Collapse all Symbian^3 Application Developer Library

CWsGraphic Class Reference

class CWsGraphic : public CBase

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

Inherits from

CWsGraphic
- 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 *)
IMPORT_C TInt	Share ( TSecureId )
IMPORT_C TInt	ShareGlobally ()
IMPORT_C TInt	UnShare ( TSecureId )
IMPORT_C TInt	UnShareGlobally ()

Private Member Functions
void	BaseConstructL ()
IMPORT_C TInt	CWsGraphic_Reserved1 ()
IMPORT_C TInt	CWsGraphic_Reserved2 ()
IMPORT_C TInt	CWsGraphic_Reserved3 ()
void	HandleMessage (const TDesC8 &)
IMPORT_C void	OnClientClose ()
void	OnReplace ()

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

Private Attributes
CPimpl *	iPimpl
TInt	iWsGraphicSpare

Constructor & Destructor Documentation

CWsGraphic()

IMPORT_C

CWsGraphic

(

)

[protected]

Default Constructor.

~CWsGraphic()

IMPORT_C

~CWsGraphic

(

)

Destructor.

Member Functions 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.

capability: ProtServ

Parameters

TUid aUid	Graphic artwork UID.
TUid aType	Graphic artwork type.
const TDesC8 & aData	User specific data.

BaseConstructL(TUid, const TDesC8 &)

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

Constructs a piece of transient graphic artwork.

Parameters

TUid aType	Graphic artwork type.
const TDesC8 & 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

const TWsGraphicId & aReplace	Graphic artwork which will be replaced.
TUid aType	New graphic artwork type.
const TDesC8 & aData	User specific data.

BaseConstructL()

void

BaseConstructL

(

)

[private]

Completes construction of the baseclass. All the overloaded BaseConstructL() methods should invoke this method to complete the construction of the baseclass.

CWsGraphic_Reserved1()

IMPORT_C TInt

CWsGraphic_Reserved1

(

)

[private, virtual]

CWsGraphic_Reserved2()

IMPORT_C TInt

CWsGraphic_Reserved2

(

)

[private, virtual]

CWsGraphic_Reserved3()

IMPORT_C TInt

CWsGraphic_Reserved3

(

)

[private, virtual]

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

HandleMessage(const TDesC8 &)

void

HandleMessage

(

const TDesC8 &

aData

)

[private, pure virtual]

Handles message from this graphic artwork peer on the server.

Parameters

const TDesC8 & aData

Message from peer CWsGraphicDrawer.

Id()

IMPORT_C const TWsGraphicId &

(

)

const

Returns graphic artwork Id.

IsActive()

IMPORT_C TBool

IsActive

(

)

const

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

OnClientClose()

IMPORT_C void

OnClientClose

(

)

[private, virtual]

Derived class can override this method to provide custom operations when the client is closed.

OnReplace()

void

OnReplace

(

)

[private, pure virtual]

Handles custom operation when this graphic artwork is replaced. When this method is invoked, the replaced peer CWsGraphicDrawer on the server has been destroyed.

SendMessage(const TDesC8 &)

IMPORT_C void

SendMessage

(

const TDesC8 &

aData

)

const [protected]

Sends message to this graphic artwork peer on the server.

Parameters

const TDesC8 & aData

User specific data.

SendSynchronMessage(const TDesC8 &)

IMPORT_C TInt

SendSynchronMessage

(

const TDesC8 &

aData

)

const [protected]

Parameters

const TDesC8 & aData

Session()

IMPORT_C RWsSession &

Session

(

)

[protected]

SetGraphicExtension(MWsObjectProvider *)

IMPORT_C void

SetGraphicExtension

(

MWsObjectProvider *

aExt

)

[protected]

Parameters

MWsObjectProvider * aExt

Share(TSecureId)

IMPORT_C TInt

(

TSecureId

aClientId

)

[protected, virtual]

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

Parameters

TSecureId aClientId

the Secure ID of the client sessions to share with.

ShareGlobally()

IMPORT_C TInt

ShareGlobally

(

)

[protected, virtual]

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

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

TSecureId aClientId

the Secure ID of the client sessions to not share with

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

Member Data Documentation

CPimpl * iPimpl

CPimpl *

iPimpl

[private]

TInt iWsGraphicSpare

TInt

iWsGraphicSpare

[private]