Struct cosmic::iced::widget::Slider

pub struct Slider<'a, T, Message, Theme = Theme>
where
    Theme: Catalog,
{ /* 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

use iced::widget::slider;

struct State {
   value: f32,
}

#[derive(Debug, Clone)]
enum Message {
    ValueChanged(f32),
}

fn view(state: &State) -> Element<'_, Message> {
    slider(0.0..=100.0, state.value, Message::ValueChanged).into()
}

fn update(state: &mut State, message: Message) {
    match message {
        Message::ValueChanged(value) => {
            state.value = value;
        }
    }
}

Implementations

impl<'a, T, Message, Theme> Slider<'a, T, Message, Theme>

where T: Copy + From<u8> + PartialOrd, Message: Clone, Theme: Catalog,

pub const DEFAULT_HEIGHT: f32 = 16f32

The default height of a Slider.

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

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 default(self, default: impl Into<T>) -> Slider<'a, T, Message, Theme>

Sets the optional default value for the Slider.

If set, the Slider will reset to this value when ctrl-clicked or command-clicked.

pub fn breakpoints(self, breakpoints: &'a [T]) -> Slider<'a, T, Message, Theme>

Defines breakpoints to visibly mark on the slider.

The slider will gravitate towards a breakpoint when near it.

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

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: impl Into<Length>) -> Slider<'a, T, Message, Theme>

Sets the width of the Slider.

pub fn height(self, height: impl Into<Pixels>) -> Slider<'a, T, Message, Theme>

Sets the height of the Slider.

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

Sets the step size of the Slider.

pub fn shift_step( self, shift_step: impl Into<T>, ) -> Slider<'a, T, Message, Theme>

Sets the optional “shift” step for the Slider.

If set, this value is used as the step while the shift key is pressed.

pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> Slider<'a, T, Message, Theme>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme, Status) -> Style + 'a>>,

Sets the style of the Slider.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> Slider<'a, T, Message, Theme>

Sets the style class of the Slider.

pub fn name( self, name: impl Into<Cow<'a, str>>, ) -> Slider<'a, T, Message, Theme>

Sets the name of the Slider.

pub fn description_widget( self, description: &impl Describes, ) -> Slider<'a, T, Message, Theme>

Sets the description of the Slider.

pub fn description( self, description: impl Into<Cow<'a, str>>, ) -> Slider<'a, T, Message, Theme>

Sets the description of the Slider.

pub fn label(self, label: &dyn Labels) -> Slider<'a, T, Message, Theme>

Sets the label of the Slider.

Trait Implementations

impl<'a, T, Message, Theme, Renderer> From<Slider<'a, T, Message, Theme>> for Element<'a, Message, Theme, Renderer>

where T: Copy + Into<f64> + FromPrimitive + 'a, Message: Clone + 'a, Theme: Catalog + 'a, Renderer: Renderer + 'a,

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

Converts to this type from the input type.

impl<'a, T, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Slider<'a, T, Message, Theme>

where T: Copy + Into<f64> + FromPrimitive, Message: Clone, Theme: Catalog, Renderer: Renderer,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout( &self, _tree: &mut Tree, _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: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) -> Status

Processes a runtime Event.

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

Draws the Widget using the associated Renderer.

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

Returns the current mouse::Interaction of the Widget.

fn a11y_nodes( &self, layout: Layout<'_>, _state: &Tree, cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget and its children

fn id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, id: Id)

Sets the id of the widget This may be called while diffing the widget tree

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

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

Returns the state Tree of the children of the Widget.

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

Reconciliates the Widget with the provided Tree.

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

Applies an Operation to the Widget.

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

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

fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.