QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 layerModified ()
 This signal is emitted when modifications has been done on layer. More...
 
void featureAdded (QgsFeatureId fid)
 
void featureDeleted (QgsFeatureId fid)
 
void geometryChanged (QgsFeatureId fid, QgsGeometry &geom)
 
void attributeValueChanged (QgsFeatureId fid, int idx, const QVariant &)
 
void attributeAdded (int idx)
 
void attributeDeleted (int idx)
 
void committedAttributesDeleted (const QString &layerId, const QgsAttributeList &deletedAttributes)
 Signals emitted after committing changes. More...
 
void committedAttributesAdded (const QString &layerId, const QList< QgsField > &addedAttributes)
 
void committedFeaturesAdded (const QString &layerId, const QgsFeatureList &addedFeatures)
 
void committedFeaturesRemoved (const QString &layerId, const QgsFeatureIds &deletedFeatureIds)
 
void committedAttributeValuesChanges (const QString &layerId, const QgsChangedAttributesMap &changedAttributesValues)
 
void committedGeometriesChanges (const QString &layerId, const QgsGeometryMap &changedGeometries)
 

Public Member Functions

 QgsVectorLayerEditBuffer (QgsVectorLayer *layer)
 
 ~QgsVectorLayerEditBuffer ()
 
bool isModified () const
 Returns true if the provider has been modified since the last commit. More...
 
bool addFeature (QgsFeature &f)
 Adds a feature. More...
 
bool addFeatures (QgsFeatureList &features)
 Insert a copy of the given features into the layer (but does not commit it) More...
 
bool deleteFeature (QgsFeatureId fid)
 delete a feature from the layer (but does not commit it) More...
 
bool changeGeometry (QgsFeatureId fid, QgsGeometry *geom)
 change feature's geometry More...
 
bool changeAttributeValue (QgsFeatureId fid, int field, const QVariant &newValue, const QVariant &oldValue=QVariant())
 changed an attribute value (but does not commit it) More...
 
bool addAttribute (const QgsField &field)
 add an attribute field (but does not commit it) returns true if the field was added More...
 
bool deleteAttribute (int attr)
 delete an attribute field (but does not commit it) More...
 
bool commitChanges (QStringList &commitErrors)
 Attempts to commit any changes to disk. More...
 
void rollBack ()
 Stop editing and discard the edits. More...
 
const QgsFeatureMapaddedFeatures ()
 New features which are not commited. More...
 
const QgsChangedAttributesMapchangedAttributeValues ()
 Changed attributes values which are not commited. More...
 
const QgsAttributeListdeletedAttributeIds ()
 deleted attributes fields which are not commited. More...
 
const QList< QgsField > & addedAttributes ()
 added attributes fields which are not commited More...
 
const QgsGeometryMapchangedGeometries ()
 Changed geometries which are not commited. More...
 
const QgsFeatureIds deletedFeatureIds ()
 

Protected Slots

void undoIndexChanged (int index)
 

Protected Member Functions

void updateFields (QgsFields &fields)
 
void updateFeatureGeometry (QgsFeature &f)
 Update feature with uncommited geometry updates. More...
 
void updateChangedAttributes (QgsFeature &f)
 Update feature with uncommited attribute updates. More...
 
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 updateLayerFields ()
 

Protected Attributes

QgsVectorLayerL
 
QgsFeatureIds mDeletedFeatureIds
 Deleted feature IDs which are not commited. More...
 
QgsFeatureMap mAddedFeatures
 New features which are not commited. More...
 
QgsChangedAttributesMap mChangedAttributeValues
 Changed attributes values which are not commited. More...
 
QgsAttributeList mDeletedAttributeIds
 deleted attributes fields which are not commited. More...
 
QList< QgsFieldmAddedAttributes
 added attributes fields which are not commited More...
 
QgsGeometryMap mChangedGeometries
 Changed geometries which are not commited. More...
 

Friends

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

Constructor & Destructor Documentation

QgsVectorLayerEditBuffer::QgsVectorLayerEditBuffer ( QgsVectorLayer layer)
QgsVectorLayerEditBuffer::~QgsVectorLayerEditBuffer ( )

Member Function Documentation

bool QgsVectorLayerEditBuffer::addAttribute ( const QgsField field)

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

Note
added in version 1.2
const QList<QgsField>& QgsVectorLayerEditBuffer::addedAttributes ( )
inline

added attributes fields which are not commited

const QgsFeatureMap& QgsVectorLayerEditBuffer::addedFeatures ( )
inline

New features which are not commited.

bool QgsVectorLayerEditBuffer::addFeature ( QgsFeature f)

Adds a feature.

Parameters
ffeature to add
Returns
True in case of success and False in case of error
bool QgsVectorLayerEditBuffer::addFeatures ( QgsFeatureList features)

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

