qgsidentifymenu.h

Go to the documentation of this file.

/***************************************************************************
    qgsidentifymenu.h  -  menu to be used in identify map tool
    ---------------------
    begin                : August 2014
    copyright            : (C) 2014 by Denis Rouzaud
    email                : denis.rouzaud@gmail.com
 ***************************************************************************
 *                                                                         *
 *   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 QGSIDENTIFYMENU_H
#define QGSIDENTIFYMENU_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsexpressioncontext.h"
#include "qgsmaplayeractionregistry.h"
#include "qgsmaptoolidentify.h"
 
#include <QMenu>
 
#ifndef SIP_RUN
class CustomActionRegistry : public QgsMapLayerActionRegistry
{
    Q_OBJECT
 
  public:
#include "qgsmaplayeractionregistry.h"
    CustomActionRegistry() = default;
    // remove all actions
    void clear() { mMapLayerActionList.clear(); }
};
#endif

class GUI_EXPORT QgsIdentifyMenu : public QMenu
{
    Q_OBJECT
 
  public:
    enum MenuLevel
    {
      LayerLevel,
      FeatureLevel
    };
 
    struct ActionData
    {
        ActionData() = default;
 
        ActionData( QgsMapLayer *layer, QgsMapLayerAction *mapLayerAction = nullptr )
          : mIsValid( true )
          , mAllResults( !layer )
          , mIsExternalAction( nullptr != mapLayerAction )
          , mLayer( layer )
          , mMapLayerAction( mapLayerAction )
        {}
 
        ActionData( QgsMapLayer *layer, QgsFeatureId fid, QgsMapLayerAction *mapLayerAction = nullptr )
          : mIsValid( true )
          , mIsExternalAction( nullptr != mapLayerAction )
          , mLayer( layer )
          , mFeatureId( fid )
          , mLevel( FeatureLevel )
          , mMapLayerAction( mapLayerAction )
        {}
 
        bool mIsValid = false;
        bool mAllResults = false;
        bool mIsExternalAction = false;
        QgsMapLayer *mLayer = nullptr;
        QgsFeatureId mFeatureId = 0;
        QgsIdentifyMenu::MenuLevel mLevel = LayerLevel;
        QgsMapLayerAction *mMapLayerAction = nullptr;
    };

    explicit QgsIdentifyMenu( QgsMapCanvas *canvas );
 
    ~QgsIdentifyMenu() override;
 

    static QList<QgsMapToolIdentify::IdentifyResult> findFeaturesOnCanvas( QgsMapMouseEvent *event, QgsMapCanvas *canvas, const QList<Qgis::GeometryType> &geometryTypes );

    void setAllowMultipleReturn( bool multipleReturn ) { mAllowMultipleReturn = multipleReturn; }
    bool allowMultipleReturn() { return mAllowMultipleReturn; }

    void setExecWithSingleResult( bool execWithSingleResult ) { mExecWithSingleResult = execWithSingleResult; }
    bool execWithSingleResult() { return mExecWithSingleResult; }

    void setExpressionContextScope( const QgsExpressionContextScope &scope );

    QgsExpressionContextScope expressionContextScope() const;

    void setShowFeatureActions( bool showFeatureActions ) { mShowFeatureActions = showFeatureActions; }
    bool showFeatureActions() { return mShowFeatureActions; }

    void setResultsIfExternalAction( bool resultsIfExternalAction ) { mResultsIfExternalAction = resultsIfExternalAction; }
    bool resultsIfExternalAction() { return mResultsIfExternalAction; }

    void setMaxLayerDisplay( int maxLayerDisplay );
    int maxLayerDisplay() { return mMaxLayerDisplay; }

    void setMaxFeatureDisplay( int maxFeatureDisplay );
    int maxFeatureDisplay() { return mMaxFeatureDisplay; }

    void addCustomAction( QgsMapLayerAction *action ) { mCustomActionRegistry.addMapLayerAction( action ); }

    void removeCustomActions();

    QList<QgsMapToolIdentify::IdentifyResult> exec( const QList<QgsMapToolIdentify::IdentifyResult> &idResults, QPoint pos );

    Q_DECL_DEPRECATED static void styleHighlight( QgsHighlight *highlight ) SIP_DEPRECATED;
 
  signals:

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

    void messageDiscarded();
 
  protected:
    void closeEvent( QCloseEvent *e ) override;
 
  private slots:
    void handleMenuHover();
    void deleteRubberBands();
    void layerDestroyed();
    void triggerMapLayerAction();
 
  private:
    void addRasterLayer( QgsMapLayer *layer );

    void addVectorLayer( QgsVectorLayer *layer, const QList<QgsMapToolIdentify::IdentifyResult> &results, bool singleLayer = false );

    QList<QgsMapToolIdentify::IdentifyResult> results( QAction *action, bool &externalAction );
 
    QgsMapCanvas *mCanvas = nullptr;
    QList<QgsHighlight *> mRubberBands;
    bool mAllowMultipleReturn = true;
    bool mExecWithSingleResult = false;
    bool mShowFeatureActions = false;
    bool mResultsIfExternalAction = false;
    int mMaxLayerDisplay = 10;
    int mMaxFeatureDisplay = 10;
 
    QgsExpressionContextScope mExpressionContextScope;
 
    // name of the action to be displayed for feature default action, if other actions are shown
    QString mDefaultActionName;
 
    // custom menu actions regirstry
    CustomActionRegistry mCustomActionRegistry;
 
    // map layers with their results, this is the odering of the menu
    QMap<QgsMapLayer *, QList<QgsMapToolIdentify::IdentifyResult>> mLayerIdResults;
};
 
Q_DECLARE_METATYPE( QgsIdentifyMenu::ActionData )
 
#endif // QGSIDENTIFYMENU_H