Class CGulIcon

class CGulIcon : public CBase;

Description

Packages two bitmaps, one each for an icon image and its mask.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CGulIcon - Packages two bitmaps, one each for an icon image and its mask

Members

Defined in CGulIcon:
Bitmap(), BitmapsOwnedExternally(), Mask(), NewL(), NewL(), NewLC(), SetBitmap(), SetBitmapsOwnedExternally(), SetMask(), ~CGulIcon()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CGulIcon *NewLC();

Description

Creates a new icon and leaves it on the cleanup stack.

Return value

CGulIcon * The new icon.

static IMPORT_C CGulIcon *NewL();

Description

Creates a new icon.

Return value

CGulIcon * The new icon.

static IMPORT_C CGulIcon *NewL(CFbsBitmap *aBitmap, CFbsBitmap *aMask=0);

Description

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.

Parameters

CFbsBitmap *aBitmap The icon bitmap. CFbsBitmap *aMask The icon mask.

Return value

CGulIcon * The new icon.

IMPORT_C ~CGulIcon();

Description

Destructor.

IMPORT_C void SetBitmap(CFbsBitmap *aBitmap);

Description

Sets the icon image's bitmap.

Transfers ownership to this object unless bitmaps are set to be owned externally.

Parameters

CFbsBitmap *aBitmap Pointer to the icon image's bitmap.

IMPORT_C void SetMask(CFbsBitmap *aMask);

Description

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.

Parameters

CFbsBitmap *aMask Pointer to the icon image's mask.

IMPORT_C CFbsBitmap *Bitmap() const;

Description

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.

Return value

CFbsBitmap * Pointer to the icon image's bitmap.

IMPORT_C CFbsBitmap *Mask() const;

Description

Gets the icon image's mask.

Transfers ownership to the caller if bitmaps are owned externally.

Return value

CFbsBitmap * Pointer to the icon image's mask.

IMPORT_C void SetBitmapsOwnedExternally(TBool aOwnedExternally);

Description

Sets the bitmap and mask to be owned externally.

Parameters

TBool aOwnedExternally ETrue if bitmaps are set as externally owned. EFalse if bitmaps are set as not being externally owned.

IMPORT_C TBool BitmapsOwnedExternally() const;

Description

Gets the icon bitmap ownership.

Return value

TBool ETrue if bitmaps are externally owned. EFalse if bitmaps are owned by this object.