Add status icons

android/src/toga_android/factory.py

@@ -9,7 +9,7 @@
 from .icons import Icon
 from .images import Image
 from .paths import Paths
-from .statusicons import MenuStatusIcon, StatusIcon, StatusIconSet
+from .statusicons import MenuStatusIcon, SimpleStatusIcon, StatusIconSet
 from .widgets.box import Box
 from .widgets.button import Button
 from .widgets.canvas import Canvas
@@ -54,7 +54,7 @@ def not_implemented(feature):
     "Location",
     # Status icons
     "MenuStatusIcon",
-    "StatusIcon",
+    "SimpleStatusIcon",
     "StatusIconSet",
     # Widgets
     # ActivityIndicator

android/src/toga_android/statusicons.py

@@ -1,7 +1,7 @@
 import toga
 
 
-class BaseStatusIcon:
+class StatusIcon:
     def __init__(self, interface):
         self.interface = interface
         self.native = None
@@ -16,11 +16,11 @@ def remove(self):
         pass  # pragma: no cover
 
 
-class StatusIcon(BaseStatusIcon):
+class SimpleStatusIcon(StatusIcon):
     pass
 
 
-class MenuStatusIcon(BaseStatusIcon):
+class MenuStatusIcon(StatusIcon):
     pass
 
 

cocoa/src/toga_cocoa/factory.py

@@ -10,7 +10,7 @@
 from .icons import Icon
 from .images import Image
 from .paths import Paths
-from .statusicons import MenuStatusIcon, StatusIcon, StatusIconSet
+from .statusicons import MenuStatusIcon, SimpleStatusIcon, StatusIconSet
 
 # Widgets
 from .widgets.activityindicator import ActivityIndicator
@@ -60,7 +60,7 @@ def not_implemented(feature):
     "Location",
     # Status Icons
     "MenuStatusIcon",
-    "StatusIcon",
+    "SimpleStatusIcon",
     "StatusIconSet",
     # Widgets
     "ActivityIndicator",

cocoa/src/toga_cocoa/statusicons.py

@@ -13,7 +13,7 @@
 from .libs import NSMenu, NSMenuItem, NSSquareStatusItemLength, NSStatusBar
 
 
-class BaseStatusIcon:
+class StatusIcon:
     def __init__(self, interface):
         self.interface = interface
         self.native = None
@@ -48,7 +48,7 @@ def onPress_(self, sender) -> None:
         self.interface.on_press()
 
 
-class StatusIcon(BaseStatusIcon):
+class SimpleStatusIcon(StatusIcon):
     def __init__(self, interface):
         super().__init__(interface)
         self.delegate = StatusItemButtonDelegate.alloc().init()
@@ -60,7 +60,7 @@ def create(self):
         self.native.button.target = self.delegate
 
 
-class MenuStatusIcon(BaseStatusIcon):
+class MenuStatusIcon(StatusIcon):
     def create(self):
         super().create()
         self.create_menu()
@@ -83,15 +83,15 @@ def create(self):
             cmd._impl.remove_menu_item(menu_item)
 
         # Determine the primary status icon.
-        primary_group = self.interface.primary_menu_status_icon
+        primary_group = self.interface._primary_menu_status_icon
         if primary_group is None:  # pragma: no cover
             # If there isn't at least one menu status icon, then there aren't any menus
             # to populate. This can't happen in the testbed, so it's marked nocover.
             return
 
         # Recreate the menus for the menu status icons
         group_cache = {
-            item: item._impl.create_menu() for item in self.interface.menu_status_icons
+            item: item._impl.create_menu() for item in self.interface._menu_status_icons
         }
         # Map the COMMANDS group to the primary status icon's menu.
         group_cache[Group.COMMANDS] = primary_group._impl.native.menu

core/src/toga/__init__.py

@@ -21,7 +21,7 @@
 from .icons import Icon
 from .images import Image
 from .keys import Key
