GhosttyTerminalData enum

Terminal data types.

These values specify what type of data to extract from a terminal using ghostty_terminal_get.

@ingroup terminal

Inheritance
Available extensions

Values

GHOSTTY_TERMINAL_DATA_INVALID → const GhosttyTerminalData

Invalid data type. Never results in any data extraction.

const GhosttyTerminalData(0)
GHOSTTY_TERMINAL_DATA_COLS → const GhosttyTerminalData

Terminal width in cells.

Output type: uint16_t *

const GhosttyTerminalData(1)
GHOSTTY_TERMINAL_DATA_ROWS → const GhosttyTerminalData

Terminal height in cells.

Output type: uint16_t *

const GhosttyTerminalData(2)
GHOSTTY_TERMINAL_DATA_CURSOR_X → const GhosttyTerminalData

Cursor column position (0-indexed).

Output type: uint16_t *

const GhosttyTerminalData(3)
GHOSTTY_TERMINAL_DATA_CURSOR_Y → const GhosttyTerminalData

Cursor row position within the active area (0-indexed).

Output type: uint16_t *

const GhosttyTerminalData(4)
GHOSTTY_TERMINAL_DATA_CURSOR_PENDING_WRAP → const GhosttyTerminalData

Whether the cursor has a pending wrap (next print will soft-wrap).

Output type: bool *

const GhosttyTerminalData(5)
GHOSTTY_TERMINAL_DATA_ACTIVE_SCREEN → const GhosttyTerminalData

The currently active screen.

Output type: GhosttyTerminalScreen *

const GhosttyTerminalData(6)
GHOSTTY_TERMINAL_DATA_CURSOR_VISIBLE → const GhosttyTerminalData

Whether the cursor is visible (DEC mode 25).

Output type: bool *

const GhosttyTerminalData(7)
GHOSTTY_TERMINAL_DATA_KITTY_KEYBOARD_FLAGS → const GhosttyTerminalData

Current Kitty keyboard protocol flags.

Output type: GhosttyKittyKeyFlags * (uint8_t *)

const GhosttyTerminalData(8)
GHOSTTY_TERMINAL_DATA_SCROLLBAR → const GhosttyTerminalData

Scrollbar state for the terminal viewport.

This may be expensive to calculate depending on where the viewport is (arbitrary pins are expensive). The caller should take care to only call this as needed and not too frequently.

Output type: GhosttyTerminalScrollbar *

const GhosttyTerminalData(9)
GHOSTTY_TERMINAL_DATA_CURSOR_STYLE → const GhosttyTerminalData

The current SGR style of the cursor.

This is the style that will be applied to newly printed characters.

Output type: GhosttyStyle *

const GhosttyTerminalData(10)

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → int
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

fromValue(int value) → GhosttyTerminalData

Constants

values → const List<GhosttyTerminalData>
A constant List of the values in this enum, in order of their declaration.