popout 0.1.1

Small and simple modal popups powered by egui
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

//! Contains utilities for creating dialog boxes

use egui::RichText;
use winit::{
    dpi::Size,
    window::{Icon, WindowAttributes},
};

use crate::create_window;

/// A rich text line for display in a [`Dialog`]
#[derive(Default, Debug)]
pub struct DialogLine {
    line: Vec<RichText>,
}

impl DialogLine {
    /// Create a new [`DialogLine`]
    pub fn new() -> Self {
        Self::default()
    }
    /// Add a new piece of rich text to the dialog line
    pub fn with(mut self, txt: impl Into<RichText>) -> Self {
        self.line.push(txt.into());
        self
    }
}

/// A dialog box with text and buttons
#[derive(Default, Debug)]
pub struct Dialog {
    texts: Vec<Vec<RichText>>,
    buttons: Vec<RichText>,
    attrs: WindowAttributes,
}

impl Dialog {
    /// Create a new [`Dialog`]
    ///
    /// Call [`Dialog::show`] to display it
    pub fn new() -> Self {
        Self::default()
    }
    /// Set the title of the dialog
    pub fn with_title(mut self, title: impl Into<String>) -> Self {
        self.attrs.title = title.into();
        self
    }

    /// Set the window attributes of the [`Dialog`] directly
    pub fn with_window_attributes(mut self, attrs: WindowAttributes) -> Self {
        self.attrs = attrs;
        self
    }

    /// Get the window attributes of the [`Dialog`]
    pub fn window_attributes(&self) -> &WindowAttributes {
        &self.attrs
    }

    /// Add a line to the [`Dialog`] that may contain nested [`RichText`]
    pub fn with_rich_line(mut self, line: DialogLine) -> Self {
        self.texts.push(line.line);
        self
    }

    /// Add a single [`RichText`] as a full line
    pub fn with_line(mut self, line: impl Into<RichText>) -> Self {
        self.texts.push(vec![line.into()]);
        self
    }
    /// Add a button
    ///
    /// # Ordering
    /// Note that ordering does matter here, as the returned value from [`Dialog::show`] will be an index
    /// of the buttons
    pub fn with_button(mut self, btn: impl Into<RichText>) -> Self {
        self.buttons.push(btn.into());
        self
    }
    /// Set the minimum size for the dialog window
    pub fn with_min_size(mut self, sz: impl Into<Size>) -> Self {
        self.attrs.min_inner_size = Some(sz.into());
        self
    }

    /// Set the initial size for the dialog window
    pub fn with_size(mut self, sz: impl Into<Size>) -> Self {
        self.attrs.inner_size = Some(sz.into());
        self
    }

    /// Set the max size for the dialog window
    pub fn with_max_size(mut self, sz: impl Into<Size>) -> Self {
        self.attrs.max_inner_size = Some(sz.into());
        self
    }
    /// Set whether decorations are enabled on the window (platform dependent)
    pub fn with_decorations(mut self, decorations: bool) -> Self {
        self.attrs.decorations = decorations;
        self
    }

    /// Set the window icon
    pub fn with_window_icon(mut self, icon: Option<Icon>) -> Self {
        self.attrs.window_icon = icon;
        self
    }

    /// Set whether the window can be resized
    pub fn with_resizeable(mut self, resizeable: bool) -> Self {
        self.attrs.resizable = resizeable;
        self
    }

    /// Display the dialog box
    ///
    /// The returned value is the index of the clicked button, or None if the user closed the window
    /// without selecting anything
    pub fn show(self) -> Result<Option<usize>, crate::Error> {
        create_window(
            |ui| {
                for line in &self.texts {
                    ui.horizontal(|ui| {
                        for txt in line {
                            ui.label(txt.clone());
                        }
                    });
                }
                ui.horizontal(|ui| {
                    for (i, btn) in self.buttons.iter().enumerate() {
                        if ui.button(btn.clone()).clicked() {
                            return Some(i);
                        }
                    }
                    None
                })
                .inner
            },
            self.attrs,
        )
    }
}