class CFepGenericGlobalSettings : public CBase |
Reads and writes generic FEP settings.
Used by the CCoeFep class. The generic FEP settings are whether the FEP is on or off and what key combinations should turn the FEP on or off. Also used to synchronise these settings across all running instances of the FEP. These settings are generic, unlike FEP attributes which are FEP-specific. FEP attributes are stored, restored and synchronised using class MFepAttributeStorer . Generic FEP settings are changed locally using the Set...() member functions. Then, to store these as the system settings and to apply them globally, call StoreChangesAndBroadcastL() .
Class CCoeFep initialises its generic FEP settings from the global system settings during construction. Its generic FEP settings are updated when the settings are changed by a call to StoreChangesAndBroadcastL() by another running instance of the FEP.
Private Member Functions | |
---|---|
CFepGenericGlobalSettings () | |
void | ConstructL () |
Private Member Enumerations | |
---|---|
enum | anonymous { EFlagIsOn = 0x00000001, EFlagStoreIsOn = 0x00000002, EFlagStoreOnKeyData = 0x00000004, EFlagStoreOffKeyData = 0x00000008 } |
Private Attributes | |
---|---|
TUint | iFlags |
TFepOnOrOffKeyData | iOffKeyData |
TFepOnOrOffKeyData | iOnKeyData |
IMPORT_C CFepGenericGlobalSettings * | NewL | ( | CCoeEnv & | aConeEnvironment, |
const TFepOnOrOffKeyData & | aDefaultOnKeyData, | |||
const TFepOnOrOffKeyData & | aDefaultOffKeyData, | |||
TBool | aDefaultIsOn | |||
) | [static] |
Allocates and constructs a new generic FEP settings object.
Reads the generic FEP data from the system settings. If the data is not present in the system settings, it is read from the default values specified.
CCoeEnv & aConeEnvironment | The FEP's control environment. |
const TFepOnOrOffKeyData & aDefaultOnKeyData | Default key event data for switching the FEP on. |
const TFepOnOrOffKeyData & aDefaultOffKeyData | Default key event data for switching the FEP off. |
TBool aDefaultIsOn | Whether the FEP is on or off by default. |
IMPORT_C CFepGenericGlobalSettings * | NewL | ( | ) | [static] |
Allocates and constructs a new generic FEP settings object.
Reads the generic FEP data from the system settings.
IMPORT_C CFepGenericGlobalSettings * | NewLC | ( | CCoeEnv & | aConeEnvironment, |
const TFepOnOrOffKeyData & | aDefaultOnKeyData, | |||
const TFepOnOrOffKeyData & | aDefaultOffKeyData, | |||
TBool | aDefaultIsOn | |||
) | [static] |
Allocates and constructs a new generic FEP settings object.
Reads the generic FEP data from the system settings. If the data is not present in the system settings, it is read from the default values specified. Leaves a pointer to the object on the cleanup stack.
CCoeEnv & aConeEnvironment | The FEP's control environment. |
const TFepOnOrOffKeyData & aDefaultOnKeyData | Default key event data for switching the FEP on. |
const TFepOnOrOffKeyData & aDefaultOffKeyData | Default key event data for switching the FEP off. |
TBool aDefaultIsOn | Whether the FEP is on or off by default. |
IMPORT_C CFepGenericGlobalSettings * | NewLC | ( | ) | [static] |
Allocates and constructs a new generic FEP settings object.
Reads the generic FEP data from the system settings. Leaves a pointer to the object on the cleanup stack.
IMPORT_C TFepOnOrOffKeyData | OffKeyData | ( | ) | const |
Gets the key event data which turns the FEP off.
IMPORT_C TFepOnOrOffKeyData | OnKeyData | ( | ) | const |
Gets the key event data which turns the FEP on.
IMPORT_C void | ReadOnOrOffKeyData | ( | CRepository & | aRepository, |
TFepOnOrOffKeyData & | aOnOrOffKeyData, | |||
TUint32 | aRepositoryKeyMask_OnOrOff, | |||
TInt * | aError = NULL | |||
) | [static] |
CRepository & aRepository | |
TFepOnOrOffKeyData & aOnOrOffKeyData | |
TUint32 aRepositoryKeyMask_OnOrOff | |
TInt * aError = NULL |
IMPORT_C void | ReadOnState | ( | CRepository & | aRepository, |
TBool & | aOnState, | |||
TInt * | aError = NULL | |||
) | [static] |
CRepository & aRepository | |
TBool & aOnState | |
TInt * aError = NULL |
IMPORT_C void | RefreshL | ( | ) |
Reads the generic FEP data from the system settings.
If the FEP data is not present in the system settings, then it is set from the default values (as passed to the NewL() ).
This function is called during construction of the object.
IMPORT_C void | SetIsOn | ( | TBool | aIsOn | ) |
Sets a flag indicating whether the FEP is on or off.
TBool aIsOn | ETrue if the FEP is on, EFalse if the FEP is off. |
IMPORT_C void | SetOffKeyData | ( | const TFepOnOrOffKeyData & | aOffKeyData | ) |
Sets the key event data which turns the FEP off.
const TFepOnOrOffKeyData & aOffKeyData | The key event data which turns the FEP off. |
IMPORT_C void | SetOnKeyData | ( | const TFepOnOrOffKeyData & | aOnKeyData | ) |
Sets the key event data which turns the FEP on.
const TFepOnOrOffKeyData & aOnKeyData | The key event data which turns the FEP on. |
IMPORT_C void | StoreChangesAndBroadcastL | ( | ) |
Stores the local copies of the generic FEP data as the system settings.
IMPORT_C void | WriteOnOrOffKeyDataAndBroadcastL | ( | CRepository & | aRepository, |
const TFepOnOrOffKeyData & | aOnOrOffKeyData, | |||
TUint32 | aRepositoryKey | |||
) | [static] |
CRepository & aRepository | |
const TFepOnOrOffKeyData & aOnOrOffKeyData | |
TUint32 aRepositoryKey |
IMPORT_C void | WriteOnStateAndBroadcastL | ( | CRepository & | aRepository, |
TBool | aOnState, | |||
TUint32 | aRepositoryKeyMask_DefaultOrDynamic | |||
) | [static] |
CRepository & aRepository | |
TBool aOnState | |
TUint32 aRepositoryKeyMask_DefaultOrDynamic |
EFlagIsOn = 0x00000001 | |
EFlagStoreIsOn = 0x00000002 | |
EFlagStoreOnKeyData = 0x00000004 | |
EFlagStoreOffKeyData = 0x00000008 |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.