Struct cosmic::widget::VerticalSlider

pub struct VerticalSlider<'a, T, Message, Theme = Theme>
where
    Theme: Catalog,
{ /* private fields */ }

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

A VerticalSlider will try to fill the vertical space of its container.

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

Example

use iced::widget::vertical_slider;

struct State {
   value: f32,
}

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

fn view(state: &State) -> Element<'_, Message> {
    vertical_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> VerticalSlider<'a, T, Message, Theme>

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

pub const DEFAULT_WIDTH: f32 = 16f32

The default width of a VerticalSlider.

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

where F: 'a + Fn(T) -> Message,

Creates a new VerticalSlider.

It expects:

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

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

Sets the optional default value for the VerticalSlider.

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

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

Sets the release message of the VerticalSlider. 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<Pixels>, ) -> VerticalSlider<'a, T, Message, Theme>

Sets the width of the VerticalSlider.

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

Sets the height of the VerticalSlider.

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

Sets the step size of the VerticalSlider.

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

Sets the optional “shift” step for the VerticalSlider.

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, ) -> VerticalSlider<'a, T, Message, Theme>

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

Sets the style of the VerticalSlider.

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

Sets the style class of the VerticalSlider.

Trait Implementations

impl<'a, T, Message, Theme, Renderer> From<VerticalSlider<'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: VerticalSlider<'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 VerticalSlider<'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 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 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 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.