CAknsBmpAnimItemData Class Reference

#include <mw/AknsItemData.h>

Link against: AknSkins.lib

class CAknsBmpAnimItemData : public CAknsImageTableItemData

Inherits from

CAknsBmpAnimItemData
- CAknsImageTableItemData
  - CAknsImageItemData
    - CAknsItemData

Protected Attributes
TBool	iFlash
TAknsBmpAnimFrameInfo *	iFrameArray
TInt16	iFrameInterval
TBool	iLastFrameBackground
TInt16	iPlayMode

Public Member Functions
virtual	~CAknsBmpAnimItemData()
IMPORT_C TBool	Flash()
IMPORT_C TAknsBmpAnimFrameInfo *	FrameInfos()
IMPORT_C TInt16	FrameInterval()
IMPORT_C TBool	LastFrameBackground()
IMPORT_C CAknsBmpAnimItemData *	NewL()
IMPORT_C TInt16	PlayMode()
IMPORT_C void	SetFlash(const TBool)
IMPORT_C void	SetFrameInfosL(const TAknsBmpAnimFrameInfo *)
IMPORT_C void	SetFrameInterval(const TInt16)
IMPORT_C void	SetLastFrameBackground(TBool)
IMPORT_C void	SetPlayMode(const TInt16)

Protected Member Functions
	CAknsBmpAnimItemData(const TAknsItemType)

Inherited Attributes
	CAknsImageItemData::iAttributeData
	CAknsImageItemData::iDrawRect
	CAknsImageItemData::iParentIID
	CAknsImageTableItemData::iImageArray
	CAknsImageTableItemData::iNumberOfImages
	CAknsItemData::iType

Inherited Functions
	CAknsImageItemData::Attributes()const
	CAknsImageItemData::CAknsImageItemData(const TAknsItemType)
	CAknsImageItemData::DrawRect()
	CAknsImageItemData::ParentIID()
	CAknsImageItemData::SetAttributesL(const TAknsImageAttributeData &)
	CAknsImageItemData::SetDrawRect(const TRect &)
	CAknsImageItemData::SetParentIID(const TAknsItemID &)
	CAknsImageItemData::~CAknsImageItemData()
	CAknsImageTableItemData::CAknsImageTableItemData(const TAknsItemType)
	CAknsImageTableItemData::ImageIID(const TInt)const
	CAknsImageTableItemData::Images()const
	CAknsImageTableItemData::NumberOfImages()const
	CAknsImageTableItemData::SetImagesL(const TInt,const TAknsItemID *)
	CAknsImageTableItemData::~CAknsImageTableItemData()
	CAknsItemData::CAknsItemData(const TAknsItemType)
	CAknsItemData::SetType(const TAknsItemType)
	CAknsItemData::Type()const
	CAknsItemData::~CAknsItemData()
	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

Bitmap animation item data. Bitmap animation item data contains (in addition to base class members), animation properties as well as an array containing frame properties Item type for bitmap animation item data objects is always EAknsITBmpAnim.

This is a public class with exported functions. The class is not intended for derivation outside the library.

Since: 2.0

Member Attribute Documentation

iFlash

TBool

iFlash

[protected]

Flash flag.

iFrameArray

TAknsBmpAnimFrameInfo *

iFrameArray

[protected]

Frame info array.

iFrameInterval

TInt16

iFrameInterval

[protected]

Frame interval.

iLastFrameBackground

TBool

iLastFrameBackground

[protected]

Last frame used as background flag.

iPlayMode

TInt16

iPlayMode

[protected]

Play mode.

Constructor & Destructor Documentation

CAknsBmpAnimItemData ( const TAknsItemType )

CAknsBmpAnimItemData

(

const TAknsItemType

aType

)

[protected]

C++ protected constructor. Constructs a new CAknsBmpAnimItemData without an array.

Parameter	Description
aType	Item type of the new item data object. While this is always EAknsITBmpAnim for instances of this class, derived classes may specify another value.

~CAknsBmpAnimItemData ( )

~CAknsBmpAnimItemData

(

)

[virtual]

Destructor. Destroys arrays.

Member Function Documentation

Flash ( )

IMPORT_C TBool

Flash

(

)

const

Retrieves the flash property.

Since: 2.0

Returns: Flash flag value.

FrameInfos ( )

IMPORT_C TAknsBmpAnimFrameInfo *

FrameInfos

(

)

const

Returns pointer to the first entry in the frame property array, owned by this object.

Since: 2.0

Returns: Pointer to TAknsBmpAnimFrameInfo.

FrameInterval ( )

IMPORT_C TInt16

FrameInterval

(

)

const

Retrieves the frame interval.

Since: 2.0

Returns: Frame interval in milliseconds or -1.

LastFrameBackground ( )

IMPORT_C TBool

LastFrameBackground

(

)

const

Retrieves the flag value indicating whether the last frame should be interpreted as the background.

Since: 2.0

Returns: Boolean value.

NewL ( )

IMPORT_C CAknsBmpAnimItemData *

NewL

(

)

[static]

Reimplemented from CAknsImageTableItemData::NewL()

Two-phased constructor. Constructs a new CAknsBmpAnimItemData object. Values must be set separately using SetImagesL and SetFrameInfosL.

Exceptions:: If allocation fails, function leaves with a system-wide error code.

Returns: Newly constructed CAknsBmpAnimItemData object.

PlayMode ( )

IMPORT_C TInt16

PlayMode

(

)

const

Retrieves the play mode.

Since: 2.0

Returns: Play mode.

SetFlash ( const TBool )

IMPORT_C void

SetFlash

(

const TBool

aFlash

)

Sets the flash property for the entire animation.

Since: 2.0

Parameter	Description
aFlash	Flash flag value.

SetFrameInfosL ( const TAknsBmpAnimFrameInfo * )

IMPORT_C void

SetFrameInfosL

(

const TAknsBmpAnimFrameInfo *

aFrameInfos

)

Sets frame property values for this item data instance.

The number of entries in the given array must match the number of images in the image table. Therefore SetFrameInfosL must be called only after SetImagesL has already been called.

Since: 2.0

Parameter	Description
aFrameInfos	Pointer to first frame info. Values are copied into an internal array.

SetFrameInterval ( const TInt16 )

IMPORT_C void

SetFrameInterval

(

const TInt16

aFrameInterval

)

Sets the frame interval for the entire animation.

Since: 2.0

Parameter	Description
aFrameInterval	Frame interval in milliseconds or -1.

SetLastFrameBackground ( TBool )

IMPORT_C void

SetLastFrameBackground

(

TBool

aLastFrameBg

)

Sets the flag indicating whether the last frame should be interpreted as the background (i.e. excluded from the animation itself).

Since: 2.0

Parameter	Description
aLastFrameBg	Boolean value.

SetPlayMode ( const TInt16 )

IMPORT_C void

SetPlayMode

(

const TInt16

aPlayMode

)

Sets the play mode for the entire animation.

Since: 2.0

Parameter	Description
aPlayMode	Play mode.