| class Alf::IAlfWidgetEventHandler : public Alf::IAlfInterfaceBase |
The interface for event handlers used by widget controls. The event handlers are used for handling any Alfred events, including key events, pointer events and custom events. Interfaces provided by the event handlers can be accessed using IAlfInterfaceBase::MakeInterface().
| Public Member Functions | |
|---|---|
| ~IAlfWidgetEventHandler () | |
| bool | accept ( CAlfWidgetControl &, const TAlfEvent &) |
| AlfEventHandlerExecutionPhase | eventExecutionPhase () |
| AlfWidgetEventHandlerInitData * | eventHandlerData () |
| AlfEventHandlerType | eventHandlerType () |
| AlfEventStatus | offerEvent ( CAlfWidgetControl &, const TAlfEvent &) |
| void | setActiveStates (unsigned int) |
| void | setEventHandlerData (const AlfWidgetEventHandlerInitData &) |
| const IfId & | type () |
| Inherited Functions | |
|---|---|
| Alf::IAlfInterfaceBase::makeInterface(IAlfInterfaceBase *) | |
| Alf::IAlfInterfaceBase::makeInterface(const IfId &) | |
| Alf::IAlfInterfaceBase::~IAlfInterfaceBase() | |
| Public Member Enumerations | |
|---|---|
| enum | AlfEventHandlerExecutionPhase { ETunnellingPhaseEventHandler , EBubblingPhaseEventHandler , ETunnellingAndBubblingPhaseEventHandler } |
| enum | AlfEventHandlerType { EPresentationEventHandler , ELogicalEventHandler } |
| bool | accept | ( | CAlfWidgetControl & | aControl, |
| const TAlfEvent & | aEvent | |||
| ) | const [pure virtual] | |||
Used to identify event handlers that are capable of handling a specified key or custom event. Pointer event handlers cannot be identified directly, since they are dependent on the presentation. Therefore, pointer event handlers should be associated with a custom event ID that can be used to simulate the actual pointer event.
| CAlfWidgetControl & aControl | |
| const TAlfEvent & aEvent | The event. |
| AlfEventHandlerExecutionPhase | eventExecutionPhase | ( | ) | [pure virtual] |
Returns information about the phase in the event handling cycle in which the event hadler will be executed. IAlfWidgetEventHandler::AlfEventHandlerExecutionPhase
| AlfWidgetEventHandlerInitData * | eventHandlerData | ( | ) | [pure virtual] |
Returns AlfWidgetEventHandlerInitData .
| AlfEventHandlerType | eventHandlerType | ( | ) | [pure virtual] |
Returns the type of EventHandler. IAlfWidgetEventHandler::AlfEventHandlerType
| AlfEventStatus | offerEvent | ( | CAlfWidgetControl & | aControl, |
| const TAlfEvent & | aEvent | |||
| ) | [pure virtual] | |||
Called when an input event is being offered to this event handler. The return value is used to indicate if the event was processed. Processed events may not be offered to other event handlers.
| CAlfWidgetControl & aControl | The parent control of this event handler. |
| const TAlfEvent & aEvent | The event. |
| void | setActiveStates | ( | unsigned int | aStates | ) | [pure virtual] |
Defines the widget states, where the event handler is active. By default, if this method is not called, the event handler is expected to be active in all states.
| unsigned int aStates | A bitmask defining the widget states, where the event handler is active. The low 16 bits are reserved for the states defined by the framework in . The high 16 bits are available for states defined by the client code. |
| void | setEventHandlerData | ( | const AlfWidgetEventHandlerInitData & | aData | ) | [pure virtual] |
Sets AlfWidgetEventHandlerInitData to event handler.
| const AlfWidgetEventHandlerInitData & aData | A data structure which contains for example id of the event handler. |
Phase in which event handlers are executed.
| ETunnellingPhaseEventHandler |
Tunneling event handlers are executed only in the tunnelling phase of the event handling cycle. Tunnelling event handlers are executed before IAlfWidgetControl::HandleEvent is executed. IAlfWidgetControl::HandleEvent |
| EBubblingPhaseEventHandler |
Bubbling event handlers are executed only in the bubbling phase of the event handling cycle. Bubbling event handlers are executed after IAlfWidgetControl::HandleEvent is executed. IAlfWidgetControl::HandleEvent |
| ETunnellingAndBubblingPhaseEventHandler |
These event handlers are executed both in the tunneling and bubbling phase of the event handling cycle i.e both before and after IAlfWidgetControl::HandleEvent is executed. IAlfWidgetControl::HandleEvent |
| EPresentationEventHandler |
Presentation related event handlers. These will be deleted when the presentation is destroyed. : IAlfWigetControl::destroyPresentation : IAlfWiget::setPresentation |
| ELogicalEventHandler |
Logical event handlers. These event handlers are not presentation related and will not be destroyed during the destruction of the presentation. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.