me/iced
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix some minor documentation inconsistencies

Browse source
This commit is contained in:
Héctor Ramón Jiménez 2023-01-24 01:59:34 +01:00
parent be860508a9
commit 01c484245b
No known key found for this signature in database
GPG key ID: 140CC052C94F138E
3 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

5
native/src/overlay.rs
View file

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

2
native/src/overlay/element.rs
View file

@ -116,7 +116,7 @@ where
self.overlay.operate(layout, renderer, operation);
}
/// Returns true if the cursor is over the [`Element`]
/// Returns true if the cursor is over the [`Element`].
pub fn is_over(&self, layout: Layout<'_>, cursor_position: Point) -> bool {
self.overlay.is_over(layout, cursor_position)
}

6
native/src/overlay/group.rs
View file

@ -8,8 +8,8 @@ use crate::renderer;
use crate::widget;
use crate::{Clipboard, Event, Layout, Overlay, Shell};
/// An [`Overlay`] container that displays multiple overlay
/// [`overlay::Element`] children
/// An [`Overlay`] container that displays multiple overlay [`overlay::Element`]
/// children.
#[allow(missing_debug_implementations)]
pub struct Group<'a, Message, Renderer> {
children: Vec<overlay::Element<'a, Message, Renderer>>,
@ -41,7 +41,7 @@ where
self
}
/// Turns the [`Group`] into an overlay [`overlay::Element`]
/// Turns the [`Group`] into an overlay [`overlay::Element`].
pub fn overlay(self) -> overlay::Element<'a, Message, Renderer> {
overlay::Element::new(Point::ORIGIN, Box::new(self))
}