/usr/lib/ocaml/lambda-term/lTerm_ui.mli is in liblambda-term-ocaml-dev 1.9-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | (*
* lTerm_ui.mli
* ------------
* Copyright : (c) 2011, Jeremie Dimino <jeremie@dimino.org>
* Licence : BSD3
*
* This file is a part of Lambda-Term.
*)
(** 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. *)
|