Sprite base class. More...

#include <w32std.h>

Inheritance diagram for RWsSpriteBase:

Public Member Functions
IMPORT_C TInt	Activate ()
	Activates the sprite or pointer cursor.

IMPORT_C TInt	AppendMember (const TSpriteMember &aMemberData)
	Adds a sprite member to a sprite or pointer cursor.

IMPORT_C void	UpdateMember (TInt aIndex)
	Updates the displayed sprite, taking into account any change to the content of the bitmaps for the specified member.

IMPORT_C TInt	UpdateMember (TInt aIndex, const TSpriteMember &aMemberData)
	Replaces one of a sprite's members.

IMPORT_C void	Close ()
	Destroys the sprite or pointer cursor in the window server, and frees client-side resources used by the sprite.

Public Member Functions inherited from MWsClientClass
	MWsClientClass ()

	MWsClientClass (RWsBuffer *aBuffer)

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

Protected Member Functions
IMPORT_C	RWsSpriteBase ()
	Protected constructor.

IMPORT_C	RWsSpriteBase (RWsSession &aWs)
	Protected constructor with a window server session.

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 ()

Additional Inherited Members
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

Sprite base class.

Unless stated otherwise, references to sprites in the documentation for this class also apply to pointer cursors.

See also: RWsSprite; RWsPointerCursor

API status: Published to all clients. Released API.

Definition at line 2441 of file w32std.h.

Constructor & Destructor Documentation

◆ RWsSpriteBase() [1/2]

IMPORT_C RWsSpriteBase::RWsSpriteBase ( )

protected

Protected constructor.

This prevents objects of this type being directly created.

(generated from Symbian Developer Library)

◆ RWsSpriteBase() [2/2]

IMPORT_C RWsSpriteBase::RWsSpriteBase ( RWsSession & aWs )

protected

Protected constructor with a window server session.

This prevents objects of this type being directly created.

Parameters

aWs	The window server session owning the sprite.

(generated from Symbian Developer Library)

Member Function Documentation

◆ Activate()

IMPORT_C TInt RWsSpriteBase::Activate ( )

Activates the sprite or pointer cursor.

Sprites are displayed on the screen when they are activated; pointer cursors are not displayed until they are set into a window using either RWindowTreeNode::SetCustomPointerCursor() or RWindowTreeNode::SetPointerCursor().

This function should not be called until the sprite or pointer cursor has been fully initialised, and its sprite members have been added.

Before it can call this function, a sprite must be fully constructed using the RWsSprite::RWsSprite(RWsSession& aWs) and RWsSprite::Construct() functions, and must have at least one sprite member. Otherwise, a panic will occur. Similarly, a pointer cursor must have at least one sprite member and must call RWsPointerCursor::RWsPointerCursor(RWsSession& aWs) and RWsPointerCursor::Construct().

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

(generated from Symbian Developer Library)

◆ AppendMember()

IMPORT_C TInt RWsSpriteBase::AppendMember ( const TSpriteMember & aMemberData )

Adds a sprite member to a sprite or pointer cursor.

Sprite members are displayed by the sprite in the order in which they were added to the sprite. This function can be called before and after the sprite has been activated.

The position of the bitmap can be changed in relation to the sprite's origin using the iOffset member of aSpriteList.

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

Parameters

aMemberData The sprite member to add.

(generated from Symbian Developer Library)

◆ Close()

IMPORT_C void RWsSpriteBase::Close ( )

Destroys the sprite or pointer cursor in the window server, and frees client-side resources used by the sprite.

Any application which constructs an RWsSprite or RWsPointerCursor should call this function when the sprite or cursor is no longer needed.

Note that this function does not free resources used by sprite members.

(generated from Symbian Developer Library)

◆ UpdateMember() [1/2]

IMPORT_C void RWsSpriteBase::UpdateMember ( TInt aIndex )

Updates the displayed sprite, taking into account any change to the content of the bitmaps for the specified member.

The appearance of a sprite can be changed after it has been activated by drawing to the appropriate TSpriteMember::iBitmap member, and then calling this function. Alternatively, a new sprite member can be created, containing a new bitmap, and the sprite can be updated to contain this new member by calling the other UpdateMember() overload.

You should only use this function if you have changed the content of the bitmap or mask. If you have changed the size of the bitmap then you must use the other overload.

You only need to call this function if you want the content of the screen to update immediately. If you don't call this function then the appearance of a member will update automatically next time that member is drawn to the screen.

Parameters

aIndex Index of the sprite member. Sprite members are indexed in the order they were added to the sprite, beginning with 0.

(generated from Symbian Developer Library)

◆ UpdateMember() [2/2]

IMPORT_C TInt RWsSpriteBase::UpdateMember	(	TInt	aIndex,
		const TSpriteMember &	aMemberData
	)

Replaces one of a sprite's members.

This allows the appearance of the sprite to be modified after it has been activated.

You must call this function if you have changed the size of a member. After calling it, the sprite starts showing member zero again.

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

Parameters

aIndex	Index of the sprite member. Sprite members are indexed in the order they were added to the sprite, beginning with 0.
aMemberData	New data for the sprite member.

(generated from Symbian Developer Library)

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RWsSpriteBase() [1/2]

◆ RWsSpriteBase() [2/2]

Member Function Documentation

◆ Activate()

◆ AppendMember()

◆ Close()

◆ UpdateMember() [1/2]

◆ UpdateMember() [2/2]