Class CICLAnimationDataProvider

class CICLAnimationDataProvider : public CAnimationDataProvider, public MICLAnimationDataLoaderObserver;

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".

Derivation

• MICLAnimationDataLoaderObserver - No description.

• CBase - Base class for all classes to be instantiated on the heap.

• CAnimationDataProvider - Pure virtual base class for data providers.

• CICLAnimationDataProvider - Data provider for frame based animations.

Members

Defined in CICLAnimationDataProvider:

• CAnimationDataProvider_Reserved1()Reserved for future use
• CAnimationDataProvider_Reserved2()Reserved for future use
• CICLAnimationDataProvider()Default constructor.
• CICLAnimationDataProvider_Reserved1()Reserved for future use
• CICLAnimationDataProvider_Reserved2()Reserved for future use
• DataLoaderEventL(TDataLoaderEvent,TInt)
• DataType()Called from the animation to obtain the type of data to expect.
• SetFileL(RFs &,const TFileName &)Specifies the file to load the animation from.
• StartL()Implmenets CAnimationDataProvider::StartL()
• ~CICLAnimationDataProvider()Destructor.

Inherited from CAnimationDataProvider:

• SendEventL(TInt)Sends an event with no associated data to the observer.
• SendEventL(TInt,TAny *,TInt)Sends an event with an arbitrary size data item to the observer.
• SendEventL(TInt,TInt)Sends an event with a single integer data item to the observer.
• SetObserver(MAnimationDataProviderObserver *)Sets the destination for data from this data provider.
• iCAnimationDataProvider_ReservedReserved for future use
• iObserverThe destination to send data to. Usually an animation class.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Related Topics

 » Symbian OS v9.4 » Examples » Application Framework example code » AnimExample: An UI application with a toolbar

• Animation example

IMPORT_C CICLAnimationDataProvider();

Description

Default constructor.

IMPORT_C ~CICLAnimationDataProvider();

Description

Destructor.

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

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

Description

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

RFs &aFs A session with the file server const TBuf &aFileName The path to the image file to be loaded

IMPORT_C virtual TPtrC8 DataType();

Description

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

Return value

TPtrC8 An 8 bit identifier string

virtual void StartL();

Description

Implmenets CAnimationDataProvider::StartL()

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

protected: IMPORT_C virtual void CICLAnimationDataProvider_Reserved1();

Description

Reserved for future use

protected: IMPORT_C virtual void CICLAnimationDataProvider_Reserved2();

Description

Reserved for future use

protected: IMPORT_C virtual void CAnimationDataProvider_Reserved1();

Description

Reserved for future use

protected: IMPORT_C virtual void CAnimationDataProvider_Reserved2();

Description

Reserved for future use

private: virtual void DataLoaderEventL(TDataLoaderEvent aEvent, TInt aError);

Description

Parameters

MICLAnimationDataLoaderObserver::TDataLoaderEvent aEvent TInt aError