Skip to main content

Module event

Module event 

Source
Expand description

Canonical input/event types.

This module defines the standard event types used throughout ftui for input handling. All events derive Clone, PartialEq, and Eq for use in tests and pattern matching.

§Design Notes

  • Mouse coordinates are 0-indexed (terminal is 1-indexed internally)
  • KeyEventKind defaults to Press when not available from the terminal
  • Modifiers use bitflags for easy combination
  • Clipboard events are optional and feature-gated in the future

Structs§

ClipboardEvent
A clipboard event from OSC 52 response.
KeyEvent
A keyboard event.
Modifiers
Modifier keys that can be held during a key event.
MouseEvent
A mouse event.
PasteEvent
A paste event from bracketed paste mode.

Enums§

ClipboardSource
The source of clipboard content.
Event
Canonical input event.
KeyCode
Key codes for keyboard events.
KeyEventKind
The type of key event.
MouseButton
Mouse button identifiers.
MouseEventKind
The type of mouse event.