Add framework so that a QgsMapLayerAction can get a reference

to the QgsAttributeDialog it is executed from
qgis · Nov 23, 2022 · 0c4aff9 · 0c4aff9
1 parent b6badb6
commit 0c4aff9
Show file tree

Hide file tree

Showing 9 changed files with 142 additions and 4 deletions.
diff --git a/python/gui/auto_generated/qgsactionmenu.sip.in b/python/gui/auto_generated/qgsactionmenu.sip.in
@@ -63,6 +63,15 @@ Constructs a new QgsActionMenu
 :param fid: The feature id of the feature for which this action will be run.
 :param parent: The usual QWidget parent.
 :param actionScope: The action scope this menu will run in
+%End
+
+    void setActionContextGenerator( QgsMapLayerActionContextGenerator *generator );
+%Docstring
+Sets a :py:class:`QgsMapLayerActionContextGenerator` to create action contexts for the menu.
+
+The ``generator`` object must exist for the lifetime of the menu.
+
+.. versionadded:: 3.30
 %End
 
     void setFeature( const QgsFeature &feature );

diff --git a/python/gui/auto_generated/qgsattributedialog.sip.in b/python/gui/auto_generated/qgsattributedialog.sip.in
@@ -10,7 +10,7 @@
 
 
 
-class QgsAttributeDialog : QDialog
+class QgsAttributeDialog : QDialog, QgsMapLayerActionContextGenerator
 {
 
 %TypeHeaderCode
@@ -83,6 +83,9 @@ for calculations in this form.
 .. versionadded:: 3.16
 %End
 
+    virtual QgsMapLayerActionContext createActionContext();
+
+
   public slots:
     virtual void accept();
 

diff --git a/python/gui/auto_generated/qgsmaplayeractionregistry.sip.in b/python/gui/auto_generated/qgsmaplayeractionregistry.sip.in
@@ -23,10 +23,48 @@ Encapsulates the context in which a :py:class:`QgsMapLayerAction` action is exec
 %End
   public:
 
+    QgsMapLayerActionContext();
+
+    QgsAttributeDialog *attributeDialog() const;
+%Docstring
+Returns the attribute dialog associated with the action's execution.
+
+May be ``None`` if the action is not being executed from an attribute dialog.
+
+.. seealso:: :py:func:`setAttributeDialog`
+%End
+
+    void setAttributeDialog( QgsAttributeDialog *dialog );
+%Docstring
+Sets the attribute ``dialog`` associated with the action's execution.
+
+.. seealso:: :py:func:`attributeDialog`
+%End
 
 };
 
 
