Collapse all Symbian^3 Application Developer Library

MAnimationObserver Class Reference

class MAnimationObserver

Interface used by an animation to report events to the client application.

An animation can inform the client application of particular events through this mechanism. Only errors are reported in this way in v9.1, but more events may be added in future.

Use of this interface by the client application is optional.

CAnimation

Public Member Functions
void	AnimationEvent (CAnimation &, TInt , TAny *)

Protected Member Functions
IMPORT_C void	MAnimationObserver_Reserved1 ()
IMPORT_C void	MAnimationObserver_Reserved2 ()

Public Member Enumerations
enum	TEvent { EDataProviderError , EAnimationInitialized = 0x01, EReserved = 0xFFFF }

Member Functions Documentation

AnimationEvent(CAnimation &, TInt, TAny *)

void	AnimationEvent	(	CAnimation &	aSender,
			TInt	aEvent,
			TAny *	aData
		)	[pure virtual]

Receives events from an animation.

The receiver is not required to take any action atall in response to this call. The receiver should not delete the animation whilst responding to this call.

Parameters

CAnimation & aSender	A reference to the animation which sent the event.
TInt aEvent	The event code.
TAny * aData	An event specific data item.

MAnimationObserver_Reserved1()

IMPORT_C void

MAnimationObserver_Reserved1

(

)

[protected, virtual]

Reserved for future use

MAnimationObserver_Reserved2()

IMPORT_C void

MAnimationObserver_Reserved2

(

)

[protected, virtual]

Reserved for future use

Member Enumerations Documentation

Enum TEvent

Represents generic events which can be sent to the observer.

Enumerators

EDataProviderError	Indicates that an error has occurred in the data provider. For events of this type, aData is a pointer to a TInt error code.
EAnimationInitialized = 0x01	Indicates that the animator initialised (and therefore knows it's size)
EReserved = 0xFFFF	Any user defined animations introducing new events should use values greater than EReserved