QGIS API Documentation  3.23.0-Master (eb871beae0)
qgsvectorlayertools.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsvectorlayertools.h
3  --------------------------------------
4  Date : 29.5.2013
5  Copyright : (C) 2013 Matthias Kuhn
6  Email : matthias at opengis dot ch
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSVECTORLAYERTOOLS_H
17 #define QGSVECTORLAYERTOOLS_H
18 
19 #include "qgis_core.h"
20 #include "qgis_sip.h"
21 #include <QObject>
22 
23 #include "qgsfeature.h"
24 #include "qgsgeometry.h"
25 
26 class QgsFeatureRequest;
27 class QgsVectorLayer;
28 
39 class CORE_EXPORT QgsVectorLayerTools : public QObject
40 {
41  Q_OBJECT
42 
43  public:
45 
46  // TODO QGIS 4: remove const qualifier
47 
58  virtual bool addFeature( QgsVectorLayer *layer, const QgsAttributeMap &defaultValues = QgsAttributeMap(), const QgsGeometry &defaultGeometry = QgsGeometry(), QgsFeature *feature SIP_OUT = nullptr ) const = 0;
59 
60  // TODO QGIS 4: remove const qualifier
61 
72  virtual bool startEditing( QgsVectorLayer *layer ) const = 0;
73 
74  // TODO QGIS 4: remove const qualifier
75 
85  virtual bool stopEditing( QgsVectorLayer *layer, bool allowCancel = true ) const = 0;
86 
87  // TODO QGIS 4: remove const qualifier
88 
96  virtual bool saveEdits( QgsVectorLayer *layer ) const = 0;
97 
98  // TODO QGIS 4: remove const qualifier
99 
114  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 ) const;
115 
122  bool forceSuppressFormPopup() const;
123 
132  void setForceSuppressFormPopup( bool forceSuppressFormPopup );
133 
134  private:
135 
136  bool mForceSuppressFormPopup { false };
137 
138 
139 };
140 
141 #endif // QGSVECTORLAYERTOOLS_H
This class wraps a request for features to a vector layer (or directly its vector data provider).
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:125
Methods in this class are used to handle basic operations on vector layers.
virtual bool startEditing(QgsVectorLayer *layer) const =0
This will be called, whenever a vector layer should be switched to edit mode.
virtual bool saveEdits(QgsVectorLayer *layer) const =0
Should be called, when the features should be committed but the editing session is not ended.
virtual bool addFeature(QgsVectorLayer *layer, const QgsAttributeMap &defaultValues=QgsAttributeMap(), const QgsGeometry &defaultGeometry=QgsGeometry(), QgsFeature *feature=nullptr) const =0
This method should/will be called, whenever a new feature will be added to the layer.
virtual bool stopEditing(QgsVectorLayer *layer, bool allowCancel=true) const =0
Will be called, when an editing session is ended and the features should be committed.
Represents a vector layer which manages a vector based data sets.
#define SIP_OUT
Definition: qgis_sip.h:58
#define SIP_INOUT
Definition: qgis_sip.h:71
QMap< int, QVariant > QgsAttributeMap
Definition: qgsattributes.h:38