Class: QgsValidityCheckContext

Base class for validity check contexts.

QgsAbstractValidityCheck subclasses are passed a QgsValidityCheckContext subclass which encapsulates the context around that particular check type. For instance, a QgsAbstractValidityCheck of the QgsAbstractValidityCheck.TypeLayoutCheck type will be passed a QgsLayoutValidityCheckContext context, containing a reference to the QgsLayout to be checked.

Added in version 3.6.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: type()

List of all members, including inherited members

Class Hierarchy

Inheritance diagram of qgis.core.QgsValidityCheckContext

Subclasses

QgsLayoutValidityCheckContext

Validity check context for print layout validation.

Classes

ContextType

Abstract Methods

type

Returns the context type.

Attributes

TypeLayoutContext

TypeUserContext

class qgis.core.QgsValidityCheckContext[source]

Bases: object

class ContextType

Bases: int

TypeLayoutContext = 1
TypeUserContext = 10001
abstract type(self) int[source]

Returns the context type.

Return type:

int