Test undo/redo behaviour of text input widgets on macOS.

android/tests_backend/widgets/base.py

@@ -1,5 +1,6 @@
 import asyncio
 
+import pytest
 from java import dynamic_proxy
 from pytest import approx
 
@@ -231,6 +232,12 @@ def is_hidden(self):
     def has_focus(self):
         return self.widget.app._impl.native.getCurrentFocus() == self.native
 
+    async def undo(self):
+        pytest.skip("Undo not supported on this platform")
+
+    async def redo(self):
+        pytest.skip("Redo not supported on this platform")
+
 
 def find_view_by_type(root, cls):
     assert isinstance(root, View)

android/tests_backend/widgets/numberinput.py

@@ -1,4 +1,4 @@
-from pytest import xfail
+import pytest
 
 from .textinput import TextInputProbe
 
@@ -16,7 +16,10 @@ def clear_input(self):
         self.native.setText("")
 
     async def increment(self):
-        xfail("This backend doesn't support stepped increments")
+        pytest.xfail("This backend doesn't support stepped increments")
 
     async def decrement(self):
-        xfail("This backend doesn't support stepped increments")
+        pytest.xfail("This backend doesn't support stepped increments")
+
+    def set_cursor_at_end(self):
+        pytest.skip("Cursor positioning not supported on this platform")

android/tests_backend/widgets/textinput.py

@@ -1,3 +1,4 @@
+import pytest
 from java import jclass
 
 from android.os import SystemClock
@@ -80,3 +81,6 @@ async def type_character(self, char):
                         0,  # metaState
                     )
                 )
+
+    def set_cursor_at_end(self):
+        pytest.skip("Cursor positioning not supported on this platform")

changes/2151.feature.rst

@@ -0,0 +1 @@
+Text input widgets on macOS now support undo and redo.

cocoa/src/toga_cocoa/widgets/multilinetextinput.py

@@ -41,6 +41,7 @@ def create(self):
 
         self.native_text.editable = True
         self.native_text.selectable = True
+        self.native_text.allowsUndo = True
         self.native_text.verticallyResizable = True
         self.native_text.horizontallyResizable = False
         self.native_text.usesAdaptiveColorMappingForDarkAppearance = True

cocoa/tests_backend/widgets/base.py

@@ -1,6 +1,7 @@
 from rubicon.objc import NSPoint
 
 from toga.colors import TRANSPARENT
+from toga_cocoa.keys import NSEventModifierFlagCommand, NSEventModifierFlagShift
 from toga_cocoa.libs import NSEvent, NSEventType
 
 from ..fonts import FontMixin
@@ -111,6 +112,7 @@ async def type_character(self, char, modifierFlags=0):
         # Convert the requested character into a Cocoa keycode.
         # This table is incomplete, but covers all the basics.
         key_code = {
+            "<backspace>": 51,
             "<esc>": 53,
             " ": 49,
             "\n": 36,
@@ -142,6 +144,9 @@ async def type_character(self, char, modifierFlags=0):
             "z": 6,
         }.get(char.lower(), 0)
 
