Symbian^3 Application Developer Library >

CAknsBmpAnimItemDef Class Reference

class CAknsBmpAnimItemDef : public CAknsImageTableItemDef

Bitmap animation item definition. Bitmap animationitem definition contains (in addition to base class data) animation properties and an array containing frame properties. Item type for image table item definitions is always EAknsITBmpAnim .

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

AknSkinSrv.lib

Since
2.0

Inherits from

Public Member Functions
~CAknsBmpAnimItemDef ()
IMPORT_C TBool Flash ()
IMPORT_C const TAknsBmpAnimFrameInfo * FrameInfos ()
IMPORT_C TInt16 FrameInterval ()
IMPORT_C TBool LastFrameBackground ()
IMPORT_C CAknsBmpAnimItemDef * NewL (const TAknsItemID &, const TInt , const TAknsItemID *const , const TAknsBmpAnimFrameInfo *const )
IMPORT_C CAknsBmpAnimItemDef * NewL (const TAknsItemID &)
IMPORT_C TInt16 PlayMode ()
IMPORT_C void SetFlash (const TBool )
IMPORT_C void SetFrameInfos (const TAknsBmpAnimFrameInfo *const )
IMPORT_C void SetFrameInfosL (const TAknsBmpAnimFrameInfo *const )
IMPORT_C void SetFrameInterval (const TInt16 )
IMPORT_C void SetLastFrameBackground ( TBool )
IMPORT_C void SetPlayMode (const TInt16 )
Protected Member Functions
CAknsBmpAnimItemDef (const TAknsItemType , const TAknsItemID &)
Inherited Functions
CAknsImageItemDef::Attributes()const
CAknsImageItemDef::CAknsImageItemDef(const TAknsItemType,const TAknsItemID &)
CAknsImageItemDef::SetAttributesL(const TAknsImageAttributeData &)
CAknsImageItemDef::~CAknsImageItemDef()
CAknsImageTableItemDef::CAknsImageTableItemDef(const TAknsItemType,const TAknsItemID &)
CAknsImageTableItemDef::Images()const
CAknsImageTableItemDef::NewL(const TAknsItemID &,const TInt,const TAknsItemID *const )
CAknsImageTableItemDef::NumberOfImages()const
CAknsImageTableItemDef::SetImages(const TInt,const TAknsItemID *const )
CAknsImageTableItemDef::SetImagesL(const TInt,const TAknsItemID *const )
CAknsImageTableItemDef::~CAknsImageTableItemDef()
CAknsItemDef::CAknsItemDef(const TAknsItemType,const TAknsItemID &)
CAknsItemDef::ID()const
CAknsItemDef::LinearOrder(const CAknsItemDef &,const CAknsItemDef &)
CAknsItemDef::Type()const
CAknsItemDef::~CAknsItemDef()
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()
Protected Attributes
TBool iFlash
const TAknsBmpAnimFrameInfo * iFrameArray
TInt16 iFrameInterval
TAknsBmpAnimFrameInfo * iInternalFrameArray
TBool iLastFrameBackground
TInt16 iPlayMode
Inherited Attributes
CAknsImageItemDef::iAttributeData
CAknsImageTableItemDef::iImageArray
CAknsImageTableItemDef::iInternalImageArray
CAknsImageTableItemDef::iNumberOfImages
CAknsItemDef::iID
CAknsItemDef::iSpare1
CAknsItemDef::iSpare2
CAknsItemDef::iType

Constructor & Destructor Documentation

CAknsBmpAnimItemDef(const TAknsItemType, const TAknsItemID &)

CAknsBmpAnimItemDef ( const TAknsItemType aType,
const TAknsItemID & aID
) [protected]

C++ constructor for internal use. Constructs bitmap animation item definition object with given ID. The image array and frame properties must be set separately.

Parameters

const TAknsItemType aType Type of the definition object. While this is always EAknsITBmpAnim for CAknsBmpAnimItemDef objects, derived classes may specify other values.
const TAknsItemID & aID Item ID of the new item definition.

~CAknsBmpAnimItemDef()

~CAknsBmpAnimItemDef ( ) [virtual]

Destructor. If the object owns an array, it is destroyed.

Member Functions Documentation

Flash()

IMPORT_C TBool Flash ( ) const

Retrieves the flash property.

Since
2.0

FrameInfos()

