QGIS API Documentation  3.13.0-Master (b0e71a822e)
Public Types | Public Attributes | List of all members
QgsValidityCheckResult Class Reference

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. More...
 
QString detailedDescription
 Detailed description of the result (translated), giving users enough detail for them to resolve the error. More...
 
QString title
 A short, translated string summarising the result. More...
 
Type type
 Result type. More...
 

Detailed Description

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.

Since
QGIS 3.6

Definition at line 37 of file qgsabstractvaliditycheck.h.

Member Enumeration Documentation

◆ Type

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.

Member Data Documentation

◆ checkId

QString QgsValidityCheckResult::checkId

ID of the check which generated the result.

This is usually automatically populated.

Definition at line 65 of file qgsabstractvaliditycheck.h.

◆ detailedDescription

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.

◆ title

QString QgsValidityCheckResult::title

A short, translated string summarising the result.

Ideally a single sentence.

Definition at line 54 of file qgsabstractvaliditycheck.h.

◆ type

Type QgsValidityCheckResult::type

Result type.

Definition at line 49 of file qgsabstractvaliditycheck.h.


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