<!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_read_line.read_keyword-c.html">
<link rel="Up" href="LTerm_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="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_read_line.term</title>
</head>
<body>
<div class="navbar"><a class="pre" href="LTerm_read_line.read_keyword-c.html" title="LTerm_read_line.read_keyword">Previous</a>
<a class="up" href="LTerm_read_line.html" title="LTerm_read_line">Up</a>
</div>
<h1>Class virtual <a href="type_LTerm_read_line.term.html">LTerm_read_line.term</a></h1>
<pre><span name="TYPEterm"><span class="keyword">class</span> <span class="keyword">virtual</span> <code class="type">['a]</code> term</span> : <code class="type"><a href="LTerm.html#TYPEt">LTerm.t</a> -> </code><code class="code">object</code> <a href="LTerm_read_line.term-c.html">..</a> <code class="code">end</code></pre><div class="info class top">
Class for read-line instances running in a terminal.<br>
</div>
<b>Inherits</b><ul>
<li><a href="LTerm_read_line.abstract-c.html"><code class="code">LTerm_read_line.abstract</code></a></li>
</ul>
<hr width="100%">
<pre><span id="METHODrun"><span class="keyword">method</span> run</span> : <code class="type">'a Lwt.t</code></pre><div class="info ">
Run this read-line instance.<br>
</div>
<pre><span id="METHODexec"><span class="keyword">method</span> <span class="keyword">private</span> exec</span> : <code class="type"><a href="LTerm_read_line.html#TYPEaction">action</a> list -> 'a Lwt.t</code></pre><div class="info ">
Executes a list of actions. Rememver to call <code class="code">Zed_macro.add
self#macro action</code> if you overload this method.<br>
</div>
<pre><span id="METHODdraw_update"><span class="keyword">method</span> draw_update</span> : <code class="type">unit Lwt.t</code></pre><div class="info ">
Updates current display and put the cursor at current edition
position.<br>
</div>
<pre><span id="METHODdraw_success"><span class="keyword">method</span> draw_success</span> : <code class="type">unit Lwt.t</code></pre><div class="info ">
Draws after accepting current input.<br>
</div>
<pre><span id="METHODdraw_failure"><span class="keyword">method</span> draw_failure</span> : <code class="type">unit Lwt.t</code></pre><div class="info ">
Draws after an exception has been raised.<br>
</div>
<pre><span id="METHODprompt"><span class="keyword">method</span> prompt</span> : <code class="type"><a href="LTerm_read_line.html#TYPEprompt">prompt</a> React.signal</code></pre><div class="info ">
The signal holding the prompt.<br>
</div>
<pre><span id="METHODset_prompt"><span class="keyword">method</span> set_prompt</span> : <code class="type"><a href="LTerm_read_line.html#TYPEprompt">prompt</a> React.signal -> unit</code></pre><div class="info ">
Sets the prompt signal.<br>
</div>
<pre><span id="METHODsize"><span class="keyword">method</span> size</span> : <code class="type"><a href="LTerm_geom.html#TYPEsize">LTerm_geom.size</a> React.signal</code></pre><div class="info ">
The size of the terminal. This can be used for computing the
prompt.<br>
</div>
<pre><span id="METHODkey_sequence"><span class="keyword">method</span> key_sequence</span> : <code class="type"><a href="LTerm_key.html#TYPEt">LTerm_key.t</a> list React.signal</code></pre><div class="info ">
The currently typed key sequence.<br>
</div>
<pre><span id="METHODcompletion_start"><span class="keyword">method</span> completion_start</span> : <code class="type">int React.signal</code></pre><div class="info ">
Index of the first displayed word in the completion bar.<br>
</div>
<pre><span id="METHODhide"><span class="keyword">method</span> hide</span> : <code class="type">unit Lwt.t</code></pre><div class="info ">
Hide this read-line instance. It remains invisible until
<a href="LTerm_read_line.term-c.html#METHODshow"><code class="code">LTerm_read_line.term.show</code></a> is called.<br>
</div>
<pre><span id="METHODshow"><span class="keyword">method</span> show</span> : <code class="type">unit Lwt.t</code></pre><div class="info ">
Show this read-line instance if it has been previously
hidden.<br>
</div>
<pre><span id="ATTvisible"><span class="keyword">val</span> <span class="keyword">mutable</span> visible</span> : <code class="type">bool</code></pre><div class="info ">
Whether the instance is visible.<br>
</div>
</body></html>
