QGIS API Documentation
3.14.0-Pi (9f7028fd23)
src
core
layout
qgsmasterlayoutinterface.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgslayoutinterface.h
3
--------------------
4
begin : December 2017
5
copyright : (C) 2017 by 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
#ifndef QGSLAYOUTINTERFACE_H
17
#define QGSLAYOUTINTERFACE_H
18
19
#include "qgis_core.h"
20
#include "
qgis_sip.h
"
21
#include <QString>
22
#include <QIcon>
23
#include <QDomElement>
24
25
class
QgsProject
;
26
class
QgsReadWriteContext
;
27
class
QgsStyleEntityVisitorInterface
;
28
29
#ifdef SIP_RUN
30
% ModuleHeaderCode
31
#include "
qgsprintlayout.h
"
32
#include "
qgsreport.h
"
33
% End
34
#endif
35
42
class
CORE_EXPORT
QgsMasterLayoutInterface
43
{
44
45
#ifdef SIP_RUN
46
SIP_CONVERT_TO_SUBCLASS_CODE
47
switch
( sipCpp->layoutType() )
48
{
49
case
QgsMasterLayoutInterface::PrintLayout
:
50
sipType = sipType_QgsPrintLayout;
51
*sipCppRet =
static_cast<
QgsPrintLayout
*
>
( sipCpp );
52
break
;
53
case
QgsMasterLayoutInterface::Report
:
54
*sipCppRet =
static_cast<
QgsReport *
>
( sipCpp );
55
sipType = sipType_QgsReport;
56
break
;
57
default
:
58
sipType = NULL;
59
}
60
SIP_END
61
#endif
62
63
public
:
64
66
enum
Type
67
{
68
PrintLayout = 0,
69
Report = 1,
70
};
71
72
virtual
~
QgsMasterLayoutInterface
() =
default
;
73
78
virtual
QgsMasterLayoutInterface
*clone()
const
= 0
SIP_FACTORY
;
79
83
virtual
QgsMasterLayoutInterface::Type
layoutType()
const
= 0;
84
89
virtual
QString name()
const
= 0;
90
94
virtual
QIcon icon()
const
= 0;
95
100
virtual
void
setName(
const
QString &name ) = 0;
101
106
virtual
QgsProject
*layoutProject()
const
= 0;
107
112
virtual
QDomElement writeLayoutXml( QDomDocument &document,
const
QgsReadWriteContext
&context )
const
= 0;
113
118
virtual
bool
readLayoutXml(
const
QDomElement &layoutElement,
const
QDomDocument &document,
const
QgsReadWriteContext
&context ) = 0;
119
123
virtual
void
updateSettings() = 0;
124
134
virtual
bool
layoutAccept
(
QgsStyleEntityVisitorInterface
*visitor )
const
{ Q_UNUSED( visitor );
return
true
; }
135
136
};
137
138
#endif //QGSLAYOUTINTERFACE_H
139
140
141
QgsReadWriteContext
Definition:
qgsreadwritecontext.h:34
QgsStyleEntityVisitorInterface
Definition:
qgsstyleentityvisitor.h:33
QgsMasterLayoutInterface::PrintLayout
@ PrintLayout
Individual print layout (QgsPrintLayout)
Definition:
qgsmasterlayoutinterface.h:68
QgsProject
Definition:
qgsproject.h:92
SIP_FACTORY
#define SIP_FACTORY
Definition:
qgis_sip.h:76
SIP_CONVERT_TO_SUBCLASS_CODE
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition:
qgis_sip.h:172
QgsPrintLayout
Print layout, a QgsLayout subclass for static or atlas-based layouts.
Definition:
qgsprintlayout.h:30
qgsreport.h
QgsMasterLayoutInterface::layoutAccept
virtual bool layoutAccept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified style entity visitor, causing it to visit all style entities associated with th...
Definition:
qgsmasterlayoutinterface.h:134
qgis_sip.h
QgsMasterLayoutInterface::Type
Type
Master layout type.
Definition:
qgsmasterlayoutinterface.h:66
qgsprintlayout.h
QgsMasterLayoutInterface::Report
@ Report
Report (QgsReport)
Definition:
qgsmasterlayoutinterface.h:69
QgsMasterLayoutInterface
Interface for master layout type objects, such as print layouts and reports.
Definition:
qgsmasterlayoutinterface.h:42
SIP_END
#define SIP_END
Definition:
qgis_sip.h:189
Generated on Mon Jun 22 2020 05:14:09 for QGIS API Documentation by
1.8.17