From e7bb35dc9f07d6027b98fe31629d1ceec5893480 Mon Sep 17 00:00:00 2001 From: Jesse Luehrs Date: Wed, 3 Apr 2013 20:52:01 -0500 Subject: documentation --- info.html | 300 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 300 insertions(+) create mode 100644 info.html (limited to 'info.html') diff --git a/info.html b/info.html new file mode 100644 index 0000000..64d9f2b --- /dev/null +++ b/info.html @@ -0,0 +1,300 @@ + + + + + + + Module info + + + + + +
+ + +
+ +
+

Enum Color

+

The default colors available on a terminal emulator.

+
+

Variants

+
    +
  • ColorBlack = 0
    • +
  • ColorRed
    • +
  • ColorGreen
    • +
  • ColorYellow
    • +
  • ColorBlue
    • +
  • ColorMagenta
    • +
  • ColorCyan
    • +
  • ColorWhite
    • +
+
+
+
+

Implementation of ::core::cmp::Eq for Color

+
+

Method eq

+
fn eq(&self, __other: &Color) -> bool
+
+
+

Method ne

+
fn ne(&self, __other: &Color) -> bool
+
+
+
+

Function carriage_return

+
fn carriage_return() -> ~str
+
+
+

Function clear_screen

+
fn clear_screen() -> ~str
+
+
+

Function cursor_address

+
fn cursor_address(p1: uint, p2: uint) -> ~str
+
+
+

Function cursor_home

+
fn cursor_home() -> ~str
+
+
+

Function cursor_invisible

+
fn cursor_invisible() -> ~str
+
+
+

Function cursor_normal

+
fn cursor_normal() -> ~str
+
+ +
+

Function enter_bold_mode

+
fn enter_bold_mode() -> ~str
+
+
+

Function enter_ca_mode

+
fn enter_ca_mode() -> ~str
+
+
+

Function enter_reverse_mode

+
fn enter_reverse_mode() -> ~str
+
+
+

Function enter_standout_mode

+
fn enter_standout_mode() -> ~str
+
+
+

Function enter_underline_mode

+
fn enter_underline_mode() -> ~str
+
+
+

Function escape

+
fn escape(name: &str) -> ~str
+

The terminal escape corresponding to the name terminfo capability.

+
+
+

Function escape1

+
fn escape1(name: &str, p1: int) -> ~str
+

The terminal escape corresponding to the name terminfo capability.

+

This capability must take one parameter, which should be passed as p1.

+
+
+

Function escape2

+
fn escape2(name: &str, p1: int, p2: int) -> ~str
+

The terminal escape corresponding to the name terminfo capability.

+

This capability must take two parameters, which should be passed as p1 and p2.

+
+
+

Function exit_attribute_mode

+
fn exit_attribute_mode() -> ~str
+
+
+

Function exit_ca_mode

+
fn exit_ca_mode() -> ~str
+
+
+

Function exit_standout_mode

+
fn exit_standout_mode() -> ~str
+
+
+

Function exit_underline_mode

+
fn exit_underline_mode() -> ~str
+
+
+

Function init

+
fn init()
+

Initialize the terminfo database.

+

This must be called before any functions from this module are used. The current terminal is determined by looking at the TERM environment variable.

+
+
+

Function key_backspace

+
fn key_backspace() -> ~str
+
+
+

Function key_dc

+
fn key_dc() -> ~str
+
+
+

Function key_down

+
fn key_down() -> ~str
+
+
+

Function key_end

+
fn key_end() -> ~str
+
+
+

Function key_f

+
fn key_f(n: uint) -> ~str
+

The terminal escape generated by the F<n> key.

+
+
+

Function key_f1

+
fn key_f1() -> ~str
+
+
+

Function key_f10

+
fn key_f10() -> ~str
+
+
+

Function key_f11

+
fn key_f11() -> ~str
+
+
+

Function key_f12

+
fn key_f12() -> ~str
+
+
+

Function key_f2

+
fn key_f2() -> ~str
+
+
+

Function key_f3

+
fn key_f3() -> ~str
+
+
+

Function key_f4

+
fn key_f4() -> ~str
+
+
+

Function key_f5

+
fn key_f5() -> ~str
+
+
+

Function key_f6

+
fn key_f6() -> ~str
+
+
+

Function key_f7

+
fn key_f7() -> ~str
+
+
+

Function key_f8

+
fn key_f8() -> ~str
+
+
+

Function key_f9

+
fn key_f9() -> ~str
+
+
+

Function key_home

+
fn key_home() -> ~str
+
+
+

Function key_ic

+
fn key_ic() -> ~str
+
+
+

Function key_left

+
fn key_left() -> ~str
+
+
+

Function key_right

+
fn key_right() -> ~str
+
+
+

Function key_up

+
fn key_up() -> ~str
+
+
+

Function keypad_local

+
fn keypad_local() -> ~str
+
+
+

Function keypad_xmit

+
fn keypad_xmit() -> ~str
+
+
+

Function orig_pair

+
fn orig_pair() -> ~str
+
+
+

Function set_a_background

+
fn set_a_background(p1: Color) -> ~str
+
+
+

Function set_a_foreground

+
fn set_a_foreground(p1: Color) -> ~str
+
+
+

Function tab

+
fn tab() -> ~str
+
+ + -- cgit v1.2.3-54-g00ecf