Class Input

Input management tools

Inheritance

object

Input

Namespace: Terminaux.Inputs

Assembly: Terminaux.dll

Syntax

public static class Input

Properties

| Edit this page View Source

BassBoomLibraryPath

Root path to BassBoom's library path

Declaration

public static string BassBoomLibraryPath { get; set; }

Property Value

Type	Description
string

| Edit this page View Source

CueEnter

A stream for the submission key press keyboard cue

Declaration

public static Stream CueEnter { get; set; }

Property Value

Type	Description
Stream

| Edit this page View Source

CueRubout

A stream for the backspace key press keyboard cue

Declaration

public static Stream CueRubout { get; set; }

Property Value

Type	Description
Stream

| Edit this page View Source

CueVolume

Keyboard cue volume

Declaration

public static double CueVolume { get; set; }

Property Value

Type	Description
double

| Edit this page View Source

CueVolumeBoost

Whether to boost cue volume up to 3.0 or not

Declaration

public static bool CueVolumeBoost { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

CueWrite

A stream for the key press keyboard cue

Declaration

public static Stream CueWrite { get; set; }

Property Value

Type	Description
Stream

| Edit this page View Source

DoubleClickTimeout

Specifies the time in milliseconds whether the double click times out

Declaration

public static TimeSpan DoubleClickTimeout { get; set; }

Property Value

Type	Description
TimeSpan

| Edit this page View Source

EnableMouse

Whether to enable mouse support.

Declaration

public static bool EnableMouse { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

EnableMovementEvents

Checks to see whether the movement events are enabled or not

Declaration

public static bool EnableMovementEvents { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

InvertScrollYAxis

Whether to invert the Y axis for scrolling or not.

Declaration

public static bool InvertScrollYAxis { get; set; }

Property Value

Type	Description
bool

Remarks

If this option is enabled, scrolling up emits the scroll down event, and scrolling down emits the scroll up event. Otherwise, scrolling up emits the scroll up event, and scrolling down emits the scroll down event.

| Edit this page View Source

KeyboardCues

Play keyboard cues for each keypress (a global switch)

Declaration

public static bool KeyboardCues { get; set; }

Property Value

Type	Description
bool

| Edit this page View Source

PasswordMaskChar

Password mask character

Declaration

public static char PasswordMaskChar { get; set; }

Property Value

Type	Description
char

| Edit this page View Source

PointerActive

Checks to see whether the pointer is active or not

Declaration

public static bool PointerActive { get; }

Property Value

Type	Description
bool

| Edit this page View Source

PointerEncoding

Selects a pointer encoding to use when receiving a raw mouse event

Declaration

public static PointerEncoding PointerEncoding { get; set; }

Property Value

Type	Description
PointerEncoding

Remarks

While the SGR encoding provides extended position attributes, X10 is more compatible but limited.

| Edit this page View Source

SwapLeftRightButtons

Whether to invert the left and the right mouse buttons for left-handed people or not.

Declaration

public static bool SwapLeftRightButtons { get; set; }

Property Value

Type	Description
bool

Remarks

This is suitable for left-handed people (i.e. you use your mouse in your left hand). If this option is enabled, clicking on the left button of your mouse emits the right click event, and clicking on the right button of your mouse emits the left click event. Otherwise, clicking on the left button of your mouse emits the left click event, and clicking on the right button of your mouse emits the right click event.

Methods

| Edit this page View Source

InvalidateInput()

Invalidates the input

Declaration

public static void InvalidateInput()

| Edit this page View Source

ReadKey()

Reads the next key from the console input stream

Declaration

public static ConsoleKeyInfo ReadKey()

Returns

Type	Description
ConsoleKeyInfo

| Edit this page View Source

ReadKeyTimeout(TimeSpan)

Reads the next key from the console input stream with the timeout

Declaration

public static (ConsoleKeyInfo result, bool provided) ReadKeyTimeout(TimeSpan Timeout)

Parameters

Type	Name	Description
TimeSpan	Timeout	Timeout

Returns

Type	Description
(ConsoleKeyInfo result, bool provided)

| Edit this page View Source

ReadPointerOrKey(InputEventType)

Reads either a pointer or a key (blocking)

Declaration

public static InputEventInfo ReadPointerOrKey(InputEventType eventType = InputEventType.Mouse | InputEventType.Keyboard)

Parameters

Type	Name	Description
InputEventType	eventType	Event types to wait for (None implies all events)

Returns

Type	Description
InputEventInfo

| Edit this page View Source

ReadPointerOrKeyNoBlock(InputEventType)

Reads either a pointer or a key (non-blocking)

Declaration

public static InputEventInfo ReadPointerOrKeyNoBlock(InputEventType eventType = InputEventType.Mouse | InputEventType.Keyboard)

Parameters

Type	Name	Description
InputEventType	eventType	Event types to wait for (None implies all events)

Returns

Type	Description
InputEventInfo