KetraTerm
API · DevelopmentAll versions

TerminalTitlePolicy

data class TerminalTitlePolicy(val permission: TerminalTitlePermission = TerminalTitlePermission.ALLOW, val overflowPolicy: TerminalTitleOverflowPolicy = TerminalTitleOverflowPolicy.CLAMP, val maxLength: Int = DEFAULT_MAX_LENGTH)

Host policy for terminal-triggered icon and window title metadata updates.

OSC 0/1/2 and xterm title-stack restore operations can rename host UI surfaces. The permission applies to all output in the session, including nested SSH and multiplexer output, before adapter or core metadata changes. A title is application-provided display text, never an authenticated identity.

Constructors

Link copied to clipboard
constructor(permission: TerminalTitlePermission = TerminalTitlePermission.ALLOW, overflowPolicy: TerminalTitleOverflowPolicy = TerminalTitleOverflowPolicy.CLAMP, maxLength: Int = DEFAULT_MAX_LENGTH)

Types

Link copied to clipboard
object Companion

Shared default maximum retained title length in UTF-16 code units.

Properties

Link copied to clipboard

maximum retained title length in UTF-16 code units. Clamping never splits a valid surrogate pair.

Link copied to clipboard

handling for titles longer than maxLength.

Link copied to clipboard

permission for title updates throughout the session.