Alf::IAlfWidgetEventHandler Class Reference

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

alfwidgetmodel.lib
Since
S60 ?S60_version Draft

Inherits from

Constructor & Destructor Documentation

~IAlfWidgetEventHandler()

~IAlfWidgetEventHandler()[inline, virtual]

Member Functions Documentation

accept(CAlfWidgetControl &, const TAlfEvent &)

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

Since
S60 ?S60_version

Parameters

CAlfWidgetControl & aControl
const TAlfEvent & aEventThe event.

eventExecutionPhase()

AlfEventHandlerExecutionPhase eventExecutionPhase()[pure virtual]

Returns information about the phase in the event handling cycle in which the event hadler will be executed. IAlfWidgetEventHandler::AlfEventHandlerExecutionPhase

eventHandlerData()

AlfWidgetEventHandlerInitData *eventHandlerData()[pure virtual]

eventHandlerType()

AlfEventHandlerType eventHandlerType()[pure virtual]

Returns the type of EventHandler. IAlfWidgetEventHandler::AlfEventHandlerType

offerEvent(CAlfWidgetControl &, const TAlfEvent &)

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.

Since
S60 ?S60_version

Parameters

CAlfWidgetControl & aControlThe parent control of this event handler.
const TAlfEvent & aEventThe event.

setActiveStates(unsigned int)

voidsetActiveStates(unsigned intaStates)[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.

Parameters

unsigned int aStatesA 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.

setEventHandlerData(const AlfWidgetEventHandlerInitData &)

voidsetEventHandlerData(const AlfWidgetEventHandlerInitData &aData)[pure virtual]

Sets AlfWidgetEventHandlerInitData to event handler.

Parameters

const AlfWidgetEventHandlerInitData & aDataA data structure which contains for example id of the event handler.

type()

const IfId &type()[static, inline]

Member Enumerations Documentation

Enum AlfEventHandlerExecutionPhase

Phase in which event handlers are executed.

Enumerators

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

Enum AlfEventHandlerType

Enumerators

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.