Class MEventHandler

MEventHandler

Support

Supported from 5.1

Description

Event handler interface. The interface provides a function to handle raw events, e.g. key presses, pen events, power buttons etc. Raw events are passed to the OfferRawEvent() function when the MAnimGeneralFunctions::GetRawEvents() function has been called.

The pure virtual function must be implemented in every animation DLL. If event handling is not required the function should simply return false.

Defined in MEventHandler:
OfferRawEvent()

virtual TBool OfferRawEvent(const TRawEvent& aRawEvent)=0;

Description

Handles raw events. If the incoming event can be handled, the function should process it and then return true, if it cannot be processed the function should return false, and the event will be passed to other event handling code.

The pure virtual function must be implemented in every animation DLL. If event handling is not required the function should simply return false.

Parameters

const TRawEvent& aRawEvent The raw event to be processed

Return value

TBool ETrue if the raw event is handled by this function, EFalse if the function chooses not to process it.