QGIS API Documentation 3.39.0-Master (9ea1ddbe645)
|
A dialog for customizing the properties of an exported PDF file from a layout. More...
#include <qgslayoutpdfexportoptionsdialog.h>
Public Member Functions | |
QgsLayoutPdfExportOptionsDialog (QWidget *parent=nullptr, bool allowGeoPdfExport=true, const QString &geoPdfReason=QString(), const QStringList &geoPdfLayerOrder=QStringList(), Qt::WindowFlags flags=Qt::WindowFlags()) | |
Constructor for QgsLayoutPdfExportOptionsDialog. | |
void | enableGeoreferencingOptions (bool enabled) |
Sets whether to enable georeferencing options. | |
bool | exportGeoPdf () const |
Returns whether Geo-PDF export is enabled. | |
QStringList | exportThemes () const |
Returns the list of export themes. | |
bool | forceVector () const |
Returns whether vector output is being forced. | |
bool | geometriesSimplified () const |
Returns whether geometry simplification is enabled. | |
QStringList | geoPdfGroupOrder () const |
Returns a list of groups in the desired order they should appear in a generated GeoPDF file. | |
QStringList | geoPdfLayerOrder () const |
Returns a list of map layer IDs in the desired order they should appear in a generated GeoPDF file. | |
bool | georeferencingEnabled () const |
Returns whether georeferencing is enabled. | |
bool | losslessImageExport () const |
Returns whether lossless image compression is enabled. | |
bool | metadataEnabled () const |
Returns whether metadata is enabled. | |
bool | openAfterExporting () const |
Returns whether the pdf should be opened after exporting it. | |
bool | rasterTilingDisabled () const |
Returns whether raster tiling is disabled. | |
void | setExportGeoPdf (bool enabled) |
Sets whether to export a Geo-PDF. | |
void | setExportThemes (const QStringList &themes) |
Sets the list of export themes. | |
void | setForceVector (bool force) |
Set whether to force vector output. | |
void | setGeometriesSimplified (bool enabled) |
Sets whether to simplify geometries. | |
void | setGeoreferencingEnabled (bool enabled) |
Sets whether to enable georeferencing. | |
void | setLosslessImageExport (bool enabled) |
Sets whether to use lossless image compression. | |
void | setMetadataEnabled (bool enabled) |
Sets whether to enable metadata. | |
void | setOpenAfterExporting (bool enabled) |
Sets whether to open the pdf after exporting it. | |
void | setRasterTilingDisabled (bool disabled) |
Sets whether to disable raster tiling. | |
void | setTextRenderFormat (Qgis::TextRenderFormat format) |
Sets the text render format. | |
void | setUseOgcBestPracticeFormat (bool enabled) |
Sets whether to use OGC best-practice format. | |
Qgis::TextRenderFormat | textRenderFormat () const |
Returns the current text render format. | |
bool | useOgcBestPracticeFormat () const |
Returns whether use of OGC best-practice format is enabled. | |
A dialog for customizing the properties of an exported PDF file from a layout.
Definition at line 39 of file qgslayoutpdfexportoptionsdialog.h.
QgsLayoutPdfExportOptionsDialog::QgsLayoutPdfExportOptionsDialog | ( | QWidget * | parent = nullptr , |
bool | allowGeoPdfExport = true , |
||
const QString & | geoPdfReason = QString() , |
||
const QStringList & | geoPdfLayerOrder = QStringList() , |
||
Qt::WindowFlags | flags = Qt::WindowFlags() |
||
) |
Constructor for QgsLayoutPdfExportOptionsDialog.
parent | parent widget |
allowGeoPdfExport | set to false if geoPdf export is blocked |
geoPdfReason | set to a descriptive translated string explaining why geopdf export is not available if applicable |
geoPdfLayerOrder | optional layer ID order list for layers in the geopdf file. Any layers not present in this list will instead be appended to the end of the geopdf layer list |
flags | window flags |
Definition at line 32 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::enableGeoreferencingOptions | ( | bool | enabled | ) |
Sets whether to enable georeferencing options.
Definition at line 131 of file qgslayoutpdfexportoptionsdialog.cpp.
bool QgsLayoutPdfExportOptionsDialog::exportGeoPdf | ( | ) | const |
Returns whether Geo-PDF export is enabled.
Definition at line 194 of file qgslayoutpdfexportoptionsdialog.cpp.
QStringList QgsLayoutPdfExportOptionsDialog::exportThemes | ( | ) | const |
Returns the list of export themes.
Definition at line 235 of file qgslayoutpdfexportoptionsdialog.cpp.
bool QgsLayoutPdfExportOptionsDialog::forceVector | ( | ) | const |
Returns whether vector output is being forced.
Definition at line 126 of file qgslayoutpdfexportoptionsdialog.cpp.
bool QgsLayoutPdfExportOptionsDialog::geometriesSimplified | ( | ) | const |
Returns whether geometry simplification is enabled.
Definition at line 171 of file qgslayoutpdfexportoptionsdialog.cpp.
QStringList QgsLayoutPdfExportOptionsDialog::geoPdfGroupOrder | ( | ) | const |
Returns a list of groups in the desired order they should appear in a generated GeoPDF file.
Definition at line 264 of file qgslayoutpdfexportoptionsdialog.cpp.
QStringList QgsLayoutPdfExportOptionsDialog::geoPdfLayerOrder | ( | ) | const |
Returns a list of map layer IDs in the desired order they should appear in a generated GeoPDF file.
Definition at line 254 of file qgslayoutpdfexportoptionsdialog.cpp.
bool QgsLayoutPdfExportOptionsDialog::georeferencingEnabled | ( | ) | const |
Returns whether georeferencing is enabled.
Definition at line 141 of file qgslayoutpdfexportoptionsdialog.cpp.
bool QgsLayoutPdfExportOptionsDialog::losslessImageExport | ( | ) | const |
Returns whether lossless image compression is enabled.
Definition at line 181 of file qgslayoutpdfexportoptionsdialog.cpp.
bool QgsLayoutPdfExportOptionsDialog::metadataEnabled | ( | ) | const |
Returns whether metadata is enabled.
Definition at line 151 of file qgslayoutpdfexportoptionsdialog.cpp.
bool QgsLayoutPdfExportOptionsDialog::openAfterExporting | ( | ) | const |
Returns whether the pdf should be opened after exporting it.
Definition at line 284 of file qgslayoutpdfexportoptionsdialog.cpp.
bool QgsLayoutPdfExportOptionsDialog::rasterTilingDisabled | ( | ) | const |
Returns whether raster tiling is disabled.
Definition at line 161 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setExportGeoPdf | ( | bool | enabled | ) |
Sets whether to export a Geo-PDF.
Definition at line 186 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setExportThemes | ( | const QStringList & | themes | ) |
Sets the list of export themes.
Definition at line 222 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setForceVector | ( | bool | force | ) |
Set whether to force vector output.
Definition at line 121 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setGeometriesSimplified | ( | bool | enabled | ) |
Sets whether to simplify geometries.
Definition at line 166 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setGeoreferencingEnabled | ( | bool | enabled | ) |
Sets whether to enable georeferencing.
Definition at line 136 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setLosslessImageExport | ( | bool | enabled | ) |
Sets whether to use lossless image compression.
Definition at line 176 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setMetadataEnabled | ( | bool | enabled | ) |
Sets whether to enable metadata.
Definition at line 146 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setOpenAfterExporting | ( | bool | enabled | ) |
Sets whether to open the pdf after exporting it.
Definition at line 279 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setRasterTilingDisabled | ( | bool | disabled | ) |
Sets whether to disable raster tiling.
Definition at line 156 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setTextRenderFormat | ( | Qgis::TextRenderFormat | format | ) |
Sets the text render format.
Definition at line 111 of file qgslayoutpdfexportoptionsdialog.cpp.
void QgsLayoutPdfExportOptionsDialog::setUseOgcBestPracticeFormat | ( | bool | enabled | ) |
Sets whether to use OGC best-practice format.
Definition at line 202 of file qgslayoutpdfexportoptionsdialog.cpp.
Qgis::TextRenderFormat QgsLayoutPdfExportOptionsDialog::textRenderFormat | ( | ) | const |
Returns the current text render format.
Definition at line 116 of file qgslayoutpdfexportoptionsdialog.cpp.
bool QgsLayoutPdfExportOptionsDialog::useOgcBestPracticeFormat | ( | ) | const |
Returns whether use of OGC best-practice format is enabled.
Definition at line 213 of file qgslayoutpdfexportoptionsdialog.cpp.