QgsValidityCheckResult class

Represents an individual result from a validity check run by a QgsAbstractValidityCheck subclass.

Contents

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.

Public types

enum Type { Warning, Critical }
Result types.

Public variables

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.

Enum documentation

enum QgsValidityCheckResult::Type

Result types.

Enumerators
Warning

Warning only, allow operation to proceed but notify user of result.
Critical

Critical error - notify user of result and prevent operation from proceeding.

Variable documentation

QString QgsValidityCheckResult::checkId

ID of the check which generated the result.

This is usually automatically populated.

QString QgsValidityCheckResult::title

A short, translated string summarising the result.

Ideally a single sentence.