Class TerminalOptions

Stores the terminal options.

Inheritance

object

TerminalOptions

Implements

IEquatable<TerminalOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Sharpie

Assembly: sharpie.dll

Syntax

[PublicAPI]
public record TerminalOptions : IEquatable<TerminalOptions>

Constructors

TerminalOptions(bool, bool, bool, bool, int?, bool, CaretMode, bool, bool, SoftLabelKeyMode, bool, bool, bool, bool)

Stores the terminal options.

Declaration

public TerminalOptions(bool UseColors = true, bool EchoInput = false, bool UseInputBuffering = false, bool UseMouse = true, int? MouseClickInterval = null, bool SuppressControlKeys = true, CaretMode CaretMode = CaretMode.Visible, bool ManualFlush = false, bool ManagedWindows = false, SoftLabelKeyMode SoftLabelKeyMode = SoftLabelKeyMode.Disabled, bool AllocateHeader = false, bool AllocateFooter = false, bool UseEnvironmentOverrides = true, bool UseStandardKeySequenceResolvers = true)

Parameters

Type	Name	Description
bool	UseColors	Toggle the use of colors. Default is true.
bool	EchoInput	Toggle the input echoing. Default is false.
bool	UseInputBuffering	Toggles buffering input. Default is false.
bool	UseMouse	Toggles the use of mouse. Default is true.
int?	MouseClickInterval	The mouse click delay. Default is null which disables Curses handling of clicks.
bool	SuppressControlKeys	Toggles the suppression of control keys such as CTRL+C. Default is true.
CaretMode	CaretMode	Specifies the caret mode. Default is Visible.
bool	ManualFlush	Toggle the ability to manually flush the terminal. Default is false.
bool	ManagedWindows	Specifies whether the Screen manages overlapping windows. Default is false.
SoftLabelKeyMode	SoftLabelKeyMode	Specifies the SLK mode. Default is Disabled.
bool	AllocateHeader	If true, allocates one line at the top as a header.
bool	AllocateFooter	If true, allocates one line at the bottom as a footer.
bool	UseEnvironmentOverrides	Toggles the use of environment LINE/COL overrides. Default is true.
bool	UseStandardKeySequenceResolvers	Registers the standard key sequence resolvers defined in KeySequenceResolver.

Properties

AllocateFooter

If true, allocates one line at the bottom as a footer.

Declaration

public bool AllocateFooter { get; init; }

Property Value

Type	Description
bool

AllocateHeader

If true, allocates one line at the top as a header.

Declaration

public bool AllocateHeader { get; init; }

Property Value

Type	Description
bool

CaretMode

Specifies the caret mode. Default is Visible.

Declaration

public CaretMode CaretMode { get; init; }

Property Value

Type	Description
CaretMode

EchoInput

Toggle the input echoing. Default is false.

Declaration

public bool EchoInput { get; init; }

Property Value

Type	Description
bool

ManagedWindows

Specifies whether the Screen manages overlapping windows. Default is false.

Declaration

public bool ManagedWindows { get; init; }

Property Value

Type	Description
bool

ManualFlush

Toggle the ability to manually flush the terminal. Default is false.

Declaration

public bool ManualFlush { get; init; }

Property Value

Type	Description
bool

MouseClickInterval

The mouse click delay. Default is null which disables Curses handling of clicks.

Declaration

public int? MouseClickInterval { get; init; }

Property Value

Type	Description
int?

SoftLabelKeyMode

Specifies the SLK mode. Default is Disabled.

Declaration

public SoftLabelKeyMode SoftLabelKeyMode { get; init; }

Property Value

Type	Description
SoftLabelKeyMode

SuppressControlKeys

Toggles the suppression of control keys such as CTRL+C. Default is true.

Declaration

public bool SuppressControlKeys { get; init; }

Property Value

Type	Description
bool

UseColors

Toggle the use of colors. Default is true.

Declaration

public bool UseColors { get; init; }

Property Value

Type	Description
bool

UseEnvironmentOverrides

Toggles the use of environment LINE/COL overrides. Default is true.

Declaration

public bool UseEnvironmentOverrides { get; init; }

Property Value

Type	Description
bool

UseInputBuffering

Toggles buffering input. Default is false.

Declaration

public bool UseInputBuffering { get; init; }

Property Value

Type	Description
bool

UseMouse

Toggles the use of mouse. Default is true.

Declaration

public bool UseMouse { get; init; }

Property Value

Type	Description
bool

UseStandardKeySequenceResolvers

Registers the standard key sequence resolvers defined in KeySequenceResolver.

Declaration

public bool UseStandardKeySequenceResolvers { get; init; }

Property Value

Type	Description
bool

Implements

IEquatable<T>