Symbian^3 Application Developer Library >

CGulIcon Class Reference

class CGulIcon : public CBase

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

Inherits from

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 *)
Private Member Functions
CGulIcon ()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CFbsBitmap * iBitmap
TBool iBitmapsOwnedExternally
CFbsBitmap * iMask

Constructor & Destructor Documentation

CGulIcon()

CGulIcon ( ) [private]

~CGulIcon()

IMPORT_C ~CGulIcon ( )

Destructor.

Member Functions 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.

BitmapsOwnedExternally()

IMPORT_C TBool BitmapsOwnedExternally ( ) const

Gets the icon bitmap ownership.

Mask()

IMPORT_C CFbsBitmap * Mask ( ) const

Gets the icon image's mask.

Transfers ownership to the caller if bitmaps are owned externally.

NewL()

IMPORT_C CGulIcon * NewL ( ) [static]

Creates a 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

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

NewLC()

IMPORT_C CGulIcon * NewLC ( ) [static]

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

SetBitmap(CFbsBitmap *)

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.

Parameters

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

SetBitmapsOwnedExternally(TBool)

IMPORT_C void SetBitmapsOwnedExternally ( TBool aOwnedExternally )

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.

SetMask(CFbsBitmap *)

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.

Parameters

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

Member Data Documentation

CFbsBitmap * iBitmap

CFbsBitmap * iBitmap [private]

TBool iBitmapsOwnedExternally

TBool iBitmapsOwnedExternally [private]

CFbsBitmap * iMask

CFbsBitmap * iMask [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.