-
Notifications
You must be signed in to change notification settings - Fork 0
Menu
menu(menu_name: str, menu_items: list, input_question: str = 'What do you want to do:', menu_size: int = 76, auto_add_quit: bool = False, return_type: simple_console_menu.Menu.menu.menu_data_type = menu_data_type.INT)
allows you to create a menu
:param menu_name: name of the menu (Str)
:param menu_items: menu items ["item 1","item 2"] (List)
:param input_question: question to ask the user (Str)
:param menu_size: size of the menu (Int)
:param auto_add_quit: automatically add a quit option (Bool)
:return: None
ValueToReturnEmptyError
:raised when the value to return is empty
display_type
:display types for the menu
possible values:
- BLOCK
- SIMPLE
menu_data_type
:data types for the menu
possible values:
- STRING
- INT
- FLOAT
add_menu_item(self, menu_item: str) ‑> None
:adds a menu item
:param menu_item: menu item to add (Str)
:return: None
display(self, menu_display_type: simple_console_menu.Menu.menu.display_type = display_type.BLOCK) ‑> None
:displays the menu
:return: None
get_user_input(self) ‑> str | int | float
:returns the user input
:return: user input (Str | Int | Float)
set_auto_add_quit(self, auto_add_quit: bool) ‑> None
:sets the auto add quit option
:param auto_add_quit: automatically add a quit option (Bool)
:return: None
set_input_question(self, input_question: str) ‑> None
:sets the input question
:param input_question: question to ask the user (Str)
:return: None
set_menu_items(self, menu_items: list) ‑> None
:sets the menu items
:param menu_items: menu items ["item 1","item 2"] (List)
:return: None
set_menu_name(self, menu_name: str) ‑> None
:sets the menu name
:param menu_name: name of the menu (Str)
:return: None
set_menu_size(self, menu_size: int) ‑> None
:sets the menu size
:param menu_size: size of the menu (Int)
:return: None
set_return_type(self, return_type: simple_console_menu.Menu.menu.menu_data_type) ‑> None
:sets the return type
:param return_type: return type (menu_data_type)
:return: None