1.1 --- a/epoc32/include/mw/profileenginesdkcrkeys.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/profileenginesdkcrkeys.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,148 @@
     1.4 -profileenginesdkcrkeys.h
     1.5 +/*
     1.6 +* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  This file contains the constant definitions of the Central
    1.19 + *                Repository keys and the Central Repository UID of Profiles
    1.20 + *                Engine Active Profile Settings API.
    1.21 + *
    1.22 +*/
    1.23 +
    1.24 +
    1.25 +
    1.26 +#ifndef PROFILEENGINESDKCRKEYS_H
    1.27 +#define PROFILEENGINESDKCRKEYS_H
    1.28 +
    1.29 +
    1.30 +//  INCLUDES
    1.31 +#include <e32std.h>
    1.32 +
    1.33 +// CONSTANTS
    1.34 +
    1.35 +/**
    1.36 + * This is a READ-ONLY API to get information about the settings of the
    1.37 + * currently active profile.
    1.38 + *
    1.39 + * How to use:
    1.40 + *
    1.41 + * @code
    1.42 + * #include <centralrepository.h>
    1.43 + * #include <ProfileEngineSDKCRKeys.h>
    1.44 + *
    1.45 + * CRepository* cr = CRepository::NewLC( KCRUidProfileEngine );
    1.46 + * TInt value;
    1.47 + *
    1.48 + * // Get the ID of the currently active profile:
    1.49 + * User::LeaveIfError( cr->Get( KProEngActiveProfile, value ) );
    1.50 + * // use value
    1.51 + *
    1.52 + * // Get the ringing type of the active profile:
    1.53 + * User::LeaveIfError( cr->Get( KProEngActiveRingingType, value ) );
    1.54 + * // use value
    1.55 + *
    1.56 + * // Get the keypad tones volume level of the active profile:
    1.57 + * User::LeaveIfError( cr->Get( KProEngActiveKeypadVolume, value ) );
    1.58 + * // use value
    1.59 + *
    1.60 + * // Get the ringing volume of the active profile:
    1.61 + * User::LeaveIfError( cr->Get( KProEngActiveRingingVolume, value ) );
    1.62 + * // use value
    1.63 + *
    1.64 + * // Get the game and warning tone setting of the active profile:
    1.65 + * User::LeaveIfError( cr->Get( KProEngActiveWarningTones, value ) );
    1.66 + * // use value
    1.67 + *
    1.68 + * // Get the message alert setting of the active profile:
    1.69 + * User::LeaveIfError( cr->Get( KProEngActiveMessageAlert, value ) );
    1.70 + * // use value
    1.71 + *
    1.72 + * CleanupStack::PopAndDestroy( cr );
    1.73 + * @endcode
    1.74 + * 
    1.75 + * The UID of the Central Repository file containing the settings. Should be
    1.76 + * given as a parameter in CRepository::NewL() call.
    1.77 + */
    1.78 +const TUid KCRUidProfileEngine = {0x101F8798};
    1.79 +
    1.80 +/**
    1.81 +* The id of the currently active profile, integer value.
    1.82 +* Possible values:
    1.83 +*
    1.84 +* 0 = General profile (default value)<br>
    1.85 +* 1 = Silent profile<br>
    1.86 +* 2 = Meeting profile<br>
    1.87 +* 3 = Outdoor profile<br>
    1.88 +* 4 = Pager profile<br>
    1.89 +* 5 = Off-line profile<br>
    1.90 +* 6 = Drive profile<br>
    1.91 +* 30-49 = User-created profiles<br>
    1.92 +**/
    1.93 +const TUint32 KProEngActiveProfile = 0x7E000001;
    1.94 +
    1.95 +/**
    1.96 +* Ringing type of the active profile, integer value.
    1.97 +*
    1.98 +* Possible values:
    1.99 +*
   1.100 +* 0 = Ringing (default value)<br>
   1.101 +* 1 = Ascending<br>
   1.102 +* 2 = Ring once<br>
   1.103 +* 3 = Beep once<br>
   1.104 +* 4 = Silent<br>
   1.105 +**/
   1.106 +const TUint32 KProEngActiveRingingType = 0x7E000002;
   1.107 +
   1.108 +/**
   1.109 +* Keypad volume of the active profile, integer value.
   1.110 +*
   1.111 +* Possible values:
   1.112 +*
   1.113 +* 0 (keypad tones off)<br>
   1.114 +* 1<br>
   1.115 +* 2 (default)<br>
   1.116 +* 3<br>
   1.117 +**/
   1.118 +const TUint32 KProEngActiveKeypadVolume = 0x7E000004;
   1.119 +
   1.120 +/**
   1.121 +* Ringing volume of the active profile, integer value.
   1.122 +*
   1.123 +* Possible value range: 1-10
   1.124 +*
   1.125 +* Default value : 7
   1.126 +**/
   1.127 +const TUint32 KProEngActiveRingingVolume = 0x7E000008;
   1.128 +
   1.129 +/**
   1.130 +* Warning & Game Tones of the active profile, integer value.
   1.131 +*
   1.132 +* Possible values:
   1.133 +*
   1.134 +* 0 = off<br>
   1.135 +* 1 = on (default value)<br>
   1.136 +**/
   1.137 +const TUint32 KProEngActiveWarningTones = 0x7E000020;
   1.138 +
   1.139 +/**
   1.140 +* Message Alert Tone of the active profile, integer value.
   1.141 +*
   1.142 +* Possible values:
   1.143 +*
   1.144 +* 0 = Off (= the profile is silent)<br>
   1.145 +* 1 = On (default value)<br>
   1.146 +**/
   1.147 +const TUint32 KProEngActiveMessageAlert = 0x7E000040;
   1.148 +
   1.149 +
   1.150 +#endif      // PROFILEENGINESDKCRKEYS_H
   1.151 +
   1.152 +// End of File