QGIS API Documentation  2.99.0-Master (c42dad3)
Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | Friends | List of all members
QgsVectorLayerEditBuffer Class Reference

#include <qgsvectorlayereditbuffer.h>

Inheritance diagram for QgsVectorLayerEditBuffer:
Inheritance graph
[legend]

Signals

void attributeAdded (int idx)
 
void attributeDeleted (int idx)
 
void attributeRenamed (int idx, const QString &newName)
 Emitted when an attribute has been renamed. More...
 
void attributeValueChanged (QgsFeatureId fid, int idx, const QVariant &)
 
void committedAttributesAdded (const QString &layerId, const QList< QgsField > &addedAttributes)
 
void committedAttributesDeleted (const QString &layerId, const QgsAttributeList &deletedAttributes)
 Signals emitted after committing changes. More...
 
void committedAttributesRenamed (const QString &layerId, const QgsFieldNameMap &renamedAttributes)
 Emitted after committing an attribute rename. More...
 
void committedAttributeValuesChanges (const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues)
 
void committedFeaturesAdded (const QString &layerId, const QgsFeatureList &addedFeatures)
 
void committedFeaturesRemoved (const QString &layerId, const QgsFeatureIds &deletedFeatureIds)
 
void committedGeometriesChanges (const QString &layerId, const QgsGeometryMap &changedGeometries)
 
void featureAdded (QgsFeatureId fid)
 
void featureDeleted (QgsFeatureId fid)
 
void geometryChanged (QgsFeatureId fid, const QgsGeometry &geom)
 Emitted when a feature's geometry is changed. More...
 
void layerModified ()
 This signal is emitted when modifications has been done on layer. More...
 

Public Member Functions

 QgsVectorLayerEditBuffer (QgsVectorLayer *layer)
 
 ~QgsVectorLayerEditBuffer ()
 
virtual bool addAttribute (const QgsField &field)
 Add an attribute field (but does not commit it) returns true if the field was added. More...
 
QList< QgsFieldaddedAttributes () const
 Returns a list of added attributes fields which are not committed. More...
 
QgsFeatureMap addedFeatures () const
 Returns a map of new features which are not committed. More...
 
virtual bool addFeature (QgsFeature &f)
 Adds a feature. More...
 
virtual bool addFeatures (QgsFeatureList &features)
 Insert a copy of the given features into the layer (but does not commit it) More...
 
virtual bool changeAttributeValue (QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant())
 Changed an attribute value (but does not commit it) More...
 
QgsChangedAttributesMap changedAttributeValues () const
 Returns a map of features with changed attributes values which are not committed. More...
 
QgsGeometryMap changedGeometries () const
 Returns a map of features with changed geometries which are not committed. More...
 
virtual bool changeGeometry (QgsFeatureId fid, const QgsGeometry &geom)
 Change feature's geometry. More...
 
virtual bool commitChanges (QStringList &commitErrors)
 Attempts to commit any changes to disk. More...
 
virtual bool deleteAttribute (int attr)
 Delete an attribute field (but does not commit it) More...
 
QgsAttributeList deletedAttributeIds () const
 Returns a list of deleted attributes fields which are not committed. More...
 
QgsFeatureIds deletedFeatureIds () const
 Returns a list of deleted feature IDs which are not committed. More...
 
virtual bool deleteFeature (QgsFeatureId fid)
 Delete a feature from the layer (but does not commit it) More...
 
virtual bool deleteFeatures (const QgsFeatureIds &fid)
 Deletes a set of features from the layer (but does not commit it) More...
 
bool isAttributeDeleted (int index) const
 Returns true if the specified attribute has been deleted but not committed. More...
 
bool isFeatureAdded (QgsFeatureId id) const
 Returns true if the specified feature ID has been added but not committed. More...
 
bool isFeatureAttributesChanged (QgsFeatureId id) const
 Returns true if the specified feature ID has had an attribute changed but not committed. More...
 
bool isFeatureDeleted (QgsFeatureId id) const
 Returns true if the specified feature ID has been deleted but not committed. More...
 
bool isFeatureGeometryChanged (QgsFeatureId id) const
 Returns true if the specified feature ID has had its geometry changed but not committed. More...
 
virtual bool isModified () const
 Returns true if the provider has been modified since the last commit. More...
 
virtual bool renameAttribute (int attr, const QString &newName)
 Renames an attribute field (but does not commit it) More...
 
virtual void rollBack ()
 Stop editing and discard the edits. More...
 

Protected Slots

void undoIndexChanged (int index)
 

