Terminal

classin packageklyn.gui.terminal

public class Terminal extends Widget

Object

└ Widget

└ Terminal

High-level terminal application root.

Inherited Attributes

attributeInherited Attributes from Widget: lastRenderAnsi, lastRenderHeight, lastRenderPlain, lastRenderWidth, layout, visible

Properties

Modifier and Type	Member	Description
public readonly property	activePage `activePage as klyn.gui.terminal.Page`	No summary.
public readonly property	deckPane `deckPane as DeckPane`	No summary.
public readonly property	dockedPanes `dockedPanes as ArrayList<klyn.gui.terminal.DockedPane>`	No summary.
public property	idlePollIntervalMs `idlePollIntervalMs as Int`	Maximum delay, in milliseconds, before the terminal calls widget idle hooks.
public static readonly property	instance `instance as Terminal`	Singleton instance.
public readonly property	lastFrame `lastFrame as TerminalFrame`	Last composed logical terminal frame.
public readonly property	menuBar `menuBar as MenuBar`	No summary.
public property	mouseTrackingEnabled `mouseTrackingEnabled as Boolean`	No summary.
public readonly property	pages `pages as ArrayList<klyn.gui.terminal.Page>`	No summary.
public property	prompt `prompt as String`	No summary.
public property	quitOnCtrlC `quitOnCtrlC as Boolean`	Controls whether an unhandled Ctrl+C exits the terminal application.
public override native property	size `size as Tuple<UInt, UInt>`	Current terminal size.
public readonly property	statusBar `statusBar as StatusBar`	No summary.
public property	title `title as String`	No summary.

Inherited Properties

propertyInherited Properties from Widget: focusable, focused, lastRenderFrame, position, size

propertyInherited Properties from Object: type

Events

Modifier and Type	Member	Description
public event	mouseReceived `mouseReceived as MouseReceivedEvent`	Emitted when the terminal decodes a mouse event.
public event	pageChanged `pageChanged as PageChangeEvent`	Emitted when the active page changes.
public event	resized `resized as ResizeEvent`	Emitted when the terminal size changes.

Constructors

Modifier and Type	Member	Description
public	Terminal `Terminal()`	No summary.

Methods

Modifier and Type	Member	Description
public	addDockedPane `addDockedPane(key as Object, aliases as Object, side as Object, view as Object) as Void`	Registers a docked pane toggled from the menu.
public	addDocument `addDocument(document as Object, view as Object) as Void`	Adds a hidden document/view entry.
public	addDocument `addDocument(key as Object, title as Object, view as Object) as Void`	Adds a document/view entry.
public	addPage `addPage(key as Object, title as Object, view as Object) as Void`	No summary.
public	addPage `addPage(view as Object) as Void`	No summary.
public static	copyToClipboard `copyToClipboard(text as String) as Boolean`	Copies text to the host terminal clipboard using the OSC 52 escape sequence.
public	dispatchEvent `dispatchEvent(eventName as String, width as Int = 0) as Boolean`	Processes one logical terminal event without reading from stdin.
public	exit `exit(code as Int = 0) as Void`	No summary.
public	focusPage `focusPage(key as String) as Void`	No summary.
public	focusPage `focusPage(view as EditorView) as Void`	No summary.
public	focusPage `focusPage(view as Widget) as Void`	No summary.
public override	paint `paint() as Void`	No summary.
public	renderFrame `renderFrame(width as Int = 0, height as Int = 0) as TerminalFrame`	Renders one logical frame without flushing it to the real terminal.
public	run `run() as Int`	Runs the interactive event loop and restores the terminal on exit.
public	setViewportSize `setViewportSize(width as Int, height as Int) as Void`	Sets a logical viewport size for headless rendering/tests.
public	togglePane `togglePane(side as DockedSide) as Void`	Shows or hides the first docked pane on the requested side.

Inherited Methods

methodInherited Methods from Widget: add, baseAnsiStyle, captureRenderFrame, children, clearChildren, configureCursor, focusNext, handleEvent, handleMouseEvent, hasActiveTextInput, idle, paint, paintToFrame, performLayout, refresh, renderAnsiSnapshot, renderPlainSnapshot, scrollbarThumbGlyph, scrollbarTrackGlyph, terminalPromptVisible

methodInherited Methods from Object: deepCopy, fromJson, hash, toDict, toJson, toMap, toString, toXml