Winforms detailed list revamp

android/tests_backend/widgets/detailedlist.py

@@ -80,6 +80,9 @@ async def wait_for_scroll_completion(self):
     async def select_row(self, row, add=False):
         self._row_layout(row).performClick()
 
+    async def deselect_all(self):
+        self.impl._clear_selection()
+
     def refresh_available(self):
         return self.scroll_position <= 0
 

changes/2110.feature.1.md

@@ -0,0 +1 @@
+The DetailedList widget on Windows now supports primary and secondary actions via a context menu.

changes/2110.feature.2.md

@@ -0,0 +1 @@
+The DetailedList widget on Windows now supports the refresh action via a context menu.

changes/4319.feature.md

@@ -0,0 +1 @@
+The style of the DetailedList widget on Windows now matches the other platforms.

cocoa/tests_backend/widgets/detailedlist.py

@@ -118,6 +118,11 @@ async def select_row(self, row, add=False):
             modifierFlags=NSEventModifierFlagCommand if add else 0,
         )
 
+    async def deselect_all(self):
+        # Assume there is blank space at the bottom of the client area.
+        row = self.row_count
+        await self.select_row(row)
+
     async def _refresh_action(self, offset):
         # Create a scroll event where event phase = Began, Momenum scroll phase = Begin,
         # and the pixel value is equal to the requested offset.

docs/en/reference/api/widgets/detailedlist.md

