PySide6.QtPdf.QPdfDocumentRenderOptions¶

class QPdfDocumentRenderOptions¶

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

Synopsis¶

Methods¶

def __init__()
def __ne__()
def __eq__()
def renderFlags()
def rotation()
def scaledClipRect()
def scaledSize()
def setRenderFlags()
def setRotation()
def setScaledClipRect()
def setScaledSize()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

See also

QPdfDocument

class Rotation¶

This enum describes the rotation of the page for rendering.

Constant

Description

QPdfDocumentRenderOptions.Rotation.Rotation.None_

Do not rotate (the default)

QPdfDocumentRenderOptions.Rotation.Rotation.Clockwise90

Rotate 90 degrees clockwise

QPdfDocumentRenderOptions.Rotation.Rotation.Clockwise180

Rotate 180 degrees

QPdfDocumentRenderOptions.Rotation.Rotation.Clockwise270

Rotate 270 degrees clockwise

See also

render()

Constant	Description
QPdfDocumentRenderOptions.Rotation.Rotation.None_	Do not rotate (the default)
QPdfDocumentRenderOptions.Rotation.Rotation.Clockwise90	Rotate 90 degrees clockwise
QPdfDocumentRenderOptions.Rotation.Rotation.Clockwise180	Rotate 180 degrees
QPdfDocumentRenderOptions.Rotation.Rotation.Clockwise270	Rotate 270 degrees clockwise

Added in version 6.5.

class RenderFlag¶

(inherits enum.Flag) This enum is used to describe how a page should be rendered.

Constant

Description

QPdfDocumentRenderOptions.RenderFlag.RenderFlag.None_

The default value, representing no flags.

QPdfDocumentRenderOptions.RenderFlag.RenderFlag.Annotations

The page is rendered with annotations.

QPdfDocumentRenderOptions.RenderFlag.RenderFlag.OptimizedForLcd

The text of the page is rendered optimized for LCD display.

QPdfDocumentRenderOptions.RenderFlag.RenderFlag.Grayscale

The page is rendered grayscale.

QPdfDocumentRenderOptions.RenderFlag.RenderFlag.ForceHalftone

Always use halftones for rendering if the output image is stretched.

QPdfDocumentRenderOptions.RenderFlag.RenderFlag.TextAliased

Anti-aliasing is disabled for rendering text.

QPdfDocumentRenderOptions.RenderFlag.RenderFlag.ImageAliased

Anti-aliasing is disabled for rendering images.

QPdfDocumentRenderOptions.RenderFlag.RenderFlag.PathAliased

Anti-aliasing is disabled for rendering paths.

See also

render()

Constant	Description
QPdfDocumentRenderOptions.RenderFlag.RenderFlag.None_	The default value, representing no flags.
QPdfDocumentRenderOptions.RenderFlag.RenderFlag.Annotations	The page is rendered with annotations.
QPdfDocumentRenderOptions.RenderFlag.RenderFlag.OptimizedForLcd	The text of the page is rendered optimized for LCD display.
QPdfDocumentRenderOptions.RenderFlag.RenderFlag.Grayscale	The page is rendered grayscale.
QPdfDocumentRenderOptions.RenderFlag.RenderFlag.ForceHalftone	Always use halftones for rendering if the output image is stretched.
QPdfDocumentRenderOptions.RenderFlag.RenderFlag.TextAliased	Anti-aliasing is disabled for rendering text.
QPdfDocumentRenderOptions.RenderFlag.RenderFlag.ImageAliased	Anti-aliasing is disabled for rendering images.
QPdfDocumentRenderOptions.RenderFlag.RenderFlag.PathAliased	Anti-aliasing is disabled for rendering paths.

Added in version 6.5.

__init__()¶

Constructs a QPdfDocumentRenderOptions object.

__ne__(rhs)¶

Parameters:: rhs – QPdfDocumentRenderOptions
Return type:: bool

__eq__(rhs)¶

Parameters:: rhs – QPdfDocumentRenderOptions
Return type:: bool

renderFlags()¶

Return type:: Combination of RenderFlag

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

See also

setRenderFlags()

rotation()¶

Return type:: Rotation

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

See also

setRotation()

scaledClipRect()¶

Return type:: QRect

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

See also

setScaledClipRect()

scaledSize()¶

Return type:: QSize

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

See also

setScaledSize()

setRenderFlags(r)¶

Parameters:: r – Combination of RenderFlag

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

See also

renderFlags()

setRotation(r)¶

Parameters:: r – Rotation

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

See also

rotation()

setScaledClipRect(r)¶

Parameters:: r – QRect

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

See also

scaledClipRect()

setScaledSize(s)¶

Parameters:: s – QSize

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

See also

scaledSize()