Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: APGICNFL.H
Link against: apgrfx.lib

Class CApaMaskedBitmap

class CApaMaskedBitmap : public CFbsBitmap;

Description

An application icon.

This is a bitmap and a mask, managed by the Font and Bitmap server.

An object of this type is passed to RApaLsSession::GetAppIcon() to fetch a suitable application icon.

Derivation

Members

Defined in CApaMaskedBitmap:
ExternalizeL(), InternalizeL(), Mask(), NewL(), NewLC(), SetMaskBitmap(), ~CApaMaskedBitmap()

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

Inherited from CFbsBitmap:
CleanAddress(), Compress(), CompressInBackground(), Create(), CreateHardwareBitmap(), DataAddress(), DisplayMode(), Duplicate(), ExternalizeRectangleL(), GetPalette(), GetPixel(), GetScanLine(), GetVerticalScanLine(), Handle(), HardwareBitmapHandle(), Header(), HorizontalPixelsToTwips(), HorizontalTwipsToPixels(), InitialDisplayMode(), IsCompressedInRAM(), IsFileInRom(), IsLargeBitmap(), IsMonochrome(), IsRomBitmap(), Load(), LoadAndCompress(), LockHeap(), LockHeapLC(), PaletteAttributes(), Reset(), Resize(), Save(), ScanLineLength(), SetDisplayMode(), SetPalette(), SetRomBitmapL(), SetScanLine(), SetSizeInTwips(), SizeInPixels(), SizeInTwips(), StoreL(), SwapWidthAndHeight(), UnlockHeap(), VerticalPixelsToTwips(), VerticalTwipsToPixels()

See also:


Construction and destruction


NewLC()

static IMPORT_C CApaMaskedBitmap *NewLC();

Description

Creates a default application icon object.

Return value

CApaMaskedBitmap *

A pointer to the new application icon object.


NewL()

static IMPORT_C CApaMaskedBitmap *NewL(const CApaMaskedBitmap *aSourceIcon);

Description

Creates a new application icon object, making a duplicate copy of an existing application icon.

Parameters

const CApaMaskedBitmap *aSourceIcon

A pointer to an existing application icon.

Return value

CApaMaskedBitmap *

A pointer to the new application icon object.


~CApaMaskedBitmap()

IMPORT_C ~CApaMaskedBitmap();

Description

Destructor.

Frees resources owned by the object prior to its destruction.

[Top]


Member functions


Mask()

IMPORT_C CFbsBitmap *Mask() const;

Description

Gets the icon's mask.

Return value

CFbsBitmap *

A pointer to the mask bitmap.


InternalizeL()

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalizes the application icon from the read stream.

Parameters

RReadStream &aStream

The read stream.


ExternalizeL()

IMPORT_C void ExternalizeL(RWriteStream &aStream) const;

Description

Externalises the application icon to the specified stream.

Parameters

RWriteStream &aStream

The write stream.


SetMaskBitmap()

IMPORT_C void SetMaskBitmap(CFbsBitmap *aMask);

Description

Sets the icon's mask

Parameters

CFbsBitmap *aMask

A pointer to the mask bitmap