QgsLayoutPdfExportOptionsDialog Class Reference

#include <qgslayoutpdfexportoptionsdialog.h>

Inheritance diagram for QgsLayoutPdfExportOptionsDialog:

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. More...
void	enableGeoreferencingOptions (bool enabled)
	Sets whether to enable georeferencing options. More...
bool	exportGeoPdf () const
	Returns whether Geo-PDF export is enabled. More...
QStringList	exportThemes () const
	Returns the list of export themes. More...
bool	forceVector () const
	Returns whether vector output is being forced. More...
bool	geometriesSimplified () const
	Returns whether geometry simplification is enabled. More...
QStringList	geoPdfLayerOrder () const
	Returns a list of map layer IDs in the desired order they should appear in a generated GeoPDF file. More...
bool	georeferencingEnabled () const
	Returns whether georeferencing is enabled. More...
bool	metadataEnabled () const
	Returns whether metadata is enabled. More...
bool	rasterTilingDisabled () const
	Returns whether raster tiling is disabled. More...
void	setExportGeoPdf (bool enabled)
	Sets whether to export a Geo-PDF. More...
void	setExportThemes (const QStringList &themes)
	Sets the list of export themes. More...
void	setForceVector (bool force)
	Set whether to force vector output. More...
void	setGeometriesSimplified (bool enabled)
	Sets whether to simplify geometries. More...
void	setGeoreferencingEnabled (bool enabled)
	Sets whether to enable georeferencing. More...
void	setMetadataEnabled (bool enabled)
	Sets whether to enable metadata. More...
void	setRasterTilingDisabled (bool disabled)
	Sets whether to disable raster tiling. More...
void	setTextRenderFormat (QgsRenderContext::TextRenderFormat format)
	Sets the text render format. More...
void	setUseOgcBestPracticeFormat (bool enabled)
	Sets whether to use OGC best-practice format. More...
QgsRenderContext::TextRenderFormat	textRenderFormat () const
	Returns the current text render format. More...
bool	useOgcBestPracticeFormat () const
	Returns whether use of OGC best-practice format is enabled. More...

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 40 of file qgslayoutpdfexportoptionsdialog.h.

Constructor & Destructor Documentation

QgsLayoutPdfExportOptionsDialog()

QgsLayoutPdfExportOptionsDialog::QgsLayoutPdfExportOptionsDialog	(	QWidget *	parent = nullptr,
		bool	allowGeoPdfExport = true,
		const QString &	geoPdfReason = QString(),
		const QStringList &	geoPdfLayerOrder = QStringList(),
		Qt::WindowFlags	flags = Qt::WindowFlags()
	)

Constructor for QgsLayoutPdfExportOptionsDialog.

Parameters

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.

Member Function Documentation

enableGeoreferencingOptions()

void QgsLayoutPdfExportOptionsDialog::enableGeoreferencingOptions

(

bool

enabled

)

Sets whether to enable georeferencing options.

Definition at line 128 of file qgslayoutpdfexportoptionsdialog.cpp.

exportGeoPdf()

bool QgsLayoutPdfExportOptionsDialog::exportGeoPdf

(

)

const

Returns whether Geo-PDF export is enabled.

Definition at line 181 of file qgslayoutpdfexportoptionsdialog.cpp.

exportThemes()

QStringList QgsLayoutPdfExportOptionsDialog::exportThemes

(

)

const

Returns the list of export themes.

Definition at line 222 of file qgslayoutpdfexportoptionsdialog.cpp.

forceVector()

bool QgsLayoutPdfExportOptionsDialog::forceVector

(

)

const

Returns whether vector output is being forced.

Definition at line 123 of file qgslayoutpdfexportoptionsdialog.cpp.

geometriesSimplified()

bool QgsLayoutPdfExportOptionsDialog::geometriesSimplified

(

)

const

Returns whether geometry simplification is enabled.

Definition at line 168 of file qgslayoutpdfexportoptionsdialog.cpp.

