QPdfDocumentRenderOptions Class

The QPdfDocumentRenderOptions class holds the options to render a page from a PDF document. More...

Header:	#include <QPdfDocumentRenderOptions>
Since:	Qt 5.10

List of all members, including inherited members

Public Types

enum class	RenderFlag { None, Annotations, OptimizedForLcd, Grayscale, ForceHalftone, …, PathAliased }
flags	RenderFlags
enum class	Rotation { None, Clockwise90, Clockwise180, Clockwise270 }

Public Functions

	QPdfDocumentRenderOptions()
QPdfDocumentRenderOptions::RenderFlags	renderFlags() const
QPdfDocumentRenderOptions::Rotation	rotation() const
QRect	scaledClipRect() const
QSize	scaledSize() const
void	setRenderFlags(QPdfDocumentRenderOptions::RenderFlags flags)
void	setRotation(QPdfDocumentRenderOptions::Rotation rotation)
void	setScaledClipRect(const QRect &r)
void	setScaledSize(const QSize &s)

Detailed Description

See also QPdfDocument.

Member Type Documentation

enum class QPdfDocumentRenderOptions::RenderFlag
flags QPdfDocumentRenderOptions::RenderFlags

This enum is used to describe how a page should be rendered.

Constant	Value	Description
`QPdfDocumentRenderOptions::RenderFlag::None`	`0x000`	The default value, representing no flags.
`QPdfDocumentRenderOptions::RenderFlag::Annotations`	`0x001`	The page is rendered with annotations.
`QPdfDocumentRenderOptions::RenderFlag::OptimizedForLcd`	`0x002`	The text of the page is rendered optimized for LCD display.
`QPdfDocumentRenderOptions::RenderFlag::Grayscale`	`0x004`	The page is rendered grayscale.
`QPdfDocumentRenderOptions::RenderFlag::ForceHalftone`	`0x008`	Always use halftones for rendering if the output image is stretched.
`QPdfDocumentRenderOptions::RenderFlag::TextAliased`	`0x010`	Anti-aliasing is disabled for rendering text.
`QPdfDocumentRenderOptions::RenderFlag::ImageAliased`	`0x020`	Anti-aliasing is disabled for rendering images.
`QPdfDocumentRenderOptions::RenderFlag::PathAliased`	`0x040`	Anti-aliasing is disabled for rendering paths.

The RenderFlags type is a typedef for QFlags<RenderFlag>. It stores an OR combination of RenderFlag values.

See also QPdfDocument::render().

enum class QPdfDocumentRenderOptions::Rotation

This enum describes the rotation of the page for rendering.

Constant	Value	Description
`QPdfDocumentRenderOptions::Rotation::None`	`0`	Do not rotate (the default)
`QPdfDocumentRenderOptions::Rotation::Clockwise90`	`1`	Rotate 90 degrees clockwise
`QPdfDocumentRenderOptions::Rotation::Clockwise180`	`2`	Rotate 180 degrees
`QPdfDocumentRenderOptions::Rotation::Clockwise270`	`3`	Rotate 270 degrees clockwise

See also QPdfDocument::render().

Member Function Documentation

QPdfDocumentRenderOptions::QPdfDocumentRenderOptions()

Constructs a QPdfDocumentRenderOptions object.

QPdfDocumentRenderOptions::RenderFlags QPdfDocumentRenderOptions::renderFlags() const

Returns the special flags used for rendering a page from a PDF document.

See also setRenderFlags().

QPdfDocumentRenderOptions::Rotation QPdfDocumentRenderOptions::rotation() const

Returns the rotation used for rendering a page from a PDF document.

See also setRotation().

QRect QPdfDocumentRenderOptions::scaledClipRect() const

Returns the rectangular region to be clipped from the page after having been scaled to scaledSize().

See also setScaledClipRect().

QSize QPdfDocumentRenderOptions::scaledSize() const

Returns the size of the page to be rendered, in pixels.

See also setScaledSize().

void QPdfDocumentRenderOptions::setRenderFlags(QPdfDocumentRenderOptions::RenderFlags flags)

Sets the special flags used for rendering a page from a PDF document.

See also renderFlags().

void QPdfDocumentRenderOptions::setRotation(QPdfDocumentRenderOptions::Rotation rotation)

Sets the rotation used for rendering a page from a PDF document.

See also rotation().

void QPdfDocumentRenderOptions::setScaledClipRect(const QRect &r)

Sets the rectangle region (r) to be clipped from the page after having been scaled to scaledSize().

See also scaledClipRect().

void QPdfDocumentRenderOptions::setScaledSize(const QSize &s)

Sets the size (s) of the page to be rendered, in pixels.

See also scaledSize().

Contents