1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QPDFWRITER_H
41#define QPDFWRITER_H
42
43#include <QtGui/qtguiglobal.h>
44
45#ifndef QT_NO_PDF
46
47#include <QtCore/qobject.h>
48#include <QtGui/qpagedpaintdevice.h>
49#include <QtGui/qpagelayout.h>
50
51QT_BEGIN_NAMESPACE
52
53class QIODevice;
54class QPdfWriterPrivate;
55
56class Q_GUI_EXPORT QPdfWriter : public QObject, public QPagedPaintDevice
57{
58 Q_OBJECT
59public:
60 explicit QPdfWriter(const QString &filename);
61 explicit QPdfWriter(QIODevice *device);
62 ~QPdfWriter();
63
64 void setPdfVersion(PdfVersion version);
65 PdfVersion pdfVersion() const;
66
67 QString title() const;
68 void setTitle(const QString &title);
69
70 QString creator() const;
71 void setCreator(const QString &creator);
72
73 bool newPage() override;
74
75 void setResolution(int resolution);
76 int resolution() const;
77
78 void setDocumentXmpMetadata(const QByteArray &xmpMetadata);
79 QByteArray documentXmpMetadata() const;
80
81 void addFileAttachment(const QString &fileName, const QByteArray &data, const QString &mimeType = QString());
82
83#ifdef Q_QDOC
84 bool setPageLayout(const QPageLayout &pageLayout);
85 bool setPageSize(const QPageSize &pageSize);
86 bool setPageOrientation(QPageLayout::Orientation orientation);
87 bool setPageMargins(const QMarginsF &margins);
88 bool setPageMargins(const QMarginsF &margins, QPageLayout::Unit units);
89 QPageLayout pageLayout() const;
90#else
91 using QPagedPaintDevice::setPageSize;
92#endif
93
94#if QT_DEPRECATED_SINCE(5, 14)
95 QT_DEPRECATED_X("Use setPageSize(QPageSize(id)) instead")
96 void setPageSize(PageSize size) override;
97 QT_DEPRECATED_X("Use setPageSize(QPageSize(size, QPageSize::Millimeter)) instead")
98 void setPageSizeMM(const QSizeF &size) override;
99 QT_DEPRECATED_X("Use setPageMargins(QMarginsF(l, t, r, b), QPageLayout::Millimeter) instead")
100 void setMargins(const Margins &m) override;
101#endif
102
103protected:
104 QPaintEngine *paintEngine() const override;
105 int metric(PaintDeviceMetric id) const override;
106
107private:
108 Q_DISABLE_COPY(QPdfWriter)
109 Q_DECLARE_PRIVATE(QPdfWriter)
110};
111
112QT_END_NAMESPACE
113
114#endif // QT_NO_PDF
115
116#endif
117

source code of qtbase/src/gui/painting/qpdfwriter.h