Display TTY  1
Customise your terminal's output
Loading...
Searching...
No Matches
Static Public Member Functions | Static Public Attributes
display_tty.src.colours.LoggerColours Class Reference
Collaboration diagram for display_tty.src.colours.LoggerColours:
Collaboration graph

Static Public Member Functions

str get_colour_string (colour_class, int colour_code)
 
Union[int, None] get_colour_code (colour_class, str colour_name)
 
bool check_if_colour_present (colour_class, str colour_name)
 
list get_all_colours (colour_class)
 

Static Public Attributes

int BLUE = 0
 
int RED = 1
 
int CYAN = 2
 
int BLACK = 3
 
int GREEN = 4
 
int WHITE = 5
 
int YELLOW = 6
 
int PURPLE = 7
 
int LIGHT_RED = 8
 
int LIGHT_BLUE = 9
 
int LIGHT_CYAN = 10
 
int LIGHT_WHITE = 11
 
int LIGHT_BLACK = 12
 
int LIGHT_GREEN = 13
 
int LIGHT_YELLOW = 14
 
int LIGHT_PURPLE = 15
 
int BOLD_BLUE = 16
 
int BOLD_RED = 17
 
int BOLD_CYAN = 18
 
int BOLD_BLACK = 19
 
int BOLD_GREEN = 20
 
int BOLD_WHITE = 21
 
int BOLD_YELLOW = 22
 
int BOLD_PURPLE = 23
 
int BOLD_LIGHT_RED = 24
 
int BOLD_LIGHT_BLUE = 25
 
int BOLD_LIGHT_CYAN = 26
 
int BOLD_LIGHT_WHITE = 27
 
int BOLD_LIGHT_BLACK = 28
 
int BOLD_LIGHT_GREEN = 29
 
int BOLD_LIGHT_YELLOW = 30
 
int BOLD_LIGHT_PURPLE = 31
 
int THIN_BLUE = 32
 
int THIN_RED = 33
 
int THIN_CYAN = 34
 
int THIN_BLACK = 35
 
int THIN_GREEN = 36
 
int THIN_WHITE = 37
 
int THIN_YELLOW = 38
 
int THIN_PURPLE = 39
 
int THIN_LIGHT_RED = 40
 
int THIN_LIGHT_BLUE = 41
 
int THIN_LIGHT_CYAN = 42
 
int THIN_LIGHT_WHITE = 43
 
int THIN_LIGHT_BLACK = 44
 
int THIN_LIGHT_GREEN = 45
 
int THIN_LIGHT_YELLOW = 46
 
int THIN_LIGHT_PURPLE = 47
 

Detailed Description

@class LoggerColours
@brief Class in charge of containing the colour names and id's that correspond to the allowed colours for the logger library.

Definition at line 11 of file colours.py.

Member Function Documentation

◆ check_if_colour_present()

bool display_tty.src.colours.LoggerColours.check_if_colour_present ( colour_class,
str colour_name )
static 
@brief Function in charge of checking if the colour is present in the list of allowed colours.
@param colour_class The class containing the colour definitions.
@param colour_name The name of the colour as a string.
@return True if the colour is present, False otherwise.

Definition at line 100 of file colours.py.

◆ get_all_colours()

list display_tty.src.colours.LoggerColours.get_all_colours ( colour_class)
static 
@brief Function in charge of returning the list of all the colours.
@param colour_class The class containing the colour definitions.
@return A list of all the colour names as strings.

Definition at line 118 of file colours.py.

◆ get_colour_code()

Union[int, None] display_tty.src.colours.LoggerColours.get_colour_code ( colour_class,
str colour_name )
static 
@brief Function in charge of returning the code of the colour to use.
@param colour_class The class containing the colour definitions.
@param colour_name The name of the colour as a string.
@return The integer code of the colour, or None if the name is invalid.

Definition at line 83 of file colours.py.

◆ get_colour_string()

