mirror of
https://github.com/sammy-ette/Hilbish
synced 2025-08-10 02:52:03 +00:00
sammyette
7c1984135b
there are a few changes here - documentation of each parameter separately has been added to the generated text docs - interfaces have been renamed to modules. this was honestly a pointless and confusing distinction (interfaces are tables for modules that are lua modules). it also makes it so that (formerly) interfaces and modules line up with each other on the doc list im not sure what else i did, these are old changes
35 lines
808 B
Markdown
35 lines
808 B
Markdown
---
|
|
title: Module hilbish.editor
|
|
description: interactions for Hilbish's line reader
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "API"
|
|
---
|
|
|
|
## Introduction
|
|
The hilbish.editor interface provides functions to
|
|
directly interact with the line editor in use.
|
|
|
|
## Functions
|
|
### 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
|
|
This function has no parameters.
|
|
|
|
### hilbish.editor.insert(text)
|
|
Inserts text into the line.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
|
|
### hilbish.editor.setVimRegister(register, text)
|
|
Sets the vim register at `register` to hold the passed text.
|
|
#### Parameters
|
|
This function has no parameters.
|
|
|