bec-widgets 0.109.1__tar.gz → 0.111.0__tar.gz

{bec_widgets-0.109.1 → bec_widgets-0.111.0}/CHANGELOG.md

@@ -1,5 +1,31 @@
 # CHANGELOG
 
+## v0.111.0 (2024-09-17)
+
+### Documentation
+
+* docs(position_indicator): updated position indicator documentation and added designer properties ([`60f7d54`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/60f7d54e2b4c3129de6c95729b8b4aea1757174f))
+
+### Feature
+
+* feat(position_indicator): improved design and added more customization options ([`d15b222`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d15b22250fbceb708d89872c0380693e04acb107))
+
+### Fix
+
+* fix(position_indicator): fixed user access ([`dd932dd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/dd932dd8f3910ab67ec8403124f4e176d048e542))
+
+* fix(generate_cli): fixed type annotations ([`d3c1a1b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d3c1a1b2edcba7afea9d369820fa7974ac29c333))
+
+* fix(positioner_box): visual improvements to the positioner_box and positioner_control_line ([`7ea4a48`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7ea4a482e7cd9499a7268ac887b345cab01632aa))
+
+* fix(palette viewer): fixed background for tool tip ([`9045323`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9045323049d2a39c36fc8845f3b2883d6933436b))
+
+## v0.110.0 (2024-09-12)
+
+### Feature
+
+* feat(palette_viewer): added widget to display the current palette and accent colors ([`a8576c1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a8576c164cad17746ec4fcd5c775fb78f70c055c))
+
 ## v0.109.1 (2024-09-09)
 
 ### Fix
@@ -130,36 +156,6 @@
 
 * docs(buttons): buttons section of docs split to appearance and queue buttons ([`047aa26`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/047aa26a60220c826cc1375cf81daf11d1f3ab5c))
 
-* docs(tests): added tests tutorial for widget ([`18d8561`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/18d8561c965d149a7662085f7dbe2a39a8c4a475))
-
-### Feature
-
-* feat(queue): BECQueue controls extended with Resume, Stop, Abort, Reset buttons ([`0d7c10e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0d7c10e670e4937787e1afaa19ca8259ac752486))
-
 ### Fix
 
 * fix(queue_reset_button): queue reset has to be confirmed with msgBox ([`9dd43aa`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9dd43aa1fd3991368002605df4389a7a7271011b))
