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

cosmic/widget/context_drawer/
widget.rs
