bec-widgets 0.96.2__py3-none-any.whl → 0.97.0__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,25 @@
 # CHANGELOG
 
+## v0.97.0 (2024-08-23)
+
+### Feature
+
+* feat(designer): added designer icon factory ([`82a55dd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/82a55ddf3eafb589cb63408db1c0e7e5c9d629da))
+
+### Fix
+
+* fix(toolbar icon): fixed material icon toolbar for theme changes ([`3ecbd60`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3ecbd60627994417c9175364e5909710dbcdceb2))
+
+## v0.96.3 (2024-08-23)
+
+### Documentation
+
+* docs(dispatcher): docs added ([`dd7c71b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/dd7c71bb1e0b7ef5398b1e1a05fc1147c772420a))
+
+### Fix
+
+* fix: minor fixes for type annotations ([`8c2e7c8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8c2e7c82592ace50e4e1f47e392a0ddc988f57ae))
+
 ## v0.96.2 (2024-08-22)
 
 ### Fix
@@ -137,23 +157,3 @@ Terminating client connections has to be done at the application level ([`198c1d
 * fix(image): image is single image mode do not raise popup error when connected twice with the same monitor ([`98b79aa`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/98b79aac7b47b73137f4d582f7f1d552b1d95366))
 
 ## v0.94.1 (2024-08-12)
-
-### Fix
-
-* fix: issue #292, wrong key was used to clean _slots internal dictionary ([`93d3977`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/93d397759c756397604ebff5e24f3a580be8620d))
-
-## v0.94.0 (2024-08-08)
-
-### Feature
-
-* feat: add PositionerControlLine ([`c80a7cd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c80a7cd1083baa9543a2cee2e3c3a51dfd209b19))
-
-### Refactor
-
-* refactor: adjust dimensions ([`0273bf4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0273bf485694609325b5b556a3c69fb53c18446e))
-
-## v0.93.5 (2024-08-08)
-
-### Fix
-
-* fix(positioner_box): icons fixed ([`281633d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/281633deff15b6879dac3a4f0770fa6949aaecdc))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.96.2
+Version: 0.97.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/examples/plugin_example_pyside/tictactoeplugin.py

@@ -2,13 +2,12 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
 from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
 from bec_widgets.examples.plugin_example_pyside.tictactoetaskmenu import TicTacToeTaskMenuFactory
+from bec_widgets.utils.bec_designer import designer_material_icon
 
 DOM_XML = """
 <ui language='c++'>
@@ -47,9 +46,7 @@ class TicTacToePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "Games"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("sports_esports", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("sports_esports")
 
     def includeFile(self):
         return "tictactoe"

bec_widgets/qt_utils/toolbar.py

@@ -3,9 +3,9 @@ import os
 from abc import ABC, abstractmethod
 from collections import defaultdict
 
-from bec_qthemes import material_icon
+from bec_qthemes._icon.material_icons import material_icon
 from qtpy.QtCore import QSize
-from qtpy.QtGui import QAction, QGuiApplication, QIcon
+from qtpy.QtGui import QAction, QIcon
 from qtpy.QtWidgets import QHBoxLayout, QLabel, QMenu, QToolBar, QToolButton, QWidget
 
 import bec_widgets
@@ -73,7 +73,7 @@ class IconAction(ToolBarAction):
 
 class MaterialIconAction:
     """
-    Abstract base class for toolbar actions.
+    Action with a Material icon for the toolbar.
 
     Args:
         icon_path (str, optional): The name of the icon file from `assets/toolbar_icons`. Defaults to None.
@@ -88,12 +88,16 @@ class MaterialIconAction:
         self.action = None
 
     def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
-        palette = QGuiApplication.palette()
-        color = "#FFFFFF"  # FIXME: This should be a theme color but the toolbar doesn't respect the theme atm
-        # one fixed, change it to palette.toolTipBase().color()
-
-        icon = material_icon(self.icon_name, size=(20, 20), color=color)
-        self.action = QAction(QIcon(icon), self.tooltip, target)
+        color = {
+            "dark": "#FFFFFF",
+            "light": "#000000",
+        }  # FIXME: This should be a theme color but the toolbar doesn't respect the theme atm
+        # once fixed, change it to
+        # palette = QGuiApplication.palette()
+        # palette.toolTipBase().color()
+
+        icon = material_icon(self.icon_name, size=(20, 20), color=color, convert_to_pixmap=False)
+        self.action = QAction(icon, self.tooltip, target)
         self.action.setCheckable(self.checkable)
         toolbar.addAction(self.action)
 

bec_widgets/utils/bec_designer.py

@@ -6,7 +6,9 @@ import sys
 import sysconfig
 from pathlib import Path
 
+from bec_qthemes import material_icon
 from qtpy import PYSIDE6
+from qtpy.QtGui import QIcon
 
 if PYSIDE6:
     from PySide6.scripts.pyside_tool import (
@@ -21,6 +23,19 @@ if PYSIDE6:
 import bec_widgets
 
 
+def designer_material_icon(icon_name: str) -> QIcon:
+    """
+    Create a QIcon for the BECDesigner with the given material icon name.
+
+    Args:
+        icon_name (str): The name of the material icon.
+
+    Returns:
+        QIcon: The QIcon for the material icon.
+    """
+    return QIcon(material_icon(icon_name, filled=True, convert_to_pixmap=True))
+
+
 def list_editable_packages() -> set[str]:
     """
     List all editable packages in the environment.

bec_widgets/utils/bec_dispatcher.py

@@ -125,7 +125,7 @@ class BECDispatcher:
         topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]],
         **kwargs,
     ) -> None:
-        """Connect widget's pyqt slot, so that it is called on new pub/sub topic message.
+        """Connect widget's qt slot, so that it is called on new pub/sub topic message.
 
         Args:
             slot (Callable): A slot method/function that accepts two inputs: content and metadata of
@@ -138,6 +138,13 @@ class BECDispatcher:
         self._slots[slot].update(set(topics_str))
 
     def disconnect_slot(self, slot: Callable, topics: Union[str, list]):
+        """
+        Disconnect a slot from a topic.
+
+        Args:
+            slot(Callable): The slot to disconnect
+            topics(Union[str, list]): The topic(s) to disconnect from
+        """
         # find the right slot to disconnect from ;
         # slot callbacks are wrapped in QtThreadSafeCallback objects,
         # but the slot we receive here is the original callable
@@ -153,6 +160,12 @@ class BECDispatcher:
             del self._slots[connected_slot]
 
     def disconnect_topics(self, topics: Union[str, list]):
+        """
+        Disconnect all slots from a topic.
+
+        Args:
+            topics(Union[str, list]): The topic(s) to disconnect from
+        """
         self.client.connector.unregister(topics)
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
         for slot in list(self._slots.keys()):
@@ -162,4 +175,11 @@ class BECDispatcher:
                 del self._slots[slot]
 
     def disconnect_all(self, *args, **kwargs):
+        """
+        Disconnect all slots from all topics.
+
+        Args:
+            *args: Arbitrary positional arguments
+            **kwargs: Arbitrary keyword arguments
+        """
         self.disconnect_topics(self.client.connector._topics_cb)

bec_widgets/utils/container_utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import itertools
 from typing import Type
 

bec_widgets/widgets/bec_queue/bec_queue.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from bec_lib.endpoints import MessageEndpoints
 from qtpy.QtCore import Qt, Slot
 from qtpy.QtWidgets import QHBoxLayout, QHeaderView, QTableWidget, QTableWidgetItem, QWidget

bec_widgets/widgets/bec_queue/bec_queue_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.bec_queue.bec_queue import BECQueue
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class BECQueuePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Services"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("edit_note", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("edit_note")
 
     def includeFile(self):
         return "bec_queue"

bec_widgets/widgets/bec_status_box/bec_status_box_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.bec_status_box.bec_status_box import BECStatusBox
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class BECStatusBoxPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Services"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("dns", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("dns")
 
     def includeFile(self):
         return "bec_status_box"

bec_widgets/widgets/color_button/color_button_plugin.py

@@ -1,10 +1,9 @@
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.color_button.color_button import ColorButton
 
 DOM_XML = """
@@ -32,9 +31,7 @@ class ColorButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Buttons"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("colors", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("colors")
 
     def includeFile(self):
         return "color_button"

bec_widgets/widgets/colormap_selector/colormap_selector_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.colormap_selector.colormap_selector import ColormapSelector
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class ColormapSelectorPlugin(QDesignerCustomWidgetInterface):  # pragma: no cove
         return "BEC Buttons"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("palette", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("palette")
 
     def includeFile(self):
         return "colormap_selector"

bec_widgets/widgets/device_browser/device_browser_plugin.py

@@ -1,10 +1,9 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.device_browser.device_browser import DeviceBrowser
 
 DOM_XML = """
@@ -31,9 +30,7 @@ class DeviceBrowserPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Services"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("lists", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("lists")
 
     def includeFile(self):
         return "device_browser"

bec_widgets/widgets/device_combobox/device_combo_box_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.device_combobox.device_combobox import DeviceComboBox
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class DeviceComboBoxPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "Device Control"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("list_alt", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("list_alt")
 
     def includeFile(self):
         return "device_combobox"

bec_widgets/widgets/device_line_edit/device_line_edit_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.device_line_edit.device_line_edit import DeviceLineEdit
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class DeviceLineEditPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "Device Control"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("edit_note", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("edit_note")
 
     def includeFile(self):
         return "device_line_edit"

bec_widgets/widgets/dock/dock_area_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.dock import BECDockArea
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class BECDockAreaPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Plots"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("widgets", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("widgets")
 
     def includeFile(self):
         return "dock_area"

bec_widgets/widgets/image/bec_image_widget_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.image.image_widget import BECImageWidget
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class BECImageWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Plots"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("image", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("image")
 
     def includeFile(self):
         return "bec_image_widget"

bec_widgets/widgets/motor_map/bec_motor_map_widget_plugin.py

@@ -1,10 +1,9 @@
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.motor_map.motor_map_widget import BECMotorMapWidget
 
 DOM_XML = """
@@ -33,9 +32,7 @@ class BECMotorMapWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cov
         return "BEC Plots"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("my_location", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("my_location")
 
     def includeFile(self):
         return "bec_motor_map_widget"

bec_widgets/widgets/position_indicator/position_indicator_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.position_indicator.position_indicator import PositionIndicator
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class PositionIndicatorPlugin(QDesignerCustomWidgetInterface):  # pragma: no cov
         return "BEC Utils"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("horizontal_distribute", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("horizontal_distribute")
 
     def includeFile(self):
         return "position_indicator"

bec_widgets/widgets/positioner_box/positioner_box_plugin.py

@@ -3,10 +3,9 @@
 
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.positioner_box.positioner_box import PositionerBox
 
 DOM_XML = """
@@ -34,9 +33,7 @@ class PositionerBoxPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "Device Control"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("switch_right", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("switch_right")
 
     def includeFile(self):
         return "positioner_box"

bec_widgets/widgets/positioner_box/positioner_control_line_plugin.py

@@ -3,10 +3,9 @@
 
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.positioner_box.positioner_control_line import PositionerControlLine
 
 DOM_XML = """
@@ -34,9 +33,7 @@ class PositionerControlLinePlugin(QDesignerCustomWidgetInterface):  # pragma: no
         return "Device Control"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("switch_left", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("switch_left")
 
     def includeFile(self):
         return "positioner_control_line"

bec_widgets/widgets/ring_progress_bar/ring_progress_bar_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.ring_progress_bar.ring_progress_bar import RingProgressBar
 
 DOM_XML = """
@@ -34,9 +33,7 @@ class RingProgressBarPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Utils"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("track_changes", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("track_changes")
 
     def includeFile(self):
         return "ring_progress_bar"

bec_widgets/widgets/scan_control/scan_control_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.scan_control.scan_control import ScanControl
 
 DOM_XML = """
@@ -34,9 +33,7 @@ class ScanControlPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "Device Control"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("stacked_line_chart", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("stacked_line_chart")
 
     def includeFile(self):
         return "scan_control"

bec_widgets/widgets/spinner/spinner_widget_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.spinner.spinner import SpinnerWidget
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class SpinnerWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Utils"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("progress_activity", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("progress_activity")
 
     def includeFile(self):
         return "spinner_widget"

bec_widgets/widgets/stop_button/stop_button_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.stop_button.stop_button import StopButton
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class StopButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Utils"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("dangerous", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("dangerous")
 
     def includeFile(self):
         return "stop_button"

bec_widgets/widgets/text_box/text_box_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.text_box.text_box import TextBox
 
 DOM_XML = """
@@ -34,9 +33,7 @@ class TextBoxPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Utils"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("chat", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("chat")
 
     def includeFile(self):
         return "text_box"

bec_widgets/widgets/toggle/toggle_switch_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.toggle.toggle import ToggleSwitch
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class ToggleSwitchPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Utils"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("toggle_on", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("toggle_on")
 
     def includeFile(self):
         return "toggle_switch"

bec_widgets/widgets/vscode/vs_code_editor_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.vscode.vscode import VSCodeEditor
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class VSCodeEditorPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Developer"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("developer_mode_tv", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("developer_mode_tv")
 
     def includeFile(self):
         return "vs_code_editor"

bec_widgets/widgets/waveform/bec_waveform_widget_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.waveform.waveform_widget import BECWaveformWidget
 
 DOM_XML = """
@@ -35,9 +34,7 @@ class BECWaveformWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cov
         return "BEC Plots"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("show_chart", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("show_chart")
 
     def includeFile(self):
         return "bec_waveform_widget"

bec_widgets/widgets/website/website_widget_plugin.py

@@ -2,11 +2,10 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 import os
 
-from bec_qthemes import material_icon
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QGuiApplication, QIcon
 
 import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.website.website import WebsiteWidget
 
 DOM_XML = """
@@ -34,9 +33,7 @@ class WebsiteWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BEC Utils"
 
     def icon(self):
-        palette = QGuiApplication.palette()
-        pixmap = material_icon("travel_explore", color=palette.text().color(), filled=True)
-        return QIcon(pixmap)
+        return designer_material_icon("travel_explore")
 
     def includeFile(self):
         return "website_widget"

{bec_widgets-0.96.2.dist-info → bec_widgets-0.97.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.96.2
+Version: 0.97.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.96.2.dist-info → bec_widgets-0.97.0.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=JevFb8k7ihFuKfooyCqcyptPCHkn6vBmWWLI6YOyNHg,6717
+CHANGELOG.md,sha256=F5JNzWDV1tskuAnkR8S2x6KB1FPs-J2JUqZeBs7e00g,6733
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=xRvEZ02kp6ROhkDYvw-jCEJA0QqyjeTRUHYJnbgxgXY,1325
+PKG-INFO,sha256=UkwD-_52GWkQgNpQnMa-cDG4Q_h3sMM1jqGYrM4Kjy8,1325
 README.md,sha256=Od69x-RS85Hph0-WwWACwal4yUd67XkEn4APEfHhHFw,2649
-pyproject.toml,sha256=S3RcibQIzFA7_Ydzi3rai8TL0k5643CILs3-IMEJ_8s,2416
+pyproject.toml,sha256=5LVT8PiePyXQ2W_r2fJjtBUzN7BRL233-0tjvBG_b_A,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
@@ -79,21 +79,21 @@ bec_widgets/examples/plugin_example_pyside/main.py,sha256=zDP5wO7wb3BVsQ15HOCRT1
 bec_widgets/examples/plugin_example_pyside/registertictactoe.py,sha256=cVhBnP0qx5j9Jft-VeKvlTFE-bX58hbP45CX0f4r5pM,535
 bec_widgets/examples/plugin_example_pyside/taskmenuextension.pyproject,sha256=O_PSMFJlXxQuf55gIOfkpfZIZGpX8W1SfUVZ-mvtI_E,119
 bec_widgets/examples/plugin_example_pyside/tictactoe.py,sha256=byR7mTiIXFaA9igPTH04pzm0yfikNB5KgISwvNiRPd8,4940
-bec_widgets/examples/plugin_example_pyside/tictactoeplugin.py,sha256=daEn01EIpYrv0tfR7wgOHaZNfhx_ExNQf9ToCMbvVdQ,2105
+bec_widgets/examples/plugin_example_pyside/tictactoeplugin.py,sha256=MFMwONn4EZ3V8DboEG4I3BXpURE9JDbKB7XTzzfZl5w,1978
 bec_widgets/examples/plugin_example_pyside/tictactoetaskmenu.py,sha256=V6OVnBTS-60zjQ2FAs88Ldjm1MfoMROfiQZZu6Guav8,2379
 bec_widgets/qt_utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/qt_utils/error_popups.py,sha256=y9gKKWaafp468ioHr96nBhf02ZpEgjDc-BAVOTWh-e8,7680
 bec_widgets/qt_utils/redis_message_waiter.py,sha256=fvL_QgC0cTDv_FPJdRyp5AKjf401EJU4z3r38p47ydY,1745
 bec_widgets/qt_utils/settings_dialog.py,sha256=NhtzTer_xzlB2lLLrGklkI1QYLJEWQpJoZbCz4o5daI,3645
-bec_widgets/qt_utils/toolbar.py,sha256=A5vXNlF7kxvdcPCmRvsy9P3f6M5NomlT2PgtUmnt94U,7669
+bec_widgets/qt_utils/toolbar.py,sha256=3gmwASDgZiE6SFI9dK3VE-dT4LMqwb68laowF7_rv3o,7773
 bec_widgets/utils/__init__.py,sha256=1930ji1Jj6dVuY81Wd2kYBhHYNV-2R0bN_L4o9zBj1U,533
 bec_widgets/utils/bec_connector.py,sha256=SivHKXVyNVqeu3kCXYEPpbleTVw8g1cW0FKq1QrQgco,9987
-bec_widgets/utils/bec_designer.py,sha256=ak3G8FdojUPjVBBwdPXw7tN5P2Uxr-SSoQt394jXeAA,4308
-bec_widgets/utils/bec_dispatcher.py,sha256=F66edY3Ib_ZjTT24qoAbjwUOdOKt6CiWUUqN1I1xxZs,5865
+bec_widgets/utils/bec_designer.py,sha256=Z3MeMju-KmTz8POtm23VQfp4rvtD2sF6eIOKQkl2F7w,4729
+bec_widgets/utils/bec_dispatcher.py,sha256=NkObWO_gRO9Uobz-fy0gVTZqQsbFRaKj6fbjYZoErFI,6400
 bec_widgets/utils/bec_table.py,sha256=nA2b8ukSeUfquFMAxGrUVOqdrzMoDYD6O_4EYbOG2zk,717
 bec_widgets/utils/bec_widget.py,sha256=Bo2v1aP7rgSAQajW8GBJbI3iovTn_hGCsmeFMo7bT10,707
 bec_widgets/utils/colors.py,sha256=hNIi99EpMv3t3hTJIL2jBe5nzh5f2fuCyEKXEPWSQSc,10501
-bec_widgets/utils/container_utils.py,sha256=m3VUyAYmSWkEwApP9tBvKxPYVtc2kHw4toxIpMryJy4,1495
+bec_widgets/utils/container_utils.py,sha256=0wr3ZfuMiAFKCrQHVjxjw-Vuk8wsHdridqcjy2eY840,1531
 bec_widgets/utils/crosshair.py,sha256=ywj4Pr2Xx8tFsD5qrHIocanKlNqDd51ElbEfxenuYM0,11363
 bec_widgets/utils/entry_validator.py,sha256=3skJIsUwTYicT76AMHm_M78RiWtUgyD2zb-Rxo2HdHQ,1313
 bec_widgets/utils/generate_designer_plugin.py,sha256=eidqauS8YLgoxkPntPL0oSG_lYqI2D7fSyOZvOtCU_U,5891
@@ -112,50 +112,50 @@ bec_widgets/widgets/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKV
 bec_widgets/widgets/base_classes/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/base_classes/device_input_base.py,sha256=thCOHOa9Z0b3-vlNFWK6PT_DdPTANnfj0_DLES_K-eE,3902
 bec_widgets/widgets/bec_queue/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/widgets/bec_queue/bec_queue.py,sha256=bU3HvghPuh7smTuKMp5WlJ0g3rW0UHIV05WekNHU8Q8,3846
+bec_widgets/widgets/bec_queue/bec_queue.py,sha256=IDZ2Jy0SeuJJ23lyVg8TnkUPJ8vfuGJUg5a9lt5jwPQ,3882
 bec_widgets/widgets/bec_queue/bec_queue.pyproject,sha256=VhoNmAv1DQUl9dg7dELyf5i4pZ5k65N3GnqOYiSwbQo,27
-bec_widgets/widgets/bec_queue/bec_queue_plugin.py,sha256=wuUeTXorzsrVi9ifCSjVkEMX9qQ_q6PydHBkTkgeoEA,1461
+bec_widgets/widgets/bec_queue/bec_queue_plugin.py,sha256=oYlAuWqgvjWHmzQuUvZaR8pHX_c_rM-Ib24z1V3Wg38,1334
 bec_widgets/widgets/bec_queue/register_bec_queue.py,sha256=XnwtUSa1asK1b80knKWodcyX9qJy4DnKsQL_FoDfZy4,463
 bec_widgets/widgets/bec_status_box/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/bec_status_box/bec_status_box.py,sha256=hlo-U9rf1jzSCXpCjx3tthNYT8KImxKSRri5gsCULvw,13108
 bec_widgets/widgets/bec_status_box/bec_status_box.pyproject,sha256=JWtx3Csfn2h7ODtk10HtyBNLf6tFIqyU6g04rMWOO1U,32
-bec_widgets/widgets/bec_status_box/bec_status_box_plugin.py,sha256=hX6UjJcetD-XMQLMLScwItEezqpyGyK6CjgEEWiTMaQ,1522
+bec_widgets/widgets/bec_status_box/bec_status_box_plugin.py,sha256=BD58_U68ySD3cHg9mdMK2XsU4A0wTdO5ES7dAJeZDsY,1395
 bec_widgets/widgets/bec_status_box/register_bec_status_box.py,sha256=EiQITnkNw7IU7hE776wAeXro97eZd9XlsB9essgCebE,481
 bec_widgets/widgets/bec_status_box/status_item.py,sha256=3aNaa-e64PmkBoAWfItYAmhB1EFhWRiFLzXWWz0dS_8,5317
 bec_widgets/widgets/color_button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/color_button/color_button.py,sha256=Jx4UAn7ZomLei0OCg7RmTnq395scXW4jmqslQRbEVMI,1203
 bec_widgets/widgets/color_button/color_button.pyproject,sha256=LUYF4VkDOB4ttVe7YfvLh64K-XZg0-xaVT06BqCT3UA,30
-bec_widgets/widgets/color_button/color_button_plugin.py,sha256=8ilyeKIbgUHKCUE4qf2IyMY65a6dDlL3MxHzCgz17I4,1381
+bec_widgets/widgets/color_button/color_button_plugin.py,sha256=Owaqrq4XcMXYB7vDJSSxiQUZ6nKof10HviEcEFcxFCc,1254
 bec_widgets/widgets/color_button/register_color_button.py,sha256=ZAx3t7G2VI2S-1qcEof31Xi9O0X8deLeZNgS651L1JI,475
 bec_widgets/widgets/colormap_selector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/colormap_selector/colormap_selector.py,sha256=4BqV11XMZVmcwzHiKgwUVFtg_bg4Nz7CQznkL4hHRYU,3794
 bec_widgets/widgets/colormap_selector/colormap_selector.pyproject,sha256=lHl9qmlMCB6BKB2orqctKwLcKK3Swc0THsyr-5O_vXM,35
-bec_widgets/widgets/colormap_selector/colormap_selector_plugin.py,sha256=cM-5o6GgtH69h2dfV6phJDDz30UAuUQbuxRalQRT_eQ,1498
+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/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
 bec_widgets/widgets/device_browser/device_browser.ui,sha256=Dy_3oXArScP-_7hRI6nQ7SKKnihuyYAzJfXiRxxJQBE,1077
-bec_widgets/widgets/device_browser/device_browser_plugin.py,sha256=FprIStCa-cjuIm_P2YRwyWu3mxIDzjEgGPjIl92__Tk,1401
+bec_widgets/widgets/device_browser/device_browser_plugin.py,sha256=VZv5q5Im1p6TOeE6LI0n7plAJ83sMY9MTdWZcynvt0E,1274
 bec_widgets/widgets/device_browser/register_device_browser.py,sha256=LJ0ckrgUbU5yprhlrOtSQzymztKyb9zksMuFO4BKN6s,483
 bec_widgets/widgets/device_browser/device_item/__init__.py,sha256=VGY-uNVCnpcY-q-gijteB2N8KxFNgYR-qQ209MVu1QI,36
 bec_widgets/widgets/device_browser/device_item/device_item.py,sha256=MtiHM8JXalfNzWYwBj12u_SJidkSchbCy7iT1YZouec,1476
 bec_widgets/widgets/device_combobox/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/device_combobox/device_combo_box.pyproject,sha256=wI2eXR5ky_IM9-BCHJnH_9CEqYcZwIuLcgitSEr8OJU,40
-bec_widgets/widgets/device_combobox/device_combo_box_plugin.py,sha256=ntd0K1W3O2RgoomTsmnuG16CJ12G6iqJiCIoDjxxswU,1523
+bec_widgets/widgets/device_combobox/device_combo_box_plugin.py,sha256=1wJZEj9cQdgNGrdy5btzlJBIKFP7mFUOuiSDG939jwo,1396
 bec_widgets/widgets/device_combobox/device_combobox.py,sha256=4YohiVtN-R4j9m2mrdwdkRL6IMpIbJ16KJ0SpJC86_g,2667
 bec_widgets/widgets/device_combobox/register_device_combo_box.py,sha256=ZCrWVdWOvIjnUJWe3MU7JO021rcXYg2SgA1iSKqbLoY,488
 bec_widgets/widgets/device_line_edit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/device_line_edit/device_line_edit.py,sha256=iKK2NrVu4okWP8kxPU5whmo_y5VHtrD7Fd_q3ZgXN1Y,3221
 bec_widgets/widgets/device_line_edit/device_line_edit.pyproject,sha256=tqAYXRbxsHR41MwqmAxvfq1CFeZ1IRv84whUG67HjjE,41
-bec_widgets/widgets/device_line_edit/device_line_edit_plugin.py,sha256=zFg-t4JsrSOOboX8DENHx27_XQlBUh9ocPD-tPXrrp8,1547
+bec_widgets/widgets/device_line_edit/device_line_edit_plugin.py,sha256=4ASFaDcpkmyzDPJlPMTV8cCYefFjHz_dv2CchzuTAL4,1420
 bec_widgets/widgets/device_line_edit/register_device_line_edit.py,sha256=8gEPnC8djYCw-idoZAENNB3bPOxM6pbzEp9A366EAGg,489
 bec_widgets/widgets/dock/__init__.py,sha256=B7foHt02gnhM7mFksa7GJVwT7n0j_JvYDCt6wc6XR5g,61
 bec_widgets/widgets/dock/dock.py,sha256=hQw5tpGrRbybjfF-aVEAeGdLTudtH4kFa70flu6_ZA8,10349
 bec_widgets/widgets/dock/dock_area.py,sha256=VfKyMxKo-r1Ugu2xjSsfGMYZUg3i3xxaokaZCFcCoxA,13579
 bec_widgets/widgets/dock/dock_area.pyproject,sha256=URW0UrDXCnkzk80rbQmUMgF6Uqay2TjHsq8Dq0g1j-c,37
-bec_widgets/widgets/dock/dock_area_plugin.py,sha256=DoVhw15MW8JoEXRj4d53B02nYH5ffRISr033Xw2FK8g,1435
+bec_widgets/widgets/dock/dock_area_plugin.py,sha256=BqWvXzRm90kZGKgP26APt7f6ARBWzLU839vGAjl7UYM,1308
 bec_widgets/widgets/dock/register_dock_area.py,sha256=Yqd1mq6CcHwlxHZxX5EHKONy4P44nMm8pso-4X0tvJI,464
 bec_widgets/widgets/figure/__init__.py,sha256=3hGx_KOV7QHCYAV06aNuUgKq4QIYCjUTad-DrwkUaBM,44
 bec_widgets/widgets/figure/figure.py,sha256=yujtlDj5NutRJ0gfHMkCVXvBNj5r2z3pb3gwWlUQ92Q,28822
@@ -174,14 +174,14 @@ bec_widgets/widgets/figure/plots/waveform/waveform.py,sha256=uW9GQHWiVd3q63-yXjQ
 bec_widgets/widgets/figure/plots/waveform/waveform_curve.py,sha256=ZwRxSfPHbMWEvgUC-mL2orpZvtxR-DcrYAFikkdWEzk,8654
 bec_widgets/widgets/image/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/image/bec_image_widget.pyproject,sha256=PHisdBo5_5UCApd27GkizzqgfdjsDx2bFZa_p9LiSW8,30
-bec_widgets/widgets/image/bec_image_widget_plugin.py,sha256=WNm1c6tP77PxA0joGREc2Dpv2tsi8dSXdb8BeKrJWdc,1479
+bec_widgets/widgets/image/bec_image_widget_plugin.py,sha256=vU9JnJwz0TTITH4fK6uVGmbTnPdV8kLu2BIJU_LQH4c,1352
 bec_widgets/widgets/image/image_widget.py,sha256=TCpTF8v94iSMklG9bYxZOjm9SbO60XZB9X0ldEp8lWE,16288
 bec_widgets/widgets/image/register_bec_image_widget.py,sha256=01YLZQTMSSIXvH1TSL-1AYsRs1a4EbSwKLVAwh9AjeA,478
 bec_widgets/widgets/jupyter_console/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/jupyter_console/jupyter_console.py,sha256=-e7HQOECeH5eDrJYh4BFIzRL78LDkooU4otabyN0aX4,2343
 bec_widgets/widgets/motor_map/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/motor_map/bec_motor_map_widget.pyproject,sha256=NAI8s5gRKz80ED4KY7OgD2OgSH5HEsjt2ux2BYp66yg,63
-bec_widgets/widgets/motor_map/bec_motor_map_widget_plugin.py,sha256=RRW72pQGFEQErGbOnI09wBdHIkx9iDdCA6n5hXBJeiI,1410
+bec_widgets/widgets/motor_map/bec_motor_map_widget_plugin.py,sha256=NSUlP06rTB73GKik7KR_sO66Yu-gp5_XA7ApgTbcwJo,1283
 bec_widgets/widgets/motor_map/motor_map_widget.py,sha256=URcysThbJKGsCZUqQm2lCtVn5FG8t4kT7DaN5EJUexg,7555
 bec_widgets/widgets/motor_map/register_bec_motor_map_widget.py,sha256=qRG8PtWGjso0pWbvj_DXKnbUfmQzfGqPSrnAozXfM7o,492
 bec_widgets/widgets/motor_map/motor_map_dialog/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -190,17 +190,17 @@ bec_widgets/widgets/motor_map/motor_map_dialog/motor_map_settings.ui,sha256=nv5v
 bec_widgets/widgets/position_indicator/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/position_indicator/position_indicator.py,sha256=QVlWvs_RvEJe5IMxGYCpi-CXYF7vFeMqEMFCs6u5NGc,2020
 bec_widgets/widgets/position_indicator/position_indicator.pyproject,sha256=s0JEf5YkpMag19ddFSYeRZ8erBau7erO3bqw05YrTyg,36
-bec_widgets/widgets/position_indicator/position_indicator_plugin.py,sha256=lCXbgVkLUmCiKOpovwnRDcIspvzzPJ2nOwBfQcrxDE4,1536
+bec_widgets/widgets/position_indicator/position_indicator_plugin.py,sha256=5efV6Y5LSvCHgg2wogAs7JfKfDhzv59NFT0uT17cWsk,1409
 bec_widgets/widgets/position_indicator/register_position_indicator.py,sha256=OZNiMgM_80TPSAXK_0hXAkne4vUh8DGvh_OdpOiMpwI,516
 bec_widgets/widgets/positioner_box/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/positioner_box/positioner_box.py,sha256=FyUGskWAb-5m44bdUNVig_AkoDbLRbB0GucI6RRHge8,10839
 bec_widgets/widgets/positioner_box/positioner_box.pyproject,sha256=7966pHdDseaHciaPNEKgdQgbUThSZf5wEDCeAEJh9po,32
 bec_widgets/widgets/positioner_box/positioner_box.ui,sha256=Y-Xp0z32okT7X4-rL5r7dF_QH_QpXvPes3f778cC7_k,5633
-bec_widgets/widgets/positioner_box/positioner_box_plugin.py,sha256=fSkLRBfCdJ6531BslhcxdwLQJWO9xcHGuX9TGGJJQbc,1531
+bec_widgets/widgets/positioner_box/positioner_box_plugin.py,sha256=pcZcE0lwgdyWsopwi5ZM1tw32P5uD5QOtEC7sLYQIEc,1404
 bec_widgets/widgets/positioner_box/positioner_control_line.py,sha256=DWSDakPsOu8SrhTMKh9NR8b1a7npuyrkjVpZVqj1Kb0,915
 bec_widgets/widgets/positioner_box/positioner_control_line.pyproject,sha256=RGIXDjWq3fNCgOnU-08oeIeBLCcjYbRXgyh26drxB7I,41
 bec_widgets/widgets/positioner_box/positioner_control_line.ui,sha256=hJ4e3e3A1zZY3WRfQ7yvAZUAtL8tJhCJX2bWbtty_EQ,5625
-bec_widgets/widgets/positioner_box/positioner_control_line_plugin.py,sha256=N6AQS7kLtvdAr76F-kdDtXSOpz-mbfnQX20H-_YL6N8,1604
+bec_widgets/widgets/positioner_box/positioner_control_line_plugin.py,sha256=ieLT4VCx9aza8NYAAioUaYglrywHmAma6JGzcBSMOCo,1477
 bec_widgets/widgets/positioner_box/register_positioner_box.py,sha256=UPOUjXXq6-IgSj0kdV_nJe1rYPMF8aIZxF4eSmWgQAg,483
 bec_widgets/widgets/positioner_box/register_positioner_control_line.py,sha256=MJ13vKGIwTMQGFhll63tfUGXHyd6bz40Cvr85oYKH3I,525
 bec_widgets/widgets/ring_progress_bar/__init__.py,sha256=_uoJKnDM2YAeUBfwc5WLbIHSJj7zm_FAurSKP3WRaCw,47
@@ -208,41 +208,41 @@ bec_widgets/widgets/ring_progress_bar/register_ring_progress_bar.py,sha256=uJrMh
 bec_widgets/widgets/ring_progress_bar/ring.py,sha256=2pdEzETaJpvx4Dzyosq2YhnvDOEUvFnj_f9GfFKpG5Q,11159
 bec_widgets/widgets/ring_progress_bar/ring_progress_bar.py,sha256=F7z6BbY7BYSKivpCus6T8pXIwzqHOsDlaIV5fGRIboQ,24119
 bec_widgets/widgets/ring_progress_bar/ring_progress_bar.pyproject,sha256=ZNYDnKDu9pixrY2XrulAGdKZg-Ysa7q67O_X2tAA0fc,35
-bec_widgets/widgets/ring_progress_bar/ring_progress_bar_plugin.py,sha256=f6eAuDEvmnl0gy-cBwUkuUS4yr1VGjVEa40N5MIXwF0,1511
+bec_widgets/widgets/ring_progress_bar/ring_progress_bar_plugin.py,sha256=4wYVyxs8osUa1VuJUI5A2KdCCghmZXwsNCEtFQq6pYI,1384
 bec_widgets/widgets/scan_control/__init__.py,sha256=IOfHl15vxb_uC6KN62-PeUzbBha_vQyqkkXbJ2HU674,38
 bec_widgets/widgets/scan_control/register_scan_control.py,sha256=xUX2yR0-MaIMg9_y9qe50yDDphzsh2x1b5PMrF90yPM,475
 bec_widgets/widgets/scan_control/scan_control.py,sha256=30pcaVaBVo6JxJuMH1ul1s-sPuWqCUKsUQ-XfAgzRZ8,9384
 bec_widgets/widgets/scan_control/scan_control.pyproject,sha256=eTgVDFKToIH8_BbJjM2RvbOLr7HnYoidX0SAHx640DM,30
-bec_widgets/widgets/scan_control/scan_control_plugin.py,sha256=t3_qTACqYcvl_Wr102bIdVDyw6uNK1B94fh_wjs-lxg,1477
+bec_widgets/widgets/scan_control/scan_control_plugin.py,sha256=Oe0jvKoLa1jvV7IyoExTzd2vvJbKPgUUt4_cdunsVNY,1350
 bec_widgets/widgets/scan_control/scan_group_box.py,sha256=BpX9ZphqOhdEbQnGzNeNlmuZsMS__U97CkBMical2FY,9300
 bec_widgets/widgets/spinner/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/spinner/register_spinner_widget.py,sha256=_zCPjLh4M7NTSHP1Atdn6yu33zJ3LJkcBy3KOJ5eSVY,476
 bec_widgets/widgets/spinner/spinner.py,sha256=3A-VcX7HLDyqWsMoTUpB4jKHL26YuAbwOk3qonp3dI4,2591
 bec_widgets/widgets/spinner/spinner_widget.pyproject,sha256=zzLajGB3DTgVnrSqMey2jRpBlxTq9cBXZL9tWJCKe-I,25
-bec_widgets/widgets/spinner/spinner_widget_plugin.py,sha256=WlPUlCeSVFPup4ZY90oIo5WjSCglIKw_bsNdEGs3yWA,1478
+bec_widgets/widgets/spinner/spinner_widget_plugin.py,sha256=VKUWMDN8h-qpbXmO9-dYQazSUs3GQDV4vTrZEP8J86k,1351
 bec_widgets/widgets/stop_button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/stop_button/register_stop_button.py,sha256=U7r3fEOH-uPhAQI-nTituHXDDXDWR4JQZ7_vD6b_dfM,471
 bec_widgets/widgets/stop_button/stop_button.py,sha256=XLrRFvVrAhD16_-SPgzvsUhy0ROunsrWlI5BPRyqZOI,832
 bec_widgets/widgets/stop_button/stop_button.pyproject,sha256=Cc_xbv-zfzNVpsdg_1QyzuTlrJaM9_BkIjes70umrx0,29
-bec_widgets/widgets/stop_button/stop_button_plugin.py,sha256=yAvIPsdyn0X8Srx2KB8KEmDLDTScQH2dc8MGH0cFj_I,1481
+bec_widgets/widgets/stop_button/stop_button_plugin.py,sha256=D5YfaGXuEenXDSGyC7VcwBolRqPV1FIikXXwVMVsozI,1354
 bec_widgets/widgets/text_box/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/text_box/register_text_box.py,sha256=UwrmCoYjAAtJJK8BwC0P_wSb-lOlOvxPe3-Bemg_9nw,459
 bec_widgets/widgets/text_box/text_box.py,sha256=3OWC6L3CWsH_uh8X11WnifYjhO8ruDe2FWFhE8cn5lY,4274
 bec_widgets/widgets/text_box/text_box.pyproject,sha256=XohO1BIe2hrpU-z_KHKRgjcUkXru7jeFte31j2TPbNk,26
-bec_widgets/widgets/text_box/text_box_plugin.py,sha256=UyP7NQ-rHnBOOww8ICAuI61FDuAoAl_KcpsKhkiPH3k,1418
+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_switch.pyproject,sha256=Msa-AS5H5XlqW65r8GlX2AxD8FnFnDyDgGnbKcXqKOw,24
-bec_widgets/widgets/toggle/toggle_switch_plugin.py,sha256=V8qW7o-8ld9Lc_P_SLfpb6Fo0DSZt3Vu2mMJEueM5fc,1460
+bec_widgets/widgets/toggle/toggle_switch_plugin.py,sha256=NSrk8KkolyOOxkliTwqz2n_l7jNPTjSFfcc9iCuzkiU,1333
 bec_widgets/widgets/vscode/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/vscode/register_vs_code_editor.py,sha256=JATKBkTEuReeQ2Jj402xasjgVRMFI8uUOAAwmnFOWRA,473
 bec_widgets/widgets/vscode/vs_code_editor.pyproject,sha256=bxx0jZlSfBo-Em7p15W1QIJ9lFr9jqTqGynUQG01ocU,24
-bec_widgets/widgets/vscode/vs_code_editor_plugin.py,sha256=0DA6gjG1ZFvrrF23W5rarUVOR6oeeB0leEjtQIK6g6o,1462
+bec_widgets/widgets/vscode/vs_code_editor_plugin.py,sha256=XqHJvMg5U804o2KnoGsKyf8WuLZjlaMRTWB2XkbqWLU,1335
 bec_widgets/widgets/vscode/vscode.py,sha256=yV1D9PK2IYomq9yYfwqUOrZGIeBwMnNuBfXxBc2M8Qc,2231
 bec_widgets/widgets/waveform/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/waveform/bec_waveform_widget.pyproject,sha256=GLD8GN9dXx9wNbtnevrxqqcwk7vKV-Uv8QYSycdaoaI,33
-bec_widgets/widgets/waveform/bec_waveform_widget_plugin.py,sha256=f8zgTQGp6hbfxOAnMqLvaI3N9KwxEMtUKkZQZBAL_rw,1514
+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=nzRDgo_qfmmp_aSGbXhwy2U7yq5cR0pHdjM0YDCvTKE,20409
 bec_widgets/widgets/waveform/waveform_popups/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -256,9 +256,9 @@ bec_widgets/widgets/website/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 bec_widgets/widgets/website/register_website_widget.py,sha256=LIQJpV9uqcBiPR9cEAiDjaUS_l7JroYVdsotnLpD9H0,476
 bec_widgets/widgets/website/website.py,sha256=vyRJr4jsti1h6cPHzTTtS_0IELJ3kYdS2_HdZCzavl4,1840
 bec_widgets/widgets/website/website_widget.pyproject,sha256=scOiV3cV1_BjbzpPzy2N8rIJL5P2qIZz8ObTJ-Uvdtg,25
-bec_widgets/widgets/website/website_widget_plugin.py,sha256=E5qf7ZK26tkXjRwJMzYqHypX0ChxAleMs6Mxw7XaPl4,1461
+bec_widgets/widgets/website/website_widget_plugin.py,sha256=Tllr4gLLPaouBxZ7-kRiNFFNPhHR4drna8VVRpia9zU,1334
 docs/Makefile,sha256=i2WHuFlgfyAPEW4ssEP8NY4cOibDJrVjvzSEU8_Ggwc,634
-docs/conf.py,sha256=eSfoMdl2eObhbKr7eki59DrkNUh15KfcZpuBc7goMRc,2500
+docs/conf.py,sha256=xrP_NOgayguXdfhEK6Oag5KlBxzzbHCv0zbitTpUWqM,2519
 docs/index.md,sha256=h4edya5UA0bx21ReHu40lJudqVBH41tOASjnCjmoYj8,1197
 docs/make.bat,sha256=vKazJE8RW49Cy8K7hm8QYbletvAd8YkeKsaPA_dWnXs,800
 docs/requirements.txt,sha256=gMQDaDpz_LSH5TP6dKxKXqI5kupNnT4g-4KJ4fg2o5s,161
@@ -296,7 +296,8 @@ docs/developer/introduction/concepts.md,sha256=N23ewZjPx97eJtrU6-0Lou2IvPfkfZ6Nw
 docs/developer/introduction/contributing.md,sha256=ocW5kjBNwD5k_nDkusXUpsW8jJALajrpNSRVJftuF-k,1668
 docs/developer/introduction/introduction.md,sha256=vR732ai0u-NiP8ij2_HJucgT4CDhjyrARbThDMqUc74,788
 docs/developer/introduction/useful_links.md,sha256=ytWRyLTAveU8ELrA0GL9hzTVCBRNBOTV8pRxvPp1huk,1487
-docs/developer/widget_development/widget_development.md,sha256=wGfDjbt9EonVxUg59keADy7wCLyS-KzCz7m4hY0OV_A,526
+docs/developer/widget_development/bec_dispatcher.md,sha256=AX3XVNE_9E1_rawD9q-yY9yvCEaZQiglfWpJpRn5TV0,8018
+docs/developer/widget_development/widget_development.md,sha256=LE9_o1IeqLBgb1jaoLlXrOlqIUAEJPJpsHs8C3cSQ1k,542
 docs/introduction/introduction.md,sha256=YBEFDhxqHTcbfbNTo76xDflaFUHIqDs-sToA1HRmCnI,1436
 docs/user/customisation.md,sha256=wCW8fAbqtlgGE3mURvXOrK67Xo0_B-lxfg0sYuQWB40,3186
 docs/user/user.md,sha256=FuBog2_wymy-A-p6QhXYf7CYn6tR6ojwK1ZLgV-tF1E,1499
@@ -399,8 +400,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.96.2.dist-info/METADATA,sha256=xRvEZ02kp6ROhkDYvw-jCEJA0QqyjeTRUHYJnbgxgXY,1325
-bec_widgets-0.96.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-bec_widgets-0.96.2.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
-bec_widgets-0.96.2.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.96.2.dist-info/RECORD,,
+bec_widgets-0.97.0.dist-info/METADATA,sha256=UkwD-_52GWkQgNpQnMa-cDG4Q_h3sMM1jqGYrM4Kjy8,1325
+bec_widgets-0.97.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bec_widgets-0.97.0.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
+bec_widgets-0.97.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.97.0.dist-info/RECORD,,

docs/conf.py

@@ -65,7 +65,7 @@ add_module_names = False  # Remove namespaces from class/method signatures
 autodoc_inherit_docstrings = True  # If no docstring, inherit from base class
 set_type_checking_flag = True  # Enable 'expensive' imports for sphinx_autodoc_typehints
 autoclass_content = "both"  # Include both class docstring and __init__
-autodoc_mock_imports = ["pyqtgraph"]
+autodoc_mock_imports = ["pyqtgraph", "qtpy", "PySide6"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/developer/widget_development/bec_dispatcher.md

@@ -0,0 +1,143 @@
+(developer.bec_dispatcher)=
+
+# BECDispatcher
+
+## Overview
+
+The [`BECDispatcher`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher)
+is a powerful tool that
+simplifies the process of connecting Qt slots to message updates from the BEC server. It enables real-time communication
+between your widget and the BEC server by listening to specific message channels and triggering callbacks when new data
+is received.
+
+This tool is especially useful for creating widgets that need to respond to dynamic data, such as device readbacks or
+scan updates. By
+using [`BECDispatcher`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher),
+you
+can create callback functions that react to incoming messages and update your widget's state or perform other tasks
+based on the data received.
+
+## How It Works
+
+When you create a widget that needs to respond to updates from the BEC server, you can use
+the [`BECDispatcher`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher)
+to
+connect specific Qt slots (callback functions) to message endpoints. These endpoints are defined within the BEC system
+and represent specific channels of information (
+e.g., [`device readback`](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_lib.endpoints.MessageEndpoints.html#bec_lib.endpoints.MessageEndpoints.device_readback),
+[`scan_segment`](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_lib.endpoints.MessageEndpoints.html#bec_lib.endpoints.MessageEndpoints.scan_segment),
+etc.).
+
+### Step-by-Step Guide
+
+1. **Create a Callback Function**: Define a function within your widget that will handle the data received from the BEC
+   server. This function should usually accept two parameters: `msg_content` (the message content) and `metadata` (
+   additional
+   information about the message).
+
+    ```python
+    # Example for a callback function that updates a widget display based on motor readback data
+   from qtpy.QtCore import Slot
+   
+    @Slot(dict, dict)
+    def on_device_readback(self, msg_content, metadata):
+        # Process the incoming data
+        new_value = msg_content["signals"]['motor_x']["value"]
+        # Update the widget's display or perform another action
+        self.update_display(new_value)
+    ```
+
+2. **Connect the Slot to an Endpoint**: Use
+   the [`BECDispatcher`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher)
+   to connect your callback function to a specific
+   endpoint. The endpoint represents the type of data or message you're interested in.
+
+    ```python
+   from bec_lib.endpoints import MessageEndpoints
+   
+    self.bec_dispatcher.connect_slot(self.on_device_readback, MessageEndpoints.device_readback("motor_x"))
+    ```
+
+3. **Handle Incoming Data**: Your callback function will be triggered automatically whenever a new message is received
+   on the connected endpoint. Use the data in `msg_content` to update your widget or perform other actions.
+
+4. **Clean Up Connections**: If your widget is being destroyed or you no longer need to listen for updates, make sure to
+   disconnect your slots from
+   the [`BECDispatcher`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher)
+   to avoid memory or thread leaks.
+
+    ```python
+    self.bec_dispatcher.disconnect_slot(self.on_device_readback, MessageEndpoints.device_readback("motor_x"))
+    ```
+
+### Example: Motor Map Widget
+
+The [`BECMotorMap`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.widgets.figure.plots.motor_map.motor_map.BECMotorMap.html#bec-widgets-widgets-figure-plots-motor-map-motor-map-becmotormap)
+widget is a great example of
+how [`BECDispatcher`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher)
+can be used to handle real-time data updates. This
+widget listens for updates on specific motor positions and dynamically updates the motor map display.
+
+Here's a breakdown of
+how [`BECDispatcher`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher)
+is used in
+the [`BECMotorMap`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.widgets.figure.plots.motor_map.motor_map.BECMotorMap.html#bec-widgets-widgets-figure-plots-motor-map-motor-map-becmotormap)
+widget:
+
+1. **Connecting to Motor Readbacks**:
+   The widget connects to
+   the [`device readback`](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_lib.endpoints.MessageEndpoints.html#bec_lib.endpoints.MessageEndpoints.device_readback)
+   endpoints using
+   the [`connect_slot`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher.connect_slot)
+   method
+   of [`BECDispatcher`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher).
+   This allows
+   the widget to receive real-time updates about the motor positions.
+
+```{literalinclude} ../../../bec_widgets/widgets/figure/plots/motor_map/motor_map.py
+:language: python
+:pyobject: BECMotorMap._connect_motor_to_slots
+:dedent: 4
+```
+
+2. **Handling Readback Data**:
+   The `on_device_readback` slot is called whenever new data is received from the motor readback. This slot processes
+   the data and updates the motor map plot accordingly.
+
+```{literalinclude} ../../../bec_widgets/widgets/figure/plots/motor_map/motor_map.py
+:language: python
+:pyobject: BECMotorMap.on_device_readback
+:dedent: 4
+```
+
+3. **Updating the Plot**:
+   The motor map plot is updated in response to the new data, providing a real-time visualization of the motor's
+   position.
+
+```{literalinclude} ../../../bec_widgets/widgets/figure/plots/motor_map/motor_map.py
+:language: python
+:pyobject: BECMotorMap._update_plot
+:dedent: 4
+```
+
+4. **Disconnecting When No Longer Needed**:
+   The widget ensures that connections are properly cleaned up when no longer needed.
+
+```{literalinclude} ../../../bec_widgets/widgets/figure/plots/motor_map/motor_map.py
+:language: python
+:pyobject: BECMotorMap._update_plot
+:dedent: 4
+```
+
+## Conclusion
+
+The [`BECDispatcher`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_dispatcher.BECDispatcher.html#bec_widgets.utils.bec_dispatcher.BECDispatcher)
+is a key tool for developing interactive and responsive widgets within the BEC framework. By
+leveraging this tool, you can create widgets that automatically respond to real-time data updates from the BEC server,
+enhancing the interactivity and functionality of your user interface.
+
+In next tutorials we will cover how to create a custom widget using the BECDispatcher and BECWidget base class.
+
+```{note}
+For more details on specific messages and endpoints, please refer to the [Message Endpoints Documentation](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_lib.endpoints.MessageEndpoints.html#bec-lib-endpoints-messageendpoints).
+```

docs/developer/widget_development/widget_development.md

@@ -8,4 +8,6 @@ maxdepth: 2
 hidden: false
 ---
 
+bec_dispatcher
+
 ```

pyproject.toml

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