menus.esc module

Provides ESC Menu functionality.

class menus.esc.ListESCMenu(*args, **kwargs)

Bases: PagedESCMenu

Creates a list-like ESC menu.

Navigation options are added automatically.

__init__(data=None, select_callback=None, build_callback=None, close_callback=None, description=None, title=None, title_color=Color(255, 255, 255, 255), fill=True, parent_menu=None, items_per_page=5)

Initialize the object.

Parameters:

• data (iterable|None) – See menus.base._BaseMenu.__init__().

• select_callback (callable|None) – See menus.base._BaseMenu.__init__().

• build_callback (callable|None) – See menus.base._BaseMenu.__init__().

• close_callback (callable|None) – See menus.base._BaseMenu.__init__().

• description (str|None) – See SimpleESCMenu.__init__().

• title (str|None) – See SimpleESCMenu.__init__().

• title_color (Color) – See SimpleESCMenu.__init__().

• fill (bool) – See PagedESCMenu.__init__().

• parent_menu (_BaseMenu) – See PagedESCMenu.__init__().

• items_per_page (int) – Number of options that should be displayed on a single page (5 is the maximum).

class menus.esc.ListESCOption(text, highlight=True, enumerated=True)

Bases: PagedESCOption

Provides options for ListESCMenu objects.

__init__(text, highlight=True, enumerated=True)

Initialize the option.

Parameters:

• text (str) – See menus.base._BaseOption.__init__().

• hightlight (bool) – See SimpleESCMenu.__init__().

• enumerated (bool) – If True the number of the option will be added in front of the text.

class menus.esc.PagedESCMenu(*args, **kwargs)

Bases: SimpleESCMenu, _PagedMenuBase

Create menus with an unlimited number of options.

Navigation options will be added automatically.

__init__(data=None, select_callback=None, build_callback=None, close_callback=None, description=None, title=None, title_color=Color(255, 255, 255, 255), fill=True, parent_menu=None)

Initialize the object.

Parameters:

• data (iterable|None) – See menus.base._BaseMenu.__init__().

• select_callback (callable|None) – See menus.base._BaseMenu.__init__().

• build_callback (callable|None) – See menus.base._BaseMenu.__init__().

• close_callback (callable|None) – See menus.base._BaseMenu.__init__().

• description (str|None) – See SimpleESCMenu.__init__().

• title (str|None) – See SimpleESCMenu.__init__().

• title_color (Color) – See SimpleESCMenu.__init__().

• fill (bool) – If True the menu will always have the same size by filling unused options.

• parent_menu (_BaseMenu) – A menu that will be displayed when hitting ‘Back’ on the first page.

class menus.esc.PagedESCOption(text, value=None, highlight=True, selectable=True)

Bases: _BaseOption

Display an enumerated option.

class menus.esc.SimpleESCMenu(*args, **kwargs)

Bases: _BaseMenu

This class creates basic ESC menus.

__init__(data=None, select_callback=None, build_callback=None, close_callback=None, description=None, title=None, title_color=Color(255, 255, 255, 255))

Initialize the object.

Parameters:

• data (iterable|None) – See menus.base._BaseMenu.__init__().

• select_callback (callable|None) – See menus.base._BaseMenu.__init__().

• build_callback (callable|None) – See menus.base._BaseMenu.__init__().

• close_callback (callable|None) – See menus.base._BaseMenu.__init__()

• description (str|None) – A description that is displayed under the title.

• title (str|None) – A title that is displayed at the top of the menu.

• title_color (Color) – The color of the title.

class menus.esc.SimpleESCOption(choice_index, text, value=None, highlight=True, selectable=True)

Bases: _BaseOption

Provides options for SimpleESCMenu objects.

__init__(choice_index, text, value=None, highlight=True, selectable=True)

Initialize the option.

Parameters:

• choice_index (int) – The number that is required to select the option.

• text (str) – See menus.base._BaseOption.__init__().

• value – See menus.base._BaseOption.__init__().

• hightlight (bool) – Does not work with ESC menus.

• selectable (bool) – Does not work with ESC menus.