CWsGraphic Class Reference

#include <w32std.h>

class CWsGraphic : public CBase, public CBase

Inherits from

CWsGraphic
- CBase
- CBase

Public Member Functions
	~CWsGraphic()
IMPORT_C void	Destroy()
IMPORT_C const TWsGraphicId &	Id()
IMPORT_C TBool	IsActive()

Protected Member Functions
	CWsGraphic()
IMPORT_C void	BaseConstructL(TUid, TUid, const TDesC8 &)
IMPORT_C void	BaseConstructL(TUid, const TDesC8 &)
IMPORT_C void	BaseConstructL(const TWsGraphicId &, TUid, const TDesC8 &)
IMPORT_C TInt	Flush()
IMPORT_C void	SendMessage(const TDesC8 &)
IMPORT_C TInt	SendSynchronMessage(const TDesC8 &)
IMPORT_C RWsSession &	Session()
IMPORT_C void	SetGraphicExtension(MWsObjectProvider *)
virtual IMPORT_C TInt	Share(TSecureId)
virtual IMPORT_C TInt	ShareGlobally()
virtual IMPORT_C TInt	UnShare(TSecureId)
virtual IMPORT_C TInt	UnShareGlobally()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

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

Constructor & Destructor Documentation

CWsGraphic ( )

IMPORT_C

CWsGraphic

(

)

[protected]

Default Constructor.

~CWsGraphic ( )

IMPORT_C

~CWsGraphic

(

)

Destructor.

Member Function Documentation

BaseConstructL ( TUid, TUid, const TDesC8 & )

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

Constructs a piece of non-transient graphic artwork.

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

Capability
ProtServ

BaseConstructL ( TUid, const TDesC8 & )

IMPORT_C void	BaseConstructL	(	TUid	aType,
			const TDesC8 &	aData
		)	[protected]

Constructs a piece of transient graphic artwork.

Parameters
aType	Graphic artwork type.
aData	User specific data.

BaseConstructL ( const TWsGraphicId &, TUid, const TDesC8 & )

IMPORT_C void	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.

Destroy ( )

IMPORT_C void

Destroy

(

)

Destroys the corresponding CWsGraphicDrawer instance on the server

Flush ( )

IMPORT_C TInt

Flush

(

)

const [protected]

Flushes window server command buffer

Return Value: One of system-wide error codes.

Id ( )

IMPORT_C const TWsGraphicId &

(

)

const

Returns graphic artwork Id.

Return Value: Graphic artwork Id. KNullWsGraphicId if graphic artwork is not active.

IsActive ( )

IMPORT_C TBool

IsActive

(

)

const

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

Return Value: ETrue if this graphic artwork has a peer CWsGraphic on the server.

SendMessage ( const TDesC8 & )

IMPORT_C void

SendMessage

(

const TDesC8 &

aData

)

const [protected]

Sends message to this graphic artwork peer on the server.

Parameters
aData	User specific data.

SendSynchronMessage ( const TDesC8 & )

IMPORT_C TInt

SendSynchronMessage

(

const TDesC8 &

aData

)

const [protected]

Session ( )

IMPORT_C RWsSession &

Session

(

)

[protected]

SetGraphicExtension ( MWsObjectProvider * )

IMPORT_C void

SetGraphicExtension

(

MWsObjectProvider *

aExt

)

[protected]

Share ( TSecureId )

IMPORT_C TInt

(

TSecureId

aClientId

)

[protected, virtual]

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.

Return Value: KErrNone If the graphic artwork was shared, else one of the system-wide error codes.

ShareGlobally ( )

IMPORT_C TInt

ShareGlobally

(

)

[protected, virtual]

Shares the graphic artwork with all the client sessions. Sharing globally trumps explicit shares.

Return Value: KErrNone if the graphic is globally shared, else one of the system-wide error codes.

UnShare ( TSecureId )

IMPORT_C TInt

UnShare

(

TSecureId

aClientId

)

[protected, virtual]

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

Return Value: KErrNone if the graphic artwork is no longer shared, KErrNotFound if the graphic was not shared anyway, else one of the system-wide error codes

UnShareGlobally ( )

IMPORT_C TInt

UnShareGlobally

(

)

[protected, virtual]

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

Return Value: KErrNone if the graphic is not globally shared, else one of the system-wide error codes.