Struct iced_audio::native::mod_range_input::ModRangeInput

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

An interactive dot that controls an NormalParam

Implementations

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

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

Creates a new ModRangeInput.

It expects:

• the local State of the ModRangeInput
• a function that will be called when the ModRangeInput is turned.

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

Sets the diameter of the ModRangeInput. The default size is Length::from(Length::Units(31)).

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

Sets the style of the ModRangeInput.

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

Sets how much the Normal value will change for the ModRangeInput per y pixel movement of the mouse.

The default value is 0.001925

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

Sets how much the Normal value will change for the ModRangeInput 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.005

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

Sets the modifier keys of the ModRangeInput.

The default modifier key is Ctrl.

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

Sets the scalar to use when the user drags the ModRangeInputs while holding down the modifier key. This is multiplied to the value set by ModRangeInput::scalar() (which the default is 0.001925).

For example, a modifier_scalar of 0.5 will cause the ModRangeInput to turn half as fast when the modifier key is down.

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

Trait Implementations

impl<'a, Message, Renderer> Widget<Message, Renderer> for ModRangeInput<'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.