QgsVectorLayerTools Class Reference

Methods in this class are used to handle basic operations on vector layers. More...

#include <qgsvectorlayertools.h>

Inheritance diagram for QgsVectorLayerTools:

Public Member Functions
	QgsVectorLayerTools ()
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. More...
virtual bool	copyMoveFeatures (QgsVectorLayer *layer, QgsFeatureRequest &request, double dx=0, double dy=0, QString *errorMsg=nullptr) const
	Copy and move features with defined translation. More...
virtual bool	saveEdits (QgsVectorLayer *layer) const =0
	Should be called, when the features should be committed but the editing session is not ended. More...
virtual bool	startEditing (QgsVectorLayer *layer) const =0
	This will be called, whenever a vector layer should be switched to edit mode. More...
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. More...

Detailed Description

Methods in this class are used to handle basic operations on vector layers.

With an implementation of this class, parts of the application can ask for an operation to be done and the implementation will then take care of it.

Reimplement this class, if you need to have custom checks or GUI elements in your application.

Definition at line 39 of file qgsvectorlayertools.h.

Constructor & Destructor Documentation

QgsVectorLayerTools::QgsVectorLayerTools

(

)

Definition at line 24 of file qgsvectorlayertools.cpp.

Member Function Documentation

virtual bool QgsVectorLayerTools::addFeature ( QgsVectorLayer *  layer, const QgsAttributeMap &  defaultValues = QgsAttributeMap(), const QgsGeometry &  defaultGeometry = QgsGeometry(), QgsFeature *  feature = nullptr  ) const

pure virtual

This method should/will be called, whenever a new feature will be added to the layer.

Parameters

layer	The layer to which the feature should be added
defaultValues	Default values for the feature to add
defaultGeometry	A default geometry to add to the feature
feature	Updated feature after adding will be written back to this

Returns

True in case of success, False if the operation failed/was aborted

TODO QGIS 3: remove const qualifier

Implemented in QgsTrackedVectorLayerTools.

bool QgsVectorLayerTools::copyMoveFeatures ( QgsVectorLayer *  layer, QgsFeatureRequest &  request, double  dx = 0, double  dy = 0, QString *  errorMsg = nullptr  ) const

virtual

Copy and move features with defined translation.

Parameters

layer	The layer
request	The request for the features to be moved. It will be assigned to a new feature request with the newly copied features.
dx	The translation on x
dy	The translation on y
errorMsg	If given, it will contain the error message

Returns

True if all features could be copied.

TODO QGIS 3: remove const qualifier

Reimplemented in QgsTrackedVectorLayerTools.

Definition at line 28 of file qgsvectorlayertools.cpp.

virtual bool QgsVectorLayerTools::saveEdits ( QgsVectorLayer *  layer ) const

pure virtual

Should be called, when the features should be committed but the editing session is not ended.

Parameters

layer

The layer to commit

Returns

True if successful

TODO QGIS 3: remove const qualifier

Implemented in QgsTrackedVectorLayerTools.

virtual bool QgsVectorLayerTools::startEditing ( QgsVectorLayer *  layer ) const

pure virtual

This will be called, whenever a vector layer should be switched to edit mode.

Check the providers capability to edit in here. If successful layer->startEditing() will be called and true returned.

Parameters

layer

The layer on which to start an edit session

Returns

True, if the editing session was started

TODO QGIS 3: remove const qualifier

Implemented in QgsTrackedVectorLayerTools.

virtual bool QgsVectorLayerTools::stopEditing ( QgsVectorLayer *  layer, bool  allowCancel = true  ) const

pure virtual

Will be called, when an editing session is ended and the features should be committed.

Appropriate dialogs should be shown like

Parameters

layer	The layer to commit
allowCancel	True if a cancel button should be offered

Returns

True if successful

TODO QGIS 3: remove const qualifier

Implemented in QgsTrackedVectorLayerTools.

---

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

• /build/qgis-3.4.15+24xenial/src/core/qgsvectorlayertools.h
• /build/qgis-3.4.15+24xenial/src/core/qgsvectorlayertools.cpp