Activity Indicator#

The activity indicator is a (spinning) animation for showing progress in an indeterminate task.

Usage#

import toga

spinner = toga.ActivityIndicator()

# make widget visible and start animation
spinner.start()

Reference#

class toga.widgets.activityindicator.ActivityIndicator(id=None, style=None, running=False, factory=None)#

Parameters:

id (str) – An identifier for this widget.
style (Style) – An optional style object. If no style is provided then a new one will be created for the widget.
running (bool) – Set the initial running mode. Defaults to False
hide_when_stopped (bool) – Hide the indicator when not running. Defaults to True.

add(*children)#

Add the provided widgets as children of this widget.

If a node already has a different parent, it will be moved over. This does nothing if a node already is a child of this node.

Raises ValueError if this widget cannot have children.

Parameters:: children – The widgets to add as children of this widget.

property app#

The App to which this widget belongs.

When setting the app for a widget, all children of this widget will be recursively assigned to the same app.

Raises ValueError if the widget is already associated with another app.

property can_have_children#

Determine if the node can have children.

This does not resolve whether there actually are any children; it only confirms whether children are theoretically allowed.

property children#

The children of this node. This always returns a list, even if the node is a leaf and cannot have children.

Returns:: A list of the children for this widget.

property enabled#: Is the widget currently enabled? i.e., can the user interact with the widget?

focus()#: Set this widget to have the current input focus.

property id#: The node identifier. This id can be used to target styling directives.

insert(index, child)#

Insert a widget as a child of this widget.

If the node already has a parent, ownership of the widget will be transferred.

Raises ValueError if this node cannot have children.

Parameters:

index – The position in the list of children where the new widget should be added.
child – The child to insert as a child of this node.

property is_running#

Use start() and stop() to change the running state.

Returns:: True if this activity indicator is running False otherwise

property parent#

The parent of this node.

Returns:: The parent of this node. Returns None if this node is the root node.

refresh()#: Refresh the layout and appearance of the tree this node is contained in.

refresh_sublayouts()#

remove(*children)#

Remove the provided widgets as children of this node.

This does nothing if a given node is not a child of this node.

Raises ValueError if this node is a leaf, and cannot have children.

Parameters:: children – The child nodes to remove.

property root#

The root of the tree containing this node.

Returns:: The root node. Returns self if this node is the root node.

start()#: Start this activity indicator.

stop()#: Stop this activity indicator (if not already stopped).

property tab_index#: The position of the widget in the focus chain for the window.

property window#

The window to which this widget belongs.

When setting the window for a widget, all children of this widget will be recursively assigned to the same window.