WinUI 3 foundational implementation

.github/workflows/ci.yml

@@ -265,6 +265,8 @@ jobs:
         - "windows-netfx-x86_64"
         - "windows-netcore-x86_64"
         - "windows-netcore-arm64"
+        - "windows-winui3-x86_64"
+        - "windows-winui3-arm64"
         - "linux-x11-gtk3"
         - "linux-wayland-gtk3"
         - "linux-wayland-gtk4"
@@ -519,6 +521,32 @@ jobs:
           runs-on: "windows-11-arm"
           app-user-data-path: '$HOME\AppData\Local\Tiberius Yak\Toga Testbed\Data'
 
+        - backend: "windows-winui3-x86_64"
+          platform: "windows"
+          runs-on: "windows-latest"
+          testbed-app: "testbed-winui3"
+          app-user-data-path: '$HOME\AppData\Local\Tiberius Yak\Toga Testbed (WinUI 3)\Data'
+          pre-command-pwsh: |
+            Invoke-WebRequest `
+            -Uri "https://aka.ms/windowsappsdk/2.3/2.3.1/windowsappruntimeinstall-x64.exe" `
+            -OutFile "windows_app_sdk_installer.exe"
+            Start-Process `
+            -FilePath ".\windows_app_sdk_installer.exe" `
+            -Wait
+
+        - backend: "windows-winui3-arm64"
+          platform: "windows"
+          runs-on: "windows-11-arm"
+          testbed-app: "testbed-winui3"
+          app-user-data-path: '$HOME\AppData\Local\Tiberius Yak\Toga Testbed (WinUI 3)\Data'
+          pre-command-pwsh: |
+            Invoke-WebRequest `
+            -Uri "https://aka.ms/windowsappsdk/2.3/2.3.1/windowsappruntimeinstall-arm64.exe" `
+            -OutFile "windows_app_sdk_installer.exe"
+            Start-Process `
+            -FilePath ".\windows_app_sdk_installer.exe" `
+            -Wait
+
         - backend: "iOS"
           platform: "iOS"
           runs-on: "macos-15"
@@ -561,7 +589,12 @@ jobs:
       with:
         python-version: "3.12"
 
-    - name: Install Dependencies
+    - name: Install Dependencies (pwsh)
+      if: matrix.platform == 'windows'
+      shell: pwsh
+      run: ${{ matrix.pre-command-pwsh }}
+
+    - name: Install Dependencies (bash)
       env:
         PIP_BREAK_SYSTEM_PACKAGES: "1"
       run: |

android/tests_backend/app.py

@@ -85,13 +85,13 @@ async def close_about_dialog(self):
         assert about_dialog is not None, "No about dialog displayed"
         await self.press_dialog_button(about_dialog, "OK")
 
-    def activate_menu_visit_homepage(self):
+    async def activate_menu_visit_homepage(self):
         pytest.xfail("This backend doesn't have a visit homepage command")
 
-    def assert_menu_item(self, path, *, enabled=True):
+    async def assert_menu_item(self, path, *, enabled=True):
         assert self._menu_item(path).isEnabled() == enabled
 
-    def assert_menu_order(self, path, expected):
+    async def assert_menu_order(self, path, expected):
         item = self._menu_item(path)
         menu = item.getSubMenu()
 
@@ -105,8 +105,8 @@ def assert_menu_order(self, path, expected):
             else:
                 assert menu.getItem(i - separator_offset).getTitle() == title
 
-    def assert_system_menus(self):
-        self.assert_menu_item(["About Toga Testbed"])
+    async def assert_system_menus(self):
+        await self.assert_menu_item(["About Toga Testbed"])
 
     def activate_menu_close_window(self):
         pytest.xfail("This backend doesn't have a window management menu")
@@ -140,10 +140,10 @@ def has_status_icon(self, status_icon):
     def status_menu_items(self, status_icon):
         pytest.xfail("Status icons not implemented on Android")
 
-    def activate_status_icon_button(self, item_id):
+    async def activate_status_icon_button(self, item_id):
         pytest.xfail("Status icons not implemented on Android")
 
-    def activate_status_menu_item(self, item_id, title):
+    async def activate_status_menu_item(self, item_id, title):
         pytest.xfail("Status icons not implemented on Android")
 
     async def assert_event_loop(self):

android/tests_backend/icons.py

@@ -11,13 +11,14 @@
 class IconProbe(BaseProbe):
     # Android only supports 1 format, so the alternate is the same as the primary.
     alternate_resource = "resources/icons/blue"
+    alternate_bad = "resources/icons/bad_png"
 
     def __init__(self, app, icon):
         super().__init__(app)
         self.icon = icon
         assert isinstance(self.icon._impl.native, Bitmap)
 
