QgsAbstractLayoutIterator class

An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter.

Derived classes

class QgsLayoutAtlas: Class used to render QgsLayout as an atlas, by iterating over the features from an associated vector layer.

auto beginRender() -> bool pure virtual: Called when rendering begins, before iteration commences.
auto count() -> int pure virtual: Returns the number of features to iterate over.
auto endRender() -> bool pure virtual: Ends the render, performing any required cleanup tasks.
auto filePath(const QString& baseFilePath, const QString& extension) -> QString pure virtual: Returns the file path for the current feature, based on a specified base file path and extension.
auto layout() -> QgsLayout* pure virtual: Returns the layout associated with the iterator.
auto next() -> bool pure virtual: Iterates to next feature, returning false if no more features exist to iterate over.

Called when rendering begins, before iteration commences.

Returns true if successful, false if no iteration is available or required.