Merge pull request qgis#59014 from 3nids/settings.fup.2

python implementation of enum settings editor widget wrapper  + fix crash

Author: 3nids

python/PyQt6/core/additions/qgssettingsentry.py

@@ -59,6 +59,15 @@ def __init__(self, key, pluginName, defaultValue, description=str(), options=Qgi
             parent = pluginName
         super().__init__(key, parent, defaultValueStr, description, options)
 
+    def metaEnum(self):
+        return self.__metaEnum
+
+    def typeId(self):
+        """
+        Defines a custom id since this class has not the same API as the cpp implementation
+        """
+        return "py-enumflag"
+
     def value(self, dynamicKeyPart=None):
         """
         Get settings value.
@@ -138,5 +147,4 @@ def settingsType(self):
         """
         Get the settings entry type.
         """
-
         return self.SettingsType.EnumFlag

python/PyQt6/gui/__init__.py.in

@@ -24,6 +24,7 @@ __copyright__ = '(C) 2014, Nathan Woodrow'
 from qgis.PyQt import QtCore
 from qgis._gui import *
 from qgis.core import Qgis as _Qgis
+from .additions.qgssettingsenumflageditorwrapper import PyQgsSettingsEnumEditorWidgetWrapper
 
 @MONKEYPATCH_INJECTIONS@
 
@@ -76,3 +77,6 @@ QgsMapLayerAction.EnabledOnlyWhenEditable = _Qgis.MapLayerActionFlag.EnabledOnly
 QgsMapLayerAction.EnabledOnlyWhenEditable.is_monkey_patched = True
 QgsMapLayerAction.EnabledOnlyWhenEditable.__doc__ = "Action should be shown only for editable layers"
 QgsMapLayerAction.Flags = _Qgis.MapLayerActionFlags
+
+# Classes patched
+QgsSettingsEnumEditorWidgetWrapper = PyQgsSettingsEnumEditorWidgetWrapper

python/PyQt6/gui/additions/qgssettingsenumflageditorwrapper.py

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+
+"""
+***************************************************************************
+    qgssettingsenumflageditorwrapper.py
+    ---------------------
+    Date                 : October 2024
+    Copyright            : (C) 2021 by Denis Rouzaud
+    Email                : [email protected]
+***************************************************************************
+*                                                                         *
+*   This program is free software; you can redistribute it and/or modify  *
+*   it under the terms of the GNU General Public License as published by  *
+*   the Free Software Foundation; either version 2 of the License, or     *
+*   (at your option) any later version.                                   *
+*                                                                         *
+***************************************************************************
+"""
+
+from qgis.PyQt.QtWidgets import QWidget, QComboBox
+
+from qgis.core import QgsSettingsEntryBase
+from qgis.gui import QgsSettingsEditorWidgetWrapper
+
+
+class PyQgsSettingsEnumEditorWidgetWrapper(QgsSettingsEditorWidgetWrapper):
+    """
+    A settings editor widget wrapper for enum settings as PyQgsSettingsEntryEnumFlag
+    """
+
+    def __init__(self, parent=None, editor=None, setting=None, displayStrings: dict = None):
+        self.setting = setting
+        self.editor = editor
+        self.displayStrings = {}
+        super().__init__(parent)
+        if editor is not None and setting is not None:
+            if displayStrings:
+                self.displayStrings = displayStrings
+            self.configureEditor(editor, setting)
+
+    def id(self):
+        return 'py-enum'
+
+    def createWrapper(self, parent=None):
+        return PyQgsSettingsEnumEditorWidgetWrapper(parent)
+
+    def setWidgetFromSetting(self):
+        if self.setting:
+            return self.setWidgetFromVariant(self.setting.value(self.dynamicKeyPartList()))
+        return False
+
+    def setSettingFromWidget(self):
+        if self.editor:
+            self.setting.setValue(self.variantValueFromWidget(), self.dynamicKeyPartList())
+            return True
+        else:
+            return False
+
+    def variantValueFromWidget(self):
+        if self.editor:
+            return self.setting.defaultValue().__class__(self.editor.currentData())
+        return None
+
+    def setWidgetFromVariant(self, value):
+        if self.editor:
+            idx = self.editor.findData(value)
+            self.editor.setCurrentIndex(idx)
+            return idx >= 0
+        return False
+
+    def createEditorPrivate(self, parent=None):
+        return QComboBox(parent)
+
+    def configureEditorPrivate(self, editor: QWidget, setting: QgsSettingsEntryBase):
+        self.setting = setting
+        if isinstance(editor, QComboBox):
+            self.editor = editor
+            for i in range(self.setting.metaEnum().keyCount()):
+                value = self.setting.metaEnum().value(i)
+                key = self.setting.metaEnum().key(i)
+                text = self.displayStrings.get(value, key)
+                self.editor.addItem(text, value)
+            return True
+        else:
+            return False
+
+    def enableAutomaticUpdatePrivate(self):
+        self.editor.currentIndexChanged.connect(
+            lambda: self.setting.setValue(self.editor.currentData(), self.dynamicKeyPartList()))

python/PyQt6/gui/auto_generated/settings/qgssettingseditorwidgetwrapper.sip.in

@@ -94,6 +94,13 @@ If not, the setting will be updated directly at each widget value change.
 
    This must called after :py:func:`~QgsSettingsEditorWidgetWrapper.createEditor` or :py:func:`~QgsSettingsEditorWidgetWrapper.configureEditor`.
 
+.. versionadded:: 3.40
+%End
+
+    QStringList dynamicKeyPartList() const;
+%Docstring
+Returns the dynamic key parts
+
 .. versionadded:: 3.40
 %End
 

python/core/additions/qgssettingsentry.py

@@ -59,6 +59,15 @@ def __init__(self, key, pluginName, defaultValue, description=str(), options=Qgi
             parent = pluginName
         super().__init__(key, parent, defaultValueStr, description, options)
 
+    def metaEnum(self):
+        return self.__metaEnum
+
+    def typeId(self):
+        """
+        Defines a custom id since this class has not the same API as the cpp implementation
+        """
+        return "py-enumflag"
+
     def value(self, dynamicKeyPart=None):
         """
         Get settings value.
@@ -138,5 +147,4 @@ def settingsType(self):
         """
         Get the settings entry type.
         """
-
         return self.SettingsType.EnumFlag

python/gui/__init__.py.in

@@ -24,6 +24,7 @@ __copyright__ = '(C) 2014, Nathan Woodrow'
 from qgis.PyQt import QtCore
 from qgis._gui import *
 from qgis.core import Qgis as _Qgis
+from .additions.qgssettingsenumflageditorwrapper import PyQgsSettingsEnumEditorWidgetWrapper
 
 @MONKEYPATCH_INJECTIONS@
 
@@ -83,3 +84,6 @@ QgsSettingsBoolEditorWidgetWrapper = QgsSettingsBoolCheckBoxWrapper
 QgsSettingsIntegerEditorWidgetWrapper = QgsSettingsIntegerSpinBoxWrapper
 QgsSettingsDoubleEditorWidgetWrapper = QgsSettingsDoubleSpinBoxWrapper
 QgsSettingsColorEditorWidgetWrapper = QgsSettingsColorButtonWrapper
+
+# Classes patched
+QgsSettingsEnumEditorWidgetWrapper = PyQgsSettingsEnumEditorWidgetWrapper

python/gui/additions/qgssettingsenumflageditorwrapper.py

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+
+"""
+***************************************************************************
+    qgssettingsenumflageditorwrapper.py
+    ---------------------
+    Date                 : October 2024
+    Copyright            : (C) 2021 by Denis Rouzaud
+    Email                : [email protected]
+***************************************************************************
+*                                                                         *
+*   This program is free software; you can redistribute it and/or modify  *
+*   it under the terms of the GNU General Public License as published by  *
+*   the Free Software Foundation; either version 2 of the License, or     *
+*   (at your option) any later version.                                   *
+*                                                                         *
+***************************************************************************
+"""
+
+from qgis.PyQt.QtWidgets import QWidget, QComboBox
+
+from qgis.core import QgsSettingsEntryBase
+from qgis.gui import QgsSettingsEditorWidgetWrapper
+
+
+class PyQgsSettingsEnumEditorWidgetWrapper(QgsSettingsEditorWidgetWrapper):
+    """
+    A settings editor widget wrapper for enum settings as PyQgsSettingsEntryEnumFlag
+    """
+
+    def __init__(self, parent=None, editor=None, setting=None, displayStrings: dict = None):
+        self.setting = setting
+        self.editor = editor
+        self.displayStrings = {}
+        super().__init__(parent)
+        if editor is not None and setting is not None:
+            if displayStrings:
+                self.displayStrings = displayStrings
+            self.configureEditor(editor, setting)
+
+    def id(self):
+        return 'py-enum'
+
+    def createWrapper(self, parent=None):
+        return PyQgsSettingsEnumEditorWidgetWrapper(parent)
+
+    def setWidgetFromSetting(self):
+        if self.setting:
+            return self.setWidgetFromVariant(self.setting.value(self.dynamicKeyPartList()))
+        return False
+
+    def setSettingFromWidget(self):
+        if self.editor:
+            self.setting.setValue(self.variantValueFromWidget(), self.dynamicKeyPartList())
+            return True
+        else:
+            return False
+
+    def variantValueFromWidget(self):
+        if self.editor:
+            return self.setting.defaultValue().__class__(self.editor.currentData())
+        return None
+
+    def setWidgetFromVariant(self, value):
+        if self.editor:
+            idx = self.editor.findData(value)
+            self.editor.setCurrentIndex(idx)
+            return idx >= 0
+        return False
+
+    def createEditorPrivate(self, parent=None):
+        return QComboBox(parent)
+
+    def configureEditorPrivate(self, editor: QWidget, setting: QgsSettingsEntryBase):
+        self.setting = setting
+        if isinstance(editor, QComboBox):
+            self.editor = editor
+            for i in range(self.setting.metaEnum().keyCount()):
+                value = self.setting.metaEnum().value(i)
+                key = self.setting.metaEnum().key(i)
+                text = self.displayStrings.get(value, key)
+                self.editor.addItem(text, value)
+            return True
+        else:
+            return False
+
+    def enableAutomaticUpdatePrivate(self):
+        self.editor.currentIndexChanged.connect(
+            lambda: self.setting.setValue(self.editor.currentData(), self.dynamicKeyPartList()))

python/gui/auto_generated/settings/qgssettingseditorwidgetwrapper.sip.in

@@ -94,6 +94,13 @@ If not, the setting will be updated directly at each widget value change.
 
    This must called after :py:func:`~QgsSettingsEditorWidgetWrapper.createEditor` or :py:func:`~QgsSettingsEditorWidgetWrapper.configureEditor`.
 
+.. versionadded:: 3.40
+%End
+
+    QStringList dynamicKeyPartList() const;
+%Docstring
+Returns the dynamic key parts
+
 .. versionadded:: 3.40
 %End
 

src/gui/settings/qgssettingseditorwidgetwrapper.h

@@ -94,6 +94,12 @@ class GUI_EXPORT QgsSettingsEditorWidgetWrapper : public QObject
      */
     void configureAutomaticUpdate( QDialog *dialog = nullptr );
 
+    /**
+     * Returns the dynamic key parts
+     * \since QGIS 3.40
+     */
+    QStringList dynamicKeyPartList() const {return mDynamicKeyPartList;}
+
 
   protected:
     //! Creates the widgets