aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 7e9f7ae211e7074254bcf5ea8673602882d7fd59 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# TermIO
Simple library that makes it easier to manipulate the terminal using escape
sequences.

It does not work in all terminal and terminal-emulators. But i have generally
had good with bash.

```
import TermIO
```

## func `TermIO.TermSize.Rows(Update=True)`
Returns rows in terminal as an int.
```
Update : BOOL, should you check the terminal size again, or just [True]
                assume that it hasn't changed since last check.
```

## func `TermIO.TermSize.Columns(Update=True)`
Returns Columns in terminal as an int.
```
Update : BOOL, should you check the terminal size again, or just [True]
                assume that it hasn't changed since last check.
```

## func `TermIO.Cursor.SetPos(col, row, flush=True)`
Set cursor to a spesific column and row in the terminal.
```
col   : The column number to put the cursor.
row   : The row number to put the cursor.
flush : Wether or not to flush the codes printed (Default is true).
```

## func `TermIO.Cursor.Left(n, flush=True)`
Move the cursor `n` characters to the left.
```
n     : number
flush : Wether or not to flush the codes printed (Default is true).
```

## func `TermIO.Cursor.Right(n, flush=True)`
Move the cursor `n` characters to the right.
```
n     : number
flush : Wether or not to flush the codes printed (Default is true).
```

## func `TermIO.Cursor.Up(n, flush=True)`
Move the cursor `n` characters up.
```
n     : number
flush : Wether or not to flush the codes printed (Default is true).
```

## func `TermIO.Cursor.Down(n, flush=True)`
Move the cursor `n` characters to the down.
```
n     : number
flush : Wether or not to flush the codes printed (Default is true).
```

## func `TermIO.Screen.Clear(flush=True)`
Clear the screen.
```
flush : Wether or not to flush the codes printed (Default is true).
```

## func `TermIO.Screen.Flush()`
Flushes printed content to screen.

## func `TermIO.Screen.Decorate(fg=None, bg=None, dec=None, flush=True)`
Clear the screen
```
fg    : Number between 0 and 255. No logical color math... [None]
bg    : Number between 0 and 255. No logical color math... [None]
dec   : Either a string or a list of strings. [None]
            The three possible decorations is
            reversed, underline, bold
            eg:
                TermIO.Screen.Decorate(dec="reversed")
            or
                TermIO.Screen.Decorate(dec=["bold", "reversed"])
flush : Wether or not to flush the codes printed. [True]
```

If you want to print `ESC[0M`, to remove all decorations. Just call this function with `fg=bg=dec=None`.

## func `TermIO.Screen.Write(outStr, flush=True)`
Writes a string to stdout.
```
outStr : string to be printed
flush  : Wether or not to flush the codes printed (Default is true).
```