Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
qpdfdocumentrenderoptions.qdoc
Go to the documentation of this file.
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
3
4#include "qpdfdocumentrenderoptions.h"
5
6QT_BEGIN_NAMESPACE
7
8/*!
9 \class QPdfDocumentRenderOptions
10 \since 5.10
11 \inmodule QtPdf
12
13 \brief The QPdfDocumentRenderOptions class holds the options to render a page from a PDF document.
14
15 \sa QPdfDocument
16*/
17
18/*!
19 \enum QPdfDocumentRenderOptions::Rotation
20
21 This enum describes the rotation of the page for rendering.
22
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
27
28 \sa QPdfDocument::render()
29*/
30/*!
31 \enum QPdfDocumentRenderOptions::RenderFlag
32
33 This enum is used to describe how a page should be rendered.
34
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.
43
44 \sa QPdfDocument::render()
45*/
46
47/*!
48 \fn QPdfDocumentRenderOptions::QPdfDocumentRenderOptions()
49
50 Constructs a QPdfDocumentRenderOptions object.
51*/
52
53/*!
54 \fn QPdfDocumentRenderOptions::Rotation QPdfDocumentRenderOptions::rotation() const
55
56 Returns the rotation used for rendering a page from a PDF document.
57
58 \sa setRotation()
59*/
60
61/*!
62 \fn void QPdfDocumentRenderOptions::setRotation(QPdfDocumentRenderOptions::Rotation rotation)
63
64 Sets the \a rotation used for rendering a page from a PDF document.
65
66 \sa rotation()
67*/
68
69/*!
70 \fn QPdfDocumentRenderOptions::RenderFlags QPdfDocumentRenderOptions::renderFlags() const
71
72 Returns the special flags used for rendering a page from a PDF document.
73
74 \sa setRenderFlags()
75*/
76
77/*!
78 \fn void QPdfDocumentRenderOptions::setRenderFlags(QPdfDocumentRenderOptions::RenderFlags flags)
79
80 Sets the special \a flags used for rendering a page from a PDF document.
81
82 \sa renderFlags()
83*/
84
85/*!
86 \fn QRect QPdfDocumentRenderOptions::scaledClipRect() const
87
88 Returns the rectangular region to be clipped from the page after having
89 been scaled to \l scaledSize().
90
91 \sa setScaledClipRect()
92*/
93
94/*!
95 \fn void QPdfDocumentRenderOptions::setScaledClipRect(const QRect &r)
96
97 Sets the rectangle region (\a r) to be clipped from the page after having
98 been scaled to \l scaledSize().
99
100 \sa scaledClipRect()
101*/
102
103/*!
104 \fn QRect QPdfDocumentRenderOptions::scaledSize() const
105
106 Returns the size of the page to be rendered, in pixels.
107
108 \sa setScaledSize()
109*/
110
111/*!
112 \fn void QPdfDocumentRenderOptions::setScaledSize(const QSize &s)
113
114 Sets the size (\a s) of the page to be rendered, in pixels.
115
116 \sa scaledSize()
117*/
118
119/*!
120 \fn bool operator!=(QPdfDocumentRenderOptions lhs, QPdfDocumentRenderOptions rhs)
121 \relates QPdfDocumentRenderOptions
122
123 Returns \c true if the options \a lhs and \a rhs are different, otherwise
124 returns \c false.
125*/
126
127/*!
128 \fn bool operator==(QPdfDocumentRenderOptions lhs, QPdfDocumentRenderOptions rhs)
129 \relates QPdfDocumentRenderOptions
130
131 Returns \c true if the options \a lhs and \a rhs are equal,
132 otherwise returns \c false.
133*/
134
135QT_END_NAMESPACE