Class TFepOnOrOffKeyData

class TFepOnOrOffKeyData;

Description

On or off key data for FEPs.

The CCoeFep class uses instances of this class to specify the key combination which is used to turn the FEP on and off. These values are initialised during construction of the FEP (see CCoeFep::BaseConstructL(const CCoeFepParameters &)).

The class consists of three TUints. They represent:

• the character code of the key combination

• a modifier mask which indicates which modifiers are relevant to the key combination

• the modifier values which indicate which of the modifiers specified in the modifier mask must be on and which must be off

For example, if the key combination to turn the FEP off is Fn+Enter, where the Shift modifier must not be down (and the state of all other modifiers is irrelevant), the TFepOnOrOffKeyData object would be constructed as follows:

TFepOnOrOffKeyData(EKeyEnter, EModifierFunc|EModifierShift, EModifierFunc) 

Note that modifiers should not be set in the values if they are not also set in the mask.

Members

Defined in TFepOnOrOffKeyData:

• CharacterCodeForFoldedMatch()constGets the character code.
• ModifierMask()constGets the modifier mask.
• ModifierValues()constGets the modifier values.
• TFepOnOrOffKeyData(TUint,TUint,TUint)The C++ constructor is used to construct the key data object with the character ...
• operator!=(const TFepOnOrOffKeyData &)constChecks if 2 TFepOnOrOffKeyData objects do not have the the same values.
• operator==(const TFepOnOrOffKeyData &)constChecks if 2 TFepOnOrOffKeyData objects have the same values.

inline TFepOnOrOffKeyData(TUint aCharacterCodeForFoldedMatch, TUint aModifierMask, TUint aModifierValues);

Description

The C++ constructor is used to construct the key data object with the character code, the modifier mask and the modifier values.

Parameters

TUint aCharacterCodeForFoldedMatch The character code. TUint aModifierMask The modifier mask. TUint aModifierValues The modifier values.

inline TUint CharacterCodeForFoldedMatch() const;

Description

Gets the character code.

Return value

TUint The character code.

inline TUint ModifierMask() const;

Description

Gets the modifier mask.

Return value

TUint The modifier mask.

inline TUint ModifierValues() const;

Description

Gets the modifier values.

Return value

TUint The modifier values.

IMPORT_C TBool operator==(const TFepOnOrOffKeyData &aAnother) const;

Description

Checks if 2 TFepOnOrOffKeyData objects have the same values.

returns Etrue if the 2 objects have the same values, EFalse otherwise

Parameters

const TFepOnOrOffKeyData &aAnother

Return value

TBool

IMPORT_C TBool operator!=(const TFepOnOrOffKeyData &aAnother) const;

Description

Checks if 2 TFepOnOrOffKeyData objects do not have the the same values.

returns Etrue if the 2 objects have the same values, EFalse otherwise

Parameters

const TFepOnOrOffKeyData &aAnother

Return value

TBool