IMPORT_C const TAknsBmpAnimFrameInfo * FrameInfos ( ) const

Returns pointer to the first element of the frame info array.

Since
2.0

FrameInterval()

IMPORT_C TInt16 FrameInterval ( ) const

Retrieves the frame interval.

Since
2.0

LastFrameBackground()

IMPORT_C TBool LastFrameBackground ( ) const

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

Since
2.0

NewL(const TAknsItemID &, const TInt, const TAknsItemID *const, const TAknsBmpAnimFrameInfo *const)

IMPORT_C CAknsBmpAnimItemDef * NewL ( const TAknsItemID & aID,
const TInt aNumberOfImages,
const TAknsItemID *const aImages,
const TAknsBmpAnimFrameInfo *const aFrameInfos
) [static]

Two-phased constructor, complete initialization. Constructs a bitmap animation item definition object.

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

Parameters

const TAknsItemID & aID Item ID of the new object.
const TInt aNumberOfImages Number of entries in aImages.
const TAknsItemID *const aImages Pointer to the first item ID. An internal pointer is set to point to the same place as the given one. Ownership of the array stays with the caller and it must ensure that its lifetime is appropriate.
const TAknsBmpAnimFrameInfo *const aFrameInfos Pointer to the first frame info. Ownership is handled as with aImages.

NewL(const TAknsItemID &)

IMPORT_C CAknsBmpAnimItemDef * NewL ( const TAknsItemID & aID ) [static]

Two-phased constructor, partial initialization. Constructs a new bitmap animation item definition object. Images must be set separately by using SetImagesL and SetFrameInfosL or SetImages and SetFrameInfos.

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

Parameters

const TAknsItemID & aID Item ID of the new object.

PlayMode()

IMPORT_C TInt16 PlayMode ( ) const

Retrieves the play mode.

Since
2.0

SetFlash(const TBool)

IMPORT_C void SetFlash ( const TBool aFlash )

Sets the flash property for the entire animation.

Since
2.0

Parameters

const TBool aFlash Flash flag value.

SetFrameInfos(const TAknsBmpAnimFrameInfo *const)

IMPORT_C void SetFrameInfos ( const TAknsBmpAnimFrameInfo *const aFrameInfos )

Sets frame properties, ownership of the frame info array stays with the caller. If this object already owns an array, it is destroyed.

The number of frame info objects in the array must match the number of images. This implies that SetFrameInfos can not be called before images have been set.

Since
2.0

Parameters

const TAknsBmpAnimFrameInfo *const aFrameInfos Pointer to the first TAknsBmpAnimFrameInfo. The caller still owns the array and must ensure that its lifetime is appropriate.

SetFrameInfosL(const TAknsBmpAnimFrameInfo *const)

IMPORT_C void SetFrameInfosL ( const TAknsBmpAnimFrameInfo *const aFrameInfos )

Sets frame propertis, content of the array is copied to an internal array. If this object already owns an array, it is destroyed.

The number of frame info objects in the array must match the number of images. This implies that SetFrameInfosL can not be called before images have been set.

Since
2.0
Exceptions:
If allocation fails, returns with an error code.

Parameters

const TAknsBmpAnimFrameInfo *const aFrameInfos Pointer to the first TAknsBmpAnimFrameInfo.

SetFrameInterval(const TInt16)

IMPORT_C void SetFrameInterval ( const TInt16 aFrameInterval )

Sets the frame interval for the entire animation.

Since
2.0

Parameters

const TInt16 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

Parameters

TBool aLastFrameBg Boolean value.

SetPlayMode(const TInt16)

IMPORT_C void SetPlayMode ( const TInt16 aPlayMode )

Sets the play mode for the entire animation.

Since
2.0

Parameters

const TInt16 aPlayMode Play mode.

Member Data Documentation

TBool iFlash

TBool iFlash [protected]

const TAknsBmpAnimFrameInfo * iFrameArray

const TAknsBmpAnimFrameInfo * iFrameArray [protected]

TInt16 iFrameInterval

TInt16 iFrameInterval [protected]

TAknsBmpAnimFrameInfo * iInternalFrameArray

TAknsBmpAnimFrameInfo * iInternalFrameArray [protected]

TBool iLastFrameBackground

TBool iLastFrameBackground [protected]

TInt16 iPlayMode

TInt16 iPlayMode [protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.