QGIS API Documentation  3.17.0-Master (8af46bc54f)
Public Member Functions | Public Attributes | List of all members
QgsVectorLayer::DeleteContext Struct Reference

Context for cascade delete features. More...

#include <qgsvectorlayer.h>

Public Member Functions

 DeleteContext (bool cascade=false, QgsProject *project=nullptr)
 Constructor for DeleteContext. More...
 
QgsFeatureIds handledFeatures (QgsVectorLayer *layer) const
 Returns a list of feature IDs from the specified layer affected by the delete operation. More...
 
QList< QgsVectorLayer * > handledLayers (bool includeAuxiliaryLayers=true) const
 Returns a list of all layers affected by the delete operation. More...
 

Public Attributes

bool cascade
 
QMap< QgsVectorLayer *, QgsFeatureIdsmHandledFeatures
 
QgsProjectproject
 

Detailed Description

Context for cascade delete features.

Since
QGIS 3.14

Definition at line 510 of file qgsvectorlayer.h.

Constructor & Destructor Documentation

◆ DeleteContext()

QgsVectorLayer::DeleteContext::DeleteContext ( bool  cascade = false,
QgsProject project = nullptr 
)
inlineexplicit

Constructor for DeleteContext.

Definition at line 516 of file qgsvectorlayer.h.

Member Function Documentation

◆ handledFeatures()

QgsFeatureIds QgsVectorLayer::DeleteContext::handledFeatures ( QgsVectorLayer layer) const

Returns a list of feature IDs from the specified layer affected by the delete operation.

Definition at line 5616 of file qgsvectorlayer.cpp.

◆ handledLayers()

QList< QgsVectorLayer * > QgsVectorLayer::DeleteContext::handledLayers ( bool  includeAuxiliaryLayers = true) const

Returns a list of all layers affected by the delete operation.

If includeAuxiliaryLayers is false then auxiliary layers will not be included in the returned list.

Definition at line 5604 of file qgsvectorlayer.cpp.

Member Data Documentation

◆ cascade

bool QgsVectorLayer::DeleteContext::cascade

Definition at line 532 of file qgsvectorlayer.h.

◆ mHandledFeatures

QMap<QgsVectorLayer *, QgsFeatureIds> QgsVectorLayer::DeleteContext::mHandledFeatures

Definition at line 531 of file qgsvectorlayer.h.

◆ project

QgsProject* QgsVectorLayer::DeleteContext::project

Definition at line 533 of file qgsvectorlayer.h.


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