struct InputClick in Tinman.AddOns.Application

Wraps an input click (mouse or keyboard) with optional modifiers.

struct

InputClick

Remarks

The ToString method returns a human-readable shortcut title (using NameOf). If IsNone returns true, the shortcut title will be the empty string.

Public / Constants

None

Invalid input click (will never be triggered).

public static readonly field	None
type	InputClick

Public / Attributes

Button

The mouse button or None if this is a keyboard click.

public readonly field	Button
type	MouseButton

IsNone

Is this an invalid input click (see None)?

public property	IsNone { get }
type	bool
value		true if this is an invalid input click, false if it is valid.

Key

The keyboard key or None if this is a mouse click.

public readonly field	Key
type	KeyboardKey

Modifier

The click modifiers.

public readonly field	Modifier
type	InputModifiers

Public / Constructors

InputClick

Creates a new instance of InputClick.

public constructor	InputClick (MouseButton button, InputModifiers modifier = InputModifiers.None)
params	button		The mouse button.
	modifier		The input modifiers. Defaults to None).

---

Creates a new instance of InputClick.

public constructor	InputClick (KeyboardKey key, InputModifiers modifier = InputModifiers.None)
params	key		The keyboard key.
	modifier		The input modifiers. Defaults to None).

Public / Methods

Clicked

Is this input click triggered by the given input event?

public method	Clicked (InputEvent inputEvent)
type	bool
params	inputEvent		The input event.
returns			true if this input click is triggered, false if not.

ToString

public override method	ToString ()
type	string