QGIS API Documentation 3.41.0-Master (fda2aa46e9a)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsLayoutPdfExportOptionsDialog Class Reference

A dialog for customizing the properties of an exported PDF file from a layout. More...

#include <qgslayoutpdfexportoptionsdialog.h>

Inheritance diagram for QgsLayoutPdfExportOptionsDialog:
Inheritance graph
[legend]

Public Member Functions

 QgsLayoutPdfExportOptionsDialog (QWidget *parent=nullptr, bool allowGeospatialPdfExport=true, const QString &geospatialPdfReason=QString(), const QStringList &geospatialPdfLayerOrder=QStringList(), Qt::WindowFlags flags=Qt::WindowFlags())
 Constructor for QgsLayoutPdfExportOptionsDialog.
 
void enableGeoreferencingOptions (bool enabled)
 Sets whether to enable georeferencing options.
 
bool exportGeospatialPdf () const
 Returns whether Geospatial 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.
 
bool georeferencingEnabled () const
 Returns whether georeferencing is enabled.
 
QStringList geospatialPdfGroupOrder () const
 Returns a list of groups in the desired order they should appear in a generated Geospatial PDF file.
 
QStringList geospatialPdfLayerOrder () const
 Returns a list of map layer IDs in the desired order they should appear in a generated Geospatial PDF file.
 
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 setExportGeospatialPdf (bool enabled)
 Sets whether to export a Geospatial 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.
 

Detailed Description

A dialog for customizing the properties of an exported PDF file from a layout.

Note
This class is not a part of public API
Since
QGIS 3.12

Definition at line 39 of file qgslayoutpdfexportoptionsdialog.h.

Constructor & Destructor Documentation

◆ QgsLayoutPdfExportOptionsDialog()

QgsLayoutPdfExportOptionsDialog::QgsLayoutPdfExportOptionsDialog ( QWidget *  parent = nullptr,
bool  allowGeospatialPdfExport = true,
const QString &  geospatialPdfReason = QString(),
const QStringList &  geospatialPdfLayerOrder = QStringList(),
Qt::WindowFlags  flags = Qt::WindowFlags() 
)

Constructor for QgsLayoutPdfExportOptionsDialog.

Parameters
parentparent widget
allowGeospatialPdfExportset to false if geospatial PDF export is blocked
geospatialPdfReasonset to a descriptive translated string explaining why geospatial PDF export is not available if applicable
geospatialPdfLayerOrderoptional layer ID order list for layers in the geospatial PDF file. Any layers not present in this list will instead be appended to the end of the geospatial PDF layer list
flagswindow flags

Definition at line 33 of file qgslayoutpdfexportoptionsdialog.cpp.

Member Function Documentation

◆ enableGeoreferencingOptions()

void QgsLayoutPdfExportOptionsDialog::enableGeoreferencingOptions ( bool  enabled)

Sets whether to enable georeferencing options.

Definition at line 133 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ exportGeospatialPdf()

bool QgsLayoutPdfExportOptionsDialog::exportGeospatialPdf ( ) const

Returns whether Geospatial PDF export is enabled.

Definition at line 196 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ exportThemes()

QStringList QgsLayoutPdfExportOptionsDialog::exportThemes ( ) const

Returns the list of export themes.

Definition at line 237 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ forceVector()

bool QgsLayoutPdfExportOptionsDialog::forceVector ( ) const

Returns whether vector output is being forced.

Definition at line 128 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ geometriesSimplified()

bool QgsLayoutPdfExportOptionsDialog::geometriesSimplified ( ) const

Returns whether geometry simplification is enabled.

Definition at line 173 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ georeferencingEnabled()

bool QgsLayoutPdfExportOptionsDialog::georeferencingEnabled ( ) const

Returns whether georeferencing is enabled.

Definition at line 143 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ geospatialPdfGroupOrder()

QStringList QgsLayoutPdfExportOptionsDialog::geospatialPdfGroupOrder ( ) const

Returns a list of groups in the desired order they should appear in a generated Geospatial PDF file.

Definition at line 266 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ geospatialPdfLayerOrder()

QStringList QgsLayoutPdfExportOptionsDialog::geospatialPdfLayerOrder ( ) const

Returns a list of map layer IDs in the desired order they should appear in a generated Geospatial PDF file.

Definition at line 256 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ losslessImageExport()

bool QgsLayoutPdfExportOptionsDialog::losslessImageExport ( ) const

Returns whether lossless image compression is enabled.

Definition at line 183 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ metadataEnabled()

bool QgsLayoutPdfExportOptionsDialog::metadataEnabled ( ) const

Returns whether metadata is enabled.

Definition at line 153 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ openAfterExporting()

bool QgsLayoutPdfExportOptionsDialog::openAfterExporting ( ) const

Returns whether the pdf should be opened after exporting it.

Definition at line 286 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ rasterTilingDisabled()

bool QgsLayoutPdfExportOptionsDialog::rasterTilingDisabled ( ) const

Returns whether raster tiling is disabled.

Definition at line 163 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setExportGeospatialPdf()

void QgsLayoutPdfExportOptionsDialog::setExportGeospatialPdf ( bool  enabled)

Sets whether to export a Geospatial PDF.

Definition at line 188 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setExportThemes()

void QgsLayoutPdfExportOptionsDialog::setExportThemes ( const QStringList &  themes)

Sets the list of export themes.

Definition at line 224 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setForceVector()

void QgsLayoutPdfExportOptionsDialog::setForceVector ( bool  force)

Set whether to force vector output.

Definition at line 123 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setGeometriesSimplified()

void QgsLayoutPdfExportOptionsDialog::setGeometriesSimplified ( bool  enabled)

Sets whether to simplify geometries.

Definition at line 168 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setGeoreferencingEnabled()

void QgsLayoutPdfExportOptionsDialog::setGeoreferencingEnabled ( bool  enabled)

Sets whether to enable georeferencing.

Definition at line 138 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setLosslessImageExport()

void QgsLayoutPdfExportOptionsDialog::setLosslessImageExport ( bool  enabled)

Sets whether to use lossless image compression.

Definition at line 178 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setMetadataEnabled()

void QgsLayoutPdfExportOptionsDialog::setMetadataEnabled ( bool  enabled)

Sets whether to enable metadata.

Definition at line 148 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setOpenAfterExporting()

void QgsLayoutPdfExportOptionsDialog::setOpenAfterExporting ( bool  enabled)

Sets whether to open the pdf after exporting it.

Definition at line 281 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setRasterTilingDisabled()

void QgsLayoutPdfExportOptionsDialog::setRasterTilingDisabled ( bool  disabled)

Sets whether to disable raster tiling.

Definition at line 158 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setTextRenderFormat()

void QgsLayoutPdfExportOptionsDialog::setTextRenderFormat ( Qgis::TextRenderFormat  format)

Sets the text render format.

Definition at line 113 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setUseOgcBestPracticeFormat()

void QgsLayoutPdfExportOptionsDialog::setUseOgcBestPracticeFormat ( bool  enabled)

Sets whether to use OGC best-practice format.

Definition at line 204 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ textRenderFormat()

Qgis::TextRenderFormat QgsLayoutPdfExportOptionsDialog::textRenderFormat ( ) const

Returns the current text render format.

Definition at line 118 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ useOgcBestPracticeFormat()

bool QgsLayoutPdfExportOptionsDialog::useOgcBestPracticeFormat ( ) const

Returns whether use of OGC best-practice format is enabled.

Definition at line 215 of file qgslayoutpdfexportoptionsdialog.cpp.


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