Class CFepGenericGlobalSettings

CFepGenericGlobalSettings

Support

Supported from 6.0

Description

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.

Derivation

CBase Base class for all classes to be instantiated on the heap CFepGenericGlobalSettings Reads and writes generic FEP settings

Defined in CFepGenericGlobalSettings:
IsOn(), NewL(), NewLC(), OffKeyData(), OnKeyData(), RefreshL(), SetIsOn(), SetOffKeyData(), SetOnKeyData(), StoreChangesAndBroadcastL()

Inherited from CBase:
operator new()

static CFepGenericGlobalSettings* NewL(CCoeEnv& aConeEnvironment, const TFepOnOrOffKeyData& aDefaultOnKeyData, const TFepOnOrOffKeyData& aDefaultOffKeyData, TBool aDefaultIsOn);

Description

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.

Parameters

CCoeEnv& aConeEnvironment The FEP's cone 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.

Return value

CFepGenericGlobalSettings* Pointer to the newly created object.

static CFepGenericGlobalSettings* NewLC(CCoeEnv& aConeEnvironment, const TFepOnOrOffKeyData& aDefaultOnKeyData, const TFepOnOrOffKeyData& aDefaultOffKeyData, TBool aDefaultIsOn);

Description

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.

Parameters

CCoeEnv& aConeEnvironment The FEP's cone 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.

Return value

CFepGenericGlobalSettings* Pointer to the newly created object.

TFepOnOrOffKeyData OnKeyData() const;

Description

Gets the key event data which turns the FEP on.

Return value

TFepOnOrOffKeyData The key event data which turns the FEP on.

TFepOnOrOffKeyData OffKeyData() const;

Description

Gets the key event data which turns the FEP off.

Return value

TFepOnOrOffKeyData The key event data which turns the FEP off.

TBool IsOn() const;

Description

Returns whether the FEP is on or off.

Return value

TBool ETrue if the FEP is on, EFalse if the FEP is off.

void SetOnKeyData(const TFepOnOrOffKeyData& aOnKeyData);

Description

Sets the key event data which turns the FEP on.

Parameters

const TFepOnOrOffKeyData& aOnKeyData The key event data which turns the FEP on.

void SetOffKeyData(const TFepOnOrOffKeyData& aOffKeyData);

Description

Sets the key event data which turns the FEP off.

Parameters

const TFepOnOrOffKeyData& aOffKeyData The key event data which turns the FEP off.

void SetIsOn(TBool aIsOn);

Description

Sets whether the FEP is on or off.

Parameters

TBool aIsOn ETrue if the FEP is on, EFalse if the FEP is off.

void StoreChangesAndBroadcastL();

Description

Stores the local copies of the generic FEP data as the system settings. Causes all other running instances of the FEP to be updated with the new settings.

void RefreshL();

Description

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.