package lambda-term

  1. Overview
  2. Docs
Terminal manipulation library for OCaml

Install 

dune-project
 Dependency

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

Authors

  1. J
    Jérémie Dimino

Maintainers

  1. J
    jeremie@dimino.org

Sources

3.0.0.tar.gz
sha256=65e16c9a52fa03a6b3a3772566414b0d35cadceac3f244301ef56dad4c6ccc18
md5=3ee0d8b6cb31f20a07fcbf34990f8a4b

doc/lambda-term/LTerm_ui/index.html

Module LTerm_uiSource

High level function for writing full-screen applications

Sourcetype t

Type of a user interface.

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

wait ui wait for an event.