Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: fepbase.h
Link against: fepbase.lib

FEP_END_KEY_EVENT_HANDLER_NO_DOWN_UP_FILTER_L

#define FEP_END_KEY_EVENT_HANDLER_NO_DOWN_UP_FILTER_L(aFep, aKeyEvent, aEventCode, aKeyResponse)\
    {\
    return (aFep).OnFinishingHandlingKeyEvent_NoDownUpFilterL((aEventCode), (aKeyEvent), (aKeyResponse));\
    }

Support

Supported from 6.1

Description

Macro to be called by a keyboard-based FEP to return from its CCoeControl::OfferKeyEventL()-overriding function.

It should be used instead of the return statement. This variant of the macro should only be used if the FEP_START_KEY_EVENT_HANDLER_NO_DOWN_UP_FILTER_L macro was used at the start of 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().

aKeyResponse

Indicates whether or not OfferKeyEventL() consumed the key event. Specifying EKeyWasNotConsumed allows that event to pass through to the application, specifying EKeyWasConsumed prevents the application from receiving the event. A good rule of thumb for a FEP that takes key events as its input is to consume as few key events as possible when not inside a FEP transaction, but once inside a transaction to block all key events from getting through to the application.