CGulIcon Class Reference

#include <mw/gulicon.h>

Link against: egul.lib

class CGulIcon : public CBase

Inherits from

Detailed Description

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

Constructor & Destructor Documentation

~CGulIcon ( )

IMPORT_C~CGulIcon()

Destructor.

Member Function Documentation

Bitmap ( )

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.

Return Value
Pointer to the icon image's bitmap.

BitmapsOwnedExternally ( )

IMPORT_C TBoolBitmapsOwnedExternally()const

Gets the icon bitmap ownership.

Return Value
ETrue if bitmaps are externally owned. EFalse if bitmaps are owned by this object.

Mask ( )

IMPORT_C CFbsBitmap *Mask()const

Gets the icon image's mask.

Transfers ownership to the caller if bitmaps are owned externally.

Return Value
Pointer to the icon image's mask.

NewL ( )

IMPORT_C CGulIcon *NewL()[static]

Creates a new icon.

Return Value
The new icon.

NewL ( CFbsBitmap *, CFbsBitmap * )

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.

Parameters
aBitmapThe icon bitmap.
aMaskThe icon mask.
Return Value
The new icon.

NewLC ( )

IMPORT_C CGulIcon *NewLC()[static]

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

Return Value
The new icon.

SetBitmap ( CFbsBitmap * )

IMPORT_C voidSetBitmap(CFbsBitmap *aBitmap)

Sets the icon image's bitmap.

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

Parameters
aBitmapPointer to the icon image's bitmap.

SetBitmapsOwnedExternally ( TBool )

IMPORT_C voidSetBitmapsOwnedExternally(TBoolaOwnedExternally)

Sets the bitmap and mask to be owned externally.

Parameters
aOwnedExternallyETrue if bitmaps are set as externally owned. EFalse if bitmaps are set as not being externally owned.

SetMask ( CFbsBitmap * )

IMPORT_C voidSetMask(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.

Parameters
aMaskPointer to the icon image's mask.