-from .statusicons import MenuStatusIcon, StatusIcon
+from .statusicons import MenuStatusIcon, SimpleStatusIcon
 from .types import LatLng, Position, Size
 from .widgets.activityindicator import ActivityIndicator
 from .widgets.base import Widget
@@ -93,7 +93,7 @@ def warn(cls, platform: str, feature: str) -> None:
     "Image",
     # Status icons
     "MenuStatusIcon",
-    "StatusIcon",
+    "SimpleStatusIcon",
     # Types
     "LatLng",
     "Position",

core/src/toga/command.py

@@ -38,7 +38,7 @@ def __init__(
         :param id: A unique identifier for the group.
         """
         self._id = f"group-{_py_id(self)}" if id is None else id
-        self.text = text
+        self._text = text
         self.order = order
         if parent is None and section != 0:
             raise ValueError("Section cannot be set without parent group")
@@ -54,6 +54,11 @@ def id(self) -> str:
         """A unique identifier for the group."""
         return self._id
 
+    @property
+    def text(self) -> str:
+        """A text label for the group."""
+        return self._text
+
     @property
     def parent(self) -> Group | None:
         """The parent of this group; returns ``None`` if the group is a root group."""

core/src/toga/statusicons.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import sys
+from abc import abstractmethod
 from collections.abc import Iterator
 from typing import TYPE_CHECKING, Mapping, Sequence
 
@@ -16,15 +17,24 @@
 _py_id = id
 
 
-class BaseStatusIcon:
-    def __init__(self, icon: IconContentT | None = None, **kwargs):
+class StatusIcon:
+    def __init__(self, icon: IconContentT | None = None):
         """An abstract base class for all status icons."""
-        super().__init__(**kwargs)
         self.factory = get_platform_factory()
         self._impl = getattr(self.factory, self.__class__.__name__)(interface=self)
 
         self.icon = icon
 
+    @property
+    @abstractmethod
+    def id(self) -> str:
+        """A unique identifier for the status icon."""
+
+    @property
+    @abstractmethod
+    def text(self) -> str:
+        """A text label for the status icon."""
+
     @property
     def icon(self) -> Icon | None:
         """The Icon to display in the status bar.
@@ -44,7 +54,7 @@ def icon(self, icon_or_name: IconContentT | None):
         self._impl.set_icon(self._icon)
 
 
-class StatusIcon(BaseStatusIcon):
+class SimpleStatusIcon(StatusIcon):
     def __init__(
         self,
         id: str | None = None,
@@ -71,16 +81,14 @@ def __init__(
         self._text = text if text is not None else toga.App.app.formal_name
 
     def __repr__(self):
-        return f"<StatusIcon {self.text!r}: {self.id}>"
+        return f"<SimpleStatusIcon {self.text!r}: {self.id}>"
 
     @property
     def id(self) -> str:
-        """A unique identifier for the icon."""
         return self._id
 
     @property
     def text(self) -> str:
-        """A text label for the icon."""
         return self._text
 
     @property
@@ -93,7 +101,7 @@ def on_press(self, handler: toga.widgets.button.OnPressHandler) -> None:
         self._on_press = wrapped_handler(self, handler)
 
 
-class MenuStatusIcon(BaseStatusIcon, Group):
+class MenuStatusIcon(Group, StatusIcon):
     def __init__(
         self,
         id: str | None = None,
@@ -112,17 +120,18 @@ def __init__(
         :param text: A text label for the status icon. Defaults to the formal name of
             the app.
         """
-        super().__init__(
+        Group.__init__(
+            self,
             id=f"menustatusitem-{_py_id(self)}" if id is None else id,
-            icon=icon,
             text=(text if text is not None else toga.App.app.formal_name),
         )
+        StatusIcon.__init__(self, icon=icon)
 
     def __repr__(self):
         return f"<MenuStatusIcon {self.text!r}: {self.id}>"
 
 
-class StatusIconSet(Sequence[BaseStatusIcon], Mapping[str, BaseStatusIcon]):
+class StatusIconSet(Sequence[StatusIcon], Mapping[str, StatusIcon]):
     def __init__(self):
         """An ordered collection of status icons.
 
@@ -132,22 +141,22 @@ def __init__(self):
         self.factory = get_platform_factory()
         self._impl = self.factory.StatusIconSet(interface=self)
 
-        self.elements: dict[str, BaseStatusIcon] = {}
+        self.elements: dict[str, StatusIcon] = {}
         self.commands = CommandSet()
 
     @property
-    def menu_status_icons(self):
+    def _menu_status_icons(self):
         """An iterator over the menu status icons that have been registered."""
         return (icon for icon in self if isinstance(icon, MenuStatusIcon))
 
     @property
-    def primary_menu_status_icon(self):
+    def _primary_menu_status_icon(self):
         """The first menu status icon that has been registered.
 
         Returns ``None`` if no menu status icons have been registered.
         """
         try:
-            return next(self.menu_status_icons)
+            return next(self._menu_status_icons)
         except StopIteration:
             # No menu status icons registered.
             return None
@@ -183,7 +192,7 @@ def _create_standard_commands(self):
             )
         )
 
-    def __iter__(self) -> Iterator[BaseStatusIcon]:
+    def __iter__(self) -> Iterator[StatusIcon]:
         return iter(self.elements.values())
 
     def __contains__(self, value: object) -> bool:
@@ -201,7 +210,7 @@ def __getitem__(self, index_or_id):
         else:
             return self.elements[index_or_id]
 
-    def add(self, *status_icons: BaseStatusIcon):
+    def add(self, *status_icons: StatusIcon):
         """Add one or more icons to the set.
 
         :param status_icons: The icon (or icons) to add to the set.
@@ -216,7 +225,7 @@ def add(self, *status_icons: BaseStatusIcon):
         if added and self.commands.on_change:
             self.commands.on_change()
 
-    def remove(self, status_icon: BaseStatusIcon):
+    def remove(self, status_icon: StatusIcon):
         """Remove a single icon from the set.
 
         :param status_icon: The status icon instance to remove.

core/tests/statusicons/test_statusicon.py → core/tests/statusicons/test_simplestatusicon.py

@@ -4,20 +4,20 @@
 import pytest
 
 import toga
-from toga import StatusIcon
+from toga import SimpleStatusIcon
 from toga_dummy.utils import assert_action_not_performed, assert_action_performed
 
 
 def test_create(app):
     """A group can be created with defaults."""
-    status_icon = StatusIcon()
+    status_icon = SimpleStatusIcon()
 
     assert status_icon.id.startswith("statusicon-")
     assert status_icon.icon is None
     assert status_icon.text == "Test App"
     assert status_icon.on_press._raw is None
 
-    assert repr(status_icon).startswith("<StatusIcon 'Test App': statusicon-")
+    assert repr(status_icon).startswith("<SimpleStatusIcon 'Test App': statusicon-")
 
     # Status icon wasn't created as a result of being instantiated
     assert_action_not_performed(status_icon, "create")
@@ -27,15 +27,15 @@ def test_create(app):
 
 @pytest.mark.parametrize("construct_icon", [True, False])
 def test_create_with_params(app, construct_icon):
-    """A fully specified StatusIcon can be created."""
+    """A fully specified SimpleStatusIcon can be created."""
     if construct_icon:
         icon = toga.Icon("path/to/icon")
     else:
         icon = "path/to/icon"
 
     press_handler = Mock()
 
-    status_icon = StatusIcon(
+    status_icon = SimpleStatusIcon(
         id="my-statusicon",
         icon=icon,
         text="My StatusIcon",
@@ -49,7 +49,7 @@ def test_create_with_params(app, construct_icon):
     assert isinstance(status_icon.icon, toga.Icon)
     assert status_icon.icon.path == Path("path/to/icon")
 
-    assert repr(status_icon) == "<StatusIcon 'My StatusIcon': my-statusicon>"
+    assert repr(status_icon) == "<SimpleStatusIcon 'My StatusIcon': my-statusicon>"
 
     # Status icon wasn't created as a result of being instantiated
     assert_action_not_performed(status_icon, "create")