RWsSprite Class Reference

class RWsSprite : public RWsSpriteBase

Sprite.

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

Inherits from

Public Member Functions
RWsSprite()
RWsSprite(RWsSession &)
IMPORT_C TIntConstruct(RWindowTreeNode &, const TPoint &, TInt)
IMPORT_C voidSetPosition(const TPoint &)
Inherited Functions
MWsClientClass::AddToBitmapArray(const TInt)const
MWsClientClass::AsyncRequest(TRequestStatus &,TUint)const
MWsClientClass::CachedWindowSize(TSize &)const
MWsClientClass::DestroyWindowNativeSizeCacheEntry()
MWsClientClass::DestroyWindowSizeCacheEntry()
MWsClientClass::EnableWindowNativeSizeCacheL()
MWsClientClass::MWsClientClass()
MWsClientClass::MWsClientClass(RWsBuffer *)
MWsClientClass::MarkWindowSizeCacheDirty()
MWsClientClass::RefreshWindowSizeCache(const TSize &)const
MWsClientClass::SetWindowNativeSize(const TSize &)const
MWsClientClass::WindowNativeSize(TSize &)const
MWsClientClass::WindowNativeSizeCacheEnabled()const
MWsClientClass::WindowSizeCacheEnabled()const
MWsClientClass::Write(TUint)const
MWsClientClass::Write(const TAny *,TInt,TUint)const
MWsClientClass::Write(const TAny *,TInt,const TAny *,TInt,TUint)const
MWsClientClass::WriteInt(TInt,TUint)const
MWsClientClass::WritePoint(const TPoint &,TUint)const
MWsClientClass::WriteRect(const TRect &,TUint)const
MWsClientClass::WriteReply(TUint,const TIpcArgs *)const
MWsClientClass::WriteReply(const TAny *,TInt,TUint,const TIpcArgs *)const
MWsClientClass::WriteReply(const TAny *,TInt,const TAny *,TInt,TUint,const TIpcArgs *)const
MWsClientClass::WriteReplyByProvidingRemoteReadAccess(const TAny *,TInt,const TReadDescriptorType &,TUint)const
MWsClientClass::WriteReplyInt(TInt,TUint,const TIpcArgs *)const
MWsClientClass::WriteReplyIntP(TInt,const TWriteDescriptorType &,TUint)const
MWsClientClass::WriteReplyP(const TAny *,TInt,const TAny *,TInt,const TWriteDescriptorType &,TUint)const
MWsClientClass::WriteReplyP(const TAny *,TInt,const TWriteDescriptorType &,TUint)const
MWsClientClass::WriteReplyP(const TWriteDescriptorType &,TUint)const
MWsClientClass::WriteSize(const TSize &,TUint)const
MWsClientClass::WsHandle()const
RWsSpriteBase::Activate()
RWsSpriteBase::AppendMember(const TSpriteMember &)
RWsSpriteBase::Close()
RWsSpriteBase::RWsSpriteBase()
RWsSpriteBase::RWsSpriteBase(RWsSession &)
RWsSpriteBase::UpdateMember(TInt)
RWsSpriteBase::UpdateMember(TInt,const TSpriteMember &)
Inherited Attributes
MWsClientClass::iBuffer
MWsClientClass::iWsHandle

Constructor & Destructor Documentation

RWsSprite()

IMPORT_CRWsSprite()

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

RWsSprite(RWsSession &)

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

RWsSession & aWsThe window server session owning the sprite.

Member Functions Documentation

Construct(RWindowTreeNode &, const TPoint &, TInt)

IMPORT_C TIntConstruct(RWindowTreeNode &aWindow,
const TPoint &aPos,
TIntaFlags
)

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.

panic
TW32Panic 17 in debug builds if called on an already constructed object.
TSpriteFlags

Parameters

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

SetPosition(const TPoint &)

IMPORT_C voidSetPosition(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

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