geoPdfLayerOrder()

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 241 of file qgslayoutpdfexportoptionsdialog.cpp.

georeferencingEnabled()

bool QgsLayoutPdfExportOptionsDialog::georeferencingEnabled

(

)

const

Returns whether georeferencing is enabled.

Definition at line 138 of file qgslayoutpdfexportoptionsdialog.cpp.

metadataEnabled()

bool QgsLayoutPdfExportOptionsDialog::metadataEnabled

(

)

const

Returns whether metadata is enabled.

Definition at line 148 of file qgslayoutpdfexportoptionsdialog.cpp.

rasterTilingDisabled()

bool QgsLayoutPdfExportOptionsDialog::rasterTilingDisabled

(

)

const

Returns whether raster tiling is disabled.

Definition at line 158 of file qgslayoutpdfexportoptionsdialog.cpp.

setExportGeoPdf()

void QgsLayoutPdfExportOptionsDialog::setExportGeoPdf

(

bool

enabled

)

Sets whether to export a Geo-PDF.

Definition at line 173 of file qgslayoutpdfexportoptionsdialog.cpp.

setExportThemes()

void QgsLayoutPdfExportOptionsDialog::setExportThemes

(

const QStringList &

themes

)

Sets the list of export themes.

Definition at line 209 of file qgslayoutpdfexportoptionsdialog.cpp.

setForceVector()

void QgsLayoutPdfExportOptionsDialog::setForceVector

(

bool

force

)

Set whether to force vector output.

Definition at line 118 of file qgslayoutpdfexportoptionsdialog.cpp.

setGeometriesSimplified()

void QgsLayoutPdfExportOptionsDialog::setGeometriesSimplified

(

bool

enabled

)

Sets whether to simplify geometries.

Definition at line 163 of file qgslayoutpdfexportoptionsdialog.cpp.

setGeoreferencingEnabled()

void QgsLayoutPdfExportOptionsDialog::setGeoreferencingEnabled

(

bool

enabled

)

Sets whether to enable georeferencing.

Definition at line 133 of file qgslayoutpdfexportoptionsdialog.cpp.

setMetadataEnabled()

void QgsLayoutPdfExportOptionsDialog::setMetadataEnabled

(

bool

enabled

)

Sets whether to enable metadata.

Definition at line 143 of file qgslayoutpdfexportoptionsdialog.cpp.

setRasterTilingDisabled()

void QgsLayoutPdfExportOptionsDialog::setRasterTilingDisabled

(

bool

disabled

)

Sets whether to disable raster tiling.

Definition at line 153 of file qgslayoutpdfexportoptionsdialog.cpp.

setTextRenderFormat()

void QgsLayoutPdfExportOptionsDialog::setTextRenderFormat

(

QgsRenderContext::TextRenderFormat

format

)

Sets the text render format.

Definition at line 108 of file qgslayoutpdfexportoptionsdialog.cpp.

setUseOgcBestPracticeFormat()

void QgsLayoutPdfExportOptionsDialog::setUseOgcBestPracticeFormat

(

bool

enabled

)

Sets whether to use OGC best-practice format.

Definition at line 189 of file qgslayoutpdfexportoptionsdialog.cpp.

textRenderFormat()

QgsRenderContext::TextRenderFormat QgsLayoutPdfExportOptionsDialog::textRenderFormat

(

)

const

Returns the current text render format.

Definition at line 113 of file qgslayoutpdfexportoptionsdialog.cpp.

useOgcBestPracticeFormat()

bool QgsLayoutPdfExportOptionsDialog::useOgcBestPracticeFormat

(

)

const

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

Definition at line 200 of file qgslayoutpdfexportoptionsdialog.cpp.

---

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

• /build/qgis-3.14.0+99unstable/src/gui/layout/qgslayoutpdfexportoptionsdialog.h
• /build/qgis-3.14.0+99unstable/src/gui/layout/qgslayoutpdfexportoptionsdialog.cpp