1 files changed, 31 insertions, 0 deletions
diff --git a/screen.mli b/screen.mli
new file mode 100755
index 0000000..a6a33dc
--- /dev/null
+++ b/screen.mli
@@ -0,0 +1,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