moonbit-community/tty/input

README
Tr
Fd
Tr
Reader
Tr
Writer
T
Command
- ::equalCursorPosition::equal
- ::not_equalCursorPosition::not_equal
- ::equalEvent::equal
- ::not_equalEvent::not_equal
- ::bitsKeyboardEnhancementFlags::bits
- ::disambiguateKeyboardEnhancementFlags::disambiguate
- ::disambiguate_escape_codesKeyboardEnhancementFlags::disambiguate_escape_codes
- ::equalKeyboardEnhancementFlags::equal
- ::fullKeyboardEnhancementFlags::full
- ::newKeyboardEnhancementFlags::new
- ::not_equalKeyboardEnhancementFlags::not_equal
- ::report_all_keys_as_escape_codesKeyboardEnhancementFlags::report_all_keys_as_escape_codes
- ::report_alternate_keysKeyboardEnhancementFlags::report_alternate_keys
- ::report_associated_textKeyboardEnhancementFlags::report_associated_text
- ::report_event_typesKeyboardEnhancementFlags::report_event_types
- ::equalMouseTrackingMode::equal
- ::not_equalMouseTrackingMode::not_equal
- ::make_rawState::make_raw
- ::begin_synchronized_updateTty::begin_synchronized_update
- ::closeTty::close
- ::cursor_backTty::cursor_back
- ::cursor_forwardTty::cursor_forward
- ::cursor_upTty::cursor_up
- ::disable_auto_wrapTty::disable_auto_wrap
- ::disable_bracketed_pasteTty::disable_bracketed_paste
- ::disable_focus_trackingTty::disable_focus_tracking
- ::disable_mouseTty::disable_mouse
- ::enable_auto_wrapTty::enable_auto_wrap
- ::enable_bracketed_pasteTty::enable_bracketed_paste
- ::enable_focus_trackingTty::enable_focus_tracking
- ::enable_mouseTty::enable_mouse
- ::end_synchronized_updateTty::end_synchronized_update
- ::enter_alt_screenTty::enter_alt_screen
- ::enter_raw_modeTty::enter_raw_mode
- ::erase_displayTty::erase_display
- ::erase_line_allTty::erase_line_all
- ::erase_scrollbackTty::erase_scrollback
- ::executeTty::execute
- ::get_stateTty::get_state
- ::hide_cursorTty::hide_cursor
- ::leave_alt_screenTty::leave_alt_screen
- ::leave_raw_modeTty::leave_raw_mode
- ::newTty::new
- ::openTty::open
- ::pop_keyboard_enhancement_flagsTty::pop_keyboard_enhancement_flags
- ::push_keyboard_enhancement_flagsTty::push_keyboard_enhancement_flags
- ::query_cursor_colorTty::query_cursor_color
- ::query_cursor_positionTty::query_cursor_position
- ::query_default_background_colorTty::query_default_background_color
- ::query_default_foreground_colorTty::query_default_foreground_color
- ::query_kitty_keyboard_supportTty::query_kitty_keyboard_support
- ::read_eventTty::read_event
- ::reset_backgroundTty::reset_background
- ::reset_boldTty::reset_bold
- ::reset_foregroundTty::reset_foreground
- ::reset_italicTty::reset_italic
- ::reset_reverseTty::reset_reverse
- ::reset_styleTty::reset_style
- ::reset_top_bottom_marginsTty::reset_top_bottom_margins
- ::reset_underlineTty::reset_underline
- ::reverse_indexTty::reverse_index
- ::set_backgroundTty::set_background
- ::set_boldTty::set_bold
- ::set_cursor_positionTty::set_cursor_position
- ::set_foregroundTty::set_foreground
- ::set_italicTty::set_italic
- ::set_reverseTty::set_reverse
- ::set_stateTty::set_state
- ::set_top_bottom_marginsTty::set_top_bottom_margins
- ::set_underlineTty::set_underline
- ::show_cursorTty::show_cursor
- ::stdioTty::stdio
- ::window_sizeTty::window_size
- ::with_alt_screenTty::with_alt_screen
- ::with_bracketed_pasteTty::with_bracketed_paste
- ::with_focus_trackingTty::with_focus_tracking
- ::with_keyboard_enhancementsTty::with_keyboard_enhancements
- ::with_kitty_keyboardTty::with_kitty_keyboard
- ::with_mouseTty::with_mouse
- ::with_raw_modeTty::with_raw_mode
- ::with_synchronized_updateTty::with_synchronized_update
- ::with_top_bottom_marginsTty::with_top_bottom_margins
- ::writeTty::write
- ::write_stringTty::write_string
- ::equalWindowSize::equal
- ::not_equalWindowSize::not_equal
V
isatty

moonbit-community/tty/input does not have a README file

InputEvent

