Class RWsSprite

class RWsSprite : public RWsSpriteBase;

Description

Sprite.

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

Derivation

• MWsClientClass - Base class for all classes whose objects are clients of the window server.

• RWsSpriteBase - Sprite base class.

• RWsSprite - Sprite.

Members

Defined in RWsSprite:

• Construct(RWindowTreeNode &,const TPoint &,TInt)Completes the construction of a sprite.
• RWsSprite()Default C++ constructor.
• RWsSprite(RWsSession &)Constructs a sprite with a window server session.
• SetPosition(const TPoint &)Sets the sprite's position.

Inherited from MWsClientClass:

• WsHandle()constGets the server side handle for the object.

Inherited from RWsSpriteBase:

• Activate()Activates the sprite or pointer cursor.
• AppendMember(const TSpriteMember &)Adds a sprite member to a sprite or pointer cursor.
• Close()Destroys the sprite or pointer cursor in the window server, and frees client-sid...
• RWsSpriteBase(RWsSession &)Protected constructor with a window server session.
• UpdateMember(TInt)Updates the displayed sprite, taking into account any change to the content of t...
• UpdateMember(TInt,const TSpriteMember &)Replaces one of a sprite's members.

IMPORT_C RWsSprite();

Description

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

IMPORT_C RWsSprite(RWsSession &aWs);

Description

Constructs a sprite with a window server session.

Initialisation must be completed using the RWsSprite::Construct(RWindowTreeNode &,const TPoint &,TInt) function before the sprite can be activated using RWsSpriteBase::Activate().

Parameters

RWsSession &aWs The window server session owning the sprite.

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

Description

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

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

Return value

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

See also:

• TSpriteFlagsSprite flags.

IMPORT_C void SetPosition(const TPoint &aPos);

Description

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 RWsSprite::Construct(RWindowTreeNode &,const TPoint &,TInt)).

Parameters

const TPoint &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.