|
1 | 1 | ## Index
|
2 | 2 |
|
3 | 3 | - [term.cursor_to()](#termcursor_to)
|
| 4 | +- [term.cursor_moveto()](#termcursor_moveto) |
4 | 5 | - [term.cursor_up()](#termcursor_up)
|
5 | 6 | - [term.cursor_down()](#termcursor_down)
|
6 | 7 | - [term.cursor_forward()](#termcursor_forward)
|
7 | 8 | - [term.cursor_backward()](#termcursor_backward)
|
8 | 9 | - [term.cursor_line_next()](#termcursor_line_next)
|
9 | 10 | - [term.cursor_line_prev()](#termcursor_line_prev)
|
10 |
| -- [term.cursor_tocolumn()](#termcursor_tocolumn) |
| 11 | +- [term.cursor_horizontal()](#termcursor_horizontal) |
11 | 12 | - [term.cursor_savepos()](#termcursor_savepos)
|
12 | 13 | - [term.cursor_restorepos()](#termcursor_restorepos)
|
13 | 14 | - [term.cursor_save()](#termcursor_save)
|
14 | 15 | - [term.cursor_restore()](#termcursor_restore)
|
15 | 16 | - [term.cursor_hide()](#termcursor_hide)
|
16 | 17 | - [term.cursor_show()](#termcursor_show)
|
17 |
| -- [term.scroll_down()](#termscroll_down) |
18 |
| -- [term.scroll_up()](#termscroll_up) |
19 |
| -- [term.tab_set()](#termtab_set) |
20 |
| -- [term.tab_clear()](#termtab_clear) |
21 |
| -- [term.tab_clearall()](#termtab_clearall) |
| 18 | +- [term.cursor_getpos()](#termcursor_getpos) |
22 | 19 | - [term.erase_line_end()](#termerase_line_end)
|
23 | 20 | - [term.erase_line_start()](#termerase_line_start)
|
24 | 21 | - [term.erase_line()](#termerase_line)
|
25 | 22 | - [term.erase_screen_end()](#termerase_screen_end)
|
26 | 23 | - [term.erase_screen_start()](#termerase_screen_start)
|
27 | 24 | - [term.erase_screen()](#termerase_screen)
|
28 | 25 | - [term.erase_saved_lines()](#termerase_saved_lines)
|
| 26 | +- [term.scroll_down()](#termscroll_down) |
| 27 | +- [term.scroll_up()](#termscroll_up) |
| 28 | +- [term.tab_set()](#termtab_set) |
| 29 | +- [term.tab_clear()](#termtab_clear) |
| 30 | +- [term.tab_clearall()](#termtab_clearall) |
29 | 31 | - [term.beep()](#termbeep)
|
30 | 32 | - [term.hyperlink()](#termhyperlink)
|
31 | 33 |
|
32 | 34 | ### term.cursor_to()
|
33 | 35 |
|
| 36 | +Move the cursor position to a supplied row and column. Both default to `0` if not supplied |
| 37 | + |
| 38 | +#### Arguments |
| 39 | + |
| 40 | +- **$1** (int): row |
| 41 | +- **$1** (int): column |
| 42 | + |
| 43 | +### term.cursor_moveto() |
| 44 | + |
| 45 | +Moves cursor position to a supplied _relative_ row and column. Both default to `0` if not supplied (FIXME: implement) |
| 46 | + |
34 | 47 | #### Arguments
|
35 | 48 |
|
36 | 49 | - **$1** (int): row
|
37 | 50 | - **$1** (int): column
|
38 | 51 |
|
39 | 52 | ### term.cursor_up()
|
40 | 53 |
|
| 54 | +Moves the cursor up. Defaults to `1` if not supplied |
| 55 | + |
41 | 56 | #### Arguments
|
42 | 57 |
|
43 | 58 | - **$1** (int): count
|
44 | 59 |
|
45 | 60 | ### term.cursor_down()
|
46 | 61 |
|
| 62 | +Moves the cursor down. Defaults to `1` if not supplied |
| 63 | + |
47 | 64 | #### Arguments
|
48 | 65 |
|
49 | 66 | - **$1** (int): count
|
50 | 67 |
|
51 | 68 | ### term.cursor_forward()
|
52 | 69 |
|
| 70 | +Moves the cursor forward. Defaults to `1` if not supplied |
| 71 | + |
53 | 72 | #### Arguments
|
54 | 73 |
|
55 | 74 | - **$1** (int): count
|
56 | 75 |
|
57 | 76 | ### term.cursor_backward()
|
58 | 77 |
|
| 78 | +Moves the cursor backwards. Defaults to `1` if not supplied |
| 79 | + |
59 | 80 | #### Arguments
|
60 | 81 |
|
61 | 82 | - **$1** (int): count
|
62 | 83 |
|
63 | 84 | ### term.cursor_line_next()
|
64 | 85 |
|
| 86 | +Moves the cursor to the next line. Defaults to `1` if not supplied |
| 87 | + |
65 | 88 | #### Arguments
|
66 | 89 |
|
67 | 90 | - **$1** (int): count
|
68 | 91 |
|
69 | 92 | ### term.cursor_line_prev()
|
70 | 93 |
|
| 94 | +Moves the cursor to the previous line. Defaults to `1` if not supplied |
| 95 | + |
71 | 96 | #### Arguments
|
72 | 97 |
|
73 | 98 | - **$1** (int): count
|
74 | 99 |
|
75 |
| -### term.cursor_tocolumn() |
| 100 | +### term.cursor_horizontal() |
| 101 | + |
| 102 | +Moves the cursor ? |
76 | 103 |
|
77 | 104 | #### Arguments
|
78 | 105 |
|
79 | 106 | - **$1** (int): count
|
80 | 107 |
|
81 | 108 | ### term.cursor_savepos()
|
82 | 109 |
|
| 110 | +Saves the current cursor position |
| 111 | + |
83 | 112 | _Function has no arguments._
|
84 | 113 |
|
85 | 114 | ### term.cursor_restorepos()
|
86 | 115 |
|
| 116 | +Restores cursor to the last saved position |
| 117 | + |
87 | 118 | _Function has no arguments._
|
88 | 119 |
|
89 | 120 | ### term.cursor_save()
|
90 | 121 |
|
| 122 | +Saves |
| 123 | + |
91 | 124 | _Function has no arguments._
|
92 | 125 |
|
93 | 126 | ### term.cursor_restore()
|
94 | 127 |
|
| 128 | +Restores |
| 129 | + |
95 | 130 | _Function has no arguments._
|
96 | 131 |
|
97 | 132 | ### term.cursor_hide()
|
98 | 133 |
|
| 134 | +Hides the cursor |
| 135 | + |
99 | 136 | _Function has no arguments._
|
100 | 137 |
|
101 | 138 | ### term.cursor_show()
|
102 | 139 |
|
| 140 | +Shows the cursor |
| 141 | + |
103 | 142 | _Function has no arguments._
|
104 | 143 |
|
105 |
| -### term.scroll_down() |
| 144 | +### term.cursor_getpos() |
| 145 | + |
| 146 | +Reports the cursor position to the application as (as though typed at the keyboard) |
106 | 147 |
|
107 | 148 | _Function has no arguments._
|
108 | 149 |
|
109 |
| -### term.scroll_up() |
| 150 | +### term.erase_line_end() |
| 151 | + |
| 152 | +Erase from the current cursor position to the end of the current line |
110 | 153 |
|
111 | 154 | _Function has no arguments._
|
112 | 155 |
|
113 |
| -### term.tab_set() |
| 156 | +### term.erase_line_start() |
| 157 | + |
| 158 | +Erase from the current cursor position to the start of the current line |
114 | 159 |
|
115 | 160 | _Function has no arguments._
|
116 | 161 |
|
117 |
| -### term.tab_clear() |
| 162 | +### term.erase_line() |
| 163 | + |
| 164 | +Erase the entire current line |
118 | 165 |
|
119 | 166 | _Function has no arguments._
|
120 | 167 |
|
121 |
| -### term.tab_clearall() |
| 168 | +### term.erase_screen_end() |
| 169 | + |
| 170 | +Erase the screen from the current line down to the bottom of the screen |
122 | 171 |
|
123 | 172 | _Function has no arguments._
|
124 | 173 |
|
125 |
| -### term.erase_line_end() |
| 174 | +### term.erase_screen_start() |
| 175 | + |
| 176 | +Erase the screen from the current line up to the top of the screen |
126 | 177 |
|
127 | 178 | _Function has no arguments._
|
128 | 179 |
|
129 |
| -### term.erase_line_start() |
| 180 | +### term.erase_screen() |
| 181 | + |
| 182 | +Erase the screen and move the cursor the top left position |
130 | 183 |
|
131 | 184 | _Function has no arguments._
|
132 | 185 |
|
133 |
| -### term.erase_line() |
| 186 | +### term.erase_saved_lines() |
134 | 187 |
|
135 | 188 | _Function has no arguments._
|
136 | 189 |
|
137 |
| -### term.erase_screen_end() |
| 190 | +### term.scroll_down() |
138 | 191 |
|
139 | 192 | _Function has no arguments._
|
140 | 193 |
|
141 |
| -### term.erase_screen_start() |
| 194 | +### term.scroll_up() |
142 | 195 |
|
143 | 196 | _Function has no arguments._
|
144 | 197 |
|
145 |
| -### term.erase_screen() |
| 198 | +### term.tab_set() |
146 | 199 |
|
147 | 200 | _Function has no arguments._
|
148 | 201 |
|
149 |
| -### term.erase_saved_lines() |
| 202 | +### term.tab_clear() |
| 203 | + |
| 204 | +_Function has no arguments._ |
| 205 | + |
| 206 | +### term.tab_clearall() |
150 | 207 |
|
151 | 208 | _Function has no arguments._
|
152 | 209 |
|
|
0 commit comments