-
-### Refactor
-
-* refactor(tests): positioner box test changed to use create_widget fixture ([`df5eff3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/df5eff3147c79ff0278e6a5a09c8f73d5236aed3))
-
-## v0.101.0 (2024-09-02)
-
-### Feature
-
-* feat: add Dap dialog widget ([`9781b77`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9781b77de27b2810fbb1047a61b1832dd186db01))
-
-### Refactor
-
-* refactor: add docs, cleanup ([`61ecf49`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/61ecf491e52bfbfa0d5a84764a9095310659043d))
-
-## v0.100.0 (2024-09-01)
-
-### Documentation
-
-* docs(becwidget): improvements to the bec widget base class docs; fixed type hint import for sphinx ([`99d5e8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/99d5e8e71c7f89a53d7967126f4056dde005534c))
-
-### Fix
-
-* fix(pyqt slot): removed slot decorator to avoid problems with pyqt6 ([`6c1f89a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6c1f89ad39b7240ab1d1c1123422b99ae195bf01))

{bec_widgets-0.109.1 → bec_widgets-0.111.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.109.1
+Version: 0.111.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.109.1 → bec_widgets-0.111.0}/bec_widgets/cli/client.py

@@ -1,5 +1,7 @@
 # This file was automatically generated by generate_cli.py
 
+from __future__ import annotations
+
 import enum
 from typing import Literal, Optional, overload
 
@@ -29,6 +31,7 @@ class Widgets(str, enum.Enum):
     DeviceComboBox = "DeviceComboBox"
     DeviceLineEdit = "DeviceLineEdit"
     LMFitDialog = "LMFitDialog"
+    PositionIndicator = "PositionIndicator"
     PositionerBox = "PositionerBox"
     PositionerControlLine = "PositionerControlLine"
     ResetButton = "ResetButton"
@@ -2539,6 +2542,45 @@ class LMFitDialog(RPCBase):
         """
 
 
+class PositionIndicator(RPCBase):
+    @rpc_call
+    def set_value(self, position: float):
+        """
+        None
+        """
+
+    @rpc_call
+    def set_range(self, min_value: float, max_value: float):
+        """
+        Set the range of the position indicator
+
+        Args:
+            min_value(float): Minimum value of the range
+            max_value(float): Maximum value of the range
+        """
+
+    @property
+    @rpc_call
+    def vertical(self):
+        """
+        Property to determine the orientation of the position indicator
+        """
+
+    @property
+    @rpc_call
+    def indicator_width(self):
+        """
+        Property to get the width of the indicator
+        """
+
+    @property
+    @rpc_call
+    def rounded_corners(self):
+        """
+        Property to get the rounded corners of the position indicator
+        """
+
+
 class PositionerBox(RPCBase):
     @rpc_call
     def set_positioner(self, positioner: "str | Positioner"):

{bec_widgets-0.109.1 → bec_widgets-0.111.0}/bec_widgets/cli/generate_cli.py

@@ -31,6 +31,7 @@ else:
 class ClientGenerator:
     def __init__(self):
         self.header = """# This file was automatically generated by generate_cli.py\n
+from __future__ import annotations
 import enum
 from typing import Literal, Optional, overload
 

bec_widgets-0.111.0/bec_widgets/qt_utils/palette_viewer.py

@@ -0,0 +1,183 @@
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import (
+    QApplication,
+    QFrame,
+    QGridLayout,
+    QHBoxLayout,
+    QLabel,
+    QScrollArea,
+    QSizePolicy,
+    QVBoxLayout,
+    QWidget,
+)
+
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.colors import get_accent_colors, get_theme_palette
+from bec_widgets.widgets.dark_mode_button.dark_mode_button import DarkModeButton
+
+
+class PaletteViewer(BECWidget, QWidget):
+    """
+    This class is a widget that displays current palette colors.
+    """
+
+    ICON_NAME = "palette"
+
+    def __init__(self, *args, parent=None, **kwargs):
+        super().__init__(*args, theme_update=True, **kwargs)
+        QWidget.__init__(self, parent=parent)
+        self.setFixedSize(400, 600)
+        layout = QVBoxLayout(self)
+        dark_mode_button = DarkModeButton(self)
+        layout.addWidget(dark_mode_button)
+
+        # Create a scroll area to hold the color boxes
+        scroll_area = QScrollArea(self)
+        scroll_area.setWidgetResizable(True)
+        scroll_area.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+
+        # Create a frame to hold the color boxes
+        self.frame = QFrame(self)
+        self.frame_layout = QGridLayout(self.frame)
+        self.frame_layout.setSpacing(0)
+        self.frame_layout.setContentsMargins(0, 0, 0, 0)
+
+        scroll_area.setWidget(self.frame)
+        layout.addWidget(scroll_area)
+
+        self.setLayout(layout)
+
+        self.update_palette()
+
+    def apply_theme(self, theme) -> None:
+        """
+        Apply the theme to the widget.
+
+        Args:
+            theme (str): The theme to apply.
+        """
+        self.update_palette()
+
+    def clear_palette(self) -> None:
+        """
+        Clear the palette colors from the frame.
+        Recursively removes all widgets and layouts in the frame layout.
+        """
+        # Iterate over all items in the layout in reverse to safely remove them
+        for i in reversed(range(self.frame_layout.count())):
+            item = self.frame_layout.itemAt(i)
+
+            # If the item is a layout, clear its contents
+            if isinstance(item, QHBoxLayout):
+                # Recursively remove all widgets from the layout
+                for j in reversed(range(item.count())):
+                    widget = item.itemAt(j).widget()
+                    if widget:
+                        item.removeWidget(widget)
+                        widget.deleteLater()
+                self.frame_layout.removeItem(item)
+
+            # If the item is a widget, remove and delete it
+            elif item.widget():
+                widget = item.widget()
+                self.frame_layout.removeWidget(widget)
+                widget.deleteLater()
+
+    def update_palette(self) -> None:
+        """
+        Update the palette colors in the frame.
+        """
+        self.clear_palette()
+        palette_label = QLabel("Palette Colors (e.g. palette.windowText().color())")
+        palette_label.setStyleSheet("font-weight: bold;")
+        self.frame_layout.addWidget(palette_label, 0, 0)
+
+        palette = get_theme_palette()
+        # Add the palette colors (roles) to the frame
+        palette_roles = [
+            palette.windowText,
+            palette.toolTipText,
+            palette.placeholderText,
+            palette.text,
+            palette.buttonText,
+            palette.highlight,
+            palette.link,
+            palette.light,
+            palette.midlight,
+            palette.mid,
+            palette.shadow,
+            palette.button,
+            palette.brightText,
+            palette.toolTipBase,
+            palette.alternateBase,
+            palette.dark,
+            palette.base,
+            palette.window,
+            palette.highlightedText,
+            palette.linkVisited,
+        ]
+
+        offset = 1
+        for i, pal in enumerate(palette_roles):
+            i += offset
+            color = pal().color()
+            label_layout = QHBoxLayout()
+            color_label = QLabel(f"{pal().color().name()} ({pal.__name__})")
+            background_label = self.background_label_with_clipboard(color)
+            label_layout.addWidget(color_label)
+            label_layout.addWidget(background_label)
+            self.frame_layout.addLayout(label_layout, i, 0)
+
+        # add a horizontal spacer
+        spacer = QLabel()
+        spacer.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Minimum)
+        self.frame_layout.addWidget(spacer, i + 1, 0)
+
+        accent_colors_label = QLabel("Accent Colors (e.g. accent_colors.default)")
+        accent_colors_label.setStyleSheet("font-weight: bold;")
+        self.frame_layout.addWidget(accent_colors_label, i + 2, 0)
+
+        accent_colors = get_accent_colors()
+        items = [
+            (accent_colors.default, "default"),
+            (accent_colors.success, "success"),
+            (accent_colors.warning, "warning"),
+            (accent_colors.emergency, "emergency"),
+            (accent_colors.highlight, "highlight"),
+        ]
+
+        offset = len(palette_roles) + 2
+        for i, (color, name) in enumerate(items):
+            i += offset
+            label_layout = QHBoxLayout()
+            color_label = QLabel(f"{color.name()} ({name})")
+            background_label = self.background_label_with_clipboard(color)
+            label_layout.addWidget(color_label)
+            label_layout.addWidget(background_label)
+            self.frame_layout.addLayout(label_layout, i + 2, 0)
+
+    def background_label_with_clipboard(self, color) -> QLabel:
+        """
+        Create a label with a background color that copies the color to the clipboard when clicked.
+
+        Args:
+            color (QColor): The color to display in the background.
+
+        Returns:
+            QLabel: The label with the background color.
+        """
+        button = QLabel()
+        button.setStyleSheet(f"QLabel {{ background-color: {color.name()}; }}")
+        button.setToolTip("Click to copy color to clipboard")
+        button.setCursor(Qt.PointingHandCursor)
+        button.mousePressEvent = lambda event: QApplication.clipboard().setText(color.name())
+        return button
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    app = QApplication(sys.argv)
+    viewer = PaletteViewer()
+    viewer.show()
+    sys.exit(app.exec_())

bec_widgets-0.111.0/bec_widgets/widgets/position_indicator/position_indicator.py

@@ -0,0 +1,291 @@
+import numpy as np
+from qtpy.QtCore import Property, QSize, Qt, Slot
+from qtpy.QtGui import QBrush, QColor, QPainter, QPainterPath, QPen
+from qtpy.QtWidgets import QWidget
+
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.colors import get_accent_colors, get_theme_palette
+
+
+class PositionIndicator(BECWidget, QWidget):
+    USER_ACCESS = ["set_value", "set_range", "vertical", "indicator_width", "rounded_corners"]
+
+    ICON_NAME = "horizontal_distribute"
+
+    def __init__(self, parent=None, client=None, config=None, gui_id=None):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+        self.position = 50
+        self.min_value = 0
+        self.max_value = 100
+        self.scaling_factor = 0.5
+        self.is_vertical = False
+        self._current_indicator_position = 0
+        self._draw_position = 0
+        self._rounded_corners = 10
+        self._indicator_width = 2
+        self._indicator_color = get_accent_colors().success
+        self._background_color = get_theme_palette().mid().color()
+        self._use_color_palette = True
+
+    def set_range(self, min_value: float, max_value: float):
+        """
+        Set the range of the position indicator
+
+        Args:
+            min_value(float): Minimum value of the range
+            max_value(float): Maximum value of the range
+        """
+        self.minimum = min_value
+        self.maximum = max_value
+
+    @Property(float)
+    def minimum(self):
+        """
+        Property to get the minimum value of the position indicator
+        """
+        return self.min_value
+
+    @minimum.setter
+    def minimum(self, min_value: float):
+        """
+        Setter for the minimum property
+
+        Args:
+            min_value: The minimum value of the position indicator
+        """
+        self.min_value = min_value
+        self.update()
+
+    @Property(float)
+    def maximum(self):
+        """
+        Property to get the maximum value of the position indicator
+        """
+        return self.max_value
+
+    @maximum.setter
+    def maximum(self, max_value: float):
+        """
+        Setter for the maximum property
+
+        Args:
+            max_value: The maximum value of the position indicator
+        """
+        self.max_value = max_value
+        self.update()
+
+    @Property(bool)
+    def vertical(self):
+        """
+        Property to determine the orientation of the position indicator
+        """
+        return self.is_vertical
+
+    @vertical.setter
+    def vertical(self, is_vertical: bool):
+        """
+        Setter for the vertical property
+
+        Args:
+            is_vertical: True if the indicator should be vertical, False if horizontal
+        """
+
+        self.is_vertical = is_vertical
+        self.update()
+
+    @Property(float)
+    def value(self):
+        """
+        Property to get the current value of the position indicator
+        """
+        return self.position
+
+    @value.setter
+    def value(self, position: float):
+        """
+        Setter for the value property
+
+        Args:
+            position: The new position of the indicator
+        """
+        self.set_value(position)
+
+    @Property(int)
+    def indicator_width(self):
+        """
+        Property to get the width of the indicator
+        """
+        return self._indicator_width
+
+    @indicator_width.setter
+    def indicator_width(self, width: int):
+        """
+        Setter for the indicator width property
+
+        Args:
+            width: The new width of the indicator
+        """
+        self._indicator_width = width
+        self.update()
+
+    @Property(int)
+    def rounded_corners(self):
+        """
+        Property to get the rounded corners of the position indicator
+        """
+        return self._rounded_corners
+
+    @rounded_corners.setter
+    def rounded_corners(self, value: int):
+        """
+        Setter for the rounded corners property
+
+        Args:
+            value: The new value for the rounded corners
+        """
+        self._rounded_corners = value
+        self.update()
+
+    @Property(QColor)
+    def indicator_color(self):
+        """
+        Property to get the color of the indicator
+        """
+        return self._indicator_color
+
+    @indicator_color.setter
+    def indicator_color(self, color: QColor):
+        """
+        Setter for the indicator color property
+
+        Args:
+            color: The new color for the indicator
+        """
+        self._indicator_color = color
+        self.update()
+
+    @Property(QColor)
+    def background_color(self):
+        """
+        Property to get the background color of the position indicator
+        """
+        return self._background_color
+
+    @background_color.setter
+    def background_color(self, color: QColor):
+        """
+        Setter for the background color property
+
+        Args:
+            color: The new background color
+        """
+        self._background_color = color
+        self.update()
+
+    @Property(bool)
+    def use_color_palette(self):
+        """
+        Property to determine if the indicator should use the color palette or the custom color.
+        """
+        return self._use_color_palette
+
+    @use_color_palette.setter
+    def use_color_palette(self, use_palette: bool):
+        """
+        Setter for the use color palette property
+
+        Args:
+            use_palette: True if the indicator should use the color palette, False if custom color
+        """
+        self._use_color_palette = use_palette
+        self.update()
+
+    # @Property(float)
+    @Slot(int)
+    @Slot(float)
+    def set_value(self, position: float):
+        self.position = position
+        self.update()
+
+    def _get_indicator_color(self):
+        if self._use_color_palette:
+            return get_accent_colors().success
+        return self._indicator_color
+
+    def _get_background_brush(self):
+        if self._use_color_palette:
+            return get_theme_palette().mid()
+        return QBrush(self._background_color)
+
+    def paintEvent(self, event):
+        painter = QPainter(self)
+        width = self.width()
+        height = self.height()
+
+        # Set up the brush for the background
+        painter.setBrush(self._get_background_brush())
+
+        # Create a QPainterPath with a rounded rectangle for clipping
+        path = QPainterPath()
+        path.addRoundedRect(0, 0, width, height, self._rounded_corners, self._rounded_corners)
+
+        # Set clipping to the rounded rectangle
+        painter.setClipPath(path)
+
+        # Draw the rounded rectangle background first
+        painter.setPen(Qt.NoPen)
+        painter.drawRoundedRect(0, 0, width, height, self._rounded_corners, self._rounded_corners)
+
+        # get the position scaled to the defined min and max values
+        self._current_indicator_position = position = np.interp(
+            self.position, [self.min_value, self.max_value], [0, 100]
+        )
+
+        if self.is_vertical:
+            # If vertical, rotate the coordinate system by -90 degrees
+            painter.translate(width // 2, height // 2)  # Move origin to center
+            painter.rotate(-90)  # Rotate by -90 degrees for vertical drawing
+            painter.translate(-height // 2, -width // 2)  # Restore the origin for drawing
+
+            # Switch width and height for the vertical orientation
+            width, height = height, width
+
+        # Draw the moving vertical indicator, respecting the clip path
+        self._draw_position = x_pos = round(
+            position * width / 100
+        )  # Position for the vertical line
+
+        indicator_pen = QPen(self._get_indicator_color(), self._indicator_width)
+        painter.setPen(indicator_pen)
+        painter.drawLine(x_pos, 0, x_pos, height)
+
+        painter.end()
+
+    def minimumSizeHint(self):
+        # Set the smallest possible size
+        return QSize(10, 10)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    from bec_qthemes import setup_theme
+    from qtpy.QtWidgets import QApplication, QSlider, QVBoxLayout
+
+    app = QApplication([])
+    setup_theme("dark")
+    # Create position indicator and slider
+    position_indicator = PositionIndicator()
+    # position_indicator.set_range(0, 1)
+    slider = QSlider(Qt.Horizontal)
+    slider.valueChanged.connect(lambda value: position_indicator.set_value(value))
+    position_indicator.is_vertical = False
+    # position_indicator.set_value(100)
+    layout = QVBoxLayout()
+    layout.addWidget(position_indicator)
+    layout.addWidget(slider)
+
+    widget = QWidget()
+    widget.setLayout(layout)
+    widget.show()
+
+    app.exec_()

{bec_widgets-0.109.1 → bec_widgets-0.111.0}/bec_widgets/widgets/positioner_box/positioner_box.py

@@ -16,7 +16,7 @@ from qtpy.QtWidgets import QDialog, QDoubleSpinBox, QPushButton, QVBoxLayout, QW
 
 from bec_widgets.utils import UILoader
 from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.utils.colors import set_theme
+from bec_widgets.utils.colors import get_accent_colors, set_theme
 from bec_widgets.widgets.device_line_edit.device_line_edit import DeviceLineEdit
 
 logger = bec_logger.logger
@@ -73,6 +73,10 @@ class PositionerBox(BECWidget, QWidget):
 
         self.ui.step_size.setStepType(QDoubleSpinBox.AdaptiveDecimalStepType)
         self.ui.stop.clicked.connect(self.on_stop)
+        self.ui.stop.setToolTip("Stop")
+        self.ui.stop.setStyleSheet(
+            f"QPushButton {{background-color: {get_accent_colors().emergency.name()}; color: white;}}"
+        )
         self.ui.tweak_right.clicked.connect(self.on_tweak_right)
         self.ui.tweak_right.setToolTip("Tweak right")
         self.ui.tweak_left.clicked.connect(self.on_tweak_left)
@@ -249,7 +253,7 @@ class PositionerBox(BECWidget, QWidget):
         self.update_limits(limits)
         if limits is not None and readback_val is not None and limits[0] != limits[1]:
             pos = (readback_val - limits[0]) / (limits[1] - limits[0])
-            self.ui.position_indicator.on_position_update(pos)
+            self.ui.position_indicator.set_value(pos)
 
     def update_limits(self, limits: tuple):
         """Update limits

{bec_widgets-0.109.1 → bec_widgets-0.111.0}/bec_widgets/widgets/positioner_box/positioner_box.ui

@@ -170,7 +170,20 @@
          </layout>
         </item>
         <item>
-         <widget class="PositionIndicator" name="position_indicator"/>
+         <widget class="PositionIndicator" name="position_indicator">
+          <property name="maximum" stdset="0">
+           <double>1.000000000000000</double>
+          </property>
+          <property name="value" stdset="0">
+           <double>0.500000000000000</double>
+          </property>
+          <property name="indicator_width" stdset="0">
+           <number>4</number>
+          </property>
+          <property name="rounded_corners" stdset="0">
+           <number>4</number>
+          </property>
+         </widget>
         </item>
         <item>
          <widget class="QLabel" name="readback">

{bec_widgets-0.109.1 → bec_widgets-0.111.0}/bec_widgets/widgets/positioner_box/positioner_control_line.py

@@ -24,11 +24,9 @@ class PositionerControlLine(PositionerBox):
 if __name__ == "__main__":  # pragma: no cover
     import sys
 
-    import qdarktheme
     from qtpy.QtWidgets import QApplication
 
     app = QApplication(sys.argv)
-    qdarktheme.setup_theme("dark")
     widget = PositionerControlLine(device="samy")
 
     widget.show()