CAnimationFrame Class Reference

#include <mw/animationframe.h>

Link against: animationshared.lib

class CAnimationFrame : public CBase, public CBase

Inherits from

CAnimationFrame
- CBase
- CBase

Nested Classes and Structures

CAnimationFrame::THandles

Public Member Functions
virtual	~CAnimationFrame()
CFbsBitmap *	Bitmap()
const CFbsBitmap *	Bitmap()
IMPORT_C void	CreateL(const TFrameInfo &)
TFrameInfo &	FrameInfo()
const TFrameInfo &	FrameInfo()
IMPORT_C void	GetHandles(THandles &)
CFbsBitmap *	Mask()
const CFbsBitmap *	Mask()
IMPORT_C CAnimationFrame *	NewL()
IMPORT_C CAnimationFrame *	NewL(const THandles &)
IMPORT_C void	SetHandlesL(const THandles &)

Protected Member Functions
virtual IMPORT_C void	CAnimationFrame_Reserved1()
virtual IMPORT_C void	CAnimationFrame_Reserved2()

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

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.

See also: CBitmapAnimator CICLAnimationDataProvider

Constructor & Destructor Documentation

~CAnimationFrame ( )

~CAnimationFrame

(

)

[virtual]

Destructor.

Member Function Documentation

Bitmap ( )

CFbsBitmap *

Bitmap

(

)

[inline]

Returns the bitmap image for the changed area for this frame

Return Value: A pointer to a CFbsBitmap

Bitmap ( )

const CFbsBitmap *

Bitmap

(

)

const [inline]

Returns the bitmap image for the changed area for this frame

Return Value: A pointer to a const CFbsBitmap

CAnimationFrame_Reserved1 ( )

IMPORT_C void

CAnimationFrame_Reserved1

(

)

[protected, virtual]

Reserved for future use

CAnimationFrame_Reserved2 ( )

IMPORT_C void

CAnimationFrame_Reserved2

(

)

[protected, virtual]

Reserved for future use

CreateL ( const TFrameInfo & )

IMPORT_C void

CreateL

(

const TFrameInfo &

aFrameInfo

)

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

Parameters
aFrameInfo	A TFrameInfo object indicating the required size of the bitmaps.

FrameInfo ( )

TFrameInfo &

FrameInfo

(

)

[inline]

Returns information about the frame.

Return Value: A TFrameInfo

FrameInfo ( )

const TFrameInfo &

FrameInfo

(

)

const [inline]

Returns information about the frame.

Return Value: A const TFrameInfo

GetHandles ( THandles & )

IMPORT_C void

GetHandles

(

THandles &

aHandles

)

const

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

Parameters
aHandles	A handles object to populate

Mask ( )

CFbsBitmap *

Mask

(

)

[inline]

Returns the bitmap mask for the changed area for this frame

Return Value: A pointer to a CFbsBitmap

Mask ( )

const CFbsBitmap *

Mask

(

)

const [inline]

Returns the bitmap mask for the changed area for this frame

Return Value: A pointer to a const CFbsBitmap

NewL ( )

IMPORT_C CAnimationFrame *

NewL

(

)

[static]

Two stage constructor.

After construction, the frame contains empty bitmaps.

Return Value: 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.

Parameters
aHandles	An internal data type used for transferring the contents

SetHandlesL ( const THandles & )

IMPORT_C void

SetHandlesL

(

const THandles &

aHandles

)

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