QGIS API Documentation  3.12.1-BucureČ™ti (121cc00ff0)
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, Qt::WindowFlags flags=nullptr)
 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...
 
bool exportGeoPdfFeatures () const
 Returns whether export of Geo-PDF features 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...
 
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 setExportGeoPdfFeatures (bool enabled)
 Sets whether to export Geo-PDF features. 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 37 of file qgslayoutpdfexportoptionsdialog.h.

Constructor & Destructor Documentation

◆ QgsLayoutPdfExportOptionsDialog()

QgsLayoutPdfExportOptionsDialog::QgsLayoutPdfExportOptionsDialog ( QWidget *  parent = nullptr,
Qt::WindowFlags  flags = nullptr 
)

Constructor for QgsLayoutPdfExportOptionsDialog.

Parameters
parentparent widget
flagswindow flags

Definition at line 30 of file qgslayoutpdfexportoptionsdialog.cpp.

Member Function Documentation

◆ enableGeoreferencingOptions()

void QgsLayoutPdfExportOptionsDialog::enableGeoreferencingOptions ( bool  enabled)

Sets whether to enable georeferencing options.

Definition at line 97 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ exportGeoPdf()

bool QgsLayoutPdfExportOptionsDialog::exportGeoPdf ( ) const

Returns whether Geo-PDF export is enabled.

Definition at line 150 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ exportGeoPdfFeatures()

bool QgsLayoutPdfExportOptionsDialog::exportGeoPdfFeatures ( ) const

Returns whether export of Geo-PDF features is enabled.

Definition at line 185 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ exportThemes()

QStringList QgsLayoutPdfExportOptionsDialog::exportThemes ( ) const

Returns the list of export themes.

Definition at line 206 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ forceVector()

bool QgsLayoutPdfExportOptionsDialog::forceVector ( ) const

Returns whether vector output is being forced.

Definition at line 92 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ geometriesSimplified()

bool QgsLayoutPdfExportOptionsDialog::geometriesSimplified ( ) const

Returns whether geometry simplification is enabled.

Definition at line 137 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ georeferencingEnabled()

bool QgsLayoutPdfExportOptionsDialog::georeferencingEnabled ( ) const

Returns whether georeferencing is enabled.

Definition at line 107 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ metadataEnabled()

bool QgsLayoutPdfExportOptionsDialog::metadataEnabled ( ) const

Returns whether metadata is enabled.

Definition at line 117 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ rasterTilingDisabled()

bool QgsLayoutPdfExportOptionsDialog::rasterTilingDisabled ( ) const

Returns whether raster tiling is disabled.

Definition at line 127 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setExportGeoPdf()

void QgsLayoutPdfExportOptionsDialog::setExportGeoPdf ( bool  enabled)

Sets whether to export a Geo-PDF.

Definition at line 142 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setExportGeoPdfFeatures()

void QgsLayoutPdfExportOptionsDialog::setExportGeoPdfFeatures ( bool  enabled)

Sets whether to export Geo-PDF features.

Definition at line 177 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setExportThemes()

void QgsLayoutPdfExportOptionsDialog::setExportThemes ( const QStringList &  themes)

Sets the list of export themes.

Definition at line 193 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setForceVector()

void QgsLayoutPdfExportOptionsDialog::setForceVector ( bool  force)

Set whether to force vector output.

Definition at line 87 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setGeometriesSimplified()

void QgsLayoutPdfExportOptionsDialog::setGeometriesSimplified ( bool  enabled)

Sets whether to simplify geometries.

Definition at line 132 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setGeoreferencingEnabled()

void QgsLayoutPdfExportOptionsDialog::setGeoreferencingEnabled ( bool  enabled)

Sets whether to enable georeferencing.

Definition at line 102 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setMetadataEnabled()

void QgsLayoutPdfExportOptionsDialog::setMetadataEnabled ( bool  enabled)

Sets whether to enable metadata.

Definition at line 112 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setRasterTilingDisabled()

void QgsLayoutPdfExportOptionsDialog::setRasterTilingDisabled ( bool  disabled)

Sets whether to disable raster tiling.

Definition at line 122 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setTextRenderFormat()

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

Sets the text render format.

Definition at line 77 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ setUseOgcBestPracticeFormat()

void QgsLayoutPdfExportOptionsDialog::setUseOgcBestPracticeFormat ( bool  enabled)

Sets whether to use OGC best-practice format.

Definition at line 158 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ textRenderFormat()

QgsRenderContext::TextRenderFormat QgsLayoutPdfExportOptionsDialog::textRenderFormat ( ) const

Returns the current text render format.

Definition at line 82 of file qgslayoutpdfexportoptionsdialog.cpp.

◆ useOgcBestPracticeFormat()

bool QgsLayoutPdfExportOptionsDialog::useOgcBestPracticeFormat ( ) const

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

Definition at line 169 of file qgslayoutpdfexportoptionsdialog.cpp.


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