//! A container for capturing mouse events. use crate::core::event::{self, Event}; use crate::core::layout; use crate::core::mouse; use crate::core::overlay; use crate::core::renderer; use crate::core::touch; use crate::core::widget::{tree, Operation, Tree}; use crate::core::{ Clipboard, Element, Layout, Length, Rectangle, Shell, Widget, }; /// Emit messages on mouse events. #[allow(missing_debug_implementations)] pub struct MouseArea<'a, Message, Renderer> { content: Element<'a, Message, Renderer>, on_press: Option, on_release: Option, on_right_press: Option, on_right_release: Option, on_middle_press: Option, on_middle_release: Option, } impl<'a, Message, Renderer> MouseArea<'a, Message, Renderer> { /// The message to emit on a left button press. #[must_use] pub fn on_press(mut self, message: Message) -> Self { self.on_press = Some(message); self } /// The message to emit on a left button release. #[must_use] pub fn on_release(mut self, message: Message) -> Self { self.on_release = Some(message); self } /// The message to emit on a right button press. #[must_use] pub fn on_right_press(mut self, message: Message) -> Self { self.on_right_press = Some(message); self } /// The message to emit on a right button release. #[must_use] pub fn on_right_release(mut self, message: Message) -> Self { self.on_right_release = Some(message); self } /// The message to emit on a middle button press. #[must_use] pub fn on_middle_press(mut self, message: Message) -> Self { self.on_middle_press = Some(message); self } /// The message to emit on a middle button release. #[must_use] pub fn on_middle_release(mut self, message: Message) -> Self { self.on_middle_release = Some(message); self } } /// Local state of the [`MouseArea`]. #[derive(Default)] struct State { // TODO: Support on_mouse_enter and on_mouse_exit } impl<'a, Message, Renderer> MouseArea<'a, Message, Renderer> { /// Creates a [`MouseArea`] with the given content. pub fn new(content: impl Into>) -> Self { MouseArea { content: content.into(), on_press: None, on_release: None, on_right_press: None, on_right_release: None, on_middle_press: None, on_middle_release: None, } } } impl<'a, Message, Renderer> Widget for MouseArea<'a, Message, Renderer> where Renderer: renderer::Renderer, Message: Clone, { fn tag(&self) -> tree::Tag { tree::Tag::of::() } fn state(&self) -> tree::State { tree::State::new(State::default()) } fn children(&self) -> Vec { vec![Tree::new(&self.content)] } fn diff(&self, tree: &mut Tree) { tree.diff_children(std::slice::from_ref(&self.content)); } fn width(&self) -> Length { self.content.as_widget().width() } fn height(&self) -> Length { self.content.as_widget().height() } fn layout( &self, tree: &mut Tree, renderer: &Renderer, limits: &layout::Limits, ) -> layout::Node { self.content .as_widget() .layout(&mut tree.children[0], renderer, limits) } fn operate( &self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, ) { self.content.as_widget().operate( &mut tree.children[0], layout, renderer, operation, ); } fn on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: mouse::Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, viewport: &Rectangle, ) -> event::Status { if let event::Status::Captured = self.content.as_widget_mut().on_event( &mut tree.children[0], event.clone(), layout, cursor, renderer, clipboard, shell, viewport, ) { return event::Status::Captured; } update(self, &event, layout, cursor, shell) } fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: mouse::Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> mouse::Interaction { self.content.as_widget().mouse_interaction( &tree.children[0], layout, cursor, viewport, renderer, ) } fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Renderer::Theme, renderer_style: &renderer::Style, layout: Layout<'_>, cursor: mouse::Cursor, viewport: &Rectangle, ) { self.content.as_widget().draw( &tree.children[0], renderer, theme, renderer_style, layout, cursor, viewport, ); } fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'_>, renderer: &Renderer, ) -> Option> { self.content.as_widget_mut().overlay( &mut tree.children[0], layout, renderer, ) } } impl<'a, Message, Renderer> From> for Element<'a, Message, Renderer> where Message: 'a + Clone, Renderer: 'a + renderer::Renderer, { fn from( area: MouseArea<'a, Message, Renderer>, ) -> Element<'a, Message, Renderer> { Element::new(area) } } /// Processes the given [`Event`] and updates the [`State`] of an [`MouseArea`] /// accordingly. fn update( widget: &mut MouseArea<'_, Message, Renderer>, event: &Event, layout: Layout<'_>, cursor: mouse::Cursor, shell: &mut Shell<'_, Message>, ) -> event::Status { if !cursor.is_over(layout.bounds()) { return event::Status::Ignored; } if let Some(message) = widget.on_press.as_ref() { if let Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)) | Event::Touch(touch::Event::FingerPressed { .. }) = event { shell.publish(message.clone()); return event::Status::Captured; } } if let Some(message) = widget.on_release.as_ref() { if let Event::Mouse(mouse::Event::ButtonReleased(mouse::Button::Left)) | Event::Touch(touch::Event::FingerLifted { .. }) = event { shell.publish(message.clone()); return event::Status::Captured; } } if let Some(message) = widget.on_right_press.as_ref() { if let Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Right)) = event { shell.publish(message.clone()); return event::Status::Captured; } } if let Some(message) = widget.on_right_release.as_ref() { if let Event::Mouse(mouse::Event::ButtonReleased( mouse::Button::Right, )) = event { shell.publish(message.clone()); return event::Status::Captured; } } if let Some(message) = widget.on_middle_press.as_ref() { if let Event::Mouse(mouse::Event::ButtonPressed( mouse::Button::Middle, )) = event { shell.publish(message.clone()); return event::Status::Captured; } } if let Some(message) = widget.on_middle_release.as_ref() { if let Event::Mouse(mouse::Event::ButtonReleased( mouse::Button::Middle, )) = event { shell.publish(message.clone()); return event::Status::Captured; } } event::Status::Ignored }