Class RWsSpriteBase

RWsSpriteBase

Support

Supported from 5.0

Description

Sprite base class.

Derivation

MWsClientClass Base class for all classes whose objects are clients of the window server engine RWsSpriteBase Sprite base class

Defined in RWsSpriteBase:
Activate(), AppendMember(), Close(), RWsSpriteBase(), UpdateMember()

Inherited from MWsClientClass:
WsHandle()

Notes:

• Unless stated otherwise, references to sprites in this class description also apply to pointer cursors.

See also:

• RWsSprite
• RWsPointerCursor

protected: RWsSpriteBase();

Description

Protected constructor.

The existence of this protected constructor prevents objects of this type being directly created.

protected: RWsSpriteBase(RWsSession& aWs);

Description

Protected constructor with window server session.

The existence of this protected constructor prevents objects of this type being directly created.

Parameters

RWsSession& aWs The window server session owning the sprite.

TInt Activate();

Description

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

Return value

TInt KErrNone if successful, otherwise one of the system-wide error codes.

void Close();

Description

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.

TInt AppendMember(const TSpriteMember& aSpriteList);

Description

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.

Parameters

const TSpriteMember& aSpriteList The sprite member to add

Return value

Tint KErrNone if successful, otherwise one of the system-wide error codes.

Notes:

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

void UpdateMember(TInt aIndex);

Description

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 following UpdateMember() overload.

Parameters

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

Notes:

• You should only use this function if you have only changed the content of the bitmap or mask. If you have changed the size of the bitmap then you must use the next function.
• 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.

TInt UpdateMember(TInt aIndex, const TSpriteMember& aMemberData);

Description

Replaces one of a sprite's TSpriteMember members.

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

Parameters

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

Return value

TInt KErrNone if successful, otherwise one of the system-wide error codes.

Notes:

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