QGIS API Documentation  3.21.0-Master (564c892cfd)
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 
26 class QgsVectorLayer;
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 
50  virtual bool addFeature( QgsFeature &f );
51 
53  virtual bool addFeatures( QgsFeatureList &features );
54 
56  virtual bool deleteFeature( QgsFeatureId fid );
57 
59  virtual bool deleteFeatures( const QgsFeatureIds &fid );
60 
62  virtual bool changeGeometry( QgsFeatureId fid, const QgsGeometry &geom );
63 
65  virtual bool changeAttributeValue( QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue = QVariant() );
66 
72  virtual bool changeAttributeValues( QgsFeatureId fid, const QgsAttributeMap &newValues, const QgsAttributeMap &oldValues );
73 
78  virtual bool addAttribute( const QgsField &field );
79 
81  virtual bool deleteAttribute( int attr );
82 
89  virtual bool renameAttribute( int attr, const QString &newName );
90 
106  virtual bool commitChanges( QStringList &commitErrors );
107 
109  virtual void rollBack();
110 
115  QgsFeatureMap addedFeatures() const { return mAddedFeatures; }
116 
123  QgsFeatureIds allAddedOrEditedFeatures() const;
124 
131  bool isFeatureAdded( QgsFeatureId id ) const { return mAddedFeatures.contains( id ); }
132 
137  QgsChangedAttributesMap changedAttributeValues() const { return mChangedAttributeValues; }
138 
145  bool isFeatureAttributesChanged( QgsFeatureId id ) const { return mChangedAttributeValues.contains( id ); }
146 
151  QgsAttributeList deletedAttributeIds() const { return mDeletedAttributeIds; }
152 
159  bool isAttributeDeleted( int index ) const { return mDeletedAttributeIds.contains( index ); }
160 
164  QList<QgsField> addedAttributes() const { return mAddedAttributes; }
165 
170  QgsGeometryMap changedGeometries() const { return mChangedGeometries; }
171 
178  bool isFeatureGeometryChanged( QgsFeatureId id ) const { return mChangedGeometries.contains( id ); }
179 
184  QgsFeatureIds deletedFeatureIds() const { return mDeletedFeatureIds; }
185 
192  bool isFeatureDeleted( QgsFeatureId id ) const { return mDeletedFeatureIds.contains( id ); }
193 
199  void updateFields( QgsFields &fields ) SIP_SKIP;
200 
201  //QString dumpEditBuffer();
202 
203  protected slots:
204  void undoIndexChanged( int index );
205 
206  signals:
209 
212 
218  void geometryChanged( QgsFeatureId fid, const QgsGeometry &geom );
219 
220  void attributeValueChanged( QgsFeatureId fid, int idx, const QVariant & );
221  void attributeAdded( int idx );
222  void attributeDeleted( int idx );
223 
230  void attributeRenamed( int idx, const QString &newName );
231 
233  void committedAttributesDeleted( const QString &layerId, const QgsAttributeList &deletedAttributes );
234  void committedAttributesAdded( const QString &layerId, const QList<QgsField> &addedAttributes );
235 
242  void committedAttributesRenamed( const QString &layerId, const QgsFieldNameMap &renamedAttributes );
243  void committedFeaturesAdded( const QString &layerId, const QgsFeatureList &addedFeatures );
244  void committedFeaturesRemoved( const QString &layerId, const QgsFeatureIds &deletedFeatureIds );
245  void committedAttributeValuesChanges( const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues );
246  void committedGeometriesChanges( const QString &layerId, const QgsGeometryMap &changedGeometries );
247 
248  protected:
249 
252 
254  void updateFeatureGeometry( QgsFeature &f );
255 
257  void updateChangedAttributes( QgsFeature &f );
258 
260  void handleAttributeAdded( int index );
261 
263  void handleAttributeDeleted( int index );
264 
266  void updateAttributeMapIndex( QgsAttributeMap &attrs, int index, int offset ) const;
267 
268  void updateLayerFields();
269 
270  protected:
271  QgsVectorLayer *L = nullptr;
272 
281 
292 
299 
302 
305 
308 
310  QList<QgsField> mAddedAttributes;
311 
314 
317 
318  friend class QgsGrassProvider; //GRASS provider totally abuses the edit buffer
319 };
320 
321 #endif // QGSVECTORLAYEREDITBUFFER_H
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:51
Container of fields for a vector layer.
Definition: qgsfields.h:45
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:124
void attributeRenamed(int idx, const QString &newName)
Emitted when an attribute has been renamed.
void committedAttributesDeleted(const QString &layerId, const QgsAttributeList &deletedAttributes)
Signals emitted after committing changes.
bool isFeatureDeleted(QgsFeatureId id) const
Returns true if the specified feature ID has been deleted but not committed.
QgsFeatureMap mAddedFeatures
New features which are not committed.
QgsFeatureIds deletedFeatureIds() const
Returns a list of deleted feature IDs which are not committed.
QgsChangedAttributesMap changedAttributeValues() const
Returns a map of features with changed attributes values which are not committed.
void committedAttributeValuesChanges(const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues)
void geometryChanged(QgsFeatureId fid, const QgsGeometry &geom)
Emitted when a feature's geometry is changed.
bool isFeatureAdded(QgsFeatureId id) const
Returns true if the specified feature ID has been added but not committed.
void committedAttributesAdded(const QString &layerId, const QList< QgsField > &addedAttributes)
QList< QgsField > addedAttributes() const
Returns a list of added attributes fields which are not committed.
QgsVectorLayerEditBuffer()=default
Constructor for QgsVectorLayerEditBuffer.
QgsFieldNameMap mRenamedAttributes
Renamed attributes which are not committed.
QgsGeometryMap mChangedGeometries
Changed geometries which are not committed.
void committedAttributesRenamed(const QString &layerId, const QgsFieldNameMap &renamedAttributes)
Emitted after committing an attribute rename.
QgsAttributeList mDeletedAttributeIds
Deleted attributes fields which are not committed. The list is kept sorted.
QgsFeatureMap addedFeatures() const
Returns a map of new features which are not committed.
QgsFeatureIds mDeletedFeatureIds
Deleted feature IDs which are not committed.
bool isAttributeDeleted(int index) const
Returns true if the specified attribute has been deleted but not committed.
void committedFeaturesAdded(const QString &layerId, const QgsFeatureList &addedFeatures)
void featureDeleted(QgsFeatureId fid)
QgsGeometryMap changedGeometries() const
Returns a map of features with changed geometries which are not committed.
bool isFeatureAttributesChanged(QgsFeatureId id) const
Returns true if the specified feature ID has had an attribute changed but not committed.
bool isFeatureGeometryChanged(QgsFeatureId id) const
Returns true if the specified feature ID has had its geometry changed but not committed.
QgsAttributeList deletedAttributeIds() const
Returns a list of deleted attributes fields which are not committed.
void attributeAdded(int idx)
void committedGeometriesChanges(const QString &layerId, const QgsGeometryMap &changedGeometries)
void attributeDeleted(int idx)
void featureAdded(QgsFeatureId fid)
void attributeValueChanged(QgsFeatureId fid, int idx, const QVariant &)
QgsChangedAttributesMap mChangedAttributeValues
Changed attributes values which are not committed.
QList< QgsField > mAddedAttributes
Added attributes fields which are not committed.
void layerModified()
Emitted when modifications has been done on layer.
void committedFeaturesRemoved(const QString &layerId, const QgsFeatureIds &deletedFeatureIds)
Undo command for adding a new attribute to a vector layer.
Undo command for adding a feature to a vector layer.
Undo command for modifying an attribute of a feature from a vector layer.
Undo command for modifying the geometry of a feature from a vector layer.
Undo command for removing an existing attribute from a vector layer.
Undo command for deleting a feature from a vector layer.
Undo command for renaming an existing attribute of a vector layer.
Base class for undo commands within a QgsVectorLayerEditBuffer.
Undo command for adding attri to a vector layer in transaction group.
Undo command for adding a feature to a vector layer in transaction group mode.
Undo command for changing attr value from a vector layer in transaction group.
Undo command for changing attributes' values from a vector layer in transaction group.
Undo command for changing feature geometry from a vector layer in transaction group.
Undo command for deleting attri of a vector layer in transaction group.
Undo command for deleting features from a vector layer in transaction group.
Undo command for deleting attri of a vector layer in transaction group.
Undo command for running a specific sql query in transaction group.
Undo command for vector layer in transaction group mode.
Represents a vector layer which manages a vector based data sets.
#define SIP_SKIP
Definition: qgis_sip.h:126
QMap< int, QString > QgsFieldNameMap
Definition: qgsattributes.h:44
QMap< int, QVariant > QgsAttributeMap
Definition: qgsattributes.h:38
QMap< QgsFeatureId, QgsGeometry > QgsGeometryMap
Definition: qgsfeature.h:731
QMap< QgsFeatureId, QgsAttributeMap > QgsChangedAttributesMap
Definition: qgsfeature.h:722
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:736
QSet< QgsFeatureId > QgsFeatureIds
Definition: qgsfeatureid.h:37
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
Definition: qgsfeatureid.h:28
QList< int > QgsAttributeList
Definition: qgsfield.h:26
const QgsField & field
Definition: qgsfield.h:463
QSet< int > QgsAttributeIds
QMap< QgsFeatureId, QgsFeature > QgsFeatureMap