Add click_x and click_y variables for right click triggered actions, Fix #16852

python/core/qgsactionmanager.sip

@@ -62,6 +62,15 @@ Constructor
 .. versionadded:: 3.0
 %End
 
+    void doActionWithContext( const QUuid &actionId,
+                              const QgsFeature &feat,
+                              QgsExpressionContextScope *actionScope,
+                              int defaultValueIndex = 0 );
+%Docstring
+ Does the action like doAction() providing
+  action context scope.
+%End
+
     void doAction( const QUuid &actionId, const QgsFeature &feature, int defaultValueIndex = 0 ) /PyName=doActionFeature/;
 %Docstring
  Does the given action. defaultValueIndex is the index of the

python/gui/qgsactionmenu.sip

@@ -73,6 +73,11 @@ class QgsActionMenu : QMenu
                  as long as the menu is displayed and the action is running.
 %End
 
+    void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
+%Docstring
+ Set expression context scope.
+%End
+
   signals:
     void reinit();
 

python/gui/qgsidentifymenu.sip

@@ -137,6 +137,11 @@ remove all custom actions from the menu to be built
  :rtype: list of QgsMapToolIdentify.IdentifyResult
 %End
 
+    void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
+%Docstring
+ Set expression context scope.
+%End
+
   protected:
     virtual void closeEvent( QCloseEvent *e );
 

src/app/qgsidentifyresultsdialog.cpp

@@ -1210,6 +1210,11 @@ void QgsIdentifyResultsDialog::activate()
   }
 }
 
+void QgsIdentifyResultsDialog::setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope )
+{
+  mExpressionContextScope = expressionContextScope;
+}
+
 void QgsIdentifyResultsDialog::deactivate()
 {
   Q_FOREACH ( QgsHighlight *h, mHighlights )
@@ -1244,8 +1249,11 @@ void QgsIdentifyResultsDialog::doAction( QTreeWidgetItem *item, const QString &a
     }
   }
 
+  // Add action context scope.
+  QgsExpressionContextScope *actionScope = new QgsExpressionContextScope( mExpressionContextScope );
+
   int featIdx = featItem->data( 0, Qt::UserRole + 1 ).toInt();
-  layer->actions()->doAction( action, mFeatures[ featIdx ], idx );
+  layer->actions()->doActionWithContext( action, mFeatures[ featIdx ], actionScope, idx );
 }
 
 void QgsIdentifyResultsDialog::doMapLayerAction( QTreeWidgetItem *item, QgsMapLayerAction *action )

src/app/qgsidentifyresultsdialog.h

@@ -25,6 +25,7 @@
 #include "qgscoordinatereferencesystem.h"
 #include "qgsmaptoolidentify.h"
 #include "qgswebview.h"
+#include "qgsexpressioncontext.h"
 
 #include <QWidget>
 #include <QList>
@@ -150,6 +151,11 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti
     //! Map tool was activated
     void activate();
 
+    /**
+     * \brief Set expression context scope.
+     */
+    void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
+
   signals:
     void selectedFeatureChanged( QgsVectorLayer *, QgsFeatureId featureId );
 
@@ -260,6 +266,9 @@ class APP_EXPORT QgsIdentifyResultsDialog: public QDialog, private Ui::QgsIdenti
 
     QVector<QgsIdentifyPlotCurve *> mPlotCurves;
 
+    // expression context scope.
+    QgsExpressionContextScope   mExpressionContextScope;
+
     void showHelp();
 };
 

src/app/qgsmaptoolidentifyaction.cpp

