Struct iced_audio::native::v_slider::VSlider

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

A vertical slider GUI widget that controls a NormalParam

a VSlider will try to fill the vertical space of its container.

Implementations

impl<'a, Message, Renderer: Renderer> VSlider<'a, Message, Renderer>

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

Creates a new VSlider.

It expects:

• the local State of the VSlider
• a function that will be called when the VSlider is dragged.

pub fn width(self, width: Length) -> Self

Sets the width of the VSlider. The default width is Length::Units(14).

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

Sets the height of the VSlider. The default height is Length::Fill.

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

Sets the style of the VSlider.

pub fn modifier_keys(self, modifier_keys: Modifiers) -> Self

Sets the modifier keys of the VSlider.

The default modifier key is Ctrl.

pub fn scalar(self, scalar: f32) -> Self

Sets the scalar to use when the user drags the slider per pixel.

For example, a scalar of 0.5 will cause the slider to move half a pixel for every pixel the mouse moves.

The default scalar is 0.9575.

pub fn wheel_scalar(self, wheel_scalar: f32) -> Self

Sets how much the Normal value will change for the VSlider per line scrolled by the mouse wheel.

This can be set to 0.0 to disable the scroll wheel from moving the parameter.

The default value is 0.01

pub fn modifier_scalar(self, scalar: f32) -> Self

Sets the scalar to use when the user drags the slider while holding down the modifier key.

For example, a scalar of 0.5 will cause the slider to move half a pixel for every pixel the mouse moves.

The default scalar is 0.02, and the default modifier key is Ctrl.

pub fn tick_marks(self, tick_marks: &'a Group) -> Self

Sets the tick marks to display. Note your StyleSheet must also implement tick_marks_style(&self) -> Option<tick_marks::Style> for them to display (which the default style does).

pub fn text_marks(self, text_marks: &'a Group) -> Self

Sets the text marks to display. Note your StyleSheet must also implement text_marks_style(&self) -> Option<text_marks::Style> for them to display (which the default style does).

pub fn mod_range(self, mod_range: &'a ModulationRange) -> Self

Sets a ModulationRange to display. Note your StyleSheet must also implement mod_range_style(&self) -> Option<ModRangeStyle> for them to display.

pub fn mod_range_2(self, mod_range: &'a ModulationRange) -> Self

Sets a second ModulationRange to display. Note your StyleSheet must also implement mod_range_style_2(&self) -> Option<ModRangeStyle> for them to display.

Trait Implementations

impl<'a, Message, Renderer> Widget<Message, Renderer> for VSlider<'a, Message, Renderer> where
    Renderer: Renderer, 

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,
    _renderer: &Renderer,
    _clipboard: &mut dyn Clipboard,
    messages: &mut Vec<Message>
) -> Status

Processes a runtime Event.

fn draw(
    &self,
    renderer: &mut Renderer,
    _defaults: &Renderer::Defaults,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle
) -> 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 Widget, if there is any.