bec-widgets 0.95.1__tar.gz → 0.96.0__tar.gz

{bec_widgets-0.95.1 → bec_widgets-0.96.0}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## v0.96.0 (2024-08-22)
+
+### Documentation
+
+* docs(scan_control): added designer options ([`9d7718c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9d7718c3d9badf14150174410b9958a3134a1e23))
+
+### Feature
+
+* feat(scan_control): added the ability to configure the scan control widget from designer ([`9d8fb0b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9d8fb0b761efa92972399bcd9aea28e956074380))
+
 ## v0.95.1 (2024-08-22)
 
 ### Documentation
@@ -148,12 +158,6 @@ Terminating client connections has to be done at the application level ([`198c1d
 
 * fix(dock): properly shut down docks and temp areas ([`99ee545`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/99ee545e41c6078654958b668b5b329f85553d16))
 
-* fix(settings): shut down settings dialog ([`b50b3a2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b50b3a27e68956e10e8169a0aa698c911d2d9642))
-
-* fix(website): fixed teardown of website widgets ([`a3d4f5a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a3d4f5ac4bc52acfed2791a1724fade6972ed320))
-
 ### Test
 
 * test: removed quit from teardown ([`cf94599`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cf94599c2544d6831c8afbe7b340082077557ed1))
-
-* test: removed explicit call to close the widget ([`bf6294e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bf6294ecbfd494565d2dc215e4d7e0c280ac7745))

{bec_widgets-0.95.1 → bec_widgets-0.96.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.95.1
+Version: 0.96.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.95.1 → bec_widgets-0.96.0}/bec_widgets/widgets/scan_control/scan_control.py

@@ -1,9 +1,11 @@
 from bec_lib.endpoints import MessageEndpoints
+from qtpy.QtCore import Property, Signal, Slot
 from qtpy.QtWidgets import (
     QApplication,
     QComboBox,
     QGridLayout,
     QGroupBox,
+    QHBoxLayout,
     QPushButton,
     QSizePolicy,
     QVBoxLayout,
@@ -18,6 +20,9 @@ from bec_widgets.widgets.stop_button.stop_button import StopButton
 
 class ScanControl(BECWidget, QWidget):
 
+    scan_started = Signal()
+    scan_selected = Signal(str)
+
     def __init__(
         self, parent=None, client=None, gui_id: str | None = None, allowed_scans: list | None = None
     ):
@@ -50,11 +55,26 @@ class ScanControl(BECWidget, QWidget):
         self.layout.addWidget(self.scan_selection_group)
 
         # Connect signals
-        self.comboBox_scan_selection.currentIndexChanged.connect(self.on_scan_selected)
+        self.comboBox_scan_selection.currentIndexChanged.connect(self.on_scan_selection_changed)
         self.button_run_scan.clicked.connect(self.run_scan)
+
+        # Add bundle button
+        self.button_add_bundle = QPushButton("Add Bundle")
+        self.button_add_bundle.setVisible(False)
+        # Remove bundle button
+        self.button_remove_bundle = QPushButton("Remove Bundle")
+        self.button_remove_bundle.setVisible(False)
+
+        bundle_layout = QHBoxLayout()
+        bundle_layout.addWidget(self.button_add_bundle)
+        bundle_layout.addWidget(self.button_remove_bundle)
+        self.layout.addLayout(bundle_layout)
+
         self.button_add_bundle.clicked.connect(self.add_arg_bundle)
         self.button_remove_bundle.clicked.connect(self.remove_arg_bundle)
 
+        self.scan_selected.connect(self.scan_select)
+
         # Initialize scan selection
         self.populate_scans()
 
@@ -69,21 +89,16 @@ class ScanControl(BECWidget, QWidget):
         scan_selection_group = QGroupBox("Scan Selection", self)
         self.scan_selection_layout = QGridLayout(scan_selection_group)
         self.comboBox_scan_selection = QComboBox(scan_selection_group)
+
         # Run button
         self.button_run_scan = QPushButton("Start", scan_selection_group)
         self.button_run_scan.setStyleSheet("background-color:  #559900; color: white")
         # Stop button
         self.button_stop_scan = StopButton(parent=scan_selection_group)
-        # Add bundle button
-        self.button_add_bundle = QPushButton("Add Bundle", scan_selection_group)
-        # Remove bundle button
-        self.button_remove_bundle = QPushButton("Remove Bundle", scan_selection_group)
 
         self.scan_selection_layout.addWidget(self.comboBox_scan_selection, 0, 0, 1, 2)
         self.scan_selection_layout.addWidget(self.button_run_scan, 1, 0)
         self.scan_selection_layout.addWidget(self.button_stop_scan, 1, 1)
-        self.scan_selection_layout.addWidget(self.button_add_bundle, 2, 0)
-        self.scan_selection_layout.addWidget(self.button_remove_bundle, 2, 1)
 
         return scan_selection_group
 
@@ -104,23 +119,65 @@ class ScanControl(BECWidget, QWidget):
             allowed_scans = self.allowed_scans
         self.comboBox_scan_selection.addItems(allowed_scans)
 
-    def on_scan_selected(self):
+    def on_scan_selection_changed(self, index: int):
         """Callback for scan selection combo box"""
-        self.reset_layout()
         selected_scan_name = self.comboBox_scan_selection.currentText()
-        selected_scan_info = self.available_scans.get(selected_scan_name, {})
+        self.scan_selected.emit(selected_scan_name)
+
+    @Property(bool)
+    def hide_scan_control_buttons(self):
+        return not self.button_run_scan.isVisible()
+
+    @hide_scan_control_buttons.setter
+    def hide_scan_control_buttons(self, hide: bool):
+        self.show_scan_control_buttons(not hide)
+
+    @Slot(bool)
+    def show_scan_control_buttons(self, show: bool):
+        """Shows or hides the scan control buttons."""
+        self.button_run_scan.setVisible(show)
+        self.button_stop_scan.setVisible(show)
+
+        show_group = show or self.button_run_scan.isVisible()
+        self.scan_selection_group.setVisible(show_group)
+
+    @Property(bool)
+    def hide_scan_selection_combobox(self):
+        return not self.comboBox_scan_selection.isVisible()
+
+    @hide_scan_selection_combobox.setter
+    def hide_scan_selection_combobox(self, hide: bool):
+        self.show_scan_selection_combobox(not hide)
+
+    @Slot(bool)
+    def show_scan_selection_combobox(self, show: bool):
+        """Shows or hides the scan selection combobox."""
+        self.comboBox_scan_selection.setVisible(show)
+
+        show_group = show or self.button_run_scan.isVisible()
+        self.scan_selection_group.setVisible(show_group)
+
+    @Slot(str)
+    def scan_select(self, scan_name: str):
+        """
+        Slot for scan selection. Updates the scan control layout based on the selected scan.
+
+        Args:
+            scan_name(str): Name of the selected scan.
+        """
+        self.reset_layout()
+        selected_scan_info = self.available_scans.get(scan_name, {})
 
         gui_config = selected_scan_info.get("gui_config", {})
         self.arg_group = gui_config.get("arg_group", None)
         self.kwarg_groups = gui_config.get("kwarg_groups", None)
 
-        if self.arg_box is None:
-            self.button_add_bundle.setEnabled(False)
-            self.button_remove_bundle.setEnabled(False)
+        show_bundle_buttons = bool(self.arg_group["arg_inputs"])
+
+        self.button_add_bundle.setVisible(show_bundle_buttons)
+        self.button_remove_bundle.setVisible(show_bundle_buttons)
 
-        if len(self.arg_group["arg_inputs"]) > 0:
-            self.button_add_bundle.setEnabled(True)
-            self.button_remove_bundle.setEnabled(True)
+        if show_bundle_buttons:
             self.add_arg_group(self.arg_group)
         if len(self.kwarg_groups) > 0:
             self.add_kwargs_boxes(self.kwarg_groups)
@@ -151,9 +208,11 @@ class ScanControl(BECWidget, QWidget):
         self.arg_box.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed)
         self.layout.addWidget(self.arg_box)
 
