Class CAnimationFrame

class CAnimationFrame : public CBase;

Description

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.

Derivation

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

• CAnimationFrame - Data format for individual bitmap format animation frames

Members

Defined in CAnimationFrame:
Bitmap(), Bitmap(), CAnimationFrame_Reserved1(), CAnimationFrame_Reserved2(), CreateL(), FrameInfo(), FrameInfo(), GetHandles(), Mask(), Mask(), NewL(), NewL(), SetHandlesL(), THandles, ~CAnimationFrame()

Inherited from CBase:
Delete(), Extension_(), operator new()

See also:

• CICLAnimationDataProvider

virtual ~CAnimationFrame();

Description

Destructor.

static IMPORT_C CAnimationFrame *NewL();

Description

Two stage constructor.

After construction, the frame contains empty bitmaps.

Return value

CAnimationFrame * The new object

static IMPORT_C CAnimationFrame *NewL(const THandles &aHandles);

Description

Two stage constructor.

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

Parameters

const THandles &aHandles An internal data type used for transferring the contents

Return value

CAnimationFrame * The new object

See also:

• GetHandles()

IMPORT_C void GetHandles(THandles &aHandles) const;

Description

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

Parameters

THandles &aHandles A handles object to populate

See also:

• SetHandlesL()

IMPORT_C void SetHandlesL(const THandles &aHandles);

Description

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

Parameters

const THandles &aHandles A handles object obtained from a call to GetHandles

See also:

• GetHandles()

IMPORT_C void CreateL(const TFrameInfo &aFrameInfo);

Description

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

Parameters

const TFrameInfo &aFrameInfo A TFrameInfo object indicating the required size of the bitmaps.

inline CFbsBitmap *Bitmap();

Description

Returns the bitmap image for the changed area for this frame

Return value

CFbsBitmap * A pointer to a CFbsBitmap

inline const CFbsBitmap *Bitmap() const;

Description

Returns the bitmap image for the changed area for this frame

Return value

const CFbsBitmap * A pointer to a const CFbsBitmap

inline CFbsBitmap *Mask();

Description

Returns the bitmap mask for the changed area for this frame

Return value

CFbsBitmap * A pointer to a CFbsBitmap

inline const CFbsBitmap *Mask() const;

Description

Returns the bitmap mask for the changed area for this frame

Return value

const CFbsBitmap * A pointer to a const CFbsBitmap

inline TFrameInfo &FrameInfo();

Description

Returns information about the frame.

Return value

TFrameInfo & A TFrameInfo

inline const TFrameInfo &FrameInfo() const;

Description

Returns information about the frame.

Return value

const TFrameInfo & A const TFrameInfo

protected: virtual IMPORT_C void CAnimationFrame_Reserved1();

Description

Reserved for future use

protected: virtual IMPORT_C void CAnimationFrame_Reserved2();

Description

Reserved for future use

struct THandles;

Description

Structure used for passing a CAnimationFrame safely over a client/server connection.

Members

Defined in CAnimationFrame::THandles:
iBitmapHandle, iFrameInfo, iMaskHandle

Member data

---

iBitmapHandle

TInt iBitmapHandle;

Description

A handle to the bitmap into which the decoded frame(s) are put

---

iMaskHandle

TInt iMaskHandle;

Description

The bitmap mask for the changed area for this frame

---

iFrameInfo

TFrameInfo iFrameInfo;

Description

General frame info provided by all plugins