Struct iced::widget::Slider

pub struct Slider<'a, T, Message, Renderer>where
    Renderer: Renderer,
    <Renderer as Renderer>::Theme: StyleSheet,{ /* private fields */ }

An horizontal bar and a handle that selects a single value from a range of values.

A Slider will try to fill the horizontal space of its container.

The Slider range of numeric values is generic and its step size defaults to 1 unit.

Example

#[derive(Clone)]
pub enum Message {
    SliderChanged(f32),
}

let value = 50.0;

Slider::new(0.0..=100.0, value, Message::SliderChanged);

Implementations

impl<'a, T, Message, Renderer> Slider<'a, T, Message, Renderer>where
    T: Copy + From<u8> + PartialOrd<T>,
    Message: Clone,
    Renderer: Renderer,
    <Renderer as Renderer>::Theme: StyleSheet,

pub const DEFAULT_HEIGHT: u16 = 22u16

The default height of a Slider.

pub fn new<F>(
    range: RangeInclusive<T>,
    value: T,
    on_change: F
) -> Slider<'a, T, Message, Renderer>where
    F: 'a + Fn(T) -> Message,

Creates a new Slider.

It expects:

• an inclusive range of possible values
• the current value of the Slider
• a function that will be called when the Slider is dragged. It receives the new value of the Slider and must produce a Message.

pub fn on_release(self, on_release: Message) -> Slider<'a, T, Message, Renderer>

Sets the release message of the Slider. This is called when the mouse is released from the slider.

Typically, the user’s interaction with the slider is finished when this message is produced. This is useful if you need to spawn a long-running task from the slider’s result, where the default on_change message could create too many events.

pub fn width(self, width: Length) -> Slider<'a, T, Message, Renderer>

Sets the width of the Slider.

pub fn height(self, height: u16) -> Slider<'a, T, Message, Renderer>

Sets the height of the Slider.

pub fn style(
    self,
    style: impl Into<<<Renderer as Renderer>::Theme as StyleSheet>::Style>
) -> Slider<'a, T, Message, Renderer>

Sets the style of the Slider.

pub fn step(self, step: T) -> Slider<'a, T, Message, Renderer>

Sets the step size of the Slider.

Trait Implementations

impl<'a, T, Message, Renderer> Widget<Message, Renderer> for Slider<'a, T, Message, Renderer>where
    T: Copy + Into<f64> + FromPrimitive,
    Message: Clone,
    Renderer: Renderer,
    <Renderer as Renderer>::Theme: StyleSheet,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, _renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn on_event(
    &mut self,
    tree: &mut Tree,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    _renderer: &Renderer,
    _clipboard: &mut dyn Clipboard,
    shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn draw(
    &self,
    tree: &Tree,
    renderer: &mut Renderer,
    theme: &<Renderer as Renderer>::Theme,
    _style: &Style,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle<f32>
)

Draws the Widget using the associated Renderer.

fn mouse_interaction(
    &self,
    tree: &Tree,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle<f32>,
    _renderer: &Renderer
) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn children(&self) -> Vec<Tree, Global>

Returns the state Tree of the children of the Widget.

fn diff(&self, _tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn operate(
    &self,
    _state: &mut Tree,
    _layout: Layout<'_>,
    _operation: &mut dyn Operation<Message>
)

Applies an Operation to the Widget.

fn overlay<'a>(
    &'a self,
    _state: &'a mut Tree,
    _layout: Layout<'_>,
    _renderer: &Renderer
) -> Option<Element<'a, Message, Renderer>>

Returns the overlay of the Widget, if there is any.