CCoeFep Class Reference

#include <mw/fepbase.h>

Link against: mpxalbumarteditordialog.lib

class CCoeFep : public CBase

Inherits from

  • CCoeFep

    Detailed Description

    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()).

    See also: NewFepL()

    Member Enumeration Documentation

    Enum TEventResponse

    Response to key or pointer event

    EnumeratorValueDescription
    EEventWasNotConsumed
    EEventWasConsumed

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

    Constructor & Destructor Documentation

    CCoeFep ( CCoeEnv & )

    IMPORT_CCCoeFep(CCoeEnv &aConeEnvironment)[protected]

    ~CCoeFep ( )

    IMPORT_C~CCoeFep()[virtual]

    Member Function Documentation

    BaseConstructL ( const CCoeFepParameters & )

    IMPORT_C voidBaseConstructL(const CCoeFepParameters &aFepParameters)[protected]

    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.

    IsOn ( )

    IMPORT_C TBoolIsOn()const [protected]

    IsSimulatingKeyEvent ( )

    IMPORT_C TBoolIsSimulatingKeyEvent()const

    IsTurnedOffByL ( const TKeyEvent & )

    IMPORT_C TBoolIsTurnedOffByL(const TKeyEvent &aKeyEvent)const

    IsTurnedOnByL ( const TKeyEvent & )

    IMPORT_C TBoolIsTurnedOnByL(const TKeyEvent &aKeyEvent)const

    MakeDeferredFunctionCall ( MDeferredFunctionCall & )

    IMPORT_C voidMakeDeferredFunctionCall(MDeferredFunctionCall &aDeferredFunctionCall)[protected]

    OnFinishingHandlingKeyEvent_NoDownUpFilterL ( TEventCode, const TKeyEvent &, TKeyResponse )

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

    OnFinishingHandlingKeyEvent_WithDownUpFilterL ( TEventCode, const TKeyEvent &, TKeyResponse )

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

    OnStartingHandlingKeyEvent_NoDownUpFilterLC ( )

    IMPORT_C voidOnStartingHandlingKeyEvent_NoDownUpFilterLC()

    OnStartingHandlingKeyEvent_WithDownUpFilterLC ( )

    IMPORT_C voidOnStartingHandlingKeyEvent_WithDownUpFilterLC()

    ReadAllAttributesL ( )

    IMPORT_C voidReadAllAttributesL()[protected]

    SetOnState ( TBool )

    voidSetOnState(TBoolaOnState)

    SimulateKeyEventsL ( const TArray< TUint > & )

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

    SimulateKeyEventsL ( const TArray< MModifiedCharacter > & )

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

    WriteAttributeDataAndBroadcastL ( TUid )

    IMPORT_C voidWriteAttributeDataAndBroadcastL(TUidaAttributeUid)[protected]

    WriteAttributeDataAndBroadcastL ( const TArray< TUid > & )

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