terminput 0.5.14

TUI input parser/encoder and abstraction over input backends
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

use crate::{Event, KeyModifiers};

/// A mouse event.
#[derive(Debug, PartialOrd, PartialEq, Eq, Clone, Copy, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct MouseEvent {
    /// The kind of mouse event that was caused.
    pub kind: MouseEventKind,
    /// The column that the event occurred on.
    pub column: u16,
    /// The row that the event occurred on.
    pub row: u16,
    /// The key modifiers active when the event occurred.
    pub modifiers: KeyModifiers,
}

/// Mouse scroll direction.
#[derive(Debug, PartialOrd, PartialEq, Eq, Clone, Copy, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum ScrollDirection {
    /// Scrolled mouse wheel upwards (away from the user).
    Up,
    /// Scrolled mouse wheel downwards (towards the user).
    Down,
    /// Scrolled mouse wheel left (usually on a laptop touchpad).
    Left,
    /// Scrolled mouse wheel right (usually on a laptop touchpad).
    Right,
}

impl ScrollDirection {
    /// Convenience method for applying a change in the vertical or horizontal direction in response
    /// to a scroll event.
    pub fn delta(&self) -> ScrollDelta {
        match self {
            Self::Up => ScrollDelta { x: 0, y: 1 },
            Self::Down => ScrollDelta { x: 0, y: -1 },
            Self::Left => ScrollDelta { x: 1, y: 0 },
            Self::Right => ScrollDelta { x: -1, y: 0 },
        }
    }
}

/// Represents the change that should be applied to the content in response to a scroll event.
#[derive(Debug, PartialOrd, PartialEq, Eq, Clone, Copy, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct ScrollDelta {
    /// Change in the x (horizontal) direction.
    pub x: i32,
    /// Change in the y (vertical) direction.
    pub y: i32,
}

/// The type of mouse event.
#[derive(Debug, PartialOrd, PartialEq, Eq, Clone, Copy, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum MouseEventKind {
    /// Pressed mouse button. Contains the button that was pressed.
    Down(MouseButton),
    /// Released mouse button. Contains the button that was released.
    Up(MouseButton),
    /// Moved the mouse cursor while pressing the contained mouse button.
    Drag(MouseButton),
    /// Moved the mouse cursor while not pressing a mouse button.
    Moved,
    /// Scrolled mouse wheel downwards (towards the user).
    Scroll(ScrollDirection),
}

/// The mouse button used for this event.
#[derive(Debug, PartialOrd, PartialEq, Eq, Clone, Copy, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum MouseButton {
    /// Left mouse button.
    Left,
    /// Right mouse button.
    Right,
    /// Middle mouse button.
    Middle,
    /// Mouse button could not be determined.
    Unknown,
}

impl From<MouseEvent> for Event {
    fn from(value: MouseEvent) -> Self {
        Self::Mouse(value)
    }
}