CCoeFep Class Reference

class CCoeFep : public CBase

Abstract base class for all FEPs.

FEP authors must derive a class from CCoeFep. The CCoeFep-derived class should implement all of its pure virtual functions including the ones which CCoeFep inherits from its base classes. For information on these functions, see the documentation of the base classes. The global NewFepL() function is used to create a fully initialised object of the derived class.

FEPs that need to intercept key events should own a CCoeControl-derived object. This object is referred to as the FEP control. The FEP control should be added to the control stack at a priority of ECoeStackPriorityFep, so that it receives first refusal of key events from the window server.

In general, focus is retained by the underlying application. This has the advantage that the user can see where the output produced by the FEP will go. When focus is switched between controls, the FEP must be notified in case the input capability of the focussed control changes. For instance, the FEP needs to prevent the user composing a large amount of text only for it to be passed to a newly focussed control that cannot accept text input. CCoeFep derives from MCoeFocusObserver, which enables FEPs to receive notification when the focus for the underlying control changes. The implementation of MCoeFocusObserver's functions can call the enquiry functions of class TCoeInputCapabilities to find out what input capabilities are supported by the new target control (you need to get the TCoeInputCapabilities object from the application UI first: see CCoeAppUi::InputCapabilities()).

NewFepL()

Inherits from

Public Member Functions
~CCoeFep()
voidCancelTransaction()
IMPORT_C TBoolIsSimulatingKeyEvent()
IMPORT_C TBoolIsTurnedOffByL(const TKeyEvent &)
IMPORT_C TBoolIsTurnedOnByL(const TKeyEvent &)
IMPORT_C TKeyResponseOnFinishingHandlingKeyEvent_NoDownUpFilterL(TEventCode, const TKeyEvent &, TKeyResponse)
IMPORT_C TKeyResponseOnFinishingHandlingKeyEvent_WithDownUpFilterL(TEventCode, const TKeyEvent &, TKeyResponse)
IMPORT_C voidOnStartingHandlingKeyEvent_NoDownUpFilterLC()
IMPORT_C voidOnStartingHandlingKeyEvent_WithDownUpFilterLC()
voidSetOnState(TBool)
Protected Member Functions
CCoeFep(CCoeEnv &)
IMPORT_C voidBaseConstructL(const CCoeFepParameters &)
IMPORT_C TBoolIsOn()
IMPORT_C voidMakeDeferredFunctionCall(MDeferredFunctionCall &)
IMPORT_C voidReadAllAttributesL()
IMPORT_C voidSimulateKeyEventsL(const TArray< TUint > &)
IMPORT_C voidSimulateKeyEventsL(const TArray< MModifiedCharacter > &)
IMPORT_C voidWriteAttributeDataAndBroadcastL(TUid)
IMPORT_C voidWriteAttributeDataAndBroadcastL(const TArray< TUid > &)
Private Member Functions
IMPORT_C voidCCoeFep_Reserved_1()
IMPORT_C voidCCoeFep_Reserved_2()
TKeyResponse DoOnFinishingHandlingKeyEventL(TEventCode, const TKeyEvent &, TKeyResponse)
voidDoOnStartingHandlingKeyEventLC(TUint)
IMPORT_C TMessageResponseHandleMessageL(TUint32, TUid, const TDesC8 &)
voidIsOnHasChangedState()
IMPORT_C voidMCoeFocusObserver_Reserved_1()
IMPORT_C voidMCoeFocusObserver_Reserved_2()
IMPORT_C voidMCoeForegroundObserver_Reserved_1()
IMPORT_C voidMCoeForegroundObserver_Reserved_2()
IMPORT_C voidMCoeMessageObserver_Reserved_1()
IMPORT_C voidMCoeMessageObserver_Reserved_2()
IMPORT_C voidMFepAttributeStorer_Reserved_1()
IMPORT_C voidMFepAttributeStorer_Reserved_2()
voidOfferKeyEventL(TEventResponse &, const TKeyEvent &, TEventCode)
voidOfferPointerBufferReadyEventL(TEventResponse &, const CCoeControl *)
voidOfferPointerEventL(TEventResponse &, const TPointerEvent &, const CCoeControl *)
voidTurnOffKeyEventHandlingFlags(TAny *)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Public Member Enumerations
enumTEventResponse { EEventWasNotConsumed, EEventWasConsumed }
Private Attributes
CCoeEnv &iConeEnvironment
CCoeFepExtra *iExtra
TUint iFlags
CHighPriorityActive *iHighPriorityActive
SKeyEvent *iLastKeyEvent
TUint iSpare

