File: output.md

package info (click to toggle)
plover 5.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 14,356 kB
  • sloc: python: 21,589; sh: 682; ansic: 25; makefile: 11
file content (29 lines) | stat: -rw-r--r-- 935 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# `plover.output` -- Text output handling

```{py:module} plover.output

```

This module provides a skeleton for customizable text output. By default,
Plover only outputs steno translations through keyboard emulation, but through
the output plugin mechanism it can also be made to output through other
means, such as writing to a file or sending it over the network.

````{class} Output

Encapsulates logic for sending keystrokes. Pass an instance of this to
the {class}`StenoEngine<plover.engine.StenoEngine>` when it is initialized.

```{method} send_backspaces(number_of_backspaces: int)
Sends the specified number of backspace keys.
```

```{method} send_string(s: str)
Sends the sequence of keys that would produce the specified string.
```

```{method} send_key_combination(combo_string: str)
Sends the specified key combination. `combo_string` is a string in the
key combo format described in {mod}`plover.key_combo`.
```
````