Base class for validity check contexts. More...

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.

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.

Definition at line 35 of file qgsvaliditycheckcontext.h.

Member Enumeration Documentation

Available check context types.

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

Definition at line 50 of file qgsvaliditycheckcontext.h.

virtual QgsValidityCheckContext::~QgsValidityCheckContext ( )

virtualdefault

virtual int QgsValidityCheckContext::type ( ) const

pure virtual

Returns the context type.

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