faststep 0.1.0

UIKit-inspired embedded UI framework built on embedded-graphics
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

use crate::Localized;

/// Semantic alert kind.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum AlertKind {
    /// Error or destructive feedback.
    Error,
    /// Warning feedback.
    Warning,
    /// Confirmation dialog.
    Confirm,
}

/// Semantic role for one alert action button.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum AlertButtonRole {
    /// Primary action.
    Primary,
    /// Secondary action.
    Secondary,
    /// Destructive action.
    Destructive,
}

/// One alert action definition.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct AlertAction<'a> {
    /// Action identifier returned by touch handling.
    pub id: u8,
    /// Localized action label.
    pub label: Localized<'a>,
    /// Semantic button role.
    pub role: AlertButtonRole,
}

/// Complete alert specification for a fixed number of actions.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct AlertSpec<'a, const N: usize> {
    /// Semantic alert kind.
    pub kind: AlertKind,
    /// Localized title.
    pub title: Localized<'a>,
    /// Localized message body.
    pub message: Localized<'a>,
    /// Action definitions displayed in the alert.
    pub actions: [AlertAction<'a>; N],
}

impl<'a> AlertSpec<'a, 1> {
    /// Creates a one-button error alert.
    pub const fn error(message: Localized<'a>) -> Self {
        Self {
            kind: AlertKind::Error,
            title: Localized::new("fs.alert.error", "Error"),
            message,
            actions: [AlertAction {
                id: 0,
                label: Localized::new("fs.alert.ok", "OK"),
                role: AlertButtonRole::Destructive,
            }],
        }
    }

    /// Creates a one-button warning alert.
    pub const fn warning(message: Localized<'a>) -> Self {
        Self {
            kind: AlertKind::Warning,
            title: Localized::new("fs.alert.warning", "Warning"),
            message,
            actions: [AlertAction {
                id: 0,
                label: Localized::new("fs.alert.ok", "OK"),
                role: AlertButtonRole::Primary,
            }],
        }
    }
}

impl<'a> AlertSpec<'a, 2> {
    /// Creates a two-button confirmation alert.
    pub const fn confirm(title: Localized<'a>, message: Localized<'a>) -> Self {
        Self {
            kind: AlertKind::Confirm,
            title,
            message,
            actions: [
                AlertAction {
                    id: 0,
                    label: Localized::new("fs.alert.cancel", "Cancel"),
                    role: AlertButtonRole::Secondary,
                },
                AlertAction {
                    id: 1,
                    label: Localized::new("fs.alert.confirm", "Confirm"),
                    role: AlertButtonRole::Primary,
                },
            ],
        }
    }
}