mirror of https://github.com/Hilbis/Hilbish
2.3 KiB
2.3 KiB
| title | description | layout | menu | ||||
|---|---|---|---|---|---|---|---|
| Module hilbish.editor | interactions for Hilbish's line reader | doc |
|
Introduction
The hilbish.editor interface provides functions to directly interact with the line editor in use.
Functions
| getLine() -> string | Returns the current input line. |
| getVimRegister(register) -> string | Returns the text that is at the register. |
| insert(text) | Inserts text into the Hilbish command line. |
| getChar() -> string | Reads a keystroke from the user. This is in a format of something like Ctrl-L. |
| setVimRegister(register, text) | Sets the vim register at register to hold the passed text. |
hilbish.editor.getLine() -> string
Returns the current input line.
Parameters
This function has no parameters.
hilbish.editor.getVimRegister(register) -> string
Returns the text that is at the register.
Parameters
string register
hilbish.editor.getChar() -> string
Reads a keystroke from the user. This is in a format of something like Ctrl-L.
Parameters
This function has no parameters.