Switch

macOS	GTK+	Windows	iOS	Android	Django

The switch widget is a clickable button with two stable states, True (on, checked) and False (off, unchecked).

Usage

import toga

input = toga.Switch()

Reference

class toga.widgets.switch.Switch(label, id=None, style=None, on_toggle=None, is_on=False, enabled=True, factory=None)

Switch widget, a clickable button with two stable states, True (on, checked)

and False (off, unchecked).

Parameters

• label (str) – Text to be shown next to the switch.

• 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.

• on_toggle (callable) – Function to execute when pressed.

• is_on (bool) – Current on or off state of the switch.

• enabled (bool) – Whether or not interaction with the button is possible, 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_on

Button Off/On state.

Returns

True if on and False if the switch is off.

property label

Accompanying text label of the Switch.

Returns

The label text of the widget as a str.

property on_toggle

The callable function for when the switch is pressed

Returns

The callable on_toggle function.

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.

toggle()

Reverse the value of Slider.is_on property from true to false and vice versa.

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.