termrs_core 0.3.0

The core library of termrs
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

use std::marker::PhantomData;

use super::Clipboard;

use crate::render::Position;

pub trait EventContext<Message> {
    /// Forces the widget to be rerendered.
    fn invalidate_render(&mut self);

    /// Forces the widget's layout to be recalculated
    /// and so the widget to be rerendered.
    fn invalidate_layout(&mut self);

    /// Emits the message for application to handle.
    fn emit_message(&mut self, message: Message);

    /// Returns reference to the clipboard.
    fn clipboard(&self) -> &dyn Clipboard;

    /// Returns mutable reference to the clipboard.
    fn clipboard_mut(&mut self) -> &mut dyn Clipboard;

    /// Gets position of the cursor
    /// in global cooridnates.
    fn cursor_position(&self) -> Position;

    /// Sets position of the cursor
    /// in global coordinates.
    ///
    /// There is only one cursor per terminal, but
    /// any widget in the tree can move it, so be careful.
    fn set_cursor_position(&mut self, value: Position);

    /// Returns keyboard focus state of this widget.
    ///
    /// When a widget has keyboard focus
    /// all key event routed to it.
    fn keyboard_focus(&self) -> bool;

    /// Sets the keyboard focus.
    fn set_keyboard_focus(&mut self, value: bool);

    /// Gets value indicating whether this widget
    /// captures mouse or not.
    ///
    /// When widget has mouse focus
    /// all mouse events roted to it.
    fn mouse_focus(&self) -> bool;

    /// Sets the mouse focus.
    fn set_mouse_focus(&mut self, value: bool);
}

pub struct WrappedEventContext<'a, Message, E>
where
    E: EventContext<Message> + ?Sized,
{
    context: &'a mut E,
    phantom_message: PhantomData<Message>,

    mouse_focus: bool,
    keyboard_focus: bool,
}

impl<'a, Message, E> WrappedEventContext<'a, Message, E>
where
    E: EventContext<Message> + ?Sized,
{
    pub fn new(context: &'a mut E, mouse_focus: bool, keyboard_focus: bool) -> Self {
        Self {
            context,
            phantom_message: PhantomData,
            mouse_focus,
            keyboard_focus,
        }
    }
}

impl<'a, Message, E> EventContext<Message> for WrappedEventContext<'a, Message, E>
where
    E: EventContext<Message> + ?Sized,
{
    fn invalidate_render(&mut self) {
        self.context.invalidate_render()
    }

    fn invalidate_layout(&mut self) {
        self.context.invalidate_layout()
    }

    fn emit_message(&mut self, message: Message) {
        self.context.emit_message(message)
    }

    fn cursor_position(&self) -> Position {
        self.context.cursor_position()
    }

    fn set_cursor_position(&mut self, value: Position) {
        self.context.set_cursor_position(value)
    }

    fn keyboard_focus(&self) -> bool {
        self.keyboard_focus
    }

    fn set_keyboard_focus(&mut self, value: bool) {
        self.keyboard_focus = value;
    }

    fn mouse_focus(&self) -> bool {
        self.mouse_focus
    }

    fn set_mouse_focus(&mut self, value: bool) {
        self.mouse_focus = value;
    }

    fn clipboard(&self) -> &dyn Clipboard {
        self.context.clipboard()
    }

    fn clipboard_mut(&mut self) -> &mut dyn Clipboard {
        self.context.clipboard_mut()
    }
}