SubmenuItem¶

Bases: cursesmenu.items.MenuItem

class cursesmenu.items.SubmenuItem(text, submenu=None, menu=None, *, should_exit=False, override_index=None)[source]¶

A menu item that opens a submenu.

Parameters:

text (str) – The text of the item
submenu (Optional[CursesMenu]) – A CursesMenu to be displayed when the item is selected
menu (Optional[CursesMenu]) – The menu that this item belongs to
should_exit (bool) – Whether the menu will exit when this item is selected

action()[source]¶

Start the submenu.

Return type:: None

clean_up()[source]¶

Block until the submenu is done and then return to the parent.

Return type:: None

get_return()[source]¶

Get the returned value from the submenu.

Return type:: Any

property menu: cursesmenu.curses_menu.CursesMenu | None¶: Get the menu that this item belongs to.

set_up()[source]¶

Set the screen up for the submenu.

Return type:: None

property submenu: cursesmenu.curses_menu.CursesMenu | None¶: Get the submenu associated with this item.