Make QMargins a proper class

Since we need QMargins for other things then
the CSS helper functions in drawutil, we have to make it more
generic. It is already useful for QWidget::contentsMargins
for example. This ensures we have some flexibility on how to
use and modify it in the future.

Reviewed-by: mbm

3 files changed, 386 insertions, 63 deletions

diff --git a/src/corelib/tools/qmargins.cpp b/src/corelib/tools/qmargins.cpp
new file mode 100644
index 0000000..710023e
--- /dev/null
+++ b/src/corelib/tools/qmargins.cpp
@@ -0,0 +1,169 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtCore module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** 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, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qmargins.h"
+#include "qdatastream.h"
+#include "qdebug.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \class QMargins
+    \ingroup painting
+
+    \brief The QMargins 
+
+    QMargin 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 true only if all margins are set to zero.
+
+    QMargin objects can be streamed as well as compared.
+
+*/
+
+
+/*****************************************************************************
+  QMargins member functions
+ *****************************************************************************/
+
+/*!
+    \fn QMargins::QMargins()
+
+    Constructs a margins object with all margins set to 0.
+
+    \sa isValid()
+*/
+
+/*!
+    \fn QMargins::QMargins(int left, int top, int right, int bottom)
+
+    Constructs margins with the given \a left, \a top, \a right, \a bottom
+
+    \sa setWidth(), setHeight()
+*/
+
+/*!
+    \fn bool QMargins::isNull() const
+
+    Returns true if all margins are is 0; otherwise returns
+    false.
+
+    \sa isValid(), isEmpty()
+*/
+
+
+/*!
+    \fn int QMargins::left() const
+
+    Returns the left margin.
+
+    \sa setLeft()
+*/
+
+/*!
+    \fn int QMargins::top() const
+
+    Returns the top margin.
+
+    \sa setTop()
+*/
+
+/*!
+    \fn int QMargins::right() const
+
+    Returns the right margin.
+*/
+
+/*!
+    \fn int QMargins::bottom() const
+
+    Returns the bottom margin.
+*/
+
+
+/*!
+    \fn void QMargins::setLeft(int left)
+
+    Sets the left margin to \a left.
+*/
+
+/*!
+    \fn void QMargins::setTop(int Top)
+
+    Sets the Top margin to \a Top.
+*/
+
+/*!
+    \fn void QMargins::setRight(int right)
+
+    Sets the right margin to \a right.
+*/
+
+/*!
+    \fn void QMargins::setBottom(int bottom)
+
+    Sets the bottom margin to \a bottom.
+*/
+
+/*!
+    \fn bool operator==(const QMargins &m1, const QMargins &m2)
+    \relates QMargins
+
+    Returns true if \a m1 and \a m2 are equal; otherwise returns false.
+*/
+
+/*!
+    \fn bool operator!=(const QMargins &m1, const QMargins &m2)
+    \relates QMargins
+
+    Returns true if \a m1 and \a m2 are different; otherwise returns false.
+*/
+
+#ifndef QT_NO_DEBUG_STREAM
+QDebug operator<<(QDebug dbg, const QMargins &m) {
+    dbg.nospace() << "QMargins(" << 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
new file mode 100644
index 0000000..de5ce0d
--- /dev/null
+++ b/src/corelib/tools/qmargins.h
@@ -0,0 +1,152 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** This file is part of the QtCore module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** 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, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QMARGINS_H
+#define QMARGINS_H
+
+#include <QtCore/qnamespace.h>
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+QT_MODULE(Core)
+
+class Q_CORE_EXPORT QMargins
+{
+public:
+    QMargins();
+    QMargins(int left, int top, int right, int bottom);
+
+    bool isNull() const;
+
+    int left() const;
+    int top() const;
+    int right() const;
+    int bottom() const;
+
+    void setLeft(int left);
+    void setTop(int top);
+    void setRight(int right);
+    void setBottom(int bottom);
+
+    int &rleft();
+    int &rtop();
+    int &rright();
+    int &rbottom();
+
+private:
+    int m_left;
+    int m_top;
+    int m_right;
+    int m_bottom;
+
+    friend inline bool operator==(const QMargins &, const QMargins &);
+    friend inline bool operator!=(const QMargins &, const QMargins &);
+};
+
+Q_DECLARE_TYPEINFO(QMargins, Q_MOVABLE_TYPE);
+
+/*****************************************************************************
+  QMargins inline functions
+ *****************************************************************************/
+
+inline QMargins::QMargins()
+{ m_top = m_bottom = m_left = m_right = 0; }
+
+inline QMargins::QMargins(int left, int top, int right, int bottom)
+{ m_left = left; m_top = top; m_right = right; m_bottom = bottom; }
+
+inline bool QMargins::isNull() const
+{ return m_left==0 && m_top==0 && m_right==0 && m_bottom==0; }
+
+inline int QMargins::left() const
+{ return m_left; }
+
+inline int QMargins::top() const
+{ return m_top; }
+
+inline int QMargins::right() const
+{ return m_right; }
+
+inline int QMargins::bottom() const
+{ return m_bottom; }
+
+
+inline void QMargins::setLeft(int left)
+{ m_left = left; }
+
+inline void QMargins::setTop(int top)
+{ m_top = top; }
+
+inline void QMargins::setRight(int right)
+{ m_right = right; }
+
+inline void QMargins::setBottom(int bottom)
+{ m_bottom = bottom; }
+
+inline bool operator==(const QMargins &m1, const QMargins &m2)
+{
+    return
+            m1.m_left == m2.m_left &&
+            m1.m_top == m2.m_top &&
+            m1.m_right == m2.m_right &&
+            m1.m_bottom == m2.m_bottom;
+}
+
+inline bool operator!=(const QMargins &m1, const QMargins &m2)
+{
+    return
+            m1.m_left != m2.m_left ||
+            m1.m_top != m2.m_top ||
+            m1.m_right != m2.m_right ||
+            m1.m_bottom != m2.m_bottom;
+}
+
+#ifndef QT_NO_DEBUG_STREAM
+Q_CORE_EXPORT QDebug operator<<(QDebug, const QMargins &);
+#endif
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif // QMARGINS_H
diff --git a/src/corelib/tools/tools.pri b/src/corelib/tools/tools.pri
index 464c60f..007b763 100644
--- a/src/corelib/tools/tools.pri
+++ b/src/corelib/tools/tools.pri
@@ -1,77 +1,79 @@
 # Qt tools module
 
 HEADERS +=  \
-	tools/qalgorithms.h \
-	tools/qbitarray.h \
-	tools/qbytearray.h \
-	tools/qbytearraymatcher.h \
+        tools/qalgorithms.h \
+        tools/qbitarray.h \
+        tools/qbytearray.h \
+        tools/qbytearraymatcher.h \
         tools/qbytedata_p.h \
-	tools/qcache.h \
-	tools/qchar.h \
-	tools/qcontainerfwd.h \
-	tools/qcryptographichash.h \
-	tools/qdatetime.h \
-	tools/qdatetime_p.h \
+        tools/qcache.h \
+        tools/qchar.h \
+        tools/qcontainerfwd.h \
+        tools/qcryptographichash.h \
+        tools/qdatetime.h \
+        tools/qdatetime_p.h \
         tools/qeasingcurve.h \
-	tools/qhash.h \
+        tools/qhash.h \
         tools/qline.h \
-	tools/qlinkedlist.h \
-	tools/qlist.h \
-	tools/qlocale.h \
-	tools/qlocale_p.h \
-	tools/qlocale_data_p.h \
-	tools/qmap.h \
+        tools/qlinkedlist.h \
+        tools/qlist.h \
+        tools/qlocale.h \
+        tools/qlocale_p.h \
+        tools/qlocale_data_p.h \
+        tools/qmap.h \
+        tools/qmargins.h \
         tools/qcontiguouscache.h \
         tools/qpodlist_p.h \
         tools/qpoint.h \
-	tools/qqueue.h \
+        tools/qqueue.h \
         tools/qrect.h \
-	tools/qregexp.h \
-	tools/qringbuffer_p.h \
-	tools/qshareddata.h \
+        tools/qregexp.h \
+        tools/qringbuffer_p.h \
+        tools/qshareddata.h \
         tools/qsharedpointer.h \
         tools/qsharedpointer_impl.h \
-	tools/qset.h \
+        tools/qset.h \
         tools/qsize.h \
-	tools/qstack.h \
-	tools/qstring.h \
-	tools/qstringbuilder.h \
-	tools/qstringlist.h \
-	tools/qstringmatcher.h \
-	tools/qtextboundaryfinder.h \
-	tools/qtimeline.h \
-	tools/qunicodetables_p.h \
-	tools/qvarlengtharray.h \
-	tools/qvector.h \
+        tools/qstack.h \
+        tools/qstring.h \
+        tools/qstringbuilder.h \
+        tools/qstringlist.h \
+        tools/qstringmatcher.h \
+        tools/qtextboundaryfinder.h \
+        tools/qtimeline.h \
+        tools/qunicodetables_p.h \
+        tools/qvarlengtharray.h \
+        tools/qvector.h \
         tools/qscopedpointer.h
 
 
 SOURCES += \
-	tools/qbitarray.cpp \
-	tools/qbytearray.cpp \
-	tools/qbytearraymatcher.cpp \
-	tools/qcryptographichash.cpp \
-	tools/qdatetime.cpp \
+        tools/qbitarray.cpp \
+        tools/qbytearray.cpp \
+        tools/qbytearraymatcher.cpp \
+        tools/qcryptographichash.cpp \
+        tools/qdatetime.cpp \
         tools/qeasingcurve.cpp \
-	tools/qhash.cpp \
+        tools/qhash.cpp \
         tools/qline.cpp \
-	tools/qlinkedlist.cpp \
-	tools/qlist.cpp \
-	tools/qlocale.cpp \
+        tools/qlinkedlist.cpp \
+        tools/qlist.cpp \
+        tools/qlocale.cpp \
         tools/qpoint.cpp \
-	tools/qmap.cpp \
-	tools/qcontiguouscache.cpp \
+        tools/qmap.cpp \
+        tools/qmargins.cpp \
+        tools/qcontiguouscache.cpp \
         tools/qrect.cpp \
-	tools/qregexp.cpp \
-	tools/qshareddata.cpp \
-	tools/qsharedpointer.cpp \
+        tools/qregexp.cpp \
+        tools/qshareddata.cpp \
+        tools/qsharedpointer.cpp \
         tools/qsize.cpp \
-	tools/qstring.cpp \
-	tools/qstringbuilder.cpp \
-	tools/qstringlist.cpp \
-	tools/qtextboundaryfinder.cpp \
-	tools/qtimeline.cpp \
-	tools/qvector.cpp \
+        tools/qstring.cpp \
+        tools/qstringbuilder.cpp \
+        tools/qstringlist.cpp \
+        tools/qtextboundaryfinder.cpp \
+        tools/qtimeline.cpp \
+        tools/qvector.cpp \
         tools/qvsnprintf.cpp
 
 symbian:SOURCES+=tools/qlocale_symbian.cpp
@@ -81,17 +83,17 @@ contains(QT_CONFIG, zlib) {
    wince*: DEFINES += NO_ERRNO_H
    INCLUDEPATH += ../3rdparty/zlib
    SOURCES+= \
-	../3rdparty/zlib/adler32.c \
-	../3rdparty/zlib/compress.c \
-	../3rdparty/zlib/crc32.c \
-	../3rdparty/zlib/deflate.c \
-	../3rdparty/zlib/gzio.c \
-	../3rdparty/zlib/inffast.c \
-	../3rdparty/zlib/inflate.c \
-	../3rdparty/zlib/inftrees.c \
-	../3rdparty/zlib/trees.c \
-	../3rdparty/zlib/uncompr.c \
-	../3rdparty/zlib/zutil.c
+        ../3rdparty/zlib/adler32.c \
+        ../3rdparty/zlib/compress.c \
+        ../3rdparty/zlib/crc32.c \
+        ../3rdparty/zlib/deflate.c \
+        ../3rdparty/zlib/gzio.c \
+        ../3rdparty/zlib/inffast.c \
+        ../3rdparty/zlib/inflate.c \
+        ../3rdparty/zlib/inftrees.c \
+        ../3rdparty/zlib/trees.c \
+        ../3rdparty/zlib/uncompr.c \
+        ../3rdparty/zlib/zutil.c
 } else:!contains(QT_CONFIG, no-zlib) {
    unix:LIBS_PRIVATE += -lz
 #  win32:LIBS += libz.lib