-    def assert_icon_content(self, path):
+    async def assert_icon_content(self, path):
         if path == "resources/icons/green":
             assert (
                 self.icon._impl.path == self.app.paths.app / "resources/icons/green.png"
@@ -29,13 +30,13 @@ def assert_icon_content(self, path):
         else:
             pytest.fail("Unknown icon resource")
 
-    def assert_default_icon_content(self):
+    async def assert_default_icon_content(self):
         assert (
             self.icon._impl.path
             == Path(toga_android.__file__).parent / "resources/toga.png"
         )
 
-    def assert_platform_icon_content(self):
+    async def assert_platform_icon_content(self):
         assert self.icon._impl.path == self.app.paths.app / "resources/logo-android.png"
 
     def assert_app_icon_content(self):

android/tests_backend/widgets/base.py

@@ -192,6 +192,9 @@ async def undo(self):
     async def redo(self):
         pytest.skip("Redo not supported on this platform")
 
+    async def assert_backend_specific_properties(self):
+        pytest.skip("Test not implemented for this platform")
+
 
 def find_view_by_type(root, cls):
     assert isinstance(root, View)

android/tests_backend/window.py

@@ -21,11 +21,7 @@ def __init__(self, app, window):
         self.window = window
         self.impl = self.window._impl
 
-    async def wait_for_window(
-        self,
-        message,
-        state=None,
-    ):
+    async def wait_for_window(self, message, state=None):
         await self.redraw(message, delay=0.1)
         if state:
             timeout = 5

changes/2574.feature.1.md

@@ -0,0 +1 @@
+Toga now provides a WinUI 3 backend for Windows desktops.

changes/2574.feature.2.md

@@ -0,0 +1 @@
+The Toga WinUI 3 backend for Windows desktops now implements StatusIcons.

changes/2574.feature.3.md

@@ -0,0 +1 @@
+The Toga WinUI 3 backend for Windows desktops now implements the Box widget.

changes/2574.feature.4.md

@@ -0,0 +1 @@
+The Toga WinUI 3 backend for Windows desktops now implements the Button widget.

changes/2574.feature.5.md

@@ -0,0 +1 @@
+The Toga WinUI 3 backend for Windows desktops now implements the Label widget.

cocoa/tests_backend/app.py

@@ -150,7 +150,7 @@ def activate_menu_hide(self):
             argtypes=[objc_id],
         )
 
-    def activate_menu_exit(self):
+    async def activate_menu_exit(self):
         self._activate_menu_item(["*", "Quit Toga Testbed"])
 
     def activate_menu_about(self):
@@ -161,37 +161,37 @@ async def close_about_dialog(self):
         if isinstance(about_dialog, NSPanel):
             about_dialog.close()
 
-    def activate_menu_visit_homepage(self):
+    async def activate_menu_visit_homepage(self):
         self._activate_menu_item(["Help", "Visit homepage"])
 
-    def assert_system_menus(self):
-        self.assert_menu_item(["*", "About Toga Testbed"], enabled=True)
-        self.assert_menu_item(["*", "Hide Toga Testbed"], enabled=True)
-        self.assert_menu_item(["*", "Hide Others"], enabled=True)
-        self.assert_menu_item(["*", "Show All"], enabled=True)
-        self.assert_menu_item(["*", "Quit Toga Testbed"], enabled=True)
-
-        self.assert_menu_item(["File", "New Example Document"], enabled=True)
-        self.assert_menu_item(["File", "New Read-only Document"], enabled=True)
-        self.assert_menu_item(["File", "Open\u2026"], enabled=True)
-        self.assert_menu_item(["File", "Save"], enabled=True)
-        self.assert_menu_item(["File", "Save As\u2026"], enabled=True)
-        self.assert_menu_item(["File", "Save All"], enabled=True)
-        self.assert_menu_item(["File", "Close"], enabled=True)
-        self.assert_menu_item(["File", "Close All"], enabled=True)
-
-        self.assert_menu_item(["Edit", "Undo"], enabled=True)
-        self.assert_menu_item(["Edit", "Redo"], enabled=True)
-        self.assert_menu_item(["Edit", "Cut"], enabled=True)
-        self.assert_menu_item(["Edit", "Copy"], enabled=True)
-        self.assert_menu_item(["Edit", "Paste"], enabled=True)
-        self.assert_menu_item(["Edit", "Paste and Match Style"], enabled=True)
-        self.assert_menu_item(["Edit", "Delete"], enabled=True)
-        self.assert_menu_item(["Edit", "Select All"], enabled=True)
-
-        self.assert_menu_item(["Window", "Minimize"], enabled=True)
-
-        self.assert_menu_item(["Help", "Visit homepage"], enabled=True)
+    async def assert_system_menus(self):
+        await self.assert_menu_item(["*", "About Toga Testbed"], enabled=True)
+        await self.assert_menu_item(["*", "Hide Toga Testbed"], enabled=True)
+        await self.assert_menu_item(["*", "Hide Others"], enabled=True)
+        await self.assert_menu_item(["*", "Show All"], enabled=True)
+        await self.assert_menu_item(["*", "Quit Toga Testbed"], enabled=True)
+
+        await self.assert_menu_item(["File", "New Example Document"], enabled=True)
+        await self.assert_menu_item(["File", "New Read-only Document"], enabled=True)
+        await self.assert_menu_item(["File", "Open\u2026"], enabled=True)
+        await self.assert_menu_item(["File", "Save"], enabled=True)
+        await self.assert_menu_item(["File", "Save As\u2026"], enabled=True)
+        await self.assert_menu_item(["File", "Save All"], enabled=True)
+        await self.assert_menu_item(["File", "Close"], enabled=True)
+        await self.assert_menu_item(["File", "Close All"], enabled=True)
+
+        await self.assert_menu_item(["Edit", "Undo"], enabled=True)
+        await self.assert_menu_item(["Edit", "Redo"], enabled=True)
+        await self.assert_menu_item(["Edit", "Cut"], enabled=True)
+        await self.assert_menu_item(["Edit", "Copy"], enabled=True)
+        await self.assert_menu_item(["Edit", "Paste"], enabled=True)
+        await self.assert_menu_item(["Edit", "Paste and Match Style"], enabled=True)
+        await self.assert_menu_item(["Edit", "Delete"], enabled=True)
+        await self.assert_menu_item(["Edit", "Select All"], enabled=True)
+
+        await self.assert_menu_item(["Window", "Minimize"], enabled=True)
+
+        await self.assert_menu_item(["Help", "Visit homepage"], enabled=True)
 
     def _activate_menu_window_item(self, path):
         item = self._menu_item(path)
