.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.ActivityIndicator:
==========================================================================================================================================
|phoenix_title| **wx.ActivityIndicator**
==========================================================================================================================================
Small control showing an animation indicating that the program is currently busy performing some background task.
.. versionadded:: 4.1/wxWidgets-3.1.0
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
ActivityIndicator:
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ActivityIndicator.__init__` Default constructor.
:meth:`~wx.ActivityIndicator.Create` Create the control initialized using the default constructor.
:meth:`~wx.ActivityIndicator.GetClassDefaultAttributes`
:meth:`~wx.ActivityIndicator.IsRunning` Returns ``True`` if the control is currently showing activity.
:meth:`~wx.ActivityIndicator.Start` Starts animation of the indicator.
:meth:`~wx.ActivityIndicator.Stop` Stops the animation of the indicator.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ActivityIndicator(Control)
**Possible constructors**::
ActivityIndicator() -> None
ActivityIndicator(parent : Window, winid: int=ID_ANY, pos:
Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name:
str="activityindicator") -> None
Small control showing an animation indicating that the program is
currently busy performing some background task.
.. method:: __init__(self, *args, **kw)
|overload| **Overloaded Implementations:**
:html:`
`
**__init__** `(self)`
Default constructor.
Use :meth:`Create` to really create the control after using this constructor.
:rtype: `None`
:html:`
`
**__init__** `(self, parent : Window, winid: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name: str="activityindicator")`
Constructor fully creating the control.
The arguments have the usual meanings and only `parent` is typically required.
:param `parent`:
:type `parent`: wx.Window
:param `winid`:
:type `winid`: wx.WindowID
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `None`
:html:`
`
.. method:: Create(self, parent : Window, winid: int=ID_ANY, pos: Point=DefaultPosition, size: Size=DefaultSize, style: int=0, name: str="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.
:param `parent`:
:type `parent`: wx.Window
:param `winid`:
:type `winid`: wx.WindowID
:param `pos`:
:type `pos`: wx.Point
:param `size`:
:type `size`: wx.Size
:param `style`:
:type `style`: long
:param `name`:
:type `name`: string
:rtype: `bool`
.. staticmethod:: GetClassDefaultAttributes(variant: WindowVariant=WINDOW_VARIANT_NORMAL)
:param `variant`:
:type `variant`: wx.WindowVariant
:rtype: :ref:`wx.VisualAttributes`
.. method:: IsRunning(self)
Returns ``True`` if the control is currently showing activity.
Returns ``False`` initially, ``True`` once :meth:`Start` is called and ``False`` again after calling :meth:`Stop` .
:rtype: `bool`
.. method:: Start(self)
Starts animation of the indicator.
Does nothing if the indicator is already running.
:rtype: `None`
.. method:: Stop(self)
Stops the animation of the indicator.
Notice that the animation is stopped even if :meth:`Start` had been called multiple times before, i.e. the calls are not cumulative.
:rtype: `None`