Protected Member Functions

 QgsVectorLayerEditBuffer ()
 
void handleAttributeAdded (int index)
 Update added and changed features after addition of an attribute. More...
 
void handleAttributeDeleted (int index)
 Update added and changed features after removal of an attribute. More...
 
void updateAttributeMapIndex (QgsAttributeMap &attrs, int index, int offset) const
 Updates an index in an attribute map to a new value (for updates of changed attributes) More...
 
void updateChangedAttributes (QgsFeature &f)
 Update feature with uncommitted attribute updates. More...
 
void updateFeatureGeometry (QgsFeature &f)
 Update feature with uncommitted geometry updates. More...
 
void updateFields (QgsFields &fields)
 
void updateLayerFields ()
 

Protected Attributes

QgsVectorLayerL
 
QList< QgsFieldmAddedAttributes
 Added attributes fields which are not committed. More...
 
QgsFeatureMap mAddedFeatures
 New features which are not committed. More...
 
QgsChangedAttributesMap mChangedAttributeValues
 Changed attributes values which are not committed. More...
 
QgsGeometryMap mChangedGeometries
 Changed geometries which are not committed. More...
 
QgsAttributeList mDeletedAttributeIds
 Deleted attributes fields which are not committed. The list is kept sorted. More...
 
QgsFeatureIds mDeletedFeatureIds
 Deleted feature IDs which are not committed. More...
 
QgsFieldNameMap mRenamedAttributes
 Renamed attributes which are not committed. More...
 

Friends

class QgsGrassProvider
 
class QgsVectorLayer
 
class QgsVectorLayerUndoCommand
 
class QgsVectorLayerUndoCommandAddAttribute
 
class QgsVectorLayerUndoCommandAddFeature
 
class QgsVectorLayerUndoCommandChangeAttribute
 
class QgsVectorLayerUndoCommandChangeGeometry
 
class QgsVectorLayerUndoCommandDeleteAttribute
 
class QgsVectorLayerUndoCommandDeleteFeature
 
class QgsVectorLayerUndoCommandRenameAttribute
 

Detailed Description

Definition at line 34 of file qgsvectorlayereditbuffer.h.

Constructor & Destructor Documentation

§ QgsVectorLayerEditBuffer() [1/2]

QgsVectorLayerEditBuffer::QgsVectorLayerEditBuffer ( QgsVectorLayer layer)

Definition at line 37 of file qgsvectorlayereditbuffer.cpp.

§ ~QgsVectorLayerEditBuffer()

QgsVectorLayerEditBuffer::~QgsVectorLayerEditBuffer ( )

Definition at line 43 of file qgsvectorlayereditbuffer.cpp.

§ QgsVectorLayerEditBuffer() [2/2]

QgsVectorLayerEditBuffer::QgsVectorLayerEditBuffer ( )
inlineprotected

Definition at line 210 of file qgsvectorlayereditbuffer.h.

Member Function Documentation

§ addAttribute()

bool QgsVectorLayerEditBuffer::addAttribute ( const QgsField field)
virtual

Add an attribute field (but does not commit it) returns true if the field was added.

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 239 of file qgsvectorlayereditbuffer.cpp.

§ addedAttributes()

QList<QgsField> QgsVectorLayerEditBuffer::addedAttributes ( ) const
inline

Returns a list of added attributes fields which are not committed.

Definition at line 138 of file qgsvectorlayereditbuffer.h.

§ addedFeatures()

QgsFeatureMap QgsVectorLayerEditBuffer::addedFeatures ( ) const
inline

Returns a map of new features which are not committed.

See also
isFeatureAdded()

Definition at line 103 of file qgsvectorlayereditbuffer.h.

§ addFeature()

bool QgsVectorLayerEditBuffer::addFeature ( QgsFeature f)
virtual

Adds a feature.

Parameters
ffeature to add
Returns
True in case of success and False in case of error

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 117 of file qgsvectorlayereditbuffer.cpp.

§ addFeatures()

bool QgsVectorLayerEditBuffer::addFeatures ( QgsFeatureList features)
virtual

Insert a copy of the given features into the layer (but does not commit it)

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 133 of file qgsvectorlayereditbuffer.cpp.

§ attributeAdded

void QgsVectorLayerEditBuffer::attributeAdded ( int  idx)
signal

§ attributeDeleted

void QgsVectorLayerEditBuffer::attributeDeleted ( int  idx)
signal

§ attributeRenamed

void QgsVectorLayerEditBuffer::attributeRenamed ( int  idx,
const QString &  newName 
)
signal

Emitted when an attribute has been renamed.

