ATAS.Indicators.Modules.PlatformModuleKeyEventArgs Class Reference

A key pressed or released while a PlatformModule has the keyboard focus. The same type is used in ATAS and ATAS X, so a module needs no WPF or Avalonia types. More...

Inheritance diagram for ATAS.Indicators.Modules.PlatformModuleKeyEventArgs:

Collaboration diagram for ATAS.Indicators.Modules.PlatformModuleKeyEventArgs:

Public Member Functions
	PlatformModuleKeyEventArgs (string key, RenderControlKeyModifiers modifiers)

Properties
string	Key [get]
	The name of the key as in the Key enumerations of WPF and Avalonia, which agree on it: "A"…<c>"Z", "D0"…<c>"D9" (digits of the main keyboard), "NumPad0"…, "F1"…, "Left", "Right", "Up", "Down", "Enter", "Escape", "Space", "Back", "Delete", "Tab", "Home", "End", "PageUp", "PageDown", "Add", "Subtract"…
RenderControlKeyModifiers	Modifiers [get]
	The modifier keys held down.
bool	Alt [get]
	True if Alt is held down.
bool	Control [get]
	True if Ctrl is held down.
bool	Shift [get]
	True if Shift is held down.
bool	Handled [get, set]
	Set to true if the module handled the key: the platform then does not process it further.

Detailed Description

A key pressed or released while a PlatformModule has the keyboard focus. The same type is used in ATAS and ATAS X, so a module needs no WPF or Avalonia types.

Constructor & Destructor Documentation

PlatformModuleKeyEventArgs()

ATAS.Indicators.Modules.PlatformModuleKeyEventArgs.PlatformModuleKeyEventArgs	(	string	key,
		RenderControlKeyModifiers	modifiers
	)

Property Documentation

Alt

bool ATAS.Indicators.Modules.PlatformModuleKeyEventArgs.Alt

get

True if Alt is held down.

Control

bool ATAS.Indicators.Modules.PlatformModuleKeyEventArgs.Control

get

True if Ctrl is held down.

Handled

bool ATAS.Indicators.Modules.PlatformModuleKeyEventArgs.Handled

getset

Set to true if the module handled the key: the platform then does not process it further.

Key

string ATAS.Indicators.Modules.PlatformModuleKeyEventArgs.Key

get

The name of the key as in the Key enumerations of WPF and Avalonia, which agree on it: "A"…<c>"Z", "D0"…<c>"D9" (digits of the main keyboard), "NumPad0"…, "F1"…, "Left", "Right", "Up", "Down", "Enter", "Escape", "Space", "Back", "Delete", "Tab", "Home", "End", "PageUp", "PageDown", "Add", "Subtract"…

Modifiers

RenderControlKeyModifiers ATAS.Indicators.Modules.PlatformModuleKeyEventArgs.Modifiers

get

The modifier keys held down.

Shift

bool ATAS.Indicators.Modules.PlatformModuleKeyEventArgs.Shift

get

True if Shift is held down.

---

The documentation for this class was generated from the following file:

• PlatformModuleKeyEventArgs.cs