gpui-kit 0.8.0

GPUI Kit: one dependency for building desktop applications with GPUI, GPUI Base, GPUI Component and default assets.
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

//! Individual native input steps for gestures spanning several UI updates.
use super::TestWindowExt;
use crate::{
    App, InputEvent, KeyDownEvent, KeyUpEvent, Keystroke, Modifiers, ModifiersChangedEvent,
    MouseButton, MouseDownEvent, MouseMoveEvent, MouseUpEvent, Pixels, Point, Window,
};

/// Dispatches individual native events, completing a frame after each step.
/// Pointer events retain the window's current modifiers. Keyboard events do not
/// insert IME text; use `TestWindowExt::input` for text entry. Parsed key
/// modifiers combine with the currently held modifiers without changing them.
pub trait TestEventExt {
    /// Moves the pointer, optionally with a mouse button held.
    fn pointer_move(
        &mut self,
        position: Point<Pixels>,
        pressed_button: Option<MouseButton>,
        cx: &mut App,
    );
    /// Presses a mouse button at a window-local position.
    fn pointer_down(&mut self, position: Point<Pixels>, button: MouseButton, cx: &mut App);
    /// Releases a mouse button at a window-local position.
    fn pointer_up(&mut self, position: Point<Pixels>, button: MouseButton, cx: &mut App);
    /// Changes keyboard modifiers while preserving caps lock.
    fn change_modifiers(&mut self, modifiers: Modifiers, cx: &mut App);
    /// Dispatches a parsed key-down; `is_held` marks an auto-repeat event.
    fn key_down(&mut self, key: &str, is_held: bool, cx: &mut App);
    /// Dispatches a parsed key-up, independently of the preceding key-down.
    fn key_up(&mut self, key: &str, cx: &mut App);
}

fn parse_key(key: &str) -> Keystroke {
    Keystroke::parse(key).unwrap_or_else(|error| panic!("invalid test keystroke: {error}"))
}

impl TestEventExt for Window {
    fn pointer_move(
        &mut self,
        position: Point<Pixels>,
        pressed_button: Option<MouseButton>,
        cx: &mut App,
    ) {
        self.render_frame(cx);
        self.dispatch_event(
            MouseMoveEvent {
                position,
                pressed_button,
                modifiers: self.modifiers(),
            }
            .to_platform_input(),
            cx,
        );
        self.render_frame(cx);
    }
    fn pointer_down(&mut self, position: Point<Pixels>, button: MouseButton, cx: &mut App) {
        self.render_frame(cx);
        self.dispatch_event(
            MouseDownEvent {
                button,
                position,
                modifiers: self.modifiers(),
                click_count: 1,
                first_mouse: false,
            }
            .to_platform_input(),
            cx,
        );
        self.render_frame(cx);
    }
    fn pointer_up(&mut self, position: Point<Pixels>, button: MouseButton, cx: &mut App) {
        self.render_frame(cx);
        self.dispatch_event(
            MouseUpEvent {
                button,
                position,
                modifiers: self.modifiers(),
                click_count: 1,
            }
            .to_platform_input(),
            cx,
        );
        self.render_frame(cx);
    }
    fn change_modifiers(&mut self, modifiers: Modifiers, cx: &mut App) {
        self.render_frame(cx);
        self.dispatch_event(
            ModifiersChangedEvent {
                modifiers,
                capslock: self.capslock(),
            }
            .to_platform_input(),
            cx,
        );
        self.render_frame(cx);
    }
    fn key_down(&mut self, key: &str, is_held: bool, cx: &mut App) {
        let mut keystroke = parse_key(key);
        self.render_frame(cx);
        keystroke.modifiers |= self.modifiers();
        self.dispatch_event(
            KeyDownEvent {
                keystroke,
                is_held,
                prefer_character_input: false,
            }
            .to_platform_input(),
            cx,
        );
        self.render_frame(cx);
    }
    fn key_up(&mut self, key: &str, cx: &mut App) {
        let mut keystroke = parse_key(key);
        self.render_frame(cx);
        keystroke.modifiers |= self.modifiers();
        self.dispatch_event(KeyUpEvent { keystroke }.to_platform_input(), cx);
        self.render_frame(cx);
    }
}