[widget audit] toga.MultilineTextInput #1938

freakboy3742 · 2023-05-10T06:55:59Z

Audit checklist

freakboy3742 · 2023-05-10T06:56:53Z

cocoa/src/toga_cocoa/widgets/multilinetextinput.py

@@ -14,9 +17,8 @@

 class TogaTextView(NSTextView):
    @objc_method
-    def touchBar(self):
-        # Disable the touchbar.
-        return None


This was needed in the past to avoid a crash if the app ran on a MacBook with a Touch Bar; however, touchbars are no longer present on modern Macs, and in my testing on an older macBook with a Touch Bar, the bug no longer manifests.

mhsmith

The Android implementation is now complete, though there are still some bugs with scrolling and background colors which I'll look at tomorrow.

Meanwhile, here's a partial review:

mhsmith · 2023-05-17T13:21:24Z

core/src/toga/widgets/multilinetextinput.py

    @property
    def placeholder(self):
-        """The placeholder text.
+        """The placeholder text for the widget.


This, and the other properties, should have type annotations, as in Slider. At some point we should go back and do all the other widgets as well – but not in this PR, because it's big enough already.

Agreed - I noticed this myself when working on TextInput; I'll wait for you to finish your pass so I don't step on your toes (or, if you feel enthused, feel free to add annotations yourself)

Scratch that - I'll do a pass now. Can't step on your toes while you're asleep :-)

docs/reference/api/widgets/multilinetextinput.rst

core/src/toga/widgets/multilinetextinput.py

docs/reference/api/widgets/multilinetextinput.rst

core/src/toga/widgets/multilinetextinput.py

mhsmith · 2023-05-17T15:44:38Z

iOS/tests_backend/widgets/multilinetextinput.py

+    async def wait_for_scroll_completion(self):
+        position = self.vertical_scroll_position
+        current = None


There's no platform-specific code in this method, so it could be moved to the testbed and avoid having empty implementations for all the other backends.

Agreed it would be desirable to avoid needing to define an empty method; however, it would require introducing a sleep into platforms that don't need it.

cocoa/tests_backend/widgets/multilinetextinput.py

mhsmith

[Non-deleteable comment caused by GitHub glitch]

examples/multilinetextinput/multilinetextinput/app.py

mhsmith · 2023-05-18T16:02:18Z

android/tests_backend/widgets/label.py

+    @property
+    def vertical_alignment(self):
+        return toga_vertical_alignment(self.native.getGravity())


This will have to be implemented by the other backends.

I've done this for iOS, Cocoa, GTK and Winforms; although for iOS and Cocoa, it's a bit of a non-test because there's literally no property to inspect to verify vertical alignment - it's just what the widget does (or, in the case of iOS Label, what the widget has been overridden to do).

…OS libs.

…ignment.

freakboy3742 · 2023-05-21T01:35:04Z

In the process of debugging a test for NumberInput, I've found a bug with all the text input APIs - we've overloaded the clear() API. TextInput and MultilineTextInput both define a clear() method that removes all content; but the base Widget also defines clear() that removes all children. As TextInput/MultilineTextInput don't have children, there isn't any functional issue; but it's obviously a confusing naming overlap.

