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 (12)

Authors

J

Jérémie Dimino

Maintainers

Z

ZAN DoYe <zandoye+ocaml@gmail.com>

Sources

3.3.2.tar.gz

sha512=78648768644058337e22c79cf1fbb1a36472b24f11b1dc0461fc38419be6ec01b02d8d0ac45fed0bc99f91ba4c0f19d3bda113e834e064bee973b734527b9766

doc/lambda-term/LTerm_ui/index.html

Module `LTerm_ui`Source

High level function for writing full-screen applications

Sourcetype t

Type of a user interface.

Source

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.

Sourceval quit : t -> unit Lwt.t

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

Sourceval 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.

Sourceval draw : t -> unit

draw ui enqueue a draw operation for the given UI.

Sourceval cursor_visible : t -> bool

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

Sourceval set_cursor_visible : t -> bool -> unit

set_cursor_visible ui visible sets the cursor visible state.

Sourceval cursor_position : t -> LTerm_geom.coord

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

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

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

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

wait ui wait for an event.