QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Member Functions | List of all members
QgsAbstractLayoutIterator Class Referenceabstract

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

#include <qgsabstractlayoutiterator.h>

Inheritance diagram for QgsAbstractLayoutIterator:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsAbstractLayoutIterator ()=default
 
virtual bool beginRender ()=0
 Called when rendering begins, before iteration commences. More...
 
virtual int count () const =0
 Returns the number of features to iterate over. More...
 
virtual bool endRender ()=0
 Ends the render, performing any required cleanup tasks. More...
 
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. More...
 
virtual QgsLayoutlayout ()=0
 Returns the layout associated with the iterator. More...
 
virtual bool next ()=0
 Iterates to next feature, returning false if no more features exist to iterate over. More...
 

Detailed Description

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

Since
QGIS 3.0

Definition at line 30 of file qgsabstractlayoutiterator.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractLayoutIterator()

virtual QgsAbstractLayoutIterator::~QgsAbstractLayoutIterator ( )
virtualdefault

Member Function Documentation

◆ beginRender()

virtual bool QgsAbstractLayoutIterator::beginRender ( )
pure virtual

Called when rendering begins, before iteration commences.

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

See also
endRender()

Implemented in QgsLayoutAtlas.

◆ count()

virtual int QgsAbstractLayoutIterator::count ( ) const
pure virtual

Returns the number of features to iterate over.

Implemented in QgsLayoutAtlas.

◆ endRender()

virtual bool QgsAbstractLayoutIterator::endRender ( )
pure virtual

Ends the render, performing any required cleanup tasks.

Implemented in QgsLayoutAtlas.

◆ filePath()

virtual QString QgsAbstractLayoutIterator::filePath ( const QString &  baseFilePath,
const QString &  extension 
)
pure virtual

Returns the file path for the current feature, based on a specified base file path and extension.

Implemented in QgsLayoutAtlas.

◆ layout()

virtual QgsLayout * QgsAbstractLayoutIterator::layout ( )
pure virtual

Returns the layout associated with the iterator.

Implemented in QgsLayoutAtlas.

◆ next()

virtual bool QgsAbstractLayoutIterator::next ( )
pure virtual

Iterates to next feature, returning false if no more features exist to iterate over.


The documentation for this class was generated from the following file: