qgsmaplayeraction.h

Go to the documentation of this file.

/***************************************************************************
    qgsmaplayeraction.h
    ---------------------------
    begin                : January 2014
    copyright            : (C) 2014 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSMAPLAYERACTION_H
#define QGSMAPLAYERACTION_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QAction>
#include <QList>
#include <QMap>
#include <QObject>
#include <QPointer>
 
class QgsFeature;
class QgsMapLayer;
class QgsMapLayerActionContext;
 

class GUI_EXPORT QgsMapLayerAction : public QAction
{
    Q_OBJECT
 
  public:
    QgsMapLayerAction(
      const QString &name,
      QObject *parent SIP_TRANSFERTHIS,
      Qgis::MapLayerActionTargets targets = Qgis::MapLayerActionTarget::AllActions,
      const QIcon &icon = QIcon(),
      Qgis::MapLayerActionFlags flags = Qgis::MapLayerActionFlags()
    );

    QgsMapLayerAction(
      const QString &name,
      QObject *parent SIP_TRANSFERTHIS,
      QgsMapLayer *layer,
      Qgis::MapLayerActionTargets targets = Qgis::MapLayerActionTarget::AllActions,
      const QIcon &icon = QIcon(),
      Qgis::MapLayerActionFlags flags = Qgis::MapLayerActionFlags()
    );

    QgsMapLayerAction(
      const QString &name,
      QObject *parent SIP_TRANSFERTHIS,
      Qgis::LayerType layerType,
      Qgis::MapLayerActionTargets targets = Qgis::MapLayerActionTarget::AllActions,
      const QIcon &icon = QIcon(),
      Qgis::MapLayerActionFlags flags = Qgis::MapLayerActionFlags()
    );
 
    ~QgsMapLayerAction() override;

    Qgis::MapLayerActionFlags flags() const;

    Q_DECL_DEPRECATED virtual bool canRunUsingLayer( QgsMapLayer *layer ) const SIP_DEPRECATED;

    virtual bool canRunUsingLayer( QgsMapLayer *layer, const QgsMapLayerActionContext &context ) const;

    Q_DECL_DEPRECATED virtual void triggerForFeatures( QgsMapLayer *layer, const QList<QgsFeature> &featureList ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED virtual void triggerForFeature( QgsMapLayer *layer, const QgsFeature &feature ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED virtual void triggerForLayer( QgsMapLayer *layer ) SIP_DEPRECATED;

    virtual void triggerForFeatures( QgsMapLayer *layer, const QList<QgsFeature> &featureList, const QgsMapLayerActionContext &context );

    virtual void triggerForFeature( QgsMapLayer *layer, const QgsFeature &feature, const QgsMapLayerActionContext &context );

    virtual void triggerForLayer( QgsMapLayer *layer, const QgsMapLayerActionContext &context );

    void setTargets( Qgis::MapLayerActionTargets targets ) { mTargets = targets; }
    Qgis::MapLayerActionTargets targets() const { return mTargets; }

    bool isEnabledOnlyWhenEditable() const;
 
  signals:

    Q_DECL_DEPRECATED void triggeredForFeatures( QgsMapLayer *layer, const QList<QgsFeature> &featureList ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void triggeredForFeature( QgsMapLayer *layer, const QgsFeature &feature ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED void triggeredForLayer( QgsMapLayer *layer ) SIP_DEPRECATED;

    void triggeredForFeaturesV2( QgsMapLayer *layer, const QList<QgsFeature> &featureList, const QgsMapLayerActionContext &context );

    void triggeredForFeatureV2( QgsMapLayer *layer, const QgsFeature &feature, const QgsMapLayerActionContext &context );

    void triggeredForLayerV2( QgsMapLayer *layer, const QgsMapLayerActionContext &context );
 
  private:
    // true if action is only valid for a single layer
    bool mSingleLayer = false;
    // layer if action is only valid for a single layer
    QgsMapLayer *mActionLayer = nullptr;
 
    // true if action is only valid for a specific layer type
    bool mSpecificLayerType = false;
    // layer type if action is only valid for a specific layer type
    Qgis::LayerType mLayerType = Qgis::LayerType::Vector;
 
    // determine if the action can be run on layer and/or single feature and/or multiple features
    Qgis::MapLayerActionTargets mTargets = Qgis::MapLayerActionTargets();
 
    Qgis::MapLayerActionFlags mFlags = Qgis::MapLayerActionFlags();
};
 
 
#endif // QGSMAPLAYERACTION_H