Class InputEncoder
Encodes user input as the byte sequences a host expects from a VT or xterm keyboard and mouse.
Assembly: DarkEffekt.Terminal.Core
Section titled “Assembly: DarkEffekt.Terminal.Core”public static class InputEncoderMethods
Section titled “Methods”Text(string)
Section titled “Text(string)”public static byte[] Text(string text)Returns
Section titled “Returns”System.Byte[]
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.String |
text |
Text(string, TermModifiers)
Section titled “Text(string, TermModifiers)”Typed text with Alt applied as an ESC prefix. Ctrl has no meaning for it.
public static byte[] Text(string text, TermModifiers mods)Returns
Section titled “Returns”System.Byte[]
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.String |
text |
| DarkEffekt.Terminal.TermModifiers | mods |
Char(char, TermModifiers)
Section titled “Char(char, TermModifiers)”A printable character with modifiers applied: Ctrl folds letters into C0, Alt prefixes ESC.
public static byte[] Char(char c, TermModifiers mods)Returns
Section titled “Returns”System.Byte[]
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.Char |
c |
| DarkEffekt.Terminal.TermModifiers | mods |
Key(TermKey, TermModifiers, bool)
Section titled “Key(TermKey, TermModifiers, bool)”public static byte[] Key(TermKey key, TermModifiers mods, bool applicationCursorKeys)Returns
Section titled “Returns”System.Byte[]
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
| DarkEffekt.Terminal.TermKey | key |
| DarkEffekt.Terminal.TermModifiers | mods |
System.Boolean |
applicationCursorKeys |
Key(TermKey, TermModifiers, in KeyboardModes)
Section titled “Key(TermKey, TermModifiers, in KeyboardModes)”A key under the host’s keyboard modes.
public static byte[] Key(TermKey key, TermModifiers mods, in KeyboardModes modes)Returns
Section titled “Returns”System.Byte[]
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
| DarkEffekt.Terminal.TermKey | key |
| DarkEffekt.Terminal.TermModifiers | mods |
| DarkEffekt.Terminal.KeyboardModes | modes |
Paste(string, bool)
Section titled “Paste(string, bool)”Wraps pasted text per bracketed paste mode when the host asked for it.
public static byte[] Paste(string text, bool bracketed)Returns
Section titled “Returns”System.Byte[]
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
System.String |
text |
System.Boolean |
bracketed |
Mouse(TermMouseButton, bool, bool, int, int, TermModifiers, MouseTrackingMode, MouseEncoding)
Section titled “Mouse(TermMouseButton, bool, bool, int, int, TermModifiers, MouseTrackingMode, MouseEncoding)”Encodes a mouse event. Column and row are zero-based; the wire format is one-based. Returns an empty array when the event should not be reported under the given tracking mode.
public static byte[] Mouse(TermMouseButton button, bool press, bool motion, int col, int row, TermModifiers mods, MouseTrackingMode tracking, MouseEncoding encoding)Returns
Section titled “Returns”System.Byte[]
Parameters
Section titled “Parameters”| Type | Name |
|---|---|
| DarkEffekt.Terminal.TermMouseButton | button |
System.Boolean |
press |
System.Boolean |
motion |
System.Int32 |
col |
System.Int32 |
row |
| DarkEffekt.Terminal.TermModifiers | mods |
| DarkEffekt.Terminal.MouseTrackingMode | tracking |
| DarkEffekt.Terminal.MouseEncoding | encoding |