CBitmapAnimClientData Class Reference

#include <mw/bmpancli.h>

class CBitmapAnimClientData : public CBase

Inherits from

  • CBitmapAnimClientData

    Detailed Description

    Encapsulates one or more animation frames into an entire animation.

    In addition to specifying the frames you wish to include in your animation, you can also specify:

    • whether the animation will flash

    • whether the animation is played once, or continuously

    • the background frame that is drawn to clear each frame in the animation

    You can also specify a default frame interval that is used for all frames in an animation. If the interval is already set for any of the individual frames, that takes precedence.

    When you have defined your animation, use RBitmapAnim to play the animation.

    Member Enumeration Documentation

    Enum TPlayMode

    Animation play mode flags.

    The animation can be played in any of the ways described below.


    Plays the animation once, from the first frame to the last one.


    Plays the animation from the first frame to the last one continuously.


    Plays the animation from the first frame to the last one then from the last frame to the first continuously.

    Constructor & Destructor Documentation

    ~CBitmapAnimClientData ( )


    Member Function Documentation

    AppendFrameL ( CBitmapFrameData * )

    IMPORT_C voidAppendFrameL(CBitmapFrameData *aFrame)

    BackgroundFrame ( )

    IMPORT_C CBitmapFrameData *BackgroundFrame()const

    DurationInMilliSeconds ( )

    IMPORT_C TIntDurationInMilliSeconds()const

    Flash ( )

    IMPORT_C TBoolFlash()const

    FrameArray ( )

    IMPORT_C const CArrayPtrFlat< CBitmapFrameData > &FrameArray()const

    FrameIntervalInMilliSeconds ( )

    IMPORT_C TIntFrameIntervalInMilliSeconds()const

    NewL ( )

    IMPORT_C CBitmapAnimClientData *NewL()[static]

    PlayMode ( )

    IMPORT_C TPlayModePlayMode()const

    ResetFrameArray ( )

    IMPORT_C voidResetFrameArray()

    SetBackgroundFrame ( CBitmapFrameData * )

    IMPORT_C voidSetBackgroundFrame(CBitmapFrameData *aBackgroundFrame)

    SetFlash ( TBool )

    IMPORT_C voidSetFlash(TBoolaFlash)

    SetFrameInterval ( TInt )

    IMPORT_C voidSetFrameInterval(TIntaFrameIntervalInMilliSeconds)

    SetPlayMode ( TPlayMode )

    IMPORT_C voidSetPlayMode(TPlayModeaPlayMode)

    Size ( )

    IMPORT_C TSizeSize()const