move QgsSettingsEditorWidgetWrapper to core + allow to specify a spec…

…ific editor for a setting
qgis · Oct 8, 2024 · 440d1e7 · 440d1e7
1 parent 553e077
commit 440d1e7
Show file tree

Hide file tree

Showing 19 changed files with 111 additions and 22 deletions.
diff --git a/python/PyQt6/core/additions/qgssettingsentry.py b/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
diff --git a/...ditions/qgssettingseditorwidgetwrapper.py → ...ditions/qgssettingseditorwidgetwrapper.py b/...ditions/qgssettingseditorwidgetwrapper.py → ...ditions/qgssettingseditorwidgetwrapper.py
@@ -1,4 +1,4 @@
-# The following has been generated automatically from src/gui/settings/qgssettingseditorwidgetwrapper.h
+# The following has been generated automatically from src/core/settings/qgssettingseditorwidgetwrapper.h
 try:
     QgsSettingsEditorWidgetWrapper.fromWidget = staticmethod(QgsSettingsEditorWidgetWrapper.fromWidget)
     QgsSettingsEditorWidgetWrapper.__group__ = ['settings']

diff --git a/...ngs/qgssettingseditorwidgetwrapper.sip.in → ...ngs/qgssettingseditorwidgetwrapper.sip.in b/...ngs/qgssettingseditorwidgetwrapper.sip.in → ...ngs/qgssettingseditorwidgetwrapper.sip.in
@@ -1,7 +1,7 @@
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *
- * src/gui/settings/qgssettingseditorwidgetwrapper.h                    *
+ * src/core/settings/qgssettingseditorwidgetwrapper.h                   *
  *                                                                      *
  * Do not edit manually ! Edit header and run scripts/sipify.py again   *
  ************************************************************************/
@@ -98,6 +98,13 @@ If not, the setting will be updated directly at each widget value change.
 %End
 
 
+    QStringList dynamicKeyPartList() const;
+%Docstring
+Returns the dynamic key parts
+
+.. versionadded:: 3.40
+%End
+
   protected:
     virtual QWidget *createEditorPrivate( QWidget *parent = 0 ) const = 0;
 %Docstring
@@ -124,7 +131,7 @@ value is changed.
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *
- * src/gui/settings/qgssettingseditorwidgetwrapper.h                    *
+ * src/core/settings/qgssettingseditorwidgetwrapper.h                   *
  *                                                                      *
  * Do not edit manually ! Edit header and run scripts/sipify.py again   *
  ************************************************************************/
diff --git a/python/PyQt6/core/auto_generated/settings/qgssettingsentry.sip.in b/python/PyQt6/core/auto_generated/settings/qgssettingsentry.sip.in
@@ -358,6 +358,24 @@ Returns ``True`` if the given ``value`` is valid towards the setting definition
 Returns ``True`` if the setting was changed during the current QGIS session.
 
 .. versionadded:: 3.36
+%End
+
+    void setEditorWidgetWrapper( QgsSettingsEditorWidgetWrapper *editorWrapper /Transfer/ );
+%Docstring
+Sets an editor widget wrapper for the setting
+Normally, editor widgets are automatically determined and build using :py:class:`QgsSettingsEditorWidgetRegistry`.
+This might be useful for plugins to define a custom implementation.
+
+.. versionadded:: 3.40
+%End
+
+    QgsSettingsEditorWidgetWrapper *editorWidgetWrapper() const;
+%Docstring
+Returns the editor widget wrapper for the setting
+Normally, editor widgets are automatically determined and build using :py:class:`QgsSettingsEditorWidgetRegistry` and
+this method will then return a null pointer.
+
+.. versionadded:: 3.40
 %End
 
 };

diff --git a/python/PyQt6/core/core_auto.sip b/python/PyQt6/core/core_auto.sip
@@ -759,6 +759,7 @@
 %Include auto_generated/sensor/qgsabstractsensor.sip
 %Include auto_generated/sensor/qgsiodevicesensor.sip
 %Include auto_generated/settings/qgssettings.sip
+%Include auto_generated/settings/qgssettingseditorwidgetwrapper.sip
 %Include auto_generated/settings/qgssettingsentry.sip
 %Include auto_generated/settings/qgssettingsentrygroup.sip
 %Include auto_generated/settings/qgssettingsentryimpl.sip

