// Copyright (C) 2014 John Layt <jlayt@kde.org>

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

// Qt-Security score:significant reason:default

#ifndef QPAGELAYOUT_H

#define QPAGELAYOUT_H

#include <QtGui/qtguiglobal.h>

#include <QtCore/qshareddata.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

    };

    enum Orientation {

        Portrait,

        Landscape

    };

    enum Mode {

        StandardMode,  // Paint Rect includes margins

        FullPageMode   // Paint Rect excludes margins

    };

    enum class OutOfBoundsPolicy {

        Reject,

        Clamp,

    };

    QPageLayout();

    QPageLayout(const QPageSize &pageSize, Orientation orientation,

                const QMarginsF &margins, Unit units = Point,

                const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0));

    QPageLayout(const QPageLayout &other);

    QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QPageLayout)

    QPageLayout &operator=(const QPageLayout &other);

    ~QPageLayout();

    void swap(QPageLayout &other) noexcept { d.swap(other.d); }

    bool isEquivalentTo(const QPageLayout &other) const;

    bool isValid() const;

    void setMode(Mode mode);

    Mode mode() const;

    void setPageSize(const QPageSize &pageSize,

                     const QMarginsF &minMargins = QMarginsF(0, 0, 0, 0));

    QPageSize pageSize() const;

    void setOrientation(Orientation orientation);

    Orientation orientation() const;

    void setUnits(Unit units);

    Unit units() const;

#if QT_GUI_REMOVED_SINCE(6, 8)

    bool setMargins(const QMarginsF &margins);

    bool setLeftMargin(qreal leftMargin);

    bool setRightMargin(qreal rightMargin);

    bool setTopMargin(qreal topMargin);

    bool setBottomMargin(qreal bottomMargin);

#endif

    bool setMargins(const QMarginsF &margins, OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject);

    bool setLeftMargin(qreal leftMargin, OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject);

    bool setRightMargin(qreal rightMargin, OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject);

    bool setTopMargin(qreal topMargin, OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject);

    bool setBottomMargin(qreal bottomMargin, OutOfBoundsPolicy outOfBoundsPolicy = OutOfBoundsPolicy::Reject);

    QMarginsF margins() const;

    QMarginsF margins(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(Unit units) const;

    QRect fullRectPoints() const;

    QRect fullRectPixels(int resolution) const;

    QRectF paintRect() const;

    QRectF paintRect(Unit units) const;

    QRect paintRectPoints() const;

    QRect paintRectPixels(int resolution) const;

private:

    friend class QPageLayoutPrivate;

    bool equals(const QPageLayout &other) const;

    friend inline bool operator==(const QPageLayout &lhs, const QPageLayout &rhs)

    { return lhs.equals(rhs); }

    friend inline bool operator!=(const QPageLayout &lhs, const QPageLayout &rhs)

    { return !lhs.equals(rhs); }

    QExplicitlySharedDataPointer<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

QT_DECL_METATYPE_EXTERN(QPageLayout, Q_GUI_EXPORT)

QT_DECL_METATYPE_EXTERN_TAGGED(QPageLayout::Unit, QPageLayout__Unit, Q_GUI_EXPORT)

QT_DECL_METATYPE_EXTERN_TAGGED(QPageLayout::Orientation, QPageLayout__Orientation, Q_GUI_EXPORT)

#endif // QPAGELAYOUT_H