ketraterm-input/io.github.ketraterm.input.event

Package-level declarations

Types

data class TerminalFocusEvent(val focused: Boolean) : TerminalInputEvent

Focus transition event accepted by the terminal input encoder.

Immutable normalized input accepted by an encoder. Sessions can admit a bounded list of these events as one ordered operation. Byte encoding and mode-dependent suppression remain the responsibility of the input encoder.

TerminalKey

enum TerminalKey : Enum<TerminalKey>

Non-printable terminal keys accepted by the input encoder.

TerminalKeyEvent

data class TerminalKeyEvent(val key: TerminalKey? = null, val codepoint: Int = NO_CODEPOINT, val unshiftedCodepoint: Int = NO_CODEPOINT, val shiftedCodepoint: Int = NO_CODEPOINT, val baseLayoutCodepoint: Int = NO_CODEPOINT, val associatedText: String? = null, val modifiers: Int = TerminalModifiers.NONE, val type: TerminalKeyEventType = TerminalKeyEventType.PRESS) : TerminalInputEvent

One keyboard event accepted by the terminal input encoder.

TerminalKeyEventType

enum TerminalKeyEventType : Enum<TerminalKeyEventType>

Physical lifecycle phase of a normalized keyboard event.

TerminalModifiers

object TerminalModifiers

Bit mask vocabulary for UI keyboard modifiers accepted by terminal input.

TerminalMouseButton

enum TerminalMouseButton : Enum<TerminalMouseButton>

Platform-neutral mouse button vocabulary for terminal input reporting.

TerminalMouseEvent

data class TerminalMouseEvent(val column: Int, val row: Int, val button: TerminalMouseButton, val type: TerminalMouseEventType, val modifiers: Int = TerminalModifiers.NONE, val pixelX: Int = -1, val pixelY: Int = -1) : TerminalInputEvent

One platform-neutral mouse event accepted by the terminal input encoder.

TerminalMouseEventType

enum TerminalMouseEventType : Enum<TerminalMouseEventType>

Mouse event family accepted by the terminal input encoder.

TerminalPasteEvent

data class TerminalPasteEvent(val text: String) : TerminalInputEvent

Paste event accepted by the terminal input encoder.

TerminalTextReplacementEvent

data class TerminalTextReplacementEvent(val deleteAfterCursorCount: Int, val deleteBeforeCursorCount: Int, val replacementText: String) : TerminalInputEvent

One logical terminal text replacement around the active cursor.