Class: QgsGeometryCheckRegistry

A registry for 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.

Added in version 3.4.

Methods

geometryCheck

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

geometryCheckFactories

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

registerGeometryCheck

Registers a new geometry check factory.
class qgis.analysis.QgsGeometryCheckRegistry[source]

Bases: object

__init__()

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

__init__(a0: QgsGeometryCheckRegistry)
Parameters:

a0 (QgsGeometryCheckRegistry)

geometryCheck(self, checkId: str | None, context: QgsGeometryCheckContext | None, geometryCheckConfig: Dict[str, Any]) → QgsGeometryCheck | None[source]

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

Added in version 3.4.

Parameters:
Return type:

Optional[QgsGeometryCheck]

geometryCheckFactories(self, layer: QgsVectorLayer | None, type: QgsGeometryCheck.CheckType, flags: QgsGeometryCheck.Flags | QgsGeometryCheck.Flag = QgsGeometryCheck.Flags()) → List[QgsGeometryCheckFactory]

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

Added in version 3.4.

Parameters:
Return type:

List[QgsGeometryCheckFactory]

registerGeometryCheck(self, checkFactory: QgsGeometryCheckFactory | None)[source]

Registers a new geometry check factory.

Added in version 3.4.

Parameters:

checkFactory (Optional[QgsGeometryCheckFactory])