QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
src
gui
layout
qgslayoutvaliditychecks.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgslayoutvaliditychecks.h
3
---------------------------
4
begin : November 2018
5
copyright : (C) 2018 Nyall Dawson
6
email : nyall dot dawson at gmail dot com
7
***************************************************************************/
8
/***************************************************************************
9
* *
10
* This program is free software; you can redistribute it and/or modify *
11
* it under the terms of the GNU General Public License as published by *
12
* the Free Software Foundation; either version 2 of the License, or *
13
* (at your option) any later version. *
14
* *
15
***************************************************************************/
16
17
#ifndef QGSLAYOUTVALIDITYCHECKS_H
18
#define QGSLAYOUTVALIDITYCHECKS_H
19
20
// We don't want to expose this in the public API
21
#define SIP_NO_FILE
22
23
#include "qgis_gui.h"
24
#include "
qgsabstractvaliditycheck.h
"
25
33
class
GUI_EXPORT
QgsLayoutScaleBarValidityCheck
:
public
QgsAbstractValidityCheck
34
{
35
public
:
37
QgsLayoutScaleBarValidityCheck
*
create
()
const override
;
38
QString
id
()
const override
;
39
int
checkType
()
const override
;
40
bool
prepareCheck
(
const
QgsValidityCheckContext
*context,
QgsFeedback
*feedback )
override
;
41
QList< QgsValidityCheckResult >
runCheck
(
const
QgsValidityCheckContext
*context,
QgsFeedback
*feedback )
override
;
42
43
private
:
44
QList<QgsValidityCheckResult> mResults;
45
};
46
47
55
class
GUI_EXPORT
QgsLayoutNorthArrowValidityCheck
:
public
QgsAbstractValidityCheck
56
{
57
public
:
59
QgsLayoutNorthArrowValidityCheck
*
create
()
const override
;
60
QString
id
()
const override
;
61
int
checkType
()
const override
;
62
bool
prepareCheck
(
const
QgsValidityCheckContext
*context,
QgsFeedback
*feedback )
override
;
63
QList< QgsValidityCheckResult >
runCheck
(
const
QgsValidityCheckContext
*context,
QgsFeedback
*feedback )
override
;
64
65
private
:
66
QList<QgsValidityCheckResult> mResults;
67
};
68
69
77
class
GUI_EXPORT
QgsLayoutOverviewValidityCheck
:
public
QgsAbstractValidityCheck
78
{
79
public
:
81
QgsLayoutOverviewValidityCheck
*
create
()
const override
;
82
QString
id
()
const override
;
83
int
checkType
()
const override
;
84
bool
prepareCheck
(
const
QgsValidityCheckContext
*context,
QgsFeedback
*feedback )
override
;
85
QList< QgsValidityCheckResult >
runCheck
(
const
QgsValidityCheckContext
*context,
QgsFeedback
*feedback )
override
;
86
87
private
:
88
QList<QgsValidityCheckResult> mResults;
89
};
90
91
99
class
GUI_EXPORT
QgsLayoutPictureSourceValidityCheck
:
public
QgsAbstractValidityCheck
100
{
101
public
:
103
QgsLayoutPictureSourceValidityCheck
*
create
()
const override
;
104
QString
id
()
const override
;
105
int
checkType
()
const override
;
106
bool
prepareCheck
(
const
QgsValidityCheckContext
*context,
QgsFeedback
*feedback )
override
;
107
QList< QgsValidityCheckResult >
runCheck
(
const
QgsValidityCheckContext
*context,
QgsFeedback
*feedback )
override
;
108
109
private
:
110
QList<QgsValidityCheckResult> mResults;
111
};
112
113
#endif // QGSLAYOUTVALIDITYCHECKS_H
QgsLayoutPictureSourceValidityCheck
Layout picture source validity check.
Definition:
qgslayoutvaliditychecks.h:100
qgsabstractvaliditycheck.h
QgsAbstractValidityCheck::prepareCheck
virtual bool prepareCheck(const QgsValidityCheckContext *context, QgsFeedback *feedback)
Prepares the check for execution, and returns true if the check can be run.
Definition:
qgsabstractvaliditycheck.h:137
QgsAbstractValidityCheck::create
virtual QgsAbstractValidityCheck * create() const =0
Creates a new instance of the check and returns it.
QgsLayoutOverviewValidityCheck
Layout overview validity check.
Definition:
qgslayoutvaliditychecks.h:78
QgsValidityCheckContext
Base class for validity check contexts.
Definition:
qgsvaliditycheckcontext.h:36
QgsFeedback
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition:
qgsfeedback.h:44
QgsLayoutNorthArrowValidityCheck
Layout north arrow validity check.
Definition:
qgslayoutvaliditychecks.h:56
QgsAbstractValidityCheck::runCheck
virtual QList< QgsValidityCheckResult > runCheck(const QgsValidityCheckContext *context, QgsFeedback *feedback)=0
Runs the check and returns a list of results.
QgsAbstractValidityCheck
Abstract base class for individual validity checks.
Definition:
qgsabstractvaliditycheck.h:93
QgsAbstractValidityCheck::checkType
virtual int checkType() const =0
Returns the type of the check.
QgsAbstractValidityCheck::id
virtual QString id() const =0
Returns the unique ID of the check.
QgsLayoutScaleBarValidityCheck
Layout scalebar validity check.
Definition:
qgslayoutvaliditychecks.h:34
Generated on Sat Oct 24 2020 17:43:09 for QGIS API Documentation by
1.8.20