Class KeySequenceResolver

Contains the definitions and implementations of input middlewares.

Inheritance

object

KeySequenceResolver

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Sharpie

Assembly: sharpie.dll

Syntax

public static class KeySequenceResolver

Methods

AltKeyResolver(IReadOnlyList<KeyEvent>)

Alt+character/key resolver middleware.

Declaration

public static (KeyEvent? key, int count) AltKeyResolver(IReadOnlyList<KeyEvent> sequence)

Parameters

Type	Name	Description
IReadOnlyList<KeyEvent>	sequence	The input sequence.

Returns

Type	Description
(KeyEvent key, int count)	The resolved key (if any) and the number of input events resolved. If the count is -1 it means nothing matches.

Remarks

This middleware converts characters in the form of ALT+.. to proper keys.

Exceptions

Type	Condition
ArgumentNullException	Thrown if sequence is null.

ControlKeyResolver(IReadOnlyList<KeyEvent>)

Control+character resolver middleware.

Declaration

public static (KeyEvent? key, int count) ControlKeyResolver(IReadOnlyList<KeyEvent> sequence)

Parameters

Type	Name	Description
IReadOnlyList<KeyEvent>	sequence	The input sequence.

Returns

Type	Description
(KeyEvent key, int count)	The resolved key (if any) and the number of input events resolved. If the count is -1 it means nothing matches.

Remarks

This middleware converts characters in the form of CTRL+.. to proper keys.

Exceptions

Type	Condition
ArgumentNullException	Thrown if sequence is null.

KeyPadModifiersResolver(IReadOnlyList<KeyEvent>)

Complex keypad resolver middleware.

Declaration

public static (KeyEvent? key, int count) KeyPadModifiersResolver(IReadOnlyList<KeyEvent> sequence)

Parameters

Type	Name	Description
IReadOnlyList<KeyEvent>	sequence	The input sequence.

Returns

Type	Description
(KeyEvent key, int count)	The resolved key (if any) and the number of input events resolved. If the count is -1 it means nothing matches.

Remarks

This middleware converts complex sequences such as CTRL/SHIFT/ALT+KeyPad to proper key representations.

Exceptions

Type	Condition
ArgumentNullException	Thrown if sequence is null.

SpecialCharacterResolver(IReadOnlyList<KeyEvent>)

Special character resolver middleware.

Declaration

public static (KeyEvent? key, int count) SpecialCharacterResolver(IReadOnlyList<KeyEvent> sequence)

Parameters

Type	Name	Description
IReadOnlyList<KeyEvent>	sequence	The input sequence.

Returns

Type	Description
(KeyEvent key, int count)	The resolved key (if any) and the number of input events resolved. If the count is -1 it means nothing matches.

Remarks

This middleware converts key such as \n, \t, escape and etc. to their key representations.

Exceptions

Type	Condition
ArgumentNullException	Thrown if sequence is null.