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

Companion

object Companion

Factory methods and sentinel values for TerminalKeyEvent.

Properties

NO_CODEPOINT

const val NO_CODEPOINT: Int

Sentinel used when a key event does not carry a printable codepoint.

TEXT_ONLY_CODEPOINT

const val TEXT_ONLY_CODEPOINT: Int = 0

Kitty key code used when text has no known physical key identity.

Functions

codepoint

fun codepoint(codepoint: Int, modifiers: Int = TerminalModifiers.NONE, unshiftedCodepoint: Int = NO_CODEPOINT, shiftedCodepoint: Int = NO_CODEPOINT, baseLayoutCodepoint: Int = NO_CODEPOINT, associatedText: String? = null, type: TerminalKeyEventType = TerminalKeyEventType.PRESS): TerminalKeyEvent

Creates a printable Unicode scalar key event.

key

fun key(key: TerminalKey, modifiers: Int = TerminalModifiers.NONE, type: TerminalKeyEventType = TerminalKeyEventType.PRESS): TerminalKeyEvent

Creates a non-printable key event.

text

fun text(associatedText: String, modifiers: Int = TerminalModifiers.NONE, type: TerminalKeyEventType = TerminalKeyEventType.PRESS): TerminalKeyEvent

Creates a Kitty text-only event with no known physical key identity.