CAknsMaskedBitmapItemData Class Reference

#include <mw/AknsItemData.h>

Link against: AknSkins.lib

class CAknsMaskedBitmapItemData : public CAknsBitmapItemData

Inherits from

Protected Attributes
CFbsBitmap *iMask
Public Member Functions
virtual ~CAknsMaskedBitmapItemData()
IMPORT_C voidDestroyAndSetMask(CFbsBitmap *)
IMPORT_C CFbsBitmap *Mask()
IMPORT_C CAknsMaskedBitmapItemData *NewL()
IMPORT_C voidSetMask(CFbsBitmap *)
Protected Member Functions
CAknsMaskedBitmapItemData(const TAknsItemType)
Inherited Attributes
CAknsBitmapItemData::iBitmap
CAknsImageItemData::iAttributeData
CAknsImageItemData::iDrawRect
CAknsImageItemData::iParentIID
CAknsItemData::iType
Inherited Functions
CAknsBitmapItemData::Bitmap()
CAknsBitmapItemData::CAknsBitmapItemData(const TAknsItemType)
CAknsBitmapItemData::DestroyAndSetBitmap(CFbsBitmap *)
CAknsBitmapItemData::SetBitmap(CFbsBitmap *)
CAknsBitmapItemData::~CAknsBitmapItemData()
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()
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

Masked bitmap item data. Masked bitmap item data contains (in addition to base class members) an additional member of type CFbsBitmap for the bitmap mask. Item type for bitmap item data is always EAknsITMaskedBitmap.

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

Since
2.0

Member Attribute Documentation

iMask

CFbsBitmap *iMask[protected]

Pointer to associated mask bitmap instance.

Constructor & Destructor Documentation

CAknsMaskedBitmapItemData ( const TAknsItemType )

CAknsMaskedBitmapItemData(const TAknsItemTypeaType)[protected]

C++ protected constructor. Constructs a new CAknsMaskedBitmapItemData with bitmaps set to NULL.

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

~CAknsMaskedBitmapItemData ( )

~CAknsMaskedBitmapItemData()[virtual]

Destructor. Deletes bitmap objects, if present.

Member Function Documentation

DestroyAndSetMask ( CFbsBitmap * )

IMPORT_C voidDestroyAndSetMask(CFbsBitmap *aMask)

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

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

Mask ( )

IMPORT_C CFbsBitmap *Mask()

Returns the current bitmap mask object owned by item data instance.

Since
2.0

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

NewL ( )

IMPORT_C CAknsMaskedBitmapItemData *NewL()[static]

Reimplemented from CAknsBitmapItemData::NewL()

Two-phased constructor. Constructs a new CAknsMaskedBitmapItemData object with bitmaps set to NULL. Bitmaps must be set afterwards by using SetBitmap(CFbsBitmap* aBitmap) and SetMask(CFbsBitmap* aBitmap) methods.

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

Returns: Newly constructed CAknsMaskedBitmapItemData object.

SetMask ( CFbsBitmap * )

IMPORT_C voidSetMask(CFbsBitmap *aMask)

Sets the mask bitmap object for this item data instance. NULL value can be used to detach bitmap mask from item data.

Since
2.0
ParameterDescription
aMaskPointer to mask instance. Ownership of the bitmap object is transferred to item data. NULL value is also valid.
© Nokia 2011.