#include <w32std.h>
| class RWsSprite : public RWsSpriteBase |
| Public Member Functions | |
|---|---|
| RWsSprite() | |
| RWsSprite(RWsSession &) | |
| IMPORT_C TInt | Construct(RWindowTreeNode &, const TPoint &, TInt) |
| IMPORT_C void | SetPosition(const TPoint &) |
| Inherited Attributes | |
|---|---|
| MWsClientClass::iBuffer | |
| MWsClientClass::iWsHandle | |
Sprite.
This class defines functions to create and initialise a sprite, and to set its position.
| IMPORT_C | 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);
| IMPORT_C | 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().
| Parameter | Description |
|---|---|
| aWs | The window server session owning the sprite. |
| IMPORT_C TInt | 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.
See also: TSpriteFlags
| Parameter | Description |
|---|---|
| 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. |
Returns: KErrNone if successful, otherwise one of the system-wide error codes.
| IMPORT_C void | 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()).
| Parameter | Description |
|---|---|
| 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. |