Client representation of a window-server-side piece of artwork owned by this Client. More...

#include <w32std.h>

Inheritance diagram for CWsGraphic:

Public Member Functions
IMPORT_C	~CWsGraphic ()
	Destructor.

IMPORT_C const TWsGraphicId &	Id () const
	Returns graphic artwork Id.

IMPORT_C TBool	IsActive () const
	Checks whether a peer of this graphic artwork has been fully constructed on the server.

IMPORT_C void	Destroy ()
	Destroys the corresponding CWsGraphicDrawer instance on the server.

Public Member Functions inherited from CBase
	CBase ()
	Default constructor.

virtual IMPORT_C	~CBase ()
	Virtual destructor.

TAny *	operator new (TUint aSize, TAny *aBase) __NO_THROW
	Initialises the object to binary zeroes.

TAny *	operator new (TUint aSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TLeave)
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TUint aExtraSize) __NO_THROW
	Allocates the object from the heap and then initialises its contents to binary zeroes.

TAny *	operator new (TUint aSize, TLeave, TUint aExtraSize)
	Allocates the object from the heap and then initialises its contents to binary zeroes.

Protected Member Functions
IMPORT_C	CWsGraphic ()
	Default Constructor.

IMPORT_C void	BaseConstructL (TUid aUid, TUid aType, const TDesC8 &aData)

IMPORT_C void	BaseConstructL (TUid aType, const TDesC8 &aData)
	Constructs a piece of transient graphic artwork.

IMPORT_C void	BaseConstructL (const TWsGraphicId &aReplace, TUid aType, const TDesC8 &aData)
	Atomically replace the artwork that already exists with this artwork.

virtual IMPORT_C TInt	ShareGlobally ()
	Shares the graphic artwork with all the client sessions.

virtual IMPORT_C TInt	Share (TSecureId aClientId)
	Explicitly shares this graphic artwork with client sessions with the specified Secure ID.

virtual IMPORT_C TInt	UnShare (TSecureId aClientId)
	Stops this graphic artwork from being shared with all client sessions with the specific Secure ID.

virtual IMPORT_C TInt	UnShareGlobally ()
	Prevents this graphic artwork from being shared with all the client sessions.

IMPORT_C void	SendMessage (const TDesC8 &aData) const
	Sends message to this graphic artwork peer on the server.

IMPORT_C TInt	SendSynchronMessage (const TDesC8 &aData) const

IMPORT_C TInt	Flush () const
	Flushes window server command buffer.

IMPORT_C void	SetGraphicExtension (MWsObjectProvider *aExt)

IMPORT_C RWsSession &	Session ()

Protected Member Functions inherited from CBase
virtual IMPORT_C TInt	Extension_ (TUint aExtensionId, TAny &a0, TAny a1)
	Extension function.

Friends
class	CManager

class	CPimpl

Additional Inherited Members
Static Public Member Functions inherited from CBase
static IMPORT_C void	Delete (CBase *aPtr)
	Deletes the specified object.

Detailed Description

Client representation of a window-server-side piece of artwork owned by this Client.

API status: Published to all clients. Released API.

Definition at line 1217 of file w32std.h.

Constructor & Destructor Documentation

◆ CWsGraphic()

IMPORT_C CWsGraphic::CWsGraphic ( )

protected

Default Constructor.

(generated from Symbian Developer Library)

◆ ~CWsGraphic()

IMPORT_C CWsGraphic::~CWsGraphic ( )

Destructor.

(generated from Symbian Developer Library)

Member Function Documentation

◆ BaseConstructL() [1/3]

IMPORT_C void CWsGraphic::BaseConstructL	(	const TWsGraphicId &	aReplace,
		TUid	aType,
		const TDesC8 &	aData
	)

protected

Atomically replace the artwork that already exists with this artwork.

If failure to properly construct the replacement artwork occurs, the replacee artwork will remain

Parameters

aReplace	Graphic artwork which will be replaced.
aType	New graphic artwork type.
aData	User specific data.

(generated from Symbian Developer Library)

◆ BaseConstructL() [2/3]

