Window server bitmap. More...

#include <w32std.h>

Inheritance diagram for CWsBitmap:

Public Member Functions
IMPORT_C	CWsBitmap ()
	Default constructor.

IMPORT_C	CWsBitmap (RWsSession &aWs)
	Constructor which takes a window server session as an argument.

IMPORT_C	~CWsBitmap ()
	Destructor.

IMPORT_C TInt	Create (const TSize &aSizeInPixels, TDisplayMode aDispMode)
	Creates a bitmap, specifying the size and display mode.

IMPORT_C TInt	Duplicate (TInt aHandle)
	Makes this bitmap a duplicate of the specified bitmap.

IMPORT_C TInt	Load (const TDesC &aFileName, TInt32 aId, TBool aShareIfLoaded=ETrue)
	Loads a bitmap from a file.

IMPORT_C void	InternalizeL (RReadStream &aStream)
	Internalises a CWsBitmap from the read stream.

IMPORT_C void	Reset ()
	Releases the bitmap's handle from the font and bitmap server.

Public Member Functions inherited from MWsClientClass
	MWsClientClass ()

	MWsClientClass (RWsBuffer *aBuffer)

TInt	WsHandle () const
	Gets the server side handle for the object.

Additional Inherited Members
Protected Member Functions inherited from MWsClientClass
void	Write (const TAny *aData1, TInt aLength1, TInt aLength2, TUint aOpcode) const

void	Write (const TAny aData, TInt aLength, const TAny aData2, TInt aLength2, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const

void	Write (const TAny aBuf, TInt aBufLen, TUint aOpcode, const TIpcArgs aIpcArgs=NULL) const

void	Write (TUint aOpcode) const

void	WriteInt (TInt aInt, TUint aOpcode) const

void	WriteRect (const TRect &aRect, TUint aOpcode) const

void	WritePoint (const TPoint &aPoint, TUint aOpcode) const

void	WriteSize (const TSize &aSize, TUint aOpcode) const

TInt	WriteReply (TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const

TInt	WriteReplyInt (TInt aInt, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const

TInt	WriteReply (const TAny aBuf, TInt aBufLen, TUint aOpcode, const TIpcArgs aIpcArgs=NULL) const

TInt	WriteReply (const TAny aBuf, TInt aBufLen, const TAny aBuf2, TInt aBuflen2, TUint aOpcode, const TIpcArgs *aIpcArgs=NULL) const

TInt	WriteReplyP (const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const

TInt	WriteReplyIntP (TInt aInt, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const

TInt	WriteReplyP (const TAny *aBuf, TInt aBufLen, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const

TInt	WriteReplyP (const TAny aBuf, TInt aBufLen, const TAny aBuf2, TInt aBuflen2, const TWriteDescriptorType &aReplyPackage, TUint aOpcode) const

TInt	WriteReplyByProvidingRemoteReadAccess (const TAny *aBuf, TInt aBufLen, const TReadDescriptorType &aRemoteReadBuffer, TUint aOpcode) const

void	AddToBitmapArray (const TInt aBitmapHandle) const

void	AsyncRequest (TRequestStatus &aStatus, TUint aOpcode) const

TBool	WindowSizeCacheEnabled () const

void	MarkWindowSizeCacheDirty ()

void	RefreshWindowSizeCache (const TSize &aNewSize) const

TInt	CachedWindowSize (TSize &aSize) const

void	DestroyWindowSizeCacheEntry ()

Protected Attributes inherited from MWsClientClass
TInt32	iWsHandle
	WARNING: Member variable for internal use ONLY.

RWsBuffer *	iBuffer
	WARNING: Member variable for internal use ONLY.

Detailed 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.

API status: Published to all clients. Released API.

Definition at line 2027 of file w32std.h.

Constructor & Destructor Documentation

◆ CWsBitmap() [1/2]

IMPORT_C CWsBitmap::CWsBitmap ( )

Default constructor.

Developers should use the other constructor overload.

(generated from Symbian Developer Library)

◆ CWsBitmap() [2/2]

IMPORT_C CWsBitmap::CWsBitmap ( RWsSession & aWs )

Constructor which takes a window server session as an argument.

Parameters

aWs	Handle to window server session.

(generated from Symbian Developer Library)

◆ ~CWsBitmap()

IMPORT_C CWsBitmap::~CWsBitmap ( )

Destructor.

(generated from Symbian Developer Library)

Member Function Documentation

◆ Create()

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

Creates a bitmap, specifying the size and display mode.

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

CFbsBitmap::Create()

Parameters

aSizeInPixels	The size of the bitmap to be created.
aDispMode	The display-mode of the bitmap to be created.

(generated from Symbian Developer Library)

◆ Duplicate()

IMPORT_C TInt CWsBitmap::Duplicate ( TInt aHandle )

Makes this bitmap a duplicate of the specified bitmap.

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

CFbsBitmap::Duplicate()

Parameters

aHandle The handle of the bitmap to be duplicated.

(generated from Symbian Developer Library)

◆ InternalizeL()

IMPORT_C void CWsBitmap::InternalizeL ( RReadStream & aStream )

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

aStream The stream from which to internalise the bitmap.

(generated from Symbian Developer Library)

◆ Load()

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

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.

CFbsBitmap::Load()

Parameters

aFileName	The filename of the multibitmap (.mbm) file containing the bitmap to be loaded.
aId	The identifier of the bitmap in the .mbm file which should be loaded.
aShareIfLoaded	Specifies whether or not the loaded bitmap will be made available for sharing between font and bitmap server clients.

(generated from Symbian Developer Library)

◆ Reset()

IMPORT_C void CWsBitmap::Reset ( )

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.

(generated from Symbian Developer Library)

The documentation for this class was generated from the following files:

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CWsBitmap() [1/2]

◆ CWsBitmap() [2/2]

◆ ~CWsBitmap()

Member Function Documentation

◆ Create()

◆ Duplicate()

◆ InternalizeL()

◆ Load()

◆ Reset()