QgsLayoutOverviewValidityCheck Class Reference

Layout overview validity check. More...

#include <qgslayoutvaliditychecks.h>

Inheritance diagram for QgsLayoutOverviewValidityCheck:

Public Member Functions
int	checkType () const override
	Returns the type of the check.
QgsLayoutOverviewValidityCheck *	create () const override
	constructor
QString	id () const override
	Returns the unique ID of the check.
bool	prepareCheck (const QgsValidityCheckContext *context, QgsFeedback *feedback) override
	Prepares the check for execution, and returns true if the check can be run.
QList< QgsValidityCheckResult >	runCheck (const QgsValidityCheckContext *context, QgsFeedback *feedback) override
	Runs the check and returns a list of results.
Public Member Functions inherited from QgsAbstractValidityCheck
virtual	~QgsAbstractValidityCheck ()=default

Additional Inherited Members
Public Types inherited from QgsAbstractValidityCheck
enum class	Type : int { LayoutCheck = 0 , UserCheck = 10000 }
	Check types. More...

Detailed Description

Layout overview validity check.

Note

This class is not a part of public API

Since

QGIS 3.12

Definition at line 77 of file qgslayoutvaliditychecks.h.

Member Function Documentation

checkType()

int QgsLayoutOverviewValidityCheck::checkType ( ) const

overridevirtual

Returns the type of the check.

Implements QgsAbstractValidityCheck.

Definition at line 153 of file qgslayoutvaliditychecks.cpp.

create()

QgsLayoutOverviewValidityCheck * QgsLayoutOverviewValidityCheck::create ( ) const

overridevirtual

constructor

Implements QgsAbstractValidityCheck.

Definition at line 143 of file qgslayoutvaliditychecks.cpp.

id()

QString QgsLayoutOverviewValidityCheck::id ( ) const

overridevirtual

Returns the unique ID of the check.

This is a non-translated, non-user visible string identifying the check.

Implements QgsAbstractValidityCheck.

Definition at line 148 of file qgslayoutvaliditychecks.cpp.

prepareCheck()

bool QgsLayoutOverviewValidityCheck::prepareCheck ( const QgsValidityCheckContext *  context, QgsFeedback *  feedback  )

overridevirtual

Prepares the check for execution, and returns true if the check can be run.

This method is always called from the main thread, and subclasses can implement it to do preparatory steps which are not thread safe (e.g. obtaining feature sources from vector layers). It is followed by a call to runCheck(), which may be performed in a background thread.

Individual calls to prepareCheck()/runCheck() are run on a new instance of the check (see create()), so subclasses can safely store state from the prepareCheck() method ready for the subsequent runCheck() method.

The context argument gives the wider in which the check is being run.

Reimplemented from QgsAbstractValidityCheck.

Definition at line 158 of file qgslayoutvaliditychecks.cpp.

runCheck()

QList< QgsValidityCheckResult > QgsLayoutOverviewValidityCheck::runCheck ( const QgsValidityCheckContext *  context, QgsFeedback *  feedback  )

overridevirtual

Runs the check and returns a list of results.

If the check is "passed" and no warnings or errors are generated, then an empty list should be returned.

This method may be called in a background thread, so subclasses should take care to ensure that only thread-safe methods are used. It is always preceded by a call to prepareCheck().

If a check needs to perform non-thread-safe tests, these should be implemented within prepareCheck() and stored in the subclass instance to be returned by this method.

The context argument gives the wider in which the check is being run.

Implements QgsAbstractValidityCheck.

Definition at line 189 of file qgslayoutvaliditychecks.cpp.

---

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

• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/layout/qgslayoutvaliditychecks.h
• /build/qgis-3.41.0+git20241119+45a0abf3bec+99sid/src/gui/layout/qgslayoutvaliditychecks.cpp