str display_tty.src.colours.LoggerColours.get_colour_string ( colour_class,
int colour_code )
static 
@brief Function in charge of returning the name of the colour to use.
@param colour_class The class containing the colour definitions.
@param colour_code The integer code of the colour.
@return The name of the colour as a string, or an empty string if the code is invalid.

Definition at line 68 of file colours.py.

Field Documentation

◆ BLACK

int display_tty.src.colours.LoggerColours.BLACK = 3
static

Definition at line 21 of file colours.py.

◆ BLUE

int display_tty.src.colours.LoggerColours.BLUE = 0
static

Definition at line 18 of file colours.py.

◆ BOLD_BLACK

int display_tty.src.colours.LoggerColours.BOLD_BLACK = 19
static

Definition at line 37 of file colours.py.

◆ BOLD_BLUE

int display_tty.src.colours.LoggerColours.BOLD_BLUE = 16
static

Definition at line 34 of file colours.py.

◆ BOLD_CYAN

int display_tty.src.colours.LoggerColours.BOLD_CYAN = 18
static

Definition at line 36 of file colours.py.

◆ BOLD_GREEN

int display_tty.src.colours.LoggerColours.BOLD_GREEN = 20
static

Definition at line 38 of file colours.py.

◆ BOLD_LIGHT_BLACK

int display_tty.src.colours.LoggerColours.BOLD_LIGHT_BLACK = 28
static

Definition at line 46 of file colours.py.

◆ BOLD_LIGHT_BLUE

int display_tty.src.colours.LoggerColours.BOLD_LIGHT_BLUE = 25
static

Definition at line 43 of file colours.py.

◆ BOLD_LIGHT_CYAN

int display_tty.src.colours.LoggerColours.BOLD_LIGHT_CYAN = 26
static

Definition at line 44 of file colours.py.

◆ BOLD_LIGHT_GREEN

int display_tty.src.colours.LoggerColours.BOLD_LIGHT_GREEN = 29
static

Definition at line 47 of file colours.py.

◆ BOLD_LIGHT_PURPLE

int display_tty.src.colours.LoggerColours.BOLD_LIGHT_PURPLE = 31
static

Definition at line 49 of file colours.py.

◆ BOLD_LIGHT_RED

int display_tty.src.colours.LoggerColours.BOLD_LIGHT_RED = 24
static

Definition at line 42 of file colours.py.

◆ BOLD_LIGHT_WHITE

int display_tty.src.colours.LoggerColours.BOLD_LIGHT_WHITE = 27
static

Definition at line 45 of file colours.py.

◆ BOLD_LIGHT_YELLOW

int display_tty.src.colours.LoggerColours.BOLD_LIGHT_YELLOW = 30
static

Definition at line 48 of file colours.py.

◆ BOLD_PURPLE

int display_tty.src.colours.LoggerColours.BOLD_PURPLE = 23
static

Definition at line 41 of file colours.py.

◆ BOLD_RED

int display_tty.src.colours.LoggerColours.BOLD_RED = 17
static

Definition at line 35 of file colours.py.

◆ BOLD_WHITE

int display_tty.src.colours.LoggerColours.BOLD_WHITE = 21
static

Definition at line 39 of file colours.py.

◆ BOLD_YELLOW

int display_tty.src.colours.LoggerColours.BOLD_YELLOW = 22
static

Definition at line 40 of file colours.py.

◆ CYAN

int display_tty.src.colours.LoggerColours.CYAN = 2
static

Definition at line 20 of file colours.py.

◆ GREEN

int display_tty.src.colours.LoggerColours.GREEN = 4
static

Definition at line 22 of file colours.py.

◆ LIGHT_BLACK

int display_tty.src.colours.LoggerColours.LIGHT_BLACK = 12
static

Definition at line 30 of file colours.py.

◆ LIGHT_BLUE

int display_tty.src.colours.LoggerColours.LIGHT_BLUE = 9
static

Definition at line 27 of file colours.py.

◆ LIGHT_CYAN

int display_tty.src.colours.LoggerColours.LIGHT_CYAN = 10
static

Definition at line 28 of file colours.py.

