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()constGets the icon image's bitmap.
• BitmapsOwnedExternally()constGets the icon bitmap ownership.
• Mask()constGets the icon image's mask.
• NewL()Creates a new icon.
• NewL(CFbsBitmap *,CFbsBitmap *)Creates a new icon using the bitmap and mask.
• NewLC()Creates a new icon and leaves it on the cleanup stack.
• SetBitmap(CFbsBitmap *)Sets the icon image's bitmap.
• SetBitmapsOwnedExternally(TBool)Sets the bitmap and mask to be owned externally.
• SetMask(CFbsBitmap *)Sets the icon image's mask.
• ~CGulIcon()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CGulIcon* NewLC();

Description

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

Return value

IMPORT_C static CGulIcon* NewL();

Description

Creates a new icon.

Return value

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

Return value

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

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

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

IMPORT_C CFbsBitmap* Mask() const;

Description

Gets the icon image's mask.

Transfers ownership to the caller if bitmaps are owned externally.

Return value

IMPORT_C void SetBitmapsOwnedExternally(TBool aOwnedExternally);

Description

Sets the bitmap and mask to be owned externally.

Parameters

IMPORT_C TBool BitmapsOwnedExternally() const;

Description

Gets the icon bitmap ownership.

Return value