QgsLayoutValidityCheckContext Class Reference

Validity check context for print layout validation. More...

#include <qgsvaliditycheckcontext.h>

Inheritance diagram for QgsLayoutValidityCheckContext:

Public Member Functions
	QgsLayoutValidityCheckContext (QgsLayout *layout)
	Constructor for QgsLayoutValidityCheckContext for the specified layout.
int	type () const override
	Returns the context type.
Public Member Functions inherited from QgsValidityCheckContext
virtual	~QgsValidityCheckContext ()=default

Public Attributes
QgsLayout *	layout = nullptr
	Pointer to the layout which the check is being run against.

Additional Inherited Members
Public Types inherited from QgsValidityCheckContext
enum	ContextType { TypeLayoutContext = 1 , TypeUserContext = 10001 }
	Available check context types. More...

Detailed Description

Validity check context for print layout validation.

QgsLayoutValidityCheckContext are passed to QgsAbstractValidityCheck subclasses which indicate they are of the QgsAbstractValidityCheck::TypeLayoutCheck type.

Since

QGIS 3.6

Definition at line 75 of file qgsvaliditycheckcontext.h.

Constructor & Destructor Documentation

QgsLayoutValidityCheckContext()

QgsLayoutValidityCheckContext::QgsLayoutValidityCheckContext ( QgsLayout *  layout )

inline

Constructor for QgsLayoutValidityCheckContext for the specified layout.

Definition at line 82 of file qgsvaliditycheckcontext.h.

Member Function Documentation

type()

int QgsLayoutValidityCheckContext::type ( ) const

inlineoverridevirtual

Returns the context type.

Implements QgsValidityCheckContext.

Definition at line 86 of file qgsvaliditycheckcontext.h.

Member Data Documentation

layout

QgsLayout* QgsLayoutValidityCheckContext::layout = nullptr

Pointer to the layout which the check is being run against.

Definition at line 91 of file qgsvaliditycheckcontext.h.

---

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

• /build/qgis-3.34.0+99sid/src/core/validity/qgsvaliditycheckcontext.h