summaryrefslogtreecommitdiffstats
path: root/pure/src/overlay.rs
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-05-02 20:16:00 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-05-02 20:16:00 +0200
commite7d595c7de3854e165fd68f05ab2292cae69dbc4 (patch)
tree4d91f993a65f7547aa9a777760af25562dbfb9dd /pure/src/overlay.rs
parent68e9eb0a9b45b86713ce5d0e9c2273a60f2cc11c (diff)
downloadiced-e7d595c7de3854e165fd68f05ab2292cae69dbc4.tar.gz
iced-e7d595c7de3854e165fd68f05ab2292cae69dbc4.tar.bz2
iced-e7d595c7de3854e165fd68f05ab2292cae69dbc4.zip
Write documentation for `iced_pure`
Diffstat (limited to 'pure/src/overlay.rs')
-rw-r--r--pure/src/overlay.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/pure/src/overlay.rs b/pure/src/overlay.rs
index c87dfce8..fecaa2ac 100644
--- a/pure/src/overlay.rs
+++ b/pure/src/overlay.rs
@@ -1,9 +1,14 @@
+//! Display interactive elements on top of other widgets.
use crate::widget::Tree;
use iced_native::Layout;
pub use iced_native::overlay::*;
+/// Obtains the first overlay [`Element`] found in the given children.
+///
+/// This method will generally only be used by advanced users that are
+/// implementing the [`Widget`](crate::Widget) trait.
pub fn from_children<'a, Message, Renderer>(
children: &'a [crate::Element<'_, Message, Renderer>],
tree: &'a mut Tree,