Struct iced_audio::native::xy_pad::XYPad

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

A 2D XY pad GUI widget that controls two NormalParam parameters at once. One in the x coordinate and one in the y coordinate.

an XYPad will try to fill the space of its container while keeping a square aspect ratio.

Implementations

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

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

Creates a new XYPad.

It expects:

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

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

Sets the size of the XYPad.

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

Sets the style of the XYPad.

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

Sets the modifier keys of the XYPad.

The default modifier key is Ctrl.

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.

Trait Implementations

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