@@ -64,23 +64,21 @@ Items in a DetailedList will respond to a primary and secondary action if the `o
 * On **Android**, a long press displays a menu with the primary and secondary actions.
 * On **iOS**, swiping left triggers the primary action, and swiping right triggers the secondary action.
 * On **GTK**, a right click displays buttons for the primary and secondary actions.
-* On **macOS**, a right click displays a context menu with the primary and secondary actions.
+* On **macOS** and **Windows**, a right click displays a context menu with the primary and secondary actions.
 * On **Qt**, the primary and secondary actions are displayed as standalone buttons.
-* On **Windows**, the implementation does not currently support primary or secondary actions.
 
 By default, the primary and secondary action will be labeled as "Delete" and "Action", respectively. These names can be overridden by providing a `primary_action` and `secondary_action` argument when constructing the DetailedList. Although the primary action is labeled "Delete" by default, the DetailedList will not perform any data deletion as part of the UI interaction. It is the responsibility of the application to implement any data deletion behavior as part of the `on_primary_action` handler.
 
 The DetailedList as a whole will also respond to a refresh UI action if an `on_refresh` handler is set:
 
-* On **macOS**, **iOS** and **Android**, pulling down at the top of the list triggers a refresh.
+* On **Android**, **iOS** and **macOS**, pulling down at the top of the list triggers a refresh.
 * On **Qt**, a button bar displays a refresh button.
 * On **GTK**, a floating refresh button is displayed when scrolled to the top.
-* On **Windows**, the implementation does not currently support refresh.
+* On **Windows**, a right click displays a context menu with a refresh option.
 
 ## Notes
 
 * The iOS Human Interface Guidelines differentiate between "Normal" and "Destructive" actions on a row. Toga will interpret any action with a name of "Delete" or "Remove" as destructive, and will render the action appropriately.
-* The WinForms implementation currently uses a column layout similar to [`Table`][toga.Table], and does not support the primary, secondary or refresh actions.
 * Using DetailedList on Android requires the AndroidX SwipeRefreshLayout widget in your project's Gradle dependencies. Ensure your app declares a dependency on `androidx.swiperefreshlayout:swiperefreshlayout:1.1.0` or later.
 
 ## Reference

gtk/tests_backend/widgets/detailedlist.py

@@ -54,6 +54,9 @@ async def wait_for_scroll_completion(self):
     async def select_row(self, row, add=False):
         self.native_detailedlist.select_row(self.impl.store[row])
 
+    async def deselect_all(self):
+        self.native_detailedlist.unselect_all()
+
     def refresh_available(self):
         return self.impl.native_revealer.get_child_revealed()
 

iOS/tests_backend/widgets/detailedlist.py

@@ -79,13 +79,28 @@ async def wait_for_scroll_completion(self):
             await asyncio.sleep(0.05)
             current = self.scroll_position
 
-    async def select_row(self, row, add=False):
+    async def change_selection(self, row, add=False, deselect=False):
         path = NSIndexPath.indexPathForRow(row, inSection=0)
-        self.native.selectRowAtIndexPath(path, animated=False, scrollPosition=0)
+        if deselect:
+            self.native.deselectRowAtIndexPath(path, animated=False)
+        else:
+            self.native.selectRowAtIndexPath(path, animated=False, scrollPosition=0)
+
         # Need to use the long form of this method because the first argument when used
         # as a selector is ambiguous with a property of the same name on the object.
         self.native.delegate.tableView_didSelectRowAtIndexPath_(self.native, path)
 
+    async def select_row(self, row, add=False):
+        await self.change_selection(row, add)
+
+    async def deselect_all(self):
+        row = self.widget.selection
+        if row is None:
+            return
+
+        row_index = self.widget.data.index(row)
+        await self.change_selection(row_index, deselect=True)
+
     def refresh_available(self):
         return self.scroll_position <= 0
 

qt/tests_backend/widgets/detailedlist.py

@@ -61,6 +61,9 @@ async def select_row(self, row, add=False):
         index = self._row_to_index(row)
         self.native.selectionModel().select(index, self.native.selectionCommand(index))
 
+    async def deselect_all(self):
+        self.native.clearSelection()
+
     def refresh_available(self):
         # need scroll position 0 to be comptaible with tests for pull-down scroll
         return (

testbed/tests/widgets/test_detailedlist.py

@@ -148,6 +148,32 @@ async def test_select(widget, probe, source, on_select_handler):
     on_select_handler.reset_mock()
 
 
+async def test_deselect(widget, probe):
+    """Test for deselection"""
+    red = toga.Icon("resources/icons/red")
+    green = toga.Icon("resources/icons/green")
+
+    # Change the data source for something smaller
+    widget.data = [
+        {
+            "a": MyData(i),
+            "b": i,
+            "c": {0: green, 1: red}[i % 2],
+        }
+        for i in range(5)
+    ]
+    await probe.redraw("Data source has been changed")
+
+    # Select a single row
+    await probe.select_row(2)
+    await probe.redraw("Third row is selected")
+    assert widget.selection == widget.data[2]
+    # Deselect all
+    await probe.deselect_all()
+    await probe.redraw("Row is deselected")
+    assert widget.selection is None
+
+
 class MyData:
     def __init__(self, text):
         self.text = text

winforms/src/toga_winforms/__init__.py

@@ -1,10 +1,8 @@
 import clr
 import travertino
 
-from .libs.user32 import (
-    DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2,
-    SetProcessDpiAwarenessContext,
-)
+from .libs.user32 import SetProcessDpiAwarenessContext
+from .libs.windowconstants import DPI_AWARENESS_CONTEXT_PER_MONITOR_AWARE_V2
 
 # Add a reference to the Winforms assembly
 clr.AddReference("System.Windows.Forms")

winforms/src/toga_winforms/dialogs.py

@@ -11,7 +11,8 @@
 
 from toga.handlers import WeakrefCallable
 
-from .libs.user32 import DPI_AWARENESS_CONTEXT_UNAWARE, SetThreadDpiAwarenessContext
+from .libs.user32 import SetThreadDpiAwarenessContext
+from .libs.windowconstants import DPI_AWARENESS_CONTEXT_UNAWARE
 
 
 class BaseDialog:

winforms/src/toga_winforms/libs/activationcontext.py

@@ -0,0 +1,73 @@
+import functools
+from collections.abc import Callable
+from ctypes import WinDLL, WinError, byref, get_last_error, sizeof
+from pathlib import Path
+
+from . import windowconstants as wc
+from .kernel32 import ActivateActCtx, CreateActCtxW, DeactivateActCtx, ReleaseActCtx
+from .kernel32classes import ACTCTXW
+from .win32 import ULONG_PTR
+
+
+def activation_context(input_function: Callable):
+    """A wrapper to call functions within the Toga activation context.
+
+    This is primarily used for Common Control version 6, and is based on the built-in
+    wrapper that is used when the ISOLATION_AWARE_ENABLED macro is employed. This is
+    described by Raymond Chen here:
+    https://devblogs.microsoft.com/oldnewthing/20140508-00/?p=1043
+    """
+
+    @functools.wraps(input_function)
+    def call_with_activation_context(*args, **kwargs):
+        manifest_path = str(
+            Path(__file__).parent.parent / "resources" / "win32.manifest"
+        )
+
+        cookie = ULONG_PTR()
+        actctx = ACTCTXW()
+        actctx.cbSize = sizeof(ACTCTXW)
+
+        # It is implicit in the ACTCTXW documentation that when using a manifest only
+        # lpSource and cbSize need to be set.
+        actctx.lpSource = manifest_path
+
+        # According to the ACTCTXW documentation, the manifest will be assumed to be
+        # written in the current user's current UI language. So, specify that the
+        # manifest is written in US English.
+        actctx.wLangId = 1033
+
+        # Create a handle and activation context from ../resources/win32.manifest.
+        handle_actctx = CreateActCtxW(byref(actctx))
+        if handle_actctx == wc.INVALID_HANDLE_VALUE:  # pragma: no cover
+            # This is not expected to fail.
+            raise WinError(
+                descr="CreateActCtxW failed to create a handle from win32.manifest.",
+                code=get_last_error(),
+            )
+
+        # Activate the activation context.
+        if not ActivateActCtx(handle_actctx, byref(cookie)):  # pragma: no cover
+            # This is not expected to fail.
+            raise WinError(descr="ActivateActCtx failed for win32.manifest.")
+
+        # Call the input function.
+        function_output = input_function(*args, **kwargs)
+
+        if not DeactivateActCtx(0, cookie):  # pragma: no cover
+            # This is not expected to fail.
+            raise WinError(
+                descr="DeactivateActCtx failed for win32.manifest.",
+                code=get_last_error(),
+            )
+
+        ReleaseActCtx(handle_actctx)
+
+        return function_output
+
+    return call_with_activation_context
+
+
+@activation_context
+def WinDLL_activation_context(library: str):
+    return WinDLL(library)

winforms/src/toga_winforms/libs/comctl32.py

@@ -1,10 +1,22 @@
-from ctypes import windll
-from ctypes.wintypes import BOOL, HWND, LPARAM, UINT, WPARAM
+from ctypes import POINTER
+from ctypes.wintypes import BOOL, HDC, HWND, INT, LPARAM, UINT, WPARAM
 
-from .comctl32classes import SUBCLASSPROC
-from .win32 import DWORD_PTR, LRESULT, UINT_PTR
+from .activationcontext import WinDLL_activation_context
+from .comctl32classes import INITCOMMONCONTROLSEX, SUBCLASSPROC
+from .win32 import DWORD_PTR, HIMAGELIST, LRESULT, UINT_PTR
 
-comctl32 = windll.comctl32
+comctl32 = WinDLL_activation_context("comctl32")
+
+# https://learn.microsoft.com/en-us/windows/win32/api/commctrl/nf-commctrl-initcommoncontrolsex
+InitCommonControlsEx = comctl32.InitCommonControlsEx
+InitCommonControlsEx.restype = BOOL
+InitCommonControlsEx.argtypes = [POINTER(INITCOMMONCONTROLSEX)]
+
+
+# https://learn.microsoft.com/en-us/windows/win32/api/commctrl/nf-commctrl-imagelist_draw
+ImageList_Draw = comctl32.ImageList_Draw
+ImageList_Draw.restype = BOOL
+ImageList_Draw.argtypes = [HIMAGELIST, INT, HDC, INT, INT, UINT]
 
 
 # https://learn.microsoft.com/en-us/windows/win32/api/commctrl/nf-commctrl-defsubclassproc

winforms/src/toga_winforms/libs/comctl32classes.py

@@ -12,13 +12,22 @@
     LPWSTR,
     POINT,
     RECT,
+    SIZE,
     UINT,
     WPARAM,
 )
 
 from .win32 import DWORD_PTR, INT_PTR, LRESULT, PUINT, UINT_PTR
 
 
+# learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-initcommoncontrolsex
+class INITCOMMONCONTROLSEX(c_Structure):
+    _fields_ = [
+        ("dwSize", DWORD),
+        ("dwICC", DWORD),
+    ]
+
+
 # https://learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-lvitemw
 class LVITEMW(c_Structure):
     _fields_ = [
@@ -40,15 +49,51 @@ class LVITEMW(c_Structure):
     ]
 
 
-# https://learn.microsoft.com/en-us/windows/win32/api/winuser/ns-winuser-nmhdr
-class NMHDR(c_Structure):
+# learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-lvcolumnw
+class LVCOLUMNW(c_Structure):
+    _fields_ = [
+        ("mask", UINT),
+        ("fmt", INT),
+        ("cx", INT),
+        ("pszText", LPWSTR),
+        ("cchTextMax", INT),
+        ("iSubItem", INT),
+        ("cchTextMax", INT),
+        ("iImage", INT),
+        ("iOrder", INT),
+        ("cxMin", INT),
+        ("cxDefault", INT),
+        ("cxIdeal", INT),
+    ]
+
+
+# learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-lvhittestinfo
+class LVHITTESTINFO(c_Structure):
+    _fields_ = [
+        ("pt", POINT),
+        ("flags", UINT),
+        ("iItem", INT),
+        ("iSubItem", INT),
+        ("iGroup", INT),
+    ]
+
+
+# learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-lvtileviewinfo
+class LVTILEVIEWINFO(c_Structure):
     _fields_ = [
-        ("hwndFrom", HWND),
-        ("idFrom", UINT_PTR),
-        ("code", UINT),
+        ("cbSize", UINT),
+        ("dwMask", DWORD),
+        ("dwFlags", DWORD),
+        ("sizeTile", SIZE),
+        ("cLines", INT),
+        ("rcLabelMargin", RECT),
     ]
 
 
+# Import .user32classes here to avoid circular reference.
+from .user32classes import NMHDR  # noqa
+
+
 # https://learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-nmcustomdraw
 class NMCUSTOMDRAW(c_Structure):
     _fields_ = [
@@ -62,6 +107,21 @@ class NMCUSTOMDRAW(c_Structure):
     ]
 
 
+# learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-nmitemactivate
+class NMITEMACTIVATE(c_Structure):
+    _fields_ = [
+        ("hdr", NMHDR),
+        ("iItem", INT),
+        ("iSubItem", INT),
+        ("uNewState", UINT),
+        ("uOldState", UINT),
+        ("uChanged", UINT),
+        ("ptAction", POINT),
+        ("lParam", LPARAM),
+        ("uKeyFlags", UINT),
+    ]
+
+
 # https://learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-nmlistview
 class NMLISTVIEW(c_Structure):
     _fields_ = [
@@ -76,6 +136,15 @@ class NMLISTVIEW(c_Structure):
     ]
 
 
+# https://learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-nmlvcachehint
+class NMLVCACHEHINT(c_Structure):
+    _fields_ = [
+        ("hdr", NMHDR),
+        ("iFrom", INT),
+        ("iTo", INT),
+    ]
+
+
 # https://learn.microsoft.com/en-us/windows/win32/api/commctrl/ns-commctrl-nmlvcustomdraw
 class NMLVCUSTOMDRAW(c_Structure):
     _fields_ = [

winforms/src/toga_winforms/libs/gdi32.py

@@ -0,0 +1,10 @@
+from ctypes import windll
+from ctypes.wintypes import COLORREF, HDC
+
+gdi32 = windll.GDI32
+
+
+# https://learn.microsoft.com/en-us/windows/win32/api/wingdi/nf-wingdi-settextcolor
+SetTextColor = gdi32.SetTextColor
+SetTextColor.restype = COLORREF
+SetTextColor.argtypes = [HDC, COLORREF]