qgsaction.h

Go to the documentation of this file.

/***************************************************************************
  qgsaction.h - QgsAction
 
 ---------------------
 begin                : 18.4.2016
 copyright            : (C) 2016 by Matthias Kuhn
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSACTION_H
#define QGSACTION_H
 
#include "qgis_core.h"
#include <QSet>
#include <QString>
#include <QIcon>
#include <QUuid>
 
#include "qgsexpressioncontext.h"
#include <memory>
 
class QgsExpressionContextScope;
 
class CORE_EXPORT QgsAction
{
  public:
    enum ActionType
    {
      Generic,
      GenericPython,
      Mac,
      Windows,
      Unix,
      OpenUrl,
      SubmitUrlEncoded, 
      SubmitUrlMultipart, 
    };
 
    QgsAction() = default;
 
    QgsAction( ActionType type, const QString &description, const QString &command, bool capture = false, bool enabledOnlyWhenEditable SIP_PYARGREMOVE = false )
      : mType( type )
      , mDescription( description )
      , mCommand( command )
      , mCaptureOutput( capture )
      , mId( QUuid::createUuid() )
      , mIsEnabledOnlyWhenEditable( enabledOnlyWhenEditable )
    {}
 
    QgsAction( ActionType type, const QString &description, const QString &action, const QString &icon, bool capture, const QString &shortTitle = QString(), const QSet<QString> &actionScopes = QSet<QString>(), const QString &notificationMessage = QString(), bool enabledOnlyWhenEditable SIP_PYARGREMOVE = false )
      : mType( type )
      , mDescription( description )
      , mShortTitle( shortTitle )
      , mIcon( icon )
      , mCommand( action )
      , mCaptureOutput( capture )
      , mActionScopes( actionScopes )
      , mNotificationMessage( notificationMessage )
      , mId( QUuid::createUuid() )
      , mIsEnabledOnlyWhenEditable( enabledOnlyWhenEditable )
    {}
 
    QgsAction( const QUuid &id, ActionType type, const QString &description, const QString &action, const QString &icon, bool capture, const QString &shortTitle = QString(), const QSet<QString> &actionScopes = QSet<QString>(), const QString &notificationMessage = QString(), bool enabledOnlyWhenEditable SIP_PYARGREMOVE = false )
      : mType( type )
      , mDescription( description )
      , mShortTitle( shortTitle )
      , mIcon( icon )
      , mCommand( action )
      , mCaptureOutput( capture )
      , mActionScopes( actionScopes )
      , mNotificationMessage( notificationMessage )
      , mId( id )
      , mIsEnabledOnlyWhenEditable( enabledOnlyWhenEditable )
    {}
 
 
    QString name() const { return mDescription; }
 
    QString shortTitle() const { return mShortTitle; }
 
    QUuid id() const { return mId; }
 
    bool isValid() const { return !mId.isNull(); }
 
    QString iconPath() const { return mIcon; }
 
    QIcon icon() const { return QIcon( mIcon ); }
 
    QString command() const { return mCommand; }
 
    QString notificationMessage() const { return mNotificationMessage; }
 
    ActionType type() const { return mType; }
 
    bool capture() const { return mCaptureOutput; }
 
 
    bool isEnabledOnlyWhenEditable() const { return mIsEnabledOnlyWhenEditable; }
 
    void setEnabledOnlyWhenEditable( bool enable ) { mIsEnabledOnlyWhenEditable = enable; };
 
 
    bool runable() const;
 
    void run( QgsVectorLayer *layer, const QgsFeature &feature, const QgsExpressionContext &expressionContext ) const;
 
    void run( const QgsExpressionContext &expressionContext ) const;
 
    QSet<QString> actionScopes() const;
 
    void setActionScopes( const QSet<QString> &actionScopes );
 
    void readXml( const QDomNode &actionNode );
 
    void writeXml( QDomNode &actionsNode ) const;
 
    void setExpressionContextScope( const QgsExpressionContextScope &scope );
 
    QgsExpressionContextScope expressionContextScope() const;
 
    QString html( ) const;
 
  private:
 
    void handleFormSubmitAction( const QString &expandedAction ) const;
    ActionType mType = Generic;
    QString mDescription;
    QString mShortTitle;
    QString mIcon;
    QString mCommand;
    bool mCaptureOutput = false;
    QSet<QString> mActionScopes;
    QString mNotificationMessage;
    QUuid mId;
    QgsExpressionContextScope mExpressionContextScope;
    bool mIsEnabledOnlyWhenEditable = false;
};
 
Q_DECLARE_METATYPE( QgsAction )
 
#endif // QGSACTION_H