+        if modifierFlags:
+            char = None
+
         # This posts a single keyDown followed by a keyUp, matching "normal" keyboard operation.
         await self.post_event(
             NSEvent.keyEventWithType(
@@ -194,3 +199,11 @@ async def mouse_event(
             ),
             delay=delay,
         )
+
+    async def undo(self):
+        await self.type_character("z", modifierFlags=NSEventModifierFlagCommand)
+
+    async def redo(self):
+        await self.type_character(
+            "z", modifierFlags=NSEventModifierFlagCommand | NSEventModifierFlagShift
+        )

cocoa/tests_backend/widgets/multilinetextinput.py

@@ -1,5 +1,5 @@
 from toga.colors import TRANSPARENT
-from toga_cocoa.libs import NSScrollView, NSTextView
+from toga_cocoa.libs import NSRange, NSScrollView, NSTextView
 
 from .base import SimpleProbe
 from .properties import toga_alignment, toga_color
@@ -96,3 +96,6 @@ def vertical_scroll_position(self):
     async def wait_for_scroll_completion(self):
         # No animation associated with scroll, so this is a no-op
         pass
+
+    def set_cursor_at_end(self):
+        self.native.selectedRange = NSRange(len(self.value), 0)

cocoa/tests_backend/widgets/numberinput.py

@@ -3,6 +3,7 @@
 from toga.colors import TRANSPARENT
 from toga_cocoa.libs import (
     NSEventType,
+    NSRange,
     NSStepper,
     NSTextField,
     NSTextView,
@@ -107,3 +108,6 @@ def has_focus(self):
         return isinstance(self.native.window.firstResponder, NSTextView) and (
             self.native_input.window.firstResponder.delegate == self.native_input
         )
+
+    def set_cursor_at_end(self):
+        self.native_input.currentEditor().selectedRange = NSRange(len(self.value), 0)

cocoa/tests_backend/widgets/textinput.py

@@ -2,6 +2,7 @@
 from toga.constants import RIGHT
 from toga_cocoa.libs import (
     NSLeftTextAlignment,
+    NSRange,
     NSRightTextAlignment,
     NSTextField,
     NSTextView,
@@ -82,3 +83,6 @@ def has_focus(self):
         return isinstance(self.native.window.firstResponder, NSTextView) and (
             self.native.window.firstResponder.delegate == self.native
         )
+
+    def set_cursor_at_end(self):
+        self.native.currentEditor().selectedRange = NSRange(len(self.value), 0)

gtk/tests_backend/widgets/base.py

@@ -1,6 +1,8 @@
 import asyncio
 from threading import Event
 
+import pytest
+
 from toga_gtk.libs import Gdk, Gtk
 
 from ..fonts import FontMixin
@@ -167,3 +169,9 @@ def event_handled(widget, e):
         # caused by typing a character doesn't fully propegate. A
         # short delay fixes this.
         await asyncio.sleep(0.04)
+
+    async def undo(self):
+        pytest.skip("Undo not supported on this platform")
+
+    async def redo(self):
+        pytest.skip("Redo not supported on this platform")

gtk/tests_backend/widgets/multilinetextinput.py

@@ -1,3 +1,5 @@
+import pytest
+
 from toga_gtk.libs import Gtk
 
 from .base import SimpleProbe
@@ -113,3 +115,6 @@ def vertical_scroll_position(self):
 
     async def wait_for_scroll_completion(self):
         pass
+
+    def set_cursor_at_end(self):
+        pytest.skip("Cursor positioning not supported on this platform")

gtk/tests_backend/widgets/numberinput.py

@@ -1,3 +1,5 @@
+import pytest
+
 from toga.constants import JUSTIFY, LEFT
 from toga_gtk.libs import Gtk
 
@@ -45,3 +47,6 @@ def assert_vertical_alignment(self, expected):
     @property
     def readonly(self):
         return not self.native.get_property("editable")
+
+    def set_cursor_at_end(self):
+        pytest.skip("Cursor positioning not supported on this platform")

gtk/tests_backend/widgets/textinput.py

@@ -1,3 +1,5 @@
+import pytest
+
 from toga.constants import JUSTIFY, LEFT
 from toga_gtk.libs import Gtk
 
@@ -47,3 +49,6 @@ def assert_vertical_alignment(self, expected):
     @property
     def readonly(self):
         return not self.native.get_property("editable")
+
+    def set_cursor_at_end(self):
+        pytest.skip("Cursor positioning not supported on this platform")

iOS/tests_backend/widgets/base.py

@@ -1,3 +1,4 @@
+import pytest
 from rubicon.objc import ObjCClass
 
 from toga_iOS.libs import UIApplication
@@ -166,3 +167,9 @@ async def type_character(self, char):
                 self.native.insertText(char)
             else:
                 self.native.insertText("")
+
+    async def undo(self):
+        pytest.skip("Undo not supported on this platform")
+
+    async def redo(self):
+        pytest.skip("Redo not supported on this platform")

iOS/tests_backend/widgets/numberinput.py

@@ -1,4 +1,4 @@
-from pytest import xfail
+import pytest
 from rubicon.objc import NSRange
 
 from toga_iOS.libs import UITextField
@@ -19,10 +19,10 @@ def value(self):
         return str(self.native.text)
 
     async def increment(self):
-        xfail("iOS doesn't support stepped increments")
+        pytest.xfail("iOS doesn't support stepped increments")
 
     async def decrement(self):
-        xfail("iOS doesn't support stepped increments")
+        pytest.xfail("iOS doesn't support stepped increments")
 
     @property
     def color(self):
@@ -48,3 +48,6 @@ def _prevalidate_input(self, char):
             shouldChangeCharactersInRange=NSRange(len(self.native.text), 0),
             replacementString=char,
         )
+
+    def set_cursor_at_end(self):
+        pytest.skip("Cursor positioning not supported on this platform")

iOS/tests_backend/widgets/textinput.py

@@ -1,3 +1,4 @@
+import pytest
 from rubicon.objc import SEL, send_message
 
 from toga_iOS.libs import UITextField
@@ -56,3 +57,6 @@ def readonly(self):
     def type_return(self):
         # Invoke the return handler explicitly.
         self.native.textFieldShouldReturn(self.native)
+
+    def set_cursor_at_end(self):
+        pytest.skip("Cursor positioning not supported on this platform")

testbed/tests/widgets/test_multilinetextinput.py

@@ -26,6 +26,7 @@
     test_on_change_focus,
     test_on_change_programmatic,
     test_on_change_user,
+    test_undo_redo,
     test_value_not_hidden,
 )
 

testbed/tests/widgets/test_numberinput.py

@@ -5,6 +5,7 @@
 
 import toga
 
+from ..conftest import skip_on_platforms
 from .properties import (  # noqa: F401
     test_alignment,
     test_background_color,
@@ -226,3 +227,40 @@ async def test_increment_decrement(widget, probe):
         assert widget.value == expected
         handler.assert_called_once_with(widget)
         handler.reset_mock()
+
+
+async def test_undo_redo(widget, probe):
+    "The widget supports undo and redo."
+    skip_on_platforms("android", "iOS", "linux", "windows")
+
+    widget.step = "0.00001"
+    text_0 = "3.14000"
+    text_1 = "3.14159"
+    text_extra = "159"
+    widget.value = text_0
+
+    widget.focus()
+    probe.set_cursor_at_end()
+
+    # type more text
+    for _ in text_extra:
+        await probe.type_character("<backspace>")
+    await probe.redraw(f"Widget value should be {text_0[:-3]!r}")
+    for char in text_extra:
+        await probe.type_character(char)
+    await probe.redraw(f"Widget value should be {text_1!r}")
+
+    assert widget.value == Decimal(text_1)
+    assert Decimal(probe.value) == Decimal(text_1)
+
+    # undo
+    await probe.undo()
+    await probe.redraw(f"Widget value should be {text_0!r}")
+    assert widget.value == Decimal(text_0)
+    assert Decimal(probe.value) == Decimal(text_0)
+
+    # redo
+    await probe.redo()
+    await probe.redraw(f"Widget value should be {text_1!r}")
+    assert widget.value == Decimal(text_1)
+    assert Decimal(probe.value) == Decimal(text_1)

testbed/tests/widgets/test_passwordinput.py

@@ -26,6 +26,7 @@
     test_on_change_user,
     test_on_confirm,
     test_text_value,
+    test_undo_redo,
     test_validation,
     verify_focus_handlers,
     verify_vertical_alignment,

testbed/tests/widgets/test_textinput.py

@@ -213,3 +213,33 @@ async def test_text_value(widget, probe):
 
         assert widget.value == str(text).replace("\n", " ")
         assert probe.value == str(text).replace("\n", " ")
+
+
+async def test_undo_redo(widget, probe):
+    "The widget supports undo and redo."
+
+    text_0 = str(widget.value)
+    text_extra = " World!"
+    text_1 = text_0 + text_extra
+
+    widget.focus()
+    probe.set_cursor_at_end()
+
+    # type more text
+    for char in text_extra:
+        await probe.type_character(char)
+    await probe.redraw(f"Widget value should be {text_1!r}")
+    assert widget.value == text_1
+    assert probe.value == text_1
+
+    # undo
+    await probe.undo()
+    await probe.redraw(f"Widget value should be {text_0!r}")
+    assert widget.value == text_0
+    assert probe.value == text_0
+
+    # redo
+    await probe.redo()
+    await probe.redraw(f"Widget value should be {text_1!r}")
+    assert widget.value == text_1
+    assert probe.value == text_1

winforms/tests_backend/widgets/base.py

@@ -1,3 +1,4 @@
+import pytest
 from pytest import approx
 from System import EventArgs, Object
 from System.Drawing import Color, SystemColors
@@ -142,3 +143,9 @@ def is_hidden(self):
     @property
     def has_focus(self):
         return self.native.ContainsFocus
+
+    async def undo(self):
+        pytest.skip("Undo not supported on this platform")
+
+    async def redo(self):
+        pytest.skip("Redo not supported on this platform")

winforms/tests_backend/widgets/numberinput.py

@@ -1,3 +1,4 @@
+import pytest
 from System.Windows.Forms import NumericUpDown
 
 from .base import SimpleProbe
@@ -38,3 +39,6 @@ def alignment(self):
     def assert_vertical_alignment(self, expected):
         # Vertical alignment isn't configurable in this native widget.
         pass
+
+    def set_cursor_at_end(self):
+        pytest.skip("Cursor positioning not supported on this platform")

winforms/tests_backend/widgets/textinput.py

@@ -2,6 +2,7 @@
 from ctypes import c_uint
 from ctypes.wintypes import HWND, LPARAM
 
+import pytest
 from System.Windows.Forms import TextBox
 
 from .base import SimpleProbe
@@ -53,3 +54,6 @@ def alignment(self):
     def assert_vertical_alignment(self, expected):
         # Vertical alignment isn't configurable in this native widget.
         pass
+
+    def set_cursor_at_end(self):
+        pytest.skip("Cursor positioning not supported on this platform")