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

type screen

(** Initialise thee screen *)
val init: unit -> screen

val close: screen -> unit

(** {2 Screen updates} *)

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

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

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

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

(** {2 User inputs} *)

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

val search: screen -> UTF8.t

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

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