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

Assembly: Terminaux.dll

Syntax

public class InteractiveTuiBinding<TPrimary, TSecondary> : Keybinding

Type Parameters

Name	Description
TPrimary
TSecondary

Constructors

| Edit this page View Source

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

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

| Edit this page View Source

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

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

| Edit this page View Source

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

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

| Edit this page View Source

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

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

| Edit this page View Source

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

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

Properties

| Edit this page View Source

BindingAction

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

Declaration

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

Property Value

Type	Description
Action<TPrimary, int, TSecondary, int>

| Edit this page View Source

BindingCanRunWithoutItems

Whether the binding can run without items or not

Declaration

public bool BindingCanRunWithoutItems { get; }

Property Value

Type	Description
bool

Methods

| Edit this page View Source

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

object.Equals(object)

| Edit this page View Source

Equals(InteractiveTuiBinding<TPrimary, TSecondary>?)

Declaration

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

Parameters

Type	Name	Description
InteractiveTuiBinding<TPrimary, TSecondary>	other

Returns

Type	Description
bool

| Edit this page View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Operators

| Edit this page View Source

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

Declaration

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

Parameters

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

Returns

Type	Description
bool

| Edit this page View Source

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

Declaration

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

Parameters

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

Returns

Type	Description
bool