availibilty definition for map layer actions

qgis · Aug 13, 2014 · b88723d · b88723d · nyalldawson · Aug 13, 2014
1 parent 0901627
commit b88723d
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 18 deletions.
diff --git a/python/gui/qgsmaplayeractionregistry.sip b/python/gui/qgsmaplayeractionregistry.sip
@@ -5,13 +5,20 @@ class QgsMapLayerAction : QAction
 %End
 
   public:
+    enum AvailabityFlag
+    {
+        Layer,
+        Feature,
+        LayerAndFeature
+    };
+    typedef QFlags<QgsMapLayerAction::AvailabityFlag> Availability;
+
     /**Creates a map layer action which can run on any layer*/
-    QgsMapLayerAction( QString name, QObject *parent );
+    QgsMapLayerAction( QString name, QObject *parent, Availability availability = LayerAndFeature );
     /**Creates a map layer action which can run only on a specific layer*/
-    QgsMapLayerAction( QString name, QObject *parent, QgsMapLayer* layer );
+    QgsMapLayerAction( QString name, QObject *parent, QgsMapLayer* layer, Availability availability = LayerAndFeature );
     /**Creates a map layer action which can run on a specific type of layer*/
-    QgsMapLayerAction( QString name, QObject *parent, QgsMapLayer::LayerType layerType );
-
+    QgsMapLayerAction( QString name, QObject *parent, QgsMapLayer::LayerType layerType, Availability availability = LayerAndFeature );
     ~QgsMapLayerAction();
 
     /** True if action can run using the specified layer */
@@ -24,6 +31,10 @@ class QgsMapLayerAction : QAction
     /** Triggers the action with the specified layer. This also emits the triggered() slot. */
     void triggerForLayer( QgsMapLayer* layer );
 
+    /** Define the availibility of the action */
+    void setAvailability( Availability availibitly );
+    Availability availability() const;
+
   signals:
     /** Triggered when action has been run for a specific feature */
     void triggeredForFeature( QgsMapLayer* layer, QgsFeature* feature );

diff --git a/src/app/composer/qgscomposer.cpp b/src/app/composer/qgscomposer.cpp
@@ -3573,7 +3573,7 @@ void QgsComposer::updateAtlasMapLayerAction( QgsVectorLayer *coverageLayer )
 
   if ( coverageLayer )
   {
-    mAtlasFeatureAction = new QgsMapLayerAction( QString( tr( "Set as atlas feature for %1" ) ).arg( mTitle ), this, coverageLayer );
+    mAtlasFeatureAction = new QgsMapLayerAction( QString( tr( "Set as atlas feature for %1" ) ).arg( mTitle ), this, coverageLayer, QgsMapLayerAction::Feature );
     QgsMapLayerActionRegistry::instance()->addMapLayerAction( mAtlasFeatureAction );
     connect( mAtlasFeatureAction, SIGNAL( triggeredForFeature( QgsMapLayer*, QgsFeature* ) ), this, SLOT( setAtlasFeature( QgsMapLayer*, QgsFeature* ) ) );
   }

diff --git a/src/gui/qgsmaplayeractionregistry.cpp b/src/gui/qgsmaplayeractionregistry.cpp
@@ -16,31 +16,31 @@
 #include "qgsmaplayeractionregistry.h"
 
 
-QgsMapLayerAction::QgsMapLayerAction( QString name, QObject* parent ) : QAction( name, parent ),
+QgsMapLayerAction::QgsMapLayerAction( QString name, QObject* parent, Availability availability ) : QAction( name, parent ),
     mSingleLayer( false ),
     mActionLayer( 0 ),
-    mSpecificLayerType( false )
+    mSpecificLayerType( false ),
+    mAvailability( availability )
 {
-
 }
 
 /**Creates a map layer action which can run only on a specific layer*/
-QgsMapLayerAction::QgsMapLayerAction( QString name, QObject* parent, QgsMapLayer* layer ) : QAction( name, parent ),
+QgsMapLayerAction::QgsMapLayerAction( QString name, QObject* parent, QgsMapLayer* layer , Availability availability ) : QAction( name, parent ),
     mSingleLayer( true ),
     mActionLayer( layer ),
-    mSpecificLayerType( false )
+    mSpecificLayerType( false ),
+    mAvailability( availability )
 {
-
 }
 
 /**Creates a map layer action which can run on a specific type of layer*/
-QgsMapLayerAction::QgsMapLayerAction( QString name, QObject* parent, QgsMapLayer::LayerType layerType ) : QAction( name, parent ),
+QgsMapLayerAction::QgsMapLayerAction( QString name, QObject* parent, QgsMapLayer::LayerType layerType, Availability availability ) : QAction( name, parent ),
     mSingleLayer( false ),
     mActionLayer( 0 ),
     mSpecificLayerType( true ),
-    mLayerType( layerType )
+    mLayerType( layerType ),
+    mAvailability( availability )
 {
-
 }
 
 QgsMapLayerAction::~QgsMapLayerAction()

diff --git a/src/gui/qgsmaplayeractionregistry.h b/src/gui/qgsmaplayeractionregistry.h
@@ -31,14 +31,23 @@ class QgsFeature;
 class GUI_EXPORT QgsMapLayerAction : public QAction
 {
     Q_OBJECT
+    Q_FLAGS( Availability )
 
   public:
+    enum AvailabityFlag
+    {
+      Layer = 1,
+      Feature = 2,
+      LayerAndFeature = Layer | Feature
+    };
+    Q_DECLARE_FLAGS( Availability, AvailabityFlag )
+
     /**Creates a map layer action which can run on any layer*/
-    QgsMapLayerAction( QString name, QObject *parent );
+    QgsMapLayerAction( QString name, QObject *parent, Availability availability = LayerAndFeature );
     /**Creates a map layer action which can run only on a specific layer*/
-    QgsMapLayerAction( QString name, QObject *parent, QgsMapLayer* layer );
+    QgsMapLayerAction( QString name, QObject *parent, QgsMapLayer* layer, Availability availability = LayerAndFeature );
     /**Creates a map layer action which can run on a specific type of layer*/
-    QgsMapLayerAction( QString name, QObject *parent, QgsMapLayer::LayerType layerType );
+    QgsMapLayerAction( QString name, QObject *parent, QgsMapLayer::LayerType layerType, Availability availability = LayerAndFeature );
 
     ~QgsMapLayerAction();
 
@@ -52,6 +61,11 @@ class GUI_EXPORT QgsMapLayerAction : public QAction
     /** Triggers the action with the specified layer. This also emits the triggered() slot. */
     void triggerForLayer( QgsMapLayer* layer );
 
+    /** Define the availibility of the action */
+    void setAvailability( Availability availabitly ) {mAvailability = availabitly;}
+    /** Return availibity of action */
+    Availability availability() const {return mAvailability;}
+
   signals:
     /** Triggered when action has been run for a specific feature */
     void triggeredForFeature( QgsMapLayer* layer, QgsFeature* feature );
@@ -71,7 +85,8 @@ class GUI_EXPORT QgsMapLayerAction : public QAction
     //layer type if action is only valid for a specific layer type
     QgsMapLayer::LayerType mLayerType;
 
-
+    // determine if the action can be run on feature and/or layer
+    Availability mAvailability;
 };
 
 /**