Overview#

This extension provides 2 types of menu, OptionsMenu and RadioMenu.

graph TD; subgraph AbstractPopupMenu OptionsMenu RadioMenu end OptionsMenu --> OptionsModel RadioMenu --> RadioModel subgraph AbstractOptionItem OptionItem OptionCustom OptionRadios OptionSeparator end OptionsModel --> AbstractOptionItem

Important API List#

The module consists of the following main components:

Menus#

OptionsMenu: Represents a menu to show various options with a header and list of menu items.
RadioMenu: Represents a menu specifically for radio button groups.

Models#

OptionsModel: Model for managing a collection of option items within a menu.
RadioModel: Represents a model for radio buttons, enabling single selection from a list.

Items for OptionsModel#

OptionCustom: Represents a custom option item with a build function and optional model.
OptionItem: Represents a general item for options menus, supporting features like checkability and visibility toggling.
OptionRadios: Represents a list of radio options within a menu.
OptionSeparator: Represents a separator in menu items, optionally with a title.

General Use Case#

This module can be utilized to create complex and customizable menu structures within applications. Developers can leverage the provided classes to build options menus with various types of items (e.g., toggles, radio buttons, custom input fields), separators for grouping, and support for saving and retrieving settings. The module’s flexibility allows for the creation of both simple and advanced user interfaces, making it suitable for settings panels, application preferences, feature toggles, and more. For examples of how to use the APIs, please consult the Python usage pages.