Struct MouseArea

pub struct MouseArea<'a, Message, Theme = Theme, Renderer = Renderer> { /* private fields */ }

Emit messages on mouse events.

Implementations

impl<'a, Message, Theme, Renderer> MouseArea<'a, Message, Theme, Renderer>

pub fn on_drag( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit when a drag is initiated.

pub fn on_press( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit on a left button press.

pub fn on_double_press( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit on a left double button press.

pub fn on_release( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit on a left button release.

pub fn on_double_click( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit on a double click.

If you use this with on_press/on_release, those event will be emit as normal.

The events stream will be: on_press -> on_release -> on_press -> on_double_click -> on_release -> on_press …

pub fn on_right_press( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit on a right button press.

pub fn on_right_release( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit on a right button release.

pub fn on_middle_press( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit on a middle button press.

pub fn on_middle_release( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit on a middle button release.

pub fn on_scroll( self, on_scroll: impl Fn(ScrollDelta) -> Message + 'a, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit when scroll wheel is used

pub fn on_enter( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit when the mouse enters the area.

pub fn on_move( self, on_move: impl Fn(Point) -> Message + 'a, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit when the mouse moves in the area.

pub fn on_exit( self, message: Message, ) -> MouseArea<'a, Message, Theme, Renderer>

The message to emit when the mouse exits the area.

pub fn interaction( self, interaction: Interaction, ) -> MouseArea<'a, Message, Theme, Renderer>

The mouse::Interaction to use when hovering the area.

impl<'a, Message, Theme, Renderer> MouseArea<'a, Message, Theme, Renderer>

pub fn new( content: impl Into<Element<'a, Message, Theme, Renderer>>, ) -> MouseArea<'a, Message, Theme, Renderer>

Creates a MouseArea with the given content.

Trait Implementations

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

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

fn from( area: MouseArea<'a, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

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

where Renderer: Renderer, Message: Clone,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

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

Returns the state Tree of the children of the Widget.

fn diff(&mut self, tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout(&self, tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn operate( &self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle, ) -> Status

Processes a runtime Event.

fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

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

Draws the Widget using the associated Renderer.

fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'_>, renderer: &Renderer, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

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

fn drag_destinations( &self, state: &Tree, layout: Layout<'_>, renderer: &Renderer, dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.

fn a11y_nodes( &self, layout: Layout<'_>, state: &Tree, cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget and its children

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, _id: Id)

Sets the id of the widget This may be called while diffing the widget tree