diff -r 000000000000 -r 1918ee327afb src/corelib/tools/qmargins.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/corelib/tools/qmargins.cpp Mon Jan 11 14:00:40 2010 +0000 @@ -0,0 +1,167 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** 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 Technology Preview License Agreement accompanying +** this package. +** +** 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.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qmargins.h" +#include "qdatastream.h" +#include "qdebug.h" + +QT_BEGIN_NAMESPACE + +/*! + \class QMargins + \ingroup painting + \since 4.6 + + \brief The QMargins class defines the four margins of a rectangle. + + 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 isNull() +*/ + +/*! + \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 setLeft(), setRight(), setTop(), setBottom() +*/ + +/*! + \fn bool QMargins::isNull() const + + Returns true if all margins are is 0; otherwise returns + false. +*/ + + +/*! + \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