1
1
## Index
2
2
3
- * [ term.cursor_to() ] ( #termcursor_to )
4
- * [ term.cursor_moveto() ] ( #termcursor_moveto )
5
- * [ term.cursor_up() ] ( #termcursor_up )
6
- * [ term.cursor_down() ] ( #termcursor_down )
7
- * [ term.cursor_forward() ] ( #termcursor_forward )
8
- * [ term.cursor_backward() ] ( #termcursor_backward )
9
- * [ term.cursor_line_next() ] ( #termcursor_line_next )
10
- * [ term.cursor_line_prev() ] ( #termcursor_line_prev )
11
- * [ term.cursor_horizontal() ] ( #termcursor_horizontal )
12
- * [ term.cursor_savepos() ] ( #termcursor_savepos )
13
- * [ term.cursor_restorepos() ] ( #termcursor_restorepos )
14
- * [ term.cursor_save() ] ( #termcursor_save )
15
- * [ term.cursor_restore() ] ( #termcursor_restore )
16
- * [ term.cursor_hide() ] ( #termcursor_hide )
17
- * [ term.cursor_show() ] ( #termcursor_show )
18
- * [ term.cursor_getpos() ] ( #termcursor_getpos )
19
- * [ term.erase_line_end() ] ( #termerase_line_end )
20
- * [ term.erase_line_start() ] ( #termerase_line_start )
21
- * [ term.erase_line() ] ( #termerase_line )
22
- * [ term.erase_screen_end() ] ( #termerase_screen_end )
23
- * [ term.erase_screen_start() ] ( #termerase_screen_start )
24
- * [ term.erase_screen() ] ( #termerase_screen )
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 )
31
- * [ term.screen_save() ] ( #termscreen_save )
32
- * [ term.screen_restore() ] ( #termscreen_restore )
33
- * [ term.style_reset() ] ( #termstyle_reset )
34
- * [ term.style_bold() ] ( #termstyle_bold )
35
- * [ term.style_dim() ] ( #termstyle_dim )
36
- * [ term.style_italic() ] ( #termstyle_italic )
37
- * [ term.style_underline() ] ( #termstyle_underline )
38
- * [ term.style_inverse() ] ( #termstyle_inverse )
39
- * [ term.style_hidden() ] ( #termstyle_hidden )
40
- * [ term.style_strikethrough() ] ( #termstyle_strikethrough )
41
- * [ term.style_hyperlink() ] ( #termstyle_hyperlink )
42
- * [ term.color_black() ] ( #termcolor_black )
43
- * [ term.color_red() ] ( #termcolor_red )
44
- * [ term.color_green() ] ( #termcolor_green )
45
- * [ term.color_orange() ] ( #termcolor_orange )
46
- * [ term.color_blue() ] ( #termcolor_blue )
47
- * [ term.color_purple() ] ( #termcolor_purple )
48
- * [ term.color_cyan() ] ( #termcolor_cyan )
49
- * [ term.color_light_gray() ] ( #termcolor_light_gray )
50
- * [ term.color_dark_gray() ] ( #termcolor_dark_gray )
51
- * [ term.color_light_red() ] ( #termcolor_light_red )
52
- * [ term.color_light_green() ] ( #termcolor_light_green )
53
- * [ term.color_yellow() ] ( #termcolor_yellow )
54
- * [ term.color_light_blue() ] ( #termcolor_light_blue )
55
- * [ term.color_light_purple() ] ( #termcolor_light_purple )
56
- * [ term.color_light_cyan() ] ( #termcolor_light_cyan )
57
- * [ term.color_white() ] ( #termcolor_white )
58
- * [ term.beep() ] ( #termbeep )
59
- * [ term.hyperlink() ] ( #termhyperlink )
60
- * [ term.bold() ] ( #termbold )
61
- * [ term.italic() ] ( #termitalic )
62
- * [ term.underline() ] ( #termunderline )
63
- * [ term.strikethrough() ] ( #termstrikethrough )
64
-
65
- ### term.cursor_to()
3
+ * [ term.cursor_to] ( #termcursor_to )
4
+ * [ term.cursor_moveto] ( #termcursor_moveto )
5
+ * [ term.cursor_up] ( #termcursor_up )
6
+ * [ term.cursor_down] ( #termcursor_down )
7
+ * [ term.cursor_forward] ( #termcursor_forward )
8
+ * [ term.cursor_backward] ( #termcursor_backward )
9
+ * [ term.cursor_line_next] ( #termcursor_line_next )
10
+ * [ term.cursor_line_prev] ( #termcursor_line_prev )
11
+ * [ term.cursor_horizontal] ( #termcursor_horizontal )
12
+ * [ term.cursor_savepos] ( #termcursor_savepos )
13
+ * [ term.cursor_restorepos] ( #termcursor_restorepos )
14
+ * [ term.cursor_save] ( #termcursor_save )
15
+ * [ term.cursor_restore] ( #termcursor_restore )
16
+ * [ term.cursor_hide] ( #termcursor_hide )
17
+ * [ term.cursor_show] ( #termcursor_show )
18
+ * [ term.cursor_getpos] ( #termcursor_getpos )
19
+ * [ term.erase_line_end] ( #termerase_line_end )
20
+ * [ term.erase_line_start] ( #termerase_line_start )
21
+ * [ term.erase_line] ( #termerase_line )
22
+ * [ term.erase_screen_end] ( #termerase_screen_end )
23
+ * [ term.erase_screen_start] ( #termerase_screen_start )
24
+ * [ term.erase_screen] ( #termerase_screen )
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 )
31
+ * [ term.screen_save] ( #termscreen_save )
32
+ * [ term.screen_restore] ( #termscreen_restore )
33
+ * [ term.style_reset] ( #termstyle_reset )
34
+ * [ term.style_bold] ( #termstyle_bold )
35
+ * [ term.style_dim] ( #termstyle_dim )
36
+ * [ term.style_italic] ( #termstyle_italic )
37
+ * [ term.style_underline] ( #termstyle_underline )
38
+ * [ term.style_inverse] ( #termstyle_inverse )
39
+ * [ term.style_hidden] ( #termstyle_hidden )
40
+ * [ term.style_strikethrough] ( #termstyle_strikethrough )
41
+ * [ term.style_hyperlink] ( #termstyle_hyperlink )
42
+ * [ term.color_black] ( #termcolor_black )
43
+ * [ term.color_red] ( #termcolor_red )
44
+ * [ term.color_green] ( #termcolor_green )
45
+ * [ term.color_orange] ( #termcolor_orange )
46
+ * [ term.color_blue] ( #termcolor_blue )
47
+ * [ term.color_purple] ( #termcolor_purple )
48
+ * [ term.color_cyan] ( #termcolor_cyan )
49
+ * [ term.color_light_gray] ( #termcolor_light_gray )
50
+ * [ term.color_dark_gray] ( #termcolor_dark_gray )
51
+ * [ term.color_light_red] ( #termcolor_light_red )
52
+ * [ term.color_light_green] ( #termcolor_light_green )
53
+ * [ term.color_yellow] ( #termcolor_yellow )
54
+ * [ term.color_light_blue] ( #termcolor_light_blue )
55
+ * [ term.color_light_purple] ( #termcolor_light_purple )
56
+ * [ term.color_light_cyan] ( #termcolor_light_cyan )
57
+ * [ term.color_white] ( #termcolor_white )
58
+ * [ term.beep] ( #termbeep )
59
+ * [ term.hyperlink] ( #termhyperlink )
60
+ * [ term.bold] ( #termbold )
61
+ * [ term.italic] ( #termitalic )
62
+ * [ term.underline] ( #termunderline )
63
+ * [ term.strikethrough] ( #termstrikethrough )
64
+
65
+ ### term.cursor_to
66
66
67
67
Move the cursor position to a supplied row and column. Both default to ` 0 ` if not supplied
68
68
@@ -71,7 +71,7 @@ Move the cursor position to a supplied row and column. Both default to `0` if no
71
71
* ** $1** (int): row
72
72
* ** $1** (int): column
73
73
74
- ### term.cursor_moveto()
74
+ ### term.cursor_moveto
75
75
76
76
Moves cursor position to a supplied _ relative_ row and column. Both default to ` 0 ` if not supplied (FIXME: implement)
77
77
@@ -80,241 +80,241 @@ Moves cursor position to a supplied _relative_ row and column. Both default to `
80
80
* ** $1** (int): row
81
81
* ** $1** (int): column
82
82
83
- ### term.cursor_up()
83
+ ### term.cursor_up
84
84
85
85
Moves the cursor up. Defaults to ` 1 ` if not supplied
86
86
87
87
#### Arguments
88
88
89
89
* ** $1** (int): count
90
90
91
- ### term.cursor_down()
91
+ ### term.cursor_down
92
92
93
93
Moves the cursor down. Defaults to ` 1 ` if not supplied
94
94
95
95
#### Arguments
96
96
97
97
* ** $1** (int): count
98
98
99
- ### term.cursor_forward()
99
+ ### term.cursor_forward
100
100
101
101
Moves the cursor forward. Defaults to ` 1 ` if not supplied
102
102
103
103
#### Arguments
104
104
105
105
* ** $1** (int): count
106
106
107
- ### term.cursor_backward()
107
+ ### term.cursor_backward
108
108
109
109
Moves the cursor backwards. Defaults to ` 1 ` if not supplied
110
110
111
111
#### Arguments
112
112
113
113
* ** $1** (int): count
114
114
115
- ### term.cursor_line_next()
115
+ ### term.cursor_line_next
116
116
117
117
Moves the cursor to the next line. Defaults to ` 1 ` if not supplied
118
118
119
119
#### Arguments
120
120
121
121
* ** $1** (int): count
122
122
123
- ### term.cursor_line_prev()
123
+ ### term.cursor_line_prev
124
124
125
125
Moves the cursor to the previous line. Defaults to ` 1 ` if not supplied
126
126
127
127
#### Arguments
128
128
129
129
* ** $1** (int): count
130
130
131
- ### term.cursor_horizontal()
131
+ ### term.cursor_horizontal
132
132
133
133
Moves the cursor ?
134
134
135
135
#### Arguments
136
136
137
137
* ** $1** (int): count
138
138
139
- ### term.cursor_savepos()
139
+ ### term.cursor_savepos
140
140
141
141
Saves the current cursor position
142
142
143
143
_ Function has no arguments._
144
144
145
- ### term.cursor_restorepos()
145
+ ### term.cursor_restorepos
146
146
147
147
Restores cursor to the last saved position
148
148
149
149
_ Function has no arguments._
150
150
151
- ### term.cursor_save()
151
+ ### term.cursor_save
152
152
153
153
Saves
154
154
155
155
_ Function has no arguments._
156
156
157
- ### term.cursor_restore()
157
+ ### term.cursor_restore
158
158
159
159
Restores
160
160
161
161
_ Function has no arguments._
162
162
163
- ### term.cursor_hide()
163
+ ### term.cursor_hide
164
164
165
165
Hides the cursor
166
166
167
167
_ Function has no arguments._
168
168
169
- ### term.cursor_show()
169
+ ### term.cursor_show
170
170
171
171
Shows the cursor
172
172
173
173
_ Function has no arguments._
174
174
175
- ### term.cursor_getpos()
175
+ ### term.cursor_getpos
176
176
177
177
Reports the cursor position to the application as (as though typed at the keyboard)
178
178
179
179
_ Function has no arguments._
180
180
181
- ### term.erase_line_end()
181
+ ### term.erase_line_end
182
182
183
183
Erase from the current cursor position to the end of the current line
184
184
185
185
_ Function has no arguments._
186
186
187
- ### term.erase_line_start()
187
+ ### term.erase_line_start
188
188
189
189
Erase from the current cursor position to the start of the current line
190
190
191
191
_ Function has no arguments._
192
192
193
- ### term.erase_line()
193
+ ### term.erase_line
194
194
195
195
Erase the entire current line
196
196
197
197
_ Function has no arguments._
198
198
199
- ### term.erase_screen_end()
199
+ ### term.erase_screen_end
200
200
201
201
Erase the screen from the current line down to the bottom of the screen
202
202
203
203
_ Function has no arguments._
204
204
205
- ### term.erase_screen_start()
205
+ ### term.erase_screen_start
206
206
207
207
Erase the screen from the current line up to the top of the screen
208
208
209
209
_ Function has no arguments._
210
210
211
- ### term.erase_screen()
211
+ ### term.erase_screen
212
212
213
213
Erase the screen and move the cursor the top left position
214
214
215
215
_ Function has no arguments._
216
216
217
- ### term.erase_saved_lines()
217
+ ### term.erase_saved_lines
218
218
219
219
_ Function has no arguments._
220
220
221
- ### term.scroll_down()
221
+ ### term.scroll_down
222
222
223
223
_ Function has no arguments._
224
224
225
- ### term.scroll_up()
225
+ ### term.scroll_up
226
226
227
227
_ Function has no arguments._
228
228
229
- ### term.tab_set()
229
+ ### term.tab_set
230
230
231
231
_ Function has no arguments._
232
232
233
- ### term.tab_clear()
233
+ ### term.tab_clear
234
234
235
235
_ Function has no arguments._
236
236
237
- ### term.tab_clearall()
237
+ ### term.tab_clearall
238
238
239
239
_ Function has no arguments._
240
240
241
- ### term.screen_save()
241
+ ### term.screen_save
242
242
243
243
Save screen
244
244
245
245
_ Function has no arguments._
246
246
247
- ### term.screen_restore()
247
+ ### term.screen_restore
248
248
249
249
Restore screen
250
250
251
251
_ Function has no arguments._
252
252
253
- ### term.style_reset()
253
+ ### term.style_reset
254
254
255
255
Construct reset
256
256
257
257
#### Arguments
258
258
259
259
* ** $1** (string): text
260
260
261
- ### term.style_bold()
261
+ ### term.style_bold
262
262
263
263
Construct bold
264
264
265
265
#### Arguments
266
266
267
267
* ** $1** (string): text
268
268
269
- ### term.style_dim()
269
+ ### term.style_dim
270
270
271
271
Construct dim
272
272
273
273
#### Arguments
274
274
275
275
* ** $1** (string): text
276
276
277
- ### term.style_italic()
277
+ ### term.style_italic
278
278
279
279
Construct italic
280
280
281
281
#### Arguments
282
282
283
283
* ** $1** (string): text
284
284
285
- ### term.style_underline()
285
+ ### term.style_underline
286
286
287
287
Construct underline
288
288
289
289
#### Arguments
290
290
291
291
* ** $1** (string): text
292
292
293
- ### term.style_inverse()
293
+ ### term.style_inverse
294
294
295
295
Construct inverse
296
296
297
297
#### Arguments
298
298
299
299
* ** $1** (string): text
300
300
301
- ### term.style_hidden()
301
+ ### term.style_hidden
302
302
303
303
Construct hidden
304
304
305
305
#### Arguments
306
306
307
307
* ** $1** (string): text
308
308
309
- ### term.style_strikethrough()
309
+ ### term.style_strikethrough
310
310
311
311
Construct strikethrough
312
312
313
313
#### Arguments
314
314
315
315
* ** $1** (string): text
316
316
317
- ### term.style_hyperlink()
317
+ ### term.style_hyperlink
318
318
319
319
Construct hyperlink
320
320
@@ -323,141 +323,141 @@ Construct hyperlink
323
323
* ** $1** (string): text
324
324
* ** $2** (string): url
325
325
326
- ### term.color_black()
326
+ ### term.color_black
327
327
328
328
Construct black color
329
329
330
330
#### Arguments
331
331
332
332
* ** $1** (string): text
333
333
334
- ### term.color_red()
334
+ ### term.color_red
335
335
336
336
Construct red color
337
337
338
338
#### Arguments
339
339
340
340
* ** $1** (string): text
341
341
342
- ### term.color_green()
342
+ ### term.color_green
343
343
344
344
Construct green color
345
345
346
346
#### Arguments
347
347
348
348
* ** $1** (string): text
349
349
350
- ### term.color_orange()
350
+ ### term.color_orange
351
351
352
352
Construct orange color
353
353
354
354
#### Arguments
355
355
356
356
* ** $1** (string): text
357
357
358
- ### term.color_blue()
358
+ ### term.color_blue
359
359
360
360
Construct blue color
361
361
362
362
#### Arguments
363
363
364
364
* ** $1** (string): text
365
365
366
- ### term.color_purple()
366
+ ### term.color_purple
367
367
368
368
Construct purple color
369
369
370
370
#### Arguments
371
371
372
372
* ** $1** (string): text
373
373
374
- ### term.color_cyan()
374
+ ### term.color_cyan
375
375
376
376
Construct cyan color
377
377
378
378
#### Arguments
379
379
380
380
* ** $1** (string): text
381
381
382
- ### term.color_light_gray()
382
+ ### term.color_light_gray
383
383
384
384
Construct light gray color
385
385
386
386
#### Arguments
387
387
388
388
* ** $1** (string): text
389
389
390
- ### term.color_dark_gray()
390
+ ### term.color_dark_gray
391
391
392
392
Construct dark gray color
393
393
394
394
#### Arguments
395
395
396
396
* ** $1** (string): text
397
397
398
- ### term.color_light_red()
398
+ ### term.color_light_red
399
399
400
400
Construct light red color
401
401
402
402
#### Arguments
403
403
404
404
* ** $1** (string): text
405
405
406
- ### term.color_light_green()
406
+ ### term.color_light_green
407
407
408
408
Construct light green color
409
409
410
410
#### Arguments
411
411
412
412
* ** $1** (string): text
413
413
414
- ### term.color_yellow()
414
+ ### term.color_yellow
415
415
416
416
Construct yellow color
417
417
418
418
#### Arguments
419
419
420
420
* ** $1** (string): text
421
421
422
- ### term.color_light_blue()
422
+ ### term.color_light_blue
423
423
424
424
Construct light blue color
425
425
426
426
#### Arguments
427
427
428
428
* ** $1** (string): text
429
429
430
- ### term.color_light_purple()
430
+ ### term.color_light_purple
431
431
432
432
Construct light purple color
433
433
434
434
#### Arguments
435
435
436
436
* ** $1** (string): text
437
437
438
- ### term.color_light_cyan()
438
+ ### term.color_light_cyan
439
439
440
440
Construct light cyan color
441
441
442
442
#### Arguments
443
443
444
444
* ** $1** (string): text
445
445
446
- ### term.color_white()
446
+ ### term.color_white
447
447
448
448
Construct white color
449
449
450
450
#### Arguments
451
451
452
452
* ** $1** (string): text
453
453
454
- ### term.beep()
454
+ ### term.beep
455
455
456
456
Construct a beep
457
457
458
458
_ Function has no arguments._
459
459
460
- ### term.hyperlink()
460
+ ### term.hyperlink
461
461
462
462
(DEPRECATED) Construct hyperlink
463
463
@@ -466,31 +466,31 @@ _Function has no arguments._
466
466
* ** $1** (string): text
467
467
* ** $2** (string): url
468
468
469
- ### term.bold()
469
+ ### term.bold
470
470
471
471
(DEPRECATED) Construct bold
472
472
473
473
#### Arguments
474
474
475
475
* ** $1** (string): text
476
476
477
- ### term.italic()
477
+ ### term.italic
478
478
479
479
(DEPRECATED) Construct italic
480
480
481
481
#### Arguments
482
482
483
483
* ** $1** (string): text
484
484
485
- ### term.underline()
485
+ ### term.underline
486
486
487
487
(DEPRECATED) Construct underline
488
488
489
489
#### Arguments
490
490
491
491
* ** $1** (string): text
492
492
493
- ### term.strikethrough()
493
+ ### term.strikethrough
494
494
495
495
(DEPRECATED) Construct strikethrough
496
496
0 commit comments