Constructor & Destructor Documentation

CCoeFep(CCoeEnv &)

IMPORT_CCCoeFep(CCoeEnv &aConeEnvironment)[protected]

Parameters

CCoeEnv & aConeEnvironment

~CCoeFep()

IMPORT_C~CCoeFep()[virtual]

Member Functions Documentation

BaseConstructL(const CCoeFepParameters &)

IMPORT_C voidBaseConstructL(const CCoeFepParameters &aFepParameters)[protected]

Parameters

const CCoeFepParameters & aFepParameters

CCoeFep_Reserved_1()

IMPORT_C voidCCoeFep_Reserved_1()[private, virtual]

CCoeFep_Reserved_2()

IMPORT_C voidCCoeFep_Reserved_2()[private, virtual]

CancelTransaction()

voidCancelTransaction()[pure virtual]

Cancels the FEP transaction.

A FEP transaction begins when an event is first intercepted by the FEP and ends either when the processed text is committed to the application underneath, or if it is cancelled.

DoOnFinishingHandlingKeyEventL(TEventCode, const TKeyEvent &, TKeyResponse)

TKeyResponse DoOnFinishingHandlingKeyEventL(TEventCodeaEventCode,
const TKeyEvent &aKeyEvent,
TKeyResponseaKeyResponse
)[private]

Parameters

TEventCode aEventCode
const TKeyEvent & aKeyEvent
TKeyResponse aKeyResponse

DoOnStartingHandlingKeyEventLC(TUint)

voidDoOnStartingHandlingKeyEventLC(TUintaFlagNoDownUpFilter)[private]

Parameters

TUint aFlagNoDownUpFilter

HandleMessageL(TUint32, TUid, const TDesC8 &)

IMPORT_C TMessageResponseHandleMessageL(TUint32aClientHandleOfTargetWindowGroup,
TUidaMessageUid,
const TDesC8 &aMessageParameters
)[private, virtual]

Parameters

TUint32 aClientHandleOfTargetWindowGroup
TUid aMessageUid
const TDesC8 & aMessageParameters

IsOn()

IMPORT_C TBoolIsOn()const [protected]

IsOnHasChangedState()

voidIsOnHasChangedState()[private, pure virtual]

Called to notify the FEP that it has either just been turned on or just been turned off (it can find out which by calling CCoeFep::IsOn()).

If FEPs want to change their appearance when they are off (e.g. make themselves invisible), then they should implement this function accordingly.

IsSimulatingKeyEvent()

IMPORT_C TBoolIsSimulatingKeyEvent()const

IsTurnedOffByL(const TKeyEvent &)

IMPORT_C TBoolIsTurnedOffByL(const TKeyEvent &aKeyEvent)const

Parameters

const TKeyEvent & aKeyEvent

IsTurnedOnByL(const TKeyEvent &)

IMPORT_C TBoolIsTurnedOnByL(const TKeyEvent &aKeyEvent)const

Parameters

const TKeyEvent & aKeyEvent

MCoeFocusObserver_Reserved_1()

IMPORT_C voidMCoeFocusObserver_Reserved_1()[private, virtual]

MCoeFocusObserver_Reserved_2()

IMPORT_C voidMCoeFocusObserver_Reserved_2()[private, virtual]

MCoeForegroundObserver_Reserved_1()

IMPORT_C voidMCoeForegroundObserver_Reserved_1()[private, virtual]

MCoeForegroundObserver_Reserved_2()

IMPORT_C voidMCoeForegroundObserver_Reserved_2()[private, virtual]

MCoeMessageObserver_Reserved_1()

IMPORT_C voidMCoeMessageObserver_Reserved_1()[private, virtual]

MCoeMessageObserver_Reserved_2()

IMPORT_C voidMCoeMessageObserver_Reserved_2()[private, virtual]

MFepAttributeStorer_Reserved_1()

IMPORT_C voidMFepAttributeStorer_Reserved_1()[private, virtual]

MFepAttributeStorer_Reserved_2()

IMPORT_C voidMFepAttributeStorer_Reserved_2()[private, virtual]

MakeDeferredFunctionCall(MDeferredFunctionCall &)

IMPORT_C voidMakeDeferredFunctionCall(MDeferredFunctionCall &aDeferredFunctionCall)[protected]

