1 /*

     2 * Copyright (c) 2002 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:  This file contains the constant definitions of the Central

    15  *                Repository keys and the Central Repository UID of Profiles

    16  *                Engine Active Profile Settings API.

    17  *

    18 */

    19 

    20 

    21 

    22 #ifndef PROFILEENGINESDKCRKEYS_H

    23 #define PROFILEENGINESDKCRKEYS_H

    24 

    25 

    26 //  INCLUDES

    27 #include <e32std.h>

    28 

    29 // CONSTANTS

    30 

    31 /**

    32  * This is a READ-ONLY API to get information about the settings of the

    33  * currently active profile.

    34  *

    35  * How to use:

    36  *

    37  * @code

    38  * #include <centralrepository.h>

    39  * #include <ProfileEngineSDKCRKeys.h>

    40  *

    41  * CRepository* cr = CRepository::NewLC( KCRUidProfileEngine );

    42  * TInt value;

    43  *

    44  * // Get the ID of the currently active profile:

    45  * User::LeaveIfError( cr->Get( KProEngActiveProfile, value ) );

    46  * // use value

    47  *

    48  * // Get the ringing type of the active profile:

    49  * User::LeaveIfError( cr->Get( KProEngActiveRingingType, value ) );

    50  * // use value

    51  *

    52  * // Get the keypad tones volume level of the active profile:

    53  * User::LeaveIfError( cr->Get( KProEngActiveKeypadVolume, value ) );

    54  * // use value

    55  *

    56  * // Get the ringing volume of the active profile:

    57  * User::LeaveIfError( cr->Get( KProEngActiveRingingVolume, value ) );

    58  * // use value

    59  *

    60  * // Get the game and warning tone setting of the active profile:

    61  * User::LeaveIfError( cr->Get( KProEngActiveWarningTones, value ) );

    62  * // use value

    63  *

    64  * // Get the message alert setting of the active profile:

    65  * User::LeaveIfError( cr->Get( KProEngActiveMessageAlert, value ) );

    66  * // use value

    67  *

    68  * CleanupStack::PopAndDestroy( cr );

    69  * @endcode

    70  * 

    71  * The UID of the Central Repository file containing the settings. Should be

    72  * given as a parameter in CRepository::NewL() call.

    73  */

    74 const TUid KCRUidProfileEngine = {0x101F8798};

    75 

    76 /**

    77 * The id of the currently active profile, integer value.

    78 * Possible values:

    79 *

    80 * 0 = General profile (default value)<br>

    81 * 1 = Silent profile<br>

    82 * 2 = Meeting profile<br>

    83 * 3 = Outdoor profile<br>

    84 * 4 = Pager profile<br>

    85 * 5 = Off-line profile<br>

    86 * 6 = Drive profile<br>

    87 * 30-49 = User-created profiles<br>

    88 **/

    89 const TUint32 KProEngActiveProfile = 0x7E000001;

    90 

    91 /**

    92 * Ringing type of the active profile, integer value.

    93 *

    94 * Possible values:

    95 *

    96 * 0 = Ringing (default value)<br>

    97 * 1 = Ascending<br>

    98 * 2 = Ring once<br>

    99 * 3 = Beep once<br>

   100 * 4 = Silent<br>

   101 **/

   102 const TUint32 KProEngActiveRingingType = 0x7E000002;

   103 

   104 /**

   105 * Keypad volume of the active profile, integer value.

   106 *

   107 * Possible values:

   108 *

   109 * 0 (keypad tones off)<br>

   110 * 1<br>

   111 * 2 (default)<br>

   112 * 3<br>

   113 **/

   114 const TUint32 KProEngActiveKeypadVolume = 0x7E000004;

   115 

   116 /**

   117 * Ringing volume of the active profile, integer value.

   118 *

   119 * Possible value range: 1-10

   120 *

   121 * Default value : 7

   122 **/

   123 const TUint32 KProEngActiveRingingVolume = 0x7E000008;

   124 

   125 /**

   126 * Warning & Game Tones of the active profile, integer value.

   127 *

   128 * Possible values:

   129 *

   130 * 0 = off<br>

   131 * 1 = on (default value)<br>

   132 **/

   133 const TUint32 KProEngActiveWarningTones = 0x7E000020;

   134 

   135 /**

   136 * Message Alert Tone of the active profile, integer value.

   137 *

   138 * Possible values:

   139 *

   140 * 0 = Off (= the profile is silent)<br>

   141 * 1 = On (default value)<br>

   142 **/

   143 const TUint32 KProEngActiveMessageAlert = 0x7E000040;

   144 

   145 

   146 #endif      // PROFILEENGINESDKCRKEYS_H

   147 

   148 // End of File