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

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...

Public Member Functions inherited from QgsAbstractGeoPdfExporter
	QgsAbstractGeoPdfExporter ()=default
	Constructor for QgsAbstractGeoPdfExporter. More...

virtual	~QgsAbstractGeoPdfExporter ()=default

QString	errorMessage ()
	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 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.

Definition at line 47 of file qgslayoutgeopdfexporter.h.

Constructor & Destructor Documentation

QgsLayoutGeoPdfExporter::QgsLayoutGeoPdfExporter ( QgsLayout * layout )

Constructor for QgsLayoutGeoPdfExporter, associated with the specified layout.

QgsLayoutGeoPdfExporter::~QgsLayoutGeoPdfExporter ( )

override

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.

friend class TestQgsLayoutGeoPdfExport

friend

Definition at line 72 of file qgslayoutgeopdfexporter.h.

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