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

See also

wxAnimation

Members

wxAnimationCtrl::wxAnimationCtrl
wxAnimationCtrl::Create
wxAnimationCtrl::GetAnimation
wxAnimationCtrl::GetInactiveBitmap
wxAnimationCtrl::IsPlaying
wxAnimationCtrl::LoadFile
wxAnimationCtrl::Play
wxAnimationCtrl::SetAnimation
wxAnimationCtrl::SetInactiveBitmap
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

Parent window, must be non-NULL.

id

The identifier for the control.

anim

The initial animation shown in the control.

pos

Initial position.

size

Initial size.

style

The window style, see wxAC_* flags.

name

Control 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::GetInactiveBitmap

wxBitmap GetInactiveBitmap() const

Returns the inactive bitmap shown in this control when the; see SetInactiveBitmap for more info.

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 stopped 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, a static image, the first frame of the given animation or the background colour will be shown (see SetInactiveBitmap for more info).

wxAnimationCtrl::SetInactiveBitmap

void SetInactiveBitmap(const wxBitmap& bmp)

Sets the bitmap to show on the control when it's not playing an animation. If you set as inactive bitmap wxNullBitmap (which is the default), then the first frame of the animation is instead shown when the control is inactive; in this case, if there's no valid animation associated with the control (see SetAnimation), then the background colour of the window is shown.

If the control is not playing the animation, the given bitmap will be immediately shown, otherwise it will be shown as soon as Stop is called.

Note that the inactive bitmap, if smaller than the control's size, will be centered in the control; if bigger, it will be stretched to fit it.

wxAnimationCtrl::Stop

void Stop()

Stops playing the animation. The control will show the first frame of the animation, a custom static image or the window's background colour as specified by the last SetInactiveBitmap call.