CAknsMaskedBitmapItemData 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 CAknsBitmapItemData.
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.
|
Public Member Functions
|
| virtual |
~CAknsMaskedBitmapItemData ()
|
| |
Destructor.
|
| IMPORT_C void |
SetMask (CFbsBitmap *aMask)
|
| |
Sets the mask bitmap object for this item data instance.
|
| IMPORT_C void |
DestroyAndSetMask (CFbsBitmap *aMask)
|
| |
Sets the mask bitmap object for this item data instance and destroys previous one, if any.
|
| IMPORT_C CFbsBitmap * |
Mask ()
|
| |
Returns the current bitmap mask object owned by item data instance.
|
Static Public Member Functions
|
| static IMPORT_C CAknsMaskedBitmapItemData *
|
NewL ()
|
| |
Two-phased constructor.
|
Protected Member Functions
|
| |
CAknsMaskedBitmapItemData (const TAknsItemType aType)
|
| |
C++ protected constructor.
|
Protected Attributes
|
| CFbsBitmap * |
iMask |
| |
Pointer to associated mask bitmap instance.
|
Constructor & Destructor Documentation
| virtual CAknsMaskedBitmapItemData::~CAknsMaskedBitmapItemData |
( |
|
) |
[virtual] |
|
|
|
Destructor.
Deletes bitmap objects, if present.
|
| CAknsMaskedBitmapItemData::CAknsMaskedBitmapItemData |
( |
const TAknsItemType
|
aType
|
) |
[protected] |
|
|
|
C++ protected constructor.
Constructs a new CAknsMaskedBitmapItemData with bitmaps set to NULL.
- Parameters:
-
|
aType
|
Item type of the new item data object. While this is always EAknsITMaskedBitmap for instances of this class, derived classes may specify another value.
|
|
Member Function Documentation
| IMPORT_C void CAknsMaskedBitmapItemData::DestroyAndSetMask |
( |
CFbsBitmap * |
aMask
|
) |
|
|
|
|
Sets the mask bitmap object for this item data instance and destroys previous one, if any.
- Parameters:
-
|
aMask
|
Pointer to mask instance. Ownership of the bitmap object is transferred to item data. NULL value is also valid.
|
|
| IMPORT_C CFbsBitmap* CAknsMaskedBitmapItemData::Mask |
( |
|
) |
|
|
|
|
Returns the current bitmap mask object owned by item data instance.
- Returns:
- Pointer to mask instance, or
NULL if none is currently associated with this item data.
|
|
|
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.
- Returns:
- Newly constructed CAknsMaskedBitmapItemData object.
- Exceptions:
- If allocation fails, function leaves with a system-wide error code.
Reimplemented from CAknsBitmapItemData.
|
| IMPORT_C void CAknsMaskedBitmapItemData::SetMask |
( |
CFbsBitmap * |
aMask
|
) |
|
|
|
|
Sets the mask bitmap object for this item data instance.
NULL value can be used to detach bitmap mask from item data.
- Parameters:
-
|
aMask
|
Pointer to mask instance. Ownership of the bitmap object is transferred to item data. NULL value is also valid.
|
|
Field Documentation
|
|
Pointer to associated mask bitmap instance.
|
The documentation for this class was generated from the following file:
