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

Some more linking to types within the SelectionList docstrings

Browse Source
This commit is contained in:
Dave Pearson
2023-05-24 14:58:27 +01:00
parent ac7a892965
commit 113ab41c3b
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -29,7 +29,7 @@ class SelectionError(TypeError):
class Selection(Generic[SelectionType], Option): class Selection(Generic[SelectionType], Option):
"""A selection for the `SelectionList`.""" """A selection for a [`SelectionList`][textual.widgets.SelectionList]."""
def __init__( def __init__(
self, self,
@@ -176,14 +176,14 @@ class SelectionList(Generic[SelectionType], OptionList):
"""Message sent when a selection is highlighted. """Message sent when a selection is highlighted.
Can be handled using `on_selection_list_selection_highlighted` in a subclass of Can be handled using `on_selection_list_selection_highlighted` in a subclass of
`SelectionList` or in a parent node in the DOM. [`SelectionList`][textual.widgets.SelectionList] or in a parent node in the DOM.
""" """
class SelectionToggled(SelectionMessage): class SelectionToggled(SelectionMessage):
"""Message sent when a selection is toggled. """Message sent when a selection is toggled.
Can be handled using `on_selection_list_selection_toggled` in a subclass of Can be handled using `on_selection_list_selection_toggled` in a subclass of
`SelectionList` or in a parent node in the DOM. [`SelectionList`][textual.widgets.SelectionList] or in a parent node in the DOM.
Note: Note:
This message is only sent if the selection is toggled by user This message is only sent if the selection is toggled by user
@@ -330,7 +330,7 @@ class SelectionList(Generic[SelectionType], OptionList):
"""Select all items. """Select all items.
Returns: Returns:
The `SelectionList` instance. The [`SelectionList`][textual.widgets.SelectionList] instance.
""" """
return self._apply_to_all(self._select) return self._apply_to_all(self._select)
@@ -542,7 +542,7 @@ class SelectionList(Generic[SelectionType], OptionList):
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: def _on_option_list_option_selected(self, event: OptionList.OptionSelected) -> None:
"""Capture the `OptionList` selected event and turn it into a `SelectionList` event. """Capture the `OptionList` selected event and turn it into a [`SelectionList`][textual.widgets.SelectionList] event.
Args: Args:
event: The event to capture and recreate. event: The event to capture and recreate.