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 Cli...

Members

Defined in CWsGraphic:

• BaseConstructL(TUid,TUid,const TDesC8 &)Constructs a piece of non-transient graphic artwork.
• BaseConstructL(TUid,const TDesC8 &)Constructs a piece of transient graphic artwork.
• BaseConstructL(const TWsGraphicId &,TUid,const TDesC8 &)Atomically replace the artwork that already exists with this artwork. If failure...
• CWsGraphic()Default Constructor.
• CWsGraphic_Reserved1()
• CWsGraphic_Reserved2()
• CWsGraphic_Reserved3()
• Destroy()Destroys the corresponding CWsGraphicDrawer instance on the server
• Flush()constFlushes window server command buffer
• HandleMessage(const TDesC8 &)Handles message from this graphic artwork peer on the server.
• Id()constReturns graphic artwork Id.
• IsActive()constChecks whether a peer of this graphic artwork has been fully constructed on the ...
• OnClientClose()Derived class can override this method to provide custom operations when the cli...
• OnReplace()Handles custom operation when this graphic artwork is replaced. When this method...
• SendMessage(const TDesC8 &)constSends message to this graphic artwork peer on the server.
• SendSynchronMessage(const TDesC8 &)const
• SetGraphicExtension(MWsObjectProvider *)
• Share(TSecureId)Explicitly shares this graphic artwork with client sessions with the specified S...
• ShareGlobally()Shares the graphic artwork with all the client sessions. Sharing globally trumps...
• UnShare(TSecureId)Stops this graphic artwork from being shared with all client sessions with the s...
• UnShareGlobally()Prevents this graphic artwork from being shared with all the client sessions. A ...
• ~CWsGraphic()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

protected: IMPORT_C CWsGraphic();

Description

Default Constructor.

IMPORT_C ~CWsGraphic();

Description

Destructor.

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

Description

Constructs a piece of non-transient graphic artwork.

Parameters

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

Description

Constructs a piece of transient graphic artwork.

Parameters

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

protected: IMPORT_C virtual TInt ShareGlobally();

Description

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

Return value

protected: IMPORT_C virtual TInt Share(TSecureId aClientId);

Description

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

Parameters

Return value

protected: IMPORT_C virtual TInt UnShare(TSecureId aClientId);

Description

Stops this graphic artwork from being shared with all client sessions with the specific Secure ID. CWsGraphic::ShareGlobally() trumps explicit sharing.

Parameters

Return value

protected: IMPORT_C virtual 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 CWsGraphic::Share(TSecureId).

Return value

IMPORT_C const TWsGraphicId& Id() const;

Description

Returns graphic artwork Id.

Return value

IMPORT_C TBool IsActive() const;

Description

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

Return value

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

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

Description

Parameters

Return value

protected: IMPORT_C TInt Flush() const;

Description

Flushes window server command buffer

Return value

protected: IMPORT_C void SetGraphicExtension(MWsObjectProvider *aExt);

Description

Parameters

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

Description

Handles message from this graphic artwork peer on the server.

Parameters

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: IMPORT_C virtual void OnClientClose();

Description

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

private: IMPORT_C virtual TInt CWsGraphic_Reserved1();

Description

Return value

private: IMPORT_C virtual TInt CWsGraphic_Reserved2();

Description

Return value

private: IMPORT_C virtual TInt CWsGraphic_Reserved3();

Description

Return value