Merge pull request #160 from Video-Nomad/fix/systray-empty-pinned-fix

fix(systray): properly hide pinned container on last icon delete

Author: amnweb

docs/widgets/(Widget)-Systray.md

@@ -1,15 +1,17 @@
 # Systray Widget
-| Option               | Type    | Default     | Description                                                                             |
-|----------------------|---------|-------------|-----------------------------------------------------------------------------------------|
-| `class_name`         | string  | `'systray'` | The class name for the base widget.                                                     |
-| `label_collapsed`    | string  | `'▼'`       | Label used for the collapse button when unpinned container is hidden.                   |
-| `label_expanded`     | string  | `'▶'`       | Label used for the collapse button when unpinned container is shown.                    |
-| `label_position`     | string  | `'left'`    | The position of the button that collapses unpinned container. Can be "left" or "right". |
-| `icon_size`          | integer | `16`        | The size of the icons in the systray. Can be any integer between 8 and 64.              |
-| `pin_click_modifier` | string  | `'alt'`     | The modifier key used to pin/unpin icons. Can be "ctrl", "alt" or "shift".              |
-| `show_unpinned`      | boolean | `true`      | Whether to show unpinned container on startup.                                          |
-| `show_battery`       | boolean | `false`     | Whether to show battery icon (from the original systray).                               |
-| `show_volume`        | boolean | `false`     | Whether to show volume icon (from the original systray).                                |
+| Option                 | Type    | Default     | Description                                                                             |
+|------------------------|---------|-------------|-----------------------------------------------------------------------------------------|
+| `class_name`           | string  | `'systray'` | The class name for the base widget.                                                     |
+| `label_collapsed`      | string  | `'▼'`       | Label used for the collapse button when unpinned container is hidden.                   |
+| `label_expanded`       | string  | `'▶'`       | Label used for the collapse button when unpinned container is shown.                    |
+| `label_position`       | string  | `'left'`    | The position of the button that collapses unpinned container. Can be "left" or "right". |
+| `icon_size`            | integer | `16`        | The size of the icons in the systray. Can be any integer between 8 and 64.              |
+| `pin_click_modifier`   | string  | `'alt'`     | The modifier key used to pin/unpin icons. Can be "ctrl", "alt" or "shift".              |
+| `show_unpinned`        | boolean | `true`      | Whether to show unpinned container on startup.                                          |
+| `show_unpinned_button` | boolean | `true`      | Whether to show the collapse unpinned icons button.                                     |
+| `show_battery`         | boolean | `false`     | Whether to show battery icon (from the original systray).                               |
+| `show_volume`          | boolean | `false`     | Whether to show volume icon (from the original systray).                                |
+| `show_network`         | boolean | `false`     | Whether to show network icon (from the original systray).
 
 
 ## Example Configuration
@@ -24,8 +26,10 @@ systray:
     icon_size: 16 # Can be any integer between 8 and 64
     pin_click_modifier: "alt" # Can be "ctrl", "alt" or "shift"
     show_unpinned: true
+    show_unpinned_button: true
     show_battery: false
     show_volume: false
+    show_network: false
 ```
 
 ## Important Notes:
@@ -41,8 +45,10 @@ There are some limitations with the systray widget:
 - **icon_size:** The size of the icons in the systray. Can be any integer between 8 and 64.
 - **pin_click_modifier:** The modifier key used to pin/unpin icons. Can be "ctrl", "alt" or "shift".
 - **show_unpinned:** Whether to show unpinned container on startup.
+- **show_unpinned_button:** Whether to show the 'collapse unpinned icons' button.
 - **show_battery:** Whether to show battery icon (from the original systray).
 - **show_volume:** Whether to show volume icon (from the original systray).
+- **show_network:** Whether to show network icon (from the original systray).
 
 ## Style
 ```css

src/core/validation/widgets/yasb/systray.py

@@ -6,8 +6,10 @@
     "icon_size": 16,
     "pin_click_modifier": "alt",
     "show_unpinned": True,
+    "show_unpinned_button": True,
     "show_battery": False,
     "show_volume": False,
+    "show_network": False,
 }
 
 VALIDATION_SCHEMA = {
@@ -48,6 +50,11 @@
         "required": False,
         "default": DEFAULTS["show_unpinned"],
     },
+    "show_unpinned_button": {
+        "type": "boolean",
+        "required": False,
+        "default": DEFAULTS["show_unpinned_button"],
+    },
     "show_battery": {
         "type": "boolean",
         "required": False,
@@ -58,4 +65,9 @@
         "required": False,
         "default": DEFAULTS["show_volume"],
     },