Parameters
idxattribute index
newNamenew attribute name
Note
added in QGSI 2.16

§ attributeValueChanged

void QgsVectorLayerEditBuffer::attributeValueChanged ( QgsFeatureId  fid,
int  idx,
const QVariant &   
)
signal

§ changeAttributeValue()

bool QgsVectorLayerEditBuffer::changeAttributeValue ( QgsFeatureId  fid,
int  field,
const QVariant &  newValue,
const QVariant &  oldValue = QVariant() 
)
virtual

Changed an attribute value (but does not commit it)

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 217 of file qgsvectorlayereditbuffer.cpp.

§ changedAttributeValues()

QgsChangedAttributesMap QgsVectorLayerEditBuffer::changedAttributeValues ( ) const
inline

Returns a map of features with changed attributes values which are not committed.

See also
isFeatureAttributesChanged()

Definition at line 115 of file qgsvectorlayereditbuffer.h.

§ changedGeometries()

QgsGeometryMap QgsVectorLayerEditBuffer::changedGeometries ( ) const
inline

Returns a map of features with changed geometries which are not committed.

See also
hasFeatureGeometryChange()

Definition at line 143 of file qgsvectorlayereditbuffer.h.

§ changeGeometry()

bool QgsVectorLayerEditBuffer::changeGeometry ( QgsFeatureId  fid,
const QgsGeometry geom 
)
virtual

Change feature's geometry.

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 195 of file qgsvectorlayereditbuffer.cpp.

§ commitChanges()

bool QgsVectorLayerEditBuffer::commitChanges ( QStringList &  commitErrors)
virtual

Attempts to commit any changes to disk.

Returns the result of the attempt. If a commit fails, the in-memory changes are left alone.

This allows editing to continue if the commit failed on e.g. a disallowed value in a Postgres database - the user can re-edit and try again.

The commits occur in distinct stages, (add attributes, add features, change attribute values, change geometries, delete features, delete attributes) so if a stage fails, it's difficult to roll back cleanly. Therefore any error message also includes which stage failed so that the user has some chance of repairing the damage cleanly.

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 305 of file qgsvectorlayereditbuffer.cpp.

§ committedAttributesAdded

void QgsVectorLayerEditBuffer::committedAttributesAdded ( const QString &  layerId,
const QList< QgsField > &  addedAttributes 
)
signal

§ committedAttributesDeleted

void QgsVectorLayerEditBuffer::committedAttributesDeleted ( const QString &  layerId,
const QgsAttributeList deletedAttributes 
)
signal

Signals emitted after committing changes.

§ committedAttributesRenamed

void QgsVectorLayerEditBuffer::committedAttributesRenamed ( const QString &  layerId,
const QgsFieldNameMap renamedAttributes 
)
signal

Emitted after committing an attribute rename.

Parameters
layerIdID of layer
renamedAttributesmap of field index to new name
Note
added in QGIS 2.16

§ committedAttributeValuesChanges

void QgsVectorLayerEditBuffer::committedAttributeValuesChanges ( const QString &  layerId,
const QgsChangedAttributesMap changedAttributesValues 
)
signal

§ committedFeaturesAdded

void QgsVectorLayerEditBuffer::committedFeaturesAdded ( const QString &  layerId,
const QgsFeatureList addedFeatures 
)
signal

§ committedFeaturesRemoved

void QgsVectorLayerEditBuffer::committedFeaturesRemoved ( const QString &  layerId,
const QgsFeatureIds deletedFeatureIds 
)
signal

§ committedGeometriesChanges

void QgsVectorLayerEditBuffer::committedGeometriesChanges ( const QString &  layerId,
const QgsGeometryMap changedGeometries 
)
signal

§ deleteAttribute()

bool QgsVectorLayerEditBuffer::deleteAttribute ( int  attr)
virtual

Delete an attribute field (but does not commit it)

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 261 of file qgsvectorlayereditbuffer.cpp.

§ deletedAttributeIds()

QgsAttributeList QgsVectorLayerEditBuffer::deletedAttributeIds ( ) const
inline

Returns a list of deleted attributes fields which are not committed.

The list is kept sorted.

See also
isAttributeDeleted()

Definition at line 127 of file qgsvectorlayereditbuffer.h.

§ deletedFeatureIds()

QgsFeatureIds QgsVectorLayerEditBuffer::deletedFeatureIds ( ) const
inline

Returns a list of deleted feature IDs which are not committed.

See also
isFeatureDeleted()

Definition at line 155 of file qgsvectorlayereditbuffer.h.

§ deleteFeature()

