Module hilbish.editor

Sidebar

  • Vim Mode
  • Completions
  • Lunacolors
  • Frequently Asked Questions
  • Getting Started
  • Introduction
  • Module fs
  • Module snail
  • Module terminal
  • Module commander
  • API
  • Module bait
  • Module hilbish.module
  • Module hilbish.abbr
  • Module hilbish.userDir
  • Module hilbish.os
  • Module hilbish.history
  • Module hilbish.completion
  • Module hilbish.messages
  • Module hilbish.aliases
  • Module hilbish.runner
  • Module hilbish.timers
  • Module hilbish
  • Module hilbish.jobs
  • Module hilbish.editor
  • Actions
  • Module doc
  • Nature
  • Module dirs
  • Hilbish
  • Command
  • Signals
  • Signal
  • Notification
  • Runner Mode
  • Options
  • Features

Module hilbish.editor

Introduction

The hilbish.editor interface provides functions to directly interact with the line editor in use.

Functions

deleteByAmount(amount) Deletes characters in the line by the given amount.
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.deleteByAmount(amount)

Deletes characters in the line by the given amount.

Parameters

number amount


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.insert(text)

Inserts text into the Hilbish command line.

Parameters

string text


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.


hilbish.editor.setVimRegister(register, text)

Sets the vim register at register to hold the passed text.

Parameters

string register

string text