+    "show_network": {
+        "type": "boolean",
+        "required": False,
+        "default": DEFAULTS["show_network"],
+    },
 }

src/core/widgets/yasb/systray.py

@@ -47,6 +47,7 @@
 
 BATTERY_ICON_GUID = UUID("7820ae75-23e3-4229-82c1-e41cb67d5b9c")
 VOLUME_ICON_GUID = UUID("7820ae73-23e3-4229-82c1-e41cb67d5b9c")
+NETWORK_GUID = UUID("7820ae74-23e3-4229-82c1-e41cb67d5b9c")
 
 
 class TrayMonitorThread(QThread):
@@ -90,23 +91,26 @@ def __init__(
         icon_size: int,
         pin_click_modifier: str,
         show_unpinned: bool,
+        show_unpinned_button: bool,
         show_battery: bool,
         show_volume: bool,
+        show_network: bool,
     ):
         super().__init__(class_name=class_name)  # type: ignore
         self.label_collapsed = label_collapsed
         self.label_expanded = label_expanded
         self.label_position = label_position if label_position in {"left", "right"} else "left"
         self.icon_size = icon_size
-        self.show_volume = show_volume
-        self.show_battery = show_battery
         self.show_unpinned = show_unpinned
+        self.show_unpinned_button = show_unpinned_button
 
         self.filtered_guids: set[UUID] = set()
-        if not self.show_battery:
+        if not show_battery:
             self.filtered_guids.add(BATTERY_ICON_GUID)
-        if not self.show_volume:
+        if not show_volume:
             self.filtered_guids.add(VOLUME_ICON_GUID)
+        if not show_network:
+            self.filtered_guids.add(NETWORK_GUID)
 
         IconWidget.icon_size = icon_size
         IconWidget.pin_modifier_key = {
@@ -128,6 +132,10 @@ def __init__(
         self.sort_timer.timeout.connect(self.sort_icons)  # type: ignore
         self.sort_timer.setSingleShot(True)
 
+        self.pinned_vis_check_timer = QTimer(self)
+        self.pinned_vis_check_timer.timeout.connect(self.update_pinned_widget_visibility)  # type: ignore
+        self.pinned_vis_check_timer.setSingleShot(True)
+
         self.unpinned_vis_btn = QPushButton()
         self.unpinned_vis_btn.setCheckable(True)
         self.unpinned_vis_btn.clicked.connect(self.toggle_unpinned_widget_visibility)  # type: ignore
@@ -157,6 +165,8 @@ def __init__(
         else:
             self.widget_layout.insertWidget(-1, self.unpinned_vis_btn)
 
+        self.unpinned_vis_btn.setVisible(self.show_unpinned_button)
+
         QTimer.singleShot(0, self.setup_client)  # pyright: ignore [reportUnknownMemberType]
 
     def setup_client(self):
@@ -182,7 +192,7 @@ def showEvent(self, a0: QShowEvent | None) -> None:
         super().showEvent(a0)
         self.unpinned_vis_btn.setChecked(self.show_unpinned)
         self.unpinned_vis_btn.setText(self.label_expanded if self.show_unpinned else self.label_collapsed)
-        self.unpinned_widget.setVisible(self.show_unpinned)
+        self.unpinned_widget.setVisible(self.show_unpinned or not self.show_unpinned_button)
 
     @pyqtSlot()
     def on_drag_started(self):
@@ -231,7 +241,7 @@ def on_icon_modified(self, data: IconData):
         self.update_icon_data(icon.data, data)
         icon.update_icon()
         icon.setHidden(data.uFlags & NIF_STATE != 0 and data.dwState == 1)
-        self.update_pinned_widget_visibility()
+        self.pinned_vis_check_timer.start(300)
 
     @pyqtSlot(IconData)
     def on_icon_deleted(self, data: IconData) -> None:
@@ -240,7 +250,7 @@ def on_icon_deleted(self, data: IconData) -> None:
         if icon is not None:
             self.icons.remove(icon)
             icon.deleteLater()
-            self.update_pinned_widget_visibility()
+            self.pinned_vis_check_timer.start(300)
 
     @pyqtSlot(object)
     def on_icon_pinned_changed(self, icon: IconWidget):
@@ -295,7 +305,7 @@ def check_icons(self):
                 icons_changed = True
 
         if icons_changed:
-            self.update_pinned_widget_visibility()
+            self.pinned_vis_check_timer.start(300)
 
     def update_icon_data(self, old_data: IconData | None, new_data: IconData):
         """Update the icon data with the new data received from the tray monitor"""