cosmic/widget/context_drawer/
widget.rs

1// Copyright 2023 System76 <info@system76.com>
2// SPDX-License-Identifier: MPL-2.0
3
4use super::overlay::Overlay;
5use crate::widget::{self, LayerContainer, button, column, container, icon, row, scrollable, text};
6use crate::{Apply, Element, Renderer, Theme, fl};
7use std::borrow::Cow;
8
9use iced_core::Alignment;
10use iced_core::event::{self, Event};
11use iced_core::widget::{Operation, Tree};
12use iced_core::{
13    Clipboard, Layout, Length, Rectangle, Shell, Vector, Widget, layout, mouse,
14    overlay as iced_overlay, renderer,
15};
16
17#[must_use]
18pub struct ContextDrawer<'a, Message> {
19    id: Option<iced_core::widget::Id>,
20    content: Element<'a, Message>,
21    drawer: Element<'a, Message>,
22    on_close: Option<Message>,
23}
24
25impl<'a, Message: Clone + 'static> ContextDrawer<'a, Message> {
26    pub fn new_inner<Drawer>(
27        title: Option<Cow<'a, str>>,
28        actions: Option<Element<'a, Message>>,
29        header: Option<Element<'a, Message>>,
30        footer: Option<Element<'a, Message>>,
31        drawer: Drawer,
32        on_close: Message,
33        max_width: f32,
34    ) -> Element<'a, Message>
35    where
36        Drawer: Into<Element<'a, Message>>,
37    {
38        #[inline(never)]
39        fn inner<'a, Message: Clone + 'static>(
40            title: Option<Cow<'a, str>>,
41            actions_opt: Option<Element<'a, Message>>,
42            header_opt: Option<Element<'a, Message>>,
43            footer_opt: Option<Element<'a, Message>>,
44            drawer: Element<'a, Message>,
45            on_close: Message,
46            max_width: f32,
47        ) -> Element<'a, Message> {
48            let cosmic_theme::Spacing {
49                space_xxs,
50                space_s,
51                space_m,
52                space_l,
53                ..
54            } = crate::theme::spacing();
55
56            let horizontal_padding = if max_width < 392.0 { space_s } else { space_l };
57
58            let (actions_slot, column_title) = if let Some(actions) = actions_opt {
59                let actions = actions
60                    .apply(container)
61                    .width(Length::Fill)
62                    .apply(Element::from);
63                let title = title.map(|title| text::title4(title).width(Length::Fill));
64                (actions, title)
65            } else {
66                let title = title
67                    .map(|title| text::title4(title).width(Length::Fill).apply(Element::from))
68                    .unwrap_or_else(|| widget::horizontal_space().apply(Element::from));
69                (title, None)
70            };
71
72            let header_row = row::with_capacity(2).push(actions_slot).push(
73                button::text(fl!("close"))
74                    .trailing_icon(icon::from_name("go-next-symbolic"))
75                    .on_press(on_close),
76            );
77            let header = column::with_capacity(3)
78                .align_x(Alignment::Center)
79                .padding([space_m, horizontal_padding])
80                .spacing(space_m)
81                .push(header_row)
82                .push_maybe(column_title)
83                .push_maybe(header_opt);
84            let footer = footer_opt.map(|element| {
85                container(element)
86                    .align_y(Alignment::Center)
87                    .padding([space_xxs, horizontal_padding])
88            });
89            let pane = column::with_capacity(3)
90                .push(header)
91                .push(
92                    container(drawer)
93                        .padding([
94                            0,
95                            horizontal_padding,
96                            if footer.is_some() { 0 } else { space_l },
97                            horizontal_padding,
98                        ])
99                        .apply(scrollable)
100                        .height(Length::Fill),
101                )
102                .push_maybe(footer);
103
104            // XXX new limits do not exactly handle the max width well for containers
105            // XXX this is a hack to get around that
106            container(
107                LayerContainer::new(pane)
108                    .layer(cosmic_theme::Layer::Primary)
109                    .class(crate::style::Container::ContextDrawer)
110                    .width(Length::Fill)
111                    .height(Length::Fill)
112                    .max_width(max_width),
113            )
114            .width(Length::Fill)
115            .height(Length::Fill)
116            .align_x(Alignment::End)
117            .into()
118        }
119
120        inner(
121            title,
122            actions,
123            header,
124            footer,
125            drawer.into(),
126            on_close,
127            max_width,
128        )
129    }
130
131    /// Creates an empty [`ContextDrawer`].
132    pub fn new<Content, Drawer>(
133        title: Option<Cow<'a, str>>,
134        actions: Option<Element<'a, Message>>,
135        header: Option<Element<'a, Message>>,
136        footer: Option<Element<'a, Message>>,
137        content: Content,
138        drawer: Drawer,
139        on_close: Message,
140        max_width: f32,
141    ) -> Self
142    where
143        Content: Into<Element<'a, Message>>,
144        Drawer: Into<Element<'a, Message>>,
145    {
146        let drawer = Self::new_inner(title, actions, header, footer, drawer, on_close, max_width);
147
148        ContextDrawer {
149            id: None,
150            content: content.into(),
151            drawer,
152            on_close: None,
153        }
154    }
155
156    /// Sets the [`Id`] of the [`ContextDrawer`].
157    #[inline]
158    pub fn id(mut self, id: iced_core::widget::Id) -> Self {
159        self.id = Some(id);
160        self
161    }
162
163    /// Map the message type of the context drawer to another
164    #[inline]
165    pub fn map<Out: Clone + 'static>(
166        self,
167        on_message: fn(Message) -> Out,
168    ) -> ContextDrawer<'a, Out> {
169        ContextDrawer {
170            id: self.id,
171            content: self.content.map(on_message),
172            drawer: self.drawer.map(on_message),
173            on_close: self.on_close.map(on_message),
174        }
175    }
176
177    /// Optionally assigns message to `on_close` event.
178    #[inline]
179    pub fn on_close_maybe(mut self, message: Option<Message>) -> Self {
180        self.on_close = message;
181        self
182    }
183}
184
185impl<Message: Clone> Widget<Message, crate::Theme, Renderer> for ContextDrawer<'_, Message> {
186    fn children(&self) -> Vec<Tree> {
187        vec![Tree::new(&self.content), Tree::new(&self.drawer)]
188    }
189
190    fn diff(&mut self, tree: &mut Tree) {
191        tree.diff_children(&mut [&mut self.content, &mut self.drawer]);
192    }
193
194    fn size(&self) -> iced_core::Size<Length> {
195        self.content.as_widget().size()
196    }
197
198    fn layout(
199        &self,
200        tree: &mut Tree,
201        renderer: &Renderer,
202        limits: &layout::Limits,
203    ) -> layout::Node {
204        self.content
205            .as_widget()
206            .layout(&mut tree.children[0], renderer, limits)
207    }
208
209    fn operate(
210        &self,
211        tree: &mut Tree,
212        layout: Layout<'_>,
213        renderer: &Renderer,
214        operation: &mut dyn Operation<()>,
215    ) {
216        self.content
217            .as_widget()
218            .operate(&mut tree.children[0], layout, renderer, operation);
219    }
220
221    fn on_event(
222        &mut self,
223        tree: &mut Tree,
224        event: Event,
225        layout: Layout<'_>,
226        cursor: mouse::Cursor,
227        renderer: &Renderer,
228        clipboard: &mut dyn Clipboard,
229        shell: &mut Shell<'_, Message>,
230        viewport: &Rectangle,
231    ) -> event::Status {
232        self.content.as_widget_mut().on_event(
233            &mut tree.children[0],
234            event,
235            layout,
236            cursor,
237            renderer,
238            clipboard,
239            shell,
240            viewport,
241        )
242    }
243
244    fn mouse_interaction(
245        &self,
246        tree: &Tree,
247        layout: Layout<'_>,
248        cursor: mouse::Cursor,
249        viewport: &Rectangle,
250        renderer: &Renderer,
251    ) -> mouse::Interaction {
252        self.content.as_widget().mouse_interaction(
253            &tree.children[0],
254            layout,
255            cursor,
256            viewport,
257            renderer,
258        )
259    }
260
261    fn draw(
262        &self,
263        tree: &Tree,
264        renderer: &mut Renderer,
265        theme: &Theme,
266        renderer_style: &renderer::Style,
267        layout: Layout<'_>,
268        cursor: mouse::Cursor,
269        viewport: &Rectangle,
270    ) {
271        self.content.as_widget().draw(
272            &tree.children[0],
273            renderer,
274            theme,
275            renderer_style,
276            layout,
277            cursor,
278            viewport,
279        );
280    }
281
282    fn overlay<'b>(
283        &'b mut self,
284        tree: &'b mut Tree,
285        layout: Layout<'_>,
286        _renderer: &Renderer,
287        translation: Vector,
288    ) -> Option<iced_overlay::Element<'b, Message, crate::Theme, Renderer>> {
289        let bounds = layout.bounds();
290
291        let mut position = layout.position();
292        position.x += translation.x;
293        position.y += translation.y;
294
295        Some(iced_overlay::Element::new(Box::new(Overlay {
296            content: &mut self.drawer,
297            tree: &mut tree.children[1],
298            width: bounds.width,
299            position,
300        })))
301    }
302
303    #[cfg(feature = "a11y")]
304    /// get the a11y nodes for the widget
305    fn a11y_nodes(
306        &self,
307        layout: Layout<'_>,
308        state: &Tree,
309        p: mouse::Cursor,
310    ) -> iced_accessibility::A11yTree {
311        let c_state = &state.children[0];
312        self.content.as_widget().a11y_nodes(layout, c_state, p)
313    }
314
315    fn drag_destinations(
316        &self,
317        state: &Tree,
318        layout: Layout<'_>,
319        renderer: &Renderer,
320        dnd_rectangles: &mut iced_core::clipboard::DndDestinationRectangles,
321    ) {
322        self.content.as_widget().drag_destinations(
323            &state.children[0],
324            layout,
325            renderer,
326            dnd_rectangles,
327        );
328    }
329
330    fn id(&self) -> Option<iced_core::widget::Id> {
331        self.id.clone()
332    }
333
334    fn set_id(&mut self, id: iced_core::widget::Id) {
335        self.id = Some(id);
336    }
337}
338
339impl<'a, Message: 'a + Clone> From<ContextDrawer<'a, Message>> for Element<'a, Message> {
340    fn from(widget: ContextDrawer<'a, Message>) -> Element<'a, Message> {
341        Element::new(widget)
342    }
343}
cosmic/widget/context_drawer/widget.rs

cosmic/widget/context_drawer/
widget.rs
