|
PyCtrl
An easy beautiful command line interface add-on for python
|
Functions | |
| def | cursorUp (val) |
| def | cursorDown (val) |
| def | cursorRight (val) |
| def | cursorLeft (val) |
| def | print_cursor_value (val, letter) |
| def | setColor (val) |
| def | printList (arr) |
| def | hideCursor () |
| def | resetCursor () |
| def | onCharUp (cursorColor, position) |
| def | onDownChar (arrL, cursorColor, position) |
| def | get_input_char () |
| def | singleChoice (arr, cursorColor="Blue", textOrVal="Val") |
| def | multiChoice (arr, cursorColor="Blue", textOrVal="Val", tickOrCross="T", otherColor="Green") |
@file main.py Documentation for this module. More details.
| def main.cursorDown | ( | val | ) |
| def main.cursorLeft | ( | val | ) |
| def main.cursorRight | ( | val | ) |
| def main.cursorUp | ( | val | ) |
| def main.get_input_char | ( | ) |
| def main.hideCursor | ( | ) |
| def main.onCharUp | ( | cursorColor, | |
| position | |||
| ) |
PURPOSE
@warning {This function is designed to be private, it may be used elswhere if useful hence the lack of attempt to hide}
This function sets the curson color as defined on input as well as moving the cursor up as long as the passed position is not currently greater than zero.
INPUT
cursorColor - Colors defined in setColor
position - current cursor position
RETURNS
position - new position after movement
| def main.onDownChar | ( | arrL, | |
| cursorColor, | |||
| position | |||
| ) |
PURPOSE
\warning {This function is designed to be private, it may be used elswhere if useful hence the lack of attempt to hide}
This function sets the curson color as defined on input as well as moving the cursor down as long as the passed position is not currently at the length of the passed array length.
INPUT
arrL - Length of array printed
cursorColor - Colors defined in setColor
position - current cursor position
RETURNS
position - new position after movement
| def main.print_cursor_value | ( | val, | |
| letter | |||
| ) |
PURPOSE Function designed for printing special @ref ANSI Escape Codes "https://en.wikipedia.org/wiki/ANSI_escape_code#Terminal_input_sequences". The value and letter are concatenated to the escape character before being printed to the console. INPUT val - no verification and validation letter - no verification and validation RETURNS None
| def main.printList | ( | arr | ) |
| def main.resetCursor | ( | ) |
1.8.11