QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
qgslayoutgeopdfexporter.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutgeopdfexporter.h
3 --------------------------
4 begin : August 2019
5 copyright : (C) 2019 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 QGSLAYOUTGEOPDFEXPORTER_H
17#define QGSLAYOUTGEOPDFEXPORTER_H
18
19#include "qgis_core.h"
21#include "qgslayoutitemmap.h"
22#include <QList>
23#include <QTemporaryDir>
24
25#define SIP_NO_FILE
26
27class QgsLayout;
28class QgsGeospatialPdfRenderedFeatureHandler;
29
48{
49 public:
50
55
57
63 QMap< QString, QString > customLayerTreeGroups() const { return mCustomLayerTreeGroups; }
64
71 QMap< QString, bool > initialLayerVisibility() const { return mInitialLayerVisibility; }
72
80 QStringList layerOrder() const { return mLayerOrder; }
81
92 QStringList layerTreeGroupOrder() const { return mLayerTreeGroupOrder; }
93
94 private:
95
96 VectorComponentDetail componentDetailForLayerId( const QString &layerId ) override;
97
98 QgsLayout *mLayout = nullptr;
99 QHash< QgsLayoutItemMap *, QgsGeospatialPdfRenderedFeatureHandler * > mMapHandlers;
100
101 QMap< QString, bool > mInitialLayerVisibility;
102 QMap< QString, QString > mCustomLayerTreeGroups;
103 QStringList mLayerOrder;
104 QStringList mLayerTreeGroupOrder;
105
106 friend class TestQgsLayoutGeospatialPdfExport;
107};
108
109#endif //QGSLAYOUTGEOPDFEXPORTER_H
110
111
112
Abstract base class for Geospatial PDF exporters.
Handles geospatial PDF export specific setup, cleanup and processing steps.
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 laye...
QMap< QString, QString > customLayerTreeGroups() const
Returns any custom layer tree groups defined in the layer's settings.
QStringList layerTreeGroupOrder() const
Specifies the ordering of layer tree groups in the generated geospatial PDF file.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:49