Set default background color for widgets on iOS

changes/767.bugfix.rst

@@ -0,0 +1 @@
+On iOS, the default background color is now TRANSPARENT for Box, Canvas, ImageView, Label, ProgressBar, ScrollContainer and Slider widgets.

iOS/src/toga_iOS/colors.py

@@ -1,4 +1,8 @@
-from toga.colors import TRANSPARENT
+from ctypes import byref
+
+from rubicon.objc import CGFloat
+
+from toga.colors import TRANSPARENT, rgba
 from toga_iOS.libs import UIColor
 
 CACHE = {TRANSPARENT: UIColor.clearColor}
@@ -18,3 +22,12 @@ def native_color(c):
         CACHE[c] = color
 
     return color
+
+
+def toga_color(c):
+    red = CGFloat()
+    green = CGFloat()
+    blue = CGFloat()
+    alpha = CGFloat()
+    c.getRed(byref(red), green=byref(green), blue=byref(blue), alpha=byref(alpha))
+    return rgba(red.value * 255, green.value * 255, blue.value * 255, alpha.value)

iOS/src/toga_iOS/widgets/base.py

@@ -1,6 +1,6 @@
 from abc import abstractmethod
 
-from toga_iOS.colors import native_color
+from toga_iOS.colors import native_color, toga_color
 from toga_iOS.constraints import Constraints
 from toga_iOS.libs import UIColor
 
@@ -13,6 +13,15 @@ def __init__(self, interface):
         self._container = None
         self.constraints = None
         self.native = None
+
+        # Set default background color
+        try:
+            # systemBackgroundColor() was introduced in iOS 13
+            # We don't test on iOS 12, so mark the other branch as nocover
+            self._default_background_color = toga_color(UIColor.systemBackgroundColor())
+        except AttributeError:  # pragma: no cover
+            self._default_background_color = toga_color(UIColor.whiteColor)
+
         self.create()
         self.interface.style.reapply()
 
@@ -90,20 +99,11 @@ def set_color(self, color):
         pass
 
     def set_background_color(self, color):
-        # By default, background color can't be changed
-        pass
-
-    # TODO: check if it's safe to make this the default implementation.
-    def set_background_color_simple(self, value):
-        if value:
-            self.native.backgroundColor = native_color(value)
-        else:
-            try:
-                # systemBackgroundColor() was introduced in iOS 13
-                # We don't test on iOS 12, so mark the other branch as nocover
-                self.native.backgroundColor = UIColor.systemBackgroundColor()
-            except AttributeError:  # pragma: no cover
-                self.native.backgroundColor = UIColor.whiteColor
+        self.native.backgroundColor = (
+            native_color(self._default_background_color)
+            if color is None
+            else native_color(color)
+        )
 
     # INTERFACE
     def add_child(self, child):

iOS/src/toga_iOS/widgets/box.py

@@ -1,6 +1,7 @@
 from rubicon.objc import objc_property
 from travertino.size import at_least
 
+from toga.colors import TRANSPARENT
 from toga_iOS.libs import UIView
 from toga_iOS.widgets.base import Widget
 
@@ -19,12 +20,11 @@ def create(self):
         self.native.interface = self.interface
         self.native.impl = self
 
+        self._default_background_color = TRANSPARENT
+
         # Add the layout constraints
         self.add_constraints()
 
-    def set_background_color(self, value):
-        self.set_background_color_simple(value)
-
     def rehint(self):
         self.interface.intrinsic.width = at_least(0)
         self.interface.intrinsic.height = at_least(0)

iOS/src/toga_iOS/widgets/button.py

@@ -68,10 +68,9 @@ def set_color(self, color):
             )
 
     def set_background_color(self, color):
-        if color == TRANSPARENT or color is None:
-            self.native.backgroundColor = None
-        else:
-            self.native.backgroundColor = native_color(color)
+        super().set_background_color(
+            self._default_background_color if color in {None, TRANSPARENT} else color
+        )
 
     def set_font(self, font):
         self.native.titleLabel.font = font._impl.native

iOS/src/toga_iOS/widgets/canvas.py

@@ -15,7 +15,7 @@
 )
 from travertino.size import at_least
 
-from toga.colors import BLACK, TRANSPARENT, color
+from toga.colors import BLACK, TRANSPARENT, color as named_color
 from toga.constants import Baseline, FillRule
 from toga_iOS.colors import native_color
 from toga_iOS.images import nsdata_to_bytes
@@ -70,6 +70,8 @@ def create(self):
         self.native.interface = self.interface
         self.native.impl = self
 
+        self._default_background_color = TRANSPARENT
+
         # Add the layout constraints
         self.add_constraints()
 
