QGIS API Documentation  3.6.0-Noosa (5873452)
Public Member Functions | List of all members
QgsGeometryCheckRegistry Class Reference

This class manages all known geometry check factories. More...

#include <qgsgeometrycheckregistry.h>

Public Member Functions

 QgsGeometryCheckRegistry ()=default
 Constructor for QgsGeometryCheckRegistry. More...
 
 ~QgsGeometryCheckRegistry ()
 Destructor. More...
 
QgsGeometryCheckgeometryCheck (const QString &checkId, QgsGeometryCheckContext *context, const QVariantMap &geometryCheckConfig)
 Create a new geometryCheck of type checkId Pass the context and geometryCheckConfiguration to the newly created check. More...
 
QList< QgsGeometryCheckFactory * > geometryCheckFactories (QgsVectorLayer *layer, QgsGeometryCheck::CheckType type, QgsGeometryCheck::Flags flags=nullptr) const
 Returns all geometry check factories that are compatible with layer and have all of the flags set. More...
 
void registerGeometryCheck (QgsGeometryCheckFactory *checkFactory)
 Registers a new geometry check factory. More...
 

Detailed Description

This class manages all known geometry check factories.

QgsGeometryCheckRegistry is not usually directly created, but rather accessed through QgsAnalysis::geometryCheckRegistry().

Note
This class is a technology preview and unstable API.
Since
QGIS 3.4

Definition at line 41 of file qgsgeometrycheckregistry.h.

Constructor & Destructor Documentation

◆ QgsGeometryCheckRegistry()

QgsGeometryCheckRegistry::QgsGeometryCheckRegistry ( )
default

Constructor for QgsGeometryCheckRegistry.

QgsGeometryCheckRegistry is not usually directly created, but rather accessed through QgsAnalysis::geometryCheckRegistry().

◆ ~QgsGeometryCheckRegistry()

QgsGeometryCheckRegistry::~QgsGeometryCheckRegistry ( )

Destructor.

Deletes all the registered checks

Definition at line 21 of file qgsgeometrycheckregistry.cpp.

Member Function Documentation

◆ geometryCheck()

QgsGeometryCheck * QgsGeometryCheckRegistry::geometryCheck ( const QString &  checkId,
QgsGeometryCheckContext context,
const QVariantMap &  geometryCheckConfig 
)

Create a new geometryCheck of type checkId Pass the context and geometryCheckConfiguration to the newly created check.

Ownership is transferred to the caller.

Since
QGIS 3.4

Definition at line 26 of file qgsgeometrycheckregistry.cpp.

◆ geometryCheckFactories()

QList< QgsGeometryCheckFactory * > QgsGeometryCheckRegistry::geometryCheckFactories ( QgsVectorLayer layer,
QgsGeometryCheck::CheckType  type,
QgsGeometryCheck::Flags  flags = nullptr 
) const

Returns all geometry check factories that are compatible with layer and have all of the flags set.

Since
QGIS 3.4

Definition at line 35 of file qgsgeometrycheckregistry.cpp.

◆ registerGeometryCheck()

void QgsGeometryCheckRegistry::registerGeometryCheck ( QgsGeometryCheckFactory checkFactory)

Registers a new geometry check factory.

Since
QGIS 3.4

Definition at line 46 of file qgsgeometrycheckregistry.cpp.


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