◆ LIGHT_GREEN

int display_tty.src.colours.LoggerColours.LIGHT_GREEN = 13
static

Definition at line 31 of file colours.py.

◆ LIGHT_PURPLE

int display_tty.src.colours.LoggerColours.LIGHT_PURPLE = 15
static

Definition at line 33 of file colours.py.

◆ LIGHT_RED

int display_tty.src.colours.LoggerColours.LIGHT_RED = 8
static

Definition at line 26 of file colours.py.

◆ LIGHT_WHITE

int display_tty.src.colours.LoggerColours.LIGHT_WHITE = 11
static

Definition at line 29 of file colours.py.

◆ LIGHT_YELLOW

int display_tty.src.colours.LoggerColours.LIGHT_YELLOW = 14
static

Definition at line 32 of file colours.py.

◆ PURPLE

int display_tty.src.colours.LoggerColours.PURPLE = 7
static

Definition at line 25 of file colours.py.

◆ RED

int display_tty.src.colours.LoggerColours.RED = 1
static

Definition at line 19 of file colours.py.

◆ THIN_BLACK

int display_tty.src.colours.LoggerColours.THIN_BLACK = 35
static

Definition at line 53 of file colours.py.

◆ THIN_BLUE

int display_tty.src.colours.LoggerColours.THIN_BLUE = 32
static

Definition at line 50 of file colours.py.

◆ THIN_CYAN

int display_tty.src.colours.LoggerColours.THIN_CYAN = 34
static

Definition at line 52 of file colours.py.

◆ THIN_GREEN

int display_tty.src.colours.LoggerColours.THIN_GREEN = 36
static

Definition at line 54 of file colours.py.

◆ THIN_LIGHT_BLACK

int display_tty.src.colours.LoggerColours.THIN_LIGHT_BLACK = 44
static

Definition at line 62 of file colours.py.

◆ THIN_LIGHT_BLUE

int display_tty.src.colours.LoggerColours.THIN_LIGHT_BLUE = 41
static

Definition at line 59 of file colours.py.

◆ THIN_LIGHT_CYAN

int display_tty.src.colours.LoggerColours.THIN_LIGHT_CYAN = 42
static

Definition at line 60 of file colours.py.

◆ THIN_LIGHT_GREEN

int display_tty.src.colours.LoggerColours.THIN_LIGHT_GREEN = 45
static

Definition at line 63 of file colours.py.

◆ THIN_LIGHT_PURPLE

int display_tty.src.colours.LoggerColours.THIN_LIGHT_PURPLE = 47
static

Definition at line 65 of file colours.py.

◆ THIN_LIGHT_RED

int display_tty.src.colours.LoggerColours.THIN_LIGHT_RED = 40
static

Definition at line 58 of file colours.py.

◆ THIN_LIGHT_WHITE

int display_tty.src.colours.LoggerColours.THIN_LIGHT_WHITE = 43
static

Definition at line 61 of file colours.py.

◆ THIN_LIGHT_YELLOW

int display_tty.src.colours.LoggerColours.THIN_LIGHT_YELLOW = 46
static

Definition at line 64 of file colours.py.

◆ THIN_PURPLE

int display_tty.src.colours.LoggerColours.THIN_PURPLE = 39
static

Definition at line 57 of file colours.py.

◆ THIN_RED

int display_tty.src.colours.LoggerColours.THIN_RED = 33
static

Definition at line 51 of file colours.py.

◆ THIN_WHITE

int display_tty.src.colours.LoggerColours.THIN_WHITE = 37
static

Definition at line 55 of file colours.py.

◆ THIN_YELLOW

int display_tty.src.colours.LoggerColours.THIN_YELLOW = 38
static

Definition at line 56 of file colours.py.

◆ WHITE

int display_tty.src.colours.LoggerColours.WHITE = 5
static

Definition at line 23 of file colours.py.

◆ YELLOW

int display_tty.src.colours.LoggerColours.YELLOW = 6
static

Definition at line 24 of file colours.py.

The documentation for this class was generated from the following file: