QMarginsF - Add new QMarginsF class

Add a new QMarginsF class to complement QMargins in the style of
QSize/QSizeF and QRect/QRectF.

[ChangeLog][QtCore] Added class QMarginsF to support handling margins
with floating-point values.

Change-Id: Iaaa95ec85f5d126d9d864fc4b607241a8c8a8f3a
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>

4 files changed, 655 insertions, 0 deletions

diff --git a/src/corelib/tools/qmargins.cpp b/src/corelib/tools/qmargins.cpp
index 7d8a167a88..088f0dc083 100644
--- a/src/corelib/tools/qmargins.cpp
+++ b/src/corelib/tools/qmargins.cpp
@@ -426,4 +426,336 @@ QDebug operator<<(QDebug dbg, const QMargins &m) {
 }
 #endif
 
+/*!
+    \class QMarginsF
+    \inmodule QtCore
+    \ingroup painting
+    \since 5.3
+
+    \brief The QMarginsF class defines the four margins of a rectangle.
+
+    QMarginsF defines a set of four margins; left, top, right and bottom,
+    that describe the size of the borders surrounding a rectangle.
+
+    The isNull() function returns \c true only if all margins are set to zero.
+
+    QMarginsF objects can be streamed as well as compared.
+*/
+
+
+/*****************************************************************************
+  QMarginsF member functions
+ *****************************************************************************/
+
+/*!
+    \fn QMarginsF::QMarginsF()
+
+    Constructs a margins object with all margins set to 0.
+
+    \sa isNull()
+*/
+
+/*!
+    \fn QMarginsF::QMarginsF(qreal left, qreal top, qreal right, qreal bottom)
+
+    Constructs margins with the given \a left, \a top, \a right, \a bottom
+
+    \sa setLeft(), setRight(), setTop(), setBottom()
+*/
+
+/*!
+    \fn QMarginsF::QMarginsF(const QMargins &margins)
+
+    Constructs margins copied from the given \a margins
+*/
+
+/*!
+    \fn bool QMarginsF::isNull() const
+
+    Returns \c true if all margins are is 0; otherwise returns
+    false.
+*/
+
+
+/*!
+    \fn qreal QMarginsF::left() const
+
+    Returns the left margin.
+
+    \sa setLeft()
+*/
+
+/*!
+    \fn qreal QMarginsF::top() const
+
+    Returns the top margin.
+
+    \sa setTop()
+*/
+
+/*!
+    \fn qreal QMarginsF::right() const
+
+    Returns the right margin.
+*/
+
+/*!
+    \fn qreal QMarginsF::bottom() const
+
+    Returns the bottom margin.
+*/
+
+
+/*!
+    \fn void QMarginsF::setLeft(qreal left)
+
+    Sets the left margin to \a left.
+*/
+
+/*!
+    \fn void QMarginsF::setTop(qreal Top)
+
+    Sets the Top margin to \a Top.
+*/
+
+/*!
+    \fn void QMarginsF::setRight(qreal right)
+
+    Sets the right margin to \a right.
+*/
+
+/*!
+    \fn void QMarginsF::setBottom(qreal bottom)
+
+    Sets the bottom margin to \a bottom.
+*/
+
+/*!
+    \fn bool operator==(const QMarginsF &lhs, const QMarginsF &rhs)
+    \relates QMarginsF
+
+    Returns \c true if \a lhs and \a rhs are equal; otherwise returns \c false.
+*/
+
+/*!
+    \fn bool operator!=(const QMarginsF &lhs, const QMarginsF &rhs)
+    \relates QMarginsF
+
+    Returns \c true if \a lhs and \a rhs are different; otherwise returns \c false.
+*/
+
+/*!
+    \fn const QMarginsF operator+(const QMarginsF &lhs, const QMarginsF &rhs)
+    \relates QMarginsF
+
+    Returns a QMarginsF object that is the sum of the given margins, \a lhs
+    and \a rhs; each component is added separately.
+
+    \sa QMarginsF::operator+=(), QMarginsF::operator-=()
+*/
+
+/*!
+    \fn const QMarginsF operator-(const QMarginsF &lhs, const QMarginsF &rhs)
+    \relates QMarginsF
+
+    Returns a QMarginsF object that is formed by subtracting \a rhs from
+    \a lhs; each component is subtracted separately.
+
+    \sa QMarginsF::operator+=(), QMarginsF::operator-=()
+*/
+
+/*!
+    \fn const QMarginsF operator+(const QMarginsF &lhs, qreal rhs)
+    \relates QMarginsF
+
+    Returns a QMarginsF object that is formed by adding \a rhs to
+    \a lhs.
+
+    \sa QMarginsF::operator+=(), QMarginsF::operator-=()
+*/
+
+/*!
+    \fn const QMarginsF operator+(qreal lhs, const QMarginsF &rhs)
+    \relates QMarginsF
+
+    Returns a QMarginsF object that is formed by adding \a lhs to
+    \a rhs.
+
+    \sa QMarginsF::operator+=(), QMarginsF::operator-=()
+*/
+
+/*!
+    \fn const QMarginsF operator-(const QMarginsF &lhs, qreal rhs)
+    \relates QMarginsF
+
+    Returns a QMarginsF object that is formed by subtracting \a rhs from
+    \a lhs.
+
+    \sa QMarginsF::operator+=(), QMarginsF::operator-=()
+*/
+
+/*!
+    \fn const QMarginsF operator*(const QMarginsF &lhs, qreal rhs)
+    \relates QMarginsF
+    \overload
+
+    Returns a QMarginsF object that is formed by multiplying each component
+    of the given \a lhs margins by \a rhs factor.
+
+    \sa QMarginsF::operator*=(), QMarginsF::operator/=()
+*/
+
+/*!
+    \fn const QMarginsF operator*(qreal lhs, const QMarginsF &rhs)
+    \relates QMarginsF
+    \overload
+
+    Returns a QMarginsF object that is formed by multiplying each component
+    of the given \a lhs margins by \a rhs factor.
+
+    \sa QMarginsF::operator*=(), QMarginsF::operator/=()
+*/
+
+/*!
+    \fn const QMarginsF operator/(const QMarginsF &lhs, qreal rhs)
+    \relates QMarginsF
+    \overload
+
+    Returns a QMarginsF object that is formed by dividing the components of
+    the given \a lhs margins by the given \a rhs divisor.
+
+    \sa QMarginsF::operator*=(), QMarginsF::operator/=()
+*/
+
+/*!
+    \fn QMarginsF operator+(const QMarginsF &margins)
+    \relates QMarginsF
+
+    Returns a QMargin object that is formed from all components of \a margins.
+*/
+
+/*!
+    \fn QMarginsF operator-(const QMarginsF &margins)
+    \relates QMarginsF
+
+    Returns a QMargin object that is formed by negating all components of \a margins.
+*/
+
+/*!
+    \fn QMarginsF &QMarginsF::operator+=(const QMarginsF &margins)
+
+    Add each component of \a margins to the respective component of this object
+    and returns a reference to it.
+
+    \sa operator-=()
+*/
+
+/*!
+    \fn QMarginsF &QMarginsF::operator-=(const QMarginsF &margins)
+
+    Subtract each component of \a margins from the respective component of this object
+    and returns a reference to it.
+
+    \sa operator+=()
+*/
+
+/*!
+    \fn QMarginsF &QMarginsF::operator+=(qreal addend)
+    \overload
+
+    Adds the \a addend to each component of this object
+    and returns a reference to it.
+
+    \sa operator-=()
+*/
+
+/*!
+    \fn QMarginsF &QMarginsF::operator-=(qreal subtrahend)
+    \overload
+
+    Subtracts the \a subtrahend from each component of this object
+    and returns a reference to it.
+
+    \sa operator+=()
+*/
+
+/*!
+    \fn QMarginsF &QMarginsF::operator*=(qreal factor)
+
+    Multiplies each component of this object by \a factor
+    and returns a reference to it.
+
+    \sa operator/=()
+*/
+
+/*!
+    \fn QMarginsF &QMarginsF::operator/=(qreal divisor)
+
+    Divides each component of this object by \a divisor
+    and returns a reference to it.
+
+    \sa operator*=()
+*/
+
+/*!
+    \fn QMargins QMarginsF::toMargins() const
+
+    Returns an integer based copy of this margins object.
+
+    Note that the components in the returned margins will be rounded to
+    the nearest integer.
+
+    \sa QMarginsF()
+*/
+
+/*****************************************************************************
+  QMarginsF stream functions
+ *****************************************************************************/
+#ifndef QT_NO_DATASTREAM
+/*!
+    \fn QDataStream &operator<<(QDataStream &stream, const QMarginsF &m)
+    \relates QMarginsF
+
+    Writes margin \a m to the given \a stream and returns a
+    reference to the stream.
+
+    \sa {Serializing Qt Data Types}
+*/
+
+QDataStream &operator<<(QDataStream &s, const QMarginsF &m)
+{
+    s << double(m.left()) << double(m.top()) << double(m.right()) << double(m.bottom());
+    return s;
+}
+
+/*!
+    \fn QDataStream &operator>>(QDataStream &stream, QMarginsF &m)
+    \relates QMarginsF
+
+    Reads a margin from the given \a stream into margin \a m
+    and returns a reference to the stream.
+
+    \sa {Serializing Qt Data Types}
+*/
+
+QDataStream &operator>>(QDataStream &s, QMarginsF &m)
+{
+    double left, top, right, bottom;
+    s >> left;
+    s >> top;
+    s >> right;
+    s >> bottom;
+    m = QMarginsF(qreal(left), qreal(top), qreal(right), qreal(bottom));
+    return s;
+}
+#endif // QT_NO_DATASTREAM
+
+#ifndef QT_NO_DEBUG_STREAM
+QDebug operator<<(QDebug dbg, const QMarginsF &m) {
+    dbg.nospace() << "QMarginsF(" << m.left() << ", "
+            << m.top() << ", " << m.right() << ", " << m.bottom() << ')';
+    return dbg.space();
+}
+#endif
+
 QT_END_NAMESPACE
