<!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="previous" href="LTerm_text.html">
<link rel="next" href="LTerm_resources.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="LTerm" rel="Chapter" href="LTerm.html">
<link title="LTerm_key" rel="Chapter" href="LTerm_key.html">
<link title="LTerm_event" rel="Chapter" href="LTerm_event.html">
<link title="LTerm_unix" rel="Chapter" href="LTerm_unix.html">
<link title="LTerm_windows" rel="Chapter" href="LTerm_windows.html">
<link title="LTerm_style" rel="Chapter" href="LTerm_style.html">
<link title="LTerm_geom" rel="Chapter" href="LTerm_geom.html">
<link title="LTerm_draw" rel="Chapter" href="LTerm_draw.html">
<link title="LTerm_mouse" rel="Chapter" href="LTerm_mouse.html">
<link title="LTerm_widget" rel="Chapter" href="LTerm_widget.html">
<link title="LTerm_edit" rel="Chapter" href="LTerm_edit.html">
<link title="LTerm_read_line" rel="Chapter" href="LTerm_read_line.html">
<link title="LTerm_text" rel="Chapter" href="LTerm_text.html">
<link title="LTerm_ui" rel="Chapter" href="LTerm_ui.html">
<link title="LTerm_resources" rel="Chapter" href="LTerm_resources.html">
<link title="LTerm_inputrc" rel="Chapter" href="LTerm_inputrc.html">
<link title="LTerm_history" rel="Chapter" href="LTerm_history.html"><title>LTerm_ui</title>
</head>
<body>
<div class="navbar"><a class="pre" href="LTerm_text.html" title="LTerm_text">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="LTerm_resources.html" title="LTerm_resources">Next</a>
</div>
<h1>Module <a href="type_LTerm_ui.html">LTerm_ui</a></h1>
<pre><span class="keyword">module</span> LTerm_ui: <code class="code">sig</code> <a href="LTerm_ui.html">..</a> <code class="code">end</code></pre><div class="info module top">
High level function for writing full-screen applications<br>
</div>
<hr width="100%">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
Type of a user interface.<br>
</div>
<pre><span id="VALcreate"><span class="keyword">val</span> create</span> : <code class="type"><a href="LTerm.html#TYPEt">LTerm.t</a> -><br> ?save_state:bool -><br> (<a href="LTerm_ui.html#TYPEt">t</a> -> <a href="LTerm_draw.html#TYPEmatrix">LTerm_draw.matrix</a> -> unit) -> <a href="LTerm_ui.html#TYPEt">t</a> Lwt.t</code></pre><div class="info ">
<code class="code">create term ?save_state draw</code> creates a new user
interface. <code class="code">draw</code> is used to draw the user interface. If
<code class="code">save_state</code> is <code class="code">true</code> (the default) then the state of the
terminal is saved.<br>
</div>
<pre><span id="VALquit"><span class="keyword">val</span> quit</span> : <code class="type"><a href="LTerm_ui.html#TYPEt">t</a> -> unit Lwt.t</code></pre><div class="info ">
<code class="code">quit ()</code> quit the given ui and restore the terminal state.<br>
</div>
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type"><a href="LTerm_ui.html#TYPEt">t</a> -> <a href="LTerm_geom.html#TYPEsize">LTerm_geom.size</a></code></pre><div class="info ">
<code class="code">size ui</code> returns the current size of the terminal used by the
given user-interface. It is updated by <a href="LTerm_ui.html#VALwait"><code class="code">LTerm_ui.wait</code></a>.<br>
</div>
<pre><span id="VALdraw"><span class="keyword">val</span> draw</span> : <code class="type"><a href="LTerm_ui.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<code class="code">draw ui</code> enqueue a draw operation for the given UI.<br>
</div>
<pre><span id="VALcursor_visible"><span class="keyword">val</span> cursor_visible</span> : <code class="type"><a href="LTerm_ui.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
<code class="code">cursor_visible ui</code> returns <code class="code">true</code> if the cursor is displayed in
the UI. It is initially not visible.<br>
</div>
<pre><span id="VALset_cursor_visible"><span class="keyword">val</span> set_cursor_visible</span> : <code class="type"><a href="LTerm_ui.html#TYPEt">t</a> -> bool -> unit</code></pre><div class="info ">
<code class="code">set_cursor_visible ui visible</code> sets the cursor visible
state.<br>
</div>
<pre><span id="VALcursor_position"><span class="keyword">val</span> cursor_position</span> : <code class="type"><a href="LTerm_ui.html#TYPEt">t</a> -> <a href="LTerm_geom.html#TYPEcoord">LTerm_geom.coord</a></code></pre><div class="info ">
<code class="code">cursor_position ui</code> returns the position of the cursor inside
the UI.<br>
</div>
<pre><span id="VALset_cursor_position"><span class="keyword">val</span> set_cursor_position</span> : <code class="type"><a href="LTerm_ui.html#TYPEt">t</a> -> <a href="LTerm_geom.html#TYPEcoord">LTerm_geom.coord</a> -> unit</code></pre><div class="info ">
<code class="code">set_cursor_position ui coord</code> sets the position of the cursor
inside the UI.<br>
</div>
<pre><span id="VALwait"><span class="keyword">val</span> wait</span> : <code class="type"><a href="LTerm_ui.html#TYPEt">t</a> -> <a href="LTerm_event.html#TYPEt">LTerm_event.t</a> Lwt.t</code></pre><div class="info ">
<code class="code">wait ui</code> wait for an event.<br>
</div>
</body></html>
