qgsactionmenu.h

Go to the documentation of this file.

/***************************************************************************
    qgsactionmenu.h
     --------------------------------------
    Date                 : 11.8.2014
    Copyright            : (C) 2014 Matthias Kuhn
    Email                : matthias at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSACTIONMENU_H
#define QGSACTIONMENU_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsaction.h"
#include "qgsattributeeditorcontext.h"
#include "qgsfeature.h"
 
#include <QMenu>
 
class QgsMapLayer;
class QgsMapLayerAction;
class QgsVectorLayer;
class QgsActionManager;
class QgsMapLayerActionContextGenerator;

class GUI_EXPORT QgsActionMenu : public QMenu
{
    Q_OBJECT
 
  public:
    struct GUI_EXPORT ActionData
    {
        ActionData() = default;
        ActionData( const QgsAction &action, QgsFeatureId featureId, QgsMapLayer *mapLayer );
        ActionData( QgsMapLayerAction *action, QgsFeatureId featureId, QgsMapLayer *mapLayer );
 
        Qgis::ActionType actionType = Qgis::ActionType::Invalid;
        QVariant actionData;
        QgsFeatureId featureId = 0;
        QgsMapLayer *mapLayer = nullptr;
    };

    explicit QgsActionMenu( QgsVectorLayer *layer, const QgsFeature &feature, const QString &actionScope, QWidget *parent SIP_TRANSFERTHIS = nullptr );

    explicit QgsActionMenu( QgsVectorLayer *layer, QgsFeatureId fid, const QString &actionScope, QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void setActionContextGenerator( QgsMapLayerActionContextGenerator *generator );

    void setFeature( const QgsFeature &feature );

    void setMode( QgsAttributeEditorContext::Mode mode );

    void setExpressionContextScope( const QgsExpressionContextScope &scope );

    QgsExpressionContextScope expressionContextScope() const;

    QList<QgsAction> menuActions() const;

    bool isEmpty() const;
 
  signals:

    void reinit();

    void messageEmitted( const QString &message, Qgis::MessageLevel level = Qgis::MessageLevel::Info );

    void messageDiscarded();
 
  private slots:
    void triggerAction();
    void reloadActions();
    void layerWillBeDeleted();
 
  private:
    void init();
    QgsFeature feature();
 
    QgsVectorLayer *mLayer = nullptr;
    int mVisibleActionCount = 0;
    QList<QgsAction> mActions;
    QgsFeature mFeature;
    QgsFeatureId mFeatureId;
    QString mActionScope;
    QgsExpressionContextScope mExpressionContextScope;
    QgsAttributeEditorContext::Mode mMode = QgsAttributeEditorContext::SingleEditMode;
 
    QgsMapLayerActionContextGenerator *mContextGenerator = nullptr;
};
 
 
Q_DECLARE_METATYPE( QgsActionMenu::ActionData )
 
#endif // QGSACTIONMENU_H