@@ -223,11 +223,11 @@ def assert_dialog_in_focus(self, dialog):
             "The dialog is not in focus"
         )
 
-    def assert_menu_item(self, path, enabled):
+    async def assert_menu_item(self, path, enabled):
         item = self._menu_item(path)
         assert item.isEnabled() == enabled
 
-    def assert_menu_order(self, path, expected):
+    async def assert_menu_order(self, path, expected):
         menu = self._menu_item(path).submenu
 
         assert menu.numberOfItems == len(expected)
@@ -333,10 +333,10 @@ def status_menu_items(self, status_icon):
             # It's a button status item
             return None
 
-    def activate_status_icon_button(self, item_id):
+    async def activate_status_icon_button(self, item_id):
         self.app.status_icons[item_id]._impl.native.button.performClick(None)
 
-    def activate_status_menu_item(self, item_id, title):
+    async def activate_status_menu_item(self, item_id, title):
         item = self.app.status_icons[item_id]._impl.native.menu.itemWithTitle(title)
         send_message(
             self.app._impl.native.delegate,

cocoa/tests_backend/icons.py

@@ -12,14 +12,15 @@
 
 class IconProbe(BaseProbe):
     alternate_resource = "resources/icons/blue"
+    alternate_bad = "resources/icons/bad_png"
 
     def __init__(self, app, icon):
         super().__init__()
         self.app = app
         self.icon = icon
         assert isinstance(self.icon._impl.native, NSImage)
 
-    def assert_icon_content(self, path):
+    async def assert_icon_content(self, path):
         match path:
             case "resources/icons/green":
                 assert (
@@ -34,13 +35,13 @@ def assert_icon_content(self, path):
             case _:
                 pytest.fail("Unknown icon resource")
 
-    def assert_default_icon_content(self):
+    async def assert_default_icon_content(self):
         assert (
             self.icon._impl.path
             == Path(toga_cocoa.__file__).parent / "resources/toga.icns"
         )
 
-    def assert_platform_icon_content(self):
+    async def assert_platform_icon_content(self):
         assert self.icon._impl.path == self.app.paths.app / "resources/logo-macOS.icns"
 
     def assert_app_icon_content(self):

cocoa/tests_backend/widgets/base.py

@@ -1,3 +1,4 @@
+from pytest import skip
 from rubicon.objc import NSPoint
 
 from toga.colors import TRANSPARENT
@@ -224,3 +225,6 @@ async def undo(self):
 
     async def redo(self):
         await self.type_character("z", alt=True, shift=True)
+
+    async def assert_backend_specific_properties(self):
+        skip("Test not implemented for this platform")

cocoa/tests_backend/window.py

@@ -1,5 +1,6 @@
 import asyncio
 
+import pytest
 from rubicon.objc import objc_id, send_message
 
 from toga.constants import WindowState
@@ -29,11 +30,7 @@ def __init__(self, app, window):
         self.native = window._impl.native
         assert isinstance(self.native, NSWindow)
 
-    async def wait_for_window(
-        self,
-        message,
-        state=None,
-    ):
+    async def wait_for_window(self, message, state=None):
         await self.redraw(message, delay=0.1)
 
         if state:
@@ -87,7 +84,7 @@ async def cleanup(self):
                 delay = 0.1
         await self.redraw("Closing window", delay=delay)
 
-    def close(self):
+    async def close(self):
         self.native.performClose(None)
 
     @property
@@ -113,7 +110,7 @@ def is_minimizable(self):
     def is_minimized(self):
         return bool(self.native.isMiniaturized)
 
-    def minimize(self):
+    async def minimize(self):
         self.native.performMiniaturize(None)
 
     def unminimize(self):
@@ -176,3 +173,6 @@ def automated_show(host_window, future):
     def _setup_file_dialog_result(self, dialog, result):
         # Closing a window modal file dialog is the same as alerts.
         self._setup_alert_dialog_result(dialog, result)
+
+    async def assert_system_dpi_change(self, get_probe, mock_scale):
+        pytest.skip("Test not implemented for this platform")