qgsvectorlayertools.h

Go to the documentation of this file.

/***************************************************************************
    qgsvectorlayertools.h
     --------------------------------------
    Date                 : 29.5.2013
    Copyright            : (C) 2013 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 QGSVECTORLAYERTOOLS_H
#define QGSVECTORLAYERTOOLS_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsexpressioncontext.h"
#include "qgsfeature.h"
#include "qgsgeometry.h"
#include "qgsvectorlayertoolscontext.h"
 
#include <QObject>
 
class QgsFeatureRequest;
class QgsVectorLayer;
class QgsProject;

class CORE_EXPORT QgsVectorLayerTools : public QObject
{
    Q_OBJECT
 
  public:
    QgsVectorLayerTools();
 
    // TODO QGIS 5: remove const qualifier

    virtual bool addFeature(
      QgsVectorLayer *layer,
      const QgsAttributeMap &defaultValues = QgsAttributeMap(),
      const QgsGeometry &defaultGeometry = QgsGeometry(),
      QgsFeature *feature SIP_OUT = nullptr,
      QWidget *parentWidget = nullptr,
      bool showModal = true,
      bool hideParent = false
    ) const
    {
      QgsVectorLayerToolsContext context;
      context.setParentWidget( parentWidget );
      context.setShowModal( showModal );
      context.setHideParent( hideParent );
      return addFeatureV2( layer, defaultValues, defaultGeometry, feature, context );
    }

    virtual bool addFeatureV2(
      QgsVectorLayer *layer,
      const QgsAttributeMap &defaultValues = QgsAttributeMap(),
      const QgsGeometry &defaultGeometry = QgsGeometry(),
      QgsFeature *feature SIP_OUT = nullptr,
      const QgsVectorLayerToolsContext &context = QgsVectorLayerToolsContext()
    ) const
    {
      Q_UNUSED( context )
      return addFeature( layer, defaultValues, defaultGeometry, feature, context.parentWidget(), context.showModal(), context.hideParent() );
    }
 
    // TODO QGIS 5: remove const qualifier

    virtual bool startEditing( QgsVectorLayer *layer ) const = 0;
 
    // TODO QGIS 5: remove const qualifier

    virtual bool stopEditing( QgsVectorLayer *layer, bool allowCancel = true ) const = 0;
 
    // TODO QGIS 5: remove const qualifier

    virtual bool saveEdits( QgsVectorLayer *layer ) const = 0;
 
    // TODO QGIS 5: remove const qualifier

    virtual bool copyMoveFeatures(
      QgsVectorLayer *layer,
      QgsFeatureRequest &request SIP_INOUT,
      double dx = 0,
      double dy = 0,
      QString *errorMsg SIP_OUT = nullptr,
      const bool topologicalEditing = false,
      QgsVectorLayer *topologicalLayer = nullptr,
      QString *childrenInfoMsg = nullptr
    ) const;

    bool forceSuppressFormPopup() const;

    void setForceSuppressFormPopup( bool forceSuppressFormPopup );

    void setProject( QgsProject *project ) { mProject = project; }

    QgsProject *project() const { return mProject; }
 
  private:
    QgsProject *mProject = nullptr;
    bool mForceSuppressFormPopup { false };
};
 
#endif // QGSVECTORLAYERTOOLS_H