iced_core/overlay/
group.rs

1use crate::layout;
2use crate::mouse;
3use crate::overlay;
4use crate::renderer;
5use crate::widget;
6use crate::{Clipboard, Event, Layout, Overlay, Shell, Size};
7
8/// An [`Overlay`] container that displays multiple overlay [`overlay::Element`]
9/// children.
10pub struct Group<'a, Message, Theme, Renderer> {
11    children: Vec<overlay::Element<'a, Message, Theme, Renderer>>,
12}
13
14impl<'a, Message, Theme, Renderer> Group<'a, Message, Theme, Renderer>
15where
16    Message: 'a,
17    Theme: 'a,
18    Renderer: 'a + crate::Renderer,
19{
20    /// Creates an empty [`Group`].
21    pub fn new() -> Self {
22        Self::default()
23    }
24
25    /// Creates a [`Group`] with the given elements.
26    pub fn with_children(
27        mut children: Vec<overlay::Element<'a, Message, Theme, Renderer>>,
28    ) -> Self {
29        use std::cmp;
30
31        children.sort_unstable_by(|a, b| {
32            a.as_overlay()
33                .index()
34                .partial_cmp(&b.as_overlay().index())
35                .unwrap_or(cmp::Ordering::Equal)
36        });
37
38        Group { children }
39    }
40
41    /// Turns the [`Group`] into an overlay [`overlay::Element`].
42    pub fn overlay(self) -> overlay::Element<'a, Message, Theme, Renderer> {
43        overlay::Element::new(Box::new(self))
44    }
45}
46
47impl<'a, Message, Theme, Renderer> Default
48    for Group<'a, Message, Theme, Renderer>
49where
50    Message: 'a,
51    Theme: 'a,
52    Renderer: 'a + crate::Renderer,
53{
54    fn default() -> Self {
55        Self::with_children(Vec::new())
56    }
57}
58
59impl<Message, Theme, Renderer> Overlay<Message, Theme, Renderer>
60    for Group<'_, Message, Theme, Renderer>
61where
62    Renderer: crate::Renderer,
63{
64    fn layout(&mut self, renderer: &Renderer, bounds: Size) -> layout::Node {
65        layout::Node::with_children(
66            bounds,
67            self.children
68                .iter_mut()
69                .map(|child| child.as_overlay_mut().layout(renderer, bounds))
70                .collect(),
71        )
72    }
73
74    fn update(
75        &mut self,
76        event: &Event,
77        layout: Layout<'_>,
78        cursor: mouse::Cursor,
79        renderer: &Renderer,
80        clipboard: &mut dyn Clipboard,
81        shell: &mut Shell<'_, Message>,
82    ) {
83        for (child, layout) in self.children.iter_mut().zip(layout.children()) {
84            child
85                .as_overlay_mut()
86                .update(event, layout, cursor, renderer, clipboard, shell);
87        }
88    }
89
90    fn draw(
91        &self,
92        renderer: &mut Renderer,
93        theme: &Theme,
94        style: &renderer::Style,
95        layout: Layout<'_>,
96        cursor: mouse::Cursor,
97    ) {
98        for (child, layout) in self.children.iter().zip(layout.children()) {
99            child
100                .as_overlay()
101                .draw(renderer, theme, style, layout, cursor);
102        }
103    }
104
105    fn mouse_interaction(
106        &self,
107        layout: Layout<'_>,
108        cursor: mouse::Cursor,
109        renderer: &Renderer,
110    ) -> mouse::Interaction {
111        self.children
112            .iter()
113            .zip(layout.children())
114            .map(|(child, layout)| {
115                child
116                    .as_overlay()
117                    .mouse_interaction(layout, cursor, renderer)
118            })
119            .max()
120            .unwrap_or_default()
121    }
122
123    fn operate(
124        &mut self,
125        layout: Layout<'_>,
126        renderer: &Renderer,
127        operation: &mut dyn widget::Operation,
128    ) {
129        operation.traverse(&mut |operation| {
130            self.children.iter_mut().zip(layout.children()).for_each(
131                |(child, layout)| {
132                    child.as_overlay_mut().operate(layout, renderer, operation);
133                },
134            );
135        });
136    }
137
138    fn overlay<'a>(
139        &'a mut self,
140        layout: Layout<'a>,
141        renderer: &Renderer,
142    ) -> Option<overlay::Element<'a, Message, Theme, Renderer>> {
143        let children = self
144            .children
145            .iter_mut()
146            .zip(layout.children())
147            .filter_map(|(child, layout)| {
148                child.as_overlay_mut().overlay(layout, renderer)
149            })
150            .collect::<Vec<_>>();
151
152        (!children.is_empty()).then(|| Group::with_children(children).overlay())
153    }
154
155    fn index(&self) -> f32 {
156        self.children
157            .first()
158            .map(|child| child.as_overlay().index())
159            .unwrap_or(1.0)
160    }
161}
162
163impl<'a, Message, Theme, Renderer> From<Group<'a, Message, Theme, Renderer>>
164    for overlay::Element<'a, Message, Theme, Renderer>
165where
166    Message: 'a,
167    Theme: 'a,
168    Renderer: 'a + crate::Renderer,
169{
170    fn from(group: Group<'a, Message, Theme, Renderer>) -> Self {
171        group.overlay()
172    }
173}
iced_core/overlay/group.rs

iced_core/overlay/
group.rs
