aboutsummaryrefslogtreecommitdiff
path: root/screen.mli
blob: b5f74b2c1f27c0635ed434105757e3f006c5890b (plain)
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
(** Represent the {!module:Sheet} *)

type t

(** Run the screen *)
val run: (t -> 'a) -> 'a

(** {2 Screen updates} *)

val draw: Sheet.t -> t -> t

val draw_input: Sheet.t -> t -> t

val resize: Sheet.t -> t -> t 

(** Display a message in the status bar. *)
val status: t -> UTF8.t -> unit

(** {2 User inputs} *)

(** Wait for a keycode *)
val read_key : t -> string
(** The keycode is always NULL terminated *)

val search: t -> UTF8.t

val get_cell: t -> int * int -> (int * int) option

val editor: ?position: int * int -> ?prefix:UTF8.t -> ?init:UTF8.t -> t -> UTF8.t option