FEP_START_KEY_EVENT_HANDLER_L

#define FEP_START_KEY_EVENT_HANDLER_L(aFep, aKeyEvent, aEventCode)\
    {\
    if ((aFep).IsSimulatingKeyEvent())\
        {\
        return EKeyWasNotConsumed;\
        }\
    (aFep).OnStartingHandlingKeyEvent_WithDownUpFilterLC();\
    if (((aEventCode)!=EEventKey) || (aFep).IsTurnedOnByL(aKeyEvent) || (aFep).IsTurnedOffByL(aKeyEvent))\
        {\
        return (aFep).OnFinishingHandlingKeyEvent_WithDownUpFilterL((aEventCode), (aKeyEvent), EKeyWasConsumed);\
        }\
    if (!(aFep).IsOn())\
        {\
        return (aFep).OnFinishingHandlingKeyEvent_WithDownUpFilterL((aEventCode), (aKeyEvent), EKeyWasNotConsumed);\
        }\
    }

Support

Supported from 6.1

Description

Macro to be called by a keyboard-based FEP at the start of its CCoeControl::OfferKeyEventL()-overriding function.

It causes key up and key down events to be consumed so that the FEP only receives standard key events (of type EEventKey, see the TEventCode enumeration). It also causes key events that turn the FEP on or off to be consumed. If the FEP is simulating key events, or is off, no key events are consumed (so that all are passed on to the underlying application) and the macro returns with EKeyWasNotConsumed.

This should be the first thing called in the OfferKeyEventL() function. The FEP_END_KEY_EVENT_HANDLER_L macro should be used to return from the function.

Parameters

aFep The FEP that owns the control implementing OfferKeyEventL(). aKeyEvent The key event (of type TKeyEvent), as passed to OfferKeyEventL(). aEventCode The key event code (of type TEventCode), as passed to OfferKeyEventL().

See also:

• TEventCode