QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | List of all members
QgsGeometryCheckFactory Class Referenceabstract

A factory for geometry checks. More...

#include <qgsgeometrycheckfactory.h>

Inheritance diagram for QgsGeometryCheckFactory:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsGeometryCheckFactory ()=default
 Destructor. More...
 
virtual QgsGeometryCheck::CheckType checkType () const =0
 The type of this check. More...
 
virtual QgsGeometryCheckcreateGeometryCheck (const QgsGeometryCheckContext *context, const QVariantMap &configuration) const =0
 Creates a new geometry check with context and configuration. More...
 
virtual QString description () const =0
 A human readable description for this check. More...
 
virtual QgsGeometryCheck::Flags flags () const =0
 Flags for this check. More...
 
virtual QString id () const =0
 The unique id for this geometry check. More...
 
virtual bool isCompatible (QgsVectorLayer *layer) const =0
 Checks if this check should be made available for layer. More...
 

Detailed Description

A factory for geometry checks.

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

Definition at line 43 of file qgsgeometrycheckfactory.h.

Constructor & Destructor Documentation

◆ ~QgsGeometryCheckFactory()

virtual QgsGeometryCheckFactory::~QgsGeometryCheckFactory ( )
virtualdefault

Destructor.

Deletes all the registered checks

Member Function Documentation

◆ checkType()

virtual QgsGeometryCheck::CheckType QgsGeometryCheckFactory::checkType ( ) const
pure virtual

The type of this check.

Implemented in QgsGeometryCheckFactoryT< T >.

◆ createGeometryCheck()

virtual QgsGeometryCheck * QgsGeometryCheckFactory::createGeometryCheck ( const QgsGeometryCheckContext context,
const QVariantMap &  configuration 
) const
pure virtual

Creates a new geometry check with context and configuration.

Implemented in QgsGeometryCheckFactoryT< T >.

◆ description()

virtual QString QgsGeometryCheckFactory::description ( ) const
pure virtual

A human readable description for this check.

Implemented in QgsGeometryCheckFactoryT< T >.

◆ flags()

virtual QgsGeometryCheck::Flags QgsGeometryCheckFactory::flags ( ) const
pure virtual

Flags for this check.

Implemented in QgsGeometryCheckFactoryT< T >.

◆ id()

virtual QString QgsGeometryCheckFactory::id ( ) const
pure virtual

The unique id for this geometry check.

Implemented in QgsGeometryCheckFactoryT< T >.

◆ isCompatible()

virtual bool QgsGeometryCheckFactory::isCompatible ( QgsVectorLayer layer) const
pure virtual

Checks if this check should be made available for layer.

Implemented in QgsGeometryCheckFactoryT< T >.


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