summaryrefslogtreecommitdiffstats
path: root/native/src/overlay.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2023-01-24 01:59:34 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2023-01-24 01:59:34 +0100
commit01c484245be54c1aeb6605659fb0f222856c28da (patch)
treee9b101cb188d03b6473324e293efb75a3434f4bf /native/src/overlay.rs
parentbe860508a9deed1f4583e045790eb9ddd74d07d5 (diff)
downloadiced-01c484245be54c1aeb6605659fb0f222856c28da.tar.gz
iced-01c484245be54c1aeb6605659fb0f222856c28da.tar.bz2
iced-01c484245be54c1aeb6605659fb0f222856c28da.zip
Fix some minor documentation inconsistencies
Diffstat (limited to 'native/src/overlay.rs')
-rw-r--r--native/src/overlay.rs5
1 files changed, 4 insertions, 1 deletions
diff --git a/native/src/overlay.rs b/native/src/overlay.rs
index 1c3d0fb9..6cada416 100644
--- a/native/src/overlay.rs
+++ b/native/src/overlay.rs
@@ -90,7 +90,10 @@ where
mouse::Interaction::Idle
}
- /// Returns true if the cursor is over the [`Overlay`]
+ /// Returns true if the cursor is over the [`Overlay`].
+ ///
+ /// By default, it returns true if the bounds of the `layout` contain
+ /// the `cursor_position`.
fn is_over(&self, layout: Layout<'_>, cursor_position: Point) -> bool {
layout.bounds().contains(cursor_position)
}