← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to src/corelib/tools/qmargins.cpp

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
Import upstream version 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/corelib/tools/qmargins.cpp
 
1
/****************************************************************************
 
2
**
 
3
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
 
4
** All rights reserved.
 
5
** Contact: Nokia Corporation (qt-info@nokia.com)
 
6
**
 
7
** This file is part of the QtCore module of the Qt Toolkit.
 
8
**
 
9
** $QT_BEGIN_LICENSE:LGPL$
 
10
** No Commercial Usage
 
11
** This file contains pre-release code and may not be distributed.
 
12
** You may use this file in accordance with the terms and conditions
 
13
** contained in the Technology Preview License Agreement accompanying
 
14
** this package.
 
15
**
 
16
** GNU Lesser General Public License Usage
 
17
** Alternatively, this file may be used under the terms of the GNU Lesser
 
18
** General Public License version 2.1 as published by the Free Software
 
19
** Foundation and appearing in the file LICENSE.LGPL included in the
 
20
** packaging of this file.  Please review the following information to
 
21
** ensure the GNU Lesser General Public License version 2.1 requirements
 
22
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
 
23
**
 
24
** In addition, as a special exception, Nokia gives you certain additional
 
25
** rights.  These rights are described in the Nokia Qt LGPL Exception
 
26
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
 
27
**
 
28
** If you have questions regarding the use of this file, please contact
 
29
** Nokia at qt-info@nokia.com.
 
30
**
 
31
**
 
32
**
 
33
**
 
34
**
 
35
**
 
36
**
 
37
**
 
38
** $QT_END_LICENSE$
 
39
**
 
40
****************************************************************************/
 
41
 
 
42
#include "qmargins.h"
 
43
#include "qdatastream.h"
 
44
#include "qdebug.h"
 
45
 
 
46
QT_BEGIN_NAMESPACE
 
47
 
 
48
/*!
 
49
    \class QMargins
 
50
    \ingroup painting
 
51
    \since 4.6
 
52
 
 
53
    \brief The QMargins class defines the four margins of a rectangle. 
 
54
 
 
55
    QMargin defines a set of four margins; left, top, right and bottom,
 
56
    that describe the size of the borders surrounding a rectangle.
 
57
 
 
58
    The isNull() function returns true only if all margins are set to zero.
 
59
 
 
60
    QMargin objects can be streamed as well as compared.
 
61
*/
 
62
 
 
63
 
 
64
/*****************************************************************************
 
65
  QMargins member functions
 
66
 *****************************************************************************/
 
67
 
 
68
/*!
 
69
    \fn QMargins::QMargins()
 
70
 
 
71
    Constructs a margins object with all margins set to 0.
 
72
 
 
73
    \sa isNull()
 
74
*/
 
75
 
 
76
/*!
 
77
    \fn QMargins::QMargins(int left, int top, int right, int bottom)
 
78
 
 
79
    Constructs margins with the given \a left, \a top, \a right, \a bottom
 
80
 
 
81
    \sa setLeft(), setRight(), setTop(), setBottom()
 
82
*/
 
83
 
 
84
/*!
 
85
    \fn bool QMargins::isNull() const
 
86
 
 
87
    Returns true if all margins are is 0; otherwise returns
 
88
    false.
 
89
*/
 
90
 
 
91
 
 
92
/*!
 
93
    \fn int QMargins::left() const
 
94
 
 
95
    Returns the left margin.
 
96
 
 
97
    \sa setLeft()
 
98
*/
 
99
 
 
100
/*!
 
101
    \fn int QMargins::top() const
 
102
 
 
103
    Returns the top margin.
 
104
 
 
105
    \sa setTop()
 
106
*/
 
107
 
 
108
/*!
 
109
    \fn int QMargins::right() const
 
110
 
 
111
    Returns the right margin.
 
112
*/
 
113
 
 
114
/*!
 
115
    \fn int QMargins::bottom() const
 
116
 
 
117
    Returns the bottom margin.
 
118
*/
 
119
 
 
120
 
 
121
/*!
 
122
    \fn void QMargins::setLeft(int left)
 
123
 
 
124
    Sets the left margin to \a left.
 
125
*/
 
126
 
 
127
/*!
 
128
    \fn void QMargins::setTop(int Top)
 
129
 
 
130
    Sets the Top margin to \a Top.
 
131
*/
 
132
 
 
133
/*!
 
134
    \fn void QMargins::setRight(int right)
 
135
 
 
136
    Sets the right margin to \a right.
 
137
*/
 
138
 
 
139
/*!
 
140
    \fn void QMargins::setBottom(int bottom)
 
141
 
 
142
    Sets the bottom margin to \a bottom.
 
143
*/
 
144
 
 
145
/*!
 
146
    \fn bool operator==(const QMargins &m1, const QMargins &m2)
 
147
    \relates QMargins
 
148
 
 
149
    Returns true if \a m1 and \a m2 are equal; otherwise returns false.
 
150
*/
 
151
 
 
152
/*!
 
153
    \fn bool operator!=(const QMargins &m1, const QMargins &m2)
 
154
    \relates QMargins
 
155
 
 
156
    Returns true if \a m1 and \a m2 are different; otherwise returns false.
 
157
*/
 
158
 
 
159
#ifndef QT_NO_DEBUG_STREAM
 
160
QDebug operator<<(QDebug dbg, const QMargins &m) {
 
161
    dbg.nospace() << "QMargins(" << m.left() << ", "
 
162
            << m.top() << ", " << m.right() << ", " << m.bottom() << ')';
 
163
    return dbg.space();
 
164
}
 
165
#endif
 
166
 
 
167
QT_END_NAMESPACE