CICLAnimationDataProvider Class Reference

#include <mw/iclanimationdataprovider.h>

Link against: animation.lib

class CICLAnimationDataProvider : public CAnimationDataProvider, public MICLAnimationDataLoaderObserver, public CAnimationDataProvider, public MICLAnimationDataLoaderObserver

Inherits from

CICLAnimationDataProvider

Public Member Functions
	CICLAnimationDataProvider()
	~CICLAnimationDataProvider()
virtual IMPORT_C TPtrC8	DataType()
IMPORT_C void	SetFileL(RFs &, const TFileName &)
virtual void	StartL()

Protected Member Functions
virtual IMPORT_C void	CAnimationDataProvider_Reserved1()
virtual IMPORT_C void	CAnimationDataProvider_Reserved2()
virtual IMPORT_C void	CICLAnimationDataProvider_Reserved1()
virtual IMPORT_C void	CICLAnimationDataProvider_Reserved2()

Inherited Attributes
	CAnimationDataProvider::iCAnimationDataProvider_Reserved
	CAnimationDataProvider::iObserver

Inherited Enumerations
	MICLAnimationDataLoaderObserver:TDataLoaderEvent

Inherited Functions
	CAnimationDataProvider::CAnimationDataProvider()
	CAnimationDataProvider::SendEventL(TInt)
	CAnimationDataProvider::SendEventL(TInt,TAny *,TInt)
	CAnimationDataProvider::SendEventL(TInt,TInt)
	CAnimationDataProvider::SetObserver(MAnimationDataProviderObserver *)
	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

Data provider for frame based animations.

This data provider expects to be provided with a file which can be interpreted as an animation using the Image Conversion Library (ICL). An example would be an animated GIF. The default data type for this provider is "bitmap".

Constructor & Destructor Documentation

CICLAnimationDataProvider ( )

IMPORT_C

CICLAnimationDataProvider

(

)

Default constructor.

~CICLAnimationDataProvider ( )

IMPORT_C

~CICLAnimationDataProvider

(

)

Destructor.

It is normal for an animation to take ownership of a data provider, and hence responsibility for destroying it.

Member Function Documentation

CAnimationDataProvider_Reserved1 ( )

IMPORT_C void

CAnimationDataProvider_Reserved1

(

)

[protected, virtual]

Reimplemented from CAnimationDataProvider::CAnimationDataProvider_Reserved1()

Reserved for future use

CAnimationDataProvider_Reserved2 ( )

IMPORT_C void

CAnimationDataProvider_Reserved2

(

)

[protected, virtual]

Reimplemented from CAnimationDataProvider::CAnimationDataProvider_Reserved2()

Reserved for future use

CICLAnimationDataProvider_Reserved1 ( )

IMPORT_C void

CICLAnimationDataProvider_Reserved1

(

)

[protected, virtual]

Reserved for future use

CICLAnimationDataProvider_Reserved2 ( )

IMPORT_C void

CICLAnimationDataProvider_Reserved2

(

)

[protected, virtual]

Reserved for future use

DataType ( )

IMPORT_C TPtrC8

DataType

(

)

[virtual]

Reimplemented from CAnimationDataProvider::DataType()

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

Return Value: An 8 bit identifier string

SetFileL ( RFs &, const TFileName & )

IMPORT_C void	SetFileL	(	RFs &	aFs,
			const TFileName &	aFileName
		)

Specifies the file to load the animation from.

This must be called before constructing an animation with this data provider. It may be called again for other files at any point during the lifespan of the animation, in which case current animation will be stopped.

Parameters
aFs	A session with the file server
aFileName	The path to the image file to be loaded

StartL ( )

void

StartL

(

)

[virtual]

Reimplemented from CAnimationDataProvider::StartL()

Implmenets CAnimationDataProvider::StartL()

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