Class CWsGraphic

class CWsGraphic : public CBase;

Description

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap

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

Members

Defined in CWsGraphic:
BaseConstructL(), BaseConstructL(), BaseConstructL(), CWsGraphic(), CWsGraphic_Reserved1(), CWsGraphic_Reserved2(), CWsGraphic_Reserved3(), Destroy(), Flush(), HandleMessage(), Id(), IsActive(), OnClientClose(), OnReplace(), SendMessage(), SendSynchronMessage(), SetGraphicExtension(), Share(), ShareGlobally(), UnShare(), UnShareGlobally(), ~CWsGraphic()

Inherited from CBase:
Delete(), Extension_(), operator new()

protected: IMPORT_C CWsGraphic();

Description

Default Constructor.

IMPORT_C ~CWsGraphic();

Description

Destructor.

Capability:

ProtServ

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

Description

Constructs a piece of non-transient graphic artwork.

Parameters

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

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

Description

Constructs a piece of transient graphic artwork.

Parameters

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

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

Description

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.

protected: virtual IMPORT_C TInt ShareGlobally();

Description

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

Return value

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

protected: virtual IMPORT_C TInt Share(TSecureId aClientId);

Description

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.

Return value

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

protected: virtual IMPORT_C TInt UnShare(TSecureId aClientId);

Description

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

Return value

TInt 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

protected: virtual IMPORT_C TInt UnShareGlobally();

Description

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

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

IMPORT_C const TWsGraphicId &Id() const;

Description

Returns graphic artwork Id.

Return value

const TWsGraphicId & Graphic artwork Id. KNullWsGraphicId if graphic artwork is not active.

IMPORT_C TBool IsActive() const;

Description

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

Return value

TBool ETrue if this graphic artwork has a peer CWsGraphic on the server.

IMPORT_C void Destroy();

Description

Destroys the corresponding CWsGraphicDrawer instance on the server

protected: IMPORT_C void SendMessage(const TDesC8 &aData) const;

Description

Sends message to this graphic artwork peer on the server.

Parameters

const TDesC8 &aData User specific data.

protected: IMPORT_C TInt SendSynchronMessage(const TDesC8 &aData) const;

Description

Parameters

const TDesC8 &aData

Return value

TInt

protected: IMPORT_C TInt Flush() const;

Description

Flushes window server command buffer

Return value

TInt One of system-wide error codes.

protected: IMPORT_C void SetGraphicExtension(MWsObjectProvider *aExt);

Description

Parameters

MWsObjectProvider *aExt

private: virtual void HandleMessage(const TDesC8 &aData)=0;

Description

Handles message from this graphic artwork peer on the server.

Parameters

const TDesC8 &aData Message from peer CWsGraphicDrawer.

private: virtual void OnReplace()=0;

Description

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

private: virtual IMPORT_C void OnClientClose();

Description

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

private: virtual IMPORT_C TInt CWsGraphic_Reserved1();

Description

Return value

TInt

private: virtual IMPORT_C TInt CWsGraphic_Reserved2();

Description

Return value

TInt

private: virtual IMPORT_C TInt CWsGraphic_Reserved3();

Description

Return value

TInt