File: console_menu.pyi

package info (click to toggle)
typeshed 0.0~git20221107.4f381af-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 18,036 kB
  • sloc: python: 3,216; sh: 62; makefile: 13
file content (87 lines) | stat: -rw-r--r-- 3,330 bytes parent folder | download
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
from collections.abc import Callable

from consolemenu.menu_formatter import MenuFormatBuilder as MenuFormatBuilder
from consolemenu.screen import Screen as Screen

class ConsoleMenu:
    currently_active_menu: ConsoleMenu | None
    screen: Screen
    clear_screen_before_render: bool
    formatter: MenuFormatBuilder
    title: str | Callable[[], str] | None
    subtitle: str | Callable[[], str] | None
    prologue_text: str | Callable[[], str] | None
    epilogue_text: str | Callable[[], str] | None
    highlight: None
    normal: None
    show_exit_option: bool
    items: list[MenuItem]
    parent: ConsoleMenu | None
    exit_item: ExitItem
    current_option: int
    selected_option: int
    returned_value: object | None
    should_exit: bool
    previous_active_menu: ConsoleMenu | None
    def __init__(
        self,
        title: str | Callable[[], str] | None = ...,
        subtitle: str | Callable[[], str] | None = ...,
        screen: Screen | None = ...,
        formatter: MenuFormatBuilder | None = ...,
        prologue_text: str | Callable[[], str] | None = ...,
        epilogue_text: str | Callable[[], str] | None = ...,
        clear_screen: bool = ...,
        show_exit_option: bool = ...,
        exit_option_text: str = ...,
    ) -> None: ...
    @property
    def current_item(self) -> MenuItem | None: ...
    @property
    def selected_item(self) -> MenuItem | None: ...
    def append_item(self, item: MenuItem) -> None: ...
    def remove_item(self, item: MenuItem) -> bool: ...
    def add_exit(self) -> bool: ...
    def remove_exit(self) -> bool: ...
    def is_selected_item_exit(self) -> bool: ...
    def start(self, show_exit_option: bool | None = ...) -> None: ...
    def show(self, show_exit_option: bool | None = ...) -> None: ...
    def draw(self) -> None: ...
    def is_running(self) -> bool: ...
    def wait_for_start(self, timeout: float | None = ...) -> bool: ...
    def is_alive(self) -> bool: ...
    def pause(self) -> None: ...
    def resume(self) -> None: ...
    def join(self, timeout: float | None = ...) -> None: ...
    def get_input(self) -> int: ...
    def process_user_input(self) -> int | None: ...
    def go_to(self, option: int) -> None: ...
    def go_down(self) -> None: ...
    def go_up(self) -> None: ...
    def select(self) -> None: ...
    def exit(self) -> None: ...
    def clear_screen(self) -> None: ...
    def get_title(self) -> str: ...
    def get_subtitle(self) -> str: ...
    def get_prologue_text(self) -> str: ...
    def get_epilogue_text(self) -> str: ...

class MenuItem:
    text: str
    menu: ConsoleMenu | None
    should_exit: bool
    index_item_separator: str
    def __init__(self, text: str | Callable[[], str], menu: ConsoleMenu | None = ..., should_exit: bool = ...) -> None: ...
    def show(self, index: int) -> str: ...
    def set_up(self) -> None: ...
    def action(self) -> None: ...
    def clean_up(self) -> None: ...
    def get_return(self) -> object: ...
    def __eq__(self, o: MenuItem) -> bool: ...  # type: ignore[override]
    def get_text(self) -> str: ...

class ExitItem(MenuItem):
    def __init__(self, text: str | Callable[[], str] = ..., menu: ConsoleMenu | None = ...) -> None: ...
    def show(self, index: int, available_width: None = ...) -> str: ...

def clear_terminal() -> None: ...