SubmenuItem

Bases: cursesmenu.items.MenuItem

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

A menu item that opens a submenu.

Parameters

• text (str) – The text of the item

• submenu (Optional[Any]) – A CursesMenu to be displayed when the item is selected

• menu (Optional[Any]) – The menu that this item belongs to

• should_exit (bool) – Whether the menu will exit when this item is selected

action()

Start the submenu.

Return type

None

clean_up()

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

Return type

None

get_return()

Get the returned value from the submenu.

Return type

Any

property menu: Optional[Any]

Get the menu that this item belongs to.

Return type

Optional[Any]

set_up()

Set the screen up for the submenu.

Return type

None

property submenu: Optional[Any]

Get the submenu associated with this item.

Return type

Optional[Any]