r3bl_tui 0.1.2

TUI library inspired by Redux, Redux, Flexbox, CSS, editor components, etc
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

/*
 *   Copyright (c) 2022 R3BL LLC
 *   All rights reserved.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

use serde::{Deserialize, Serialize};

/// Crossterm docs:
/// - [`KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES`](https://docs.rs/crossterm/0.25.0/crossterm/event/struct.KeyboardEnhancementFlags.html)
/// - [`PushKeyboardEnhancementFlags`](https://docs.rs/crossterm/0.25.0/crossterm/event/struct.KeyboardEnhancementFlags.html)
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize, Copy)]
pub enum Enhanced {
  /// **Note:** this key can only be read if `KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES`
  /// has been enabled with `PushKeyboardEnhancementFlags`.
  MediaKey(MediaKey),
  /// **Note:** this key can only be read if `KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES`
  /// has been enabled with `PushKeyboardEnhancementFlags`.
  SpecialKeyExt(SpecialKeyExt),
  /// **Note:** these keys can only be read if **both**
  /// `KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES` and
  /// `KeyboardEnhancementFlags::REPORT_ALL_KEYS_AS_ESCAPE_CODES` have been enabled with
  /// `PushKeyboardEnhancementFlags`.
  ModifierKeyEnum(ModifierKeyEnum),
}

/// Crossterm docs:
/// - [`KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES`](https://docs.rs/crossterm/0.25.0/crossterm/event/struct.KeyboardEnhancementFlags.html)
/// - [`PushKeyboardEnhancementFlags`](https://docs.rs/crossterm/0.25.0/crossterm/event/struct.KeyboardEnhancementFlags.html)
///
/// **Note:** these keys can only be read if **both**
/// `KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES` and
/// `KeyboardEnhancementFlags::REPORT_ALL_KEYS_AS_ESCAPE_CODES` have been enabled with
/// `PushKeyboardEnhancementFlags`.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize, Copy)]
pub enum ModifierKeyEnum {
  /// Left Shift key.
  LeftShift,
  /// Left Control key.
  LeftControl,
  /// Left Alt key.
  LeftAlt,
  /// Left Super key.
  LeftSuper,
  /// Left Hyper key.
  LeftHyper,
  /// Left Meta key.
  LeftMeta,
  /// Right Shift key.
  RightShift,
  /// Right Control key.
  RightControl,
  /// Right Alt key.
  RightAlt,
  /// Right Super key.
  RightSuper,
  /// Right Hyper key.
  RightHyper,
  /// Right Meta key.
  RightMeta,
  /// Iso Level3 Shift key.
  IsoLevel3Shift,
  /// Iso Level5 Shift key.
  IsoLevel5Shift,
}

/// Crossterm docs:
/// - [`KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES`](https://docs.rs/crossterm/0.25.0/crossterm/event/struct.KeyboardEnhancementFlags.html)
/// - [`PushKeyboardEnhancementFlags`](https://docs.rs/crossterm/0.25.0/crossterm/event/struct.KeyboardEnhancementFlags.html)
///
/// **Note:** this key can only be read if `KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES` has
/// been enabled with `PushKeyboardEnhancementFlags`.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize, Copy)]
pub enum SpecialKeyExt {
  CapsLock,
  ScrollLock,
  NumLock,
  PrintScreen,
  Pause,
  Menu,
  KeypadBegin,
}

/// Crossterm docs:
/// - [`KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES`](https://docs.rs/crossterm/0.25.0/crossterm/event/struct.KeyboardEnhancementFlags.html)
/// - [`PushKeyboardEnhancementFlags`](https://docs.rs/crossterm/0.25.0/crossterm/event/struct.KeyboardEnhancementFlags.html)
///
/// **Note:** this key can only be read if
/// `KeyboardEnhancementFlags::DISAMBIGUATE_ESCAPE_CODES` has been enabled with
/// `PushKeyboardEnhancementFlags`.
#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize, Copy)]
pub enum MediaKey {
  Play,
  Pause,
  PlayPause,
  Reverse,
  Stop,
  FastForward,
  Rewind,
  TrackNext,
  TrackPrevious,
  Record,
  LowerVolume,
  RaiseVolume,
  MuteVolume,
}