QGIS API Documentation 3.41.0-Master (181b2f43d8e)
|
Represents an individual result from a validity check run by a QgsAbstractValidityCheck subclass. More...
#include <qgsabstractvaliditycheck.h>
Public Types | |
enum | Type { Warning , Critical } |
Result types. More... | |
Public Attributes | |
QString | checkId |
ID of the check which generated the result. | |
QString | detailedDescription |
Detailed description of the result (translated), giving users enough detail for them to resolve the error. | |
QString | title |
A short, translated string summarising the result. | |
Type | type |
Result type. | |
Represents an individual result from a validity check run by a QgsAbstractValidityCheck subclass.
Results can either be warnings or critical errors, as dictated by the type member. Critical error are errors which are serious enough to prevent an operation from proceeding, while a warning result will be communicated to users, but not prevent them from proceeding.
Definition at line 37 of file qgsabstractvaliditycheck.h.
Result types.
Enumerator | |
---|---|
Warning | Warning only, allow operation to proceed but notify user of result. |
Critical | Critical error - notify user of result and prevent operation from proceeding. |
Definition at line 42 of file qgsabstractvaliditycheck.h.
QString QgsValidityCheckResult::checkId |
ID of the check which generated the result.
This is usually automatically populated.
Definition at line 65 of file qgsabstractvaliditycheck.h.
QString QgsValidityCheckResult::detailedDescription |
Detailed description of the result (translated), giving users enough detail for them to resolve the error.
Definition at line 60 of file qgsabstractvaliditycheck.h.
QString QgsValidityCheckResult::title |
A short, translated string summarising the result.
Ideally a single sentence.
Definition at line 54 of file qgsabstractvaliditycheck.h.
Type QgsValidityCheckResult::type |
Result type.
Definition at line 49 of file qgsabstractvaliditycheck.h.