package lambda-term

  1. Overview
  2. Docs
Terminal manipulation library for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (14)

Authors

  1. J
    Jérémie Dimino

Maintainers

  1. J
    jeremie@dimino.org

Sources

lambda-term-2.0.1.tbz
sha256=541cda520f42bc5551175e0d24ddec8724b9391d52da7c7253f7817972c49a5a
md5=4b4b8480fe1280e1ed2a34ed93d16675

doc/lambda-term/LTerm_read_line/class-term/index.html

Class LTerm_read_line.termSource

Class for read-line instances running in a terminal.

inherit 'a abstract
method run : 'a Lwt.t

Run this read-line instance.

method private exec : action list -> 'a Lwt.t

Executes a list of actions. Rememver to call Zed_macro.add self#macro action if you overload this method.

method bind : LTerm_key.t list -> action list -> unit
method draw_update : unit Lwt.t

Updates current display and put the cursor at current edition position.

method draw_success : unit Lwt.t

Draws after accepting current input.

method draw_failure : unit Lwt.t

Draws after an exception has been raised.

method prompt : prompt React.signal

The signal holding the prompt.

method set_prompt : prompt React.signal -> unit

Sets the prompt signal.

method size : LTerm_geom.size React.signal

The size of the terminal. This can be used for computing the prompt.

method key_sequence : LTerm_key.t list React.signal

The currently typed key sequence.

method completion_start : int React.signal

Index of the first displayed word in the completion bar.

method hide : unit Lwt.t

Hide this read-line instance. It remains invisible until show is called.

method show : unit Lwt.t

Show this read-line instance if it has been previously hidden.

val mutable visible : bool

Whether the instance is visible.

method create_temporary_file_for_external_editor : string

Create a temporary file and return its path. Used for editing input with an external command.

method external_editor : string

External editor command.