[settings] support direct connection from widget value change to upda… (

qgis#58611) * [settings] support direct connection from widget value change to update setting value * support automatic setting update on dialog accept * add settings entry * better name + fix typo * Update src/gui/settings/qgssettingseditorwidgetwrapper.h Co-authored-by: Mathieu Pellerin <nirvn.asia@gmail.com> * sipify --------- Co-authored-by: Mathieu Pellerin <nirvn.asia@gmail.com>
velle · Sep 17, 2024 · 028c168 · 028c168
1 parent a73034e
commit 028c168
Show file tree

Hide file tree

Showing 10 changed files with 200 additions and 1 deletion.
diff --git a/python/PyQt6/gui/auto_generated/settings/qgssettingseditorwidgetwrapper.sip.in b/python/PyQt6/gui/auto_generated/settings/qgssettingseditorwidgetwrapper.sip.in
@@ -10,6 +10,7 @@
 
 
 
+
 class QgsSettingsEditorWidgetWrapper : QObject
 {
 %Docstring(signature="appended")
@@ -82,6 +83,21 @@ Sets the ``value`` of the widget
 The wrapper must be configured before calling this medthod
 %End
 
+    void configureAutomaticUpdate( QDialog *dialog = 0 );
+%Docstring
+Enables automatic update, which causes the setting to be updated immediately when the widget
+value is changed.
+
+If a ``dialog`` is provided, the setting will be updated when the dialog is accepted.
+If not, the setting will be updated directly at each widget value change.
+
+.. note::
+
+   This must called after :py:func:`~QgsSettingsEditorWidgetWrapper.createEditor` or :py:func:`~QgsSettingsEditorWidgetWrapper.configureEditor`.
+
+.. versionadded:: 3.40
+%End
+
 
   protected:
     virtual QWidget *createEditorPrivate( QWidget *parent = 0 ) const = 0;
@@ -92,6 +108,14 @@ Creates the widgets
     virtual bool configureEditorPrivate( QWidget *editor, const QgsSettingsEntryBase *setting ) = 0;
 %Docstring
 Configures an existing ``editor`` widget
+%End
+
+    virtual void enableAutomaticUpdatePrivate() = 0;
+%Docstring
+Enables automatic update, which causes the setting to be updated immediately when the widget
+value is changed.
+
+.. versionadded:: 3.40
 %End
 
 };

diff --git a/python/PyQt6/gui/auto_generated/settings/qgssettingseditorwidgetwrapperimpl.sip.in b/python/PyQt6/gui/auto_generated/settings/qgssettingseditorwidgetwrapperimpl.sip.in
@@ -109,6 +109,9 @@ Constructor
 
     virtual bool setWidgetValue( const QString &value ) const;
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 
@@ -145,6 +148,9 @@ Constructor
 
     virtual bool setWidgetValue( const bool &value ) const;
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 
@@ -181,6 +187,9 @@ Constructor
 
     virtual bool setWidgetValue( const int &value ) const;
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 
@@ -218,6 +227,9 @@ Constructor
 
     virtual bool setWidgetValue( const double &value ) const;
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 
@@ -258,6 +270,9 @@ Constructor
 
     virtual void configureEditorPrivateImplementation();
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 

diff --git a/python/gui/auto_generated/settings/qgssettingseditorwidgetwrapper.sip.in b/python/gui/auto_generated/settings/qgssettingseditorwidgetwrapper.sip.in
@@ -10,6 +10,7 @@
 
 
 
+
 class QgsSettingsEditorWidgetWrapper : QObject
 {
 %Docstring(signature="appended")
@@ -82,6 +83,21 @@ Sets the ``value`` of the widget
 The wrapper must be configured before calling this medthod
 %End
 
+    void configureAutomaticUpdate( QDialog *dialog = 0 );
+%Docstring
+Enables automatic update, which causes the setting to be updated immediately when the widget
+value is changed.
+
+If a ``dialog`` is provided, the setting will be updated when the dialog is accepted.
+If not, the setting will be updated directly at each widget value change.
+
+.. note::
+
+   This must called after :py:func:`~QgsSettingsEditorWidgetWrapper.createEditor` or :py:func:`~QgsSettingsEditorWidgetWrapper.configureEditor`.
+
+.. versionadded:: 3.40
+%End
+
 
   protected:
     virtual QWidget *createEditorPrivate( QWidget *parent = 0 ) const = 0;
@@ -92,6 +108,14 @@ Creates the widgets
     virtual bool configureEditorPrivate( QWidget *editor, const QgsSettingsEntryBase *setting ) = 0;
 %Docstring
 Configures an existing ``editor`` widget
+%End
+
+    virtual void enableAutomaticUpdatePrivate() = 0;
+%Docstring
+Enables automatic update, which causes the setting to be updated immediately when the widget
+value is changed.
+
+.. versionadded:: 3.40
 %End
 
 };

diff --git a/python/gui/auto_generated/settings/qgssettingseditorwidgetwrapperimpl.sip.in b/python/gui/auto_generated/settings/qgssettingseditorwidgetwrapperimpl.sip.in
@@ -109,6 +109,9 @@ Constructor
 
     virtual bool setWidgetValue( const QString &value ) const;
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 
@@ -145,6 +148,9 @@ Constructor
 
     virtual bool setWidgetValue( const bool &value ) const;
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 
@@ -181,6 +187,9 @@ Constructor
 
     virtual bool setWidgetValue( const int &value ) const;
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 
@@ -218,6 +227,9 @@ Constructor
 
     virtual bool setWidgetValue( const double &value ) const;
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 
@@ -258,6 +270,9 @@ Constructor
 
     virtual void configureEditorPrivateImplementation();
 
+
+    virtual void enableAutomaticUpdatePrivate();
+
 };
 
 

