QGIS API Documentation  3.17.0-Master (a035f434f4)
qgsvectorlayereditbuffer.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsvectorlayereditbuffer.h
3  ---------------------
4  begin : Dezember 2012
5  copyright : (C) 2012 by Martin Dobias
6  email : wonder dot sk at gmail dot com
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 #ifndef QGSVECTORLAYEREDITBUFFER_H
16 #define QGSVECTORLAYEREDITBUFFER_H
17 
18 #include "qgis_core.h"
19 #include <QList>
20 #include <QSet>
21 
22 #include "qgsfeature.h"
23 #include "qgsfields.h"
24 #include "qgsgeometry.h"
25 
27 
28 typedef QList<int> QgsAttributeList SIP_SKIP;
29 typedef QSet<int> QgsAttributeIds SIP_SKIP;
30 typedef QMap<QgsFeatureId, QgsFeature> QgsFeatureMap;
31 
36 class CORE_EXPORT QgsVectorLayerEditBuffer : public QObject
37 {
38  Q_OBJECT
39  public:
41 
43  virtual bool isModified() const;
44 
45 
51  virtual bool addFeature( QgsFeature &f );
52 
54  virtual bool addFeatures( QgsFeatureList &features );
55 
57  virtual bool deleteFeature( QgsFeatureId fid );
58 
60  virtual bool deleteFeatures( const QgsFeatureIds &fid );
61 
63  virtual bool changeGeometry( QgsFeatureId fid, const QgsGeometry &geom );
64 
66  virtual bool changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue = QVariant() );
67 
73  virtual bool changeAttributeValues( QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues );
74 
79  virtual bool addAttribute( const QgsField &field );
80 
82  virtual bool deleteAttribute( int attr );
83 
90  virtual bool renameAttribute( int attr, const QString &newName );
91 
107  virtual bool commitChanges( QStringList &commitErrors );
108 
110  virtual void rollBack();
111 
116  QgsFeatureMap addedFeatures() const { return mAddedFeatures; }
117 
124  bool isFeatureAdded( QgsFeatureId id ) const { return mAddedFeatures.contains( id ); }
125 
130  QgsChangedAttributesMap changedAttributeValues() const { return mChangedAttributeValues; }
131 
138  bool isFeatureAttributesChanged( QgsFeatureId id ) const { return mChangedAttributeValues.contains( id ); }
139 
144  QgsAttributeList deletedAttributeIds() const { return mDeletedAttributeIds; }
145 
152  bool isAttributeDeleted( int index ) const { return mDeletedAttributeIds.contains( index ); }
153 
157  QList<QgsField> addedAttributes() const { return mAddedAttributes; }
158 
163  QgsGeometryMap changedGeometries() const { return mChangedGeometries; }
164 
171  bool isFeatureGeometryChanged( QgsFeatureId id ) const { return mChangedGeometries.contains( id ); }
172 
177  QgsFeatureIds deletedFeatureIds() const { return mDeletedFeatureIds; }
178 
185  bool isFeatureDeleted( QgsFeatureId id ) const { return mDeletedFeatureIds.contains( id ); }
186 
187  //QString dumpEditBuffer();
188 
189  protected slots:
190  void undoIndexChanged( int index );
191 
192  signals:
194  void layerModified();
195 
196  void featureAdded( QgsFeatureId fid );
197  void featureDeleted( QgsFeatureId fid );
198 
204  void geometryChanged( QgsFeatureId fid, const QgsGeometry &geom );
205 
206  void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant & );
207  void attributeAdded( int idx );
208  void attributeDeleted( int idx );
209 
216  void attributeRenamed( int idx, const QString &newName );
217 
219  void committedAttributesDeleted( const QString &layerId, const QgsAttributeList &deletedAttributes );
220  void committedAttributesAdded( const QString &layerId, const QList<QgsField> &addedAttributes );
221 
228  void committedAttributesRenamed( const QString &layerId, const QgsFieldNameMap &renamedAttributes );
229  void committedFeaturesAdded( const QString &layerId, const QgsFeatureList &addedFeatures );
230  void committedFeaturesRemoved( const QString &layerId, const QgsFeatureIds &deletedFeatureIds );
231  void committedAttributeValuesChanges( const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues );
232  void committedGeometriesChanges( const QString &layerId, const QgsGeometryMap &changedGeometries );
233 
234  protected:
235 
237  QgsVectorLayerEditBuffer() = default;
238 
239  void updateFields( QgsFields &fields );
240 
242  void updateFeatureGeometry( QgsFeature &f );
243 
245  void updateChangedAttributes( QgsFeature &f );
246 
248  void handleAttributeAdded( int index );
249 
251  void handleAttributeDeleted( int index );
252 
254  void updateAttributeMapIndex( QgsAttributeMap &attrs, int index, int offset ) const;
255 
256  void updateLayerFields();
257 
258  protected:
259  QgsVectorLayer *L = nullptr;
260  friend class QgsVectorLayer;
261 
270 
281 
288 
291 
294 
297 
299  QList<QgsField> mAddedAttributes;
300 
303 
306 
307  friend class QgsGrassProvider; //GRASS provider totally abuses the edit buffer
308 };
309 
310 #endif // QGSVECTORLAYEREDITBUFFER_H
Undo command for deleting attri of a vector layer in transaction group.
Undo command for removing an existing attribute from a vector layer.
QMap< QgsFeatureId, QgsGeometry > QgsGeometryMap
Definition: qgsfeature.h:578
QSet< QgsFeatureId > QgsFeatureIds
Definition: qgsfeatureid.h:37
Undo command for deleting a feature from a vector layer.
Undo command for deleting attri of a vector layer in transaction group.
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:583
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features ...
Definition: qgsfeatureid.h:28
Base class for undo commands within a QgsVectorLayerEditBuffer.
Container of fields for a vector layer.
Definition: qgsfields.h:44
Undo command for modifying an attribute of a feature from a vector layer.
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:123
Undo command for vector layer in transaction group mode.
QgsChangedAttributesMap mChangedAttributeValues
Changed attributes values which are not committed.
bool isFeatureAdded(QgsFeatureId id) const
Returns true if the specified feature ID has been added but not committed.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
QgsFieldNameMap mRenamedAttributes
Renamed attributes which are not committed.
QgsChangedAttributesMap changedAttributeValues() const
Returns a map of features with changed attributes values which are not committed. ...
Undo command for adding attri to a vector layer in transaction group.
Undo command for changing attr value from a vector layer in transaction group.
QgsFeatureIds deletedFeatureIds() const
Returns a list of deleted feature IDs which are not committed.
Undo command for adding a feature to a vector layer.
QSet< int > QgsAttributeIds
Undo command for changing feature geometry from a vector layer in transaction group.
Undo command for modifying the geometry of a feature from a vector layer.
QgsGeometryMap changedGeometries() const
Returns a map of features with changed geometries which are not committed.
#define SIP_SKIP
Definition: qgis_sip.h:126
QMap< int, QVariant > QgsAttributeMap
Definition: qgsattributes.h:38
QgsGeometryMap mChangedGeometries
Changed geometries which are not committed.
QgsAttributeList deletedAttributeIds() const
Returns a list of deleted attributes fields which are not committed.
Undo command for renaming an existing attribute of a vector layer.
Undo command for running a specific sql query in transaction group.
QgsFeatureIds mDeletedFeatureIds
Deleted feature IDs which are not committed.
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:49
bool isFeatureAttributesChanged(QgsFeatureId id) const
Returns true if the specified feature ID has had an attribute changed but not committed.
bool isAttributeDeleted(int index) const
Returns true if the specified attribute has been deleted but not committed.
QMap< int, QString > QgsFieldNameMap
Definition: qgsattributes.h:44
Undo command for adding a new attribute to a vector layer.
Undo command for deleting features from a vector layer in transaction group.
QMap< QgsFeatureId, QgsFeature > QgsFeatureMap
Undo command for changing attributes&#39; values from a vector layer in transaction group.
QgsFeatureMap addedFeatures() const
Returns a map of new features which are not committed.
QList< QgsField > mAddedAttributes
Added attributes fields which are not committed.
QMap< QgsFeatureId, QgsAttributeMap > QgsChangedAttributesMap
Definition: qgsfeature.h:569
Undo command for adding a feature to a vector layer in transaction group mode.
bool isFeatureDeleted(QgsFeatureId id) const
Returns true if the specified feature ID has been deleted but not committed.
QList< int > QgsAttributeList
Definition: qgsfield.h:26
QList< QgsField > addedAttributes() const
Returns a list of added attributes fields which are not committed.
QgsFeatureMap mAddedFeatures
New features which are not committed.
Represents a vector layer which manages a vector based data sets.
QgsAttributeList mDeletedAttributeIds
Deleted attributes fields which are not committed. The list is kept sorted.
const QgsField & field
Definition: qgsfield.h:471
bool isFeatureGeometryChanged(QgsFeatureId id) const
Returns true if the specified feature ID has had its geometry changed but not committed.