CAknsBitmapItemData Class Reference

#include <mw/AknsItemData.h>

Link against: AknSkins.lib

class CAknsBitmapItemData : public CAknsImageItemData

Inherits from

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.

Since
2.0

Member Attribute Documentation

iBitmap

CFbsBitmap *iBitmap[protected]

Pointer to associated bitmap instance.

Constructor & Destructor Documentation

CAknsBitmapItemData ( const TAknsItemType )

CAknsBitmapItemData(const TAknsItemTypeaType)[protected]

C++ protected constructor. Constructs a new CAknsBitmapItemData with bitmap set to NULL.

ParameterDescription
aTypeItem type of the new item data object. While this is always EAknsITBitmap for instances of this class, derived classes may specify another value.

~CAknsBitmapItemData ( )

~CAknsBitmapItemData()[virtual]

Destructor. Deletes bitmap object, if present.

Member Function Documentation

Bitmap ( )

IMPORT_C CFbsBitmap *Bitmap()

Returns the current bitmap object owned by item data instance.

Since
2.0

Returns: Pointer to bitmap instance, or NULL if none is currently associated with this item data.

DestroyAndSetBitmap ( CFbsBitmap * )

IMPORT_C voidDestroyAndSetBitmap(CFbsBitmap *aBitmap)

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

Since
2.0
ParameterDescription
aBitmapPointer to bitmap instance. Ownership of the bitmap object is transferred to item data. NULL value is also valid.

NewL ( )

IMPORT_C 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.

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

Returns: Newly constructed CAknsBitmapItemData object.

SetBitmap ( CFbsBitmap * )

IMPORT_C voidSetBitmap(CFbsBitmap *aBitmap)

Sets the bitmap object for this item data instance.

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

ParameterDescription
aBitmapPointer to bitmap instance. Ownership of the bitmap object is transferred to item data. NULL value is also valid.