QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter. More...
#include <qgsabstractlayoutiterator.h>
Public Member Functions | |
virtual | ~QgsAbstractLayoutIterator ()=default |
virtual bool | beginRender ()=0 |
Called when rendering begins, before iteration commences. | |
virtual int | count () const =0 |
Returns the number of features to iterate over. | |
virtual bool | endRender ()=0 |
Ends the render, performing any required cleanup tasks. | |
virtual QString | filePath (const QString &baseFilePath, const QString &extension)=0 |
Returns the file path for the current feature, based on a specified base file path and extension. | |
virtual QgsLayout * | layout ()=0 |
Returns the layout associated with the iterator. | |
virtual bool | next ()=0 |
Iterates to next feature, returning false if no more features exist to iterate over. | |
An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter.
Definition at line 29 of file qgsabstractlayoutiterator.h.
|
virtualdefault |
|
pure virtual |
Called when rendering begins, before iteration commences.
Returns true
if successful, false
if no iteration is available or required.
Implemented in QgsLayoutAtlas.
|
pure virtual |
Returns the number of features to iterate over.
Implemented in QgsLayoutAtlas.
|
pure virtual |
Ends the render, performing any required cleanup tasks.
Implemented in QgsLayoutAtlas.
|
pure virtual |
Returns the file path for the current feature, based on a specified base file path and extension.
Implemented in QgsLayoutAtlas.
|
pure virtual |
Returns the layout associated with the iterator.
Implemented in QgsLayoutAtlas.
|
pure virtual |
Iterates to next feature, returning false
if no more features exist to iterate over.