MenuItem

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

The base class for menu items.

Is displayed in a basic manner and does nothing when selected.

Parameters:

• text (str) – The text representing this menu item

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

• menu (Optional[CursesMenu]) – The menu that owns this item

action()

Do the main action for the item.

If you’re just writing a simple subclass, you shouldn’t need set_up or clean_up. The menu just calls them in order. They are provided so you can make subclass hierarchies where the superclass handles some setup and cleanup for its subclasses.

Return type:

None

clean_up()

Perform cleanup for the item.

Return type:

None

get_return()

Get the return value for this item.

For a basic MenuItem, just forwards the return value from the menu.

Return type:

Any

Returns:

The return value for the item.

set_up()

Perform setup for the item.

Return type:

None

show(index_text)

Provide the representation that should be used for this item in a menu.

The base class is simply “[index] - [text]”

Parameters:

index_text (str) – The string used for the index, provided by the menu.

Return type:

str

Returns:

The text representing the item.