IMPORT_C void CWsGraphic::BaseConstructL	(	TUid	aType,
		const TDesC8 &	aData
	)

protected

Constructs a piece of transient graphic artwork.

Parameters

aType	Graphic artwork type.
aData	User specific data.

(generated from Symbian Developer Library)

◆ BaseConstructL() [3/3]

IMPORT_C void CWsGraphic::BaseConstructL	(	TUid	aUid,
		TUid	aType,
		const TDesC8 &	aData
	)

protected

Parameters

aUid	Graphic artwork UID.
aType	Graphic artwork type.
aData	User specific data.

capability: ProtServ

(generated from Symbian Developer Library)

◆ Destroy()

IMPORT_C void CWsGraphic::Destroy ( )

Destroys the corresponding CWsGraphicDrawer instance on the server.

(generated from Symbian Developer Library)

◆ Flush()

IMPORT_C TInt CWsGraphic::Flush ( ) const

protected

Flushes window server command buffer.

(generated from Symbian Developer Library)

◆ Id()

IMPORT_C const TWsGraphicId & CWsGraphic::Id ( ) const

Returns graphic artwork Id.

(generated from Symbian Developer Library)

◆ IsActive()

IMPORT_C TBool CWsGraphic::IsActive ( ) const

Checks whether a peer of this graphic artwork has been fully constructed on the server.

(generated from Symbian Developer Library)

◆ SendMessage()

IMPORT_C void CWsGraphic::SendMessage ( const TDesC8 & aData ) const

protected

Sends message to this graphic artwork peer on the server.

Parameters

aData User specific data.

(generated from Symbian Developer Library)

◆ SendSynchronMessage()

IMPORT_C TInt CWsGraphic::SendSynchronMessage ( const TDesC8 & aData ) const

protected

◆ Session()

IMPORT_C RWsSession & CWsGraphic::Session ( )

protected

◆ SetGraphicExtension()

IMPORT_C void CWsGraphic::SetGraphicExtension ( MWsObjectProvider * aExt )

protected

◆ Share()

IMPORT_C TInt CWsGraphic::Share ( TSecureId aClientId )

protectedvirtual

Explicitly shares this graphic artwork with client sessions with the specified Secure ID.

Parameters

aClientId the Secure ID of the client sessions to share with.

(generated from Symbian Developer Library)

◆ ShareGlobally()

IMPORT_C TInt CWsGraphic::ShareGlobally ( )

protectedvirtual

Shares the graphic artwork with all the client sessions.

Sharing globally trumps explicit shares.

(generated from Symbian Developer Library)

◆ UnShare()

IMPORT_C TInt CWsGraphic::UnShare ( TSecureId aClientId )

protectedvirtual

Stops this graphic artwork from being shared with all client sessions with the specific Secure ID.

ShareGlobally() trumps explicit sharing.

Parameters

aClientId the Secure ID of the client sessions to not share with

(generated from Symbian Developer Library)

◆ UnShareGlobally()

IMPORT_C TInt CWsGraphic::UnShareGlobally ( )

protectedvirtual

Prevents this graphic artwork from being shared with all the client sessions.

A graphic artwork that isn't shared explicitly is only available to clients it has been explicitly shared with using Share().

(generated from Symbian Developer Library)

Friends And Related Symbol Documentation

◆ CManager

friend class CManager

friend

Definition at line 1272 of file w32std.h.

◆ CPimpl

friend class CPimpl

friend

Definition at line 1274 of file w32std.h.

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

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CWsGraphic()

◆ ~CWsGraphic()

Member Function Documentation

◆ BaseConstructL() [1/3]

◆ BaseConstructL() [2/3]

◆ BaseConstructL() [3/3]

◆ Destroy()

◆ Flush()

◆ Id()

◆ IsActive()

◆ SendMessage()

◆ SendSynchronMessage()

◆ Session()

◆ SetGraphicExtension()

◆ Share()

◆ ShareGlobally()

◆ UnShare()

◆ UnShareGlobally()

Friends And Related Symbol Documentation

◆ CManager

◆ CPimpl