qgsactionmanager.h

Go to the documentation of this file.

/***************************************************************************
                          qgsactionmanager.h

 These classes store and control the managment and execution of actions
 associated with a particular Qgis layer. Actions are defined to be
 external programs that are run with user-specified inputs that can
 depend on the contents of layer attributes.

                             -------------------
    begin                : Oct 24 2004
    copyright            : (C) 2004 by Gavin Macaulay
    email                : gavin at macaulay dot co dot nz
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSACTIONMANAGER_H
#define QGSACTIONMANAGER_H

#include <QString>
#include <QIcon>

#include "qgsaction.h"
#include "qgsfeature.h"
#include "qgsexpressioncontext.h"

class QDomNode;
class QDomDocument;
class QgsPythonUtils;
class QgsVectorLayer;


class CORE_EXPORT QgsActionManager
{
  public:
    QgsActionManager( QgsVectorLayer *layer )
        : mLayer( layer )
        , mDefaultAction( -1 )
    {}

    void addAction( QgsAction::ActionType type, const QString& name, const QString& action, bool capture = false );

    void addAction( QgsAction::ActionType type, const QString& name, const QString& action, const QString& icon, bool capture = false );

    void addAction( const QgsAction& action );

    void removeAction( int index );

    void doAction( int index,
                   const QgsFeature &feat,
                   int defaultValueIndex = 0,
                   const QgsExpressionContextScope &scope = QgsExpressionContextScope() );

    // TODO QGIS 3.0 remove substition map - force use of expression variables
    void doAction( int index,
                   const QgsFeature& feature,
                   const QgsExpressionContext& context,
                   const QMap<QString, QVariant> *substitutionMap = nullptr );

    Q_DECL_DEPRECATED void doAction( int index,
                                     const QgsFeature &feat,
                                     const QMap<QString, QVariant> *substitutionMap );

    void clearActions();

    QList<QgsAction> listActions() const;

    QgsVectorLayer* layer() const { return mLayer; }

    Q_DECL_DEPRECATED QString expandAction( QString action, const QgsAttributeMap &attributes, uint defaultValueIndex );

    Q_DECL_DEPRECATED QString expandAction( const QString& action,
                                            QgsFeature &feat,
                                            const QMap<QString, QVariant> *substitutionMap = nullptr );


    bool writeXML( QDomNode& layer_node, QDomDocument& doc ) const;

    bool readXML( const QDomNode& layer_node );

    int size() const { return mActions.size(); }

    const QgsAction& at( int idx ) const { return mActions.at( idx ); }

    QgsAction operator[]( int idx ) const { return mActions[idx]; }

    Q_DECL_DEPRECATED static void setPythonExecute( void ( * )( const QString & ) );

    int defaultAction() const { return mDefaultAction < 0 || mDefaultAction >= size() ? -1 : mDefaultAction; }

    void setDefaultAction( int actionNumber ) { mDefaultAction = actionNumber ; }

  private:
    QList<QgsAction> mActions;
    QgsVectorLayer *mLayer;
    static void ( *smPythonExecute )( const QString & );

    void runAction( const QgsAction &action,
                    void ( *executePython )( const QString & ) = nullptr );

    int mDefaultAction;

    QgsExpressionContext createExpressionContext() const;
};

#endif