Struct iced_native::widget::slider::Slider

pub struct Slider<'a, T, Message, Renderer: Renderer> { /* fields omitted */ }

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

pub enum Message {
    SliderChanged(f32),
}

let state = &mut slider::State::new();
let value = 50.0;

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

Implementations

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

pub fn new<F>(
    state: &'a mut State,
    range: RangeInclusive<T>,
    value: T,
    on_change: F
) -> Self where
    F: 'static + Fn(T) -> Message, 

Creates a new Slider.

It expects:

• the local State of the Slider
• 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) -> Self

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) -> Self

Sets the width of the Slider.

pub fn height(self, height: u16) -> Self

Sets the height of the Slider.

pub fn style(self, style: impl Into<Renderer::Style>) -> Self

Sets the style of the Slider.

pub fn step(self, step: T) -> Self

Sets the step size of the Slider.

Trait Implementations

impl<'a, T, Message, Renderer> From<Slider<'a, T, Message, Renderer>> for Element<'a, Message, Renderer> where
    T: 'a + Copy + Into<f64> + FromPrimitive,
    Renderer: 'a + Renderer,
    Message: 'a + Clone, 

fn from(
    slider: Slider<'a, T, Message, Renderer>
) -> Element<'a, Message, Renderer>

Performs the conversion.

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

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 [Node] of the [Widget].

fn on_event(
    &mut self,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    messages: &mut Vec<Message>,
    _renderer: &Renderer,
    _clipboard: Option<&dyn Clipboard>
)

Processes a runtime [Event].

fn draw(
    &self,
    renderer: &mut Renderer,
    _defaults: &Renderer::Defaults,
    layout: Layout<'_>,
    cursor_position: Point
) -> Renderer::Output

Draws the [Widget] using the associated Renderer.

fn hash_layout(&self, state: &mut Hasher)

Computes the layout hash of the [Widget].

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

Returns the overlay of the [Element], if there is any.