TerminalInputPolicy

data class TerminalInputPolicy(val backspacePolicy: BackspacePolicy = BackspacePolicy.DELETE, val metaKeyPolicy: MetaKeyPolicy = MetaKeyPolicy.ESC_PREFIX, val unsupportedModifiedKeyPolicy: UnsupportedModifiedKeyPolicy = UnsupportedModifiedKeyPolicy.SUPPRESS, val altSendsEscapePrefix: Boolean = true, val enterNewLineModePolicy: EnterNewLineModePolicy = EnterNewLineModePolicy.SEND_CR_LF, val mouseCoordinateLimitPolicy: MouseCoordinateLimitPolicy = MouseCoordinateLimitPolicy.SUPPRESS_OUT_OF_RANGE, val pasteSanitizationPolicy: PasteSanitizationPolicy = PasteSanitizationPolicy.RAW)

Runtime policy for keyboard encodings that do not have one unambiguous terminal byte representation.

The production encoder suppresses unsupported combinations by default rather than throwing, because UI toolkits may report platform-specific key states.

Constructors

Link copied to clipboard
constructor(backspacePolicy: BackspacePolicy = BackspacePolicy.DELETE, metaKeyPolicy: MetaKeyPolicy = MetaKeyPolicy.ESC_PREFIX, unsupportedModifiedKeyPolicy: UnsupportedModifiedKeyPolicy = UnsupportedModifiedKeyPolicy.SUPPRESS, altSendsEscapePrefix: Boolean = true, enterNewLineModePolicy: EnterNewLineModePolicy = EnterNewLineModePolicy.SEND_CR_LF, mouseCoordinateLimitPolicy: MouseCoordinateLimitPolicy = MouseCoordinateLimitPolicy.SUPPRESS_OUT_OF_RANGE, pasteSanitizationPolicy: PasteSanitizationPolicy = PasteSanitizationPolicy.RAW)

Properties

Link copied to clipboard

when true, Alt prefixes applicable legacy encodings with ESC.

Link copied to clipboard

byte sent for the Backspace key.

Link copied to clipboard

handling for unmodified Return/Enter when ANSI Line Feed/New Line mode is active.

Link copied to clipboard

handling for Meta-only printable and legacy key encodings.

Link copied to clipboard

handling for legacy mouse coordinates outside the bounded ESC [ M byte range.

Link copied to clipboard

handling for pasted text before optional bracketed-paste wrapping.

Link copied to clipboard

handling for valid key events whose modifier combination has no supported encoding in the active protocol set.