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
|
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgsabstractlayoutiterator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsAbstractLayoutIterator
{
%Docstring(signature="appended")
An abstract base class for :py:class:`QgsLayout` based classes which can be exported by :py:class:`QgsLayoutExporter`.
.. versionadded:: 3.0
%End
%TypeHeaderCode
#include "qgsabstractlayoutiterator.h"
%End
public:
virtual ~QgsAbstractLayoutIterator();
virtual QgsLayout *layout() = 0;
%Docstring
Returns the layout associated with the iterator.
%End
virtual bool beginRender() = 0;
%Docstring
Called when rendering begins, before iteration commences. Returns ``True`` if successful, ``False`` if no iteration
is available or required.
.. seealso:: :py:func:`endRender`
%End
virtual bool endRender() = 0;
%Docstring
Ends the render, performing any required cleanup tasks.
%End
virtual int count() const = 0;
%Docstring
Returns the number of features to iterate over.
%End
virtual bool next() = 0;
%Docstring
Iterates to next feature, returning ``False`` if no more features exist to iterate over.
%End
virtual QString filePath( const QString &baseFilePath, const QString &extension ) = 0;
%Docstring
Returns the file path for the current feature, based on a
specified base file path and extension.
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/layout/qgsabstractlayoutiterator.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
|
