Symbian
Symbian OS Library

SYMBIAN OS V9.3

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



Location: W32STD.H
Link against: ws32.lib

Class CWsBitmap

class CWsBitmap : public CFbsBitmap, public MWsClientClass;

Description

Window server bitmap.

This is a bitmap to which the window server already has a handle. Functions which take a window server bitmap are faster than equivalent functions which take a CFbsBitmap.

Derivation

Members

Defined in CWsBitmap:
CWsBitmap(), CWsBitmap(), Create(), Duplicate(), InternalizeL(), Load(), Reset(), ~CWsBitmap()

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

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

Inherited from MWsClientClass:
WsHandle()


Construction and destruction


CWsBitmap()

IMPORT_C CWsBitmap();

Description

Default constructor. Developers should use the other constructor overload.


CWsBitmap()

IMPORT_C CWsBitmap(RWsSession &aWs);

Description

Constructor which takes a window server session as an argument.

Parameters

RWsSession &aWs

Handle to window server session.


~CWsBitmap()

IMPORT_C ~CWsBitmap();

Description

Destructor.

[Top]


Member functions


Create()

IMPORT_C TInt Create(const TSize &aSizeInPixels, TDisplayMode aDispMode);

Description

Creates a bitmap, specifying the size and display mode.

This function, if successful, always causes a flush of the window server buffer.

Parameters

const TSize &aSizeInPixels

The size of the bitmap to be created.

TDisplayMode aDispMode

The display-mode of the bitmap to be created.

Return value

TInt

KErrNone if successful, KErrCouldNotConnect if no connection to the font and bitmap server could be made, KErrArgument if aSizeInPixels is illegal.

See also:


Duplicate()

IMPORT_C TInt Duplicate(TInt aHandle);

Description

Makes this bitmap a duplicate of the specified bitmap.

This function, if successful, always causes a flush of the window server buffer.

Parameters

TInt aHandle

The handle of the bitmap to be duplicated.

Return value

TInt

KErrNone if successful, KErrCouldNotConnect if no connection to the font and bitmap server could be made, or KErrUnknown if no bitmap could be found whose handle is aHandle.

See also:


Load()

IMPORT_C TInt Load(const TDesC &aFileName, TInt32 aId, TBool aShareIfLoaded=ETrue);

Description

Loads a bitmap from a file.

If aShareIfLoaded is ETrue the bitmap will be allowed to be shared by a number of font and bitmap server clients.

This function, if successful, always causes a flush of the window server buffer.

Parameters

const TDesC &aFileName

The filename of the multibitmap (.mbm) file containing the bitmap to be loaded.

TInt32 aId

The identifier of the bitmap in the .mbm file which should be loaded.

TBool aShareIfLoaded

Specifies whether or not the loaded bitmap will be made available for sharing between font and bitmap server clients.

Return value

TInt

KErrNone if successful, otherwise KErrCouldNotConnect, KErrEof, or an error specific to the font and bitmap server.

See also:


InternalizeL()

IMPORT_C void InternalizeL(RReadStream &aStream);

Description

Internalises a CWsBitmap from the read stream.

The presence of this function means that the standard templated operator>>() can be used to internalise objects of this class.

This function always causes a flush of the window server buffer.

Parameters

RReadStream &aStream

The stream from which to internalise the bitmap.


Reset()

IMPORT_C void Reset();

Description

Releases the bitmap's handle from the font and bitmap server.

The function also decrements the bitmap's access count in the font and bitmap server. The server-side bitmap is deleted only if the access count for the bitmap decrements to zero.