bec-widgets 0.109.0__tar.gz → 0.110.0__tar.gz

{bec_widgets-0.109.0 → bec_widgets-0.110.0}/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 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
+
+* fix: refactor textbox widget, remove inheritance, adhere to bec style; closes #324 ([`b0d786b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b0d786b991677c0846a0c6ba3f2252d48d94ccaa))
+
 ## v0.109.0 (2024-09-06)
 
 ### Feature
@@ -149,17 +161,3 @@
 * 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))
-
-### Feature
-
-* feat(theme): added theme handler to bec widget base class; added tests ([`7fb938a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7fb938a8506685278ee5eeb6fe9a03f74b713cf8))
-
-### Fix
-
-* fix(pyqt slot): removed slot decorator to avoid problems with pyqt6 ([`6c1f89a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6c1f89ad39b7240ab1d1c1123422b99ae195bf01))
-
-## v0.99.15 (2024-08-31)

{bec_widgets-0.109.0 → bec_widgets-0.110.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.109.0
+Version: 0.110.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.0 → bec_widgets-0.110.0}/bec_widgets/cli/client.py

@@ -2914,31 +2914,21 @@ class StopButton(RPCBase):
 
 class TextBox(RPCBase):
     @rpc_call
-    def set_color(self, background_color: str, font_color: str) -> None:
+    def set_plain_text(self, text: str) -> None:
         """
-        Set the background color of the widget.
-
-        Args:
-            background_color (str): The color to set the background in HEX.
-            font_color (str): The color to set the font in HEX.
-        """
-
-    @rpc_call
-    def set_text(self, text: str) -> None:
-        """
-        Set the text of the widget.
+        Set the plain text of the widget.
 
         Args:
             text (str): The text to set.
         """
 
     @rpc_call
-    def set_font_size(self, size: int) -> None:
+    def set_html_text(self, text: str) -> None:
         """
-        Set the font size of the text in the widget.
+        Set the HTML text of the widget.
 
         Args:
-            size (int): The font size to set.
+            text (str): The text to set.
         """
 
 

bec_widgets-0.110.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"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.110.0/bec_widgets/widgets/text_box/text_box.py

@@ -0,0 +1,135 @@
+"""Module for a text box widget that displays text in plain and HTML format and adheres to the BECWidget interface & style."""
+
+import re
+from html.parser import HTMLParser
+
+from bec_lib.logger import bec_logger
+from pydantic import Field
+from qtpy.QtCore import Property, Slot
+from qtpy.QtWidgets import QTextEdit, QVBoxLayout, QWidget
+
+from bec_widgets.utils.bec_connector import ConnectionConfig
+from bec_widgets.utils.bec_widget import BECWidget
+
+logger = bec_logger.logger
+
+DEFAULT_TEXT = "<h1>Welcome to the BEC Widget TextBox</h1><p>A widget that allows user to display text in plain and HTML format.</p><p>This is an example of displaying HTML text.</p>"
+
+
+class TextBoxConfig(ConnectionConfig):
+    """Configuration for the TextBox widget.
+
+    Args:
+        text (str, optional): The text to display in the widget. Defaults to None.
+        is_html (bool, optional): Whether the text is in HTML format or not. Defaults to False.
+    """
+
+    text: str | None = Field(None, description="The text to display in the widget.")
+    is_html: bool = Field(False, description="Whether the text is in HTML format or not.")
+
+
+class TextBox(BECWidget, QWidget):
+    """A widget that displays text in plain and HTML format
+
+    Args:
+        parent (QWidget, optional): The parent widget. Defaults to None.
+        client ([type], optional): The client to use. Defaults to None.
+        config ([type], optional): The config to use. Defaults to None.
+        gui_id ([type], optional): The gui_id to use. Defaults to None.
+    """
+
+    USER_ACCESS = ["set_plain_text", "set_html_text"]
+    ICON_NAME = "chat"
+
+    def __init__(self, parent=None, client=None, config=None, gui_id=None):
+        if config is None:
+            config = TextBoxConfig(widget_class=self.__class__.__name__)
+        else:
+            if isinstance(config, dict):
+                config = TextBoxConfig(**config)
+            self.config = config
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent)
+        self.layout = QVBoxLayout(self)
+        self.text_box_text_edit = QTextEdit(parent=self)
+        self.layout.addWidget(self.text_box_text_edit)
+        self.setLayout(self.layout)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+        self.config = config
+        self.text_box_text_edit.setReadOnly(True)
+        if self.config.text is not None:
+            if self.config.is_html:
+                self.set_html_text(self.config.text)
+            else:
+                self.set_plain_text(self.config.text)
+        else:
+            self.set_html_text(DEFAULT_TEXT)
+
+    @Slot(str)
+    def set_plain_text(self, text: str) -> None:
+        """Set the plain text of the widget.
+
+        Args:
+            text (str): The text to set.
+        """
+        self.text_box_text_edit.setPlainText(text)
+        self.config.text = text
+        self.config.is_html = False
+
+    @Slot(str)
+    def set_html_text(self, text: str) -> None:
+        """Set the HTML text of the widget.
+
+        Args:
+            text (str): The text to set.
+        """
+        self.text_box_text_edit.setHtml(text)
+        self.config.text = text
+        self.config.is_html = True
+
+    @Property(str)
+    def plain_text(self) -> str:
+        """Get the text of the widget.
+
+        Returns:
+            str: The text of the widget.
+        """
+        return self.text_box_text_edit.toPlainText()
+
+    @plain_text.setter
+    def plain_text(self, text: str) -> None:
+        """Set the text of the widget.
+
+        Args:
+            text (str): The text to set.
+        """
+        self.set_plain_text(text)
+
+    @Property(str)
+    def html_text(self) -> str:
+        """Get the HTML text of the widget.
+
+        Returns:
+            str: The HTML text of the widget.
+        """
+        return self.text_box_text_edit.toHtml()
+
+    @html_text.setter
+    def html_text(self, text: str) -> None:
+        """Set the HTML text of the widget.
+
+        Args:
+            text (str): The HTML text to set.
+        """
+        self.set_html_text(text)
+
+
+if __name__ == "__main__":
+    import sys
+
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication(sys.argv)
+    widget = TextBox()
+    widget.show()
+    sys.exit(app.exec())