void QgsVectorLayerEditBuffer::attributeAdded ( int  idx)
signal
void QgsVectorLayerEditBuffer::attributeDeleted ( int  idx)
signal
void QgsVectorLayerEditBuffer::attributeValueChanged ( QgsFeatureId  fid,
int  idx,
const QVariant &   
)
signal
bool QgsVectorLayerEditBuffer::changeAttributeValue ( QgsFeatureId  fid,
int  field,
const QVariant &  newValue,
const QVariant &  oldValue = QVariant() 
)

changed an attribute value (but does not commit it)

const QgsChangedAttributesMap& QgsVectorLayerEditBuffer::changedAttributeValues ( )
inline

Changed attributes values which are not commited.

const QgsGeometryMap& QgsVectorLayerEditBuffer::changedGeometries ( )
inline

Changed geometries which are not commited.

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

change feature's geometry

Note
added in version 1.2
bool QgsVectorLayerEditBuffer::commitChanges ( QStringList &  commitErrors)

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.

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

Signals emitted after committing changes.

Note
added in v1.6
void QgsVectorLayerEditBuffer::committedAttributeValuesChanges ( const QString &  layerId,
const QgsChangedAttributesMap changedAttributesValues 
)
signal
void QgsVectorLayerEditBuffer::committedFeaturesAdded ( const QString &  layerId,
const QgsFeatureList addedFeatures 
)
signal
void QgsVectorLayerEditBuffer::committedFeaturesRemoved ( const QString &  layerId,
const QgsFeatureIds deletedFeatureIds 
)
signal
void QgsVectorLayerEditBuffer::committedGeometriesChanges ( const QString &  layerId,
const QgsGeometryMap changedGeometries 
)
signal
bool QgsVectorLayerEditBuffer::deleteAttribute ( int  attr)

delete an attribute field (but does not commit it)

const QgsAttributeList& QgsVectorLayerEditBuffer::deletedAttributeIds ( )
inline

deleted attributes fields which are not commited.

The list is kept sorted.

const QgsFeatureIds QgsVectorLayerEditBuffer::deletedFeatureIds ( )
inline
bool QgsVectorLayerEditBuffer::deleteFeature ( QgsFeatureId  fid)

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

void QgsVectorLayerEditBuffer::featureAdded ( QgsFeatureId  fid)
signal
void QgsVectorLayerEditBuffer::featureDeleted ( QgsFeatureId  fid)
signal
void QgsVectorLayerEditBuffer::geometryChanged ( QgsFeatureId  fid,
QgsGeometry geom 
)
signal
void QgsVectorLayerEditBuffer::handleAttributeAdded ( int  index)
protected

update added and changed features after addition of an attribute

void QgsVectorLayerEditBuffer::handleAttributeDeleted ( int  index)
protected

update added and changed features after removal of an attribute

bool QgsVectorLayerEditBuffer::isModified ( ) const

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

void QgsVectorLayerEditBuffer::layerModified ( )
signal

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

void QgsVectorLayerEditBuffer::rollBack ( )

Stop editing and discard the edits.

void QgsVectorLayerEditBuffer::undoIndexChanged ( int  index)
protectedslot
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)

void QgsVectorLayerEditBuffer::updateChangedAttributes ( QgsFeature f)
protected

Update feature with uncommited attribute updates.

void QgsVectorLayerEditBuffer::updateFeatureGeometry ( QgsFeature f)
protected

Update feature with uncommited geometry updates.

void QgsVectorLayerEditBuffer::updateFields ( QgsFields fields)
protected
void QgsVectorLayerEditBuffer::updateLayerFields ( )
protected

Friends And Related Function Documentation

friend class QgsVectorLayer
friend
friend class QgsVectorLayerUndoCommand
friend

Member Data Documentation

QgsVectorLayer* QgsVectorLayerEditBuffer::L
protected
QList<QgsField> QgsVectorLayerEditBuffer::mAddedAttributes
protected

added attributes fields which are not commited

QgsFeatureMap QgsVectorLayerEditBuffer::mAddedFeatures
protected

New features which are not commited.

QgsChangedAttributesMap QgsVectorLayerEditBuffer::mChangedAttributeValues
protected

Changed attributes values which are not commited.

QgsGeometryMap QgsVectorLayerEditBuffer::mChangedGeometries
protected

Changed geometries which are not commited.

QgsAttributeList QgsVectorLayerEditBuffer::mDeletedAttributeIds
protected

deleted attributes fields which are not commited.

The list is kept sorted.

QgsFeatureIds QgsVectorLayerEditBuffer::mDeletedFeatureIds
protected

Deleted feature IDs which are not commited.

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.


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