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. More... | |
| int | type () const override |
| Returns the context type. More... | |
 Public Member Functions inherited from QgsValidityCheckContext | |
| virtual | ~QgsValidityCheckContext ()=default |
| virtual int | type () const =0 |
| Returns the context type. More... | |
Public Attributes | |
| QgsLayout * | layout = nullptr |
| Pointer to the layout which the check is being run against. More... | |
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()
|
inline |
Constructor for QgsLayoutValidityCheckContext for the specified layout.
Definition at line 82 of file qgsvaliditycheckcontext.h.
Member Function Documentation
◆ type()
|
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.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/validity/qgsvaliditycheckcontext.h
