qgsactionmanager.h

Go to the documentation of this file.

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

 These classes store and control the management 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 "qgis_core.h"
#include <QString>
#include <QIcon>
#include <QObject>

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

class QDomNode;
class QDomDocument;
class QgsPythonUtils;
class QgsVectorLayer;
class QgsExpressionContextScope;
class QgsExpressionContext;

class CORE_EXPORT QgsActionManager: public QObject
{
    Q_OBJECT

  public:
    QgsActionManager( QgsVectorLayer *layer )
      : mLayer( layer )
    {}

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

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

    void addAction( const QgsAction &action );

    void removeAction( QUuid actionId );

    void doAction( QUuid actionId, const QgsFeature &feature, int defaultValueIndex = 0, const QgsExpressionContextScope &scope = QgsExpressionContextScope() ) SIP_PYNAME( doActionFeature );

    void doAction( QUuid actionId, const QgsFeature &feature, const QgsExpressionContext &context );

    void clearActions();

    QList<QgsAction> actions( const QString &actionScope = QString() ) const;

    QgsVectorLayer *layer() const { return mLayer; }

    bool writeXml( QDomNode &layer_node ) const;

    bool readXml( const QDomNode &layer_node );

    QgsAction action( QUuid id );

    void setDefaultAction( const QString &actionScope, QUuid actionId );

    QgsAction defaultAction( const QString &actionScope );

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

    void runAction( const QgsAction &action );

    QMap<QString, QUuid> mDefaultActions;

    bool mOnNotifyConnected = false;

    QgsExpressionContext createExpressionContext() const;

  private slots:
    void onNotifyRunActions( const QString &message );
};

#endif