feat(gui): add activate/deactivate to UIInputText (#2196)

* feat(gui): add activate/deactivate to UIInputText
* fix(gui): remove start_render calls

Author: eruvanos

arcade/gui/widgets/text.py

@@ -397,10 +397,7 @@ def on_event(self, event: UIEvent) -> Optional[bool]:
         # If not active, check to activate, return
         if not self._active and isinstance(event, UIMousePressEvent):
             if self.rect.point_in_rect(event.pos):
-                self._active = True
-                self.trigger_full_render()
-                self.caret.on_activate()
-                self.caret.position = len(self.doc.text)
+                self.activate()
                 return EVENT_UNHANDLED
 
         # If active check to deactivate
@@ -410,9 +407,7 @@ def on_event(self, event: UIEvent) -> Optional[bool]:
                 y = int(event.y - self.bottom)
                 self.caret.on_mouse_press(x, y, event.button, event.modifiers)
             else:
-                self._active = False
-                self.trigger_full_render()
-                self.caret.on_deactivate()
+                self.deactivate()
                 return EVENT_UNHANDLED
 
         # If active pass all non press events to caret
@@ -445,6 +440,23 @@ def on_event(self, event: UIEvent) -> Optional[bool]:
 
         return EVENT_UNHANDLED
 
+    @property
+    def active(self) -> bool:
+        return self._active
+
+    def activate(self):
+        """Programmatically activate the text input field."""
+        self._active = True
+        self.trigger_full_render()
+        self.caret.on_activate()
+        self.caret.position = len(self.doc.text)
+
+    def deactivate(self):
+        """Programmatically deactivate the text input field."""
+        self._active = False
+        self.trigger_full_render()
+        self.caret.on_deactivate()
+
     def _update_layout(self):
         # Update Pyglet layout size
         layout = self.layout

tests/unit/gui/__init__.py

@@ -23,6 +23,9 @@ def drag(self, x: int, y: int, dx=0.0, dy=0.0, buttons=arcade.MOUSE_BUTTON_LEFT,
     def release(self, x: int, y: int, button=arcade.MOUSE_BUTTON_LEFT):
         self.on_mouse_release(x=x, y=y, button=button, modifiers=0)
 
+    def type_text(self, text: str):
+        self.on_text(text)
+
     def click(self, x: int, y: int, button=arcade.MOUSE_BUTTON_LEFT):
         self.click_and_hold(x, y, button=button)
         self.release(x, y, button=button)

tests/unit/gui/test_widget_inputtext.py

@@ -1,9 +1,59 @@
 from arcade.gui import UIInputText
 
 
-def test_uilabel_support_multiline(uimanager):
+def test_deactivated_by_default(uimanager):
+    # GIVEN
+    widget = UIInputText()
+
+    # THEN
+    assert widget.active is False
+
+
+def test_activated_after_click(uimanager):
+    # GIVEN
+    widget = UIInputText()
+    uimanager.add(widget)
+
     # WHEN
+    uimanager.click(*widget.rect.center)
+
+    # THEN
+    assert widget.active is True
+
+
+def test_deactivated_after_off_click(uimanager):
+    # GIVEN
     widget = UIInputText()
+    uimanager.add(widget)
+    widget.activate()
+
+    # WHEN
+    uimanager.click(200, 200)
+
+    # THEN
+    assert widget.active is False
+
+
+def test_captures_text_when_active(uimanager):
+    # GIVEN
+    widget = UIInputText()
+    uimanager.add(widget)
+    widget.activate()
+
+    # WHEN
+    uimanager.type_text("Hello")
+
+    # THEN
+    assert widget.text == "Hello"
+
+
+def test_does_not_capture_text_when_inactive(uimanager):
+    # GIVEN
+    widget = UIInputText()
+    uimanager.add(widget)
+
+    # WHEN
+    uimanager.type_text("Hello")
 
     # THEN
-    assert widget is not None
+    assert widget.text == ""