Class Keybinding

Keybinding class

Inheritance

object

Keybinding

InteractiveTuiBinding<TPrimary, TSecondary>

Namespace: Terminaux.Writer.CyclicWriters.Renderer.Tools

Assembly: Terminaux.dll

Syntax

public class Keybinding

Constructors

Keybinding(string, ConsoleKey, bool)

Makes a new instance of a key binding

Declaration

public Keybinding(string bindingName, ConsoleKey bindingKeyName, bool hidden = false)

Parameters

Type	Name	Description
string	bindingName	Key binding name
ConsoleKey	bindingKeyName	Which key is bound to the action?
bool	hidden	Whether the key binding is hidden or not

Keybinding(string, ConsoleKey, ConsoleModifiers, bool)

Makes a new instance of a key binding

Declaration

public Keybinding(string bindingName, ConsoleKey bindingKeyName, ConsoleModifiers bindingKeyModifiers, bool hidden = 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 are bound to the action?
bool	hidden	Whether the key binding is hidden or not

Keybinding(string, PointerButton, bool)

Makes a new instance of a mouse pointer binding

Declaration

public Keybinding(string bindingName, PointerButton bindingPointerButton, bool hidden = false)

Parameters

Type	Name	Description
string	bindingName	Key binding name
PointerButton	bindingPointerButton	Which key is bound to the action?
bool	hidden	Whether the key binding is hidden or not

Keybinding(string, PointerButton, PointerButtonPress, bool)

Makes a new instance of a mouse pointer binding

Declaration

public Keybinding(string bindingName, PointerButton bindingPointerButton, PointerButtonPress bindingPointerButtonPress, bool hidden = 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?
bool	hidden	Whether the key binding is hidden or not

Keybinding(string, PointerButton, PointerButtonPress, PointerModifiers, bool)

Makes a new instance of a mouse pointer binding

Declaration

public Keybinding(string bindingName, PointerButton bindingPointerButton, PointerButtonPress bindingPointerButtonPress, PointerModifiers bindingButtonModifiers, bool hidden = 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 are bound to the action?
bool	hidden	Whether the key binding is hidden or not

Properties

BindingHidden

Whether the key binding is hidden or not

Declaration

public bool BindingHidden { get; }

Property Value

Type	Description
bool

BindingKeyModifiers

Which key modifiers are bound to the action?

Declaration

public ConsoleModifiers BindingKeyModifiers { get; }

Property Value

Type	Description
ConsoleModifiers

BindingKeyName

Which key is bound to the action?

Declaration

public ConsoleKey BindingKeyName { get; }

Property Value

Type	Description
ConsoleKey

BindingName

Key binding name

Declaration

public string BindingName { get; }

Property Value

Type	Description
string

BindingPointerButton

Which pointer button is bound to the action?

Declaration

public PointerButton BindingPointerButton { get; }

Property Value

Type	Description
PointerButton

BindingPointerButtonPress

Which pointer button press mode is bound to the action?

Declaration

public PointerButtonPress BindingPointerButtonPress { get; }

Property Value

Type	Description
PointerButtonPress

BindingPointerModifiers

Which pointer modifier is bound to the action?

Declaration

public PointerModifiers BindingPointerModifiers { get; }

Property Value

Type	Description
PointerModifiers

BindingUsesMouse

Whether the binding uses the mouse or the keyboard

Declaration

public bool BindingUsesMouse { get; }

Property Value

Type	Description
bool