bool QgsVectorLayerEditBuffer::deleteFeature ( QgsFeatureId  fid)
virtual

Delete a feature from the layer (but does not commit it)

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 150 of file qgsvectorlayereditbuffer.cpp.

§ deleteFeatures()

bool QgsVectorLayerEditBuffer::deleteFeatures ( const QgsFeatureIds fid)
virtual

Deletes a set of features from the layer (but does not commit it)

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 179 of file qgsvectorlayereditbuffer.cpp.

§ featureAdded

void QgsVectorLayerEditBuffer::featureAdded ( QgsFeatureId  fid)
signal

§ featureDeleted

void QgsVectorLayerEditBuffer::featureDeleted ( QgsFeatureId  fid)
signal

§ geometryChanged

void QgsVectorLayerEditBuffer::geometryChanged ( QgsFeatureId  fid,
const QgsGeometry geom 
)
signal

Emitted when a feature's geometry is changed.

Parameters
fidfeature ID
geomnew feature geometry

§ handleAttributeAdded()

void QgsVectorLayerEditBuffer::handleAttributeAdded ( int  index)
protected

Update added and changed features after addition of an attribute.

Definition at line 665 of file qgsvectorlayereditbuffer.cpp.

§ handleAttributeDeleted()

void QgsVectorLayerEditBuffer::handleAttributeDeleted ( int  index)
protected

Update added and changed features after removal of an attribute.

Definition at line 698 of file qgsvectorlayereditbuffer.cpp.

§ isAttributeDeleted()

bool QgsVectorLayerEditBuffer::isAttributeDeleted ( int  index) const
inline

Returns true if the specified attribute has been deleted but not committed.

Parameters
indexattribute index
Note
added in QGIS 3.0
See also
deletedAttributeIds()

Definition at line 134 of file qgsvectorlayereditbuffer.h.

§ isFeatureAdded()

bool QgsVectorLayerEditBuffer::isFeatureAdded ( QgsFeatureId  id) const
inline

Returns true if the specified feature ID has been added but not committed.

Parameters
idfeature ID
Note
added in QGIS 3.0
See also
addedFeatures()

Definition at line 110 of file qgsvectorlayereditbuffer.h.

§ isFeatureAttributesChanged()

bool QgsVectorLayerEditBuffer::isFeatureAttributesChanged ( QgsFeatureId  id) const
inline

Returns true if the specified feature ID has had an attribute changed but not committed.

Parameters
idfeature ID
Note
added in QGIS 3.0
See also
changedAttributeValues()

Definition at line 122 of file qgsvectorlayereditbuffer.h.

§ isFeatureDeleted()

bool QgsVectorLayerEditBuffer::isFeatureDeleted ( QgsFeatureId  id) const
inline

Returns true if the specified feature ID has been deleted but not committed.

Parameters
idfeature ID
Note
added in QGIS 3.0
See also
deletedFeatureIds()

Definition at line 162 of file qgsvectorlayereditbuffer.h.

§ isFeatureGeometryChanged()

bool QgsVectorLayerEditBuffer::isFeatureGeometryChanged ( QgsFeatureId  id) const
inline

Returns true if the specified feature ID has had its geometry changed but not committed.

Parameters
idfeature ID
Note
added in QGIS 3.0
See also
changedGeometries()

Definition at line 150 of file qgsvectorlayereditbuffer.h.

§ isModified()

bool QgsVectorLayerEditBuffer::isModified ( ) const
virtual

Returns true if the provider has been modified since the last commit.

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 48 of file qgsvectorlayereditbuffer.cpp.

§ layerModified

void QgsVectorLayerEditBuffer::layerModified ( )
signal

This signal is emitted when modifications has been done on layer.

§ renameAttribute()

bool QgsVectorLayerEditBuffer::renameAttribute ( int  attr,
const QString &  newName 
)
virtual

Renames an attribute field (but does not commit it)

Parameters
attrattribute index
newNamenew name of field
Note
added in QGIS 2.16

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 283 of file qgsvectorlayereditbuffer.cpp.

§ rollBack()

void QgsVectorLayerEditBuffer::rollBack ( )
virtual

Stop editing and discard the edits.

Reimplemented in QgsVectorLayerEditPassthrough.

Definition at line 632 of file qgsvectorlayereditbuffer.cpp.

§ undoIndexChanged

void QgsVectorLayerEditBuffer::undoIndexChanged ( int  index)
protectedslot

Definition at line 54 of file qgsvectorlayereditbuffer.cpp.

§ updateAttributeMapIndex()

