Class InteractiveTuiBinding<TPrimary, TSecondary>

Interactive TUI binding information class

Inheritance

object

Keybinding

InteractiveTuiBinding<TPrimary, TSecondary>

InteractiveTuiBinding<T>

Inherited Members

Keybinding.BindingName

Keybinding.BindingUsesMouse

Keybinding.BindingHidden

Keybinding.BindingKeyName

Keybinding.BindingKeyModifiers

Keybinding.BindingPointerButton

Keybinding.BindingPointerButtonPress

Keybinding.BindingPointerModifiers

Namespace

Terminaux.Inputs.Interactive @ Terminaux.dll

Syntax

public class InteractiveTuiBinding<TPrimary, TSecondary> : Keybinding

Type Parameters

Name	Description
TPrimary
TSecondary

Constructors

InteractiveTuiBinding(string, ConsoleKey, Action<TPrimary?, int, TSecondary?, int>?, bool)

Makes a new instance of an interactive TUI key binding

Declaration

public InteractiveTuiBinding(string bindingName, ConsoleKey bindingKeyName, Action<TPrimary?, int, TSecondary?, int>? bindingAction, bool canRunWithoutItems = false)

Parameters

Name	Type	Description
bindingName	string	Key binding name
bindingKeyName	ConsoleKey	Which key is bound to the action?
bindingAction	Action<TPrimary, int, TSecondary, int>	The action to execute. The object argument denotes the currently selected item, and the integer argument denotes the currently selected data
canRunWithoutItems	bool	Whether the binding can run without items or not

InteractiveTuiBinding(string, ConsoleKey, ConsoleModifiers, Action<TPrimary?, int, TSecondary?, int>?, bool)

Makes a new instance of an interactive TUI key binding

Declaration

public InteractiveTuiBinding(string bindingName, ConsoleKey bindingKeyName, ConsoleModifiers bindingKeyModifiers, Action<TPrimary?, int, TSecondary?, int>? bindingAction, bool canRunWithoutItems = false)

Parameters

Name	Type	Description
bindingName	string	Key binding name
bindingKeyName	ConsoleKey	Which key is bound to the action?
bindingKeyModifiers	ConsoleModifiers	Which modifiers of the key is bound to the action?
bindingAction	Action<TPrimary, int, TSecondary, int>	The action to execute. The object argument denotes the currently selected item, and the integer argument denotes the currently selected data
canRunWithoutItems	bool	Whether the binding can run without items or not

InteractiveTuiBinding(string, PointerButton, Action<TPrimary?, int, TSecondary?, int>?, bool)

Makes a new instance of an interactive TUI mouse pointer binding

Declaration

public InteractiveTuiBinding(string bindingName, PointerButton bindingPointerButton, Action<TPrimary?, int, TSecondary?, int>? bindingAction, bool canRunWithoutItems = false)

Parameters

Name	Type	Description
bindingName	string	Key binding name
bindingPointerButton	PointerButton	Which key is bound to the action?
bindingAction	Action<TPrimary, int, TSecondary, int>	The action to execute. The object argument denotes the currently selected item, and the integer argument denotes the currently selected data
canRunWithoutItems	bool	Whether the binding can run without items or not

InteractiveTuiBinding(string, PointerButton, PointerButtonPress, Action<TPrimary?, int, TSecondary?, int>?, bool)

Makes a new instance of an interactive TUI mouse pointer binding

Declaration

public InteractiveTuiBinding(string bindingName, PointerButton bindingPointerButton, PointerButtonPress bindingPointerButtonPress, Action<TPrimary?, int, TSecondary?, int>? bindingAction, bool canRunWithoutItems = false)

Parameters

Name	Type	Description
bindingName	string	Key binding name
bindingPointerButton	PointerButton	Which button is bound to the action?
bindingPointerButtonPress	PointerButtonPress	Which press mode of the button is bound to the action?
bindingAction	Action<TPrimary, int, TSecondary, int>	The action to execute. The object argument denotes the currently selected item, and the integer argument denotes the currently selected data
canRunWithoutItems	bool	Whether the binding can run without items or not

InteractiveTuiBinding(string, PointerButton, PointerButtonPress, PointerModifiers, Action<TPrimary?, int, TSecondary?, int>?, bool)

Makes a new instance of an interactive TUI mouse pointer binding

Declaration

public InteractiveTuiBinding(string bindingName, PointerButton bindingPointerButton, PointerButtonPress bindingPointerButtonPress, PointerModifiers bindingButtonModifiers, Action<TPrimary?, int, TSecondary?, int>? bindingAction, bool canRunWithoutItems = false)

Parameters

Name	Type	Description
bindingName	string	Key binding name
bindingPointerButton	PointerButton	Which button is bound to the action?
bindingPointerButtonPress	PointerButtonPress	Which press mode of the button is bound to the action?
bindingButtonModifiers	PointerModifiers	Which modifiers of the button is bound to the action?
bindingAction	Action<TPrimary, int, TSecondary, int>	The action to execute. The object argument denotes the currently selected item, and the integer argument denotes the currently selected data
canRunWithoutItems	bool	Whether the binding can run without items or not

Properties

BindingAction

The action to execute. The integer argument denotes the currently selected data

Property Value

Action<TPrimary, int, TSecondary, int>

Declaration

public Action<TPrimary?, int, TSecondary?, int>? BindingAction { get; }

BindingCanRunWithoutItems

Whether the binding can run without items or not

Property Value

bool

Declaration

public bool BindingCanRunWithoutItems { get; }

Methods

Equals(object?)

Returns

bool

Declaration

public override bool Equals(object? obj)

Parameters

Name	Type	Description
obj	object

Overrides

object.Equals(object)

Equals(InteractiveTuiBinding<TPrimary, TSecondary>?)

Returns

bool

Declaration

public bool Equals(InteractiveTuiBinding<TPrimary, TSecondary>? other)

Parameters

Name	Type	Description
other	InteractiveTuiBinding<TPrimary, TSecondary>

GetHashCode()

Returns

int

Declaration

public override int GetHashCode()

Overrides

object.GetHashCode()

Operators

operator ==(InteractiveTuiBinding<TPrimary, TSecondary>?, InteractiveTuiBinding<TPrimary, TSecondary>?)

Returns

bool

Declaration

public static bool operator ==(InteractiveTuiBinding<TPrimary, TSecondary>? left, InteractiveTuiBinding<TPrimary, TSecondary>? right)

Parameters

Name	Type	Description
left	InteractiveTuiBinding<TPrimary, TSecondary>
right	InteractiveTuiBinding<TPrimary, TSecondary>

operator !=(InteractiveTuiBinding<TPrimary, TSecondary>?, InteractiveTuiBinding<TPrimary, TSecondary>?)

Returns

bool

Declaration

public static bool operator !=(InteractiveTuiBinding<TPrimary, TSecondary>? left, InteractiveTuiBinding<TPrimary, TSecondary>? right)

Parameters

Name	Type	Description
left	InteractiveTuiBinding<TPrimary, TSecondary>
right	InteractiveTuiBinding<TPrimary, TSecondary>