diff --git a/src/corelib/tools/qmargins.h b/src/corelib/tools/qmargins.h
index 55355ac859..d96ccaccae 100644
--- a/src/corelib/tools/qmargins.h
+++ b/src/corelib/tools/qmargins.h
@@ -46,6 +46,9 @@
 
 QT_BEGIN_NAMESPACE
 
+/*****************************************************************************
+  QMargins class
+ *****************************************************************************/
 
 class QMargins
 {
@@ -277,6 +280,214 @@ Q_DECL_CONSTEXPR inline QMargins operator-(const QMargins &margins)
 Q_CORE_EXPORT QDebug operator<<(QDebug, const QMargins &);
 #endif
 
+/*****************************************************************************
+  QMarginsF class
+ *****************************************************************************/
+
+class QMarginsF
+{
+public:
+    Q_DECL_CONSTEXPR QMarginsF();
+    Q_DECL_CONSTEXPR QMarginsF(qreal left, qreal top, qreal right, qreal bottom);
+    Q_DECL_CONSTEXPR QMarginsF(const QMargins &margins);
+
+    Q_DECL_CONSTEXPR bool isNull() const;
+
+    Q_DECL_CONSTEXPR qreal left() const;
+    Q_DECL_CONSTEXPR qreal top() const;
+    Q_DECL_CONSTEXPR qreal right() const;
+    Q_DECL_CONSTEXPR qreal bottom() const;
+
+    void setLeft(qreal left);
+    void setTop(qreal top);
+    void setRight(qreal right);
+    void setBottom(qreal bottom);
+
+    QMarginsF &operator+=(const QMarginsF &margins);
+    QMarginsF &operator-=(const QMarginsF &margins);
+    QMarginsF &operator+=(qreal addend);
+    QMarginsF &operator-=(qreal subtrahend);
+    QMarginsF &operator*=(qreal factor);
+    QMarginsF &operator/=(qreal divisor);
+
+    Q_DECL_CONSTEXPR inline QMargins toMargins() const;
+
+private:
+    qreal m_left;
+    qreal m_top;
+    qreal m_right;
+    qreal m_bottom;
+};
+
+Q_DECLARE_TYPEINFO(QMarginsF, Q_MOVABLE_TYPE);
+
+/*****************************************************************************
+  QMarginsF stream functions
+ *****************************************************************************/
+
+#ifndef QT_NO_DATASTREAM
+Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QMarginsF &);
+Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QMarginsF &);
+#endif
+
+/*****************************************************************************
+  QMarginsF inline functions
+ *****************************************************************************/
+
+Q_DECL_CONSTEXPR inline QMarginsF::QMarginsF() : m_left(0), m_top(0), m_right(0), m_bottom(0) {}
+
+Q_DECL_CONSTEXPR inline QMarginsF::QMarginsF(qreal aleft, qreal atop, qreal aright, qreal abottom)
+    : m_left(aleft), m_top(atop), m_right(aright), m_bottom(abottom) {}
+
+Q_DECL_CONSTEXPR inline QMarginsF::QMarginsF(const QMargins &margins)
+    : m_left(margins.left()), m_top(margins.top()), m_right(margins.right()), m_bottom(margins.bottom()) {}
+
+Q_DECL_CONSTEXPR inline bool QMarginsF::isNull() const
+{ return qFuzzyIsNull(m_left) && qFuzzyIsNull(m_top) && qFuzzyIsNull(m_right) && qFuzzyIsNull(m_bottom); }
+
+Q_DECL_CONSTEXPR inline qreal QMarginsF::left() const
+{ return m_left; }
+
+Q_DECL_CONSTEXPR inline qreal QMarginsF::top() const
+{ return m_top; }
+
+Q_DECL_CONSTEXPR inline qreal QMarginsF::right() const
+{ return m_right; }
+
+Q_DECL_CONSTEXPR inline qreal QMarginsF::bottom() const
+{ return m_bottom; }
+
+
+inline void QMarginsF::setLeft(qreal aleft)
+{ m_left = aleft; }
+
+inline void QMarginsF::setTop(qreal atop)
+{ m_top = atop; }
+
+inline void QMarginsF::setRight(qreal aright)
+{ m_right = aright; }
+
+inline void QMarginsF::setBottom(qreal abottom)
+{ m_bottom = abottom; }
+
+Q_DECL_CONSTEXPR inline bool operator==(const QMarginsF &lhs, const QMarginsF &rhs)
+{
+    return qFuzzyCompare(lhs.left(), rhs.left())
+           && qFuzzyCompare(lhs.top(), rhs.top())
+           && qFuzzyCompare(lhs.right(), rhs.right())
+           && qFuzzyCompare(lhs.bottom(), rhs.bottom());
+}
+
+Q_DECL_CONSTEXPR inline bool operator!=(const QMarginsF &lhs, const QMarginsF &rhs)
+{
+    return !operator==(lhs, rhs);
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator+(const QMarginsF &lhs, const QMarginsF &rhs)
+{
+    return QMarginsF(lhs.left() + rhs.left(), lhs.top() + rhs.top(),
+                     lhs.right() + rhs.right(), lhs.bottom() + rhs.bottom());
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator-(const QMarginsF &lhs, const QMarginsF &rhs)
+{
+    return QMarginsF(lhs.left() - rhs.left(), lhs.top() - rhs.top(),
+                     lhs.right() - rhs.right(), lhs.bottom() - rhs.bottom());
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator+(const QMarginsF &lhs, qreal rhs)
+{
+    return QMarginsF(lhs.left() + rhs, lhs.top() + rhs,
+                     lhs.right() + rhs, lhs.bottom() + rhs);
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator+(qreal lhs, const QMarginsF &rhs)
+{
+    return QMarginsF(rhs.left() + lhs, rhs.top() + lhs,
+                     rhs.right() + lhs, rhs.bottom() + lhs);
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator-(const QMarginsF &lhs, qreal rhs)
+{
+    return QMarginsF(lhs.left() - rhs, lhs.top() - rhs,
+                     lhs.right() - rhs, lhs.bottom() - rhs);
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator*(const QMarginsF &lhs, qreal rhs)
+{
+    return QMarginsF(lhs.left() * rhs, lhs.top() * rhs,
+                     lhs.right() * rhs, lhs.bottom() * rhs);
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator*(qreal lhs, const QMarginsF &rhs)
+{
+    return QMarginsF(rhs.left() * lhs, rhs.top() * lhs,
+                     rhs.right() * lhs, rhs.bottom() * lhs);
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator/(const QMarginsF &lhs, qreal divisor)
+{
+    return QMarginsF(lhs.left() / divisor, lhs.top() / divisor,
+                     lhs.right() / divisor, lhs.bottom() / divisor);
+}
+
+inline QMarginsF &QMarginsF::operator+=(const QMarginsF &margins)
+{
+    return *this = *this + margins;
+}
+
+inline QMarginsF &QMarginsF::operator-=(const QMarginsF &margins)
+{
+    return *this = *this - margins;
+}
+
+inline QMarginsF &QMarginsF::operator+=(qreal addend)
+{
+    m_left += addend;
+    m_top += addend;
+    m_right += addend;
+    m_bottom += addend;
+    return *this;
+}
+
+inline QMarginsF &QMarginsF::operator-=(qreal subtrahend)
+{
+    m_left -= subtrahend;
+    m_top -= subtrahend;
+    m_right -= subtrahend;
+    m_bottom -= subtrahend;
+    return *this;
+}
+
+inline QMarginsF &QMarginsF::operator*=(qreal factor)
+{
+    return *this = *this * factor;
+}
+
+inline QMarginsF &QMarginsF::operator/=(qreal divisor)
+{
+    return *this = *this / divisor;
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator+(const QMarginsF &margins)
+{
+    return margins;
+}
+
+Q_DECL_CONSTEXPR inline QMarginsF operator-(const QMarginsF &margins)
+{
+    return QMarginsF(-margins.left(), -margins.top(), -margins.right(), -margins.bottom());
+}
+
+Q_DECL_CONSTEXPR inline QMargins QMarginsF::toMargins() const
+{
+    return QMargins(qRound(m_left), qRound(m_top), qRound(m_right), qRound(m_bottom));
+}
+
+#ifndef QT_NO_DEBUG_STREAM
+Q_CORE_EXPORT QDebug operator<<(QDebug, const QMarginsF &);
+#endif
+
 QT_END_NAMESPACE
 
 #endif // QMARGINS_H
diff --git a/src/corelib/tools/qrect.cpp b/src/corelib/tools/qrect.cpp
index e3ecdbb2ca..33e8dd23fc 100644
--- a/src/corelib/tools/qrect.cpp
+++ b/src/corelib/tools/qrect.cpp
@@ -2379,6 +2379,71 @@ QRect QRectF::toAlignedRect() const
     returns \c false.
 */
 
+/*!
+    \fn QRectF operator+(const QRectF &lhs, const QMarginsF &rhs)
+    \relates QRectF
+    \since 5.3
+
+    Returns the \a lhs rectangle grown by the \a rhs margins.
+*/
+
+/*!
+    \fn QRectF operator-(const QRectF &lhs, const QMarginsF &rhs)
+    \relates QRectF
+    \since 5.3
+
+    Returns the \a lhs rectangle grown by the \a rhs margins.
+*/
+
+/*!
+    \fn QRectF operator+(const QMarginsF &lhs, const QRectF &rhs)
+    \relates QRectF
+    \overload
+    \since 5.3
+
+    Returns the \a lhs rectangle grown by the \a rhs margins.
+*/
+
+/*!
+    \fn QRectF QRectF::marginsAdded(const QMarginsF &margins) const
+    \relates QRectF
+    \since 5.3
+
+    Returns a rectangle grown by the \a margins.
+
+    \sa operator+=(), marginsRemoved(), operator-=()
+*/
+
+/*!
+    \fn QRectF QRectF::marginsRemoved(const QMarginsF &margins) const
+    \relates QRectF
+    \since 5.3
+
+    Removes the \a margins from the rectangle, shrinking it.
+
+    \sa marginsAdded(), operator+=(), operator-=()
+*/
+
+/*!
+    \fn QRectF QRectF::operator+=(const QMarginsF &margins)
+    \relates QRectF
+    \since 5.3
+
+    Adds the \a margins to the rectangle, growing it.
+
+    \sa marginsAdded(), marginsRemoved(), operator-=()
+*/
+
+/*!
+    \fn QRectF QRectF::operator-=(const QMarginsF &margins)
+    \relates QRectF
+    \since 5.3
+
+    Returns a rectangle shrunk by the \a margins.
+
+    \sa marginsRemoved(), operator+=(), marginsAdded()
+*/
+
 /*****************************************************************************
   QRectF stream functions
  *****************************************************************************/
diff --git a/src/corelib/tools/qrect.h b/src/corelib/tools/qrect.h
index 5f59bde269..2bb74e8221 100644
--- a/src/corelib/tools/qrect.h
+++ b/src/corelib/tools/qrect.h
@@ -584,6 +584,11 @@ public:
     inline QRectF intersected(const QRectF &other) const;
     bool intersects(const QRectF &r) const;
 
+    Q_DECL_CONSTEXPR inline QRectF marginsAdded(const QMarginsF &margins) const;
+    Q_DECL_CONSTEXPR inline QRectF marginsRemoved(const QMarginsF &margins) const;
+    inline QRectF &operator+=(const QMarginsF &margins);
+    inline QRectF &operator-=(const QMarginsF &margins);
+
 #if QT_DEPRECATED_SINCE(5, 0)
     QT_DEPRECATED QRectF unite(const QRectF &r) const { return united(r); }
     QT_DEPRECATED QRectF intersect(const QRectF &r) const { return intersected(r); }
@@ -825,6 +830,48 @@ Q_DECL_CONSTEXPR inline QRect QRectF::toRect() const
     return QRect(qRound(xp), qRound(yp), qRound(w), qRound(h));
 }
 
+Q_DECL_CONSTEXPR inline QRectF operator+(const QRectF &lhs, const QMarginsF &rhs)
+{
+    return QRectF(QPointF(lhs.left() - rhs.left(), lhs.top() - rhs.top()),
+                  QSizeF(lhs.width() + rhs.left() + rhs.right(), lhs.height() + rhs.top() + rhs.bottom()));
+}
+
+Q_DECL_CONSTEXPR inline QRectF operator+(const QMarginsF &lhs, const QRectF &rhs)
+{
+    return QRectF(QPointF(rhs.left() - lhs.left(), rhs.top() - lhs.top()),
+                  QSizeF(rhs.width() + lhs.left() + lhs.right(), rhs.height() + lhs.top() + lhs.bottom()));
+}
+
+Q_DECL_CONSTEXPR inline QRectF operator-(const QRectF &lhs, const QMarginsF &rhs)
+{
+    return QRectF(QPointF(lhs.left() + rhs.left(), lhs.top() + rhs.top()),
+                  QSizeF(lhs.width() - rhs.left() - rhs.right(), lhs.height() - rhs.top() - rhs.bottom()));
+}
+
+Q_DECL_CONSTEXPR inline QRectF QRectF::marginsAdded(const QMarginsF &margins) const
+{
+    return QRectF(QPointF(xp - margins.left(), yp - margins.top()),
+                  QSizeF(w + margins.left() + margins.right(), h + margins.top() + margins.bottom()));
+}
+
+Q_DECL_CONSTEXPR inline QRectF QRectF::marginsRemoved(const QMarginsF &margins) const
+{
+    return QRectF(QPointF(xp + margins.left(), yp + margins.top()),
+                  QSizeF(w - margins.left() - margins.right(), h - margins.top() - margins.bottom()));
+}
+
+inline QRectF &QRectF::operator+=(const QMarginsF &margins)
+{
+    *this = marginsAdded(margins);
+    return *this;
+}
+
+inline QRectF &QRectF::operator-=(const QMarginsF &margins)
+{
+    *this = marginsRemoved(margins);
+    return *this;
+}
+
 #ifndef QT_NO_DEBUG_STREAM
 Q_CORE_EXPORT QDebug operator<<(QDebug, const QRectF &);
 #endif