CAknsBmpAnimItemData Class Reference

API published in: S60 2nd Ed

Link against: aknskins.lib aknskinsrv.lib aknswallpaperutils.lib

Capability Information

Required Capabilities

None

#include <aknsitemdata.h>

Inherits CAknsImageTableItemData.

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.


Public Member Functions

virtual ~CAknsBmpAnimItemData ()
 Destructor.
IMPORT_C void SetFrameInfosL (const TAknsBmpAnimFrameInfo *aFrameInfos)
 Sets frame property values for this item data instance.
IMPORT_C TAknsBmpAnimFrameInfo * FrameInfos () const
 Returns pointer to the first entry in the frame property array, owned by this object.
IMPORT_C void SetLastFrameBackground (TBool aLastFrameBg)
 Sets the flag indicating whether the last frame should be interpreted as the background (i.e.
IMPORT_C TBool LastFrameBackground () const
 Retrieves the flag value indicating whether the last frame should be interpreted as the background.
IMPORT_C void SetFrameInterval (const TInt16 aFrameInterval)
 Sets the frame interval for the entire animation.
IMPORT_C TInt16 FrameInterval () const
 Retrieves the frame interval.
IMPORT_C void SetPlayMode (const TInt16 aPlayMode)
 Sets the play mode for the entire animation.
IMPORT_C TInt16 PlayMode () const
 Retrieves the play mode.
IMPORT_C void SetFlash (const TBool aFlash)
 Sets the flash property for the entire animation.
IMPORT_C TBool Flash () const
 Retrieves the flash property.

Static Public Member Functions

static IMPORT_C CAknsBmpAnimItemData * NewL ()
 Two-phased constructor.

Protected Member Functions

 CAknsBmpAnimItemData (const TAknsItemType aType)
 C++ protected constructor.

Protected Attributes

TAknsBmpAnimFrameInfo * iFrameArray
 Frame info array.
TBool iLastFrameBackground
 Last frame used as background flag.
TInt16 iFrameInterval
 Frame interval.
TInt16 iPlayMode
 Play mode.
TBool iFlash
 Flash flag.

Constructor & Destructor Documentation

virtual CAknsBmpAnimItemData::~CAknsBmpAnimItemData (   )  [virtual]
 

Destructor.

Destroys arrays.

CAknsBmpAnimItemData::CAknsBmpAnimItemData ( const TAknsItemType  aType  )  [protected]
 

C++ protected constructor.

Constructs a new CAknsBmpAnimItemData without an array.

Parameters:
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.

Member Function Documentation

IMPORT_C TBool CAknsBmpAnimItemData::Flash (   )  const
 

Retrieves the flash property.

Returns:
Flash flag value.
IMPORT_C TAknsBmpAnimFrameInfo* CAknsBmpAnimItemData::FrameInfos (   )  const
 

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

Returns:
Pointer to TAknsBmpAnimFrameInfo.
IMPORT_C TInt16 CAknsBmpAnimItemData::FrameInterval (   )  const
 

Retrieves the frame interval.

Returns:
Frame interval in milliseconds or -1.
IMPORT_C TBool CAknsBmpAnimItemData::LastFrameBackground (   )  const
 

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

Returns:
Boolean value.
static IMPORT_C CAknsBmpAnimItemData* CAknsBmpAnimItemData::NewL (   )  [static]
 

Two-phased constructor.

Constructs a new CAknsBmpAnimItemData object. Values must be set separately using SetImagesL and SetFrameInfosL.

Returns:
Newly constructed CAknsBmpAnimItemData object.
Exceptions:
If allocation fails, function leaves with a system-wide error code.

Reimplemented from CAknsImageTableItemData.

IMPORT_C TInt16 CAknsBmpAnimItemData::PlayMode (   )  const
 

Retrieves the play mode.

Returns:
Play mode.
IMPORT_C void CAknsBmpAnimItemData::SetFlash ( const TBool  aFlash  ) 
 

Sets the flash property for the entire animation.

Parameters:
aFlash Flash flag value.
IMPORT_C void CAknsBmpAnimItemData::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.

Parameters:
aFrameInfos Pointer to first frame info. Values are copied into an internal array.
IMPORT_C void CAknsBmpAnimItemData::SetFrameInterval ( const TInt16  aFrameInterval  ) 
 

Sets the frame interval for the entire animation.

Parameters:
aFrameInterval Frame interval in milliseconds or -1.
IMPORT_C void CAknsBmpAnimItemData::SetLastFrameBackground ( TBool  aLastFrameBg  ) 
 

Sets the flag indicating whether the last frame should be interpreted as the background (i.e.

excluded from the animation itself).

Parameters:
aLastFrameBg Boolean value.
IMPORT_C void CAknsBmpAnimItemData::SetPlayMode ( const TInt16  aPlayMode  ) 
 

Sets the play mode for the entire animation.

Parameters:
aPlayMode Play mode.

Field Documentation

TBool CAknsBmpAnimItemData::iFlash [protected]
 

Flash flag.

TAknsBmpAnimFrameInfo* CAknsBmpAnimItemData::iFrameArray [protected]
 

Frame info array.

TInt16 CAknsBmpAnimItemData::iFrameInterval [protected]
 

Frame interval.

TBool CAknsBmpAnimItemData::iLastFrameBackground [protected]
 

Last frame used as background flag.

TInt16 CAknsBmpAnimItemData::iPlayMode [protected]
 

Play mode.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top