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()
Public Member Functions | |
---|---|
~CCoeFep() | |
void | CancelTransaction() |
IMPORT_C TBool | IsSimulatingKeyEvent() |
IMPORT_C TBool | IsTurnedOffByL(const TKeyEvent &) |
IMPORT_C TBool | IsTurnedOnByL(const TKeyEvent &) |
IMPORT_C TKeyResponse | OnFinishingHandlingKeyEvent_NoDownUpFilterL(TEventCode, const TKeyEvent &, TKeyResponse) |
IMPORT_C TKeyResponse | OnFinishingHandlingKeyEvent_WithDownUpFilterL(TEventCode, const TKeyEvent &, TKeyResponse) |
IMPORT_C void | OnStartingHandlingKeyEvent_NoDownUpFilterLC() |
IMPORT_C void | OnStartingHandlingKeyEvent_WithDownUpFilterLC() |
void | SetOnState(TBool) |
Protected Member Functions | |
---|---|
CCoeFep(CCoeEnv &) | |
IMPORT_C void | BaseConstructL(const CCoeFepParameters &) |
IMPORT_C TBool | IsOn() |
IMPORT_C void | MakeDeferredFunctionCall(MDeferredFunctionCall &) |
IMPORT_C void | ReadAllAttributesL() |
IMPORT_C void | SimulateKeyEventsL(const TArray< TUint > &) |
IMPORT_C void | SimulateKeyEventsL(const TArray< MModifiedCharacter > &) |
IMPORT_C void | WriteAttributeDataAndBroadcastL(TUid) |
IMPORT_C void | WriteAttributeDataAndBroadcastL(const TArray< TUid > &) |
Private Member Functions | |
---|---|
IMPORT_C void | CCoeFep_Reserved_1() |
IMPORT_C void | CCoeFep_Reserved_2() |
TKeyResponse | DoOnFinishingHandlingKeyEventL(TEventCode, const TKeyEvent &, TKeyResponse) |
void | DoOnStartingHandlingKeyEventLC(TUint) |
IMPORT_C TMessageResponse | HandleMessageL(TUint32, TUid, const TDesC8 &) |
void | IsOnHasChangedState() |
IMPORT_C void | MCoeFocusObserver_Reserved_1() |
IMPORT_C void | MCoeFocusObserver_Reserved_2() |
IMPORT_C void | MCoeForegroundObserver_Reserved_1() |
IMPORT_C void | MCoeForegroundObserver_Reserved_2() |
IMPORT_C void | MCoeMessageObserver_Reserved_1() |
IMPORT_C void | MCoeMessageObserver_Reserved_2() |
IMPORT_C void | MFepAttributeStorer_Reserved_1() |
IMPORT_C void | MFepAttributeStorer_Reserved_2() |
void | OfferKeyEventL(TEventResponse &, const TKeyEvent &, TEventCode) |
void | OfferPointerBufferReadyEventL(TEventResponse &, const CCoeControl *) |
void | OfferPointerEventL(TEventResponse &, const TPointerEvent &, const CCoeControl *) |
void | TurnOffKeyEventHandlingFlags(TAny *) |
Public Member Enumerations | |
---|---|
enum | TEventResponse { EEventWasNotConsumed, EEventWasConsumed } |
Private Attributes | |
---|---|
CCoeEnv & | iConeEnvironment |
CCoeFepExtra * | iExtra |
TUint | iFlags |
CHighPriorityActive * | iHighPriorityActive |
SKeyEvent * | iLastKeyEvent |
TUint | iSpare |
IMPORT_C | CCoeFep | ( | CCoeEnv & | aConeEnvironment | ) | [protected] |
CCoeEnv & aConeEnvironment |
IMPORT_C void | BaseConstructL | ( | const CCoeFepParameters & | aFepParameters | ) | [protected] |
const CCoeFepParameters & aFepParameters |
void | CancelTransaction | ( | ) | [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.
TKeyResponse | DoOnFinishingHandlingKeyEventL | ( | TEventCode | aEventCode, |
const TKeyEvent & | aKeyEvent, | |||
TKeyResponse | aKeyResponse | |||
) | [private] |
TEventCode aEventCode | |
const TKeyEvent & aKeyEvent | |
TKeyResponse aKeyResponse |
void | DoOnStartingHandlingKeyEventLC | ( | TUint | aFlagNoDownUpFilter | ) | [private] |
TUint aFlagNoDownUpFilter |
IMPORT_C TMessageResponse | HandleMessageL | ( | TUint32 | aClientHandleOfTargetWindowGroup, |
TUid | aMessageUid, | |||
const TDesC8 & | aMessageParameters | |||
) | [private, virtual] |
void | IsOnHasChangedState | ( | ) | [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.
IMPORT_C TBool | IsTurnedOffByL | ( | const TKeyEvent & | aKeyEvent | ) | const |
const TKeyEvent & aKeyEvent |
IMPORT_C TBool | IsTurnedOnByL | ( | const TKeyEvent & | aKeyEvent | ) | const |
const TKeyEvent & aKeyEvent |
IMPORT_C void | MCoeForegroundObserver_Reserved_1 | ( | ) | [private, virtual] |
IMPORT_C void | MCoeForegroundObserver_Reserved_2 | ( | ) | [private, virtual] |
IMPORT_C void | MakeDeferredFunctionCall | ( | MDeferredFunctionCall & | aDeferredFunctionCall | ) | [protected] |
MDeferredFunctionCall & aDeferredFunctionCall |
void | OfferKeyEventL | ( | TEventResponse & | , |
const TKeyEvent & | , | |||
TEventCode | ||||
) | [private, inline, virtual] |
TEventResponse & | |
const TKeyEvent & | |
TEventCode |
void | OfferPointerBufferReadyEventL | ( | TEventResponse & | , |
const CCoeControl * | ||||
) | [private, inline, virtual] |
TEventResponse & | |
const CCoeControl * |
void | OfferPointerEventL | ( | TEventResponse & | , |
const TPointerEvent & | , | |||
const CCoeControl * | ||||
) | [private, inline, virtual] |
TEventResponse & | |
const TPointerEvent & | |
const CCoeControl * |
IMPORT_C TKeyResponse | OnFinishingHandlingKeyEvent_NoDownUpFilterL | ( | TEventCode | aEventCode, |
const TKeyEvent & | aKeyEvent, | |||
TKeyResponse | aKeyResponse | |||
) |
TEventCode aEventCode | |
const TKeyEvent & aKeyEvent | |
TKeyResponse aKeyResponse |
IMPORT_C TKeyResponse | OnFinishingHandlingKeyEvent_WithDownUpFilterL | ( | TEventCode | aEventCode, |
const TKeyEvent & | aKeyEvent, | |||
TKeyResponse | aKeyResponse | |||
) |
TEventCode aEventCode | |
const TKeyEvent & aKeyEvent | |
TKeyResponse aKeyResponse |
IMPORT_C void | OnStartingHandlingKeyEvent_NoDownUpFilterLC | ( | ) |
IMPORT_C void | OnStartingHandlingKeyEvent_WithDownUpFilterLC | ( | ) |
IMPORT_C void | SimulateKeyEventsL | ( | const TArray< TUint > & | aArrayOfCharacters | ) | [protected] |
IMPORT_C void | SimulateKeyEventsL | ( | const TArray< MModifiedCharacter > & | aArrayOfModifiedCharacters | ) | [protected] |
const TArray< MModifiedCharacter > & aArrayOfModifiedCharacters |
void | TurnOffKeyEventHandlingFlags | ( | TAny * | aFlags | ) | [private, static] |
TAny * aFlags |
IMPORT_C void | WriteAttributeDataAndBroadcastL | ( | TUid | aAttributeUid | ) | [protected] |
TUid aAttributeUid |
IMPORT_C void | WriteAttributeDataAndBroadcastL | ( | const TArray< TUid > & | aAttributeUids | ) | [protected] |
Response to key or pointer event
EEventWasNotConsumed | |
EEventWasConsumed |
< Indicates that the FEP did not process the event. < Indicates that the FEP did process the event. |