diff --git a/src/gui/qgsgui.h b/src/gui/qgsgui.h
@@ -19,6 +19,7 @@
 #define QGSGUI_H
 
 #include "qgis_gui.h"
+#include "qgssettingstree.h"
 #include "qgis_sip.h"
 #include <QWidget>
 #include <memory>
@@ -64,6 +65,8 @@ class GUI_EXPORT QgsGui : public QObject
 
   public:
 
+    static inline QgsSettingsTreeNode *sTtreeWidgetLastUsedValues = QgsSettingsTree::sTreeApp->createChildNode( QStringLiteral( "widget-last-used-values" ) ) SIP_SKIP;
+
     /**
      * Defines the behavior to use when setting the CRS for a newly created project.
      */

diff --git a/src/gui/settings/qgssettingseditorwidgetwrapper.cpp b/src/gui/settings/qgssettingseditorwidgetwrapper.cpp
@@ -19,6 +19,7 @@
 #include "qgslogger.h"
 #include "qgssettingsentry.h"
 
+#include <QDialog>
 #include <QWidget>
 
 
@@ -59,3 +60,19 @@ bool QgsSettingsEditorWidgetWrapper::configureEditor( QWidget *editor, const Qgs
 
   return ok;
 }
+
+void QgsSettingsEditorWidgetWrapper::configureAutomaticUpdate( QDialog *dialog )
+{
+  setWidgetFromSetting();
+  if ( dialog )
+  {
+    QObject::connect( dialog, &QDialog::accepted, this, [ = ]()
+    {
+      setSettingFromWidget();
+    } );
+  }
+  else
+  {
+    enableAutomaticUpdatePrivate();
+  }
+}
diff --git a/src/gui/settings/qgssettingseditorwidgetwrapper.h b/src/gui/settings/qgssettingseditorwidgetwrapper.h
@@ -23,6 +23,8 @@
 
 class QgsSettingsEntryBase;
 
+class QDialog;
+
 /**
  * \ingroup gui
  * \brief Base class for settings editor wrappers
@@ -80,6 +82,18 @@ class GUI_EXPORT QgsSettingsEditorWidgetWrapper : public QObject
      */
     virtual void setWidgetFromVariant( const QVariant &value ) const = 0;
 
+    /**
+     * Configure the settings update behavior when a widget value is changed.
+     *
+     * If a \a dialog is provided, the setting will be updated when the dialog is accepted.
+     * If not, the setting will be updated directly at each widget value change.
+     *
+     * \note This must called after createEditor() or configureEditor().
+     *
+     * \since QGIS 3.40
+     */
+    void configureAutomaticUpdate( QDialog *dialog = nullptr );
+
 
   protected:
     //! Creates the widgets
@@ -88,6 +102,13 @@ class GUI_EXPORT QgsSettingsEditorWidgetWrapper : public QObject
     //! Configures an existing \a editor widget
     virtual bool configureEditorPrivate( QWidget *editor, const QgsSettingsEntryBase *setting ) = 0;
 
+    /**
+     * Enables automatic update, which causes the setting to be updated immediately when the widget
+     * value is changed.
+     * \since QGIS 3.40
+     */
+    virtual void enableAutomaticUpdatePrivate() = 0;
+
     QStringList mDynamicKeyPartList;
 };
 

diff --git a/src/gui/settings/qgssettingseditorwidgetwrapperimpl.cpp b/src/gui/settings/qgssettingseditorwidgetwrapperimpl.cpp
@@ -46,6 +46,14 @@ bool QgsSettingsStringEditorWidgetWrapper::setWidgetValue( const QString &value
   return false;
 }
 