pub(all) enum InputEvent {
  Key(KeyEvent)
  Mouse(MouseEvent)
  Paste(String)
  FocusIn
  FocusOut
  Unknown(Bytes)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

User input decoded from terminal bytes.

Unsupported, malformed, invalid UTF-8, or unclosed sequences are preserved as Unknown bytes instead of becoming decoder errors.

InputEvent::equal

source

fn InputEvent::equal(InputEvent, InputEvent) -> Bool

InputEvent::not_equal

source

fn InputEvent::not_equal(x : InputEvent, y : InputEvent) -> Bool

InputEvent::to_repr

source

fn InputEvent::to_repr(InputEvent) -> @moonbitlang/core/debug.Repr
Repr

KeyCode

source

pub(all) enum KeyCode {
  Char(Char)
  Text
  Enter
  Tab
  Backspace
  Delete
  Escape
  Up
  Down
  Left
  Right
  Home
  End
  PageUp
  PageDown
  Insert
  F1
  F2
  F3
  F4
  F5
  F6
  F7
  F8
  F9
  F10
  F11
  F12
  F13
  F14
  F15
  F16
  F17
  F18
  F19
  F20
  F21
  F22
  F23
  F24
  F25
  F26
  F27
  F28
  F29
  F30
  F31
  F32
  F33
  F34
  F35
  CapsLock
  ScrollLock
  NumLock
  PrintScreen
  Pause
  Menu
  KeypadBegin
  Keypad0
  Keypad1
  Keypad2
  Keypad3
  Keypad4
  Keypad5
  Keypad6
  Keypad7
  Keypad8
  Keypad9
  KeypadDecimal
  KeypadDivide
  KeypadMultiply
  KeypadMinus
  KeypadPlus
  KeypadEnter
  KeypadEqual
  KeypadSeparator
  Media(MediaKeyCode)
  Modifier(ModifierKeyCode)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Logical key code decoded from terminal input.

KeyCode::equal

source

fn KeyCode::equal(KeyCode, KeyCode) -> Bool

KeyCode::not_equal

source

fn KeyCode::not_equal(x : KeyCode, y : KeyCode) -> Bool

KeyCode::to_repr

source

fn KeyCode::to_repr(KeyCode) -> @moonbitlang/core/debug.Repr
Repr

KeyEvent

source

pub struct KeyEvent {
  code : KeyCode
  modifiers : KeyModifiers
  kind : KeyEventKind
  state : KeyEventState
  text : String?
  shifted_code : KeyCode?
  base_code : KeyCode?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Decoded key event.

text is decoded terminal text when present. It is not a grapheme, display width, or cursor-motion contract.

shifted_code and base_code are available when kitty keyboard protocol alternate key reports are enabled. shifted_code is the shifted key in the active layout; base_code is the key in a standard PC-101 layout.

KeyEvent::equal

source

fn KeyEvent::equal(KeyEvent, KeyEvent) -> Bool

KeyEvent::new

source

fn KeyEvent::new(code : KeyCode, modifiers? : KeyModifiers, text? : String, kind? : KeyEventKind, state? : KeyEventState, shifted_code? : KeyCode, base_code? : KeyCode) -> KeyEvent

Construct a key event.

KeyEvent::not_equal

source

fn KeyEvent::not_equal(x : KeyEvent, y : KeyEvent) -> Bool

KeyEvent::to_repr

source

fn KeyEvent::to_repr(KeyEvent) -> @moonbitlang/core/debug.Repr
Repr

KeyEventKind

source

pub(all) enum KeyEventKind {
  Press
  Repeat
  Release
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Keyboard event action.

KeyEventKind::equal

source

fn KeyEventKind::equal(KeyEventKind, KeyEventKind) -> Bool

KeyEventKind::not_equal

source

fn KeyEventKind::not_equal(x : KeyEventKind, y : KeyEventKind) -> Bool

KeyEventKind::to_repr

source

fn KeyEventKind::to_repr(KeyEventKind) -> @moonbitlang/core/debug.Repr
Repr

KeyEventState

source

type KeyEventState derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Opaque set of keyboard event state flags.

KeyEventState::caps_lock

source

fn KeyEventState::caps_lock(self : KeyEventState) -> Bool

Return whether Caps Lock was active for the key event.

KeyEventState::equal

source

fn KeyEventState::equal(KeyEventState, KeyEventState) -> Bool

KeyEventState::keypad

source

fn KeyEventState::keypad(self : KeyEventState) -> Bool

Return whether the event originated from the keypad.

KeyEventState::new

source

fn KeyEventState::new(keypad? : Bool, caps_lock? : Bool, num_lock? : Bool) -> KeyEventState

Construct a keyboard event state set.

KeyEventState::not_equal

source

fn KeyEventState::not_equal(x : KeyEventState, y : KeyEventState) -> Bool

KeyEventState::num_lock

source

fn KeyEventState::num_lock(self : KeyEventState) -> Bool

Return whether Num Lock was active for the key event.

KeyEventState::to_repr

source

fn KeyEventState::to_repr(KeyEventState) -> @moonbitlang/core/debug.Repr
Repr

KeyModifiers

source

type KeyModifiers derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Opaque set of key modifiers.

KeyModifiers::alt

source

fn KeyModifiers::alt(self : KeyModifiers) -> Bool

Return whether the Alt modifier is set.

KeyModifiers::ctrl

source

fn KeyModifiers::ctrl(self : KeyModifiers) -> Bool

Return whether the Ctrl modifier is set.

KeyModifiers::equal

source

fn KeyModifiers::equal(KeyModifiers, KeyModifiers) -> Bool

KeyModifiers::hyper

source

fn KeyModifiers::hyper(self : KeyModifiers) -> Bool

Return whether the Hyper modifier is set.

KeyModifiers::meta

source

fn KeyModifiers::meta(self : KeyModifiers) -> Bool

Return whether the Meta modifier is set.

KeyModifiers::new

source

fn KeyModifiers::new(shift? : Bool, alt? : Bool, ctrl? : Bool, meta? : Bool, super_? : Bool, hyper? : Bool) -> KeyModifiers

Construct a modifier set.

KeyModifiers::not_equal

source

fn KeyModifiers::not_equal(x : KeyModifiers, y : KeyModifiers) -> Bool

KeyModifiers::shift

source

fn KeyModifiers::shift(self : KeyModifiers) -> Bool

Return whether the Shift modifier is set.

KeyModifiers::super_

source

fn KeyModifiers::super_(self : KeyModifiers) -> Bool

Return whether the Super modifier is set.

KeyModifiers::to_repr

source

fn KeyModifiers::to_repr(KeyModifiers) -> @moonbitlang/core/debug.Repr
Repr

MediaKeyCode

source

pub(all) enum MediaKeyCode {
  Play
  Pause
  PlayPause
  Reverse
  Stop
  FastForward
  Rewind
  TrackNext
  TrackPrevious
  Record
  LowerVolume
  RaiseVolume
  MuteVolume
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Media key decoded from kitty keyboard functional key reports.

MediaKeyCode::equal

source

fn MediaKeyCode::equal(MediaKeyCode, MediaKeyCode) -> Bool

MediaKeyCode::not_equal

source

fn MediaKeyCode::not_equal(x : MediaKeyCode, y : MediaKeyCode) -> Bool

MediaKeyCode::to_repr

source

fn MediaKeyCode::to_repr(MediaKeyCode) -> @moonbitlang/core/debug.Repr
Repr

ModifierKeyCode

source

pub(all) enum ModifierKeyCode {
  LeftShift
  LeftControl
  LeftAlt
  LeftSuper
  LeftHyper
  LeftMeta
  RightShift
  RightControl
  RightAlt
  RightSuper
  RightHyper
  RightMeta
  IsoLevel3Shift
  IsoLevel5Shift
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Modifier key decoded from kitty keyboard functional key reports.

ModifierKeyCode::equal

source

fn ModifierKeyCode::equal(ModifierKeyCode, ModifierKeyCode) -> Bool

ModifierKeyCode::not_equal

source

fn ModifierKeyCode::not_equal(x : ModifierKeyCode, y : ModifierKeyCode) -> Bool

ModifierKeyCode::to_repr

source

fn ModifierKeyCode::to_repr(ModifierKeyCode) -> @moonbitlang/core/debug.Repr
Repr

MouseButton

source

pub(all) enum MouseButton {
  Left
  Middle
  Right
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Supported mouse buttons.

MouseButton::equal

source

fn MouseButton::equal(MouseButton, MouseButton) -> Bool

MouseButton::not_equal

source

fn MouseButton::not_equal(x : MouseButton, y : MouseButton) -> Bool

MouseButton::to_repr

source

fn MouseButton::to_repr(MouseButton) -> @moonbitlang/core/debug.Repr
Repr

MouseEvent

source

pub struct MouseEvent {
  kind : MouseEventKind
  row : Int
  col : Int
  modifiers : KeyModifiers
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Decoded mouse event.

Rows and columns are 1-based terminal cell coordinates.

MouseEvent::equal

source

fn MouseEvent::equal(MouseEvent, MouseEvent) -> Bool

MouseEvent::new

source

fn MouseEvent::new(kind : MouseEventKind, row : Int, col : Int, modifiers? : KeyModifiers) -> MouseEvent

Construct a mouse event with optional key modifiers.

MouseEvent::not_equal

source

fn MouseEvent::not_equal(x : MouseEvent, y : MouseEvent) -> Bool

MouseEvent::to_repr

source

fn MouseEvent::to_repr(MouseEvent) -> @moonbitlang/core/debug.Repr
Repr

MouseEventKind

source

pub(all) enum MouseEventKind {
  Press(MouseButton)
  Release(MouseButton)
  Drag(MouseButton)
  Move
  Scroll(MouseScroll)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Mouse input action decoded from an SGR mouse report.

MouseEventKind::equal

source

fn MouseEventKind::equal(MouseEventKind, MouseEventKind) -> Bool

MouseEventKind::not_equal

source

fn MouseEventKind::not_equal(x : MouseEventKind, y : MouseEventKind) -> Bool

MouseEventKind::to_repr

source

fn MouseEventKind::to_repr(MouseEventKind) -> @moonbitlang/core/debug.Repr
Repr

MouseScroll

source

pub(all) enum MouseScroll {
  Up
  Down
  Left
  Right
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Supported mouse scroll directions.

MouseScroll::equal

source

fn MouseScroll::equal(MouseScroll, MouseScroll) -> Bool

MouseScroll::not_equal

source

fn MouseScroll::not_equal(x : MouseScroll, y : MouseScroll) -> Bool

MouseScroll::to_repr

source

fn MouseScroll::to_repr(MouseScroll) -> @moonbitlang/core/debug.Repr
Repr

Source Files

event.mbt

Site source Report issue Packages Build queue Skills Statistics

#InputEvent

#InputEvent::equal

#InputEvent::not_equal

#InputEvent::to_repr

#KeyCode

#KeyCode::equal

#KeyCode::not_equal

#KeyCode::to_repr

#KeyEvent

#KeyEvent::equal

#KeyEvent::new

#KeyEvent::not_equal

#KeyEvent::to_repr

#KeyEventKind

#KeyEventKind::equal

#KeyEventKind::not_equal

#KeyEventKind::to_repr

#KeyEventState

#KeyEventState::caps_lock

#KeyEventState::equal

#KeyEventState::keypad

#KeyEventState::new

#KeyEventState::not_equal

#KeyEventState::num_lock

#KeyEventState::to_repr

#KeyModifiers

#KeyModifiers::alt

#KeyModifiers::ctrl

#KeyModifiers::equal

#KeyModifiers::hyper

#KeyModifiers::meta

#KeyModifiers::new

#KeyModifiers::not_equal

#KeyModifiers::shift

#KeyModifiers::super_

#KeyModifiers::to_repr

#MediaKeyCode

#MediaKeyCode::equal

#MediaKeyCode::not_equal

#MediaKeyCode::to_repr

#ModifierKeyCode

#ModifierKeyCode::equal

#ModifierKeyCode::not_equal

#ModifierKeyCode::to_repr

#MouseButton

#MouseButton::equal

#MouseButton::not_equal

#MouseButton::to_repr

#MouseEvent

#MouseEvent::equal

#MouseEvent::new

#MouseEvent::not_equal

#MouseEvent::to_repr

#MouseEventKind

#MouseEventKind::equal

#MouseEventKind::not_equal

#MouseEventKind::to_repr

#MouseScroll

#MouseScroll::equal

#MouseScroll::not_equal

#MouseScroll::to_repr

Source Files

InputEvent

InputEvent::equal

InputEvent::not_equal

InputEvent::to_repr

KeyCode

KeyCode::equal

KeyCode::not_equal

KeyCode::to_repr

KeyEvent

KeyEvent::equal

KeyEvent::new

KeyEvent::not_equal

KeyEvent::to_repr

KeyEventKind

KeyEventKind::equal

KeyEventKind::not_equal

KeyEventKind::to_repr

KeyEventState

KeyEventState::caps_lock

KeyEventState::equal

KeyEventState::keypad

KeyEventState::new

KeyEventState::not_equal

KeyEventState::num_lock

KeyEventState::to_repr

KeyModifiers

KeyModifiers::alt

KeyModifiers::ctrl

KeyModifiers::equal

KeyModifiers::hyper

KeyModifiers::meta

KeyModifiers::new

KeyModifiers::not_equal

KeyModifiers::shift

KeyModifiers::super_

KeyModifiers::to_repr

MediaKeyCode

MediaKeyCode::equal

MediaKeyCode::not_equal

MediaKeyCode::to_repr

ModifierKeyCode

ModifierKeyCode::equal

ModifierKeyCode::not_equal

ModifierKeyCode::to_repr

MouseButton

MouseButton::equal

MouseButton::not_equal

MouseButton::to_repr

MouseEvent

MouseEvent::equal

MouseEvent::new

MouseEvent::not_equal

MouseEvent::to_repr

MouseEventKind

MouseEventKind::equal

MouseEventKind::not_equal

MouseEventKind::to_repr

MouseScroll

MouseScroll::equal

MouseScroll::not_equal

MouseScroll::to_repr