Inheritance diagram for wx.animate.AnimationCtrl:
This is a static control which displays an animation. wx.animate.AnimationCtrl API is simple as possible and won’t give you full control on the animation; if you need it then use wx.media.MediaCtrl.
This control is useful to display a (small) animation while doing a long task (e.g. a “throbber”).
It is only available if wx.USE_ANIMATIONCTRL is set to 1 (the default).
See also
wx.animate.GIFAnimationCtrl
Window Style | Description |
---|---|
wx.animate.AC_DEFAULT_STYLE | The default style: wx.NO_BORDER. |
wx.animate.AC_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. |
Constructor.
Parameters:
Returns:
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.
Parameters:
Returns:
bool
Returns the animation associated with this control.
Returns:
Returns the inactive bitmap shown in this control when the; see SetInactiveBitmap for more info.
Returns:
See also
Returns True if the animation is being played.
Returns:
bool
Loads an animation from a file and calls SetAnimation.
Returns True if the operation succeeded, False otherwise.
Parameters:
name (string): A filename.
type (int): One of the following values:
Animation Type |
Description |
---|---|
wx.animate.ANIMATION_TYPE_GIF |
Load an animated GIF file. |
wx.animate.ANIMATION_TYPE_ANI |
Load an ANI file. |
wx.animate.ANIMATION_TYPE_ANY |
Try to autodetect the filetype. |
Returns:
bool
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).
Returns:
bool
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).
Parameters:
Sets the bitmap to show on the control when it’s not playing an animation.
If you set as inactive bitmap wx.NullBitmap (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.
Parameters:
Note
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.
See also
Parameters:
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.