module Curses:sig..end
Beware, all coordinates are passed y first, then x.
Functions whose name start with a "w" take as first argument the window the
function applies to.
Functions whose name start with "mv" take as first two arguments the
coordinates y and x of the point to move the cursor to. For example
mvaddch y x ch is the same as move y x; addch ch.
type window
type screen
type terminal
typechtype =int
chtype using
char_of_int and int_of_char. See also get_acs_codes for characters
useful for drawing and the Key module for special input characters.typeattr_t =int
lorings of flags which are defined in the A module.typeerr =bool
false means that an error occured.val initscr : unit -> windowval endwin : unit -> unitval isendwin : unit -> boolendwin been called without any subsequent call to werefresh?val newterm : string -> Unix.file_descr -> Unix.file_descr -> screenval set_term : screen -> unitval delscreen : screen -> unitval stdscr : unit -> windowval getyx : window -> int * intval getparyx : window -> int * intval getbegyx : window -> int * intval getmaxyx : window -> int * intval move : int -> int -> errval wmove : window -> int -> int -> errmodule Acs:sig..end
val get_acs_codes : unit -> Acs.acsval addch : chtype -> errval waddch : window -> chtype -> errval mvaddch : int -> int -> chtype -> errval mvwaddch : window -> int -> int -> chtype -> errval echochar : chtype -> errechochar ch is equivalent to addch ch followed by refresh ().val wechochar : window -> chtype -> errval addchstr : chtype array -> erraddstr.val waddchstr : window -> chtype array -> errval mvaddchstr : int -> int -> chtype array -> errval mvwaddchstr : window -> int -> int -> chtype array -> errval addchnstr : chtype array -> int -> int -> errval waddchnstr : window -> chtype array -> int -> int -> errval mvaddchnstr : int -> int -> chtype array -> int -> int -> errval mvwaddchnstr : window ->
int -> int -> chtype array -> int -> int -> errval addstr : string -> errval waddstr : window -> string -> errval mvaddstr : int -> int -> string -> errval mvwaddstr : window -> int -> int -> string -> errval addnstr : string -> int -> int -> errval waddnstr : window -> string -> int -> int -> errval mvaddnstr : int -> int -> string -> int -> int -> errval mvwaddnstr : window -> int -> int -> string -> int -> int -> errval insch : chtype -> errval winsch : window -> chtype -> errval mvinsch : int -> int -> chtype -> errval mvwinsch : window -> int -> int -> chtype -> errval insstr : string -> errval winsstr : window -> string -> errval mvinsstr : int -> int -> string -> errval mvwinsstr : window -> int -> int -> string -> errval insnstr : string -> int -> int -> errval winsnstr : window -> string -> int -> int -> errval mvinsnstr : int -> int -> string -> int -> int -> errval mvwinsnstr : window -> int -> int -> string -> int -> int -> errval delch : unit -> errval wdelch : window -> errval mvdelch : int -> int -> errval mvwdelch : window -> int -> int -> errmodule A:sig..end
module WA:sig..end
val attroff : int -> unitA module).val wattroff : window -> int -> unitval attron : int -> unitval wattron : window -> int -> unitval attrset : int -> unitval wattrset : window -> int -> unitval standend : unit -> unitval wstandend : window -> unitval standout : unit -> unitval wstandout : window -> unitval attr_off : attr_t -> unitWA module).val wattr_off : window -> attr_t -> unitval attr_on : attr_t -> unitval wattr_on : window -> attr_t -> unitval attr_set : attr_t -> int -> unitval wattr_set : window -> attr_t -> int -> unitval chgat : int -> attr_t -> int -> unitchgat n attr color changes the attributes of n characters.val wchgat : window -> int -> attr_t -> int -> unitval mvchgat : int -> int -> int -> attr_t -> int -> unitval mvwchgat : window -> int -> int -> int -> attr_t -> int -> unitval inch : unit -> chtypeval winch : window -> chtypeval mvinch : int -> int -> chtypeval mvwinch : window -> int -> int -> chtypeval inchstr : chtype array -> errval winchstr : window -> chtype array -> errval mvinchstr : int -> int -> chtype array -> errval mvwinchstr : window -> int -> int -> chtype array -> errval inchnstr : chtype array -> int -> int -> errval winchnstr : window -> chtype array -> int -> int -> errval mvinchnstr : int -> int -> chtype array -> int -> int -> errval mvwinchnstr : window ->
int -> int -> chtype array -> int -> int -> errval instr : string -> errval winstr : window -> string -> errval mvinstr : int -> int -> string -> errval mvwinstr : window -> int -> int -> string -> errval innstr : string -> int -> int -> errval winnstr : window -> string -> int -> int -> errval mvinnstr : int -> int -> string -> int -> int -> errval mvwinnstr : window -> int -> int -> string -> int -> int -> errval bkgdset : chtype -> unitval wbkgdset : window -> chtype -> unitval bkgd : chtype -> unitval wbkgd : window -> chtype -> unitval getbkgd : window -> chtypeval deleteln : unit -> errval wdeleteln : window -> errval insdelln : int -> errinsdelln n inserts n lines above the current line if n is positive or
deletes -n lines if n is negative.val winsdelln : window -> int -> errval insertln : unit -> errval winsertln : window -> errmodule Key:sig..end
val getch : unit -> intval wgetch : window -> intval mvgetch : int -> int -> intval mvwgetch : window -> int -> int -> intval ungetch : int -> errval getstr : string -> errval wgetstr : window -> string -> errval mvgetstr : int -> int -> string -> errval mvwgetstr : window -> int -> int -> string -> errval getnstr : string -> int -> int -> errval wgetnstr : window -> string -> int -> int -> errval mvgetnstr : int -> int -> string -> int -> int -> errval mvwgetnstr : window -> int -> int -> string -> int -> int -> errval newwin : int -> int -> int -> int -> windownewwin l c y x create a new window with l lines, c columns. The upper
left-hand corner is at (x,y).val delwin : window -> errval mvwin : window -> int -> int -> errval subwin : window -> int -> int -> int -> int -> windowsubwin l c y x create a subwindow with l lines and c columns at
screen-relative position (x,y).val derwin : window -> int -> int -> int -> int -> windowsubwin excepting that the position (x,y) is relative to the
parent window.val mvderwin : window -> int -> int -> errval dupwin : window -> windowval wsyncup : window -> unitval syncok : window -> bool -> errsyncok is called with true as second argument, wsyncup is called
automatically whenever there is a change in the window.val wcursyncup : window -> unitval wsyncdown : window -> unitval winch_handler_on : unit -> unitval winch_handler_off : unit -> unitval get_size : unit -> int * intval get_size_fd : Unix.file_descr -> int * intval null_window : windowval refresh : unit -> errval wrefresh : window -> errval wnoutrefresh : window -> errval doupdate : unit -> errval redrawwin : window -> errval wredrawln : window -> int -> int -> errval wresize : window -> int -> int -> errval resizeterm : int -> int -> errval scroll : window -> errval scrl : int -> errval wscrl : window -> int -> errval touchwin : window -> errval touchline : window -> int -> int -> errval untouchwin : window -> errval wtouchln : window -> int -> int -> bool -> errval is_linetouched : window -> int -> intval is_wintouched : window -> boolval erase : unit -> unitval werase : window -> unitval clear : unit -> unitval wclear : window -> unitval clrtobot : unit -> unitval wclrtobot : window -> unitval clrtoeol : unit -> unitval wclrtoeol : window -> unitval overlay : window -> window -> erroverlay srcwin dstwin overlays srcwin on top of dstwin.val overwrite : window -> window -> errval copywin : window ->
window -> int -> int -> int -> int -> int -> int -> bool -> errval border : chtype ->
chtype ->
chtype ->
chtype ->
chtype -> chtype -> chtype -> chtype -> unitval wborder : window ->
chtype ->
chtype ->
chtype ->
chtype ->
chtype -> chtype -> chtype -> chtype -> unitval box : window -> chtype -> chtype -> unitval hline : chtype -> int -> unitval whline : window -> chtype -> int -> unitval mvhline : int -> int -> chtype -> int -> unitval mvwhline : window -> int -> int -> chtype -> int -> unitval vline : chtype -> int -> unitval wvline : window -> chtype -> int -> unitval mvvline : int -> int -> chtype -> int -> unitval mvwvline : window -> int -> int -> chtype -> int -> unitval newpad : int -> int -> windowval subpad : window -> int -> int -> int -> int -> windowval prefresh : window -> int -> int -> int -> int -> int -> int -> errval pnoutrefresh : window -> int -> int -> int -> int -> int -> int -> errval pechochar : window -> chtype -> errmodule Color:sig..end
val start_color : unit -> errval use_default_colors : unit -> errval init_pair : int -> int -> int -> errval init_color : int -> int -> int -> int -> errval has_colors : unit -> boolval can_change_color : unit -> boolval color_content : int -> int * int * intval pair_content : int -> int * intval colors : unit -> intval color_pairs : unit -> intval cbreak : unit -> errval halfdelay : int -> errcbreak but with delay.val nocbreak : unit -> errval echo : unit -> errval noecho : unit -> errval intrflush : window -> bool -> errval keypad : window -> bool -> errval meta : window -> bool -> errval nodelay : window -> bool -> errval raw : unit -> errval noraw : unit -> errval noqiflush : unit -> unitval qiflush : unit -> unitval notimeout : window -> bool -> errval timeout : int -> unitval wtimeout : window -> int -> unitval typeahead : Unix.file_descr -> errval notypeahead : unit -> errval clearok : window -> bool -> unittrue as second argument, the next call to wrefresh with
this window will clear the streen completely and redraw the entire screen
from scratch.val idlok : window -> bool -> unitval idcok : window -> bool -> unitval immedok : window -> bool -> unitval leaveok : window -> bool -> unitval setscrreg : int -> int -> errval wsetscrreg : window -> int -> int -> errval scrollok : window -> bool -> unitval nl : unit -> unitval nonl : unit -> unitval slk_init : int -> errval slk_set : int -> string -> int -> errval slk_refresh : unit -> errval slk_noutrefresh : unit -> errval slk_label : int -> stringval slk_clear : unit -> errval slk_restore : unit -> errval slk_touch : unit -> errval slk_attron : attr_t -> errval slk_attroff : attr_t -> errval slk_attrset : attr_t -> errval mousemask : int -> int * intval beep : unit -> errval flash : unit -> errval unctrl : chtype -> stringval keyname : int -> stringval filter : unit -> unitval use_env : bool -> unitval putwin : window -> Unix.file_descr -> errval getwin : Unix.file_descr -> windowval delay_output : int -> errval flushinp : unit -> unitval scr_dump : string -> errval scr_restore : string -> errval scr_init : string -> errval scr_set : string -> errval baudrate : unit -> intval erasechar : unit -> charval has_ic : unit -> boolval has_il : unit -> boolval killchar : unit -> charval longname : unit -> stringval termattrs : unit -> attr_tval termname : unit -> stringval tgetent : string -> boolval tgetflag : string -> boolval tgetnum : string -> intval tgetstr : string -> boolval tgoto : string -> int -> int -> stringval setupterm : string -> Unix.file_descr -> errval setterm : string -> errval cur_term : unit -> terminalval set_curterm : terminal -> terminalval del_curterm : terminal -> errval restartterm : string -> Unix.file_descr -> errval putp : string -> errval vidattr : chtype -> errval mvcur : int -> int -> int -> int -> errval tigetflag : string -> boolval tigetnum : string -> intval tigetstr : string -> stringval tputs : string -> int -> (char -> unit) -> errval vidputs : chtype -> (char -> unit) -> errval tparm : string -> int array -> stringval bool_terminfo_variable : int -> string * string * stringval num_terminfo_variable : int -> string * string * stringval str_terminfo_variable : int -> string * string * stringval bool_terminfo_variables : (string, string * string) Hashtbl.tval num_terminfo_variables : (string, string * string) Hashtbl.tval str_terminfo_variables : (string, string * string) Hashtbl.tval def_prog_mode : unit -> unitreser_prog_mod and reset_shell_mode functions.val def_shell_mode : unit -> unitval reset_prog_mode : unit -> unitval reset_shell_mode : unit -> unitval resetty : unit -> unitval savetty : unit -> unitval getsyx : unit -> int * intval setsyx : int -> int -> unitval curs_set : int -> errval napms : int -> unitval ripoffline : bool -> unitval get_ripoff : unit -> window * intmodule Curses_config:sig..end