+void QgsSettingsStringEditorWidgetWrapper::enableAutomaticUpdatePrivate()
+{
+  QObject::connect( this->mEditor, &QLineEdit::textChanged, this, [ = ]( const QString & text )
+  {
+    this->mSetting->setValue( text, this->mDynamicKeyPartList );
+  } );
+}
+
 bool QgsSettingsStringEditorWidgetWrapper::setSettingFromWidget() const
 {
   if ( mEditor )
@@ -96,6 +104,14 @@ bool QgsSettingsBoolEditorWidgetWrapper::setWidgetValue( const bool &value ) con
   return false;
 }
 
+void QgsSettingsBoolEditorWidgetWrapper::enableAutomaticUpdatePrivate()
+{
+  QObject::connect( this->mEditor, &QCheckBox::clicked, this, [ = ]( bool checked )
+  {
+    this->mSetting->setValue( checked, this->mDynamicKeyPartList );
+  } );
+}
+
 bool QgsSettingsBoolEditorWidgetWrapper::setSettingFromWidget() const
 {
   if ( mEditor )
@@ -148,6 +164,14 @@ bool QgsSettingsIntegerEditorWidgetWrapper::setWidgetValue( const int &value ) c
   return false;
 }
 
+void QgsSettingsIntegerEditorWidgetWrapper::enableAutomaticUpdatePrivate()
+{
+  QObject::connect( this->mEditor, qOverload<int>( &QSpinBox::valueChanged ), this, [ = ]( int value )
+  {
+    this->mSetting->setValue( value, this->mDynamicKeyPartList );
+  } );
+}
+
 bool QgsSettingsIntegerEditorWidgetWrapper::setSettingFromWidget() const
 {
   if ( mEditor )
@@ -200,6 +224,14 @@ bool QgsSettingsDoubleEditorWidgetWrapper::setWidgetValue( const double &value )
   return false;
 }
 
+void QgsSettingsDoubleEditorWidgetWrapper::enableAutomaticUpdatePrivate()
+{
+  QObject::connect( this->mEditor, qOverload<double>( &QDoubleSpinBox::valueChanged ), this, [ = ]( double value )
+  {
+    this->mSetting->setValue( value, this->mDynamicKeyPartList );
+  } );
+}
+
 bool QgsSettingsDoubleEditorWidgetWrapper::setSettingFromWidget() const
 {
   if ( mEditor )
@@ -262,6 +294,14 @@ void QgsSettingsColorEditorWidgetWrapper::configureEditorPrivateImplementation()
   }
 }
 
+void QgsSettingsColorEditorWidgetWrapper::enableAutomaticUpdatePrivate()
+{
+  QObject::connect( this->mEditor, &QgsColorButton::colorChanged, this, [ = ]( const QColor & color )
+  {
+    this->mSetting->setValue( color, this->mDynamicKeyPartList );
+  } );
+}
+
 bool QgsSettingsColorEditorWidgetWrapper::setSettingFromWidget() const
 {
   if ( mEditor )

diff --git a/src/gui/settings/qgssettingseditorwidgetwrapperimpl.h b/src/gui/settings/qgssettingseditorwidgetwrapperimpl.h
@@ -139,6 +139,8 @@ class GUI_EXPORT QgsSettingsStringEditorWidgetWrapper : public QgsSettingsEditor
     QString valueFromWidget() const override;
 
     bool setWidgetValue( const QString &value ) const override;
+
+    void enableAutomaticUpdatePrivate() override;
 };
 
 /**
@@ -164,6 +166,8 @@ class GUI_EXPORT QgsSettingsBoolEditorWidgetWrapper : public QgsSettingsEditorWi
     bool valueFromWidget() const override;
 
     bool setWidgetValue( const bool &value ) const override;
+
+    void enableAutomaticUpdatePrivate() override;
 };
 
 /**
@@ -189,6 +193,8 @@ class GUI_EXPORT QgsSettingsIntegerEditorWidgetWrapper : public QgsSettingsEdito
     int valueFromWidget() const override;
 
     bool setWidgetValue( const int &value ) const override;
+
+    void enableAutomaticUpdatePrivate() override;
 };
 
 
@@ -215,6 +221,8 @@ class GUI_EXPORT QgsSettingsDoubleEditorWidgetWrapper : public QgsSettingsEditor
     double valueFromWidget() const override;
 
     bool setWidgetValue( const double &value ) const override;
+
+    void enableAutomaticUpdatePrivate() override;
 };
 
 
@@ -243,6 +251,8 @@ class GUI_EXPORT QgsSettingsColorEditorWidgetWrapper : public QgsSettingsEditorW
     bool setWidgetValue( const QColor &value ) const override;
 
     void configureEditorPrivateImplementation() override;
+
+    void enableAutomaticUpdatePrivate() override;
 };