<!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="Lwt_read_line.Engine.html">
<link rel="next" href="Lwt_read_line.Control.html">
<link rel="Up" href="Lwt_read_line.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="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Lwt_condition" rel="Chapter" href="Lwt_condition.html">
<link title="Lwt_list" rel="Chapter" href="Lwt_list.html">
<link title="Lwt" rel="Chapter" href="Lwt.html">
<link title="Lwt_mutex" rel="Chapter" href="Lwt_mutex.html">
<link title="Lwt_mvar" rel="Chapter" href="Lwt_mvar.html">
<link title="Lwt_pool" rel="Chapter" href="Lwt_pool.html">
<link title="Lwt_sequence" rel="Chapter" href="Lwt_sequence.html">
<link title="Lwt_stream" rel="Chapter" href="Lwt_stream.html">
<link title="Lwt_switch" rel="Chapter" href="Lwt_switch.html">
<link title="Lwt_util" rel="Chapter" href="Lwt_util.html">
<link title="Lwt_pqueue" rel="Chapter" href="Lwt_pqueue.html">
<link title="Lwt_lib" rel="Chapter" href="Lwt_lib.html">
<link title="Lwt_glib" rel="Chapter" href="Lwt_glib.html">
<link title="Lwt_preemptive" rel="Chapter" href="Lwt_preemptive.html">
<link title="Lwt_event" rel="Chapter" href="Lwt_event.html">
<link title="Lwt_signal" rel="Chapter" href="Lwt_signal.html">
<link title="Lwt_react" rel="Chapter" href="Lwt_react.html">
<link title="Lwt_ssl" rel="Chapter" href="Lwt_ssl.html">
<link title="Lwt_text" rel="Chapter" href="Lwt_text.html">
<link title="Lwt_term" rel="Chapter" href="Lwt_term.html">
<link title="Lwt_read_line" rel="Chapter" href="Lwt_read_line.html">
<link title="Lwt_top" rel="Chapter" href="Lwt_top.html">
<link title="Lwt_chan" rel="Chapter" href="Lwt_chan.html">
<link title="Lwt_daemon" rel="Chapter" href="Lwt_daemon.html">
<link title="Lwt_gc" rel="Chapter" href="Lwt_gc.html">
<link title="Lwt_io" rel="Chapter" href="Lwt_io.html">
<link title="Lwt_log" rel="Chapter" href="Lwt_log.html">
<link title="Lwt_main" rel="Chapter" href="Lwt_main.html">
<link title="Lwt_process" rel="Chapter" href="Lwt_process.html">
<link title="Lwt_throttle" rel="Chapter" href="Lwt_throttle.html">
<link title="Lwt_timeout" rel="Chapter" href="Lwt_timeout.html">
<link title="Lwt_unix" rel="Chapter" href="Lwt_unix.html">
<link title="Lwt_sys" rel="Chapter" href="Lwt_sys.html">
<link title="Lwt_engine" rel="Chapter" href="Lwt_engine.html">
<link title="Lwt_bytes" rel="Chapter" href="Lwt_bytes.html">
<link title="Pa_lwt" rel="Chapter" href="Pa_lwt.html">
<link title="Pa_lwt_log" rel="Chapter" href="Pa_lwt_log.html"><title>Lwt_read_line.Terminal</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Lwt_read_line.Engine.html" title="Lwt_read_line.Engine">Previous</a>
<a class="up" href="Lwt_read_line.html" title="Lwt_read_line">Up</a>
<a class="post" href="Lwt_read_line.Control.html" title="Lwt_read_line.Control">Next</a>
</div>
<h1>Module <a href="type_Lwt_read_line.Terminal.html">Lwt_read_line.Terminal</a></h1>
<pre><span class="keyword">module</span> Terminal: <code class="code"><span class="keyword">sig</span></code> <a href="Lwt_read_line.Terminal.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info">
Rendering to the terminal<br>
</div>
<hr width="100%">
<pre><span id="TYPEstate"><span class="keyword">type</span> <code class="type"></code>state</span> </pre>
<div class="info">
State of rendering<br>
</div>
<pre><span id="VALinit"><span class="keyword">val</span> init</span> : <code class="type"><a href="Lwt_read_line.Terminal.html#TYPEstate">state</a></code></pre><div class="info">
Initial state<br>
</div>
<br>
The following functions are the one used by read-line functions
of this module.<br>
<pre><code><span id="TYPEbox"><span class="keyword">type</span> <code class="type"></code>box</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTbox.Box_none"><span class="constructor">Box_none</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >No box at all</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTbox.Box_empty"><span class="constructor">Box_empty</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >An empty box</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTbox.Box_words"><span class="constructor">Box_words</span></span> <span class="keyword">of</span> <code class="type"><a href="Lwt_read_line.html#TYPEtext_set">Lwt_read_line.text_set</a> * int</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" ><code class="code"><span class="constructor">BM_words</span>(words, position)</code> is a box with the given list
of words. <code class="code">position</code> is the position of the selected word
in the list..</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTbox.Box_message"><span class="constructor">Box_message</span></span> <span class="keyword">of</span> <code class="type">string</code></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >A box containing only the given message</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info">
Box for the completion:<br>
</div>
<pre><span id="VALdraw"><span class="keyword">val</span> draw</span> : <code class="type">columns:int -><br> ?map_text:(Text.t -> Text.t) -><br> ?box:<a href="Lwt_read_line.Terminal.html#TYPEbox">box</a> -><br> render_state:<a href="Lwt_read_line.Terminal.html#TYPEstate">state</a> -><br> engine_state:<a href="Lwt_read_line.Engine.html#TYPEstate">Lwt_read_line.Engine.state</a> -><br> prompt:<a href="Lwt_read_line.html#TYPEprompt">Lwt_read_line.prompt</a> -><br> unit -> <a href="Lwt_term.html#TYPEstyled_text">Lwt_term.styled_text</a> * <a href="Lwt_read_line.Terminal.html#TYPEstate">state</a></code></pre><div class="info">
<code class="code">draw ~column ?map_text ?bar ~render_state ~engine_state
prompt ()</code> returns <code class="code">(text, state)</code> where <code class="code">state</code> is the new
rendering state, and <code class="code">text</code> is a text containing escape
sequences. When printed, it will update the displayed state.<br>
</div>
<div class="param_info"><code class="code">map_text</code> : is a function used to map user input before
printing it, for example to hide passwords.</div>
<div class="param_info"><code class="code">box</code> : defaults to <code class="code"><span class="constructor">Box_none</span></code>.</div>
<pre><span id="VALlast_draw"><span class="keyword">val</span> last_draw</span> : <code class="type">columns:int -><br> ?map_text:(Text.t -> Text.t) -><br> render_state:<a href="Lwt_read_line.Terminal.html#TYPEstate">state</a> -><br> engine_state:<a href="Lwt_read_line.Engine.html#TYPEstate">Lwt_read_line.Engine.state</a> -><br> prompt:<a href="Lwt_read_line.html#TYPEprompt">Lwt_read_line.prompt</a> -> unit -> <a href="Lwt_term.html#TYPEstyled_text">Lwt_term.styled_text</a></code></pre><div class="info">
Draw for the last time, i.e. the cursor is left after the text
and not at current position.<br>
</div>
<pre><span id="VALerase"><span class="keyword">val</span> erase</span> : <code class="type">columns:int -><br> render_state:<a href="Lwt_read_line.Terminal.html#TYPEstate">state</a> -> unit -> <a href="Lwt_term.html#TYPEstyled_text">Lwt_term.styled_text</a></code></pre><div class="info">
<code class="code">erase ~columns ~render_state ()</code> returns a text which will
erase everything (the prompt, user input, completion, ...).
<p>
After an erase, the rendering state is <code class="code">init</code>.<br>
</div>
</body></html>
