RWsSprite Class Reference

Sprite. More...

#include <w32std.h>

Inheritance diagram for RWsSprite:

Public Member Functions
IMPORT_C	RWsSprite ()
	Default C++ constructor.
IMPORT_C	RWsSprite (RWsSession &aWs)
	Constructs a sprite with a window server session.
IMPORT_C TInt	Construct (RWindowTreeNode &aWindow, const TPoint &aPos, TInt aFlags)
	Completes the construction of a sprite.
IMPORT_C void	SetPosition (const TPoint &aPos)
	Sets the sprite's position.
Public Member Functions inherited from RWsSpriteBase
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.

Additional Inherited Members
Protected Member Functions inherited from RWsSpriteBase
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 ()
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.

This class defines functions to create and initialise a sprite, and to set its position.

API status

Published to all clients. Released API.

Definition at line 2468 of file w32std.h.

Constructor & Destructor Documentation

RWsSprite() [1/2]

IMPORT_C RWsSprite::RWsSprite

(

)

Default C++ constructor.

This allows classes that contain an RWsSprite to be constructed before an RWsSession exists.

Note: do not use this version of the constructor on its own. Before an RWsSprite object can be used it must be constructed using the RWsSprite(RWsSession) constructor. An example of this might be as follows:

RWsSprite iSprite;
iSprite = RWsSprite(iWsSession);

(generated from Symbian Developer Library)

RWsSprite() [2/2]

IMPORT_C RWsSprite::RWsSprite

(

RWsSession &

aWs

)

Constructs a sprite with a window server session.

Initialisation must be completed using the Construct() function before the sprite can be activated using RWsSpriteBase::Activate().

Parameters

aWs	The window server session owning the sprite.

(generated from Symbian Developer Library)

Member Function Documentation

Construct()

IMPORT_C TInt RWsSprite::Construct	(	RWindowTreeNode &	aWindow,
		const TPoint &	aPos,
		TInt	aFlags
	)

Completes the construction of a sprite.

This function must be called before a sprite is activated using RWsSpriteBase::Activate().

It always causes a flush of the window server buffer.

Parameters

aWindow	The window in which the sprite is displayed.
aPos	The position of the sprite's origin relative to aWindow's origin. The origin is the top left corner of the window.
aFlags	Any one of the TSpriteFlags values, or a combination of the flags, using a bit-wise OR operation.

Panic condition: TW32Panic 17 in debug builds if called on an already constructed object.

(generated from Symbian Developer Library)

SetPosition()

IMPORT_C void RWsSprite::SetPosition

(

const TPoint &

aPos

)

Sets the sprite's position.

This function can be called before or after the sprite has been activated.

Note: the sprite's initial position is set when the sprite is constructed (see Construct()).

Parameters

aPos	Position of the sprite's origin relative to the origin of the window that owns it. The origin is the top left corner of the window.

(generated from Symbian Developer Library)

---

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

• w32std.h
• w32std.h.dox