docs(gui): Document UIInteractiveWidget changes

pythonarcade · May 10, 2024 · 4764887 · 4764887
1 parent 40bade7
commit 4764887
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/arcade/gui/events.py b/arcade/gui/events.py
@@ -116,7 +116,7 @@ class UITextMotionSelectEvent(UIEvent):
 
 @dataclass
 class UIOnClickEvent(UIMouseEvent):
-    """Triggered when a button is clicked."""
+    """Triggered when a widget is clicked."""
 
     button: int
     modifiers: int

diff --git a/doc/programming_guide/release_notes.rst b/doc/programming_guide/release_notes.rst
@@ -125,6 +125,8 @@ Changes
     * :py:class:`~arcade.gui.widgets.slider.UISlider`
     * :py:class:`~arcade.gui.widgets.constructs.UIButtonRow` (`PR1580 <https://github.com/pythonarcade/arcade/pull/1580>`_ and `PR1253 <https://github.com/pythonarcade/arcade/pull/1253>`_)
 
+  * :py:class:`~arcade.gui.UIInteractiveWidget` only reacts to left mouse button events
+
   * Arcade :py:class:`~arcade.gui.property.Property`:
 
     * Properties are observable attributes (supported: primitive, list and dict).