-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgslayoutatlas.sip
377 lines (254 loc) · 9.24 KB
/
qgslayoutatlas.sip
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutatlas.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsLayoutAtlas : QObject, QgsAbstractLayoutIterator, QgsLayoutSerializableObject
{
%Docstring
Class used to render an Atlas, iterating over geometry features.
prepareForFeature() modifies the atlas map's extent to zoom on the given feature.
This class is used for printing, exporting to PDF and images.
.. note::
This class should not be created directly. For the atlas to function correctly
the atlasComposition() property for QgsComposition should be used to retrieve a
QgsLayoutAtlas which is automatically created and attached to the composition.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgslayoutatlas.h"
%End
public:
QgsLayoutAtlas( QgsLayout *layout /TransferThis/ );
%Docstring
Constructor for new QgsLayoutAtlas.
%End
virtual QString stringType() const;
virtual QgsLayout *layout();
virtual bool writeXml( QDomElement &parentElement, QDomDocument &document, const QgsReadWriteContext &context ) const;
virtual bool readXml( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context );
bool enabled() const;
%Docstring
Returns whether the atlas generation is enabled
.. seealso:: :py:func:`setEnabled()`
%End
void setEnabled( bool enabled );
%Docstring
Sets whether the atlas is ``enabled``.
.. seealso:: :py:func:`enabled()`
%End
bool hideCoverage() const;
%Docstring
Returns true if the atlas is set to hide the coverage layer.
.. seealso:: :py:func:`setHideCoverage()`
%End
void setHideCoverage( bool hide );
%Docstring
Sets whether the coverage layer should be hidden in map items in the layouts.
.. seealso:: :py:func:`hideCoverage()`
%End
QString filenameExpression() const;
%Docstring
Returns the filename expression used for generating output filenames for each
atlas page.
.. seealso:: :py:func:`setFilenameExpression()`
.. seealso:: :py:func:`currentFilename()`
%End
bool setFilenameExpression( const QString &expression, QString &errorString /Out/ );
%Docstring
Sets the filename ``expression`` used for generating output filenames for each
atlas page.
If an invalid expression is passed, false will be returned and ``errorString``
will be set to the expression error.
.. seealso:: :py:func:`filenameExpression()`
.. seealso:: :py:func:`currentFilename()`
%End
QString currentFilename() const;
%Docstring
Returns the current feature filename.
.. seealso:: :py:func:`filenameExpression()`
.. seealso:: :py:func:`setFilenameExpression()`
%End
QgsVectorLayer *coverageLayer() const;
%Docstring
Returns the coverage layer used for the atlas features.
.. seealso:: :py:func:`setCoverageLayer()`
%End
void setCoverageLayer( QgsVectorLayer *layer );
%Docstring
Sets the coverage ``layer`` to use for the atlas features.
.. seealso:: :py:func:`coverageLayer()`
%End
QString pageNameExpression() const;
%Docstring
Returns the expression (or field name) used for calculating the page name.
.. seealso:: :py:func:`setPageNameExpression()`
.. seealso:: :py:func:`nameForPage()`
%End
void setPageNameExpression( const QString &expression );
%Docstring
Sets the ``expression`` (or field name) used for calculating the page name.
.. seealso:: :py:func:`pageNameExpression()`
%End
QString nameForPage( int page ) const;
%Docstring
Returns the calculated name for a specified atlas ``page`` number. Page numbers start at 0.
.. seealso:: :py:func:`pageNameExpression()`
%End
bool sortFeatures() const;
%Docstring
Returns true if features should be sorted in the atlas.
.. seealso:: :py:func:`setSortFeatures()`
.. seealso:: :py:func:`sortAscending()`
.. seealso:: :py:func:`sortExpression()`
%End
void setSortFeatures( bool enabled );
%Docstring
Sets whether features should be sorted in the atlas.
.. seealso:: :py:func:`sortFeatures()`
.. seealso:: :py:func:`setSortAscending()`
.. seealso:: :py:func:`setSortExpression()`
%End
bool sortAscending() const;
%Docstring
Returns true if features should be sorted in an ascending order.
This property has no effect is sortFeatures() is false.
.. seealso:: :py:func:`sortFeatures()`
.. seealso:: :py:func:`setSortAscending()`
.. seealso:: :py:func:`sortExpression()`
%End
void setSortAscending( bool ascending );
%Docstring
Sets whether features should be sorted in an ascending order.
This property has no effect is sortFeatures() is false.
.. seealso:: :py:func:`setSortFeatures()`
.. seealso:: :py:func:`sortAscending()`
.. seealso:: :py:func:`setSortExpression()`
%End
QString sortExpression() const;
%Docstring
Returns the expression (or field name) to use for sorting features.
This property has no effect is sortFeatures() is false.
.. seealso:: :py:func:`sortFeatures()`
.. seealso:: :py:func:`sortAscending()`
.. seealso:: :py:func:`setSortExpression()`
%End
void setSortExpression( const QString &expression );
%Docstring
Sets the ``expression`` (or field name) to use for sorting features.
This property has no effect is sortFeatures() is false.
.. seealso:: :py:func:`setSortFeatures()`
.. seealso:: :py:func:`setSortAscending()`
.. seealso:: :py:func:`sortExpression()`
%End
bool filterFeatures() const;
%Docstring
Returns true if features should be filtered in the coverage layer.
.. seealso:: :py:func:`filterExpression()`
.. seealso:: :py:func:`setFilterExpression()`
%End
void setFilterFeatures( bool filtered );
%Docstring
Sets whether features should be ``filtered`` in the coverage layer.
.. seealso:: :py:func:`filterFeatures()`
.. seealso:: :py:func:`setFilterExpression()`
%End
QString filterExpression() const;
%Docstring
Returns the expression used for filtering features in the coverage layer.
This property has no effect is filterFeatures() is false.
.. seealso:: :py:func:`setFilterExpression()`
.. seealso:: :py:func:`filterFeatures()`
%End
bool setFilterExpression( const QString &expression, QString &errorString /Out/ );
%Docstring
Sets the ``expression`` used for filtering features in the coverage layer.
This property has no effect is filterFeatures() is false.
If an invalid expression is passed, false will be returned and ``errorString``
will be set to the expression error.
.. seealso:: :py:func:`filterExpression()`
.. seealso:: :py:func:`setFilterFeatures()`
%End
int updateFeatures();
%Docstring
Requeries the current atlas coverage layer and applies filtering and sorting. Returns
number of matching features.
%End
virtual bool beginRender();
virtual bool endRender();
virtual int count() const;
int currentFeatureNumber() const;
%Docstring
Returns the current feature number, where a value of 0 corresponds to the first feature.
%End
public slots:
virtual bool next();
bool previous();
%Docstring
Iterates to the previous feature, returning false if no previous feature exists.
.. seealso:: :py:func:`next()`
.. seealso:: :py:func:`last()`
.. seealso:: :py:func:`first()`
%End
bool last();
%Docstring
Seeks to the last feature, returning false if no feature was found.
.. seealso:: :py:func:`next()`
.. seealso:: :py:func:`previous()`
.. seealso:: :py:func:`first()`
%End
bool first();
%Docstring
Seeks to the first feature, returning false if no feature was found.
.. seealso:: :py:func:`next()`
.. seealso:: :py:func:`previous()`
.. seealso:: :py:func:`last()`
%End
bool seekTo( int feature );
void refreshCurrentFeature();
%Docstring
Refreshes the current atlas feature, by refetching its attributes from the vector layer provider
%End
signals:
void changed();
%Docstring
Emitted when one of the atlas parameters changes.
%End
void toggled( bool );
%Docstring
Emitted when atlas is enabled or disabled.
%End
void coverageLayerChanged( QgsVectorLayer *layer );
%Docstring
Emitted when the coverage layer for the atlas changes.
%End
void messagePushed( const QString &message );
%Docstring
Is emitted when the atlas has an updated status bar ``message``.
%End
void numberFeaturesChanged( int numFeatures );
%Docstring
Emitted when the number of features for the atlas changes.
%End
void featureChanged( const QgsFeature &feature );
%Docstring
Is emitted when the current atlas ``feature`` changes.
%End
void renderBegun();
%Docstring
Emitted when atlas rendering has begun.
%End
void renderEnded();
%Docstring
Emitted when atlas rendering has ended.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgslayoutatlas.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/