germinal/types

A module containing types in germinal.

Types

Event

Represent any event in terminal.

Currently, this library does not support mouse.

pub type Event {
  FocusGained
  FocusLost
  Key(KeyEvent)
  Paste(String)
  Resize(Int, Int)
}

Constructors

```
FocusGained
```
```
FocusLost
```
```
Key(KeyEvent)
```
```
Paste(String)
```
```
Resize(Int, Int)
```

KeyCode

</>

Key code.

pub type KeyCode {
  Backspace
  Enter
  Left
  Right
  Up
  Down
  Home
  End
  PageUp
  PageDown
  Tab
  BackTab
  Delete
  Insert
  F(Int)
  Char(String)
  Null
  Esc
  CapsLock
  ScrollLock
  NumLock
  PrintScreen
  Pause
  Menu
  KeypadBegin
}

Constructors

```
Backspace
```
```
Enter
```
```
Left
```
```
Right
```
```
Up
```
```
Down
```
```
Home
```
```
End
```
```
PageUp
```
```
PageDown
```
```
Tab
```
```
BackTab
```
```
Delete
```
```
Insert
```
```
F(Int)
```
```
Char(String)
```
```
Null
```
```
Esc
```
```
CapsLock
```
```
ScrollLock
```
```
NumLock
```
```
PrintScreen
```
```
Pause
```
```
Menu
```
```
KeypadBegin
```

KeyEvent

</>

Key event.

pub type KeyEvent

KeyEventKind

</>

The kind of key event.

pub type KeyEventKind {
  Press
  Repeat
  Release
}

Constructors

```
Press
```
```
Repeat
```
```
Release
```

KeyEventState

</>

The state of key event.

pub type KeyEventState

KeyModifiers

</>

pub type KeyModifiers

Functions

alt_modifier

</>

pub fn alt_modifier() -> KeyModifiers

Represent the ALT modifier.

caps_lock_state

</>

pub fn caps_lock_state() -> KeyEventState

Represent the Caps Lock state.

contains_modifiers

</>

pub fn contains_modifiers(
  parent_modifiers: KeyModifiers,
  child_modifiers: KeyModifiers,
) -> Bool

Return True if parent_modifiers contains child_modifiers. Return False if not.

contains_state

</>

pub fn contains_state(
  parent_state: KeyEventState,
  child_state: KeyEventState,
) -> Bool

Return True if parent_state contains child_state. Return False if not.

control_modifier

</>

pub fn control_modifier() -> KeyModifiers

get_key_modifiers

</>

pub fn get_key_modifiers(event: KeyEvent) -> KeyModifiers

Return the key modifiers of the key event.

get_keycode

</>

pub fn get_keycode(event: KeyEvent) -> KeyCode

Return the key code of the key event.

get_keyevent_kind

</>

pub fn get_keyevent_kind(event: KeyEvent) -> KeyEventKind

Return the kind of the key event.

get_keyevent_state

</>

pub fn get_keyevent_state(event: KeyEvent) -> KeyEventState

Return the state of the key event.

keypad_state

</>

pub fn keypad_state() -> KeyEventState

Represent the KeyPad state.

none_modifier

</>

pub fn none_modifier() -> KeyModifiers

Represent no modifier.

none_state

</>

pub fn none_state() -> KeyEventState

Represent no state.

num_lock_state

</>

pub fn num_lock_state() -> KeyEventState

Represent the Num Lock state.

or_modifiers

</>

pub fn or_modifiers(
  modifiers1: KeyModifiers,
  modifiers2: KeyModifiers,
) -> KeyModifiers

Combine two modifiers.

or_state

</>

pub fn or_state(
  state1: KeyEventState,
  state2: KeyEventState,
) -> KeyEventState

Combine two state.

shift_modifier

</>

pub fn shift_modifier() -> KeyModifiers

Represent the SHIFT modifier.