The clear() name was only added recently to Toga (#1893); but the name was inherited from Travertino as a core node operation.

I can see a couple of ways forward:

Ignore the problem. It isn't functionally ambiguous, as input widgets will always be leaf nodes.
Remove clear() as an API on text inputs. This would be backwards incompatible, but the functionality is achievable with self.value = "".
Rename clear() on the base node (and possibly also Travertino) - clear_children() perhaps? If we do this, we might need to consider renaming add, insert and remove as well for consistency. If we do this rename, we may also need to re-introduce add/insert/remove/clear APIs for Box as proxies, as this is a commonly used API for constructing layouts.
Remove clear() as a method on the base node, and only make it available as an API on Box (which actually has children). Again, for consistency, there might be an argument to be made for removing add, insert and remove as well, as these can only be used on Box in practice. This won't hide it from the base node though, unless we also modify Travertino to make these APIs private.

I'm not sure which one I prefer at this point, but I probably fall somewhere between 2 and 3. Thoughts @mhsmith?

mhsmith · 2023-05-21T18:08:48Z

I think we should go with 2. Remove clear() as an API on text inputs. This method was hardly saving any typing anyway, compared to value = "".

freakboy3742 · 2023-05-21T23:42:26Z

android/src/toga_android/libs/android/drawable.py

Should these be here, or in android.graphics?

At some point we should remove the libs folder and use Chaquopy's from ... import ... syntax, so we don't need to edit 2 files every time we import a new class. To make it easy to do that with a simple search and replace, I've made drawable a submodule of graphics.

freakboy3742 · 2023-05-22T03:51:03Z

I think we should go with 2. Remove clear() as an API on text inputs. This method was hardly saving any typing anyway, compared to value = "".

Done - I've removed it (and added a deprecation note).

mhsmith · 2023-05-23T22:53:44Z

Since Winforms displays the widget's value and placeholder through the same mechanism, only one of them at a time can be retrieved through the native API. So I've merged the value and placeholder properties on the probe into a single value property, which always returns whatever text is visible to the user.

I also added a few additional assertions, one of which verifies that a typed character is actually visible after the on_change event fires. The assertion is currently on probe.value, but it should probably check widget.value as well. Anyway, this is currently failing on iOS, maybe because the placeholder isn't being hidden correctly.

…e focus handlers.

freakboy3742 · 2023-05-24T06:26:23Z

Success!! I've cleaned up the iOS error - the cause was a weird edge case where the widget already had focus, and was programmatically cleared. The same error was technically present on GTK (and I think Windows) as well, but wasn't visible because of the way the keyboard handler was triggering.

I've also done a small cleanup on the Winforms implementation, removing the need for a proxied copy of the text of the widget; and added a documentation note about the color limitations on Winforms transparent backgrounds.

With that, I'm happy with what is here; if you're happy to, we're good to merge!

freakboy3742 added 4 commits May 9, 2023 13:56

Audit docs and core tests for MultilineTextInput.

5cac536

WIP

5429acc

Cocoa MultilineTextView to 100% coverage.

c0cf0f3

iOS to 100% coverage.

cc80700

freakboy3742 commented May 10, 2023

View reviewed changes

freakboy3742 and others added 10 commits May 10, 2023 14:59

Add Changenote.

8fa3aa9

Use the UIKeyInput protocol to fake keyboard input.

9096f52

Ensure a redraw includes at an event loop tick on macOS.

cf9da9c

Spelling corrections in docstrings.

5800c40

Tweaked some test docstrings.

6a5be8a

Gtk implementation to 100%

d89e49c

Enable GTK focus tests.

2f8f214

Add a window manager to the GTK CI config.

7aea2d0

Correct iOS placeholder test definition.

7fceda3

Android WIP

ead982d

mhsmith reviewed May 17, 2023

View reviewed changes

freakboy3742 commented May 17, 2023

View reviewed changes

examples/multilinetextinput/multilinetextinput/app.py Outdated Show resolved Hide resolved

freakboy3742 added 10 commits May 18, 2023 07:53

Merge branch 'main' into audit-multilinetext

43759f9

Add type annotations.

c763aa9

Tweaked some docs formatting.

4cdab2c

Simplified some probe handling.

ff27cde

Tweaked handling of on-change and enabled.

e636a1f

Correct GTK on_change handling.

98343dc

Additional tolerance for scoll size.

375d26c

Another scrollbar tolerance tweak.

8ef583d

Propegate widget descriptions to the API summary page.

838c6e4

Actually save all the changes before pushing...

6dff342

freakboy3742 mentioned this pull request May 18, 2023

[widget audit] TextInput, PasswordInput #1944

Merged

11 tasks

Update Android for changes in testbed

80ea9f6

mhsmith reviewed May 18, 2023

View reviewed changes

freakboy3742 and others added 5 commits May 19, 2023 09:17

Implement vertical alignment checks for GTK.

cbe63ec

Removed and no-covered some unreachable and unused content in cocoa/i…

9eec789

…OS libs.

Probe implementations (and widget implementation) for top vertical al…

2ff9920

…ignment.

Added Winforms implementation and fix for vertical alignment.

08c8d50

Fix Android background color

e379547

Android at 100% coverage

5db4c77

freakboy3742 commented May 21, 2023

View reviewed changes

Deprecated the clear() method on text inputs.

be9ca2f

mhsmith mentioned this pull request May 22, 2023

Fix text alignment for MultilineTextInput on Android #1808

Merged

4 tasks

freakboy3742 and others added 5 commits May 23, 2023 10:09

Add allowance for minor GTK style differences.

07abb24

Update change note and support table

e9132f0

Make libs/android/graphics/drawable match Java package structure

df00658

All Winforms tests passing except test_scroll_position

bb71950

Winforms at 100% coverage

3ad5352

Correct iOS test failure caused by focus.

e687898

freakboy3742 force-pushed the audit-multilinetext branch from 5a71b9d to e687898 Compare May 24, 2023 04:50

freakboy3742 added 3 commits May 24, 2023 13:12

Document Winforms issue with TRANSPARENT backgrounds, and mainline th…

4ca8a9b

…e focus handlers.

Correct GTK handling of clearing while focussed.

87fffda

Simplify winforms implementation, removing proxy value.

fee4bb6

Winforms: fix interactions between placeholder and on_change handler

9f871ef

mhsmith approved these changes May 25, 2023

View reviewed changes

mhsmith merged commit 6f16eef into beeware:main May 25, 2023

freakboy3742 deleted the audit-multilinetext branch June 26, 2023 02:17

freakboy3742 mentioned this pull request Jul 31, 2023

MultiLineTextInput Disable/enable is not working in Cocoa #888

Closed

14 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[widget audit] toga.MultilineTextInput #1938

[widget audit] toga.MultilineTextInput #1938

freakboy3742 commented May 10, 2023 •

edited by mhsmith

Loading

freakboy3742 May 10, 2023

mhsmith left a comment

mhsmith May 17, 2023

freakboy3742 May 17, 2023

freakboy3742 May 17, 2023

mhsmith May 17, 2023

freakboy3742 May 18, 2023

mhsmith left a comment •

edited

Loading

mhsmith May 18, 2023

freakboy3742 May 19, 2023 •

edited

Loading

freakboy3742 commented May 21, 2023

mhsmith commented May 21, 2023

freakboy3742 May 21, 2023

mhsmith May 23, 2023

freakboy3742 commented May 22, 2023

mhsmith commented May 23, 2023 •

edited

Loading

freakboy3742 commented May 24, 2023

[widget audit] toga.MultilineTextInput #1938

[widget audit] toga.MultilineTextInput #1938

Conversation

freakboy3742 commented May 10, 2023 • edited by mhsmith Loading

Audit checklist

Choose a reason for hiding this comment

mhsmith left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhsmith left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freakboy3742 May 19, 2023 • edited Loading

Choose a reason for hiding this comment

freakboy3742 commented May 21, 2023

mhsmith commented May 21, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

freakboy3742 commented May 22, 2023

mhsmith commented May 23, 2023 • edited Loading

freakboy3742 commented May 24, 2023

freakboy3742 commented May 10, 2023 •

edited by mhsmith

Loading

mhsmith left a comment •

edited

Loading

freakboy3742 May 19, 2023 •

edited

Loading

mhsmith commented May 23, 2023 •

edited

Loading