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 <QString>
#include <QIcon>

class CORE_EXPORT QgsAction
{
  public:
    enum ActionType
    {
      Generic,
      GenericPython,
      Mac,
      Windows,
      Unix,
      OpenUrl,
    };

    QgsAction( ActionType type, const QString& description, const QString& action, bool capture )
        : mType( type )
        , mDescription( description )
        , mAction( action )
        , mCaptureOutput( capture )
        , mShowInAttributeTable( true )
    {}


    QgsAction( ActionType type, const QString& description, const QString& action, const QString& icon, bool capture, const QString& shortTitle = QString() )
        : mType( type )
        , mDescription( description )
        , mShortTitle( shortTitle )
        , mIcon( icon )
        , mAction( action )
        , mCaptureOutput( capture )
        , mShowInAttributeTable( true )
    {}

    QgsAction( ActionType type, const QString& description, const QString& action, const QString& icon, bool capture, bool showInAttributeTable, const QString& shortTitle = QString() )
        : mType( type )
        , mDescription( description )
        , mShortTitle( shortTitle )
        , mIcon( icon )
        , mAction( action )
        , mCaptureOutput( capture )
        , mShowInAttributeTable( showInAttributeTable )
    {}

    QString name() const { return mDescription; }

    QString shortTitle() const { return mShortTitle; }

    QString iconPath() const { return mIcon; }

    QIcon icon() const { return QIcon( mIcon ); }

    QString action() const { return mAction; }

    ActionType type() const { return mType; }

    bool capture() const { return mCaptureOutput; }

    bool showInAttributeTable() const { return mShowInAttributeTable; }

    bool runable() const;

  private:
    ActionType mType;
    QString mDescription;
    QString mShortTitle;
    QString mIcon;
    QString mAction;
    bool mCaptureOutput;
    bool mShowInAttributeTable;
};

#endif // QGSACTION_H