{bec_widgets-0.109.0 → bec_widgets-0.110.0}/pyproject.toml

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

bec_widgets-0.109.0/bec_widgets/widgets/text_box/text_box.py

@@ -1,129 +0,0 @@
-import re
-
-from pydantic import Field, field_validator
-from qtpy.QtWidgets import QTextEdit
-
-from bec_widgets.utils.bec_connector import ConnectionConfig
-from bec_widgets.utils.bec_widget import BECWidget
-from bec_widgets.utils.colors import Colors
-
-
-class TextBoxConfig(ConnectionConfig):
-
-    theme: str = Field("dark", description="The theme of the figure widget.")
-    font_color: str = Field("#FFF", description="The font color of the text")
-    background_color: str = Field("#000", description="The background color of the widget.")
-    font_size: int = Field(16, description="The font size of the text in the widget.")
-    text: str = Field("", description="The text to display in the widget.")
-
-    @classmethod
-    @field_validator("theme")
-    def validate_theme(cls, v):
-        """Validate the theme of the figure widget."""
-        if v not in ["dark", "light"]:
-            raise ValueError("Theme must be either 'dark' or 'light'")
-        return v
-
-    _validate_font_color = field_validator("font_color")(Colors.validate_color)
-    _validate_background_color = field_validator("background_color")(Colors.validate_color)
-
-
-class TextBox(BECWidget, QTextEdit):
-
-    USER_ACCESS = ["set_color", "set_text", "set_font_size"]
-    ICON_NAME = "chat"
-
-    def __init__(self, parent=None, text: str = "", client=None, config=None, gui_id=None):
-        if config is None:
-            config = TextBoxConfig(widget_class=self.__class__.__name__)
-        else:
-            if isinstance(config, dict):
-                config = TextBoxConfig(**config)
-            self.config = config
-        super().__init__(client=client, config=config, gui_id=gui_id)
-        QTextEdit.__init__(self, parent=parent)
-
-        self.config = config
-        self.setReadOnly(True)
-        self.setGeometry(self.rect())
-        self.set_color(self.config.background_color, self.config.font_color)
-        if not text:
-            text = "<h1>Welcome to the BEC Widget TextBox</h1><p>A widget that allows user to display text in plain and HTML format.</p><p>This is an example of displaying HTML text.</p>"
-        self.set_text(text)
-
-    def change_theme(self) -> None:
-        """
-        Change the theme of the figure widget.
-        """
-        if self.config.theme == "dark":
-            theme = "light"
-            font_color = "#000"
-            background_color = "#FFF"
-        else:
-            theme = "dark"
-            font_color = "#FFF"
-            background_color = "#000"
-        self.config.theme = theme
-        self.set_color(background_color, font_color)
-
-    def set_color(self, background_color: str, font_color: str) -> None:
-        """Set the background color of the widget.
-
-        Args:
-            background_color (str): The color to set the background in HEX.
-            font_color (str): The color to set the font in HEX.
-
-        """
-        self.config.background_color = background_color
-        self.config.font_color = font_color
-        self._update_stylesheet()
-
-    def set_font_size(self, size: int) -> None:
-        """Set the font size of the text in the widget.
-
-        Args:
-            size (int): The font size to set.
-        """
-        self.config.font_size = size
-        self._update_stylesheet()
-
-    def _update_stylesheet(self):
-        """Update the stylesheet of the widget."""
-        self.setStyleSheet(
-            f"background-color: {self.config.background_color}; color: {self.config.font_color}; font-size: {self.config.font_size}px"
-        )
-
-    def set_text(self, text: str) -> None:
-        """Set the text of the widget.
-
-        Args:
-            text (str): The text to set.
-        """
-        if self.is_html(text):
-            self.setHtml(text)
-        else:
-            self.setPlainText(text)
-        self.config.text = text
-
-    def is_html(self, text: str) -> bool:
-        """Check if the text contains HTML tags.
-
-        Args:
-            text (str): The text to check.
-
-        Returns:
-            bool: True if the text contains HTML tags, False otherwise.
-        """
-        return bool(re.search(r"<[a-zA-Z/][^>]*>", text))
-
-
-if __name__ == "__main__":
-    import sys
-
-    from qtpy.QtWidgets import QApplication
-
-    app = QApplication(sys.argv)
-
-    widget = TextBox()
-    widget.show()
-    sys.exit(app.exec())