Struct iced_audio::native::mod_range_input::ModRangeInput

pub struct ModRangeInput<'a, Message, Renderer>where
    Renderer: Renderer,
    Renderer::Theme: StyleSheet,{ /* private fields */ }

An interactive dot that controls an NormalParam

Implementations

impl<'a, Message, Renderer> ModRangeInput<'a, Message, Renderer>where Renderer: Renderer, Renderer::Theme: StyleSheet,

pub fn new<F>(normal_param: NormalParam, on_change: F) -> Selfwhere F: 'a + Fn(Normal) -> Message,

Creates a new ModRangeInput.

It expects:

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

pub fn on_grab(self, on_grab: impl 'a + FnMut() -> Option<Message>) -> Self

Sets the grab message of the ModRangeInput. This is called when the mouse grabs from the mod range input.

Typically, the user’s interaction with the mod range input starts when this message is produced. This is useful for some environments so that external changes, such as automation, don’t interfer with user’s changes.

pub fn on_release( self, on_release: impl 'a + FnMut() -> Option<Message> ) -> Self

Sets the release message of the ModRangeInput. This is called when the mouse is released from the mod range input.

Typically, the user’s interaction with the mod range input is finished when this message is produced. This is useful if you need to spawn a long-running task from the mod range input’s result, where the default on_change message could create too many events.

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

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

pub fn style( self, style: impl Into<<Renderer::Theme as StyleSheet>::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> From<ModRangeInput<'a, Message, Renderer>> for Element<'a, Message, Renderer>where Message: 'a, Renderer: 'a + Renderer, Renderer::Theme: 'a + StyleSheet,

fn from( mod_range_input: ModRangeInput<'a, Message, Renderer> ) -> Element<'a, Message, Renderer>

Converts to this type from the input type.

impl<'a, Message, Renderer> Widget<Message, Renderer> for ModRangeInput<'a, Message, Renderer>where Renderer: Renderer, Renderer::Theme: StyleSheet,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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 layout::Node of the Widget.

fn on_event( &mut self, state: &mut Tree, event: Event, layout: Layout<'_>, cursor_position: Point, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message> ) -> Status

Processes a runtime Event.

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

Draws the Widget using the associated Renderer.

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

Returns the state Tree of the children of the Widget.

fn diff(&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<Message> )

Applies an Operation to the Widget.

fn mouse_interaction( &self, _state: &Tree, _layout: Layout<'_>, _cursor_position: Point, _viewport: &Rectangle<f32>, _renderer: &Renderer ) -> Interaction

Returns the current mouse::Interaction of the Widget.

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

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