wx.ActivityIndicator¶

Small control showing an animation indicating that the program is currently busy performing some background task.

Added in version 4.1/wxWidgets-3.1.0.

Class Hierarchy¶

Inheritance diagram for class ActivityIndicator:

Inheritance diagram of ActivityIndicator

Control Appearance¶

Methods Summary¶

`__init__`	Default constructor.
`Create`	Create the control initialized using the default constructor.
`GetClassDefaultAttributes`
`IsRunning`	Returns `True` if the control is currently showing activity.
`Start`	Starts animation of the indicator.
`Stop`	Stops the animation of the indicator.

Class API¶

class wx.ActivityIndicator(Control)¶

Possible constructors:

ActivityIndicator() -> None

ActivityIndicator(parent, winid=ID_ANY, pos=DefaultPosition,
                  size=DefaultSize, style=0, name="activityindicator") -> None

Small control showing an animation indicating that the program is currently busy performing some background task.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor.

Use Create to really create the control after using this constructor.

Return type:: None

__init__ (self, parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name=”activityindicator”)

Constructor fully creating the control.

The arguments have the usual meanings and only parent is typically required.

Parameters:

parent (wx.Window)
winid (wx.WindowID)
pos (wx.Point)
size (wx.Size)
style (long)
name (string)

Return type:

None

Create(self, parent, winid=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, name='activityindicator')¶

Create the control initialized using the default constructor.

This method can be used to finish the control creation if it hadn’t been done already by using the non-default constructor.

Parameters:

parent (wx.Window)
winid (wx.WindowID)
pos (wx.Point)
size (wx.Size)
style (long)
name (string)

Return type:

bool

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters:: variant (WindowVariant)
Return type:: wx.VisualAttributes

IsRunning(self)¶

Returns True if the control is currently showing activity.

Returns False initially, True once Start is called and False again after calling Stop .

Return type:: bool

Start(self)¶

Starts animation of the indicator.

Does nothing if the indicator is already running.

Return type:: None

Stop(self)¶

Stops the animation of the indicator.

Notice that the animation is stopped even if Start had been called multiple times before, i.e. the calls are not cumulative.

Return type:: None