egelm 0.3.1

A simple message-driven framework for building GUI applications in Rust using egui.
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
144

//! Internal modal used to present queued application errors.

use crate::prelude::*;

#[derive(Debug)]
struct QueuedError {
	summary: String,
	details: Option<String>,
}

#[derive(Default, Debug)]
/// A first-in, first-out queue of errors displayed in a modal dialog.
pub struct ErrorDialog {
	errors: std::collections::VecDeque<QueuedError>,
}

impl ErrorDialog {
	/// Adds an error summary and optional details to the display queue.
	pub fn emit(&mut self, summary: String, details: Option<String>) {
		self.errors.push_back(QueuedError { summary, details });
	}
}

impl LeafWidget for ErrorDialog {
	fn render(&mut self, ui: &mut egui::Ui, _frame: &mut Frame) {
		if self.errors.is_empty() {
			return;
		}

		egui::Modal::new(egui::Id::new("error_dialog")).show(ui, |ui| {
			ui.set_width(460.0);
			ui.set_max_height(520.0);

			ui.vertical_centered(|ui| {
				ui.add_space(12.0);
				ui.add(
					Label::new(
						RichText::new(
							#[cfg(feature = "emoji")]
							emoji("warning"),
							#[cfg(not(feature = "emoji"))]
							"⚠",
						)
						.size(40.0)
						.color(Color32::from_rgb(0xe0, 0x1b, 0x24)),
					)
					.selectable(false),
				);
				ui.add_space(8.0);
				ui.label(RichText::new("An error occurred").size(18.0).strong());
				ui.label(
					RichText::new(if self.errors.len() > 1 {
						format!("1 of {} errors", self.errors.len())
					} else {
						String::new()
					})
					.size(11.5)
					.weak(),
				);
			});

			ui.separator();
			ui.add_space(10.0);

			let summary = self
				.errors
				.front()
				.map(|e| e.summary.as_str())
				.unwrap_or_default();

			egui::Frame::new()
				.fill(ui.visuals().extreme_bg_color)
				.corner_radius(8)
				.inner_margin(12)
				.show(ui, |ui| {
					ui.label(RichText::new(summary).monospace().size(12.5));
				});

			ui.add_space(10.0);

			if let Some(details) = self.errors.front()
				&& let Some(details) = &details.details
			{
				ui.collapsing("Details", |ui| {
					egui::Frame::new()
						.fill(ui.visuals().extreme_bg_color)
						.corner_radius(8)
						.inner_margin(10)
						.show(ui, |ui| {
							ScrollArea::both().show(ui, |ui| {
								ui.add(
									Label::new(RichText::new(details).monospace())
										.wrap_mode(TextWrapMode::Wrap)
										.selectable(false),
								);
							})
						});

					ui.add_space(6.0);
				});

				ui.separator();
			}

			ui.with_layout(Layout::right_to_left(Align::Max), |ui| {
				if ui
					.button(if self.errors.len() > 1 {
						"Dismiss"
					} else {
						"Close"
					})
					.clicked()
				{
					self.errors.pop_front();
				}

				if let Some(details) = self.errors.front().and_then(|e| e.details.clone())
					&& ui.button("Copy Details").clicked()
				{
					ui.copy_text(details);
				}
			});
		});
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn emit_queues_errors_in_fifo_order() {
		let mut dialog = ErrorDialog::default();

		dialog.emit("first".to_owned(), Some("details".to_owned()));
		dialog.emit("second".to_owned(), None);

		assert_eq!(dialog.errors.len(), 2);
		assert_eq!(dialog.errors[0].summary, "first");
		assert_eq!(dialog.errors[0].details.as_deref(), Some("details"));
		assert_eq!(dialog.errors[1].summary, "second");
		assert!(dialog.errors[1].details.is_none());
	}
}