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>

1 files changed, 332 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