QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
layout
qgsabstractlayoutiterator.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsabstractlayoutiterator.h
3
---------------------------
4
begin : December 2017
5
copyright : (C) 2017 by Nyall Dawson
6
email : nyall dot dawson at gmail dot com
7
***************************************************************************/
8
/***************************************************************************
9
* *
10
* This program is free software; you can redistribute it and/or modify *
11
* it under the terms of the GNU General Public License as published by *
12
* the Free Software Foundation; either version 2 of the License, or *
13
* (at your option) any later version. *
14
* *
15
***************************************************************************/
16
#ifndef QGSABSTRACTLAYOUTITERATOR_H
17
#define QGSABSTRACTLAYOUTITERATOR_H
18
19
#include "qgis_core.h"
20
21
#include <QString>
22
23
class
QgsLayout
;
24
30
class
CORE_EXPORT
QgsAbstractLayoutIterator
31
{
32
public
:
33
virtual
~QgsAbstractLayoutIterator
() =
default
;
34
38
virtual
QgsLayout
*
layout
() = 0;
39
45
virtual
bool
beginRender
() = 0;
46
50
virtual
bool
endRender
() = 0;
51
55
virtual
int
count
()
const
= 0;
56
60
virtual
bool
next
() = 0;
61
66
virtual
QString
filePath
(
const
QString &baseFilePath,
const
QString &extension ) = 0;
67
};
68
69
#endif
//QGSABSTRACTLAYOUTITERATOR_H
QgsAbstractLayoutIterator
An abstract base class for QgsLayout based classes which can be exported by QgsLayoutExporter.
Definition
qgsabstractlayoutiterator.h:31
QgsAbstractLayoutIterator::endRender
virtual bool endRender()=0
Ends the render, performing any required cleanup tasks.
QgsAbstractLayoutIterator::layout
virtual QgsLayout * layout()=0
Returns the layout associated with the iterator.
QgsAbstractLayoutIterator::next
virtual bool next()=0
Iterates to next feature, returning false if no more features exist to iterate over.
QgsAbstractLayoutIterator::~QgsAbstractLayoutIterator
virtual ~QgsAbstractLayoutIterator()=default
QgsAbstractLayoutIterator::beginRender
virtual bool beginRender()=0
Called when rendering begins, before iteration commences.
QgsAbstractLayoutIterator::filePath
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.
QgsAbstractLayoutIterator::count
virtual int count() const =0
Returns the number of features to iterate over.
QgsLayout
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition
qgslayout.h:51
Generated on
for QGIS API Documentation by
1.17.0