bec-widgets 0.98.0__tar.gz → 0.99.0__tar.gz

{bec_widgets-0.98.0 → bec_widgets-0.99.0}/CHANGELOG.md

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## v0.99.0 (2024-08-25)
+
+### Documentation
+
+* docs(darkmodebutton): added dark mode button docs ([`406c263`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/406c263746f0e809c1a4d98356c48f40428c23d7))
+
+### Feature
+
+* feat(darkmodebutton): added button to toggle between dark and light mode ([`cc8c166`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cc8c166b5c1d37e0f64c83801b2347a54a6550b6))
+
+### Fix
+
+* fix(toggle): emit state change ([`c4f3308`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c4f3308dc0c3e4b2064760ccd7372d71b3e49f96))
+
+### Refactor
+
+* refactor(darkmodebutton): renamed set_dark_mode_enabled to toggle_dark_mode ([`c70724a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c70724a456900bcb06b040407a2c5d497e49ce77))
+
+### Test
+
+* test(dark_mode_button): added tests for dark mode button ([`df35aab`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/df35aabff30c5d00b1c441132bd370446653741e))
+
 ## v0.98.0 (2024-08-25)
 
 ### Feature
@@ -149,5 +171,3 @@ Since we now rely on reusing the BECClient singleton, we need the fix introduced
 ### Fix
 
 * fix(rpc): use client singleton instead of dispatcher ([`ea9240d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ea9240d2f71931082f33fb6b68231469875c3d63))
-
-* fix: removed qcoreapplication for polling events ([`4d02b42`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4d02b42f11e9882b843317255a4975565c8a536f))

{bec_widgets-0.98.0 → bec_widgets-0.99.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.98.0
+Version: 0.99.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-0.98.0 → bec_widgets-0.99.0}/bec_widgets/cli/client.py

@@ -21,6 +21,7 @@ class Widgets(str, enum.Enum):
     BECQueue = "BECQueue"
     BECStatusBox = "BECStatusBox"
     BECWaveformWidget = "BECWaveformWidget"
+    DarkModeButton = "DarkModeButton"
     DeviceBrowser = "DeviceBrowser"
     DeviceComboBox = "DeviceComboBox"
     DeviceLineEdit = "DeviceLineEdit"
