wx.adv.AnimationCtrl

This is a static control which displays an animation.

wx.adv.AnimationCtrl API is as 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 USE_ANIMATIONCTRL is set to 1 (the default).

For the platforms where this control has a native implementation, it may have only limited support for the animation types, see wx.adv.GenericAnimationCtrl if you need to support all of them.

^^

Window Styles

This class supports the following styles:

• wx.adv.AC_DEFAULT_STYLE: The default style: wx.BORDER_NONE.

• wx.adv.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 ^^

Implementations:GTK, MSW ports; a generic implementation is used elsewhere.

See also

wx.adv.Animation, Animation Sample

Class Hierarchy

Inheritance diagram for class AnimationCtrl:

Control Appearance

wxMSW

wxMAC

wxGTK

Known Subclasses

wx.adv.GenericAnimationCtrl

Methods Summary

__init__	Initializes the object and calls Create with all the parameters.
Create	Creates the control with the given anim animation.
CreateAnimation	Create a new animation object compatible with this control.
CreateCompatibleAnimation	Create a new animation object compatible with this control.
GetAnimation	Returns the animation associated with this control.
GetClassDefaultAttributes
GetInactiveBitmap	Returns the inactive bitmap shown in this control when the; see SetInactiveBitmap for more info.
IsPlaying	Returns True if the animation is being played.
Load	Loads the animation from the given stream and calls SetAnimation .
LoadFile	Loads the animation from the given file and calls SetAnimation .
Play	Starts playing the animation.
SetAnimation	Sets the animation to play in this control.
SetInactiveBitmap	Sets the bitmap to show on the control when it’s not playing an animation.
Stop	Stops playing the animation.

Properties Summary

Animation	See GetAnimation and SetAnimation
InactiveBitmap	See GetInactiveBitmap and SetInactiveBitmap

Class API

class wx.adv.AnimationCtrl(Control)

Possible constructors:

AnimationCtrl(parent, id=ID_ANY, anim=NullAnimation,
              pos=DefaultPosition, size=DefaultSize, style=AC_DEFAULT_STYLE,
              name=AnimationCtrlNameStr)

This is a static control which displays an animation.

Methods

__init__(self, parent, id=ID_ANY, anim=NullAnimation, pos=DefaultPosition, size=DefaultSize, style=AC_DEFAULT_STYLE, name=AnimationCtrlNameStr)

Initializes the object and calls Create with all the parameters.

Parameters:

• parent (wx.Window) –

• id (wx.WindowID) –

• anim (wx.adv.Animation) –

• pos (wx.Point) –

• size (wx.Size) –

• style (long) –

• name (string) –

---

Create(self, parent, id=ID_ANY, anim=NullAnimation, pos=DefaultPosition, size=DefaultSize, style=AC_DEFAULT_STYLE, name=AnimationCtrlNameStr)

Creates the control with the given anim animation.

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

Parameters:

• parent (wx.Window) – Parent window, must be not None.

• id (wx.WindowID) – The identifier for the control.

• anim (wx.adv.Animation) – The initial animation shown in the control.

• pos (wx.Point) – Initial position.

• size (wx.Size) – Initial size.

• style (long) – The window style, see AC_ flags.

• name (string) – Control name.

Return type:

bool

Returns:

True if the control was successfully created or False if creation failed.

---

CreateAnimation(self)

Create a new animation object compatible with this control.

A wx.adv.Animation object created using this function is always compatible with controls of this type, see wx.adv.Animation.IsCompatibleWith .

Return type:

wx.adv.Animation

New in version 4.1/wxWidgets-3.1.4.

See also

CreateCompatibleAnimation

---

static CreateCompatibleAnimation()

Create a new animation object compatible with this control.

This method does the same thing as CreateAnimation but is static, i.e. can be called without creating any wx.adv.AnimationCtrl objects.

Return type:

wx.adv.Animation

New in version 4.1/wxWidgets-3.1.4.

---

GetAnimation(self)

Returns the animation associated with this control.

Return type:

wx.adv.Animation

---

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Parameters:

variant (WindowVariant) –

Return type:

VisualAttributes

---

GetInactiveBitmap(self)

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

Return type:

Bitmap

---

IsPlaying(self)

Returns True if the animation is being played.

Return type:

bool

---

Load(self, file, animType=ANIMATION_TYPE_ANY)

Loads the animation from the given stream and calls SetAnimation .

See wx.adv.Animation.Load for more info.

Parameters:

• file (wx.InputStream) –

• animType (AnimationType) –

Return type:

bool

---

LoadFile(self, file, animType=ANIMATION_TYPE_ANY)

Loads the animation from the given file and calls SetAnimation .

See wx.adv.Animation.LoadFile for more info.

Parameters:

• file (string) –

• animType (AnimationType) –

Return type:

bool

---

Play(self)

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.

Return type:

bool

---

SetAnimation(self, anim)

Sets the animation to play in this control.

If the previous animation is being played, it’s Stop 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:

anim (wx.adv.Animation) –

---

SetInactiveBitmap(self, bmp)

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.

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.

Parameters:

bmp (wx.BitmapBundle) –

---

Stop(self)

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.

Properties

Animation

See GetAnimation and SetAnimation

---

InactiveBitmap

See GetInactiveBitmap and SetInactiveBitmap