1// Copyright (C) 2017 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Tobias König <tobias.koenig@kdab.com>
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
4#include "qpdfdocumentrenderoptions.h"
9 \class QPdfDocumentRenderOptions
13 \brief The QPdfDocumentRenderOptions class holds the options to render a page from a PDF document.
19 \enum QPdfDocumentRenderOptions::Rotation
21 This enum describes the rotation of the page for rendering.
23 \value None Do not rotate (the default)
24 \value Clockwise90 Rotate 90 degrees clockwise
25 \value Clockwise180 Rotate 180 degrees
26 \value Clockwise270 Rotate 270 degrees clockwise
28 \sa QPdfDocument::render()
31 \enum QPdfDocumentRenderOptions::RenderFlag
33 This enum is used to describe how a page should be rendered.
35 \value None The default value, representing no flags.
36 \value Annotations The page is rendered with annotations.
37 \value OptimizedForLcd The text of the page is rendered optimized for LCD display.
38 \value Grayscale The page is rendered grayscale.
39 \value ForceHalftone Always use halftones for rendering if the output image is stretched.
40 \value TextAliased Anti-aliasing is disabled for rendering text.
41 \value ImageAliased Anti-aliasing is disabled for rendering images.
42 \value PathAliased Anti-aliasing is disabled for rendering paths.
44 \sa QPdfDocument::render()
48 \fn QPdfDocumentRenderOptions::QPdfDocumentRenderOptions()
50 Constructs a QPdfDocumentRenderOptions object.
54 \fn QPdfDocumentRenderOptions::Rotation QPdfDocumentRenderOptions::rotation() const
56 Returns the rotation used for rendering a page from a PDF document.
62 \fn void QPdfDocumentRenderOptions::setRotation(QPdfDocumentRenderOptions::Rotation rotation)
64 Sets the \a rotation used for rendering a page from a PDF document.
70 \fn QPdfDocumentRenderOptions::RenderFlags QPdfDocumentRenderOptions::renderFlags() const
72 Returns the special flags used for rendering a page from a PDF document.
78 \fn void QPdfDocumentRenderOptions::setRenderFlags(QPdfDocumentRenderOptions::RenderFlags flags)
80 Sets the special \a flags used for rendering a page from a PDF document.
86 \fn QRect QPdfDocumentRenderOptions::scaledClipRect() const
88 Returns the rectangular region to be clipped from the page after having
89 been scaled to \l scaledSize().
91 \sa setScaledClipRect()
95 \fn void QPdfDocumentRenderOptions::setScaledClipRect(const QRect &r)
97 Sets the rectangle region (\a r) to be clipped from the page after having
98 been scaled to \l scaledSize().
104 \fn QRect QPdfDocumentRenderOptions::scaledSize() const
106 Returns the size of the page to be rendered, in pixels.
112 \fn void QPdfDocumentRenderOptions::setScaledSize(const QSize &s)
114 Sets the size (\a s) of the page to be rendered, in pixels.
120 \fn bool operator!=(QPdfDocumentRenderOptions lhs, QPdfDocumentRenderOptions rhs)
121 \relates QPdfDocumentRenderOptions
123 Returns \c true if the options \a lhs and \a rhs are different, otherwise
128 \fn bool operator==(QPdfDocumentRenderOptions lhs, QPdfDocumentRenderOptions rhs)
129 \relates QPdfDocumentRenderOptions
131 Returns \c true if the options \a lhs and \a rhs are equal,
132 otherwise returns \c false.