QgsValidityCheckContext class

Base class for validity check contexts.

Contents

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.

Derived classes

class QgsLayoutValidityCheckContext
Validity check context for print layout validation.

Public types

enum ContextType { TypeLayoutContext = 1, TypeUserContext = 10001 }
Available check context types.

Public functions

auto type() const -> int pure virtual
Returns the context type.

Enum documentation

enum QgsValidityCheckContext::ContextType

Available check context types.

Enumerators
TypeLayoutContext

Layout context, see QgsLayoutValidityCheckContext.
TypeUserContext

Starting point for user contexts.