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#
- 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 range#
Range composed of min and max slider value.
- Returns:
Returns the range in a
tuple
like this (min, max)
- 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.