bec-widgets 1.14.1__py3-none-any.whl → 1.15.0__py3-none-any.whl

CHANGELOG.md

@@ -1,6 +1,17 @@
 # CHANGELOG
 
 
+## v1.15.0 (2025-01-10)
+
+### Features
+
+- **widget_state_manager**: Example app added
+  ([`a00d368`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a00d368c25a19b04d6fbc8a07cff330d1a232e21))
+
+- **widget_state_manager**: State manager for single widget
+  ([`01b4608`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/01b4608331f375aeeeb692328b693f2d2802dc9c))
+
+
 ## v1.14.1 (2025-01-10)
 
 ### Bug Fixes

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.14.1
+Version: 1.15.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/utils/widget_state_manager.py

@@ -0,0 +1,151 @@
+from __future__ import annotations
+
+from qtpy.QtCore import QSettings
+from qtpy.QtWidgets import (
+    QApplication,
+    QCheckBox,
+    QFileDialog,
+    QHBoxLayout,
+    QLineEdit,
+    QPushButton,
+    QSpinBox,
+    QVBoxLayout,
+    QWidget,
+)
+
+
+class WidgetStateManager:
+    """
+    A class to manage the state of a widget by saving and loading the state to and from a INI file.
+
+    Args:
+        widget(QWidget): The widget to manage the state for.
+    """
+
+    def __init__(self, widget):
+        self.widget = widget
+
+    def save_state(self, filename: str = None):
+        """
+        Save the state of the widget to a INI file.
+
+        Args:
+            filename(str): The filename to save the state to.
+        """
+        if not filename:
+            filename, _ = QFileDialog.getSaveFileName(
+                self.widget, "Save Settings", "", "INI Files (*.ini)"
+            )
+        if filename:
+            settings = QSettings(filename, QSettings.IniFormat)
+            self._save_widget_state_qsettings(self.widget, settings)
+
+    def load_state(self, filename: str = None):
+        """
+        Load the state of the widget from a INI file.
+
+        Args:
+            filename(str): The filename to load the state from.
+        """
+        if not filename:
+            filename, _ = QFileDialog.getOpenFileName(
+                self.widget, "Load Settings", "", "INI Files (*.ini)"
+            )
+        if filename:
+            settings = QSettings(filename, QSettings.IniFormat)
+            self._load_widget_state_qsettings(self.widget, settings)
+
+    def _save_widget_state_qsettings(self, widget: QWidget, settings: QSettings):
+        """
+        Save the state of the widget to QSettings.
+
+        Args:
+            widget(QWidget): The widget to save the state for.
+            settings(QSettings): The QSettings object to save the state to.
+        """
+        meta = widget.metaObject()
+        settings.beginGroup(widget.objectName())
+        for i in range(meta.propertyCount()):
+            prop = meta.property(i)
+            name = prop.name()
+            value = widget.property(name)
+            settings.setValue(name, value)
+        settings.endGroup()
+
+        # Recursively save child widgets
+        for child in widget.findChildren(QWidget):
+            if child.objectName():
+                self._save_widget_state_qsettings(child, settings)
+
+    def _load_widget_state_qsettings(self, widget: QWidget, settings: QSettings):
+        """
+        Load the state of the widget from QSettings.
+
+        Args:
+            widget(QWidget): The widget to load the state for.
+            settings(QSettings): The QSettings object to load the state from.
+        """
+        meta = widget.metaObject()
+        settings.beginGroup(widget.objectName())
+        for i in range(meta.propertyCount()):
+            prop = meta.property(i)
+            name = prop.name()
+            if settings.contains(name):
+                value = settings.value(name)
+                widget.setProperty(name, value)
+        settings.endGroup()
+
+        # Recursively load child widgets
+        for child in widget.findChildren(QWidget):
+            if child.objectName():
+                self._load_widget_state_qsettings(child, settings)
+
+
+class ExampleApp(QWidget):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self.setObjectName("MainWindow")
+        self.setWindowTitle("State Manager Example")
+
+        layout = QVBoxLayout(self)
+
+        # A line edit to store some user text
+        self.line_edit = QLineEdit(self)
+        self.line_edit.setObjectName("MyLineEdit")
+        self.line_edit.setPlaceholderText("Enter some text here...")
+        layout.addWidget(self.line_edit)
+
+        # A spin box to hold a numeric value
+        self.spin_box = QSpinBox(self)
+        self.spin_box.setObjectName("MySpinBox")
+        self.spin_box.setRange(0, 100)
+        layout.addWidget(self.spin_box)
+
+        # A checkbox to hold a boolean value
+        self.check_box = QCheckBox("Enable feature?", self)
+        self.check_box.setObjectName("MyCheckBox")
+        layout.addWidget(self.check_box)
+
+        # Buttons to save and load state
+        button_layout = QHBoxLayout()
+        self.save_button = QPushButton("Save State", self)
+        self.load_button = QPushButton("Load State", self)
+        button_layout.addWidget(self.save_button)
+        button_layout.addWidget(self.load_button)
+        layout.addLayout(button_layout)
+
+        # Create the state manager
+        self.state_manager = WidgetStateManager(self)
+
+        # Connect buttons
+        self.save_button.clicked.connect(lambda: self.state_manager.save_state())
+        self.load_button.clicked.connect(lambda: self.state_manager.load_state())
+
+
+if __name__ == "__main__":  # pragma: no cover:
+    import sys
+
+    app = QApplication(sys.argv)
+    w = ExampleApp()
+    w.show()
+    sys.exit(app.exec_())

