1/****************************************************************************
2**
3** Copyright (C) 2014 John Layt <jlayt@kde.org>
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 QPAGELAYOUT_H
41#define QPAGELAYOUT_H
42
43#include <QtGui/qtguiglobal.h>
44#include <QtCore/qsharedpointer.h>
45#include <QtCore/qstring.h>
46#include <QtCore/qmargins.h>
47
48#include <QtGui/qpagesize.h>
49
50QT_BEGIN_NAMESPACE
51
52class QPageLayoutPrivate;
53class QMarginsF;
54
55class Q_GUI_EXPORT QPageLayout
56{
57public:
58
59 // NOTE: Must keep in sync with QPageSize::Unit and QPrinter::Unit
60 enum Unit {
61 Millimeter,
62 Point,
63 Inch,
64 Pica,
65 Didot,
66 Cicero
67 };
68
69 enum Orientation {
70 Portrait,
71 Landscape
72 };
73
74 enum Mode {
75 StandardMode, // Paint Rect includes margins
76 FullPageMode // Paint Rect excludes margins
77 };
78
79 QPageLayout();
80 QPageLayout(const QPageSize &pageSize, Orientation orientation,
81 const QMarginsF &margins, Unit units = Point,
82 const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0));
83 QPageLayout(const QPageLayout &other);
84 QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QPageLayout)
85 QPageLayout &operator=(const QPageLayout &other);
86 ~QPageLayout();
87
88 void swap(QPageLayout &other) noexcept { qSwap(d, other.d); }
89
90 friend Q_GUI_EXPORT bool operator==(const QPageLayout &lhs, const QPageLayout &rhs);
91 bool isEquivalentTo(const QPageLayout &other) const;
92
93 bool isValid() const;
94
95 void setMode(Mode mode);
96 Mode mode() const;
97
98 void setPageSize(const QPageSize &pageSize,
99 const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0));
100 QPageSize pageSize() const;
101
102 void setOrientation(Orientation orientation);
103 Orientation orientation() const;
104
105 void setUnits(Unit units);
106 Unit units() const;
107
108 bool setMargins(const QMarginsF &margins);
109 bool setLeftMargin(qreal leftMargin);
110 bool setRightMargin(qreal rightMargin);
111 bool setTopMargin(qreal topMargin);
112 bool setBottomMargin(qreal bottomMargin);
113
114 QMarginsF margins() const;
115 QMarginsF margins(Unit units) const;
116 QMargins marginsPoints() const;
117 QMargins marginsPixels(int resolution) const;
118
119 void setMinimumMargins(const QMarginsF &minMargins);
120 QMarginsF minimumMargins() const;
121 QMarginsF maximumMargins() const;
122
123 QRectF fullRect() const;
124 QRectF fullRect(Unit units) const;
125 QRect fullRectPoints() const;
126 QRect fullRectPixels(int resolution) const;
127
128 QRectF paintRect() const;
129 QRectF paintRect(Unit units) const;
130 QRect paintRectPoints() const;
131 QRect paintRectPixels(int resolution) const;
132
133private:
134 friend class QPageLayoutPrivate;
135 QExplicitlySharedDataPointer<QPageLayoutPrivate> d;
136};
137
138Q_DECLARE_SHARED(QPageLayout)
139
140Q_GUI_EXPORT bool operator==(const QPageLayout &lhs, const QPageLayout &rhs);
141inline bool operator!=(const QPageLayout &lhs, const QPageLayout &rhs)
142{ return !operator==(lhs, rhs); }
143
144#ifndef QT_NO_DEBUG_STREAM
145Q_GUI_EXPORT QDebug operator<<(QDebug dbg, const QPageLayout &pageLayout);
146#endif
147
148QT_END_NAMESPACE
149
150Q_DECLARE_METATYPE(QPageLayout)
151Q_DECLARE_METATYPE(QPageLayout::Unit)
152Q_DECLARE_METATYPE(QPageLayout::Orientation)
153
154#endif // QPAGELAYOUT_H
155