Struct cushy::widgets::slider::Slider

pub struct Slider<T>
where
    T: SliderValue,
{
    pub value: Dynamic<T>,
    pub minimum: Value<T::Value>,
    pub maximum: Value<T::Value>,
    pub step: Value<ZeroToOne>,
    /* private fields */
}

A widget that allows sliding between two values.

Fields

value: Dynamic<T>

The current value.

minimum: Value<T::Value>

The minimum value represented by this slider.

maximum: Value<T::Value>

The maximum value represented by this slider.

step: Value<ZeroToOne>

The percentage to step when advancing the slider using alternative inputs (e.g, keyboard/mousewheel).

The widget will use this as a starting value, but will continue to step by this amount until a new unique value is obtained from linear interpolation.

This defaults to 0.05/5%.

Implementations

impl<T> Slider<T>

where T: SliderValue, T::Value: Ranged,

pub fn from_value(value: impl IntoDynamic<T>) -> Self

Returns a new slider over value using the types full range.

impl<T> Slider<T>

where T: SliderValue,

pub fn new( value: impl IntoDynamic<T>, min: impl IntoValue<T::Value>, max: impl IntoValue<T::Value>, ) -> Self

Returns a new slider using value as the slider’s value, keeping the value between min and max.

pub fn maximum(self, max: impl IntoValue<T::Value>) -> Self

Sets the maximum value of this slider to max and returns self.

pub fn minimum(self, min: impl IntoValue<T::Value>) -> Self

Sets the minimum value of this slider to min and returns self.

pub fn step_by(self, percent: impl IntoValue<ZeroToOne>) -> Self

The percentage to step when advancing the slider using alternative inputs (e.g, keyboard/mousewheel).

The widget will use this as a starting value, but will continue to step by this amount until a new unique value is obtained from linear interpolation.

This defaults to 0.05/5%.

pub fn knobless(self) -> Self

Updates this slider to not show knobs and returns self.

This also prevents the slider from being focused.

pub fn non_interactive(self) -> Self

Updates this slider to ignore all user input and returns self.

Trait Implementations

impl<T> Clone for Slider<T>

where T: SliderValue + Clone, T::Value: Clone,

fn clone(&self) -> Slider<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Slider<T>

where T: SliderValue + Debug, T::Value: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Widget for Slider<T>

where T: SliderValue,

fn redraw(&mut self, context: &mut GraphicsContext<'_, '_, '_, '_>)

Redraw the contents of this widget.

fn layout( &mut self, available_space: Size<ConstraintLimit>, context: &mut LayoutContext<'_, '_, '_, '_>, ) -> Size<UPx>

Layout this widget and returns the ideal size based on its contents and the available_space.

fn hit_test( &mut self, _location: Point<Px>, _context: &mut EventContext<'_>, ) -> bool

Returns true if this widget should respond to mouse input at location.

fn hover( &mut self, _location: Point<Px>, context: &mut EventContext<'_>, ) -> Option<CursorIcon>

The widget is currently has a cursor hovering it at location.

fn accept_focus(&mut self, context: &mut EventContext<'_>) -> bool

This widget has been targeted to be focused. If this function returns true, the widget will be focused. If false, Cushy will continue searching for another focus target.

fn focus(&mut self, context: &mut EventContext<'_>)

The widget has received focus for user input.

fn advance_focus( &mut self, direction: VisualOrder, context: &mut EventContext<'_>, ) -> EventHandling

The widget should switch to the next focusable area within this widget, honoring direction in a consistent manner. Returning HANDLED will cause the search for the next focus widget stop.

fn blur(&mut self, context: &mut EventContext<'_>)

The widget is no longer focused for user input.

fn mouse_down( &mut self, location: Point<Px>, _device_id: DeviceId, _button: MouseButton, context: &mut EventContext<'_>, ) -> EventHandling

A mouse button event has occurred at location. Returns whether the event has been handled or not.

fn mouse_drag( &mut self, location: Point<Px>, _device_id: DeviceId, _button: MouseButton, context: &mut EventContext<'_>, )

A mouse button is being held down as the cursor is moved across the widget.

fn mouse_up( &mut self, _location: Option<Point<Px>>, _device_id: DeviceId, _button: MouseButton, _context: &mut EventContext<'_>, )

A mouse button is no longer being pressed.

fn keyboard_input( &mut self, _device_id: DeviceId, input: KeyEvent, _is_synthetic: bool, _context: &mut EventContext<'_>, ) -> EventHandling

A keyboard event has been sent to this widget. Returns whether the event has been handled or not.

fn mouse_wheel( &mut self, _device_id: DeviceId, delta: MouseScrollDelta, _phase: TouchPhase, context: &mut EventContext<'_>, ) -> EventHandling

A mouse wheel event has been sent to this widget. Returns whether the event has been handled or not.

fn summarize(&self, fmt: &mut Formatter<'_>) -> Result

Writes a summary of this widget into fmt.

fn full_control_redraw(&self) -> bool

Returns true if this widget handles all built-in style components that apply.

fn mounted(&mut self, context: &mut EventContext<'_>)

The widget has been mounted into a parent widget.

fn unmounted(&mut self, context: &mut EventContext<'_>)

The widget has been removed from its parent widget.

fn unhover(&mut self, context: &mut EventContext<'_>)

The widget is no longer being hovered.

fn allow_blur(&mut self, context: &mut EventContext<'_>) -> bool

The widget is about to lose focus. Returning true allows the focus to switch away from this widget.

fn activate(&mut self, context: &mut EventContext<'_>)

The widget has become the active widget.

fn deactivate(&mut self, context: &mut EventContext<'_>)

The widget is no longer active.

fn ime(&mut self, ime: Ime, context: &mut EventContext<'_>) -> EventHandling

An input manager event has been sent to this widget. Returns whether the event has been handled or not.

fn root_behavior( &mut self, context: &mut EventContext<'_>, ) -> Option<(RootBehavior, WidgetInstance)>

Returns a reference to a single child widget if this widget is a widget that primarily wraps a single other widget to customize its behavior.