Merge pull request #1339 from davep/event-props

Add some missing widget event attributes

Author: willmcgugan

src/textual/widgets/_button.py

@@ -151,6 +151,12 @@ class Button(Static, can_focus=True):
     """When buttons are clicked they get the `-active` class for this duration (in seconds)"""
 
     class Pressed(Message, bubble=True):
+        """Event sent when a `Button` is pressed.
+
+        Attributes:
+            button (Button): The button that was pressed.
+        """
+
         @property
         def button(self) -> Button:
             return cast(Button, self.sender)

src/textual/widgets/_checkbox.py

@@ -123,7 +123,12 @@ def toggle(self) -> None:
         self.value = not self.value
 
     class Changed(Message, bubble=True):
-        """Checkbox was toggled."""
+        """Checkbox was toggled.
+
+        Attributes:
+            value (bool): The value that the checkbox was changed to.
+            input (Checkbox): The `Checkbox` widget that was changed.
+        """
 
         def __init__(self, sender: Checkbox, value: bool) -> None:
             super().__init__(sender)

src/textual/widgets/_input.py

@@ -314,15 +314,25 @@ async def action_submit(self) -> None:
         await self.emit(self.Submitted(self, self.value))
 
     class Changed(Message, bubble=True):
-        """Value was changed."""
+        """Value was changed.
+
+        Attributes:
+            value (str): The value that the input was changed to.
+            input (Input): The `Input` widget that was changed.
+        """
 
         def __init__(self, sender: Input, value: str) -> None:
             super().__init__(sender)
             self.value = value
             self.input = sender
 
     class Submitted(Message, bubble=True):
-        """Value was updated via enter key or blur."""
+        """Sent when the enter key is pressed within an `Input`.
+
+        Attributes:
+            value (str): The value of the `Input` being submitted..
+            input (Input): The `Input` widget that is being submitted.
+        """
 
         def __init__(self, sender: Input, value: str) -> None:
             super().__init__(sender)

src/textual/widgets/_list_view.py

@@ -143,14 +143,22 @@ def __len__(self):
         return len(self.children)
 
     class Highlighted(Message, bubble=True):
-        """Emitted when the highlighted item changes. Highlighted item is controlled using up/down keys"""
+        """Emitted when the highlighted item changes. Highlighted item is controlled using up/down keys.
+
+        Attributes:
+            item (ListItem | None): The highlighted item, if there is one highlighted.
+        """
 
         def __init__(self, sender: ListView, item: ListItem | None) -> None:
             super().__init__(sender)
             self.item = item
 
     class Selected(Message, bubble=True):
-        """Emitted when a list item is selected, e.g. when you press the enter key on it"""
+        """Emitted when a list item is selected, e.g. when you press the enter key on it
+
+        Attributes:
+            item (ListItem): The selected item.
+        """
 
         def __init__(self, sender: ListView, item: ListItem) -> None:
             super().__init__(sender)

src/textual/widgets/_tree.py

@@ -232,33 +232,33 @@ class Tree(Generic[TreeDataType], ScrollView, can_focus=True):
         color: $text;
     }
     Tree > .tree--label {
-        
+
     }
     Tree > .tree--guides {
         color: $success-darken-3;
     }
 
-    Tree > .tree--guides-hover {  
-        color: $success;      
+    Tree > .tree--guides-hover {
+        color: $success;
         text-style: bold;
     }
 
     Tree > .tree--guides-selected {
         color: $warning;
         text-style: bold;
-    }    
+    }
 
     Tree > .tree--cursor {
         background: $secondary;
         color: $text;
         text-style: bold;
     }
 
-    Tree > .tree--highlight {        
+    Tree > .tree--highlight {
         text-style: underline;
     }
-    
-    Tree > .tree--highlight-line {        
+
+    Tree > .tree--highlight-line {
         background: $boost;
     }
 
@@ -309,7 +309,11 @@ class Tree(Generic[TreeDataType], ScrollView, can_focus=True):
     }
 
     class NodeSelected(Generic[EventTreeDataType], Message, bubble=True):
-        """Event sent when a node is selected."""
+        """Event sent when a node is selected.
+
+        Attributes:
+            TreeNode[EventTreeDataType]: The node that was selected.
+        """
 
         def __init__(
             self, sender: MessageTarget, node: TreeNode[EventTreeDataType]
@@ -318,7 +322,11 @@ def __init__(
             super().__init__(sender)
 
     class NodeExpanded(Generic[EventTreeDataType], Message, bubble=True):
-        """Event sent when a node is expanded."""
+        """Event sent when a node is expanded.
+
+        Attributes:
+            TreeNode[EventTreeDataType]: The node that was expanded.
+        """
 
         def __init__(
             self, sender: MessageTarget, node: TreeNode[EventTreeDataType]
@@ -327,7 +335,11 @@ def __init__(
             super().__init__(sender)
 
     class NodeCollapsed(Generic[EventTreeDataType], Message, bubble=True):
-        """Event sent when a node is collapsed."""
+        """Event sent when a node is collapsed.
+
+        Attributes:
+            TreeNode[EventTreeDataType]: The node that was collapsed.
+        """
 
         def __init__(
             self, sender: MessageTarget, node: TreeNode[EventTreeDataType]