Slider#

Usage#

Reference#

class toga.widgets.slider.Slider(id=None, style=None, value=None, range=None, tick_count=None, on_change=None, on_slide=None, on_press=None, on_release=None, enabled=True, factory=None, default=None)#

Slider widget, displays a range of values.

Parameters:

id – An identifier for this widget.
style (Style) –
value (float) – Initial value of the slider
range (tuple) – Min and max values of the slider in this form (min, max).
tick_count (int) – How many ticks in range. if None, slider is continuous.
on_change (callable) – The handler to invoke when the slider value changes.
on_press (callable) – The handler to invoke when the slider has been pressed.
on_release (callable) – The handler to invoke when the slider has been released.
enabled (bool) – Whether user interaction is possible or not.

MIN_WIDTH = 100#

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 max#

property min#

property on_change#

The function for when the value of the slider is changed.

Returns:: The callable that is executed when the value changes.

property on_press#

The function for when the user click the slider before sliding it.

Returns:: The callable that is executed when the slider is clicked.

property on_release#

The function for when the user release the slider after sliding it.

Returns:: The callable that is executed when the slider is released.

property on_slide#

The function for when the value of the slider is changed.

DEPRECATED: renamed as on_change

Returns:: The callable that is executed on slide.

property parent#

The parent of this node.

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

property range#

Range composed of min and max slider value.

Returns:: Returns the range in a tuple like this (min, max)

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.

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

property tick_count#

property tick_step#

property tick_value#

The value of the slider, measured in ticks.

If tick count is not None, a value between 1 and tick count. Otherwise, None.

property value#

Current slider value.

Returns:: The current slider value as a float.
Raises:: ValueError – If the new value is not in the range of min and max.

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.