QgsValidityCheckContext Class Reference

Base class for validity check contexts. More...

#include <qgsvaliditycheckcontext.h>

Inheritance diagram for QgsValidityCheckContext:

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

Public Member Functions
virtual	~QgsValidityCheckContext ()=default
virtual int	type () const =0
	Returns the context type. More...

Detailed Description

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.

Since

QGIS 3.6

Definition at line 35 of file qgsvaliditycheckcontext.h.

Member Enumeration Documentation

ContextType

enum QgsValidityCheckContext::ContextType

Available check context types.

Enumerator
TypeLayoutContext	Layout context, see QgsLayoutValidityCheckContext.
TypeUserContext	Starting point for user contexts.

Definition at line 50 of file qgsvaliditycheckcontext.h.

Constructor & Destructor Documentation

~QgsValidityCheckContext()

virtual QgsValidityCheckContext::~QgsValidityCheckContext ( )

virtualdefault

Member Function Documentation

type()

virtual int QgsValidityCheckContext::type ( ) const

pure virtual

Returns the context type.

Implemented in QgsLayoutValidityCheckContext.

---

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

• /build/qgis-3.22.4+99unstable/src/core/validity/qgsvaliditycheckcontext.h