@@ -2289,6 +2290,15 @@ class BECWaveformWidget(RPCBase):
         """
 
 
+class DarkModeButton(RPCBase):
+    @rpc_call
+    def toggle_dark_mode(self) -> None:
+        """
+        Toggle the dark mode state. This will change the theme of the entire
+        application to dark or light mode.
+        """
+
+
 class DeviceBrowser(RPCBase):
     @property
     @rpc_call

bec_widgets-0.99.0/bec_widgets/widgets/dark_mode_button/dark_mode_button.py

@@ -0,0 +1,71 @@
+from bec_qthemes import material_icon
+from qtpy.QtCore import Property, Qt, Slot
+from qtpy.QtWidgets import QHBoxLayout, QPushButton, QWidget
+
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.colors import set_theme
+
+
+class DarkModeButton(BECWidget, QWidget):
+    USER_ACCESS = ["toggle_dark_mode"]
+
+    def __init__(
+        self, parent: QWidget | None = None, client=None, gui_id: str | None = None
+    ) -> None:
+        super().__init__(client=client, gui_id=gui_id)
+        QWidget.__init__(self, parent)
+
+        self._dark_mode_enabled = False
+        self.layout = QHBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+        self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
+
+        icon = material_icon("dark_mode", size=(20, 20), convert_to_pixmap=False)
+        self.mode_button = QPushButton(icon=icon)
+        self.update_mode_button()
+        self.mode_button.clicked.connect(self.toggle_dark_mode)
+        self.layout.addWidget(self.mode_button)
+        self.setLayout(self.layout)
+        self.setFixedSize(40, 40)
+
+    @Property(bool)
+    def dark_mode_enabled(self) -> bool:
+        """
+        The dark mode state. If True, dark mode is enabled. If False, light mode is enabled.
+        """
+        return self._dark_mode_enabled
+
+    @dark_mode_enabled.setter
+    def dark_mode_enabled(self, state: bool) -> None:
+        self._dark_mode_enabled = state
+
+    @Slot()
+    def toggle_dark_mode(self) -> None:
+        """
+        Toggle the dark mode state. This will change the theme of the entire
+        application to dark or light mode.
+        """
+        self.dark_mode_enabled = not self.dark_mode_enabled
+        self.update_mode_button()
+        set_theme("dark" if self.dark_mode_enabled else "light")
+
+    def update_mode_button(self):
+        icon = material_icon(
+            "light_mode" if self.dark_mode_enabled else "dark_mode",
+            size=(20, 20),
+            convert_to_pixmap=False,
+        )
+        self.mode_button.setIcon(icon)
+        self.mode_button.setToolTip("Set Light Mode" if self.dark_mode_enabled else "Set Dark Mode")
+
+
+if __name__ == "__main__":
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication([])
+
+    w = DarkModeButton()
+    w.show()
+
+    app.exec_()

bec_widgets-0.99.0/bec_widgets/widgets/dark_mode_button/dark_mode_button.pyproject

@@ -0,0 +1 @@
+{'files': ['dark_mode_button.py']}

bec_widgets-0.99.0/bec_widgets/widgets/dark_mode_button/dark_mode_button_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.dark_mode_button.dark_mode_button import DarkModeButton
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='DarkModeButton' name='dark_mode_button'>
+    </widget>
+</ui>
+"""
+
+
+class DarkModeButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = DarkModeButton(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        return designer_material_icon("dark_mode")
+
+    def includeFile(self):
+        return "dark_mode_button"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "DarkModeButton"
+
+    def toolTip(self):
+        return "Button to toggle between dark and light mode."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets-0.99.0/bec_widgets/widgets/dark_mode_button/register_dark_mode_button.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.dark_mode_button.dark_mode_button_plugin import DarkModeButtonPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(DarkModeButtonPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

{bec_widgets-0.98.0 → bec_widgets-0.99.0}/bec_widgets/widgets/toggle/toggle.py

@@ -1,6 +1,6 @@
 import sys
 
-from qtpy.QtCore import Property, QEasingCurve, QPointF, QPropertyAnimation, Qt
+from qtpy.QtCore import Property, QEasingCurve, QPointF, QPropertyAnimation, Qt, Signal
 from qtpy.QtGui import QColor, QPainter
 from qtpy.QtWidgets import QApplication, QWidget
 
@@ -10,6 +10,8 @@ class ToggleSwitch(QWidget):
     A simple toggle.
     """
 
+    enabled = Signal(bool)
+
     def __init__(self, parent=None):
         super().__init__(parent)
         self.setFixedSize(40, 21)
@@ -41,6 +43,7 @@ class ToggleSwitch(QWidget):
         self._checked = state
         self.update_colors()
         self.set_thumb_pos_to_state()
+        self.enabled.emit(self._checked)
 
     @Property(QPointF)
     def thumb_pos(self):
@@ -109,9 +112,7 @@ class ToggleSwitch(QWidget):
 
     def mousePressEvent(self, event):
         if event.button() == Qt.LeftButton:
-            self._checked = not self._checked
-            self.update_colors()
-            self.animate_thumb()
+            self.checked = not self.checked
 
     def update_colors(self):
 

{bec_widgets-0.98.0 → bec_widgets-0.99.0}/docs/user/widgets/buttons/buttons.md

@@ -14,6 +14,18 @@ The `Stop Button` is a specialized control that provides an immediate interface
 - **Immediate Termination**: Instantly halts the execution of the current script or process.
 - **Queue Management**: Clears any pending operations in the scan queue, ensuring the system is reset and ready for new tasks.
 
+## Dark Mode Button
+
+The `Dark Mode Button` is a toggle control that allows users to switch between light and dark themes in the BEC GUI. It provides a convenient way to adjust the interface's appearance based on user preferences or environmental conditions.
+
+```{figure} ./dark_mode_enabled.png
+```
+```{figure} ./dark_mode_disabled.png
+```
+
+**Key Features:**
+- **Theme Switching**: Enables users to switch between light and dark themes with a single click.
+- **Configurable from BECDesigner**: The defaults for the dark mode can be set in the BECDesigner, allowing users to customize the startup appearance of the GUI.
 ````
 
 ````{tab} Examples
@@ -46,5 +58,6 @@ my_gui.show()
 ````{tab} API
 ```{eval-rst} 
 .. include:: /api_reference/_autosummary/bec_widgets.cli.client.StopButton.rst
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.DarkModeButton.rst
 ```
 ````

{bec_widgets-0.98.0 → bec_widgets-0.99.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.98.0"
+version = "0.99.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [

bec_widgets-0.99.0/tests/unit_tests/test_dark_mode_button.py

@@ -0,0 +1,70 @@
+from unittest import mock
+
+import pytest
+from qtpy.QtCore import Qt
+
+from bec_widgets.widgets.dark_mode_button.dark_mode_button import DarkModeButton
+
+# pylint: disable=unused-import
+from .client_mocks import mocked_client
+
+# pylint: disable=redefined-outer-name
+
+
+@pytest.fixture
+def dark_mode_button(qtbot, mocked_client):
+    """
+    Fixture for the dark mode button.
+    """
+    button = DarkModeButton(client=mocked_client)
+    qtbot.addWidget(button)
+    qtbot.waitExposed(button)
+    yield button
+
+
+def test_dark_mode_button_init(dark_mode_button):
+    """
+    Test that the dark mode button is initialized correctly.
+    """
+    assert dark_mode_button.dark_mode_enabled is False
+    assert dark_mode_button.mode_button.toolTip() == "Set Dark Mode"
+
+
+def test_dark_mode_button_toggle(dark_mode_button):
+    """
+    Test that the dark mode button toggles correctly.
+    """
+    dark_mode_button.toggle_dark_mode()
+    assert dark_mode_button.dark_mode_enabled is True
+    assert dark_mode_button.mode_button.toolTip() == "Set Light Mode"
+
+    dark_mode_button.toggle_dark_mode()
+    assert dark_mode_button.dark_mode_enabled == False
+    assert dark_mode_button.mode_button.toolTip() == "Set Dark Mode"
+
+
+def test_dark_mode_button_toggles_on_click(dark_mode_button, qtbot):
+    """
+    Test that the dark mode button toggles correctly when clicked.
+    """
+    qtbot.mouseClick(dark_mode_button.mode_button, Qt.MouseButton.LeftButton)
+    assert dark_mode_button.dark_mode_enabled is True
+    assert dark_mode_button.mode_button.toolTip() == "Set Light Mode"
+
+    qtbot.mouseClick(dark_mode_button.mode_button, Qt.MouseButton.LeftButton)
+    assert dark_mode_button.dark_mode_enabled is False
+    assert dark_mode_button.mode_button.toolTip() == "Set Dark Mode"
+
+
+def test_dark_mode_button_changes_theme(dark_mode_button):
+    """
+    Test that the dark mode button changes the theme correctly.
+    """
+    with mock.patch(
+        "bec_widgets.widgets.dark_mode_button.dark_mode_button.set_theme"
+    ) as mocked_set_theme:
+        dark_mode_button.toggle_dark_mode()
+        mocked_set_theme.assert_called_with("dark")
+
+        dark_mode_button.toggle_dark_mode()
+        mocked_set_theme.assert_called_with("light")