1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgsreportsectionfieldgroup.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsReportSectionFieldGroup : QgsAbstractReportSection
{
%Docstring(signature="appended")
A report section consisting of a features
.. warning::
This is not considered stable API, and may change in future QGIS releases. It is
exposed to the Python bindings for unit testing purposes only.
%End
%TypeHeaderCode
#include "qgsreportsectionfieldgroup.h"
%End
public:
enum SectionVisibility /BaseType=IntEnum/
{
IncludeWhenFeaturesFound,
AlwaysInclude
};
QgsReportSectionFieldGroup( QgsAbstractReportSection *parentSection = 0 );
%Docstring
Constructor for QgsReportSectionFieldGroup, attached to the specified
``parent`` section. Note that ownership is not transferred to
``parent``.
%End
virtual QString type() const;
virtual QString description() const;
virtual QIcon icon() const;
QgsLayout *body();
%Docstring
Returns the body layout for the section.
.. seealso:: :py:func:`setBody`
.. seealso:: :py:func:`bodyEnabled`
.. seealso:: :py:func:`setBodyEnabled`
%End
void setBody( QgsLayout *body /Transfer/ );
%Docstring
Sets the ``body`` layout for the section. Ownership of ``body`` is
transferred to the report section.
.. seealso:: :py:func:`body`
.. seealso:: :py:func:`bodyEnabled`
.. seealso:: :py:func:`setBodyEnabled`
%End
bool bodyEnabled() const;
%Docstring
Returns ``True`` if the body for the section is enabled.
.. seealso:: :py:func:`setBodyEnabled`
.. seealso:: :py:func:`body`
.. seealso:: :py:func:`setBody`
%End
void setBodyEnabled( bool enabled );
%Docstring
Sets whether the body for the section is ``enabled``.
.. seealso:: :py:func:`bodyEnabled`
.. seealso:: :py:func:`body`
.. seealso:: :py:func:`setBody`
%End
QgsVectorLayer *layer();
%Docstring
Returns the vector layer associated with this section.
.. seealso:: :py:func:`setLayer`
%End
void setLayer( QgsVectorLayer *layer );
%Docstring
Sets the vector ``layer`` associated with this section.
.. seealso:: :py:func:`layer`
%End
QString field() const;
%Docstring
Returns the field associated with this section.
.. seealso:: :py:func:`setField`
%End
void setField( const QString &field );
%Docstring
Sets the ``field`` associated with this section.
.. seealso:: :py:func:`field`
%End
bool sortAscending() const;
%Docstring
Returns ``True`` if the field values should be sorted ascending, or
``False`` for descending sort.
.. seealso:: :py:func:`setSortAscending`
%End
void setSortAscending( bool sortAscending );
%Docstring
Sets whether the field values should be sorted ascending. Set to
``True`` to sort ascending, or ``False`` for descending sort.
.. seealso:: :py:func:`sortAscending`
%End
SectionVisibility headerVisibility() const;
%Docstring
Returns the header visibility mode.
.. seealso:: :py:func:`setHeaderVisibility`
%End
void setHeaderVisibility( SectionVisibility visibility );
%Docstring
Sets the visibility mode for the header.
.. seealso:: :py:func:`headerVisibility`
%End
SectionVisibility footerVisibility() const;
%Docstring
Returns the footer visibility mode.
.. seealso:: :py:func:`setFooterVisibility`
%End
void setFooterVisibility( SectionVisibility visibility );
%Docstring
Sets the visibility mode for the footer.
.. seealso:: :py:func:`footerVisibility`
%End
virtual QgsReportSectionFieldGroup *clone() const /Factory/;
virtual bool beginRender();
virtual bool prepareHeader();
virtual bool prepareFooter();
virtual QgsLayout *nextBody( bool &ok );
virtual void reset();
virtual void setParentSection( QgsAbstractReportSection *parentSection );
virtual void reloadSettings();
protected:
virtual bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const;
virtual bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context );
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgsreportsectionfieldgroup.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
|
