Class TerminalInfo

Namespace

MiniTui

Assembly

MiniTui.dll

What the terminal said about itself in reply to the startup queries (1.x spec §12.3). Unknown values are null.

public sealed record TerminalInfo : IEquatable<TerminalInfo>

Inheritance

object

TerminalInfo

Implements

IEquatable<TerminalInfo>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Answered

True once the terminal answered (its Primary Device Attributes reply arrived). False before that, with queries turned off, on backends that aren't a VT terminal, and when it never answered.

public bool Answered { get; init; }

Property Value

bool

Background

The default background color (the OSC 11 reply), as an RGB color.

public Color? Background { get; init; }

Property Value

Color?

Foreground

The default foreground color (the OSC 10 reply), as an RGB color.

public Color? Foreground { get; init; }

Property Value

Color?

IsDark

Whether the background is dark: from Background, or else COLORFGBG.

public bool? IsDark { get; init; }

Property Value

bool?

Keyboard

The keyboard protocol in use (1.x spec §12.5). Legacy until one is detected and turned on.

public KeyboardProtocol Keyboard { get; init; }

Property Value

KeyboardProtocol

Name

The terminal's name and version from its XTVERSION reply.

public string? Name { get; init; }

Property Value

string