Parameters

MDeferredFunctionCall & aDeferredFunctionCall

OfferKeyEventL(TEventResponse &, const TKeyEvent &, TEventCode)

voidOfferKeyEventL(TEventResponse &,
const TKeyEvent &,
TEventCode
)[private, inline, virtual]

Parameters

TEventResponse &
const TKeyEvent &
TEventCode

OfferPointerBufferReadyEventL(TEventResponse &, const CCoeControl *)

voidOfferPointerBufferReadyEventL(TEventResponse &,
const CCoeControl *
)[private, inline, virtual]

Parameters

TEventResponse &
const CCoeControl *

OfferPointerEventL(TEventResponse &, const TPointerEvent &, const CCoeControl *)

voidOfferPointerEventL(TEventResponse &,
const TPointerEvent &,
const CCoeControl *
)[private, inline, virtual]

Parameters

TEventResponse &
const TPointerEvent &
const CCoeControl *

OnFinishingHandlingKeyEvent_NoDownUpFilterL(TEventCode, const TKeyEvent &, TKeyResponse)

IMPORT_C TKeyResponseOnFinishingHandlingKeyEvent_NoDownUpFilterL(TEventCodeaEventCode,
const TKeyEvent &aKeyEvent,
TKeyResponseaKeyResponse
)

Parameters

TEventCode aEventCode
const TKeyEvent & aKeyEvent
TKeyResponse aKeyResponse

OnFinishingHandlingKeyEvent_WithDownUpFilterL(TEventCode, const TKeyEvent &, TKeyResponse)

IMPORT_C TKeyResponseOnFinishingHandlingKeyEvent_WithDownUpFilterL(TEventCodeaEventCode,
const TKeyEvent &aKeyEvent,
TKeyResponseaKeyResponse
)

Parameters

TEventCode aEventCode
const TKeyEvent & aKeyEvent
TKeyResponse aKeyResponse

OnStartingHandlingKeyEvent_NoDownUpFilterLC()

IMPORT_C voidOnStartingHandlingKeyEvent_NoDownUpFilterLC()

OnStartingHandlingKeyEvent_WithDownUpFilterLC()

IMPORT_C voidOnStartingHandlingKeyEvent_WithDownUpFilterLC()

ReadAllAttributesL()

IMPORT_C voidReadAllAttributesL()[protected]

SetOnState(TBool)

voidSetOnState(TBoolaOnState)

Parameters

TBool aOnState

SimulateKeyEventsL(const TArray< TUint > &)

IMPORT_C voidSimulateKeyEventsL(const TArray< TUint > &aArrayOfCharacters)[protected]

Parameters

const TArray< TUint > & aArrayOfCharacters

SimulateKeyEventsL(const TArray< MModifiedCharacter > &)

IMPORT_C voidSimulateKeyEventsL(const TArray< MModifiedCharacter > &aArrayOfModifiedCharacters)[protected]

Parameters

const TArray< MModifiedCharacter > & aArrayOfModifiedCharacters

TurnOffKeyEventHandlingFlags(TAny *)

voidTurnOffKeyEventHandlingFlags(TAny *aFlags)[private, static]

Parameters

TAny * aFlags

WriteAttributeDataAndBroadcastL(TUid)

IMPORT_C voidWriteAttributeDataAndBroadcastL(TUidaAttributeUid)[protected]

Parameters

TUid aAttributeUid

WriteAttributeDataAndBroadcastL(const TArray< TUid > &)

IMPORT_C voidWriteAttributeDataAndBroadcastL(const TArray< TUid > &aAttributeUids)[protected]

Parameters

const TArray< TUid > & aAttributeUids

Member Enumerations Documentation

Enum TEventResponse

Response to key or pointer event

Enumerators

EEventWasNotConsumed
EEventWasConsumed

< Indicates that the FEP did not process the event. < Indicates that the FEP did process the event.

Member Data Documentation

CCoeEnv & iConeEnvironment

CCoeEnv &iConeEnvironment[private]

CCoeFepExtra * iExtra

CCoeFepExtra *iExtra[private]

TUint iFlags

TUint iFlags[private]

CHighPriorityActive * iHighPriorityActive

CHighPriorityActive *iHighPriorityActive[private]

SKeyEvent * iLastKeyEvent

SKeyEvent *iLastKeyEvent[private]

TUint iSpare

TUint iSpare[private]