Allow disabled options to be created

add_option() now has a "disabled" parameter, which will add the given
option as a simple indented text. This is very similar as calling
add_text(). The advantage of having this as a parameter to add_option()
is that disabled options can now be created from the shorthand function
cli_select_item() by passing each option as a tuple or dict, which has
disabled=True set.

This is a breaking change, as the parameter order of add_option()
changes.
This commit is contained in:
Sebastian Lohff 2023-02-16 17:55:01 +01:00
parent 26412d400f
commit b44a1f3543
1 changed files with 13 additions and 7 deletions

View File

@ -132,11 +132,15 @@ class CliMenu:
for text in title.split('\n'):
self._items.append(_CliMenuHeader(text, indent=indent, style=style))
def add_option(self, text, item=_EmptyParameter, style=None, highlighted_style=None):
def add_option(self, text, item=_EmptyParameter, disabled=False, style=None, highlighted_style=None):
if disabled:
# this is basically a text option and we just throw the item away
self.add_text(title=text, style=style)
else:
if item == _EmptyParameter:
item = text
self._items.append(_CliMenuOption(text, self._item_num, item=item,
style=style, highlighted_style=highlighted_style))
opt = _CliMenuOption(text, self._item_num, item=item, style=style, highlighted_style=highlighted_style)
self._items.append(opt)
self._item_num += 1
@property
@ -369,9 +373,11 @@ class CliMultiMenu(CliMenu):
self._selection_icons = selection_icons if selection_icons is not None else self.default_selection_icons
super().__init__(*args, **kwargs)
def add_option(self, text, item=_EmptyParameter, selected=False,
def add_option(self, text, item=_EmptyParameter, selected=False, disabled=False,
style=None, highlighted_style=None, selected_style=None, selected_highlighted_style=None):
super().add_option(text, item, style, highlighted_style=highlighted_style)
if disabled:
return
self._items[-1].selected_style = selected_style
self._items[-1].selected_highlighted_style = selected_highlighted_style
if selected: