qgsmaptoolselectutils.h

Go to the documentation of this file.

/***************************************************************************
qgsmaptoolselectutils.h  -  Utility methods to help with select map tools
---------------------
begin                : May 2010
copyright            : (C) 2010 by Jeremy Palmer
email                : jpalmer at linz dot govt 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 QGSMAPTOOLSELECTUTILS_H
#define QGSMAPTOOLSELECTUTILS_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgscoordinatetransform.h"
#include "qgsrendercontext.h"
#include "qgsvectorlayer.h"
 
#include <QFutureWatcher>
#include <QList>
#include <QPoint>
#include <QRect>
 
#define SIP_NO_FILE
 
class QMouseEvent;
class QgsMapCanvas;
class QgsVectorLayer;
class QgsVectorLayerFeatureSource;
class QgsGeometry;
class QgsRubberBand;
class QMenu;
class QgsHighlight;

namespace QgsMapToolSelectUtils
{

  QgsFeatureIds getMatchingFeatures( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, bool doContains, bool singleSelect );

  void setSelectedFeatures(
    QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, Qgis::SelectBehavior selectBehavior = Qgis::SelectBehavior::SetSelection, bool doContains = true, bool singleSelect = false
  );

  void selectMultipleFeatures( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, Qt::KeyboardModifiers modifiers );

  void selectSingleFeature( QgsMapCanvas *canvas, const QgsGeometry &selectGeometry, Qt::KeyboardModifiers modifiers );

  QgsMapLayer *getCurrentTargetLayer( QgsMapCanvas *canvas );

  QgsRectangle GUI_EXPORT expandSelectRectangle( QgsPointXY mapPoint, QgsMapCanvas *canvas, QgsMapLayer *layer );

  void GUI_EXPORT setRubberBand( QgsMapCanvas *canvas, QRect &selectRect, QgsRubberBand *rubberBand );

  class QgsMapToolSelectMenuActions : public QObject
  {
      Q_OBJECT
    public:
      QgsMapToolSelectMenuActions( QgsMapCanvas *canvas, QgsVectorLayer *vectorLayer, Qgis::SelectBehavior behavior, const QgsGeometry &selectionGeometry, QObject *parent = nullptr );
 
      ~QgsMapToolSelectMenuActions() override;

      void populateMenu( QMenu *menu );
 
    private slots:
      void chooseAllCandidateFeature();
      void highlightAllFeatures();
      void onLayerDestroyed();
      void removeHighlight();
      void onSearchFinished();
 
    private:
      QgsMapCanvas *mCanvas = nullptr;
      QgsVectorLayer *mVectorLayer = nullptr;
      Qgis::SelectBehavior mBehavior = Qgis::SelectBehavior::SetSelection;
      QgsGeometry mSelectGeometry;
      QAction *mActionChooseAll = nullptr;
      QMenu *mMenuChooseOne = nullptr;
      QFutureWatcher<QgsFeatureIds> *mFutureWatcher = nullptr;
      QgsFeatureIds mAllFeatureIds;
      QList<QgsHighlight *> mHighlight;
 
      void startFeatureSearch();
 
      QString textForChooseAll( qint64 featureCount = -1 ) const;
      QString textForChooseOneMenu() const;
      void populateChooseOneMenu( const QgsFeatureIds &ids );
 
      static QgsFeatureIds filterIds( const QgsFeatureIds &ids, const QgsFeatureIds &existingSelection, Qgis::SelectBehavior behavior );
 
      struct DataForSearchingJob
      {
          bool isCanceled;
          std::unique_ptr<QgsVectorLayerFeatureSource> source;
          QgsGeometry selectGeometry;
          QgsCoordinateTransform ct;
          QgsRenderContext context;
          std::unique_ptr<QgsFeatureRenderer> featureRenderer;
          QString filterString;
          Qgis::SelectBehavior selectBehavior;
          QgsFeatureIds existingSelection;
      };
 
      std::shared_ptr<DataForSearchingJob> mJobData;
 
      static QgsFeatureIds search( std::shared_ptr<DataForSearchingJob> data );
 
      void chooseOneCandidateFeature( QgsFeatureId id );
      void highlightOneFeature( QgsFeatureId id );
  };
} // namespace QgsMapToolSelectUtils
 
#endif