+class QgsMapLayerActionContextGenerator
+{
+%Docstring(signature="appended")
+An interface for objects which can create a QgsMapLayerActionContext.
+
+.. versionadded:: 3.30
+%End
+
+%TypeHeaderCode
+#include "qgsmaplayeractionregistry.h"
+%End
+  public:
+
+    virtual ~QgsMapLayerActionContextGenerator();
+
+    virtual QgsMapLayerActionContext createActionContext() = 0;
+%Docstring
+Creates a :py:class:`QgsMapLayerActionContext`.
+%End
+};
+
 class QgsMapLayerAction : QAction
 {
 %Docstring(signature="appended")

diff --git a/src/gui/qgsactionmenu.cpp b/src/gui/qgsactionmenu.cpp
@@ -39,6 +39,11 @@ QgsActionMenu::QgsActionMenu( QgsVectorLayer *layer, const QgsFeatureId fid, con
   init();
 }
 
+void QgsActionMenu::setActionContextGenerator( QgsMapLayerActionContextGenerator *generator )
+{
+  mContextGenerator = generator;
+}
+
 void QgsActionMenu::init()
 {
   setTitle( tr( "&Actions" ) );
@@ -94,7 +99,7 @@ void QgsActionMenu::triggerAction()
   {
     QgsMapLayerAction *mapLayerAction = data.actionData.value<QgsMapLayerAction *>();
 
-    QgsMapLayerActionContext context;
+    const QgsMapLayerActionContext context = mContextGenerator ? mContextGenerator->createActionContext() : QgsMapLayerActionContext();
     Q_NOWARN_DEPRECATED_PUSH
     mapLayerAction->triggerForFeature( data.mapLayer, mFeature );
     Q_NOWARN_DEPRECATED_POP

diff --git a/src/gui/qgsactionmenu.h b/src/gui/qgsactionmenu.h
@@ -21,13 +21,14 @@
 
 #include "qgsfeature.h"
 #include "qgsaction.h"
+#include "qgsattributeeditorcontext.h"
 #include "qgis_gui.h"
-#include "qgsattributeform.h"
 
 class QgsMapLayer;
 class QgsMapLayerAction;
 class QgsVectorLayer;
 class QgsActionManager;
+class QgsMapLayerActionContextGenerator;
 
 /**
  * \ingroup gui
@@ -83,6 +84,15 @@ class GUI_EXPORT QgsActionMenu : public QMenu
      */
     explicit QgsActionMenu( QgsVectorLayer *layer, QgsFeatureId fid, const QString &actionScope, QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
+    /**
+     * Sets a QgsMapLayerActionContextGenerator to create action contexts for the menu.
+     *
+     * The \a generator object must exist for the lifetime of the menu.
+     *
+     * \since QGIS 3.30
+     */
+    void setActionContextGenerator( QgsMapLayerActionContextGenerator *generator );
+
     /**
      * Change the feature on which actions are performed
      *
@@ -146,6 +156,8 @@ class GUI_EXPORT QgsActionMenu : public QMenu
     QString mActionScope;
     QgsExpressionContextScope mExpressionContextScope;
     QgsAttributeEditorContext::Mode mMode = QgsAttributeEditorContext::SingleEditMode;
+
+    QgsMapLayerActionContextGenerator *mContextGenerator = nullptr;
 };
 
 

diff --git a/src/gui/qgsattributedialog.cpp b/src/gui/qgsattributedialog.cpp
@@ -125,6 +125,7 @@ void QgsAttributeDialog::init( QgsVectorLayer *layer, QgsFeature *feature, const
   connect( layer, &QObject::destroyed, this, &QWidget::close );
 
   mMenu = new QgsActionMenu( layer, mAttributeForm->feature(), QStringLiteral( "Feature" ), this );
+  mMenu->setActionContextGenerator( this );
   if ( !mMenu->isEmpty() )
   {
     mMenuBar = new QMenuBar( this );
@@ -169,3 +170,10 @@ void QgsAttributeDialog::setExtraContextScope( QgsExpressionContextScope *extraS
 {
   mAttributeForm->setExtraContextScope( extraScope );
 }
+
+QgsMapLayerActionContext QgsAttributeDialog::createActionContext()
+{
+  QgsMapLayerActionContext context;
+  context.setAttributeDialog( this );
+  return context;
+}
diff --git a/src/gui/qgsattributedialog.h b/src/gui/qgsattributedialog.h
@@ -22,6 +22,7 @@
 #include "qgsattributeform.h"
 #include "qgstrackedvectorlayertools.h"
 #include "qgsactionmenu.h"
+#include "qgsmaplayeractionregistry.h"
 
 #include <QDialog>
 #include <QMenuBar>
@@ -34,7 +35,7 @@ class QgsHighlight;
  * \ingroup gui
  * \class QgsAttributeDialog
  */
-class GUI_EXPORT QgsAttributeDialog : public QDialog
+class GUI_EXPORT QgsAttributeDialog : public QDialog, public QgsMapLayerActionContextGenerator
 {
     Q_OBJECT
 
@@ -103,6 +104,8 @@ class GUI_EXPORT QgsAttributeDialog : public QDialog
      */
     void setExtraContextScope( QgsExpressionContextScope *extraScope SIP_TRANSFER );
 
+    QgsMapLayerActionContext createActionContext() override;
+
   public slots:
     void accept() override;
     void reject() override;

diff --git a/src/gui/qgsmaplayeractionregistry.cpp b/src/gui/qgsmaplayeractionregistry.cpp
@@ -16,6 +16,7 @@
 #include "qgsmaplayeractionregistry.h"
 #include "qgsgui.h"
 #include "qgsvectorlayer.h"
+#include "qgsattributedialog.h"
 
 QgsMapLayerAction::QgsMapLayerAction( const QString &name, QObject *parent, Targets targets, const QIcon &icon, QgsMapLayerAction::Flags flags )
   : QAction( icon, name, parent )
@@ -195,3 +196,21 @@ QgsMapLayerAction *QgsMapLayerActionRegistry::defaultActionForLayer( QgsMapLayer
 
   return mDefaultLayerActionMap[ layer ];
 }
+
+//
+// QgsMapLayerActionContext
+//
+
+QgsMapLayerActionContext::QgsMapLayerActionContext() = default;
+
+QgsAttributeDialog *QgsMapLayerActionContext::attributeDialog() const
+{
+  return mAttributeDialog;
+}
+
+void QgsMapLayerActionContext::setAttributeDialog( QgsAttributeDialog *dialog )
+{
+  mAttributeDialog = dialog;
+}
+
+QgsMapLayerActionContextGenerator::~QgsMapLayerActionContextGenerator() = default;
diff --git a/src/gui/qgsmaplayeractionregistry.h b/src/gui/qgsmaplayeractionregistry.h
@@ -21,12 +21,14 @@
 #include <QList>
 #include <QMap>
 #include <QAction>
+#include <QPointer>
 
 #include "qgis.h"
 #include "qgis_gui.h"
 
 class QgsFeature;
 class QgsMapLayer;
+class QgsAttributeDialog;
 
 /**
  * \ingroup gui
@@ -37,11 +39,50 @@ class GUI_EXPORT QgsMapLayerActionContext
 {
   public:
 
+    QgsMapLayerActionContext();
+
+    /**
+     * Returns the attribute dialog associated with the action's execution.
+     *
+     * May be NULLPTR if the action is not being executed from an attribute dialog.
+     *
+     * \see setAttributeDialog()
+     */
+    QgsAttributeDialog *attributeDialog() const;
+
+    /**
+     * Sets the attribute \a dialog associated with the action's execution.
+     *
+     * \see attributeDialog()
+     */
+    void setAttributeDialog( QgsAttributeDialog *dialog );
+
+  private:
+
+    QPointer< QgsAttributeDialog > mAttributeDialog;
+
 
 };
 
 Q_DECLARE_METATYPE( QgsMapLayerActionContext )
 
+/**
+ * \ingroup gui
+ * \brief An interface for objects which can create a QgsMapLayerActionContext.
+ * \since QGIS 3.30
+ */
+class GUI_EXPORT QgsMapLayerActionContextGenerator
+{
+  public:
+
+    virtual ~QgsMapLayerActionContextGenerator();
+
+    /**
+     * Creates a QgsMapLayerActionContext.
+     */
+    virtual QgsMapLayerActionContext createActionContext() = 0;
+};
+
 /**
  * \ingroup gui
 * \brief An action which can run on map layers