Class BaseInteractiveTui<TPrimary, TSecondary>

A base class for your interactive user interface for terminal apps

Inheritance
object
BaseInteractiveTui<TPrimary, TSecondary>
BaseInteractiveTui<T>
Implements
IInteractiveTui<TPrimary, TSecondary>
Namespace: Terminaux.Inputs.Interactive
Assembly: Terminaux.dll
Syntax
public class BaseInteractiveTui<TPrimary, TSecondary> : IInteractiveTui<TPrimary, TSecondary>
Type Parameters
Name Description
TPrimary
TSecondary

Properties

| Edit this page View Source

AcceptsEmptyData

Whether empty data is accepted

Declaration
public virtual bool AcceptsEmptyData { get; }
Property Value
Type Description
bool
| Edit this page View Source

Bindings

All key bindings for your interactive user interface

Declaration
public List<InteractiveTuiBinding<TPrimary, TSecondary>> Bindings { get; }
Property Value
Type Description
List<InteractiveTuiBinding<TPrimary, TSecondary>>
| Edit this page View Source

CurrentInfoLine

Current info line index

Declaration
public int CurrentInfoLine { get; }
Property Value
Type Description
int
| Edit this page View Source

CurrentPane

Current pane

Declaration
public int CurrentPane { get; }
Property Value
Type Description
int
| Edit this page View Source

FirstPaneCurrentSelection

Current selection for the first pane

Declaration
public int FirstPaneCurrentSelection { get; }
Property Value
Type Description
int
| Edit this page View Source

PrimaryDataSource

An array, a dictionary, a list, or an enumerable that holds data (pane one)

Declaration
public virtual IEnumerable<TPrimary> PrimaryDataSource { get; }
Property Value
Type Description
IEnumerable<TPrimary>
| Edit this page View Source

RefreshInterval

How many milliseconds to wait before refreshing? Only applies to single-pane interactive TUI instances. 0 to disable.

Declaration
public virtual int RefreshInterval { get; }
Property Value
Type Description
int
| Edit this page View Source

SecondPaneCurrentSelection

Current selection for the second pane

Declaration
public int SecondPaneCurrentSelection { get; }
Property Value
Type Description
int
| Edit this page View Source

SecondPaneInteractable

Whether the user can switch to the second path

Declaration
public virtual bool SecondPaneInteractable { get; }
Property Value
Type Description
bool
| Edit this page View Source

SecondaryDataSource

An array, a dictionary, a list, or an enumerable that holds data (pane two)

Declaration
public virtual IEnumerable<TSecondary> SecondaryDataSource { get; }
Property Value
Type Description
IEnumerable<TSecondary>
| Edit this page View Source

Settings

Interactive TUI settings

Declaration
public InteractiveTuiSettings Settings { get; set; }
Property Value
Type Description
InteractiveTuiSettings
| Edit this page View Source

Status

Current status

Declaration
public string Status { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

GetEntryFromItem(TPrimary)

Gets an entry string from a specified item for listing

Declaration
public virtual string GetEntryFromItem(TPrimary item)
Parameters
Type Name Description
TPrimary item

Target item
Returns
Type Description
string
| Edit this page View Source

GetEntryFromItemSecondary(TSecondary)

Gets an entry string from a specified item for listing

Declaration
public virtual string GetEntryFromItemSecondary(TSecondary item)
Parameters
Type Name Description
TSecondary item

Target item
Returns
Type Description
string
| Edit this page View Source

GetInfoFromItem(TPrimary)

Gets the info from the item

Declaration
public virtual string GetInfoFromItem(TPrimary item)
Parameters
Type Name Description
TPrimary item

Target item
Returns
Type Description
string

The rendered info so that InteractiveTuiTools can handle its rendering
| Edit this page View Source

GetInfoFromItemSecondary(TSecondary)

Gets the info from the item

Declaration
public virtual string GetInfoFromItemSecondary(TSecondary item)
Parameters
Type Name Description
TSecondary item

Target item
Returns
Type Description
string

The rendered info so that InteractiveTuiTools can handle its rendering
| Edit this page View Source

GetStatusFromItem(TPrimary)

Gets the status from the item

Declaration
public virtual string GetStatusFromItem(TPrimary item)
Parameters
Type Name Description
TPrimary item

Target item
Returns
Type Description
string
| Edit this page View Source

GetStatusFromItemSecondary(TSecondary)

Gets the status from the item

Declaration
public virtual string GetStatusFromItemSecondary(TSecondary item)
Parameters
Type Name Description
TSecondary item

Target item
Returns
Type Description
string
| Edit this page View Source

HandleExit()

Handles exiting the interactive TUI

Declaration
public virtual void HandleExit()

Implements