QPageLayout - Add new QPageLayout class

New QPageLayout to encapsulate page layout details including page size,
orientation and margins.  Scale may be added later.

Subsequent changes will use this class in the paged paint devices,
paint engines, print engines, and print plugins to replace multiple
inconsistent local implementations.

[ChangeLog][QtGui] Added class QPageLayout to support handling page
layouts including the page size, orientation and margins.

Change-Id: Ife1ddd6c2a8d1516542be2eb37425111f41cd5c7
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Reviewed-by: Andy Shaw <andy.shaw@digia.com>

1 files changed, 155 insertions, 0 deletions

diff --git a/src/gui/painting/qpagelayout.h b/src/gui/painting/qpagelayout.h
new file mode 100644
index 0000000000..86e430e311
--- /dev/null
+++ b/src/gui/painting/qpagelayout.h
@@ -0,0 +1,155 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 John Layt <jlayt@kde.org>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtGui module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QPAGELAYOUT_H
+#define QPAGELAYOUT_H
+
+#include <QtCore/qsharedpointer.h>
+#include <QtCore/qstring.h>
+#include <QtCore/qmargins.h>
+
+#include <QtGui/qpagesize.h>
+
+QT_BEGIN_NAMESPACE
+
+class QPageLayoutPrivate;
+class QMarginsF;
+
+class Q_GUI_EXPORT QPageLayout
+{
+public:
+
+    // NOTE: Must keep in sync with QPageSize::Unit and QPrinter::Unit
+    enum Unit {
+        Millimeter,
+        Point,
+        Inch,
+        Pica,
+        Didot,
+        Cicero
+    };
+
+    // NOTE: Must keep in sync with QPrinter::Orientation
+    enum Orientation {
+        Portrait,
+        Landscape
+    };
+
+    enum Mode {
+        StandardMode,  // Paint Rect includes margins
+        FullPageMode   // Paint Rect excludes margins
+    };
+
+    QPageLayout();
+    QPageLayout(const QPageSize &pageSize, QPageLayout::Orientation orientation,
+                const QMarginsF &margins, QPageLayout::Unit units = QPageLayout::Point,
+                const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0));
+    QPageLayout(const QPageLayout &other);
+    ~QPageLayout();
+
+    QPageLayout &operator=(const QPageLayout &other);
+ #ifdef Q_COMPILER_RVALUE_REFS
+    QPageLayout &operator=(QPageLayout &&other) { swap(other); return *this; }
+#endif
+
+    void swap(QPageLayout &other) { d.swap(other.d); }
+
+    bool operator==(const QPageLayout &other) const;
+    bool isEquivalentTo(const QPageLayout &other) const;
+
+    bool isValid() const;
+
+    void setMode(QPageLayout::Mode mode);
+    QPageLayout::Mode mode() const;
+
+    void setPageSize(const QPageSize &pageSize,
+                     const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0));
+    QPageSize pageSize() const;
+
+    void setOrientation(QPageLayout::Orientation orientation);
+    QPageLayout::Orientation orientation() const;
+
+    void setUnits(QPageLayout::Unit units);
+    QPageLayout::Unit units() const;
+
+    bool setMargins(const QMarginsF &margins);
+    bool setLeftMargin(qreal leftMargin);
+    bool setRightMargin(qreal rightMargin);
+    bool setTopMargin(qreal topMargin);
+    bool setBottomMargin(qreal bottomMargin);
+
+    QMarginsF margins() const;
+    QMarginsF margins(QPageLayout::Unit units) const;
+    QMargins marginsPoints() const;
+    QMargins marginsPixels(int resolution) const;
+
+    void setMinimumMargins(const QMarginsF &minMargins);
+    QMarginsF minimumMargins() const;
+    QMarginsF maximumMargins() const;
+
+    QRectF fullRect() const;
+    QRectF fullRect(QPageLayout::Unit units) const;
+    QRect fullRectPoints() const;
+    QRect fullRectPixels(int resolution) const;
+
+    QRectF paintRect() const;
+    QRectF paintRect(QPageLayout::Unit units) const;
+    QRect paintRectPoints() const;
+    QRect paintRectPixels(int resolution) const;
+
+private:
+    friend class QPageLayoutPrivate;
+    QSharedDataPointer<QPageLayoutPrivate> d;
+};
+
+Q_DECLARE_SHARED(QPageLayout)
+
+#ifndef QT_NO_DEBUG_STREAM
+Q_GUI_EXPORT QDebug operator<<(QDebug dbg, const QPageLayout &pageLayout);
+#endif
+
+QT_END_NAMESPACE
+
+Q_DECLARE_METATYPE(QPageLayout)
+Q_DECLARE_METATYPE(QPageLayout::Unit)
+Q_DECLARE_METATYPE(QPageLayout::Orientation)
+
+#endif // QPAGELAYOUT_H