void QgsVectorLayerEditBuffer::updateAttributeMapIndex ( QgsAttributeMap attrs,
int  index,
int  offset 
) const
protected

Updates an index in an attribute map to a new value (for updates of changed attributes)

Definition at line 743 of file qgsvectorlayereditbuffer.cpp.

§ updateChangedAttributes()

void QgsVectorLayerEditBuffer::updateChangedAttributes ( QgsFeature f)
protected

Update feature with uncommitted attribute updates.

Definition at line 90 of file qgsvectorlayereditbuffer.cpp.

§ updateFeatureGeometry()

void QgsVectorLayerEditBuffer::updateFeatureGeometry ( QgsFeature f)
protected

Update feature with uncommitted geometry updates.

Definition at line 83 of file qgsvectorlayereditbuffer.cpp.

§ updateFields()

void QgsVectorLayerEditBuffer::updateFields ( QgsFields fields)
protected

Definition at line 62 of file qgsvectorlayereditbuffer.cpp.

§ updateLayerFields()

void QgsVectorLayerEditBuffer::updateLayerFields ( )
protected

Definition at line 756 of file qgsvectorlayereditbuffer.cpp.

Friends And Related Function Documentation

§ QgsGrassProvider

friend class QgsGrassProvider
friend

Definition at line 268 of file qgsvectorlayereditbuffer.h.

§ QgsVectorLayer

friend class QgsVectorLayer
friend

Definition at line 233 of file qgsvectorlayereditbuffer.h.

§ QgsVectorLayerUndoCommand

friend class QgsVectorLayerUndoCommand
friend

Definition at line 235 of file qgsvectorlayereditbuffer.h.

§ QgsVectorLayerUndoCommandAddAttribute

Definition at line 240 of file qgsvectorlayereditbuffer.h.

§ QgsVectorLayerUndoCommandAddFeature

Definition at line 236 of file qgsvectorlayereditbuffer.h.

§ QgsVectorLayerUndoCommandChangeAttribute

Definition at line 239 of file qgsvectorlayereditbuffer.h.

§ QgsVectorLayerUndoCommandChangeGeometry

Definition at line 238 of file qgsvectorlayereditbuffer.h.

§ QgsVectorLayerUndoCommandDeleteAttribute

Definition at line 241 of file qgsvectorlayereditbuffer.h.

§ QgsVectorLayerUndoCommandDeleteFeature

Definition at line 237 of file qgsvectorlayereditbuffer.h.

§ QgsVectorLayerUndoCommandRenameAttribute

Definition at line 242 of file qgsvectorlayereditbuffer.h.

Member Data Documentation

§ L

QgsVectorLayer* QgsVectorLayerEditBuffer::L
protected

Definition at line 232 of file qgsvectorlayereditbuffer.h.

§ mAddedAttributes

QList<QgsField> QgsVectorLayerEditBuffer::mAddedAttributes
protected

Added attributes fields which are not committed.

Definition at line 260 of file qgsvectorlayereditbuffer.h.

§ mAddedFeatures

QgsFeatureMap QgsVectorLayerEditBuffer::mAddedFeatures
protected

New features which are not committed.

Definition at line 251 of file qgsvectorlayereditbuffer.h.

§ mChangedAttributeValues

QgsChangedAttributesMap QgsVectorLayerEditBuffer::mChangedAttributeValues
protected

Changed attributes values which are not committed.

Definition at line 254 of file qgsvectorlayereditbuffer.h.

§ mChangedGeometries

QgsGeometryMap QgsVectorLayerEditBuffer::mChangedGeometries
protected

Changed geometries which are not committed.

Definition at line 266 of file qgsvectorlayereditbuffer.h.

§ mDeletedAttributeIds

QgsAttributeList QgsVectorLayerEditBuffer::mDeletedAttributeIds
protected

Deleted attributes fields which are not committed. The list is kept sorted.

Definition at line 257 of file qgsvectorlayereditbuffer.h.

§ mDeletedFeatureIds

QgsFeatureIds QgsVectorLayerEditBuffer::mDeletedFeatureIds
protected

Deleted feature IDs which are not committed.

Note a feature can be added and then deleted again before the change is committed - in that case the added feature would be removed from mAddedFeatures only and not entered here.

Definition at line 248 of file qgsvectorlayereditbuffer.h.

§ mRenamedAttributes

QgsFieldNameMap QgsVectorLayerEditBuffer::mRenamedAttributes
protected

Renamed attributes which are not committed.

Definition at line 263 of file qgsvectorlayereditbuffer.h.


The documentation for this class was generated from the following files: