QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Handles geospatial PDF export specific setup, cleanup and processing steps. More...
#include <qgslayoutgeopdfexporter.h>
Public Member Functions | |
QgsLayoutGeospatialPdfExporter (QgsLayout *layout) | |
Constructor for QgsLayoutGeospatialPdfExporter, associated with the specified layout. | |
~QgsLayoutGeospatialPdfExporter () override | |
QMap< QString, QString > | customLayerTreeGroups () const |
Returns any custom layer tree groups defined in the layer's settings. | |
QMap< QString, bool > | initialLayerVisibility () const |
Optional map of map layer ID to initial visibility state. | |
QStringList | layerOrder () const |
Optional list of map layer IDs in the order they should be shown in the generated geospatial PDF layer tree. | |
QStringList | layerTreeGroupOrder () const |
Specifies the ordering of layer tree groups in the generated geospatial PDF file. | |
Public Member Functions inherited from QgsAbstractGeospatialPdfExporter | |
QgsAbstractGeospatialPdfExporter ()=default | |
virtual | ~QgsAbstractGeospatialPdfExporter ()=default |
QString | errorMessage () const |
Returns the last error message encountered during the export. | |
bool | finalize (const QList< QgsAbstractGeospatialPdfExporter::ComponentLayerDetail > &components, const QString &destinationFile, const ExportDetails &details) |
To be called after the rendering operation is complete. | |
QString | generateTemporaryFilepath (const QString &filename) const |
Returns a file path to use for temporary files required for Geospatial PDF creation. | |
void | pushRenderedFeature (const QString &layerId, const QgsAbstractGeospatialPdfExporter::RenderedFeature &feature, const QString &group=QString()) |
Called multiple times during the rendering operation, whenever a feature associated with the specified layerId is rendered. | |
Friends | |
class | TestQgsLayoutGeospatialPdfExport |
Additional Inherited Members | |
Static Public Member Functions inherited from QgsAbstractGeospatialPdfExporter | |
static bool | compositionModeSupported (QPainter::CompositionMode mode) |
Returns true if the specified composition mode is supported for layers during Geospatial PDF exports. | |
static QString | geospatialPDFAvailabilityExplanation () |
Returns a user-friendly, translated string explaining why Geospatial PDF export support is not available on the current QGIS build (or an empty string if Geospatial PDF support IS available). | |
static bool | geospatialPDFCreationAvailable () |
Returns true if the current QGIS build is capable of Geospatial PDF support. | |
Handles geospatial PDF 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.
Definition at line 47 of file qgslayoutgeopdfexporter.h.
QgsLayoutGeospatialPdfExporter::QgsLayoutGeospatialPdfExporter | ( | QgsLayout * | layout | ) |
Constructor for QgsLayoutGeospatialPdfExporter, associated with the specified layout.
Definition at line 108 of file qgslayoutgeopdfexporter.cpp.
|
override |
Definition at line 170 of file qgslayoutgeopdfexporter.cpp.
|
inline |
Returns any custom layer tree groups defined in the layer's settings.
Definition at line 63 of file qgslayoutgeopdfexporter.h.
|
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.
Definition at line 71 of file qgslayoutgeopdfexporter.h.
|
inline |
Optional list of map layer IDs in the order they should be shown in the generated geospatial PDF layer tree.
Layer IDs earlier in the list will appear higher in the geospatial PDF layer tree.
Definition at line 80 of file qgslayoutgeopdfexporter.h.
|
inline |
Specifies the ordering of layer tree groups in the generated geospatial PDF file.
Groups appearing earlier in the list will show earlier in the geospatial PDF layer tree list.
Definition at line 92 of file qgslayoutgeopdfexporter.h.
|
friend |
Definition at line 106 of file qgslayoutgeopdfexporter.h.