Page Index - GabrielSCabrera/Termighty GitHub Wiki

137 page(s) in this GitHub Wiki:

• Home
• Termighty
• High-level utilities for cross-platform terminal interaction.
• Class Documentation: System
• Attributes
• terminal_size: tuple[int, int]
• os
• escape_code_encoding
• kill_all
• Methods
• track_terminal_shape(cls)
• Threading
• track_terminal_shape_thread
• Class Documentation: Term
• Methods
• init(self, flush: bool = False) -> None
• bell(self, flush: bool = False) -> None
• clear(self, flush: bool = False) -> None
• cursor_hide(self, flush: bool = False) -> None
• cursor_load(self, flush: bool = False) -> None
• cursor_move(self, line: int, column: int, flush: bool = False) -> None
• cursor_save(self, flush: bool = False) -> None
• cursor_show(self, flush: bool = False) -> None
• flush(self) -> None
• flush_string(self, string: str) -> None
• write(self, line: int, column: int, string: str, flush: bool = False) -> None
• Class Documentation: String
• Class Methods
• list_styles() -> str
• Constructor
• init(string: str, foreground: Optional[Union[str, Color, tuple[int, int, int]]] = None, background: Optional[Union[str, Color, tuple[int, int, int]]] = None, style: Optional[str] = None) -> None
• Magic Methods
• Properties
• background -> Color
• foreground -> Color
• string -> str
• style -> str
• Setter Methods
• background.setter(color: Optional[Union[str, Color, tuple[int, int, int]]] = None) -> None
• foreground.setter(color: Optional[Union[str, Color, tuple[int, int, int]]] = None) -> None
• string.setter(data: str) -> None
• style.setter(style: Optional[str] = None) -> None
• Class: Color
• Class Methods:
• chart(r: Optional[int], g: Optional[int], b: Optional[int], term_width: int) -> str
• is_color(name: str) -> bool
• list_colors(sort_by="step") -> str
• palette(name: str) -> "Color"
• Properties:
• sample -> str
• Constructor:
• init(self, rgb: Sequence[int], name: str = "Unnamed Color") -> None
• Magic Methods:
• add(self, color: "Color") -> "Color"
• call(self, string: str) -> str
• hash(self) -> int
• repr(self) -> str
• str(self) -> str
• sub(self, color: "Color") -> "Color"
• Properties (Getters/Setters):
• b -> int
• g -> int
• name -> str
• r -> int
• rgb -> tuple[int, int, int]
• Public Methods:
• brightness(self) -> int
• copy(self) -> "Color"
• hsv(self) -> tuple[float, float, float]
• lightness(self, weighted: bool = True) -> float
• negative(self) -> "Color"
• Class: GetchIterator
• Methods
• init(self, idx: Optional[int] = None)
• iter(self)
• next(self)
• Class: Listener
• Class Attributes
• _active
• _escape_hits
• _history
• _raw
• _sleep_time
• Class Methods
• _getch_linux()
• _getch_windows()
• _interpret_escape_code(escape_code: bytes) -> str
• _listener()
• _listener_raw()
• _raw_mode_linux(state: bool)
• _raw_mode_windows(state: bool)
• Public Methods
• getch_iterator(cls, idx: Optional[int] = None, keytest: bool = False) -> GetchIterator
• start(cls, raw: bool = False)
• stop(cls)
• OS-Specific Methods
• _getch
• _raw_mode
• _fd
• _old_settings
• Class: TextBox
• Constructor
• init(self, row_start: int, col_start: int, row_end: int, col_end: int, wrap_text: bool = False, wrap_subsequent_indent: str = "", wrap_text_break_on_hyphens: bool = True, wrap_text_break_long_words: bool = True, background: Optional[Union[str, Color]] = None, foreground: Optional[Union[str, Color]] = None, style: Optional[str] = None, alignment: Literal["left", "right", "center"] = "left", view: tuple[int, int] = (0, 0),) -> None
• call(self, text: Union[str, list[str, ...]]) -> None
• _process_text(self) -> None
• _init_color_attributes(self, background: Color, foreground: Color, style: str) -> None
• _init_spacial_attributes(self, row_start: int, col_start: int, row_end: int, col_end: int, view: tuple[int, int]) -> None
• _process_text_wrapper(self) -> None
• _init_arguments(self, background: Union[str, Color, tuple[int, int, int]], foreground: Union[str, Color, tuple[int, int, int]], style: str, defaults: tuple[Color, Color, str], argnames: tuple[str, str, str]) -> tuple[Color, Color, str]
• _run_thread(self, dt: float) -> None
• _set_shape(self) -> None
• _set_view(self) -> None
• Public Methods
• start(self, dt: float = 0.005) -> None
• stop(self) -> None
• alignment(self, mode: str) -> None
• TextEditor Class
• Constructor
• init(self, row_start: int, col_start: int, row_end: int, col_end: int, wrap_text: bool = False, wrap_subsequent_indent: str = "", line_numbers: bool = False, background: Union[str, Color, tuple[int, int, int]] = None, foreground: Union[str, Color, tuple[int, int, int]] = None, style: Optional[str] = None, select_background: Union[str, Color, tuple[int, int, int]] = None, select_foreground: Union[str, Color, tuple[int, int, int]] = None, select_style: Optional[str] = None, line_number_background: Union[str, Color, tuple[int, int, int]] = None, line_number_foreground: Union[str, Color, tuple[int, int, int]] = None, line_number_style: Optional[str] = None, vertical_scroll_buffer: Optional[int] = None, horizontal_scroll_buffer: Optional[int] = None, cursor_position: tuple[int, int] = (0, 0), frozen: bool = False,)
• Methods
• _init_editor_attributes(self, cursor_position, frozen, line_numbers, select_background, select_foreground, select_style, line_number_background, line_number_foreground, line_number_style, selected=None)
• _process_text_wrapper(self)
• _run_getch_thread(self) -> None
• _set_scroll_buffer(self) -> None
• _set_view(self) -> None
• start(self)
• freeze(self)
• unfreeze(self)
• write(self) -> None
• class Color
• class Grid
• class Pixel
• class Series
• class Style
• class Term
• class Window
• Classes