Class InteractiveTuiTools

Tools for the interactive TUI implementation

Inheritance

object

InteractiveTuiTools

Namespace

Terminaux.Inputs.Interactive @ Terminaux.dll

Syntax

public static class InteractiveTuiTools

Methods

FirstOnUnderflow<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary>)

Goes up to the first element upon underflow (caused by remove operation, ...). This applies to the first and the second pane.

Declaration

public static void FirstOnUnderflow<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary> interactiveTui)

Parameters

Name	Type	Description
interactiveTui	BaseInteractiveTui<TPrimary, TSecondary>

Type Parameters

Name	Description
TPrimary
TSecondary

LastOnOverflow<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary>)

Goes down to the last element upon overflow (caused by remove operation, ...). This applies to the first and the second pane.

Declaration

public static void LastOnOverflow<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary> interactiveTui)

Parameters

Name	Type	Description
interactiveTui	BaseInteractiveTui<TPrimary, TSecondary>

Type Parameters

Name	Description
TPrimary
TSecondary

OpenInteractiveTui<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary>)

Opens the interactive TUI

Declaration

public static void OpenInteractiveTui<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary> interactiveTui)

Parameters

Name	Type	Description
interactiveTui	BaseInteractiveTui<TPrimary, TSecondary>	The inherited class instance of the interactive TUI

Type Parameters

Name	Description
TPrimary
TSecondary

Exceptions

Type	Condition
TerminauxException

SelectionMovement<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary>, int)

Initiates the selection movement

Declaration

public static void SelectionMovement<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary> interactiveTui, int pos)

Parameters

Name	Type	Description
interactiveTui	BaseInteractiveTui<TPrimary, TSecondary>	Interactive TUI to deal with
pos	int	Position to move the pane selection to

Type Parameters

Name	Description
TPrimary
TSecondary

SelectionMovement<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary>, int, int)

Initiates the selection movement

Declaration

public static void SelectionMovement<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary> interactiveTui, int pos, int paneNum)

Parameters

Name	Type	Description
interactiveTui	BaseInteractiveTui<TPrimary, TSecondary>	Interactive TUI to deal with
pos	int	Position to move the pane selection to
paneNum	int	Pane number to process

Type Parameters

Name	Description
TPrimary
TSecondary

SwitchSides<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary>)

Switches between two panes

Declaration

public static void SwitchSides<TPrimary, TSecondary>(BaseInteractiveTui<TPrimary, TSecondary> interactiveTui)

Parameters

Name	Type	Description
interactiveTui	BaseInteractiveTui<TPrimary, TSecondary>	Interactive TUI to deal with

Type Parameters

Name	Description
TPrimary
TSecondary