<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <link rel="stylesheet" href="style.css" type="text/css"> <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type"> <link rel="Start" href="index.html"> <link rel="Up" href="index.html"> <link title="Index of types" rel=Appendix href="index_types.html"> <link title="Index of values" rel=Appendix href="index_values.html"> <link title="Index of modules" rel=Appendix href="index_modules.html"> <link title="Curses" rel="Chapter" href="Curses.html"><link title="Initialization functions" rel="Section" href="#2_Initializationfunctions"> <link title="Cursor" rel="Section" href="#2_Cursor"> <link title="Operations on characters" rel="Section" href="#2_Operationsoncharacters"> <link title="Windows" rel="Section" href="#2_Windows"> <link title="Colors" rel="Section" href="#2_Colors"> <link title="Input/output options" rel="Section" href="#2_Inputoutputoptions"> <link title="Soft-label keys" rel="Section" href="#2_Softlabelkeys"> <link title="Mouse" rel="Section" href="#2_Mouse"> <link title="Misc" rel="Section" href="#2_Misc"> <link title="Screen manipulation" rel="Section" href="#2_Screenmanipulation"> <link title="Terminal" rel="Section" href="#2_Terminal"> <link title="Low-level curses routines" rel="Section" href="#2_Lowlevelcursesroutines"> <link title="Configuration" rel="Section" href="#2_Configuration"> <link title="Displaying characters" rel="Subsection" href="#3_Displayingcharacters"> <link title="Attributes" rel="Subsection" href="#3_Attributes"> <link title="Background" rel="Subsection" href="#3_Background"> <link title="Operations on lines" rel="Subsection" href="#3_Operationsonlines"> <link title="Characters input" rel="Subsection" href="#3_Charactersinput"> <link title="Window manipulations" rel="Subsection" href="#3_Windowmanipulations"> <link title="Refresh control" rel="Subsection" href="#3_Refreshcontrol"> <link title="Overlapped windows" rel="Subsection" href="#3_Overlappedwindows"> <link title="Decorations" rel="Subsection" href="#3_Decorations"> <link title="Pads" rel="Subsection" href="#3_Pads"> <link title="Input options" rel="Subsection" href="#3_Inputoptions"> <link title="Output options" rel="Subsection" href="#3_Outputoptions"> <title>Curses</title> </head> <body> <div class="navbar"> <a href="index.html">Up</a> </div> <center><h1>Module <a href="type_Curses.html">Curses</a></h1></center> <br> <pre><span class="keyword">module</span> Curses: <code class="code">sig</code> <a href="Curses.html">..</a> <code class="code">end</code></pre> Bindings to the ncurses library. <p> Beware, all coordinates are passed <code class="code">y</code> first, then <code class="code">x</code>. <p> 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 <code class="code">y</code> and <code class="code">x</code> of the point to move the cursor to. For example <code class="code">mvaddch y x ch</code> is the same as <code class="code">move y x; addch ch</code>.<br> <hr width="100%"> <pre><span class="keyword">type</span> <a name="TYPEwindow"></a><code class="type"></code>window </pre> <div class="info"> Windows.<br> </div> <pre><span class="keyword">type</span> <a name="TYPEscreen"></a><code class="type"></code>screen </pre> <div class="info"> Screens.<br> </div> <pre><span class="keyword">type</span> <a name="TYPEterminal"></a><code class="type"></code>terminal </pre> <div class="info"> Terminals.<br> </div> <pre><span class="keyword">type</span> <a name="TYPEchtype"></a><code class="type"></code>chtype = <code class="type">int</code> </pre> <div class="info"> Characters. Usual characters can be converted from/to <code class="code">chtype</code> using <code class="code">char_of_int</code> and <code class="code">int_of_char</code>. See also <code class="code">get_acs_codes</code> for characters useful for drawing and the <code class="code">Key</code> module for special input characters.<br> </div> <pre><span class="keyword">type</span> <a name="TYPEattr_t"></a><code class="type"></code>attr_t = <code class="type">int</code> </pre> <div class="info"> Attributes are <code class="code">lor</code>ings of flags which are defined in the <code class="code">A</code> module.<br> </div> <pre><span class="keyword">type</span> <a name="TYPEerr"></a><code class="type"></code>err = <code class="type">bool</code> </pre> <div class="info"> A return value. <code class="code">false</code> means that an error occured.<br> </div> <br> <a name="2_Initializationfunctions"></a> <h2>Initialization functions</h2><br> <pre><span class="keyword">val</span> <a name="VALinitscr"></a>initscr : <code class="type">unit -> <a href="Curses.html#TYPEwindow">window</a></code></pre><div class="info"> Initialize the curses library.<br> </div> <pre><span class="keyword">val</span> <a name="VALendwin"></a>endwin : <code class="type">unit -> unit</code></pre><div class="info"> Restore the terminal (should be called before exiting).<br> </div> <pre><span class="keyword">val</span> <a name="VALisendwin"></a>isendwin : <code class="type">unit -> bool</code></pre><div class="info"> Has <code class="code">endwin</code> been called without any subsequent call to <code class="code">werefresh</code>?<br> </div> <pre><span class="keyword">val</span> <a name="VALnewterm"></a>newterm : <code class="type">string -> Unix.file_descr -> Unix.file_descr -> <a href="Curses.html#TYPEscreen">screen</a></code></pre><div class="info"> Create a new terminal.<br> </div> <pre><span class="keyword">val</span> <a name="VALset_term"></a>set_term : <code class="type"><a href="Curses.html#TYPEscreen">screen</a> -> unit</code></pre><div class="info"> Switch terminal.<br> </div> <pre><span class="keyword">val</span> <a name="VALdelscreen"></a>delscreen : <code class="type"><a href="Curses.html#TYPEscreen">screen</a> -> unit</code></pre><div class="info"> Delete a screen.<br> </div> <pre><span class="keyword">val</span> <a name="VALstdscr"></a>stdscr : <code class="type">unit -> <a href="Curses.html#TYPEwindow">window</a></code></pre><br> <a name="2_Cursor"></a> <h2>Cursor</h2><br> <pre><span class="keyword">val</span> <a name="VALgetyx"></a>getyx : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int * int</code></pre><div class="info"> Get the current cursor position.<br> </div> <pre><span class="keyword">val</span> <a name="VALgetparyx"></a>getparyx : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALgetbegyx"></a>getbegyx : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALgetmaxyx"></a>getmaxyx : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALmove"></a>move : <code class="type">int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Move the cursor.<br> </div> <pre><span class="keyword">val</span> <a name="VALwmove"></a>wmove : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="2_Operationsoncharacters"></a> <h2>Operations on characters</h2><br> <pre><span class="keyword">module</span> <a href="Curses.Acs.html">Acs</a>: <code class="code">sig</code> <a href="Curses.Acs.html">..</a> <code class="code">end</code></pre><div class="info"> Predefined characters. </div> <pre><span class="keyword">val</span> <a name="VALget_acs_codes"></a>get_acs_codes : <code class="type">unit -> <a href="Curses.Acs.html#TYPEacs">Acs.acs</a></code></pre><div class="info"> Get the predefined characters.<br> </div> <br> <a name="3_Displayingcharacters"></a> <h3>Displaying characters</h3><br> <pre><span class="keyword">val</span> <a name="VALaddch"></a>addch : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Add a character at the current position, then advance the cursor.<br> </div> <pre><span class="keyword">val</span> <a name="VALwaddch"></a>waddch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvaddch"></a>mvaddch : <code class="type">int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwaddch"></a>mvwaddch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALechochar"></a>echochar : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> <code class="code">echochar ch</code> is equivalent to <code class="code">addch ch</code> followed by <code class="code">refresh ()</code>.<br> </div> <pre><span class="keyword">val</span> <a name="VALwechochar"></a>wechochar : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALaddchstr"></a>addchstr : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> array -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Add a sequence of characters at the current position. See also <code class="code">addstr</code>.<br> </div> <pre><span class="keyword">val</span> <a name="VALwaddchstr"></a>waddchstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> array -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvaddchstr"></a>mvaddchstr : <code class="type">int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> array -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwaddchstr"></a>mvwaddchstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> array -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALaddchnstr"></a>addchnstr : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> array -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwaddchnstr"></a>waddchnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> array -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvaddchnstr"></a>mvaddchnstr : <code class="type">int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> array -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwaddchnstr"></a>mvwaddchnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -><br> int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> array -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALaddstr"></a>addstr : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Add a string at the current position.<br> </div> <pre><span class="keyword">val</span> <a name="VALwaddstr"></a>waddstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvaddstr"></a>mvaddstr : <code class="type">int -> int -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwaddstr"></a>mvwaddstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALaddnstr"></a>addnstr : <code class="type">string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwaddnstr"></a>waddnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvaddnstr"></a>mvaddnstr : <code class="type">int -> int -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwaddnstr"></a>mvwaddnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinsch"></a>insch : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Insert a character before cursor.<br> </div> <pre><span class="keyword">val</span> <a name="VALwinsch"></a>winsch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvinsch"></a>mvinsch : <code class="type">int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwinsch"></a>mvwinsch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinsstr"></a>insstr : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Insert a string before cursor.<br> </div> <pre><span class="keyword">val</span> <a name="VALwinsstr"></a>winsstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvinsstr"></a>mvinsstr : <code class="type">int -> int -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwinsstr"></a>mvwinsstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinsnstr"></a>insnstr : <code class="type">string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwinsnstr"></a>winsnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvinsnstr"></a>mvinsnstr : <code class="type">int -> int -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwinsnstr"></a>mvwinsnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALdelch"></a>delch : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Delete a character.<br> </div> <pre><span class="keyword">val</span> <a name="VALwdelch"></a>wdelch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvdelch"></a>mvdelch : <code class="type">int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwdelch"></a>mvwdelch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="3_Attributes"></a> <h3>Attributes</h3><br> <pre><span class="keyword">module</span> <a href="Curses.A.html">A</a>: <code class="code">sig</code> <a href="Curses.A.html">..</a> <code class="code">end</code></pre><div class="info"> Attributes. </div> <pre><span class="keyword">module</span> <a href="Curses.WA.html">WA</a>: <code class="code">sig</code> <a href="Curses.WA.html">..</a> <code class="code">end</code></pre><div class="info"> New series of highlight attributes. </div> <pre><span class="keyword">val</span> <a name="VALattroff"></a>attroff : <code class="type">int -> unit</code></pre><div class="info"> Turn off the attributes given in argument (see the <code class="code">A</code> module).<br> </div> <pre><span class="keyword">val</span> <a name="VALwattroff"></a>wattroff : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALattron"></a>attron : <code class="type">int -> unit</code></pre><div class="info"> Turn on the attributes given in argument.<br> </div> <pre><span class="keyword">val</span> <a name="VALwattron"></a>wattron : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALattrset"></a>attrset : <code class="type">int -> unit</code></pre><div class="info"> Set the attributes.<br> </div> <pre><span class="keyword">val</span> <a name="VALwattrset"></a>wattrset : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALstandend"></a>standend : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwstandend"></a>wstandend : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALstandout"></a>standout : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwstandout"></a>wstandout : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALattr_off"></a>attr_off : <code class="type"><a href="Curses.html#TYPEattr_t">attr_t</a> -> unit</code></pre><div class="info"> Turn off the attributes given in argument (see the <code class="code">WA</code> module).<br> </div> <pre><span class="keyword">val</span> <a name="VALwattr_off"></a>wattr_off : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEattr_t">attr_t</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALattr_on"></a>attr_on : <code class="type"><a href="Curses.html#TYPEattr_t">attr_t</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwattr_on"></a>wattr_on : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEattr_t">attr_t</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALattr_set"></a>attr_set : <code class="type"><a href="Curses.html#TYPEattr_t">attr_t</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwattr_set"></a>wattr_set : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEattr_t">attr_t</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALchgat"></a>chgat : <code class="type">int -> <a href="Curses.html#TYPEattr_t">attr_t</a> -> int -> unit</code></pre><div class="info"> <code class="code">chgat n attr color</code> changes the attributes of <code class="code">n</code> characters.<br> </div> <pre><span class="keyword">val</span> <a name="VALwchgat"></a>wchgat : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> <a href="Curses.html#TYPEattr_t">attr_t</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALmvchgat"></a>mvchgat : <code class="type">int -> int -> int -> <a href="Curses.html#TYPEattr_t">attr_t</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALmvwchgat"></a>mvwchgat : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> int -> <a href="Curses.html#TYPEattr_t">attr_t</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALinch"></a>inch : <code class="type">unit -> <a href="Curses.html#TYPEchtype">chtype</a></code></pre><div class="info"> Get the attributes of the caracter at current position.<br> </div> <pre><span class="keyword">val</span> <a name="VALwinch"></a>winch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvinch"></a>mvinch : <code class="type">int -> int -> <a href="Curses.html#TYPEchtype">chtype</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwinch"></a>mvwinch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEchtype">chtype</a></code></pre><pre><span class="keyword">val</span> <a name="VALinchstr"></a>inchstr : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> array -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Get the attributes of a sequence of characters.<br> </div> <pre><span class="keyword">val</span> <a name="VALwinchstr"></a>winchstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> array -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvinchstr"></a>mvinchstr : <code class="type">int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> array -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwinchstr"></a>mvwinchstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> array -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinchnstr"></a>inchnstr : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> array -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwinchnstr"></a>winchnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> array -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvinchnstr"></a>mvinchnstr : <code class="type">int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> array -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwinchnstr"></a>mvwinchnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -><br> int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> array -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinstr"></a>instr : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Get the attributes of a string.<br> </div> <pre><span class="keyword">val</span> <a name="VALwinstr"></a>winstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvinstr"></a>mvinstr : <code class="type">int -> int -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwinstr"></a>mvwinstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinnstr"></a>innstr : <code class="type">string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwinnstr"></a>winnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvinnstr"></a>mvinnstr : <code class="type">int -> int -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwinnstr"></a>mvwinnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="3_Background"></a> <h3>Background</h3><br> <pre><span class="keyword">val</span> <a name="VALbkgdset"></a>bkgdset : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> unit</code></pre><div class="info"> Set the background of the current character.<br> </div> <pre><span class="keyword">val</span> <a name="VALwbkgdset"></a>wbkgdset : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALbkgd"></a>bkgd : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> unit</code></pre><div class="info"> Set the background of every character.<br> </div> <pre><span class="keyword">val</span> <a name="VALwbkgd"></a>wbkgd : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALgetbkgd"></a>getbkgd : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a></code></pre><div class="info"> Get the current background.<br> </div> <br> <a name="3_Operationsonlines"></a> <h3>Operations on lines</h3><br> <pre><span class="keyword">val</span> <a name="VALdeleteln"></a>deleteln : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Delete a line.<br> </div> <pre><span class="keyword">val</span> <a name="VALwdeleteln"></a>wdeleteln : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinsdelln"></a>insdelln : <code class="type">int -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> <code class="code">insdelln n</code> inserts <code class="code">n</code> lines above the current line if <code class="code">n</code> is positive or deletes <code class="code">-n</code> lines if <code class="code">n</code> is negative.<br> </div> <pre><span class="keyword">val</span> <a name="VALwinsdelln"></a>winsdelln : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinsertln"></a>insertln : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Insert a blank line above the current line.<br> </div> <pre><span class="keyword">val</span> <a name="VALwinsertln"></a>winsertln : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="3_Charactersinput"></a> <h3>Characters input</h3><br> <pre><span class="keyword">module</span> <a href="Curses.Key.html">Key</a>: <code class="code">sig</code> <a href="Curses.Key.html">..</a> <code class="code">end</code></pre><div class="info"> Special keys. </div> <pre><span class="keyword">val</span> <a name="VALgetch"></a>getch : <code class="type">unit -> int</code></pre><div class="info"> Read a character in a window.<br> </div> <pre><span class="keyword">val</span> <a name="VALwgetch"></a>wgetch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int</code></pre><pre><span class="keyword">val</span> <a name="VALmvgetch"></a>mvgetch : <code class="type">int -> int -> int</code></pre><pre><span class="keyword">val</span> <a name="VALmvwgetch"></a>mvwgetch : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> int</code></pre><pre><span class="keyword">val</span> <a name="VALungetch"></a>ungetch : <code class="type">int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALgetstr"></a>getstr : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Read a string in a window.<br> </div> <pre><span class="keyword">val</span> <a name="VALwgetstr"></a>wgetstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvgetstr"></a>mvgetstr : <code class="type">int -> int -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwgetstr"></a>mvwgetstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALgetnstr"></a>getnstr : <code class="type">string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwgetnstr"></a>wgetnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvgetnstr"></a>mvgetnstr : <code class="type">int -> int -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvwgetnstr"></a>mvwgetnstr : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> string -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="2_Windows"></a> <h2>Windows</h2><br> <br> <a name="3_Windowmanipulations"></a> <h3>Window manipulations</h3><br> <pre><span class="keyword">val</span> <a name="VALnewwin"></a>newwin : <code class="type">int -> int -> int -> int -> <a href="Curses.html#TYPEwindow">window</a></code></pre><div class="info"> <code class="code">newwin l c y x</code> create a new window with <code class="code">l</code> lines, <code class="code">c</code> columns. The upper left-hand corner is at (<code class="code">x</code>,<code class="code">y</code>).<br> </div> <pre><span class="keyword">val</span> <a name="VALdelwin"></a>delwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Delete a window.<br> </div> <pre><span class="keyword">val</span> <a name="VALmvwin"></a>mvwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Move a window.<br> </div> <pre><span class="keyword">val</span> <a name="VALsubwin"></a>subwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> int -> int -> <a href="Curses.html#TYPEwindow">window</a></code></pre><div class="info"> <code class="code">subwin l c y x</code> create a subwindow with <code class="code">l</code> lines and <code class="code">c</code> columns at screen-relative position (<code class="code">x</code>,<code class="code">y</code>).<br> </div> <pre><span class="keyword">val</span> <a name="VALderwin"></a>derwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> int -> int -> <a href="Curses.html#TYPEwindow">window</a></code></pre><div class="info"> Same as <code class="code">subwin</code> excepting that the position (<code class="code">x</code>,<code class="code">y</code>) is relative to the parent window.<br> </div> <pre><span class="keyword">val</span> <a name="VALmvderwin"></a>mvderwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Move a derived windw.<br> </div> <pre><span class="keyword">val</span> <a name="VALdupwin"></a>dupwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEwindow">window</a></code></pre><div class="info"> Duplicate a window.<br> </div> <pre><span class="keyword">val</span> <a name="VALwsyncup"></a>wsyncup : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALsyncok"></a>syncok : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> If <code class="code">syncok</code> is called with <code class="code">true</code> as second argument, <code class="code">wsyncup</code> is called automatically whenever there is a change in the window.<br> </div> <pre><span class="keyword">val</span> <a name="VALwcursyncup"></a>wcursyncup : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwsyncdown"></a>wsyncdown : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwinch_handler_on"></a>winch_handler_on : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwinch_handler_off"></a>winch_handler_off : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALget_size"></a>get_size : <code class="type">unit -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALget_size_fd"></a>get_size_fd : <code class="type">Unix.file_descr -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALnull_window"></a>null_window : <code class="type"><a href="Curses.html#TYPEwindow">window</a></code></pre><br> <a name="3_Refreshcontrol"></a> <h3>Refresh control</h3><br> <pre><span class="keyword">val</span> <a name="VALrefresh"></a>refresh : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Refresh windows.<br> </div> <pre><span class="keyword">val</span> <a name="VALwrefresh"></a>wrefresh : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwnoutrefresh"></a>wnoutrefresh : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALdoupdate"></a>doupdate : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALredrawwin"></a>redrawwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwredrawln"></a>wredrawln : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwresize"></a>wresize : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALresizeterm"></a>resizeterm : <code class="type">int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALscroll"></a>scroll : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALscrl"></a>scrl : <code class="type">int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwscrl"></a>wscrl : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALtouchwin"></a>touchwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALtouchline"></a>touchline : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALuntouchwin"></a>untouchwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwtouchln"></a>wtouchln : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> bool -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALis_linetouched"></a>is_linetouched : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int</code></pre><pre><span class="keyword">val</span> <a name="VALis_wintouched"></a>is_wintouched : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALerase"></a>erase : <code class="type">unit -> unit</code></pre><div class="info"> Clear a window.<br> </div> <pre><span class="keyword">val</span> <a name="VALwerase"></a>werase : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALclear"></a>clear : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwclear"></a>wclear : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALclrtobot"></a>clrtobot : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwclrtobot"></a>wclrtobot : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALclrtoeol"></a>clrtoeol : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwclrtoeol"></a>wclrtoeol : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> unit</code></pre><br> <a name="3_Overlappedwindows"></a> <h3>Overlapped windows</h3><br> <pre><span class="keyword">val</span> <a name="VALoverlay"></a>overlay : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> <code class="code">overlay srcwin dstwin</code> overlays <code class="code">srcwin</code> on top of <code class="code">dstwin</code>.<br> </div> <pre><span class="keyword">val</span> <a name="VALoverwrite"></a>overwrite : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALcopywin"></a>copywin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -><br> <a href="Curses.html#TYPEwindow">window</a> -> int -> int -> int -> int -> int -> int -> bool -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="3_Decorations"></a> <h3>Decorations</h3><br> <pre><span class="keyword">val</span> <a name="VALborder"></a>border : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -><br> <a href="Curses.html#TYPEchtype">chtype</a> -><br> <a href="Curses.html#TYPEchtype">chtype</a> -><br> <a href="Curses.html#TYPEchtype">chtype</a> -><br> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> unit</code></pre><div class="info"> Draw a box around the edges of a window.<br> </div> <pre><span class="keyword">val</span> <a name="VALwborder"></a>wborder : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -><br> <a href="Curses.html#TYPEchtype">chtype</a> -><br> <a href="Curses.html#TYPEchtype">chtype</a> -><br> <a href="Curses.html#TYPEchtype">chtype</a> -><br> <a href="Curses.html#TYPEchtype">chtype</a> -><br> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALbox"></a>box : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> unit</code></pre><div class="info"> Draw a box.<br> </div> <pre><span class="keyword">val</span> <a name="VALhline"></a>hline : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> int -> unit</code></pre><div class="info"> Draw an horizontal line.<br> </div> <pre><span class="keyword">val</span> <a name="VALwhline"></a>whline : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALmvhline"></a>mvhline : <code class="type">int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALmvwhline"></a>mvwhline : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALvline"></a>vline : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> int -> unit</code></pre><div class="info"> Draw a vertical line.<br> </div> <pre><span class="keyword">val</span> <a name="VALwvline"></a>wvline : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALmvvline"></a>mvvline : <code class="type">int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALmvwvline"></a>mvwvline : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEchtype">chtype</a> -> int -> unit</code></pre><br> <a name="3_Pads"></a> <h3>Pads</h3><br> <br> A pad is like a window except that it is not restricted by the screen size, and is not necessarily associated with a particular part of the screen.<br> <pre><span class="keyword">val</span> <a name="VALnewpad"></a>newpad : <code class="type">int -> int -> <a href="Curses.html#TYPEwindow">window</a></code></pre><div class="info"> Create a new pad.<br> </div> <pre><span class="keyword">val</span> <a name="VALsubpad"></a>subpad : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> int -> int -> <a href="Curses.html#TYPEwindow">window</a></code></pre><pre><span class="keyword">val</span> <a name="VALprefresh"></a>prefresh : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> int -> int -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALpnoutrefresh"></a>pnoutrefresh : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> int -> int -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALpechochar"></a>pechochar : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> <a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="2_Colors"></a> <h2>Colors</h2><br> <pre><span class="keyword">module</span> <a href="Curses.Color.html">Color</a>: <code class="code">sig</code> <a href="Curses.Color.html">..</a> <code class="code">end</code></pre><div class="info"> Colors. </div> <pre><span class="keyword">val</span> <a name="VALstart_color"></a>start_color : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALuse_default_colors"></a>use_default_colors : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinit_pair"></a>init_pair : <code class="type">int -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALinit_color"></a>init_color : <code class="type">int -> int -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALhas_colors"></a>has_colors : <code class="type">unit -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALcan_change_color"></a>can_change_color : <code class="type">unit -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALcolor_content"></a>color_content : <code class="type">int -> int * int * int</code></pre><pre><span class="keyword">val</span> <a name="VALpair_content"></a>pair_content : <code class="type">int -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALcolors"></a>colors : <code class="type">unit -> int</code></pre><pre><span class="keyword">val</span> <a name="VALcolor_pairs"></a>color_pairs : <code class="type">unit -> int</code></pre><br> <a name="2_Inputoutputoptions"></a> <h2>Input/output options</h2><br> <br> <a name="3_Inputoptions"></a> <h3>Input options</h3><br> <pre><span class="keyword">val</span> <a name="VALcbreak"></a>cbreak : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Disable line buffering.<br> </div> <pre><span class="keyword">val</span> <a name="VALhalfdelay"></a>halfdelay : <code class="type">int -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Similar to <code class="code">cbreak</code> but with delay.<br> </div> <pre><span class="keyword">val</span> <a name="VALnocbreak"></a>nocbreak : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Enable line buffering (waits for characters until newline is typed).<br> </div> <pre><span class="keyword">val</span> <a name="VALecho"></a>echo : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Don't echo typed characters.<br> </div> <pre><span class="keyword">val</span> <a name="VALnoecho"></a>noecho : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Echo typed characters.<br> </div> <pre><span class="keyword">val</span> <a name="VALintrflush"></a>intrflush : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALkeypad"></a>keypad : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmeta"></a>meta : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALnodelay"></a>nodelay : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALraw"></a>raw : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALnoraw"></a>noraw : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALnoqiflush"></a>noqiflush : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALqiflush"></a>qiflush : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALnotimeout"></a>notimeout : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALtimeout"></a>timeout : <code class="type">int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALwtimeout"></a>wtimeout : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALtypeahead"></a>typeahead : <code class="type">Unix.file_descr -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALnotypeahead"></a>notypeahead : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="3_Outputoptions"></a> <h3>Output options</h3><br> <pre><span class="keyword">val</span> <a name="VALclearok"></a>clearok : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> unit</code></pre><div class="info"> If called with <code class="code">true</code> as second argument, the next call to <code class="code">wrefresh</code> with this window will clear the streen completely and redraw the entire screen from scratch.<br> </div> <pre><span class="keyword">val</span> <a name="VALidlok"></a>idlok : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALidcok"></a>idcok : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALimmedok"></a>immedok : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALleaveok"></a>leaveok : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALsetscrreg"></a>setscrreg : <code class="type">int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALwsetscrreg"></a>wsetscrreg : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALscrollok"></a>scrollok : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> bool -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALnl"></a>nl : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALnonl"></a>nonl : <code class="type">unit -> unit</code></pre><br> <a name="2_Softlabelkeys"></a> <h2>Soft-label keys</h2><br> <pre><span class="keyword">val</span> <a name="VALslk_init"></a>slk_init : <code class="type">int -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Initialize soft labels.<br> </div> <pre><span class="keyword">val</span> <a name="VALslk_set"></a>slk_set : <code class="type">int -> string -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALslk_refresh"></a>slk_refresh : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALslk_noutrefresh"></a>slk_noutrefresh : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALslk_label"></a>slk_label : <code class="type">int -> string</code></pre><pre><span class="keyword">val</span> <a name="VALslk_clear"></a>slk_clear : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALslk_restore"></a>slk_restore : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALslk_touch"></a>slk_touch : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALslk_attron"></a>slk_attron : <code class="type"><a href="Curses.html#TYPEattr_t">attr_t</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALslk_attroff"></a>slk_attroff : <code class="type"><a href="Curses.html#TYPEattr_t">attr_t</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALslk_attrset"></a>slk_attrset : <code class="type"><a href="Curses.html#TYPEattr_t">attr_t</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="2_Mouse"></a> <h2>Mouse</h2><br> <pre><span class="keyword">val</span> <a name="VALmousemask"></a>mousemask : <code class="type">int -> int * int</code></pre><div class="info"> Sets the mouse mask.<br> </div> <br> <a name="2_Misc"></a> <h2>Misc</h2><br> <pre><span class="keyword">val</span> <a name="VALbeep"></a>beep : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Ring a bell.<br> </div> <pre><span class="keyword">val</span> <a name="VALflash"></a>flash : <code class="type">unit -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Flash the screen.<br> </div> <pre><span class="keyword">val</span> <a name="VALunctrl"></a>unctrl : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> string</code></pre><pre><span class="keyword">val</span> <a name="VALkeyname"></a>keyname : <code class="type">int -> string</code></pre><pre><span class="keyword">val</span> <a name="VALfilter"></a>filter : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALuse_env"></a>use_env : <code class="type">bool -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALputwin"></a>putwin : <code class="type"><a href="Curses.html#TYPEwindow">window</a> -> Unix.file_descr -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALgetwin"></a>getwin : <code class="type">Unix.file_descr -> <a href="Curses.html#TYPEwindow">window</a></code></pre><pre><span class="keyword">val</span> <a name="VALdelay_output"></a>delay_output : <code class="type">int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALflushinp"></a>flushinp : <code class="type">unit -> unit</code></pre><br> <a name="2_Screenmanipulation"></a> <h2>Screen manipulation</h2><br> <pre><span class="keyword">val</span> <a name="VALscr_dump"></a>scr_dump : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><div class="info"> Dump the current screen to a file.<br> </div> <pre><span class="keyword">val</span> <a name="VALscr_restore"></a>scr_restore : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALscr_init"></a>scr_init : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALscr_set"></a>scr_set : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><br> <a name="2_Terminal"></a> <h2>Terminal</h2><br> <pre><span class="keyword">val</span> <a name="VALbaudrate"></a>baudrate : <code class="type">unit -> int</code></pre><div class="info"> Get the speed of a terminal (in bits per second).<br> </div> <pre><span class="keyword">val</span> <a name="VALerasechar"></a>erasechar : <code class="type">unit -> char</code></pre><div class="info"> Get user's current erase character.<br> </div> <pre><span class="keyword">val</span> <a name="VALhas_ic"></a>has_ic : <code class="type">unit -> bool</code></pre><div class="info"> Has the terminal insert- and delete-character capabilites?<br> </div> <pre><span class="keyword">val</span> <a name="VALhas_il"></a>has_il : <code class="type">unit -> bool</code></pre><div class="info"> Has the terminal insert- and delete-line capabilites?<br> </div> <pre><span class="keyword">val</span> <a name="VALkillchar"></a>killchar : <code class="type">unit -> char</code></pre><div class="info"> Get user's current line kill character.<br> </div> <pre><span class="keyword">val</span> <a name="VALlongname"></a>longname : <code class="type">unit -> string</code></pre><div class="info"> Get a description of the terminal.<br> </div> <pre><span class="keyword">val</span> <a name="VALtermattrs"></a>termattrs : <code class="type">unit -> <a href="Curses.html#TYPEattr_t">attr_t</a></code></pre><pre><span class="keyword">val</span> <a name="VALtermname"></a>termname : <code class="type">unit -> string</code></pre><pre><span class="keyword">val</span> <a name="VALtgetent"></a>tgetent : <code class="type">string -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALtgetflag"></a>tgetflag : <code class="type">string -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALtgetnum"></a>tgetnum : <code class="type">string -> int</code></pre><pre><span class="keyword">val</span> <a name="VALtgetstr"></a>tgetstr : <code class="type">string -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALtgoto"></a>tgoto : <code class="type">string -> int -> int -> string</code></pre><pre><span class="keyword">val</span> <a name="VALsetupterm"></a>setupterm : <code class="type">string -> Unix.file_descr -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALsetterm"></a>setterm : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALcur_term"></a>cur_term : <code class="type">unit -> <a href="Curses.html#TYPEterminal">terminal</a></code></pre><pre><span class="keyword">val</span> <a name="VALset_curterm"></a>set_curterm : <code class="type"><a href="Curses.html#TYPEterminal">terminal</a> -> <a href="Curses.html#TYPEterminal">terminal</a></code></pre><pre><span class="keyword">val</span> <a name="VALdel_curterm"></a>del_curterm : <code class="type"><a href="Curses.html#TYPEterminal">terminal</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALrestartterm"></a>restartterm : <code class="type">string -> Unix.file_descr -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALputp"></a>putp : <code class="type">string -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALvidattr"></a>vidattr : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALmvcur"></a>mvcur : <code class="type">int -> int -> int -> int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALtigetflag"></a>tigetflag : <code class="type">string -> bool</code></pre><pre><span class="keyword">val</span> <a name="VALtigetnum"></a>tigetnum : <code class="type">string -> int</code></pre><pre><span class="keyword">val</span> <a name="VALtigetstr"></a>tigetstr : <code class="type">string -> string</code></pre><pre><span class="keyword">val</span> <a name="VALtputs"></a>tputs : <code class="type">string -> int -> (char -> unit) -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALvidputs"></a>vidputs : <code class="type"><a href="Curses.html#TYPEchtype">chtype</a> -> (char -> unit) -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALtparm"></a>tparm : <code class="type">string -> int array -> string</code></pre><pre><span class="keyword">val</span> <a name="VALbool_terminfo_variable"></a>bool_terminfo_variable : <code class="type">int -> string * string * string</code></pre><pre><span class="keyword">val</span> <a name="VALnum_terminfo_variable"></a>num_terminfo_variable : <code class="type">int -> string * string * string</code></pre><pre><span class="keyword">val</span> <a name="VALstr_terminfo_variable"></a>str_terminfo_variable : <code class="type">int -> string * string * string</code></pre><pre><span class="keyword">val</span> <a name="VALbool_terminfo_variables"></a>bool_terminfo_variables : <code class="type">(string, string * string) Hashtbl.t</code></pre><pre><span class="keyword">val</span> <a name="VALnum_terminfo_variables"></a>num_terminfo_variables : <code class="type">(string, string * string) Hashtbl.t</code></pre><pre><span class="keyword">val</span> <a name="VALstr_terminfo_variables"></a>str_terminfo_variables : <code class="type">(string, string * string) Hashtbl.t</code></pre><br> <a name="2_Lowlevelcursesroutines"></a> <h2>Low-level curses routines</h2><br> <pre><span class="keyword">val</span> <a name="VALdef_prog_mode"></a>def_prog_mode : <code class="type">unit -> unit</code></pre><div class="info"> Save the current terminal modes as the "program" state for use by the <code class="code">reser_prog_mod</code> and <code class="code">reset_shell_mode</code> functions.<br> </div> <pre><span class="keyword">val</span> <a name="VALdef_shell_mode"></a>def_shell_mode : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALreset_prog_mode"></a>reset_prog_mode : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALreset_shell_mode"></a>reset_shell_mode : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALresetty"></a>resetty : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALsavetty"></a>savetty : <code class="type">unit -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALgetsyx"></a>getsyx : <code class="type">unit -> int * int</code></pre><pre><span class="keyword">val</span> <a name="VALsetsyx"></a>setsyx : <code class="type">int -> int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALcurs_set"></a>curs_set : <code class="type">int -> <a href="Curses.html#TYPEerr">err</a></code></pre><pre><span class="keyword">val</span> <a name="VALnapms"></a>napms : <code class="type">int -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALripoffline"></a>ripoffline : <code class="type">bool -> unit</code></pre><pre><span class="keyword">val</span> <a name="VALget_ripoff"></a>get_ripoff : <code class="type">unit -> <a href="Curses.html#TYPEwindow">window</a> * int</code></pre><br> <a name="2_Configuration"></a> <h2>Configuration</h2><br> <pre><span class="keyword">module</span> <a href="Curses.Curses_config.html">Curses_config</a>: <code class="code">sig</code> <a href="Curses.Curses_config.html">..</a> <code class="code">end</code></pre></body></html>
