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

cosmic/widget/context_drawer/
widget.rs
