menus.radio module

Provides ShowMenu based functionality.

class menus.radio.ListRadioMenu(*args, **kwargs)

Bases: PagedRadioMenu

Creates a list-like radio menu.

Navigation options are added automatically.

__init__(data=None, select_callback=None, build_callback=None, close_callback=None, description=None, title=None, top_separator='------------------------------', bottom_separator='------------------------------', fill=True, parent_menu=None, items_per_page=10)

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 PagedRadioMenu.__init__().

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

• top_separator (str) – See PagedRadioMenu.__init__().

• bottom_separator (str) – See PagedRadioMenu.__init__().

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

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

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

class menus.radio.ListRadioOption(text, highlight=True, enumerated=True)

Bases: PagedRadioOption

Provides options for ListRadioMenu objects.

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

Initialize the option.

Parameters:

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

• hightlight (bool) – If True the text will be highlighted.

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

Note

highlight only works if enumerated is set to True.

class menus.radio.PagedRadioMenu(*args, **kwargs)

Bases: SimpleRadioMenu, _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, top_separator='------------------------------', bottom_separator='------------------------------', 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) – A description that is displayed under the title.

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

• top_separator (str) – A separator that is displayed right after the title/description.

• bottom_separator (str) – A separator that is displayed right after the body.

• fill (bool) – If True the menu will be filled so that it will always have the same size.

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

class menus.radio.PagedRadioOption(text, value=None, highlight=True, selectable=True)

Bases: _BaseRadioOption

Provides options for PagedRadioMenu objects.

class menus.radio.SimpleRadioMenu(*args, **kwargs)

Bases: _BaseMenu

This class creates a basic radio menu.

class menus.radio.SimpleRadioOption(choice_index, text, value=None, highlight=True, selectable=True)

Bases: _BaseRadioOption

Provides options for SimpleRadioMenu 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) – If True the text will be highlighted.

• selectable (bool) – If True the option will be selectable.