package inquire

You can search for identifiers within the package.

in-package search v0.2.0

An OCaml library to create beautiful interactive CLIs

Install

Dune Dependency

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

Authors

Thibaut Mattio

Maintainers

Thibaut Mattio

Sources

inquire-0.2.1.tbz

sha256=0b88d89e24d4cbc0560a7c8d8ec51388990e1b27f24685029997afa52a7c720f

sha512=8b62860a8d15e41528a404a6f1b9968c3d79755607b5ea319af2e3e45516e672a785361d278279910928db4054e1800e87bcee0210ff3eabfb330713b368c827

doc/inquire.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.