CAknsBitmapItemData 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 CAknsImageItemData.

Inherited by CAknsMaskedBitmapItemData.


Detailed Description

Bitmap item data.

Bitmap item data contains (in addition to base class members) CFbsBitmap instance of the bitmap. Item type for bitmap item data is always EAknsITBitmap.

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


Public Member Functions

virtual  ~CAknsBitmapItemData ()
  Destructor.
IMPORT_C void  SetBitmap (CFbsBitmap *aBitmap)
  Sets the bitmap object for this item data instance.
IMPORT_C void  DestroyAndSetBitmap (CFbsBitmap *aBitmap)
  Sets the bitmap object for this item data instance and destroys previous one, if any.
IMPORT_C CFbsBitmap *  Bitmap ()
  Returns the current bitmap object owned by item data instance.

Static Public Member Functions

static IMPORT_C CAknsBitmapItemData NewL ()
  Two-phased constructor.

Protected Member Functions

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

Protected Attributes

CFbsBitmap *  iBitmap
  Pointer to associated bitmap instance.

Constructor & Destructor Documentation

virtual CAknsBitmapItemData::~CAknsBitmapItemData  )  [virtual]
 

Destructor.

Deletes bitmap object, if present.

CAknsBitmapItemData::CAknsBitmapItemData const TAknsItemType  aType  )  [protected]
 

C++ protected constructor.

Constructs a new CAknsBitmapItemData with bitmap set to NULL.

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

Member Function Documentation

IMPORT_C CFbsBitmap* CAknsBitmapItemData::Bitmap  ) 
 

Returns the current bitmap object owned by item data instance.

Returns:
Pointer to bitmap instance, or NULL if none is currently associated with this item data.
IMPORT_C void CAknsBitmapItemData::DestroyAndSetBitmap CFbsBitmap *  aBitmap  ) 
 

Sets the bitmap object for this item data instance and destroys previous one, if any.

Parameters:
aBitmap  Pointer to bitmap instance. Ownership of the bitmap object is transferred to item data. NULL value is also valid.
static IMPORT_C CAknsBitmapItemData* CAknsBitmapItemData::NewL  )  [static]
 

Two-phased constructor.

Constructs a new CAknsBitmapItemData object with bitmap set to NULL. Bitmap must be set afterwards by using SetBitmap(CFbsBitmap* aBitmap) method.

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

Reimplemented in CAknsMaskedBitmapItemData.

IMPORT_C void CAknsBitmapItemData::SetBitmap CFbsBitmap *  aBitmap  ) 
 

Sets the bitmap object for this item data instance.

NULL value can be used to detach bitmap from item data.

Parameters:
aBitmap  Pointer to bitmap instance. Ownership of the bitmap object is transferred to item data. NULL value is also valid.

Field Documentation

CFbsBitmap* CAknsBitmapItemData::iBitmap [protected]
 

Pointer to associated bitmap instance.


The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top