Class CWsGraphicBitmap

class CWsGraphicBitmap : public CWsGraphic;

Description

Client representation of a window-server-side CFbsBitmap 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

• CWsGraphicBitmap - Client representation of a window-server-side CFbsBitmap owned by this Client

Members

Defined in CWsGraphicBitmap:
HandleMessage(), NewL(), NewL(), NewL(), OnReplace(), Share(), ShareGlobally(), UnShare(), UnShareGlobally(), ~CWsGraphicBitmap()

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

Inherited from CWsGraphic:
BaseConstructL(), CWsGraphic_Reserved1(), CWsGraphic_Reserved2(), CWsGraphic_Reserved3(), Destroy(), Flush(), Id(), IsActive(), OnClientClose(), SendMessage(), SendSynchronMessage(), SetGraphicExtension()

static IMPORT_C CWsGraphicBitmap *NewL(const CFbsBitmap *aBitmap, const CFbsBitmap *aMask);

Description

Parameters

const CFbsBitmap *aBitmap const CFbsBitmap *aMask

Return value

CWsGraphicBitmap *

static IMPORT_C CWsGraphicBitmap *NewL(TUid aUid, const CFbsBitmap *aBitmap, const CFbsBitmap *aMask);

Description

Parameters

TUid aUid const CFbsBitmap *aBitmap const CFbsBitmap *aMask

Return value

CWsGraphicBitmap *

static IMPORT_C CWsGraphicBitmap *NewL(const TWsGraphicId &aReplace, const CFbsBitmap *aBitmap, const CFbsBitmap *aMask);

Description

Parameters

const TWsGraphicId &aReplace const CFbsBitmap *aBitmap const CFbsBitmap *aMask

Return value

CWsGraphicBitmap *

IMPORT_C ~CWsGraphicBitmap();

Description

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.

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.

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.

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

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

Description

Handles message from this graphic artwork peer on the server.

Parameters

const TDesC8 &aData Message from peer CWsGraphicDrawer.

private: virtual void OnReplace();

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.