diff options
| author | Jesse Luehrs <doy@tozt.net> | 2013-04-03 20:52:01 -0500 |
|---|---|---|
| committer | Jesse Luehrs <doy@tozt.net> | 2013-04-03 20:52:01 -0500 |
| commit | e7bb35dc9f07d6027b98fe31629d1ceec5893480 (patch) | |
| tree | 8f4231862e41aa7979cf0719a17172a94e88117d /info.html | |
| download | rust-term-e7bb35dc9f07d6027b98fe31629d1ceec5893480.tar.gz rust-term-e7bb35dc9f07d6027b98fe31629d1ceec5893480.zip | |
documentation
Diffstat (limited to 'info.html')
| -rw-r--r-- | info.html | 300 |
1 files changed, 300 insertions, 0 deletions
diff --git a/info.html b/info.html new file mode 100644 index 0000000..64d9f2b --- /dev/null +++ b/info.html @@ -0,0 +1,300 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + <meta http-equiv="Content-Style-Type" content="text/css" /> + <meta name="generator" content="pandoc" /> + <title>Module info</title> + <style type="text/css">code{white-space: pre;}</style> + <link rel="stylesheet" href="rust.css" type="text/css" /> +</head> +<body> +<div id="header"> +<h1 class="title">Module info</h1> +</div> +<div class='index'> + +<ul> +<li><a href="#enum-color">Enum <code>Color</code></a> - The default colors available on a terminal emulator.</li> +<li><a href="#implementation-of-corecmpeq-for-color">Implementation <code>of ::core::cmp::Eq for Color</code></a></li> +<li><a href="#function-carriage_return">Function <code>carriage_return</code></a></li> +<li><a href="#function-clear_screen">Function <code>clear_screen</code></a></li> +<li><a href="#function-cursor_address">Function <code>cursor_address</code></a></li> +<li><a href="#function-cursor_home">Function <code>cursor_home</code></a></li> +<li><a href="#function-cursor_invisible">Function <code>cursor_invisible</code></a></li> +<li><a href="#function-cursor_normal">Function <code>cursor_normal</code></a></li> +<li><a href="#function-enter_blink_mode">Function <code>enter_blink_mode</code></a></li> +<li><a href="#function-enter_bold_mode">Function <code>enter_bold_mode</code></a></li> +<li><a href="#function-enter_ca_mode">Function <code>enter_ca_mode</code></a></li> +<li><a href="#function-enter_reverse_mode">Function <code>enter_reverse_mode</code></a></li> +<li><a href="#function-enter_standout_mode">Function <code>enter_standout_mode</code></a></li> +<li><a href="#function-enter_underline_mode">Function <code>enter_underline_mode</code></a></li> +<li><a href="#function-escape">Function <code>escape</code></a> - The terminal escape corresponding to the <code>name</code> terminfo capability.</li> +<li><a href="#function-escape1">Function <code>escape1</code></a> - The terminal escape corresponding to the <code>name</code> terminfo capability.</li> +<li><a href="#function-escape2">Function <code>escape2</code></a> - The terminal escape corresponding to the <code>name</code> terminfo capability.</li> +<li><a href="#function-exit_attribute_mode">Function <code>exit_attribute_mode</code></a></li> +<li><a href="#function-exit_ca_mode">Function <code>exit_ca_mode</code></a></li> +<li><a href="#function-exit_standout_mode">Function <code>exit_standout_mode</code></a></li> +<li><a href="#function-exit_underline_mode">Function <code>exit_underline_mode</code></a></li> +<li><a href="#function-init">Function <code>init</code></a> - Initialize the terminfo database.</li> +<li><a href="#function-key_backspace">Function <code>key_backspace</code></a></li> +<li><a href="#function-key_dc">Function <code>key_dc</code></a></li> +<li><a href="#function-key_down">Function <code>key_down</code></a></li> +<li><a href="#function-key_end">Function <code>key_end</code></a></li> +<li><a href="#function-key_f">Function <code>key_f</code></a> - The terminal escape generated by the F<<code>n</code>> key.</li> +<li><a href="#function-key_f1">Function <code>key_f1</code></a></li> +<li><a href="#function-key_f10">Function <code>key_f10</code></a></li> +<li><a href="#function-key_f11">Function <code>key_f11</code></a></li> +<li><a href="#function-key_f12">Function <code>key_f12</code></a></li> +<li><a href="#function-key_f2">Function <code>key_f2</code></a></li> +<li><a href="#function-key_f3">Function <code>key_f3</code></a></li> +<li><a href="#function-key_f4">Function <code>key_f4</code></a></li> +<li><a href="#function-key_f5">Function <code>key_f5</code></a></li> +<li><a href="#function-key_f6">Function <code>key_f6</code></a></li> +<li><a href="#function-key_f7">Function <code>key_f7</code></a></li> +<li><a href="#function-key_f8">Function <code>key_f8</code></a></li> +<li><a href="#function-key_f9">Function <code>key_f9</code></a></li> +<li><a href="#function-key_home">Function <code>key_home</code></a></li> +<li><a href="#function-key_ic">Function <code>key_ic</code></a></li> +<li><a href="#function-key_left">Function <code>key_left</code></a></li> +<li><a href="#function-key_right">Function <code>key_right</code></a></li> +<li><a href="#function-key_up">Function <code>key_up</code></a></li> +<li><a href="#function-keypad_local">Function <code>keypad_local</code></a></li> +<li><a href="#function-keypad_xmit">Function <code>keypad_xmit</code></a></li> +<li><a href="#function-orig_pair">Function <code>orig_pair</code></a></li> +<li><a href="#function-set_a_background">Function <code>set_a_background</code></a></li> +<li><a href="#function-set_a_foreground">Function <code>set_a_foreground</code></a></li> +<li><a href="#function-tab">Function <code>tab</code></a></li> +</ul> +</div> + +<div class="section level2" id="enum-color"> +<h2>Enum <code>Color</code></h2> +<p>The default colors available on a terminal emulator.</p> +<div class="section level4" id="variants"> +<h4>Variants</h4> +<ul> +<li><code>ColorBlack = 0</code></li> +<li><code>ColorRed</code></li> +<li><code>ColorGreen</code></li> +<li><code>ColorYellow</code></li> +<li><code>ColorBlue</code></li> +<li><code>ColorMagenta</code></li> +<li><code>ColorCyan</code></li> +<li><code>ColorWhite</code></li> +</ul> +</div> +</div> +<div class="section level2" id="implementation-of-corecmpeq-for-color"> +<h2>Implementation of <code>::core::cmp::Eq</code> for <code>Color</code></h2> +<div class="section level3" id="method-eq"> +<h3>Method <code>eq</code></h3> +<pre><code>fn eq(&self, __other: &Color) -> bool</code></pre> +</div> +<div class="section level3" id="method-ne"> +<h3>Method <code>ne</code></h3> +<pre><code>fn ne(&self, __other: &Color) -> bool</code></pre> +</div> +</div> +<div class="section level2" id="function-carriage_return"> +<h2>Function <code>carriage_return</code></h2> +<pre><code>fn carriage_return() -> ~str</code></pre> +</div> +<div class="section level2" id="function-clear_screen"> +<h2>Function <code>clear_screen</code></h2> +<pre><code>fn clear_screen() -> ~str</code></pre> +</div> +<div class="section level2" id="function-cursor_address"> +<h2>Function <code>cursor_address</code></h2> +<pre><code>fn cursor_address(p1: uint, p2: uint) -> ~str</code></pre> +</div> +<div class="section level2" id="function-cursor_home"> +<h2>Function <code>cursor_home</code></h2> +<pre><code>fn cursor_home() -> ~str</code></pre> +</div> +<div class="section level2" id="function-cursor_invisible"> +<h2>Function <code>cursor_invisible</code></h2> +<pre><code>fn cursor_invisible() -> ~str</code></pre> +</div> +<div class="section level2" id="function-cursor_normal"> +<h2>Function <code>cursor_normal</code></h2> +<pre><code>fn cursor_normal() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_blink_mode"> +<h2>Function <code>enter_blink_mode</code></h2> +<pre><code>fn enter_blink_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_bold_mode"> +<h2>Function <code>enter_bold_mode</code></h2> +<pre><code>fn enter_bold_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_ca_mode"> +<h2>Function <code>enter_ca_mode</code></h2> +<pre><code>fn enter_ca_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_reverse_mode"> +<h2>Function <code>enter_reverse_mode</code></h2> +<pre><code>fn enter_reverse_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_standout_mode"> +<h2>Function <code>enter_standout_mode</code></h2> +<pre><code>fn enter_standout_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-enter_underline_mode"> +<h2>Function <code>enter_underline_mode</code></h2> +<pre><code>fn enter_underline_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-escape"> +<h2>Function <code>escape</code></h2> +<pre><code>fn escape(name: &str) -> ~str</code></pre> +<p>The terminal escape corresponding to the <code>name</code> terminfo capability.</p> +</div> +<div class="section level2" id="function-escape1"> +<h2>Function <code>escape1</code></h2> +<pre><code>fn escape1(name: &str, p1: int) -> ~str</code></pre> +<p>The terminal escape corresponding to the <code>name</code> terminfo capability.</p> +<p>This capability must take one parameter, which should be passed as <code>p1</code>.</p> +</div> +<div class="section level2" id="function-escape2"> +<h2>Function <code>escape2</code></h2> +<pre><code>fn escape2(name: &str, p1: int, p2: int) -> ~str</code></pre> +<p>The terminal escape corresponding to the <code>name</code> terminfo capability.</p> +<p>This capability must take two parameters, which should be passed as <code>p1</code> and <code>p2</code>.</p> +</div> +<div class="section level2" id="function-exit_attribute_mode"> +<h2>Function <code>exit_attribute_mode</code></h2> +<pre><code>fn exit_attribute_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-exit_ca_mode"> +<h2>Function <code>exit_ca_mode</code></h2> +<pre><code>fn exit_ca_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-exit_standout_mode"> +<h2>Function <code>exit_standout_mode</code></h2> +<pre><code>fn exit_standout_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-exit_underline_mode"> +<h2>Function <code>exit_underline_mode</code></h2> +<pre><code>fn exit_underline_mode() -> ~str</code></pre> +</div> +<div class="section level2" id="function-init"> +<h2>Function <code>init</code></h2> +<pre><code>fn init()</code></pre> +<p>Initialize the terminfo database.</p> +<p>This must be called before any functions from this module are used. The current terminal is determined by looking at the <code>TERM</code> environment variable.</p> +</div> +<div class="section level2" id="function-key_backspace"> +<h2>Function <code>key_backspace</code></h2> +<pre><code>fn key_backspace() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_dc"> +<h2>Function <code>key_dc</code></h2> +<pre><code>fn key_dc() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_down"> +<h2>Function <code>key_down</code></h2> +<pre><code>fn key_down() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_end"> +<h2>Function <code>key_end</code></h2> +<pre><code>fn key_end() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f"> +<h2>Function <code>key_f</code></h2> +<pre><code>fn key_f(n: uint) -> ~str</code></pre> +<p>The terminal escape generated by the F<<code>n</code>> key.</p> +</div> +<div class="section level2" id="function-key_f1"> +<h2>Function <code>key_f1</code></h2> +<pre><code>fn key_f1() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f10"> +<h2>Function <code>key_f10</code></h2> +<pre><code>fn key_f10() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f11"> +<h2>Function <code>key_f11</code></h2> +<pre><code>fn key_f11() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f12"> +<h2>Function <code>key_f12</code></h2> +<pre><code>fn key_f12() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f2"> +<h2>Function <code>key_f2</code></h2> +<pre><code>fn key_f2() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f3"> +<h2>Function <code>key_f3</code></h2> +<pre><code>fn key_f3() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f4"> +<h2>Function <code>key_f4</code></h2> +<pre><code>fn key_f4() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f5"> +<h2>Function <code>key_f5</code></h2> +<pre><code>fn key_f5() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f6"> +<h2>Function <code>key_f6</code></h2> +<pre><code>fn key_f6() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f7"> +<h2>Function <code>key_f7</code></h2> +<pre><code>fn key_f7() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f8"> +<h2>Function <code>key_f8</code></h2> +<pre><code>fn key_f8() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_f9"> +<h2>Function <code>key_f9</code></h2> +<pre><code>fn key_f9() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_home"> +<h2>Function <code>key_home</code></h2> +<pre><code>fn key_home() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_ic"> +<h2>Function <code>key_ic</code></h2> +<pre><code>fn key_ic() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_left"> +<h2>Function <code>key_left</code></h2> +<pre><code>fn key_left() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_right"> +<h2>Function <code>key_right</code></h2> +<pre><code>fn key_right() -> ~str</code></pre> +</div> +<div class="section level2" id="function-key_up"> +<h2>Function <code>key_up</code></h2> +<pre><code>fn key_up() -> ~str</code></pre> +</div> +<div class="section level2" id="function-keypad_local"> +<h2>Function <code>keypad_local</code></h2> +<pre><code>fn keypad_local() -> ~str</code></pre> +</div> +<div class="section level2" id="function-keypad_xmit"> +<h2>Function <code>keypad_xmit</code></h2> +<pre><code>fn keypad_xmit() -> ~str</code></pre> +</div> +<div class="section level2" id="function-orig_pair"> +<h2>Function <code>orig_pair</code></h2> +<pre><code>fn orig_pair() -> ~str</code></pre> +</div> +<div class="section level2" id="function-set_a_background"> +<h2>Function <code>set_a_background</code></h2> +<pre><code>fn set_a_background(p1: Color) -> ~str</code></pre> +</div> +<div class="section level2" id="function-set_a_foreground"> +<h2>Function <code>set_a_foreground</code></h2> +<pre><code>fn set_a_foreground(p1: Color) -> ~str</code></pre> +</div> +<div class="section level2" id="function-tab"> +<h2>Function <code>tab</code></h2> +<pre><code>fn tab() -> ~str</code></pre> +</div> +</body> +</html> |