diff --git a/python/PyQt6/gui/gui_auto.sip b/python/PyQt6/gui/gui_auto.sip
@@ -519,7 +519,6 @@
 %Include auto_generated/symbology/qgsvectorfieldsymbollayerwidget.sip
 %Include auto_generated/sensor/qgssensorguiregistry.sip
 %Include auto_generated/sensor/qgssensorwidget.sip
-%Include auto_generated/settings/qgssettingseditorwidgetwrapper.sip
 %Include auto_generated/settings/qgssettingseditorwidgetwrapperimpl.sip
 %Include auto_generated/settings/qgssettingseditorwidgetregistry.sip
 %Include auto_generated/settings/qgssettingsregistrygui.sip

diff --git a/python/core/additions/qgssettingsentry.py b/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.
@@ -139,9 +148,3 @@ def settingsType(self):
         Get the settings entry type.
         """
         return self.SettingsType.EnumFlag
-
-    def typeId(self):
-        """
-        Defines a custom id since this class has not the same API as the cpp implementation
-        """
-        return "py-enum"
diff --git a/...ditions/qgssettingseditorwidgetwrapper.py → ...ditions/qgssettingseditorwidgetwrapper.py b/...ditions/qgssettingseditorwidgetwrapper.py → ...ditions/qgssettingseditorwidgetwrapper.py
@@ -1,4 +1,4 @@
-# The following has been generated automatically from src/gui/settings/qgssettingseditorwidgetwrapper.h
+# The following has been generated automatically from src/core/settings/qgssettingseditorwidgetwrapper.h
 try:
     QgsSettingsEditorWidgetWrapper.fromWidget = staticmethod(QgsSettingsEditorWidgetWrapper.fromWidget)
     QgsSettingsEditorWidgetWrapper.__group__ = ['settings']

diff --git a/...ngs/qgssettingseditorwidgetwrapper.sip.in → ...ngs/qgssettingseditorwidgetwrapper.sip.in b/...ngs/qgssettingseditorwidgetwrapper.sip.in → ...ngs/qgssettingseditorwidgetwrapper.sip.in
@@ -1,7 +1,7 @@
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *
- * src/gui/settings/qgssettingseditorwidgetwrapper.h                    *
+ * src/core/settings/qgssettingseditorwidgetwrapper.h                   *
  *                                                                      *
  * Do not edit manually ! Edit header and run scripts/sipify.py again   *
  ************************************************************************/
@@ -98,6 +98,13 @@ If not, the setting will be updated directly at each widget value change.
 %End
 
 
+    QStringList dynamicKeyPartList() const;
+%Docstring
+Returns the dynamic key parts
+
+.. versionadded:: 3.40
+%End
+
   protected:
     virtual QWidget *createEditorPrivate( QWidget *parent = 0 ) const = 0;
 %Docstring
@@ -124,7 +131,7 @@ value is changed.
 /************************************************************************
  * This file has been generated automatically from                      *
  *                                                                      *
- * src/gui/settings/qgssettingseditorwidgetwrapper.h                    *
+ * src/core/settings/qgssettingseditorwidgetwrapper.h                   *
  *                                                                      *
  * Do not edit manually ! Edit header and run scripts/sipify.py again   *
  ************************************************************************/
diff --git a/python/core/auto_generated/settings/qgssettingsentry.sip.in b/python/core/auto_generated/settings/qgssettingsentry.sip.in
@@ -358,6 +358,24 @@ Returns ``True`` if the given ``value`` is valid towards the setting definition
 Returns ``True`` if the setting was changed during the current QGIS session.
 
 .. versionadded:: 3.36
+%End
+
+    void setEditorWidgetWrapper( QgsSettingsEditorWidgetWrapper *editorWrapper /Transfer/ );
+%Docstring
+Sets an editor widget wrapper for the setting
+Normally, editor widgets are automatically determined and build using :py:class:`QgsSettingsEditorWidgetRegistry`.
+This might be useful for plugins to define a custom implementation.
+
+.. versionadded:: 3.40
+%End
+
+    QgsSettingsEditorWidgetWrapper *editorWidgetWrapper() const;
+%Docstring
+Returns the editor widget wrapper for the setting
+Normally, editor widgets are automatically determined and build using :py:class:`QgsSettingsEditorWidgetRegistry` and
+this method will then return a null pointer.
+
+.. versionadded:: 3.40
 %End
 
 };

diff --git a/python/core/core_auto.sip b/python/core/core_auto.sip
@@ -759,6 +759,7 @@
 %Include auto_generated/sensor/qgsabstractsensor.sip
 %Include auto_generated/sensor/qgsiodevicesensor.sip
 %Include auto_generated/settings/qgssettings.sip
+%Include auto_generated/settings/qgssettingseditorwidgetwrapper.sip
 %Include auto_generated/settings/qgssettingsentry.sip
 %Include auto_generated/settings/qgssettingsentrygroup.sip
 %Include auto_generated/settings/qgssettingsentryimpl.sip

diff --git a/python/gui/__init__.py.in b/python/gui/__init__.py.in
@@ -23,7 +23,7 @@ __copyright__ = '(C) 2014, Nathan Woodrow'
 
 from qgis.PyQt import QtCore
 from qgis._gui import *
-from qgis.core import Qgis as _Qgis
+from qgis.core import Qgis as _Qgis, QgsSettingsEditorWidgetWrapper as _QgsSettingsEditorWidgetWrapper
 
 @MONKEYPATCH_INJECTIONS@
 
@@ -78,6 +78,7 @@ QgsMapLayerAction.EnabledOnlyWhenEditable.__doc__ = "Action should be shown only
 QgsMapLayerAction.Flags = _Qgis.MapLayerActionFlags
 
 # monkey patch old settings wrappers
+QgsSettingsEditorWidgetWrapper = _QgsSettingsEditorWidgetWrapper # moved from gui to core
 QgsSettingsStringEditorWidgetWrapper = QgsSettingsStringLineEditWrapper
 QgsSettingsBoolEditorWidgetWrapper = QgsSettingsBoolCheckBoxWrapper
 QgsSettingsIntegerEditorWidgetWrapper = QgsSettingsIntegerSpinBoxWrapper

diff --git a/python/gui/gui_auto.sip b/python/gui/gui_auto.sip
@@ -519,7 +519,6 @@
 %Include auto_generated/symbology/qgsvectorfieldsymbollayerwidget.sip
 %Include auto_generated/sensor/qgssensorguiregistry.sip
 %Include auto_generated/sensor/qgssensorwidget.sip
-%Include auto_generated/settings/qgssettingseditorwidgetwrapper.sip
 %Include auto_generated/settings/qgssettingseditorwidgetwrapperimpl.sip
 %Include auto_generated/settings/qgssettingseditorwidgetregistry.sip
 %Include auto_generated/settings/qgssettingsregistrygui.sip

diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
@@ -943,6 +943,7 @@ set(QGIS_CORE_SRCS
   fieldformatter/qgsvaluerelationfieldformatter.cpp
 
   settings/qgssettings.cpp
+  settings/qgssettingseditorwidgetwrapper.cpp
   settings/qgssettingsentry.cpp
   settings/qgssettingsentrygroup.cpp
   settings/qgssettingsentryimpl.cpp
@@ -2036,6 +2037,7 @@ set(QGIS_CORE_HDRS
   sensor/qgsiodevicesensor.h
 
   settings/qgssettings.h
+  settings/qgssettingseditorwidgetwrapper.h
   settings/qgssettingsentry.h
   settings/qgssettingsentrygroup.h
   settings/qgssettingsentryenumflag.h

diff --git a/...ttings/qgssettingseditorwidgetwrapper.cpp → ...ttings/qgssettingseditorwidgetwrapper.cpp b/...ttings/qgssettingseditorwidgetwrapper.cpp → ...ttings/qgssettingseditorwidgetwrapper.cpp
diff --git a/...settings/qgssettingseditorwidgetwrapper.h → ...settings/qgssettingseditorwidgetwrapper.h b/...settings/qgssettingseditorwidgetwrapper.h → ...settings/qgssettingseditorwidgetwrapper.h
@@ -19,19 +19,19 @@
 #include <QVariant>
 
 #include "qgis_sip.h"
-#include "qgis_gui.h"
+#include "qgis_core.h"
 
 class QgsSettingsEntryBase;
 
 class QDialog;
 
 /**
- * \ingroup gui
+ * \ingroup core
  * \brief Base class for settings editor wrappers
  *
  * \since QGIS 3.32
  */
-class GUI_EXPORT QgsSettingsEditorWidgetWrapper : public QObject
+class CORE_EXPORT QgsSettingsEditorWidgetWrapper : public QObject
 {
     Q_OBJECT
   public:
@@ -95,6 +95,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
     virtual QWidget *createEditorPrivate( QWidget *parent = nullptr ) const = 0;

diff --git a/src/core/settings/qgssettingsentry.h b/src/core/settings/qgssettingsentry.h
@@ -26,6 +26,7 @@
 
 
 class QgsSettingsTreeNode;
+class QgsSettingsEditorWidgetWrapper;
 
 
 static const inline QMetaEnum sSettingsTypeMetaEnum = QMetaEnum::fromType<Qgis::SettingsType>() SIP_SKIP;
@@ -352,6 +353,22 @@ class CORE_EXPORT QgsSettingsEntryBase
      */
     bool hasChanged() const { return mHasChanged; }
 
+    /**
+     * Sets an editor widget wrapper for the setting
+     * Normally, editor widgets are automatically determined and build using QgsSettingsEditorWidgetRegistry.
+     * This might be useful for plugins to define a custom implementation.
+     * \since QGIS 3.40
+     */
+    void setEditorWidgetWrapper( QgsSettingsEditorWidgetWrapper *editorWrapper SIP_TRANSFER ) {mEditorWrapper = editorWrapper; }
+
+    /**
+     * Returns the editor widget wrapper for the setting
+     * Normally, editor widgets are automatically determined and build using QgsSettingsEditorWidgetRegistry and
+     * this method will then return a null pointer.
+     * \since QGIS 3.40
+     */
+    QgsSettingsEditorWidgetWrapper *editorWidgetWrapper() const {return mEditorWrapper;}
+
   private:
     QString formerValuekey( const QStringList &dynamicKeyPartList ) const;
 
@@ -364,6 +381,7 @@ class CORE_EXPORT QgsSettingsEntryBase
     QString mDescription;
     Qgis::SettingsOptions mOptions;
     mutable bool mHasChanged = false;
+    QgsSettingsEditorWidgetWrapper *mEditorWrapper = nullptr;
 };
 
 /**

diff --git a/src/gui/CMakeLists.txt b/src/gui/CMakeLists.txt
@@ -498,7 +498,6 @@ set(QGIS_GUI_SRCS
   sensor/qgssensorguiregistry.cpp
   sensor/qgssensorwidget.cpp
 
-  settings/qgssettingseditorwidgetwrapper.cpp
   settings/qgssettingseditorwidgetwrapperimpl.cpp
   settings/qgssettingseditorwidgetregistry.cpp
   settings/qgssettingsregistrygui.cpp
@@ -1552,7 +1551,6 @@ set(QGIS_GUI_HDRS
   sensor/qgssensorguiregistry.h
   sensor/qgssensorwidget.h
 
-  settings/qgssettingseditorwidgetwrapper.h
   settings/qgssettingseditorwidgetwrapperimpl.h
   settings/qgssettingsenumflageditorwidgetwrapper.h
   settings/qgssettingseditorwidgetregistry.h

diff --git a/src/gui/settings/qgssettingseditorwidgetregistry.cpp b/src/gui/settings/qgssettingseditorwidgetregistry.cpp
@@ -97,7 +97,10 @@ QgsSettingsEditorWidgetWrapper *QgsSettingsEditorWidgetRegistry::createWrapper(
 
 QWidget *QgsSettingsEditorWidgetRegistry::createEditor( const QgsSettingsEntryBase *setting, const QStringList &dynamicKeyPartList, QWidget *parent ) const
 {
-  QgsSettingsEditorWidgetWrapper *eww = createWrapper( setting->typeId(), parent );
+
+  QgsSettingsEditorWidgetWrapper *eww = setting->editorWidgetWrapper();
+  if ( !eww )
+    eww = createWrapper( setting->typeId(), parent );
   if ( eww )
     return eww->createEditor( setting, dynamicKeyPartList, parent );
   else