{bec_widgets-1.14.1.dist-info → bec_widgets-1.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.14.1
+Version: 1.15.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-1.14.1.dist-info → bec_widgets-1.15.0.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=CLlFGYRGKp4FxCPTkyF9p-7qx67KmbM9Yok9JQEU_Ls,8677
 .pylintrc,sha256=eeY8YwSI74oFfq6IYIbCqnx3Vk8ZncKaatv96n_Y8Rs,18544
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=FFvwVqBUD_q2IiMmx4HdvyGB5NKM2DG0Tkcfcy_9reE,220975
+CHANGELOG.md,sha256=849MrBPqJXJ8uZuRcBjlPsxjve-_HmdJgibe27FENaQ,221333
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=NtdzzO4MGjNTXBbNulluYh__nOLWcQX820P88EixW30,1339
+PKG-INFO,sha256=yGSseM2wz5VSWKYD2XZ9RLsaXmX7WMfNwjh-HWMkJwE,1339
 README.md,sha256=Od69x-RS85Hph0-WwWACwal4yUd67XkEn4APEfHhHFw,2649
-pyproject.toml,sha256=a_6QuEHoaPGQEUAHvY24XelSuVDR_Df6wf0IAftbEvg,2596
+pyproject.toml,sha256=1cn7PLlXgQgF3kW2-a6mRnuCb4SD0wTYspJB2CLTE0A,2596
 .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
@@ -83,6 +83,7 @@ bec_widgets/utils/thread_checker.py,sha256=rDNuA3X6KQyA7JPb67mccTg0z8YkInynLAENQ
 bec_widgets/utils/ui_loader.py,sha256=6z0Qvt99XWoIk_YMACShwQ1p7PbDh6uJ9wS6e2wZs0w,4878
 bec_widgets/utils/validator_delegate.py,sha256=Emj1WF6W8Ke1ruBWUfmHdVJpmOSPezuOt4zvQTay_44,442
 bec_widgets/utils/widget_io.py,sha256=R-ZYQyEVigHNH1AD4cNYmCV1DoO0XNidTZpiCSSND2c,15232
+bec_widgets/utils/widget_state_manager.py,sha256=dtObn3xRY5mVTnkGTQDOPsAwkQ18pXJwYPgtCdRpKtc,4920
 bec_widgets/utils/yaml_dialog.py,sha256=T6UyGNGdmpXW74fa_7Nk6b99T5pp2Wvyw3AOauRc8T8,2407
 bec_widgets/utils/plugin_templates/plugin.template,sha256=DWtJdHpdsVtbiTTOniH3zBe5a40ztQ20o_-Hclyu38s,1266
 bec_widgets/utils/plugin_templates/register.template,sha256=XyL3OZPT_FTArLAM8tHd5qMqv2ZuAbJAZLsNNnHcagU,417
@@ -325,8 +326,8 @@ bec_widgets/widgets/utility/visual/dark_mode_button/dark_mode_button.py,sha256=Z
 bec_widgets/widgets/utility/visual/dark_mode_button/dark_mode_button.pyproject,sha256=Lbi9zb6HNlIq14k6hlzR-oz6PIFShBuF7QxE6d87d64,34
 bec_widgets/widgets/utility/visual/dark_mode_button/dark_mode_button_plugin.py,sha256=CzChz2SSETYsR8-36meqWnsXCT-FIy_J_xeU5coWDY8,1350
 bec_widgets/widgets/utility/visual/dark_mode_button/register_dark_mode_button.py,sha256=rMpZ1CaoucwobgPj1FuKTnt07W82bV1GaSYdoqcdMb8,521
-bec_widgets-1.14.1.dist-info/METADATA,sha256=NtdzzO4MGjNTXBbNulluYh__nOLWcQX820P88EixW30,1339
-bec_widgets-1.14.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-bec_widgets-1.14.1.dist-info/entry_points.txt,sha256=dItMzmwA1wizJ1Itx15qnfJ0ZzKVYFLVJ1voxT7K7D4,214
-bec_widgets-1.14.1.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-1.14.1.dist-info/RECORD,,
+bec_widgets-1.15.0.dist-info/METADATA,sha256=yGSseM2wz5VSWKYD2XZ9RLsaXmX7WMfNwjh-HWMkJwE,1339
+bec_widgets-1.15.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+bec_widgets-1.15.0.dist-info/entry_points.txt,sha256=dItMzmwA1wizJ1Itx15qnfJ0ZzKVYFLVJ1voxT7K7D4,214
+bec_widgets-1.15.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-1.15.0.dist-info/RECORD,,

pyproject.toml

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