QgsLayoutGeoPdfExporter Class Reference

Handles GeoPDF export specific setup, cleanup and processing steps. More...

#include <qgslayoutgeopdfexporter.h>

Inheritance diagram for QgsLayoutGeoPdfExporter:

Public Member Functions
	QgsLayoutGeoPdfExporter (QgsLayout *layout)
	Constructor for QgsLayoutGeoPdfExporter, associated with the specified layout. More...
	~QgsLayoutGeoPdfExporter () override
QMap< QString, QString >	customLayerTreeGroups () const
	Returns any custom layer tree groups defined in the layer's settings. More...
QMap< QString, bool >	initialLayerVisibility () const
	Optional map of map layer ID to initial visibility state. More...
QStringList	layerOrder () const
	Optional list of map layer IDs in the order they should be shown in the generated GeoPDF layer tree. More...
Public Member Functions inherited from QgsAbstractGeoPdfExporter
	QgsAbstractGeoPdfExporter ()=default
	Constructor for QgsAbstractGeoPdfExporter. More...
virtual	~QgsAbstractGeoPdfExporter ()=default
QString	errorMessage () const
	Returns the last error message encountered during the export. More...
bool	finalize (const QList< QgsAbstractGeoPdfExporter::ComponentLayerDetail > &components, const QString &destinationFile, const ExportDetails &details)
	To be called after the rendering operation is complete. More...
QString	generateTemporaryFilepath (const QString &filename) const
	Returns a file path to use for temporary files required for GeoPDF creation. More...
void	pushRenderedFeature (const QString &layerId, const QgsAbstractGeoPdfExporter::RenderedFeature &feature, const QString &group=QString())
	Called multiple times during the rendering operation, whenever a feature associated with the specified layerId is rendered. More...

Friends
class	TestQgsLayoutGeoPdfExport

Additional Inherited Members
Static Public Member Functions inherited from QgsAbstractGeoPdfExporter
static bool	compositionModeSupported (QPainter::CompositionMode mode)
	Returns true if the specified composition mode is supported for layers during GeoPDF exports. More...
static QString	geoPDFAvailabilityExplanation ()
	Returns a user-friendly, translated string explaining why GeoPDF export support is not available on the current QGIS build (or an empty string if GeoPDF support IS available). More...
static bool	geoPDFCreationAvailable ()
	Returns true if the current QGIS build is capable of GeoPDF support. More...

Detailed Description

Handles GeoPDF export specific setup, cleanup and processing steps.

This class is a low level implementation detail only. Generally, you should use the high level interface exposed by QgsLayoutExporter instead.

Warning

QgsLayoutGeoPdfExporter is designed to be a short lived object. It should be created for a single layout export operation only, and then immediately destroyed. Failure to correctly destroy the object after exporting a layout will leave the layout in an inconsistent, unstable state.

Note

Not available in Python bindings

Since

QGIS 3.10

Definition at line 47 of file qgslayoutgeopdfexporter.h.

Constructor & Destructor Documentation

QgsLayoutGeoPdfExporter()

QgsLayoutGeoPdfExporter::QgsLayoutGeoPdfExporter

(

QgsLayout *

layout

)

Constructor for QgsLayoutGeoPdfExporter, associated with the specified layout.

Definition at line 111 of file qgslayoutgeopdfexporter.cpp.

~QgsLayoutGeoPdfExporter()

QgsLayoutGeoPdfExporter::~QgsLayoutGeoPdfExporter ( )

override

Definition at line 171 of file qgslayoutgeopdfexporter.cpp.

Member Function Documentation

customLayerTreeGroups()

QMap< QString, QString > QgsLayoutGeoPdfExporter::customLayerTreeGroups ( ) const

inline

Returns any custom layer tree groups defined in the layer's settings.

Definition at line 61 of file qgslayoutgeopdfexporter.h.

initialLayerVisibility()

QMap< QString, bool > QgsLayoutGeoPdfExporter::initialLayerVisibility ( ) const

inline

Optional map of map layer ID to initial visibility state.

If a layer ID is not present in this, it will default to being initially visible when opening the PDF.

Since

QGIS 3.14

Definition at line 69 of file qgslayoutgeopdfexporter.h.

layerOrder()

QStringList QgsLayoutGeoPdfExporter::layerOrder ( ) const

inline

Optional list of map layer IDs in the order they should be shown in the generated GeoPDF layer tree.

Layer IDs earlier in the list will appear higher in the GeoPDF layer tree.

Since

QGIS 3.14

Definition at line 77 of file qgslayoutgeopdfexporter.h.

Friends And Related Function Documentation

TestQgsLayoutGeoPdfExport

friend class TestQgsLayoutGeoPdfExport

friend

Definition at line 90 of file qgslayoutgeopdfexporter.h.

---

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

• /build/qgis-3.28.0+99sid/src/core/layout/qgslayoutgeopdfexporter.h
• /build/qgis-3.28.0+99sid/src/core/layout/qgslayoutgeopdfexporter.cpp