alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add support for a selection message

Browse Source 
In doing so, change up how the toggling happens.
This commit is contained in:
Dave Pearson
2023-05-22 11:25:56 +01:00
parent 41b1c08db5
commit 6bc2a6ebd2
1 changed files with 23 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
src/textual/widgets/_selection_list.py
View File

@@ -52,7 +52,7 @@ class Selection(Generic[SelectionType], Option):
class SelectionList(Generic[SelectionType], OptionList): class SelectionList(Generic[SelectionType], OptionList):
"""A vertical selection list that allows making multiple selections.""" """A vertical selection list that allows making multiple selections."""
BINDINGS = [Binding("space, enter", "toggle")] BINDINGS = [Binding("space", "select")]
COMPONENT_CLASSES: ClassVar[set[str]] = { COMPONENT_CLASSES: ClassVar[set[str]] = {
"selection-list--button", "selection-list--button",
@@ -148,6 +148,13 @@ class SelectionList(Generic[SelectionType], OptionList):
`SelectionList` or in a parent node in the DOM. `SelectionList` or in a parent node in the DOM.
""" """
class SelectionToggled(SelectionMessage):
"""Message sent when a selection is toggled.
Can be handled using `on_selection_list_selection_toggled` in a subclass of
`SelectionList` or in a parent node in the DOM.
"""
def __init__( def __init__(
self, self,
*selections: tuple[TextType, SelectionType] *selections: tuple[TextType, SelectionType]
@@ -199,7 +206,11 @@ class SelectionList(Generic[SelectionType], OptionList):
self._selected[value] = None self._selected[value] = None
return Selection(label, value) return Selection(label, value)
def action_toggle(self) -> None: def _toggle_highlighted_selection(self) -> None:
"""Toggle the state of the highlighted selection.
If nothing is selected in the list this is a non-operation.
"""
if self.highlighted is not None: if self.highlighted is not None:
option = self.get_option_at_index(self.highlighted) option = self.get_option_at_index(self.highlighted)
assert isinstance(option, Selection) assert isinstance(option, Selection)
@@ -285,3 +296,13 @@ class SelectionList(Generic[SelectionType], OptionList):
""" """
event.stop() event.stop()
self.post_message(self.SelectionHighlighted(self, event.option_index)) self.post_message(self.SelectionHighlighted(self, event.option_index))
def _on_option_list_option_selected(self, event: OptionList.OptionSelected) -> None:
"""Capture the `OptionList` selected event and turn it into a `SelectionList` event.
Args:
event: The event to capture and recreate.
"""
event.stop()
self._toggle_highlighted_selection()
self.post_message(self.SelectionToggled(self, event.option_index))