From f55a97b738096d85086858026234ee95dcd79289 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9ctor=20Ram=C3=B3n=20Jim=C3=A9nez?= Date: Thu, 13 Apr 2023 06:46:33 +0200 Subject: [PATCH] Rename `MouseListener` to `MouseArea` --- native/src/widget.rs | 4 ++-- native/src/widget/helpers.rs | 6 ++--- .../{mouse_listener.rs => mouse_area.rs} | 24 +++++++++---------- src/widget.rs | 6 ++--- 4 files changed, 20 insertions(+), 20 deletions(-) rename native/src/widget/{mouse_listener.rs => mouse_area.rs} (93%) diff --git a/native/src/widget.rs b/native/src/widget.rs index 4eb3d1ba..6849da17 100644 --- a/native/src/widget.rs +++ b/native/src/widget.rs @@ -17,7 +17,7 @@ pub mod column; pub mod container; pub mod helpers; pub mod image; -pub mod mouse_listener; +pub mod mouse_area; pub mod operation; pub mod pane_grid; pub mod pick_list; @@ -52,7 +52,7 @@ pub use helpers::*; #[doc(no_inline)] pub use image::Image; #[doc(no_inline)] -pub use mouse_listener::MouseListener; +pub use mouse_area::MouseArea; #[doc(no_inline)] pub use pane_grid::PaneGrid; #[doc(no_inline)] diff --git a/native/src/widget/helpers.rs b/native/src/widget/helpers.rs index 88986d60..5f44e22c 100644 --- a/native/src/widget/helpers.rs +++ b/native/src/widget/helpers.rs @@ -316,11 +316,11 @@ where } /// A container intercepting mouse events. -pub fn mouse_listener<'a, Message, Renderer>( +pub fn mouse_area<'a, Message, Renderer>( widget: impl Into>, -) -> widget::MouseListener<'a, Message, Renderer> +) -> widget::MouseArea<'a, Message, Renderer> where Renderer: crate::Renderer, { - widget::MouseListener::new(widget) + widget::MouseArea::new(widget) } diff --git a/native/src/widget/mouse_listener.rs b/native/src/widget/mouse_area.rs similarity index 93% rename from native/src/widget/mouse_listener.rs rename to native/src/widget/mouse_area.rs index 00e20c04..1b8b318c 100644 --- a/native/src/widget/mouse_listener.rs +++ b/native/src/widget/mouse_area.rs @@ -13,7 +13,7 @@ use crate::{ /// Emit messages on mouse events. #[allow(missing_debug_implementations)] -pub struct MouseListener<'a, Message, Renderer> { +pub struct MouseArea<'a, Message, Renderer> { content: Element<'a, Message, Renderer>, on_press: Option, on_release: Option, @@ -25,7 +25,7 @@ pub struct MouseListener<'a, Message, Renderer> { on_mouse_exit: Option, } -impl<'a, Message, Renderer> MouseListener<'a, Message, Renderer> { +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 { @@ -83,16 +83,16 @@ impl<'a, Message, Renderer> MouseListener<'a, Message, Renderer> { } } -/// Local state of the [`MouseListener`]. +/// Local state of the [`MouseArea`]. #[derive(Default)] struct State { is_hovered: bool, } -impl<'a, Message, Renderer> MouseListener<'a, Message, Renderer> { - /// Creates an empty [`MouseListener`]. +impl<'a, Message, Renderer> MouseArea<'a, Message, Renderer> { + /// Creates an empty [`MouseArea`]. pub fn new(content: impl Into>) -> Self { - MouseListener { + MouseArea { content: content.into(), on_press: None, on_release: None, @@ -107,7 +107,7 @@ impl<'a, Message, Renderer> MouseListener<'a, Message, Renderer> { } impl<'a, Message, Renderer> Widget - for MouseListener<'a, Message, Renderer> + for MouseArea<'a, Message, Renderer> where Renderer: crate::Renderer, Message: Clone, @@ -243,23 +243,23 @@ where } } -impl<'a, Message, Renderer> From> +impl<'a, Message, Renderer> From> for Element<'a, Message, Renderer> where Message: 'a + Clone, Renderer: 'a + crate::Renderer, { fn from( - listener: MouseListener<'a, Message, Renderer>, + area: MouseArea<'a, Message, Renderer>, ) -> Element<'a, Message, Renderer> { - Element::new(listener) + Element::new(area) } } -/// Processes the given [`Event`] and updates the [`State`] of an [`MouseListener`] +/// Processes the given [`Event`] and updates the [`State`] of an [`MouseArea`] /// accordingly. fn update( - widget: &mut MouseListener<'_, Message, Renderer>, + widget: &mut MouseArea<'_, Message, Renderer>, event: &Event, layout: Layout<'_>, cursor_position: Point, diff --git a/src/widget.rs b/src/widget.rs index 15b34ffa..d06fdafb 100644 --- a/src/widget.rs +++ b/src/widget.rs @@ -47,12 +47,12 @@ pub mod container { iced_native::widget::Container<'a, Message, Renderer>; } -pub mod mouse_listener { +pub mod mouse_area { //! Intercept mouse events on a widget. /// A container intercepting mouse events. - pub type MouseListener<'a, Message, Renderer = crate::Renderer> = - iced_native::widget::MouseListener<'a, Message, Renderer>; + pub type MouseArea<'a, Message, Renderer = crate::Renderer> = + iced_native::widget::MouseArea<'a, Message, Renderer>; } pub mod pane_grid {