@@ -260,7 +262,7 @@ def _line_height(self, font):
     def measure_text(self, text, font):
         # We need at least a fill color to render, but that won't change the size.
         sizes = [
-            self._render_string(line, font, fill_color=color(BLACK)).size()
+            self._render_string(line, font, fill_color=named_color(BLACK)).size()
             for line in text.splitlines()
         ]
         return (

iOS/src/toga_iOS/widgets/imageview.py

@@ -1,6 +1,5 @@
 from toga.colors import TRANSPARENT
 from toga.widgets.imageview import rehint_imageview
-from toga_iOS.colors import native_color
 from toga_iOS.libs import UIImageView, UIViewContentMode
 from toga_iOS.widgets.base import Widget
 
@@ -15,13 +14,9 @@ def create(self):
         self.native.setTranslatesAutoresizingMaskIntoConstraints_(False)
         self.native.setAutoresizesSubviews_(False)
 
-        self.add_constraints()
+        self._default_background_color = TRANSPARENT
 
-    def set_background_color(self, color):
-        if color == TRANSPARENT or color is None:
-            self.native.backgroundColor = native_color(TRANSPARENT)
-        else:
-            self.native.backgroundColor = native_color(color)
+        self.add_constraints()
 
     def set_image(self, image):
         if image:

iOS/src/toga_iOS/widgets/label.py

@@ -38,6 +38,8 @@ def create(self):
         # We shouldn't ever word wrap; if faced with that option, clip.
         self.native.lineBreakMode = NSLineBreakByClipping
 
+        self._default_background_color = TRANSPARENT
+
         # Add the layout constraints
         self.add_constraints()
 
@@ -47,12 +49,6 @@ def set_alignment(self, value):
     def set_color(self, value):
         self.native.textColor = native_color(value)
 
-    def set_background_color(self, color):
-        if color == TRANSPARENT or color is None:
-            self.native.backgroundColor = native_color(TRANSPARENT)
-        else:
-            self.native.backgroundColor = native_color(color)
-
     def set_font(self, font):
         self.native.font = font._impl.native
 

iOS/src/toga_iOS/widgets/multilinetextinput.py

@@ -141,9 +141,6 @@ def set_color(self, value):
         self.native.textColor = color
         self.placeholder_label.textColor = color
 
-    def set_background_color(self, color):
-        self.set_background_color_simple(color)
-
     def set_alignment(self, value):
         self.native.textAlignment = NSTextAlignment(value)
 

iOS/src/toga_iOS/widgets/numberinput.py

@@ -117,9 +117,6 @@ def set_font(self, font):
     def set_color(self, color):
         self.native.textColor = native_color(color)
 
-    def set_background_color(self, color):
-        self.set_background_color_simple(color)
-
     def rehint(self):
         # Height of a text input is known.
         fitting_size = self.native.systemLayoutSizeFittingSize(CGSize(0, 0))

iOS/src/toga_iOS/widgets/progressbar.py

@@ -2,6 +2,7 @@
 
 from travertino.size import at_least
 
+from toga.colors import TRANSPARENT
 from toga_iOS.libs import CGSize, UIProgressView, UIProgressViewStyle
 from toga_iOS.widgets.base import Widget
 
@@ -41,6 +42,8 @@ def create(self):
         self.native = UIProgressView.alloc().initWithProgressViewStyle_(
             UIProgressViewStyle.Default
         )
+        self._default_background_color = TRANSPARENT
+
         self.add_constraints()
 
         self._running = False

iOS/src/toga_iOS/widgets/scrollcontainer.py

@@ -1,6 +1,7 @@
 from rubicon.objc import SEL, NSMakePoint, NSMakeSize, objc_method, objc_property
 from travertino.size import at_least
 
+from toga.colors import TRANSPARENT
 from toga_iOS.container import Container
 from toga_iOS.libs import UIScrollView
 from toga_iOS.widgets.base import Widget
@@ -31,6 +32,8 @@ def create(self):
         self.native.impl = self
         self.native.delegate = self.native
 
+        self._default_background_color = TRANSPARENT
+
         # UIScrollView doesn't have a native ability to disable a scrolling direction;
         # it's handled by controlling the scrollable area.
         self._allow_horizontal = True
@@ -68,9 +71,6 @@ def content_refreshed(self, container):
 
         self.native.contentSize = NSMakeSize(width, height)
 
-    def set_background_color(self, value):
-        self.set_background_color_simple(value)
-
     def rehint(self):
         self.interface.intrinsic.width = at_least(self.interface._MIN_WIDTH)
         self.interface.intrinsic.height = at_least(self.interface._MIN_HEIGHT)

iOS/src/toga_iOS/widgets/selection.py

@@ -83,9 +83,6 @@ def set_alignment(self, value):
     def set_color(self, color):
         self.native.textColor = native_color(color)
 
-    def set_background_color(self, color):
-        self.set_background_color_simple(color)
-
     def set_font(self, font):
         self.native.font = font._impl.native
 

iOS/src/toga_iOS/widgets/slider.py

@@ -1,6 +1,7 @@
 from rubicon.objc import SEL, CGSize, objc_method, objc_property
 from travertino.size import at_least
 
+from toga.colors import TRANSPARENT
 from toga_iOS.libs import (
     UIControlEventTouchCancel,
     UIControlEventTouchDown,
@@ -49,6 +50,8 @@ def create(self):
         self.native.interface = self.interface
         self.native.impl = self
 
+        self._default_background_color = TRANSPARENT
+
         # Dummy values used during initialization.
         self.value = 0
         self.min_value = 0

iOS/src/toga_iOS/widgets/textinput.py

@@ -138,9 +138,6 @@ def set_alignment(self, value):
     def set_color(self, color):
         self.native.textColor = native_color(color)
 
-    def set_background_color(self, color):
-        self.set_background_color_simple(color)
-
     def set_font(self, font):
         self.native.font = font._impl.native
 

testbed/tests/widgets/test_button.py

@@ -101,6 +101,9 @@ async def test_press(widget, probe):
 
 async def test_background_color_transparent(widget, probe):
     "Buttons treat background transparency as a color reset."
+    del widget.style.background_color
+    original_background_color = probe.background_color
+
     widget.style.background_color = TRANSPARENT
-    await probe.redraw("Button background color should be transparent")
-    assert_color(probe.background_color, None)
+    await probe.redraw("Button background color should be reset to the default color")
+    assert_color(probe.background_color, original_background_color)