Rename MouseListener to MouseArea

This commit is contained in:
Héctor Ramón Jiménez 2023-04-13 06:46:33 +02:00
parent 6b359b496c
commit f55a97b738
No known key found for this signature in database
GPG key ID: 140CC052C94F138E
4 changed files with 20 additions and 20 deletions

View file

@ -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)]

View file

@ -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<Element<'a, Message, Renderer>>,
) -> widget::MouseListener<'a, Message, Renderer>
) -> widget::MouseArea<'a, Message, Renderer>
where
Renderer: crate::Renderer,
{
widget::MouseListener::new(widget)
widget::MouseArea::new(widget)
}

View file

@ -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<Message>,
on_release: Option<Message>,
@ -25,7 +25,7 @@ pub struct MouseListener<'a, Message, Renderer> {
on_mouse_exit: Option<Message>,
}
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<Element<'a, Message, Renderer>>) -> 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<Message, Renderer>
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<MouseListener<'a, Message, Renderer>>
impl<'a, Message, Renderer> From<MouseArea<'a, Message, Renderer>>
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<Message: Clone, Renderer>(
widget: &mut MouseListener<'_, Message, Renderer>,
widget: &mut MouseArea<'_, Message, Renderer>,
event: &Event,
layout: Layout<'_>,
cursor_position: Point,

View file

@ -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 {