Class CWsGraphicBitmapAnimation

class CWsGraphicBitmapAnimation : 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...

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

Members

Defined in CWsGraphicBitmapAnimation:

• CFrame
• HandleMessage(const TDesC8 &)Handles message from this graphic artwork peer on the server.
• NewL(TUid,const TFrames &)
• NewL(const TFrames &)
• NewL(const TWsGraphicId &,const TFrames &)
• 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...
• TFrames
• 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 ...
• ~CWsGraphicBitmapAnimation()

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 CWsGraphicBitmapAnimation* NewL(const TFrames &aFrames);

Description

Parameters

const TArray &aFrames

Return value

CWsGraphicBitmapAnimation *

IMPORT_C static CWsGraphicBitmapAnimation* NewL(TUid aUid, const TFrames &aFrames);

Description

Parameters

TUid aUid const TArray &aFrames

Return value

CWsGraphicBitmapAnimation *

IMPORT_C static CWsGraphicBitmapAnimation* NewL(const TWsGraphicId &aReplace, const TFrames &aFrames);

Description

Parameters

const TWsGraphicId &aReplace const TArray &aFrames

Return value

CWsGraphicBitmapAnimation *

IMPORT_C ~CWsGraphicBitmapAnimation();

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

class CFrame : public CBase;

Description

Derivation

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

• CWsGraphicBitmapAnimation::CFrame - (No abstract)

Members

Defined in CWsGraphicBitmapAnimation::CFrame:

• Bitmap()const
• FrameInfo()const
• Mask()const
• NewL()
• SetBitmap(CFbsBitmap *)
• SetFrameInfo(const TFrameInfo &)
• SetMask(CFbsBitmap *)
• ~CFrame()

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

Construction and destruction

---

NewL()

IMPORT_C static CFrame* NewL();

Description

Return value

CWsGraphicBitmapAnimation::CFrame *

---

~CFrame()

IMPORT_C ~CFrame();

Description

Member functions

---

FrameInfo()const

IMPORT_C TFrameInfo FrameInfo() const;

Description

Return value

TFrameInfo

---

SetFrameInfo(const TFrameInfo &)

IMPORT_C void SetFrameInfo(const TFrameInfo &aFrameInfo);

Description

Parameters

const TFrameInfo &aFrameInfo

---

Bitmap()const

IMPORT_C const CFbsBitmap* Bitmap() const;

Description

Return value

const CFbsBitmap *

---

SetBitmap(CFbsBitmap *)

IMPORT_C void SetBitmap(CFbsBitmap *aBitmap);

Description

Parameters

CFbsBitmap *aBitmap

---

Mask()const

IMPORT_C const CFbsBitmap* Mask() const;

Description

Return value

const CFbsBitmap *

---

SetMask(CFbsBitmap *)

IMPORT_C void SetMask(CFbsBitmap *aMask);

Description

Parameters

CFbsBitmap *aMask

typedef TArray<CFrame*> CWsGraphicBitmapAnimation::TFrames;

Description