bec-widgets 0.98.0__py3-none-any.whl → 0.99.1__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,33 @@
 # CHANGELOG
 
+## v0.99.1 (2024-08-27)
+
+### Fix
+
+* fix(crosshair): emit all crosshair events, not just line coordinates ([`2265458`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2265458dcc57970db18c62619f5877d542d72e81))
+
+## 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
@@ -125,29 +153,3 @@
 ### Test
 
 * test: added test for device browser ([`e870e5b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e870e5ba083c61df581c9c0305adabe72967f997))
-
-## v0.94.7 (2024-08-20)
-
-### Fix
-
-* fix: formatting of stdout, stderr captured text for logger ([`939f834`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/939f834a26ddbac0bdead0b60b1cdf52014f182f))
-
-## v0.94.6 (2024-08-14)
-
-### Fix
-
-* fix(server): emit heartbeat with state ([`bc2abe9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bc2abe945fb5adeec89ed5ac45e966db86ce6ffc))
-
-## v0.94.5 (2024-08-14)
-
-### Build
-
-* build: increased min version of bec to 2.21.4
-
-Since we now rely on reusing the BECClient singleton, we need the fix introduced with 2.21.4 in BEC. ([`4f96d0e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f96d0e4a14edc4b2839c1dddeda384737dc7a8a))
-
-### 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))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.98.0
+Version: 0.99.1
 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/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/utils/crosshair.py

@@ -9,6 +9,8 @@ from qtpy.QtCore import Signal as pyqtSignal
 
 
 class Crosshair(QObject):
+    positionChanged = pyqtSignal(tuple)
+    positionClicked = pyqtSignal(tuple)
     # Signal for 1D plot
     coordinatesChanged1D = pyqtSignal(tuple)
     coordinatesClicked1D = pyqtSignal(tuple)
@@ -164,6 +166,7 @@ class Crosshair(QObject):
         """
         pos = event[0]
         self.update_markers()
+        self.positionChanged.emit((pos.x(), pos.y()))
         if self.plot_item.vb.sceneBoundingRect().contains(pos):
             mouse_point = self.plot_item.vb.mapSceneToView(pos)
             self.v_line.setPos(mouse_point.x())
@@ -217,6 +220,7 @@ class Crosshair(QObject):
         if self.plot_item.vb.sceneBoundingRect().contains(event._scenePos):
             mouse_point = self.plot_item.vb.mapSceneToView(event._scenePos)
             x, y = mouse_point.x(), mouse_point.y()
+            self.positionClicked.emit((x, y))
 
             if self.is_log_x:
                 x = 10**x

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/widgets/dark_mode_button/dark_mode_button.pyproject

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

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/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/widgets/figure/plots/plot_base.py

@@ -56,6 +56,8 @@ class BECViewBox(pg.ViewBox):
 
 
 class BECPlotBase(BECConnector, pg.GraphicsLayout):
+    crosshair_position_changed = Signal(tuple)
+    crosshair_position_clicked = Signal(tuple)
     crosshair_coordinates_changed = Signal(tuple)
     crosshair_coordinates_clicked = Signal(tuple)
     USER_ACCESS = [
@@ -328,6 +330,8 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
         """Hook the crosshair to all plots."""
         if self.crosshair is None:
             self.crosshair = Crosshair(self.plot_item, precision=3)
+            self.crosshair.positionChanged.connect(self.crosshair_position_changed)
+            self.crosshair.positionClicked.connect(self.crosshair_position_clicked)
             self.crosshair.coordinatesChanged1D.connect(self.crosshair_coordinates_changed)
             self.crosshair.coordinatesClicked1D.connect(self.crosshair_coordinates_clicked)
             self.crosshair.coordinatesChanged2D.connect(self.crosshair_coordinates_changed)
@@ -336,6 +340,8 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     def unhook_crosshair(self) -> None:
         """Unhook the crosshair from all plots."""
         if self.crosshair is not None:
+            self.crosshair.positionChanged.disconnect(self.crosshair_position_changed)
+            self.crosshair.positionClicked.disconnect(self.crosshair_position_clicked)
             self.crosshair.coordinatesChanged1D.disconnect(self.crosshair_coordinates_changed)
             self.crosshair.coordinatesClicked1D.disconnect(self.crosshair_coordinates_clicked)
             self.crosshair.coordinatesChanged2D.disconnect(self.crosshair_coordinates_changed)

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/widgets/waveform/waveform_widget.py

@@ -58,8 +58,14 @@ class BECWaveformWidget(BECWidget, QWidget):
     dap_summary_update = Signal(dict)
     autorange_signal = Signal()
     new_scan = Signal()
+    crosshair_position_changed = Signal(tuple)
+    crosshair_position_changed_string = Signal(str)
+    crosshair_position_clicked = Signal(tuple)
+    crosshair_position_clicked_string = Signal(str)
     crosshair_coordinates_changed = Signal(tuple)
+    crosshair_coordinates_changed_string = Signal(str)
     crosshair_coordinates_clicked = Signal(tuple)
+    crosshair_coordinates_clicked_string = Signal(str)
 
     def __init__(
         self,
@@ -136,6 +142,20 @@ class BECWaveformWidget(BECWidget, QWidget):
         self.waveform.new_scan.connect(self.new_scan)
         self.waveform.crosshair_coordinates_changed.connect(self.crosshair_coordinates_changed)
         self.waveform.crosshair_coordinates_clicked.connect(self.crosshair_coordinates_clicked)
+        self.waveform.crosshair_coordinates_changed.connect(
+            self._emit_crosshair_coordinates_changed_string
+        )
+        self.waveform.crosshair_coordinates_clicked.connect(
+            self._emit_crosshair_coordinates_clicked_string
+        )
+        self.waveform.crosshair_position_changed.connect(self.crosshair_position_changed)
+        self.waveform.crosshair_position_clicked.connect(self.crosshair_position_clicked)
+        self.waveform.crosshair_position_changed.connect(
+            self._emit_crosshair_position_changed_string
+        )
+        self.waveform.crosshair_position_clicked.connect(
+            self._emit_crosshair_position_clicked_string
+        )
 
     def _hook_actions(self):
         self.toolbar.widgets["save"].action.triggered.connect(self.export)
@@ -156,6 +176,22 @@ class BECWaveformWidget(BECWidget, QWidget):
         #     lambda: self.save_config(path=None, gui=True)
         # )
 
+    @SafeSlot(tuple)
+    def _emit_crosshair_coordinates_changed_string(self, coordinates):
+        self.crosshair_coordinates_changed_string.emit(str(coordinates))
+
+    @SafeSlot(tuple)
+    def _emit_crosshair_coordinates_clicked_string(self, coordinates):
+        self.crosshair_coordinates_clicked_string.emit(str(coordinates))
+
+    @SafeSlot(tuple)
+    def _emit_crosshair_position_changed_string(self, position):
+        self.crosshair_position_changed_string.emit(str(position))
+
+    @SafeSlot(tuple)
+    def _emit_crosshair_position_clicked_string(self, position):
+        self.crosshair_position_clicked_string.emit(str(position))
+
     ###################################
     # Dialog Windows
     ###################################

{bec_widgets-0.98.0.dist-info → bec_widgets-0.99.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.98.0
+Version: 0.99.1
 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.dist-info → bec_widgets-0.99.1.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=9dZ_EvimZrDzG8MtII0qtBYMM_Nc6xqh2iFRds0rlvE,8370
 .pylintrc,sha256=eeY8YwSI74oFfq6IYIbCqnx3Vk8ZncKaatv96n_Y8Rs,18544
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=gjQfqaLDuPUnF3DFFQqOFpYcJNBi7cVD6D_-knI9F2k,6839
+CHANGELOG.md,sha256=TrmYDiypc90eYaa-faQzSvVKyS3bZt1pBLSqIpUqDeU,6964
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=IAkC6nhPjMKZoERtnUZtDsEU4stXZjICC1FDwQuyuoM,1325
+PKG-INFO,sha256=MVPi_Ok7cGpSqZHITDtcZCuEBiWaMs7LXnzOk1olL-o,1325
 README.md,sha256=Od69x-RS85Hph0-WwWACwal4yUd67XkEn4APEfHhHFw,2649
-pyproject.toml,sha256=61TgaqglyIMXu3W2TMVVhZwG5g2bN4ShiDCSw16LnTE,2416
+pyproject.toml,sha256=yN4Aw4TTp4pjQtn1s3UdvUKePIwRCP8wfcqGakRG7Rs,2416
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
@@ -61,7 +61,7 @@ bec_widgets/assets/toolbar_icons/transform.svg,sha256=Fgug9wCi1FONy08nssEvnoDDDB
 bec_widgets/assets/toolbar_icons/waveform.svg,sha256=darXWaIww4HEu9skFUd8Vs1NSAgUo1d37xBNr6DX-bM,231
 bec_widgets/cli/__init__.py,sha256=d0Q6Fn44e7wFfLabDOBxpcJ1DPKWlFunGYDUBmO-4hA,22
 bec_widgets/cli/auto_updates.py,sha256=DwzRChcFIWPH2kCYvp8H7dXvyYSKGYv6LwCmK2sDR2E,5676
-bec_widgets/cli/client.py,sha256=sqWc80V5RZH3gJdQQnGSDY3LR3ypox8orOkDE1PuI7Q,76650
+bec_widgets/cli/client.py,sha256=e9BWeliuC7__cNTBTWhiKZNK4SD3b8LPptILjNAu7mY,76919
 bec_widgets/cli/client_utils.py,sha256=l35LtTkD7PdvVCckjMU8-y6f5a5pp1u6cFPpD-Dkvow,11713
 bec_widgets/cli/generate_cli.py,sha256=Ea5px9KblUlcGg-1JbJBTIU7laGg2n8PM7Efw9WVVzM,5889
 bec_widgets/cli/rpc_register.py,sha256=QxXUZu5XNg00Yf5O3UHWOXg3-f_pzKjjoZYMOa-MOJc,2216
@@ -94,7 +94,7 @@ bec_widgets/utils/bec_table.py,sha256=nA2b8ukSeUfquFMAxGrUVOqdrzMoDYD6O_4EYbOG2z
 bec_widgets/utils/bec_widget.py,sha256=Bo2v1aP7rgSAQajW8GBJbI3iovTn_hGCsmeFMo7bT10,707
 bec_widgets/utils/colors.py,sha256=2lQZFfmin0YBJVrMH_81wSUPpmFz235_NYHpNRFlrbk,11383
 bec_widgets/utils/container_utils.py,sha256=0wr3ZfuMiAFKCrQHVjxjw-Vuk8wsHdridqcjy2eY840,1531
-bec_widgets/utils/crosshair.py,sha256=ywj4Pr2Xx8tFsD5qrHIocanKlNqDd51ElbEfxenuYM0,11363
+bec_widgets/utils/crosshair.py,sha256=8lik9k69WI2WMj5FGLbrKtny9duxqXUJAhpX8tHoyp0,11543
 bec_widgets/utils/entry_validator.py,sha256=3skJIsUwTYicT76AMHm_M78RiWtUgyD2zb-Rxo2HdHQ,1313
 bec_widgets/utils/generate_designer_plugin.py,sha256=eidqauS8YLgoxkPntPL0oSG_lYqI2D7fSyOZvOtCU_U,5891
 bec_widgets/utils/layout_manager.py,sha256=H0nKsIMaPxRkof1MEXlSmW6w1dFxA6astaGzf4stI84,4727
@@ -133,6 +133,11 @@ bec_widgets/widgets/colormap_selector/colormap_selector.pyproject,sha256=lHl9qml
 bec_widgets/widgets/colormap_selector/colormap_selector_plugin.py,sha256=3DjuT36quiMOfLwpCzVxRlV6KhkUr6AMjh73HDIGm6w,1371
 bec_widgets/widgets/colormap_selector/register_colormap_selector.py,sha256=bfw7RWmTmMLTLxGT-izSwcGtxGLKvL3jdivJw2z8oN4,512
 bec_widgets/widgets/console/console.py,sha256=NG0cBuqqPX4hC-sHhk_UEkT-nHhhN9Y7karJITPLzyo,17864
+bec_widgets/widgets/dark_mode_button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_widgets/widgets/dark_mode_button/dark_mode_button.py,sha256=G6Q9pfThp8cWMzCYrKfrZa-26-qBG-SDZFj-ezXRyGc,2319
+bec_widgets/widgets/dark_mode_button/dark_mode_button.pyproject,sha256=Lbi9zb6HNlIq14k6hlzR-oz6PIFShBuF7QxE6d87d64,34
+bec_widgets/widgets/dark_mode_button/dark_mode_button_plugin.py,sha256=rvoXxVkmEa5QKzPIAjZ1_7CLdHmHuCdGHiJGrkIzZz8,1322
+bec_widgets/widgets/dark_mode_button/register_dark_mode_button.py,sha256=_4Fw6j1KLuluko8X2B7zf_DT5eA07G0CqR-aRMAn0iA,489
 bec_widgets/widgets/device_browser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/device_browser/device_browser.py,sha256=PRpgXuAUc6dCWXddp7m_dxUE9VA6AuSzCJ8t3TYng1w,3517
 bec_widgets/widgets/device_browser/device_browser.pyproject,sha256=s0vM1xYUwyU6Je68_hSCSBLK8ZPfHB-ftt4flfdpkXY,32
@@ -162,7 +167,7 @@ bec_widgets/widgets/figure/figure.py,sha256=ArJ_fN6xvqzuK8p6YQJfMJwSTh-Rvk69TKIg
 bec_widgets/widgets/figure/plots/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/figure/plots/axis_settings.py,sha256=QxRpQwgfBr1H0HTjfOpiXi_-n8I0BaZhS8LRXNeVfFg,3544
 bec_widgets/widgets/figure/plots/axis_settings.ui,sha256=a2qIuK9lyi9HCyrSvPr6wxzmm1FymaWcpmyOhMIiFt8,11013
-bec_widgets/widgets/figure/plots/plot_base.py,sha256=30KsfR6SlbeuV_t96kILcPU17vf_qMHajlvFwfBvN2Y,13593
+bec_widgets/widgets/figure/plots/plot_base.py,sha256=RLQeize3X02rzp5DyBzvQI7SdA4DiEuFH-Dzij1mohg,14029
 bec_widgets/widgets/figure/plots/image/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/figure/plots/image/image.py,sha256=y2MqgJv6Njv-huDN_exn0Fq1rAh5vs_assKCKHgQH6I,24941
 bec_widgets/widgets/figure/plots/image/image_item.py,sha256=RljjbkqJEr2cKDlqj1j5GQ1h89jpqOV-OpFz1TbED8I,10937
@@ -232,7 +237,7 @@ bec_widgets/widgets/text_box/text_box.pyproject,sha256=XohO1BIe2hrpU-z_KHKRgjcUk
 bec_widgets/widgets/text_box/text_box_plugin.py,sha256=UAbDbSgI3s2FniFSrNFe_VVTc3VzEphOS3lI9mRPwmY,1291
 bec_widgets/widgets/toggle/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/toggle/register_toggle_switch.py,sha256=8pVtkeEeiDOjV4OPoZq1I30F9JDzl4nQE7e7xoWyWBs,472
-bec_widgets/widgets/toggle/toggle.py,sha256=JzCGYoyHBrlBWCoyL94QX4zSLyEwWbCNHMegjlnSy2E,4442
+bec_widgets/widgets/toggle/toggle.py,sha256=xW5WAtjzzRgTpHsyoRSTVoiaKcX8vxsbbDd_J46EJYM,4451
 bec_widgets/widgets/toggle/toggle_switch.pyproject,sha256=Msa-AS5H5XlqW65r8GlX2AxD8FnFnDyDgGnbKcXqKOw,24
 bec_widgets/widgets/toggle/toggle_switch_plugin.py,sha256=NSrk8KkolyOOxkliTwqz2n_l7jNPTjSFfcc9iCuzkiU,1333
 bec_widgets/widgets/vscode/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -244,7 +249,7 @@ bec_widgets/widgets/waveform/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NM
 bec_widgets/widgets/waveform/bec_waveform_widget.pyproject,sha256=GLD8GN9dXx9wNbtnevrxqqcwk7vKV-Uv8QYSycdaoaI,33
 bec_widgets/widgets/waveform/bec_waveform_widget_plugin.py,sha256=Qt8E5nvk6f5JYwOqVn5UkbIW_JqsXkIMdv3CM41gXsU,1387
 bec_widgets/widgets/waveform/register_bec_waveform_widget.py,sha256=qZHVZH_lP2hvzkG1Ra0EyrXlMeLkRCy0aceH-bfJ1cs,490
-bec_widgets/widgets/waveform/waveform_widget.py,sha256=7oOLIIQbx1Oam89cjtAidRU1QFLphTk-ALSRbiessrY,20512
+bec_widgets/widgets/waveform/waveform_widget.py,sha256=LD5nx6Z2wxiaMK7ukrFzwJDojrkj3pn_oG2eZqguulE,22152
 bec_widgets/widgets/waveform/waveform_popups/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/waveform/waveform_popups/curve_dialog/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/waveform/waveform_popups/curve_dialog/curve_dialog.py,sha256=5e2BrKA97cfZCM04x7-S3z6sby82KKnUH1S0gVQUfLU,13090
@@ -315,7 +320,9 @@ docs/user/widgets/bec_figure/BECFigure.png,sha256=8dQr4u0uk_y0VV-R1Jh9yTR3Vidd9H
 docs/user/widgets/bec_figure/bec_figure.md,sha256=_HDsRXf45N8NDwfHt4HqI3uDMr5Tx_A6RB7yY9m1l8c,6023
 docs/user/widgets/bec_status_box/bec_status_box.gif,sha256=kLxf40HbS6fjdUIQ2b9SiduBEXdBd4DDWGEnQDOFMcY,1259044
 docs/user/widgets/bec_status_box/bec_status_box.md,sha256=e23y7DYg63IwFFInDozDslh9BdYvbWY3NGiwv6_Fc3Q,2056
-docs/user/widgets/buttons/buttons.md,sha256=WVeRcOPCk9a28lbJ-25Eqd7U6uNL_YXYGl4WddOUwkc,1974
+docs/user/widgets/buttons/buttons.md,sha256=1VgkVl2o5ERKjuPJFOZtxvpY-wDLR7P19-lJzQwBFQM,2677
+docs/user/widgets/buttons/dark_mode_disabled.png,sha256=eSLZLGcKCS3uQ4NDhJaUYr9gL56CnPblJvRvEPG6h-g,5156
+docs/user/widgets/buttons/dark_mode_enabled.png,sha256=hf4u_AeR4Gri1F87_7lcRt7Q3QnJ42f5g2vN7QkfFGA,4121
 docs/user/widgets/device_browser/device_browser.md,sha256=kzZrS3aoWbmUUPygjGNuXJ7_qqD35WJN-HwQHx5hpmI,1102
 docs/user/widgets/device_browser/device_browser.png,sha256=85clca-gpCyxTL-SOS8hmgDmjbZ5i-0ZmOVA6vBZBUA,46429
 docs/user/widgets/device_input/device_input.md,sha256=5zkBeCX_I8TBM0rHi2WHgqrM0k64VoC87vhIWyo3Isc,3878
@@ -368,6 +375,7 @@ tests/unit_tests/test_client_utils.py,sha256=CBdWIVJ_UiyFzTJnX3XJm4PGw2uXhFvRCP_
 tests/unit_tests/test_color_map_selector.py,sha256=dTsizpT7TUpX2AEWIc0v09KPOryhWepFXFI9duQ3NF8,1497
 tests/unit_tests/test_color_validation.py,sha256=xbFbtFDia36XLgaNrX2IwvAX3IDC_Odpj5BGoJSgiIE,2389
 tests/unit_tests/test_crosshair.py,sha256=POB9EFCO9gCCAEHgddiyQV28C4rMxIosHX0aR-zr8gg,4595
+tests/unit_tests/test_dark_mode_button.py,sha256=GcfdRZuk7iovw1-EYIG6bTBf2B13eFdzPvzYV5bA__c,2226
 tests/unit_tests/test_device_browser.py,sha256=LOvvUFepNcoQptX7d6oUoomfg5nyjjdCMJ2iHviF9aQ,2948
 tests/unit_tests/test_device_input_base.py,sha256=LY-3adMb2xM9pBiP6V2bAJF_65csCe2Xfaq5ArVEE1E,2859
 tests/unit_tests/test_device_input_widgets.py,sha256=Y3mc_EaeQAPxpj6DijvxLLyMPSxnaNN86KhIL4ASO3E,5821
@@ -400,8 +408,8 @@ tests/unit_tests/test_configs/config_device_no_entry.yaml,sha256=hdvue9KLc_kfNzG
 tests/unit_tests/test_configs/config_scan.yaml,sha256=vo484BbWOjA_e-h6bTjSV9k7QaQHrlAvx-z8wtY-P4E,1915
 tests/unit_tests/test_msgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit_tests/test_msgs/available_scans_message.py,sha256=m_z97hIrjHXXMa2Ex-UvsPmTxOYXfjxyJaGkIY6StTY,46532
-bec_widgets-0.98.0.dist-info/METADATA,sha256=IAkC6nhPjMKZoERtnUZtDsEU4stXZjICC1FDwQuyuoM,1325
-bec_widgets-0.98.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bec_widgets-0.98.0.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
-bec_widgets-0.98.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.98.0.dist-info/RECORD,,
+bec_widgets-0.99.1.dist-info/METADATA,sha256=MVPi_Ok7cGpSqZHITDtcZCuEBiWaMs7LXnzOk1olL-o,1325
+bec_widgets-0.99.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bec_widgets-0.99.1.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
+bec_widgets-0.99.1.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.99.1.dist-info/RECORD,,

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
 ```
 ````

pyproject.toml

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

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")