ketraterm-protocol/io.github.ketraterm.protocol.keyboard/XtermKeyResource

XtermKeyResource

object XtermKeyResource

Shared key-family IDs for xterm modifier and format set/reset/query controls. The command selects the operation; both families use the same resource IDs. Resource 5 is reserved for string actions and is excluded. See https://invisible-island.net/xterm/ctlseqs/ctlseqs.html.

Properties

const val CURSOR_KEYS: Int = 1

Cursor and editing keypad keys.

const val FUNCTION_KEYS: Int = 2

Numbered and miscellaneous function keys.

const val KEYBOARD: Int = 0

Modifier admission mask for legacy/VT220 keyboard profiles.

const val KEYPAD_KEYS: Int = 3

Numeric keypad keys.

const val MODIFIER_KEYS: Int = 6

Physical modifier keys, including left/right variants.

const val OTHER_KEYS: Int = 4

Ordinary keys, controlled by modifyOtherKeys and formatOtherKeys.

const val SPECIAL_KEYS: Int = 7

Remaining predefined keys such as Escape and Enter.

Functions

fun isSupported(resource: Int): Boolean

Whether this is a documented key resource; string-action resource 5 is excluded.

isValidFormatValue

fun isValidFormatValue(resource: Int, value: Int): Boolean

Whether the resource and extended-report format (0 or 1) are supported.

isValidModifierValue

fun isValidModifierValue(resource: Int, value: Int): Boolean

Whether a semantic resource value is implemented, including explicit disable (-1).