+    @Slot()
     def add_arg_bundle(self):
         self.arg_box.add_widget_bundle()
 
+    @Slot()
     def remove_arg_bundle(self):
         self.arg_box.remove_widget_bundle()
 
@@ -172,7 +231,9 @@ class ScanControl(BECWidget, QWidget):
             box.deleteLater()
         self.kwarg_boxes = []
 
+    @Slot()
     def run_scan(self):
+        self.scan_started.emit()
         args = []
         kwargs = {}
         if self.arg_box is not None:

{bec_widgets-0.95.1 → bec_widgets-0.96.0}/docs/user/widgets/scan_control/scan_control.md

@@ -23,11 +23,19 @@ By default, this widget supports scans that are derived from the following base
 The full procedure how to design `gui_config` for your custom scan class is described in the [Scan GUI Configuration](https://bec.readthedocs.io/en/latest/developer/scans/scan_gui_config.html) tutorial.
 ```
 
+## BECDesigner Customization
+Within the BECDesigner's [property editor](https://doc.qt.io/qt-6/designer-widget-mode.html#the-property-editor/), the `ScanControl` widget can be customized to suit your application's requirements. The widget provides the following customization options:
+- **Hide Scan Control**: Allows you to hide the scan control buttons from the widget interface. This is useful when you want to place the control buttons in a different location.
+- **Hide Scan Selection**: Allows you to hide the scan selection combobox from the widget interface. This is useful when you want to restrict the user to a specific scan type or implement a custom scan selection mechanism.
+
+```{figure} ./hide_scan_control.png
+```
+
 ````
 
 ````{tab} Examples
 
-The `ScanControl` widget can be integrated within a [`BECDockArea`](user.widgets.bec_dock_area) or used as an individual component in your application through `QtDesigner`. Below are examples demonstrating how to create and use the `ScanControl` widget.
+The `ScanControl` widget can be integrated within a [`BECDockArea`](user.widgets.bec_dock_area) or used as an individual component in your application through `BECDesigner`. Below are examples demonstrating how to create and use the `ScanControl` widget.
 
 ## Example 1 - Adding Scan Control Widget to BECDockArea
 

{bec_widgets-0.95.1 → bec_widgets-0.96.0}/pyproject.toml

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