CAnimationDataProvider Class Reference

#include <mw/animationdataprovider.h>

Link against: animationshared.lib

class CAnimationDataProvider : public CBase, public CBase

Inherits from

CAnimationDataProvider
- CBase
- CBase

Protected Attributes
TInt	iCAnimationDataProvider_Reserved
MAnimationDataProviderObserver *	iObserver

Public Member Functions
pure virtual TPtrC8	DataType()
IMPORT_C void	SetObserver(MAnimationDataProviderObserver *)
pure virtual void	StartL()

Protected Member Functions
	CAnimationDataProvider()
virtual IMPORT_C void	CAnimationDataProvider_Reserved1()
virtual IMPORT_C void	CAnimationDataProvider_Reserved2()
IMPORT_C void	SendEventL(TInt)
IMPORT_C void	SendEventL(TInt, TInt)
IMPORT_C void	SendEventL(TInt, TAny *, TInt)

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

Detailed Description

Pure virtual base class for data providers.

A data provider takes an animation specification (such as a file), converts it (if needed) into a format recognised by an animator (such as CAnimationFrame objects), and passes it to the animator, via the medium of an animation.

Most animation types take a data provider as an argument during contruction. For more detailed usage instructions, refer to the documentation of the derived classes.

See also: CAnimation MAnimationDataProviderObserver

Member Attribute Documentation

iCAnimationDataProvider_Reserved

TInt

iCAnimationDataProvider_Reserved

[protected]

Reserved for future use

iObserver

MAnimationDataProviderObserver *

iObserver

[protected]

The destination to send data to. Usually an animation class.

Constructor & Destructor Documentation

CAnimationDataProvider ( )

IMPORT_C

CAnimationDataProvider

(

)

[protected]

Constructor

Member Function Documentation

CAnimationDataProvider_Reserved1 ( )

IMPORT_C void

CAnimationDataProvider_Reserved1

(

)

[protected, virtual]

Reserved for future use

CAnimationDataProvider_Reserved2 ( )

IMPORT_C void

CAnimationDataProvider_Reserved2

(

)

[protected, virtual]

Reserved for future use

DataType ( )

TPtrC8

DataType

(

)

[pure virtual]

Called from the animation to obtain the type of data to expect.

Return Value: An 8 bit identifier string

SendEventL ( TInt )

IMPORT_C void

SendEventL

(

TInt

aEvent

)

[protected]

Sends an event with no associated data to the observer.

See SendEventL(TInt,TAny*,TInt) for further details.

Parameters
aEvent	The event to pass. This may be a member of TAnimationEvent, or a user defined value. User defined events must be greater than EAnimationReservedEvents

SendEventL ( TInt, TInt )

IMPORT_C void	SendEventL	(	TInt	aEvent,
			TInt	aData
		)	[protected]

Sends an event with a single integer data item to the observer.

See SendEventL(TInt,TAny*,TInt) for further details.

Parameters
aEvent	The event to pass. This may be a member of TAnimationEvent, or a user defined value. User defined events must be greater than EAnimationReservedEvents
aData	A pointer to the data to send

SendEventL ( TInt, TAny *, TInt )

IMPORT_C void	SendEventL	(	TInt	aEvent,
			TAny *	aData,
			TInt	aDataSize
		)	[protected]

Sends an event with an arbitrary size data item to the observer.

SetObserver ( MAnimationDataProviderObserver * )

IMPORT_C void

SetObserver

(

MAnimationDataProviderObserver *

aObserver

)

Sets the destination for data from this data provider.

You do not need to call this function unless you are writing a new animation type.

Parameters
aObserver	The destination to send data to. Usually an animation class.

StartL ( )

void

StartL

(

)

[pure virtual]

Called from the animation when it is ready to begin receiving data.