@@ -115,6 +115,20 @@ void QgsMapToolIdentifyAction::canvasPressEvent( QgsMapMouseEvent *e )
 
 void QgsMapToolIdentifyAction::canvasReleaseEvent( QgsMapMouseEvent *e )
 {
+  // Store clicked x & y into identify menu.
+  if ( mIdentifyMenu )
+  {
+    QgsPointXY point = toMapCoordinates( e->pos() );
+
+    QgsExpressionContextScope contextScope;
+
+    contextScope.addVariable( QgsExpressionContextScope::StaticVariable( QString( "click_x" ), point.x(), true ) );
+    contextScope.addVariable( QgsExpressionContextScope::StaticVariable( QString( "click_y" ), point.y(), true ) );
+
+    mIdentifyMenu->setExpressionContextScope( contextScope );
+    resultsDialog()->setExpressionContextScope( contextScope );
+  }
+
   resultsDialog()->clear();
   connect( this, &QgsMapToolIdentifyAction::identifyProgress, QgisApp::instance(), &QgisApp::showProgress );
   connect( this, &QgsMapToolIdentifyAction::identifyMessage, QgisApp::instance(), &QgisApp::showStatusMessage );

src/core/CMakeLists.txt

@@ -145,6 +145,7 @@ SET(QGIS_CORE_SRCS
   qgscolorscheme.cpp
   qgscolorschemeregistry.cpp
   qgsconditionalstyle.cpp
+  qgscontextaction.cpp
   qgscoordinatereferencesystem.cpp
   qgscoordinatetransform.cpp
   qgscoordinatetransform_p.cpp
@@ -576,6 +577,7 @@ SET(QGIS_CORE_MOC_HDRS
   qgsanimatedicon.h
   qgsauxiliarystorage.h
   qgsbrowsermodel.h
+  qgscontextaction.h
   qgscoordinatereferencesystem.h
   qgscredentials.h
   qgsdataitem.h

src/core/qgsactionmanager.cpp

@@ -123,6 +123,19 @@ void QgsActionManager::removeAction( const QUuid &actionId )
   }
 }
 
+void QgsActionManager::doActionWithContext( const QUuid &actionId, const QgsFeature &feature, QgsExpressionContextScope *ctxScope, int defaultValueIndex )
+{
+  QgsExpressionContext context = createExpressionContext();
+  QgsExpressionContextScope *actionScope = new QgsExpressionContextScope();
+  actionScope->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "field_index" ), defaultValueIndex, true ) );
+  if ( defaultValueIndex >= 0 && defaultValueIndex < feature.fields().size() )
+    actionScope->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "field_name" ), feature.fields().at( defaultValueIndex ).name(), true ) );
+  actionScope->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "field_value" ), feature.attribute( defaultValueIndex ), true ) );
+  context << actionScope;
+  context << ctxScope;
+  doAction( actionId, feature, context );
+}
+
 void QgsActionManager::doAction( const QUuid &actionId, const QgsFeature &feature, int defaultValueIndex )
 {
   QgsExpressionContext context = createExpressionContext();

src/core/qgsactionmanager.h

@@ -88,6 +88,15 @@ class CORE_EXPORT QgsActionManager: public QObject
      */
     void removeAction( const QUuid &actionId );
 
+    /**
+     * Does the action like doAction() providing
+     *  action context scope.
+     */
+    void doActionWithContext( const QUuid &actionId,
+                              const QgsFeature &feat,
+                              QgsExpressionContextScope *actionScope,
+                              int defaultValueIndex = 0 );
+
     /**
      * Does the given action. defaultValueIndex is the index of the
      *  field to be used if the action has a $currfield placeholder.

src/core/qgscontextaction.cpp

@@ -0,0 +1,41 @@
+/***************************************************************************
+  qgsactionscope.cpp - QgsActionScope
+
+ ---------------------
+ begin                : 25.09.2017
+ copyright            : (C) 2017 by C. MARCEL
+ email                : clement.marcel@nwanda.fr
+ ***************************************************************************
+ *                                                                         *
+ *   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.                                   *
+ *                                                                         *
+ ***************************************************************************/
+#include "qgscontextaction.h"
+
+QgsContextAction::QgsContextAction( QObject *parent ):
+  QAction( parent )
+{
+}
+
+QgsContextAction::QgsContextAction( const QString &text, QObject *parent ):
+  QAction( text, parent )
+{
+}
+
+QgsContextAction::QgsContextAction( const QIcon &icon, const QString &text, QObject *parent ):
+  QAction( icon, text, parent )
+{
+}
+
+QgsExpressionContextScope QgsContextAction::expressionContextScope() const
+{
+  return mExpressionContextScope;
+}
+
+void QgsContextAction::setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope )
+{
+  mExpressionContextScope = expressionContextScope;
+}

src/core/qgscontextaction.h

