40 return QStringLiteral(
"layout_scalebar_check" );
57 QList< QgsLayoutItemScaleBar * > barItems;
61 if ( !bar->linkedMap() )
65 res.
title = QObject::tr(
"Scalebar is not linked to a map" );
66 const QString name = bar->displayName().toHtmlEscaped();
67 res.
detailedDescription = QObject::tr(
"The scalebar “%1” is not linked to a map item. This scale will be misleading." ).arg( name );
68 mResults.append( res );
92 return QStringLiteral(
"layout_northarrow_check" );
106 if ( !layoutContext )
110 const QString defaultPath = settings.
value( QStringLiteral(
"LayoutDesigner/defaultNorthArrow" ), QStringLiteral(
":/images/north_arrows/layout_default_north_arrow.svg" ),
QgsSettings::Gui ).toString();
112 QList< QgsLayoutItemPicture * > pictureItems;
118 if ( !picture->linkedMap() && ( picture->picturePath() == defaultPath || picture->id().contains( QObject::tr(
"North Arrow" ), Qt::CaseInsensitive ) ) )
122 res.
title = QObject::tr(
"North arrow is not linked to a map" );
123 const QString name = picture->displayName().toHtmlEscaped();
124 res.
detailedDescription = QObject::tr(
"The north arrow “%1” is not linked to a map item. The arrow orientation may be misleading." ).arg( name );
125 mResults.append( res );
150 return QStringLiteral(
"layout_overview_check" );
164 if ( !layoutContext )
167 QList< QgsLayoutItemMap * > mapItems;
171 for (
int i = 0; i < map->overviews()->size(); ++i )
178 res.
title = QObject::tr(
"Overview is not linked to a map" );
179 const QString name = map->displayName().toHtmlEscaped();
180 res.
detailedDescription = QObject::tr(
"The map “%1” includes an overview (“%2”) which is not linked to a map item." ).arg( name, overview->
name() );
181 mResults.append( res );
207 return QStringLiteral(
"layout_picture_source_check" );
221 if ( !layoutContext )
224 QList< QgsLayoutItemPicture * > pictureItems;
228 if ( picture->isMissingImage() )
232 res.
title = QObject::tr(
"Picture source is missing or corrupt" );
233 const QString name = picture->displayName().toHtmlEscaped();
235 const QUrl picUrl = QUrl::fromUserInput( picture->evaluatedPath() );
236 const bool isLocalFile = picUrl.isLocalFile();
238 res.
detailedDescription = QObject::tr(
"The source for picture “%1” could not be loaded or is corrupt:<p>%2" ).arg( name,
239 isLocalFile ? QDir::toNativeSeparators( picture->evaluatedPath() ) : picture->evaluatedPath() );
240 mResults.append( res );
264 return QStringLiteral(
"layout_html_item_check" );
278 if ( !layoutContext )
281 const QList<QgsLayoutMultiFrame *> multiFrames = layoutContext->
layout->
multiFrames();
288 res.
title = QObject::tr(
"HTML item cannot be rendered" );
289 res.
detailedDescription = QObject::tr(
"HTML items cannot be rendered because this QGIS install was built without WebKit support. These items will be missing from the export." );
290 mResults.append( res );
@ LayoutCheck
Print layout validity check, triggered on exporting a print layout.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Layout HTML item validity check.
QList< QgsValidityCheckResult > runCheck(const QgsValidityCheckContext *context, QgsFeedback *feedback) override
Runs the check and returns a list of results.
QString id() const override
Returns the unique ID of the check.
QgsLayoutHtmlItemValidityCheck * create() const override
constructor
bool prepareCheck(const QgsValidityCheckContext *context, QgsFeedback *feedback) override
Prepares the check for execution, and returns true if the check can be run.
int checkType() const override
Returns the type of the check.
QString name() const
Returns the friendly display name for the item.
bool enabled() const
Returns whether the item will be drawn.
An individual overview which is drawn above the map content in a QgsLayoutItemMap,...
QgsLayoutItemMap * linkedMap()
Returns the source map to show the overview extent of.
Layout graphical items for displaying a map.
A layout item subclass that displays SVG files or raster format images (jpg, png, ....
@ LayoutHtml
Html multiframe item.
A layout item subclass for scale bars.
Abstract base class for layout items with the ability to distribute the content to several frames (Qg...
Layout north arrow validity check.
int checkType() const override
Returns the type 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.
QString id() const override
Returns the unique ID of the check.
QgsLayoutNorthArrowValidityCheck * create() const override
constructor
QList< QgsValidityCheckResult > runCheck(const QgsValidityCheckContext *context, QgsFeedback *feedback) override
Runs the check and returns a list of results.
Layout overview validity check.
QList< QgsValidityCheckResult > runCheck(const QgsValidityCheckContext *context, QgsFeedback *feedback) override
Runs the check and returns a list of results.
int checkType() const override
Returns the type of the check.
QString id() const override
Returns the unique ID of the check.
QgsLayoutOverviewValidityCheck * create() const override
constructor
bool prepareCheck(const QgsValidityCheckContext *context, QgsFeedback *feedback) override
Prepares the check for execution, and returns true if the check can be run.
Layout picture source validity check.
bool prepareCheck(const QgsValidityCheckContext *context, QgsFeedback *feedback) override
Prepares the check for execution, and returns true if the check can be run.
QString id() const override
Returns the unique ID of the check.
QList< QgsValidityCheckResult > runCheck(const QgsValidityCheckContext *context, QgsFeedback *feedback) override
Runs the check and returns a list of results.
QgsLayoutPictureSourceValidityCheck * create() const override
constructor
int checkType() const override
Returns the type of the check.
Layout scalebar validity check.
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.
int checkType() const override
Returns the type of the check.
QgsLayoutScaleBarValidityCheck * create() const override
constructor
Validity check context for print layout validation.
QgsLayout * layout
Pointer to the layout which the check is being run against.
void layoutItems(QList< T * > &itemList) const
Returns a list of layout items of a specific type.
QList< QgsLayoutMultiFrame * > multiFrames() const
Returns a list of multi frames contained in the layout.
This class is a composition of two QSettings instances:
QVariant value(const QString &key, const QVariant &defaultValue=QVariant(), Section section=NoSection) const
Returns the value for setting key.
Base class for validity check contexts.
virtual int type() const =0
Returns the context type.
@ TypeLayoutContext
Layout context, see QgsLayoutValidityCheckContext.
Represents an individual result from a validity check run by a QgsAbstractValidityCheck subclass.
@ Warning
Warning only, allow operation to proceed but notify user of result.
QString detailedDescription
Detailed description of the result (translated), giving users enough detail for them to resolve the e...
QString title
A short, translated string summarising the result.