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

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

Members

Defined in CWsGraphicBitmap:

• HandleMessage(const TDesC8 &)Handles message from this graphic artwork peer on the server.
• NewL(TUid,const CFbsBitmap *,const CFbsBitmap *)Constructs the client representation of a window-server-side CFbsBitmap owned by...
• NewL(const CFbsBitmap *,const CFbsBitmap *)Constructs the client representation of a window-server-side CFbsBitmap owned by...
• NewL(const TWsGraphicId &,const CFbsBitmap *,const CFbsBitmap *)Constructs the client representation of a window-server-side CFbsBitmap owned by...
• OnReplace()Handles custom operation when this graphic artwork is replaced. When this method...
• 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 ...
• ~CWsGraphicBitmap()

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

Inherited from 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...
• Destroy()Destroys the corresponding CWsGraphicDrawer instance on the server
• Flush()constFlushes window server command buffer
• Id()constReturns graphic artwork Id.
• IsActive()constChecks whether a peer of this graphic artwork has been fully constructed on the ...
• SendMessage(const TDesC8 &)constSends message to this graphic artwork peer on the server.
• SendSynchronMessage(const TDesC8 &)const
• SetGraphicExtension(MWsObjectProvider *)

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

Description

Constructs the client representation of a window-server-side CFbsBitmap owned by this Client. The base class CWsGraphic is therefore constructed having KStdBitmapType as artwork type.

Parameters

const CFbsBitmap *aBitmap CFbsBitmap owned by the Client const CFbsBitmap *aMask Bitmap's Mask.

Return value

CWsGraphicBitmap *

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

Description

Constructs the client representation of a window-server-side CFbsBitmap owned by this Client. The base class CWsGraphic is therefore constructed having KStdBitmapType as artwork type.

Parameters

TUid aUid Graphic Bitmap UID. const CFbsBitmap *aBitmap CFbsBitmap owned by the Client const CFbsBitmap *aMask Bitmap's Mask.

Return value

CWsGraphicBitmap *

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

Description

Constructs the client representation of a window-server-side CFbsBitmap owned by this Client. The base class CWsGraphic is therefore constructed having KStdBitmapType as artwork type.

Atomically replace the artwork that already exists with this artwork (i.e. aBitmap) . If failure to properly construct the replacement artwork occurs, the replacee artwork will remain

Parameters

const TWsGraphicId &aReplace Bitmap artwork which will be replaced. const CFbsBitmap *aBitmap CFbsBitmap owned by the Client const CFbsBitmap *aMask Bitmap's Mask.

Return value

CWsGraphicBitmap *

IMPORT_C ~CWsGraphicBitmap();

Description

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

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 CWsGraphicBitmap::Share(TSecureId).

Return value

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

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

IMPORT_C virtual TInt UnShare(TSecureId aClientId);

Description

Stops this graphic artwork from being shared with all client sessions with the specific Secure ID. CWsGraphicBitmap::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.