zsui 0.3.0-alpha.2

Rust-first feature-gated native UI framework for Win32, AppKit, and Linux.
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
144
145
146
147
148
149
150
151

use crate::{
    command_protocol::UiCommand,
    geometry::{Point, Size},
};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ComponentPhase {
    New,
    Mounted,
    Active,
    Suspended,
    Unmounted,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LifecycleEvent {
    Mount,
    Resume,
    Suspend,
    Unmount,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct LifecycleState {
    phase: ComponentPhase,
}

impl LifecycleState {
    pub const fn new() -> Self {
        Self {
            phase: ComponentPhase::New,
        }
    }

    pub const fn phase(self) -> ComponentPhase {
        self.phase
    }

    pub fn apply(&mut self, event: LifecycleEvent) -> bool {
        let next = match (self.phase, event) {
            (ComponentPhase::New, LifecycleEvent::Mount) => ComponentPhase::Mounted,
            (ComponentPhase::Mounted | ComponentPhase::Suspended, LifecycleEvent::Resume) => {
                ComponentPhase::Active
            }
            (ComponentPhase::Active, LifecycleEvent::Suspend) => ComponentPhase::Suspended,
            (
                ComponentPhase::Mounted | ComponentPhase::Active | ComponentPhase::Suspended,
                LifecycleEvent::Unmount,
            ) => ComponentPhase::Unmounted,
            _ => return false,
        };
        self.phase = next;
        true
    }
}

impl Default for LifecycleState {
    fn default() -> Self {
        Self::new()
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum MouseButton {
    Left,
    Right,
    Middle,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum KeyState {
    Down,
    Up,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum UiEvent<AppEvent = crate::AppEvent> {
    Application(AppEvent),
    Lifecycle(LifecycleEvent),
    PointerMove {
        position: Point,
    },
    PointerHover {
        position: Point,
    },
    PointerLeave,
    PointerCancel,
    PointerButton {
        position: Point,
        button: MouseButton,
        pressed: bool,
        click_count: u8,
    },
    MouseWheel {
        delta: i32,
    },
    Key {
        code: u32,
        state: KeyState,
        system: bool,
    },
    TextInput(String),
    Command(UiCommand),
    ControlCommand {
        control_id: u32,
        notification: u16,
    },
    ControlSelectionChanged {
        control_id: u32,
        index: usize,
    },
    GlobalHotkey {
        id: i32,
    },
    ClipboardChanged,
    Timer {
        id: u64,
    },
    WindowSize {
        size: Size,
        minimized: bool,
    },
    AppActivationChanged {
        active: bool,
    },
    SystemMetricsChanged,
    WindowMoved,
    WindowMoveCompleted,
    CloseRequested,
    ThemeChanged,
    DpiChanged {
        dpi: u32,
    },
}

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

    #[test]
    fn lifecycle_rejects_out_of_order_transitions() {
        let mut lifecycle = LifecycleState::new();
        assert!(!lifecycle.apply(LifecycleEvent::Resume));
        assert!(lifecycle.apply(LifecycleEvent::Mount));
        assert!(lifecycle.apply(LifecycleEvent::Resume));
        assert_eq!(lifecycle.phase(), ComponentPhase::Active);
        assert!(lifecycle.apply(LifecycleEvent::Suspend));
        assert!(lifecycle.apply(LifecycleEvent::Unmount));
        assert!(!lifecycle.apply(LifecycleEvent::Resume));
    }
}