package lambda-term

You can search for identifiers within the package.

in-package search v0.2.0

Terminal manipulation library for OCaml

Install

dune-project

Dependency

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

Authors

J

Jérémie Dimino

Maintainers

J

jeremie@dimino.org

Sources

lambda-term-3.2.0.tar.gz

md5=68a44ac4a5c643cf48ea927c073b4428

sha512=46cd46f47c9f34c0a5e096b96e6eec59667b645bf5201140e498e6d4eb9baba8204a2b30b73c4b2f8140e5cf1972a56e3aa485b27bc5ace25b2c368f713ad7c4

doc/lambda-term/LTerm_ui/index.html

Module `LTerm_ui`

High level function for writing full-screen applications

type t

Type of a user interface.

val create : 
  LTerm.t ->
  ?save_state:bool ->
  (t -> LTerm_draw.matrix -> unit) ->
  t Lwt.t

create term ?save_state draw creates a new user interface. draw is used to draw the user interface. If save_state is true (the default) then the state of the terminal is saved.

val quit : t -> unit Lwt.t

quit () quit the given ui and restore the terminal state.

val size : t -> LTerm_geom.size

size ui returns the current size of the terminal used by the given user-interface. It is updated by wait.

val draw : t -> unit

draw ui enqueue a draw operation for the given UI.

val cursor_visible : t -> bool

cursor_visible ui returns true if the cursor is displayed in the UI. It is initially not visible.

val set_cursor_visible : t -> bool -> unit

set_cursor_visible ui visible sets the cursor visible state.

val cursor_position : t -> LTerm_geom.coord

cursor_position ui returns the position of the cursor inside the UI.

val set_cursor_position : t -> LTerm_geom.coord -> unit

set_cursor_position ui coord sets the position of the cursor inside the UI.

val wait : t -> LTerm_event.t Lwt.t

wait ui wait for an event.