diff -r 666f914201fb -r 2fe1408b6811 epoc32/include/mw/profileenginesdkcrkeys.h --- a/epoc32/include/mw/profileenginesdkcrkeys.h Tue Nov 24 13:55:44 2009 +0000 +++ b/epoc32/include/mw/profileenginesdkcrkeys.h Tue Mar 16 16:12:26 2010 +0000 @@ -1,1 +1,148 @@ -profileenginesdkcrkeys.h +/* +* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). +* All rights reserved. +* This component and the accompanying materials are made available +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members +* which accompanies this distribution, and is available +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". +* +* Initial Contributors: +* Nokia Corporation - initial contribution. +* +* Contributors: +* +* Description: This file contains the constant definitions of the Central + * Repository keys and the Central Repository UID of Profiles + * Engine Active Profile Settings API. + * +*/ + + + +#ifndef PROFILEENGINESDKCRKEYS_H +#define PROFILEENGINESDKCRKEYS_H + + +// INCLUDES +#include + +// CONSTANTS + +/** + * This is a READ-ONLY API to get information about the settings of the + * currently active profile. + * + * How to use: + * + * @code + * #include + * #include + * + * CRepository* cr = CRepository::NewLC( KCRUidProfileEngine ); + * TInt value; + * + * // Get the ID of the currently active profile: + * User::LeaveIfError( cr->Get( KProEngActiveProfile, value ) ); + * // use value + * + * // Get the ringing type of the active profile: + * User::LeaveIfError( cr->Get( KProEngActiveRingingType, value ) ); + * // use value + * + * // Get the keypad tones volume level of the active profile: + * User::LeaveIfError( cr->Get( KProEngActiveKeypadVolume, value ) ); + * // use value + * + * // Get the ringing volume of the active profile: + * User::LeaveIfError( cr->Get( KProEngActiveRingingVolume, value ) ); + * // use value + * + * // Get the game and warning tone setting of the active profile: + * User::LeaveIfError( cr->Get( KProEngActiveWarningTones, value ) ); + * // use value + * + * // Get the message alert setting of the active profile: + * User::LeaveIfError( cr->Get( KProEngActiveMessageAlert, value ) ); + * // use value + * + * CleanupStack::PopAndDestroy( cr ); + * @endcode + * + * The UID of the Central Repository file containing the settings. Should be + * given as a parameter in CRepository::NewL() call. + */ +const TUid KCRUidProfileEngine = {0x101F8798}; + +/** +* The id of the currently active profile, integer value. +* Possible values: +* +* 0 = General profile (default value)
+* 1 = Silent profile
+* 2 = Meeting profile
+* 3 = Outdoor profile
+* 4 = Pager profile
+* 5 = Off-line profile
+* 6 = Drive profile
+* 30-49 = User-created profiles
+**/ +const TUint32 KProEngActiveProfile = 0x7E000001; + +/** +* Ringing type of the active profile, integer value. +* +* Possible values: +* +* 0 = Ringing (default value)
+* 1 = Ascending
+* 2 = Ring once
+* 3 = Beep once
+* 4 = Silent
+**/ +const TUint32 KProEngActiveRingingType = 0x7E000002; + +/** +* Keypad volume of the active profile, integer value. +* +* Possible values: +* +* 0 (keypad tones off)
+* 1
+* 2 (default)
+* 3
+**/ +const TUint32 KProEngActiveKeypadVolume = 0x7E000004; + +/** +* Ringing volume of the active profile, integer value. +* +* Possible value range: 1-10 +* +* Default value : 7 +**/ +const TUint32 KProEngActiveRingingVolume = 0x7E000008; + +/** +* Warning & Game Tones of the active profile, integer value. +* +* Possible values: +* +* 0 = off
+* 1 = on (default value)
+**/ +const TUint32 KProEngActiveWarningTones = 0x7E000020; + +/** +* Message Alert Tone of the active profile, integer value. +* +* Possible values: +* +* 0 = Off (= the profile is silent)
+* 1 = On (default value)
+**/ +const TUint32 KProEngActiveMessageAlert = 0x7E000040; + + +#endif // PROFILEENGINESDKCRKEYS_H + +// End of File