1 /*

     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Profile tone settings interface.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef MPROENGTONESETTINGS_H

    21 #define MPROENGTONESETTINGS_H

    22 

    23 // INCLUDES

    24 #include <e32std.h>

    25 #include <Profile.hrh>

    26 

    27 // FORWARD DECLARATIONS

    28 class MProEngToneSettingsExt;

    29 

    30 // CLASS DECLARATION

    31 

    32 /**

    33 *  Profile tone settings interface.

    34 *  This interface offers methods to set and get the following settings: ringing

    35 *  type, keypad volume, ringing volume, vibrating alert, warning and game tones

    36 *  and text-to-speech.

    37 *

    38 *  @lib ProfileEngine.lib

    39 *  @since 3.1

    40 */

    41 class MProEngToneSettings

    42     {

    43     protected:  // Destructor

    44 

    45         virtual ~MProEngToneSettings() {};

    46 

    47     public:

    48 

    49         /**

    50         * Returns the ringing type.

    51         * @since 3.1

    52         * @return Returns the ringing type.

    53         */

    54         virtual TProfileRingingType RingingType() const = 0;

    55 

    56         /**

    57         * Returns the keypad volume.

    58         * @since 3.1

    59         * @return Returns the keypad volume.

    60         */

    61         virtual TProfileKeypadVolume KeypadVolume() const = 0;

    62 

    63         /**

    64         * Returns the ringing volume.

    65         * @since 3.1

    66         * @return Returns the ringing volume.

    67         */

    68         virtual TProfileRingingVolume RingingVolume() const = 0;

    69 

    70         /**

    71         * Returns the state of vibrating alert setting.

    72         * @since 3.1

    73         * @return Returns the state of vibrating alert setting.

    74         */

    75         virtual TBool VibratingAlert() const = 0;

    76 

    77         /**

    78         * Returns the state of warning and game tones setting.

    79         * @since 3.1

    80         * @return Returns the state of warning and game tones setting.

    81         */

    82         virtual TBool WarningAndGameTones() const = 0;

    83 

    84         /**

    85         * Returns the state of text-to-speech setting.

    86         * @since 3.1

    87         * @return Returns the state of text-to-speech setting.

    88         */

    89         virtual TBool TextToSpeech() const = 0;

    90 

    91         /**

    92         * Sets the ringing type.

    93         * @since 3.1

    94         * @param aRingingType The new value for ringing type.

    95         * @return KErrNone if succesful, KErrAccessDenied if ringing type

    96         *         setting of this profile is read-only.

    97         */

    98         virtual TInt SetRingingType( TProfileRingingType aRingingType ) = 0;

    99 

   100         /**

   101         * Sets the keypad volume.

   102         * @since 3.1

   103         * @param aKeypadVolume The new value for keypad tones volume.

   104         * @return KErrNone if succesful, KErrAccessDenied if keypad tones

   105         *         setting of this profile is read-only.

   106         */

   107         virtual TInt SetKeypadVolume( TProfileKeypadVolume aKeypadVolume ) = 0;

   108 

   109         /**

   110         * Sets the ringing volume.

   111         * @since 3.1

   112         * @param aRingingVolume The new value for ringing volume.

   113         * @return KErrNone if succesful, KErrAccessDenied if ringing volume

   114         *         setting of this profile is read-only.

   115         */

   116         virtual TInt SetRingingVolume(

   117                 TProfileRingingVolume aRingingVolume ) = 0;

   118 

   119         /**

   120         * Sets the state of vibrating alert setting.

   121         * @since 3.1

   122         * @param aVibratingAlert The new state for the vibrating alert setting.

   123         * @return KErrNone if succesful, KErrAccessDenied if vibrating alert

   124         *         setting of this profile is read-only.

   125         */

   126         virtual TInt SetVibratingAlert( TBool aVibratingAlert ) = 0;

   127 

   128         /**

   129         * Sets the state of warning and game tones setting.

   130         * @since 3.1

   131         * @param aWarningAndGameTones The new state for Warning and Game tones

   132         * setting.

   133         * @return KErrNone if succesful, KErrAccessDenied if warning and game

   134         *         tones setting of this profile is read-only.

   135         */

   136         virtual TInt SetWarningAndGameTones( TBool aWarningAndGameTones ) = 0;

   137 

   138         /**

   139         * Sets the state of text-to-speech setting.

   140         * @since 3.1

   141         * @param aTextToSpeech The new state for text-to-speech setting.

   142         * @return KErrNone if succesful, KErrAccessDenied if text-to-speech

   143         *         setting of this profile is read-only.

   144         */

   145         virtual TInt SetTextToSpeech( TBool aTextToSpeech ) = 0;

   146 

   147     private: // Extension interface

   148 

   149         /**

   150         * This member is internal and not intended for use.

   151         */

   152         virtual MProEngToneSettingsExt* Extension() { return NULL; }

   153 

   154     };

   155 

   156 #endif      // MPROENGTONESETTINGS_H

   157 

   158 // End of File

   159 

   160