CAnimationFrame Class Reference

class CAnimationFrame : public CBase

Data format for individual bitmap format animation frames.

Animators and data providers which use the "bitmap" data type use objects of this type to transfer data.

You do not need to instantiate an object of this type unless you are writing a new data provider.

CBitmapAnimator

CICLAnimationDataProvider

Inherits from

Nested Classes and Structures

Constructor & Destructor Documentation

CAnimationFrame()

CAnimationFrame()[private, inline]

CAnimationFrame(const CAnimationFrame &)

CAnimationFrame(const CAnimationFrame &)[private]

Parameters

const CAnimationFrame &

~CAnimationFrame()

~CAnimationFrame()[virtual]

Destructor.

Member Functions Documentation

Bitmap()

CFbsBitmap *Bitmap()[inline]

Returns the bitmap image for the changed area for this frame A pointer to a CFbsBitmap

Bitmap()

const CFbsBitmap *Bitmap()const [inline]

Returns the bitmap image for the changed area for this frame A pointer to a const CFbsBitmap

CAnimationFrame_Reserved1()

IMPORT_C voidCAnimationFrame_Reserved1()[protected, virtual]

Reserved for future use

CAnimationFrame_Reserved2()

IMPORT_C voidCAnimationFrame_Reserved2()[protected, virtual]

Reserved for future use

ConstructL()

voidConstructL()[private]

CreateL(const TFrameInfo &)

IMPORT_C voidCreateL(const TFrameInfo &aFrameInfo)

Initialises the internal bitmaps to the correct sizes for the frame.

Parameters

const TFrameInfo & aFrameInfoA TFrameInfo object indicating the required size of the bitmaps.

FrameInfo()

TFrameInfo &FrameInfo()[inline]

Returns information about the frame. A TFrameInfo

FrameInfo()

const TFrameInfo &FrameInfo()const [inline]

Returns information about the frame. A const TFrameInfo

GetHandles(THandles &)

IMPORT_C voidGetHandles(THandles &aHandles)const

Obtains an alternative representation of the frame suitable for transferring over most interfaces (a THandle uses handles instead of pointers).

SetHandlesL()

Parameters

THandles & aHandlesA handles object to populate

Mask()

CFbsBitmap *Mask()[inline]

Returns the bitmap mask for the changed area for this frame A pointer to a CFbsBitmap

Mask()

const CFbsBitmap *Mask()const [inline]

Returns the bitmap mask for the changed area for this frame A pointer to a const CFbsBitmap

NewL()

IMPORT_C CAnimationFrame *NewL()[static]

Two stage constructor.

After construction, the frame contains empty bitmaps.

The new object

NewL(const THandles &)

IMPORT_C CAnimationFrame *NewL(const THandles &aHandles)[static]

Two stage constructor.

After construction, the frame contains the bitmaps specified in the handles argument.

GetHandles()

The new object

Parameters

const THandles & aHandlesAn internal data type used for transferring the contents

SetHandlesL(const THandles &)

IMPORT_C voidSetHandlesL(const THandles &aHandles)

Sets the contents of the internal bitmaps to those represented by the handles.

GetHandles()

Parameters

const THandles & aHandlesA handles object obtained from a call to GetHandles

operator=(const CAnimationFrame &)

CAnimationFrame &operator=(const CAnimationFrame &)[private]

Parameters

const CAnimationFrame &

Member Data Documentation

CFbsBitmap * iBitmap

CFbsBitmap *iBitmap[private]

TInt iCAnimationFrame_Reserved

TInt iCAnimationFrame_Reserved[private]

TFrameInfo iFrameInfo

TFrameInfo iFrameInfo[private]

CFbsBitmap * iMask

CFbsBitmap *iMask[private]