Class InteractiveTuiSettings

Interactive TUI settings

Inheritance

object

InteractiveTuiSettings

Namespace: Terminaux.Inputs.Interactive

Assembly: Terminaux.dll

Syntax

public class InteractiveTuiSettings

Constructors

InteractiveTuiSettings()

Makes a new instance of the interactive TUI settings

Declaration

public InteractiveTuiSettings()

InteractiveTuiSettings(InteractiveTuiSettings)

Makes a new instance of the interactive TUI settings with the copied settings

Declaration

public InteractiveTuiSettings(InteractiveTuiSettings settings)

Parameters

Type	Name	Description
InteractiveTuiSettings	settings	Settings instance to copy settings from

Properties

BackgroundColor

Interactive TUI background color

Declaration

public Color BackgroundColor { get; set; }

Property Value

Type	Description
Color

BoxBackgroundColor

Interactive TUI box background color

Declaration

public Color BoxBackgroundColor { get; set; }

Property Value

Type	Description
Color

BoxForegroundColor

Interactive TUI box foreground color

Declaration

public Color BoxForegroundColor { get; set; }

Property Value

Type	Description
Color

ForegroundColor

Interactive TUI foreground color

Declaration

public Color ForegroundColor { get; set; }

Property Value

Type	Description
Color

GlobalSettings

Global interactive TUI settings

Declaration

public static InteractiveTuiSettings GlobalSettings { get; }

Property Value

Type	Description
InteractiveTuiSettings

InfoBoxSettings

Infobox settings to use when rendering the interactive TUI

Declaration

public InfoBoxSettings InfoBoxSettings { get; set; }

Property Value

Type	Description
InfoBoxSettings

KeyBindingBuiltinBackgroundColor

Interactive TUI built-in key binding background color

Declaration

public Color KeyBindingBuiltinBackgroundColor { get; set; }

Property Value

Type	Description
Color

KeyBindingBuiltinColor

Interactive TUI built-in key binding foreground color in the background color

Declaration

public Color KeyBindingBuiltinColor { get; set; }

Property Value

Type	Description
Color

KeyBindingBuiltinForegroundColor

Interactive TUI built-in key binding foreground color outside the background color

Declaration

public Color KeyBindingBuiltinForegroundColor { get; set; }

Property Value

Type	Description
Color

KeyBindingOptionColor

Interactive TUI key binding in option color

Declaration

public Color KeyBindingOptionColor { get; set; }

Property Value

Type	Description
Color

OptionBackgroundColor

Interactive TUI option background color

Declaration

public Color OptionBackgroundColor { get; set; }

Property Value

Type	Description
Color

OptionForegroundColor

Interactive TUI option foreground color

Declaration

public Color OptionForegroundColor { get; set; }

Property Value

Type	Description
Color

PaneBackgroundColor

Interactive TUI pane background color

Declaration

public Color PaneBackgroundColor { get; set; }

Property Value

Type	Description
Color

PaneItemBackColor

Interactive TUI pane item color (background)

Declaration

public Color PaneItemBackColor { get; set; }

Property Value

Type	Description
Color

PaneItemForeColor

Interactive TUI pane item color (foreground)

Declaration

public Color PaneItemForeColor { get; set; }

Property Value

Type	Description
Color

PaneSelectedItemBackColor

Interactive TUI pane selected item color (background)

Declaration

public Color PaneSelectedItemBackColor { get; set; }

Property Value

Type	Description
Color

PaneSelectedItemForeColor

Interactive TUI pane selected item color (foreground)

Declaration

public Color PaneSelectedItemForeColor { get; set; }

Property Value

Type	Description
Color

PaneSelectedSeparatorColor

Interactive TUI pane selected separator color

Declaration

public Color PaneSelectedSeparatorColor { get; set; }

Property Value

Type	Description
Color

PaneSeparatorColor

Interactive TUI pane separator color

Declaration

public Color PaneSeparatorColor { get; set; }

Property Value

Type	Description
Color

Methods

SetBackgroundColor(Color?)

Sets the background color of the interactive TUI

Declaration

public void SetBackgroundColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetBoxBackgroundColor(Color?)

Sets the box background color of the interactive TUI

Declaration

public void SetBoxBackgroundColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetBoxForegroundColor(Color?)

Sets the box foreground color of the interactive TUI

Declaration

public void SetBoxForegroundColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetForegroundColor(Color?)

Sets the foreground color of the interactive TUI

Declaration

public void SetForegroundColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetKeyBindingBuiltinBackgroundColor(Color?)

Sets the built-in key binding background color of the interactive TUI

Declaration

public void SetKeyBindingBuiltinBackgroundColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetKeyBindingBuiltinColor(Color?)

Sets the built-in key binding foreground color in the background color of the interactive TUI

Declaration

public void SetKeyBindingBuiltinColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetKeyBindingBuiltinForegroundColor(Color?)

Sets the built-in key binding foreground color outside the background color of the interactive TUI

Declaration

public void SetKeyBindingBuiltinForegroundColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetKeyBindingOptionColor(Color?)

Sets the key binding in option color of the interactive TUI

Declaration

public void SetKeyBindingOptionColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetOptionBackgroundColor(Color?)

Sets the option background color of the interactive TUI

Declaration

public void SetOptionBackgroundColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetOptionForegroundColor(Color?)

Sets the option foreground color of the interactive TUI

Declaration

public void SetOptionForegroundColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetPaneBackgroundColor(Color?)

Sets the pane background color of the interactive TUI

Declaration

public void SetPaneBackgroundColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetPaneItemBackColor(Color?)

Sets the pane item background color of the interactive TUI

Declaration

public void SetPaneItemBackColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetPaneItemForeColor(Color?)

Sets the pane item foreground color of the interactive TUI

Declaration

public void SetPaneItemForeColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetPaneSelectedItemBackColor(Color?)

Sets the pane selected item background color of the interactive TUI

Declaration

public void SetPaneSelectedItemBackColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetPaneSelectedItemForeColor(Color?)

Sets the pane selected item foreground color of the interactive TUI

Declaration

public void SetPaneSelectedItemForeColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetPaneSelectedSeparatorColor(Color?)

Sets the pane selected separator color of the interactive TUI

Declaration

public void SetPaneSelectedSeparatorColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.

SetPaneSeparatorColor(Color?)

Sets the pane separator color of the interactive TUI

Declaration

public void SetPaneSeparatorColor(Color? color)

Parameters

Type	Name	Description
Color	color	Color to set. If null, inherits the color from the theme.