@@ -0,0 +1,73 @@
+/***************************************************************************
+  qgsactionscope.h - QgsActionScope
+
+ ---------------------
+ begin                : 25.09.2017
+ copyright            : (C) 2017 by C. MARCEL
+ email                : clement.marcel@nwanda.fr
+ ***************************************************************************
+ *                                                                         *
+ *   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.                                   *
+ *                                                                         *
+ ***************************************************************************/
+#ifndef QGSCONTEXTACTION_H
+#define QGSCONTEXTACTION_H
+
+#include "qgis_core.h"
+#include <QString>
+#include <QAction>
+#include "qgsexpressioncontext.h"
+
+#define SIP_NO_FILE
+
+/**
+ * \ingroup core
+ * QgsContextAction is derived from QAction and contains a context expression scope.
+ *
+ * \since QGIS 3.0
+ */
+class CORE_EXPORT QgsContextAction: public QAction
+{
+  public:
+
+    /**
+     * Creates a new context action.
+     *
+     * \since QGIS 3.0
+     */
+    explicit QgsContextAction( QObject *parent );
+
+    /**
+     * Creates a new context action providing action text.
+     *
+     * \since QGIS 3.0
+     */
+    QgsContextAction( const QString &text, QObject *parent );
+
+    /**
+     * Creates a new context action providing action text & icon.
+     *
+     * \since QGIS 3.0
+     */
+    QgsContextAction( const QIcon &icon, const QString &text, QObject *parent );
+
+    /**
+     * Action context scope.
+     *
+     * \since QGIS 3.0
+     */
+    QgsExpressionContextScope expressionContextScope() const;
+
+    /**
+     * \copydoc expressionContextScope()
+     */
+    void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
+
+  private:
+    QgsExpressionContextScope mExpressionContextScope;
+};
+
+#endif // QGSCONTEXTACTION_H

src/gui/qgsactionmenu.cpp

@@ -19,6 +19,7 @@
 #include "qgsactionmanager.h"
 #include "qgsfeatureiterator.h"
 #include "qgsgui.h"
+#include "qgscontextaction.h"
 
 QgsActionMenu::QgsActionMenu( QgsVectorLayer *layer, const QgsFeature &feature, const QString &actionScope, QWidget  *parent )
   : QMenu( parent )
@@ -63,6 +64,11 @@ void QgsActionMenu::setFeature( const QgsFeature &feature )
   mFeature = feature;
 }
 
+void QgsActionMenu::setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope )
+{
+  mExpressionContextScope = expressionContextScope;
+}
+
 void QgsActionMenu::triggerAction()
 {
   if ( !feature().isValid() )
@@ -93,6 +99,15 @@ void QgsActionMenu::triggerAction()
     QgsExpressionContextScope *actionScope = new QgsExpressionContextScope();
     actionScope->addVariable( QgsExpressionContextScope::StaticVariable( QStringLiteral( "action_scope" ), mActionScope, true ) );
     context << actionScope;
+    context << new QgsExpressionContextScope( mExpressionContextScope );
+
+    QgsContextAction *contextAction = dynamic_cast<QgsContextAction *>( action );
+    if ( contextAction )
+    {
+      QgsExpressionContextScope *expressionContextScope = new QgsExpressionContextScope( contextAction->expressionContextScope() );
+      context << expressionContextScope;
+    }
+
     QgsAction act = data.actionData.value<QgsAction>();
     act.run( context );
   }
@@ -106,9 +121,10 @@ void QgsActionMenu::reloadActions()
 
   Q_FOREACH ( const QgsAction &action, mActions )
   {
-    QAction *qAction = new QAction( action.icon(), action.name(), this );
+    QgsContextAction *qAction = new QgsContextAction( action.icon(), action.name(), this );
     qAction->setData( QVariant::fromValue<ActionData>( ActionData( action, mFeatureId, mLayer ) ) );
     qAction->setIcon( action.icon() );
+    qAction->setExpressionContextScope( mExpressionContextScope );
 
     // Only enable items on supported platforms
     if ( !action.runable() )

src/gui/qgsactionmenu.h

@@ -91,6 +91,11 @@ class GUI_EXPORT QgsActionMenu : public QMenu
      */
     void setFeature( const QgsFeature &feature );
 
+    /**
+     * \brief Set expression context scope.
+     */
+    void setExpressionContextScope( const QgsExpressionContextScope &expressionContextScope );
+
   signals:
     void reinit();
 
@@ -107,6 +112,9 @@ class GUI_EXPORT QgsActionMenu : public QMenu
     QgsFeature mFeature;
     QgsFeatureId mFeatureId;
     QString mActionScope;
+
+    // expression context scope.
+    QgsExpressionContextScope   mExpressionContextScope;
 };