CWsGraphicBitmap Class Reference

#include <w32stdgraphic.h>

Link against: w32stdgraphic.lib

class CWsGraphicBitmap : public CWsGraphic, public CWsGraphic

Inherits from

Detailed Description

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

Constructor & Destructor Documentation

~CWsGraphicBitmap ( )

IMPORT_C~CWsGraphicBitmap()

Member Function Documentation

NewL ( const CFbsBitmap *, const CFbsBitmap * )

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

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
aBitmapCFbsBitmap owned by the Client
aMaskBitmap's Mask.

NewL ( TUid, const CFbsBitmap *, const CFbsBitmap * )

IMPORT_C CWsGraphicBitmap *NewL(TUidaUid,
const CFbsBitmap *aBitmap,
const CFbsBitmap *aMask
)[static]

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
aUidGraphic Bitmap UID.
aBitmapCFbsBitmap owned by the Client
aMaskBitmap's Mask.

NewL ( const TWsGraphicId &, const CFbsBitmap *, const CFbsBitmap * )

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

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
aReplaceBitmap artwork which will be replaced.
aBitmapCFbsBitmap owned by the Client
aMaskBitmap's Mask.

Share ( TSecureId )

IMPORT_C TIntShare(TSecureIdaClientId)[virtual]

Reimplemented from CWsGraphic::Share(TSecureId)

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

Parameters
aClientIdthe Secure ID of the client sessions to share with.
Return Value
KErrNone If the graphic artwork was shared, else one of the system-wide error codes.

ShareGlobally ( )

IMPORT_C TIntShareGlobally()[virtual]

Reimplemented from CWsGraphic::ShareGlobally()

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

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

UnShare ( TSecureId )

IMPORT_C TIntUnShare(TSecureIdaClientId)[virtual]

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

Parameters
aClientIdthe Secure ID of the client sessions to not share with
Return Value
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

UnShareGlobally ( )

IMPORT_C TIntUnShareGlobally()[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().

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