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

TerminalModifiers

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

These are internal encoder bits, not CSI modifier parameter values. CSI encoding applies the 1 + modifiers translation only at the wire boundary.

Properties

ALT

const val ALT: Int

Alt is active.

CAPS_LOCK

const val CAPS_LOCK: Int

Caps Lock is enabled.

CTRL

const val CTRL: Int

Control is active.

HYPER

const val HYPER: Int

Hyper is active.

Functions

hasAlt

fun hasAlt(modifiers: Int): Boolean

Returns true when Alt is present in modifiers.

hasCapsLock

fun hasCapsLock(modifiers: Int): Boolean

Returns true when Caps Lock is present in modifiers.

hasCtrl

fun hasCtrl(modifiers: Int): Boolean

Returns true when Control is present in modifiers.

hasHyper

fun hasHyper(modifiers: Int): Boolean

Returns true when Hyper is present in modifiers.

hasMeta

fun hasMeta(modifiers: Int): Boolean

Returns true when Meta is present in modifiers.

hasNumLock

fun hasNumLock(modifiers: Int): Boolean

Returns true when Num Lock is present in modifiers.

hasShift

fun hasShift(modifiers: Int): Boolean

Returns true when Shift is present in modifiers.

hasSuper

fun hasSuper(modifiers: Int): Boolean

Returns true when Super is present in modifiers.

isValid

fun isValid(modifiers: Int): Boolean

Returns true when modifiers contains only supported modifier bits.

toCsiModifierParam

fun toCsiModifierParam(modifiers: Int): Int

Converts internal modifier bits to an xterm-style CSI modifier parameter.

toKittyCsiModifierParam

fun toKittyCsiModifierParam(modifiers: Int): Int

Converts internal modifier bits to Kitty's CSI-u modifier parameter.