#include <mw/gulicon.h>
| class CGulIcon : public CBase |
| Public Member Functions | |
|---|---|
| ~CGulIcon() | |
| IMPORT_C CFbsBitmap * | Bitmap() |
| IMPORT_C TBool | BitmapsOwnedExternally() |
| IMPORT_C CFbsBitmap * | Mask() |
| IMPORT_C CGulIcon * | NewL() |
| IMPORT_C CGulIcon * | NewL(CFbsBitmap *, CFbsBitmap *) |
| IMPORT_C CGulIcon * | NewLC() |
| IMPORT_C void | SetBitmap(CFbsBitmap *) |
| IMPORT_C void | SetBitmapsOwnedExternally(TBool) |
| IMPORT_C void | SetMask(CFbsBitmap *) |
Packages two bitmaps, one each for an icon image and its mask.
| IMPORT_C CFbsBitmap * | Bitmap | ( | ) | const |
Gets the icon image's bitmap.
Does not normally imply transfer of ownership. Ownership can be transferred if bitmaps are set to be owned externally.
Returns: Pointer to the icon image's bitmap.
| IMPORT_C TBool | BitmapsOwnedExternally | ( | ) | const |
Gets the icon bitmap ownership.
Returns: ETrue if bitmaps are externally owned. EFalse if bitmaps are owned by this object.
| IMPORT_C CFbsBitmap * | Mask | ( | ) | const |
Gets the icon image's mask.
Transfers ownership to the caller if bitmaps are owned externally.
Returns: Pointer to the icon image's mask.
| IMPORT_C CGulIcon * | NewL | ( | CFbsBitmap * | aBitmap, |
| CFbsBitmap * | aMask = NULL | |||
| ) | [static] | |||
Creates a new icon using the bitmap and mask.
It takes ownership of the bitmap and mask and returns a pointer to the new object.
| Parameter | Description |
|---|---|
| aBitmap | The icon bitmap. |
| aMask | The icon mask. |
Returns: The new icon.
| IMPORT_C CGulIcon * | NewLC | ( | ) | [static] |
Creates a new icon and leaves it on the cleanup stack.
Returns: The new icon.
| IMPORT_C void | SetBitmap | ( | CFbsBitmap * | aBitmap | ) |
Sets the icon image's bitmap.
Transfers ownership to this object unless bitmaps are set to be owned externally.
| Parameter | Description |
|---|---|
| aBitmap | Pointer to the icon image's bitmap. |
| IMPORT_C void | SetBitmapsOwnedExternally | ( | TBool | aOwnedExternally | ) |
Sets the bitmap and mask to be owned externally.
| Parameter | Description |
|---|---|
| aOwnedExternally | ETrue if bitmaps are set as externally owned. EFalse if bitmaps are set as not being externally owned. |
| IMPORT_C void | SetMask | ( | CFbsBitmap * | aMask | ) |
Sets the icon image's mask.
Ownership is transferred to this object unless the bitmaps are owned externally.
The mask can be set to be identical to the bitmap if the bitmap is self-masking.
| Parameter | Description |
|---|---|
| aMask | Pointer to the icon image's mask. |