Struct XYPad 

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

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, Theme> XYPad<'a, Message, Theme>

where Theme: StyleSheet,

pub fn new( param_x: Option<impl Into<NormalParam>>, param_y: Option<impl Into<NormalParam>>, ) -> Self

where <Theme as StyleSheet>::Style: Default,

Creates a new XYPad.

It expects:

• the NormalParams for the x & y axis of the XYPad

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

Sets the message to emit when the user gestures the X axis of this widget.

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

Sets the message to emit when the user gestures the Y axis of this widget.

pub const fn enabled(self, enabled: bool) -> Self

Enable/disable this widget.

The default is true.

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

Sets the size of the XYPad.

pub fn style(self, style: impl Into<<Theme as StyleSheet>::Style>) -> Self

Sets the style of the XYPad.

Trait Implementations

impl<'a, Message, Theme, Renderer> From<XYPad<'a, Message, Theme>> for Element<'a, Message, Theme, Renderer>

where Message: 'a, Theme: 'a + StyleSheet, Renderer: Renderer,

fn from(xy_pad: XYPad<'a, Message, Theme>) -> Self

Converts to this type from the input type.

impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for XYPad<'a, Message, Theme>

where Theme: StyleSheet, 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( &mut self, _tree: &mut Tree, _renderer: &Renderer, limits: &Limits, ) -> Node

Returns the layout::Node of the Widget.

fn update( &mut self, tree: &mut Tree, event: &Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, )

Processes a runtime Event.

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

Draws the Widget using the associated Renderer.

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(&self, tree: &mut Tree)

Reconciles the Widget with the provided Tree.

fn operate( &mut self, _tree: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn mouse_interaction( &self, _tree: &Tree, _layout: Layout<'_>, _cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn overlay<'a>( &'a mut self, _tree: &'a mut Tree, _layout: Layout<'a>, _renderer: &Renderer, _viewport: &Rectangle, _translation: Vector, ) -> Option<Element<'a, Message, Theme, Renderer>>

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