Contents Up Previous Next

wxAnimationCtrl

This is a static control which displays an animation. wxAnimationCtrl API is simple as possible and won't give you full control on the animation; if you need it then use wxMediaCtrl.

This control is useful to display a (small) animation while doing a long task (e.g. a "throbber").

It is only available if wxUSE_ANIMATIONCTRL is set to 1 (the default).

Derived from

wxControl
wxWindow
wxEvtHandler
wxObject

Include files

<wx/animate.h>

Window styles

wxAC_DEFAULT_STYLE The default style: wxNO_BORDER.
wxAC_NO_AUTORESIZE By default, the control will adjust its size to exactly fit to the size of the animation when SetAnimation is called. If this style flag is given, the control will not change its size

See also

wxAnimation

Members

wxAnimationCtrl::wxAnimationCtrl
wxAnimationCtrl::Create
wxAnimationCtrl::GetAnimation
wxAnimationCtrl::IsPlaying
wxAnimationCtrl::LoadFile
wxAnimationCtrl::Play
wxAnimationCtrl::SetAnimation
wxAnimationCtrl::Stop


wxAnimationCtrl::wxAnimationCtrl

wxAnimationCtrl(wxWindow *parent, wxWindowID id, const wxAnimation& anim, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxAC_DEFAULT_STYLE, const wxString& name = "animationctrl")

Initializes the object and calls Create with all the parameters.


wxAnimationCtrl::Create

bool Create(wxWindow *parent, wxWindowID id, const wxAnimation& anim, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxAC_DEFAULT_STYLE, const wxString& name = "animationctrl")

Parameters

parent

id

anim

pos

size

style

name

After control creation you must explicitely call Play to start to play the animation. Until that function won't be called, the first frame of the animation is displayed.

Return value

true if the control was successfully created or false if creation failed.


wxAnimationCtrl::GetAnimation

wxAnimation GetAnimation() const

Returns the animation associated with this control.


wxAnimationCtrl::IsPlaying

bool IsPlaying() const

Returns true if the animation is being played.


wxAnimationCtrl::LoadFile

bool LoadFile(const wxString & file, wxAnimationType animType = wxANIMATION_TYPE_ANY)

Loads the animation from the given file and calls SetAnimation. See wxAnimation::LoadFile for more info.


wxAnimationCtrl::Play

bool Play()

Starts playing the animation. The animation is always played in loop mode (unless the last frame of the animation has an infinite delay time) and always start from the first frame (even if you atopped it while some other frame was displayed).


wxAnimationCtrl::SetAnimation

void SetAnimation(const wxAnimation & anim)

Sets the animation to play in this control. If the previous animation is being played, it's Stopped.

Until Play isn't called, the first frame of the animation is displayed.

If wxNullAnimation is given as animation, the control will be cleared to display the background colour (see wxWindow::GetBackgroundColour).


wxAnimationCtrl::Stop

void Stop()

Stops playing the animation. The control will show the last frame rendered of the current animation until Play is called.