Symbian^3 Product Developer Library >

CSvgEventHandler Class Reference

class CSvgEventHandler : public CBase

Class description goes here.

SVGEngine.lib
Since
1.0

Inherits from

Nested Classes and Structures

Public Member Functions
~CSvgEventHandler()
voidAddEventBeginTime(MSvgEventReceiver *, TUint32, MSvgEventReceiver *)
voidAddToEventReceiverListL(MSvgEventReceiver *, TUint8, TUint32, TUint32)
voidAddToEventReceiverListL(MSvgEventReceiver *, TSvgEvent, TUint8, TUint32, TUint32)
TInt32 AnimationElementsCount()
TBool CheckInteractivityAndGetSubEventMask(CSvgElementImpl *, TUint16 &)
voidClearNullsFromEventReceiverList()
TInt32 Count()
voidDeactivateAnimations()
voidDoAnimProcL(MSvgEvent *)
voidDoCancel()
TUint8 EventMask(MSvgEventReceiver *)
MSvgEventReceiver *GetEventReceiver(TInt32, TBool, TUint8, TInt32 &)
TBool IsValidSubEventMask(TUint16)
CSvgEventHandler *NewL()
CSvgEventHandler *NewLC()
TBool ProcessEventL(MSvgEvent *)
voidReInitialize()
voidRemoveFromEventReceiverList(MSvgEventReceiver *)
voidReset()
voidReset(MSvgEvent *)
voidResetTimes()
voidRunL()
voidSetCurrentTime(TInt32)
voidSortEventList()
Private Member Functions
CSvgEventHandler()
voidConstructL()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
TInt32 iCurrentTime
CArrayFixFlat< TEventReceiverListItem > *iEventReceiverList
TUint8 iInProcess

Constructor & Destructor Documentation

CSvgEventHandler()

CSvgEventHandler()[private]

Private constructor

Since
1.0

~CSvgEventHandler()

~CSvgEventHandler()

Destructor

Since
1.0

Member Functions Documentation

AddEventBeginTime(MSvgEventReceiver *, TUint32, MSvgEventReceiver *)

voidAddEventBeginTime(MSvgEventReceiver *aElement,
TUint32aTime,
MSvgEventReceiver *aTargetElement
)

Provide the event end time information to the Event Handler

Since
1.0

Parameters

MSvgEventReceiver * aElement- An element that, ultimately, processes the event (eg. an animation element)
TUint32 aTime- The end time for an event on the target element
MSvgEventReceiver * aTargetElement- The element for which the event is processed

AddToEventReceiverListL(MSvgEventReceiver *, TUint8, TUint32, TUint32)

voidAddToEventReceiverListL(MSvgEventReceiver *aElement,
TUint8aEventMask,
TUint32aBeginTime = 0,
TUint32aEndTime = 0
)

Add an object to the list of objects that are notified of an event

Since
1.0

Parameters

MSvgEventReceiver * aElement- An SVG element that wants to be registered for an event (implements MSvgEventReceiver interface)
TUint8 aEventMask- A bit mask that indicates the types of events an object listens for
TUint32 aBeginTime = 0
TUint32 aEndTime = 0

AddToEventReceiverListL(MSvgEventReceiver *, TSvgEvent, TUint8, TUint32, TUint32)

voidAddToEventReceiverListL(MSvgEventReceiver *aElement,
TSvgEventaEvent,
TUint8aEventMask,
TUint32aBeginTime = 0,
TUint32aEndTime = 0
)

Add an object to the list of objects that are notified of an event

Since
3.2

Parameters

MSvgEventReceiver * aElement- An SVG element that wants to be registered for an event (implements MSvgEventReceiver interface)
TSvgEvent aEvent- An SVG Event that the target element needs to generate
TUint8 aEventMask- A bit mask that indicates the types of events an object listens for
TUint32 aBeginTime = 0
TUint32 aEndTime = 0

AnimationElementsCount()

TInt32 AnimationElementsCount()

CheckInteractivityAndGetSubEventMask(CSvgElementImpl *, TUint16 &)

TBool CheckInteractivityAndGetSubEventMask(CSvgElementImpl *aElement,
TUint16 &aSubEventMask
)
Checks whether the element is interactive or not and if interactive updates aSubEventMask.
Since
v3.2

Parameters

CSvgElementImpl * aElement
TUint16 & aSubEventMask- contains the list of interactive events that the element can respond to. It is a bitmask using TSvgInteractionEvent

ClearNullsFromEventReceiverList()

voidClearNullsFromEventReceiverList()

ConstructL()

voidConstructL()[private]

A private constructor that constructs heap objects

Since
1.0

Count()

TInt32 Count()

DeactivateAnimations()

voidDeactivateAnimations()

DoAnimProcL(MSvgEvent *)

voidDoAnimProcL(MSvgEvent *aEvent)

Parameters

MSvgEvent * aEvent

DoCancel()

voidDoCancel()

Standard active object DoCancel method

Since
1.0

EventMask(MSvgEventReceiver *)

TUint8 EventMask(MSvgEventReceiver *aElement)

EventMask: Return the event mask of the registered element

Parameters

MSvgEventReceiver * aElement

GetEventReceiver(TInt32, TBool, TUint8, TInt32 &)

MSvgEventReceiver *GetEventReceiver(TInt32aIndex,
TBoolaNext,
TUint8aMask,
TInt32 &aNewIndex
)

returns the next (or prev) focussable object starting with a given index search wraps around to start or end

Since
1.0

Parameters

TInt32 aIndex- search for a focussable object with this index
TBool aNext- Etrue (next) EFalse (prev) (go forward or backward for search)
TUint8 aMask
TInt32 & aNewIndex- Return the actual index where the object was found

IsValidSubEventMask(TUint16)

TBool IsValidSubEventMask(TUint16aSubEventMask)
Checks whether the aSubEventMask is has a valid value set
Since
v3.2

Parameters

TUint16 aSubEventMask

NewL()

CSvgEventHandler *NewL()[static]

Two phase constructor

Since
1.0

NewLC()

CSvgEventHandler *NewLC()[static]

Two phase constructor

Since
1.0

ProcessEventL(MSvgEvent *)

TBool ProcessEventL(MSvgEvent *aEvent)

Process events received from the client

Since
1.0

Parameters

MSvgEvent * aEvent- An object containing event information (implements MSvgEvent interface)

ReInitialize()

voidReInitialize()

RemoveFromEventReceiverList(MSvgEventReceiver *)

voidRemoveFromEventReceiverList(MSvgEventReceiver *aElement)

Remove an object from the list of objects that are notified of an event

Since
1.0

Parameters

MSvgEventReceiver * aElement- An SVG element that wants to be unregistered for an event (implements MSvgEventReceiver interface)

Reset()

voidReset()

Reset the status of the event handler and all the event receivers

Since
1.0

Reset(MSvgEvent *)

voidReset(MSvgEvent *aEvent)

Parameters

MSvgEvent * aEvent

ResetTimes()

voidResetTimes()

RunL()

voidRunL()

Standard avtive object RunL method

Since
1.0

SetCurrentTime(TInt32)

voidSetCurrentTime(TInt32aTime)

Parameters

TInt32 aTime

SortEventList()

voidSortEventList()

An internal method that sorts the events in a time scale

Since
1.0

Member Data Documentation

TInt32 iCurrentTime

TInt32 iCurrentTime[private]

CArrayFixFlat< TEventReceiverListItem > * iEventReceiverList

CArrayFixFlat< TEventReceiverListItem > *iEventReceiverList[private]

TUint8 iInProcess

TUint8 iInProcess[private]

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.