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