Contains settings relating to exporting layouts to PDF. More...

#include <qgslayoutexporter.h>

Public Member Functions
	PdfExportSettings ()
	Constructor for PdfExportSettings. More...

Public Attributes
double	dpi = -1
	Resolution to export layout at. If dpi <= 0 the default layout dpi will be used. More...

bool	exportMetadata = true
	Indicates whether PDF export should include metadata generated from the layout's project's metadata. More...

QgsLayoutRenderContext::Flags	flags = nullptr
	Layout context flags, which control how the export will be created. More...

bool	forceVectorOutput = false
	Set to `true` to force vector object exports, even when the resultant appearance will differ from the layout. More...

bool	rasterizeWholeImage = false
	Set to `true` to force whole layout to be rasterized while exporting. More...

QgsRenderContext::TextRenderFormat	textRenderFormat = QgsRenderContext::TextFormatAlwaysOutlines
	Text rendering format, which controls how text should be rendered in the export (e.g. More...

Detailed Description

Contains settings relating to exporting layouts to PDF.

Definition at line 242 of file qgslayoutexporter.h.

Constructor & Destructor Documentation

◆ PdfExportSettings()

QgsLayoutExporter::PdfExportSettings::PdfExportSettings ( )

inline

Constructor for PdfExportSettings.

Definition at line 245 of file qgslayoutexporter.h.

Member Data Documentation

◆ dpi

double QgsLayoutExporter::PdfExportSettings::dpi = -1

Resolution to export layout at. If dpi <= 0 the default layout dpi will be used.

Definition at line 250 of file qgslayoutexporter.h.

◆ exportMetadata

bool QgsLayoutExporter::PdfExportSettings::exportMetadata = true

Indicates whether PDF export should include metadata generated from the layout's project's metadata.

Since: QGIS 3.2

Definition at line 274 of file qgslayoutexporter.h.

◆ flags

QgsLayoutRenderContext::Flags QgsLayoutExporter::PdfExportSettings::flags = nullptr

Layout context flags, which control how the export will be created.

Definition at line 279 of file qgslayoutexporter.h.

◆ forceVectorOutput

bool QgsLayoutExporter::PdfExportSettings::forceVectorOutput = false

Set to true to force vector object exports, even when the resultant appearance will differ from the layout.

If false, some items may be rasterized in order to maintain their correct appearance in the output.

This option is mutually exclusive with rasterizeWholeImage.

Definition at line 266 of file qgslayoutexporter.h.

◆ rasterizeWholeImage

bool QgsLayoutExporter::PdfExportSettings::rasterizeWholeImage = false

Set to true to force whole layout to be rasterized while exporting.

This option is mutually exclusive with forceVectorOutput.

Definition at line 257 of file qgslayoutexporter.h.

◆ textRenderFormat

QgsRenderContext::TextRenderFormat QgsLayoutExporter::PdfExportSettings::textRenderFormat = QgsRenderContext::TextFormatAlwaysOutlines

Text rendering format, which controls how text should be rendered in the export (e.g.

as paths or real text objects).

Since: QGIS 3.4.3

Definition at line 287 of file qgslayoutexporter.h.

The documentation for this struct was generated from the following file:

/tmp/buildd/qgis-3.8.0+99unstable/src/core/layout/qgslayoutexporter.h

Public Member Functions

Public Attributes