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.
factory (module) – A python module that is capable to return a implementation of this class with the same name. (optional & normally not needed)

add(*children)¶

Add nodes as children of this one. 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.

Parameters: children – Nodes to add as children of this node.
Raises: ValueError – If this node is a leaf, and cannot have children.

property app¶

The App to which this widget belongs. On setting the app we also iterate over all children of this widget and set them to the same app.

Returns: The toga.App to which this widget belongs.
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¶

focus()¶

property id¶

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

Returns: The widgets identifier as a str.

insert(index, child)¶

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

Parameters

index – Position of child node.
child – A node to insert as a child of this node.

Raises

ValueError – If this node is a leaf, and cannot have children.

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 child nodes of this node. This does nothing if a given node is not a child of this node.

Parameters: children – Child nodes to remove.
Raises: ValueError – If this node is a leaf, and cannot have children.

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 window¶

The Window to which this widget belongs. On setting the window, we automatically update all children of this widget to belong to the same window.

Returns: The toga.Window to which the widget belongs.