File indexing completed on 2026-08-03 09:24:51
0001
0002
0003
0004
0005 #ifndef QMARGINS_H
0006 #define QMARGINS_H
0007
0008 #include <QtCore/qcheckedint_impl.h>
0009 #include <QtCore/qcompare.h>
0010 #include <QtCore/qnamespace.h>
0011
0012 #include <QtCore/q20type_traits.h>
0013 #include <QtCore/q23utility.h>
0014
0015 QT_BEGIN_NAMESPACE
0016
0017 QT_ENABLE_P0846_SEMANTICS_FOR(get)
0018
0019 class QDataStream;
0020 class QMarginsF;
0021
0022
0023
0024
0025
0026 class QMargins
0027 {
0028 public:
0029 constexpr QMargins() noexcept;
0030 constexpr QMargins(int left, int top, int right, int bottom) noexcept;
0031
0032 constexpr bool isNull() const noexcept;
0033
0034 constexpr int left() const noexcept;
0035 constexpr int top() const noexcept;
0036 constexpr int right() const noexcept;
0037 constexpr int bottom() const noexcept;
0038
0039 constexpr void setLeft(int left) noexcept;
0040 constexpr void setTop(int top) noexcept;
0041 constexpr void setRight(int right) noexcept;
0042 constexpr void setBottom(int bottom) noexcept;
0043
0044 constexpr QMargins &operator+=(const QMargins &margins) noexcept;
0045 constexpr QMargins &operator-=(const QMargins &margins) noexcept;
0046 constexpr QMargins &operator+=(int) noexcept;
0047 constexpr QMargins &operator-=(int) noexcept;
0048 constexpr QMargins &operator*=(int) noexcept;
0049 constexpr QMargins &operator/=(int);
0050 constexpr QMargins &operator*=(qreal) noexcept;
0051 constexpr QMargins &operator/=(qreal);
0052
0053 [[nodiscard]] constexpr inline QMarginsF toMarginsF() const noexcept;
0054
0055 friend constexpr inline QMargins operator+(const QMargins &m1, const QMargins &m2) noexcept;
0056 friend constexpr inline QMargins operator-(const QMargins &m1, const QMargins &m2) noexcept;
0057 friend constexpr inline QMargins operator+(const QMargins &lhs, int rhs) noexcept;
0058 friend constexpr inline QMargins operator+(int lhs, const QMargins &rhs) noexcept;
0059 friend constexpr inline QMargins operator-(const QMargins &lhs, int rhs) noexcept;
0060 friend constexpr inline QMargins operator*(const QMargins &margins, int factor) noexcept;
0061 friend constexpr inline QMargins operator*(int factor, const QMargins &margins) noexcept;
0062 friend constexpr inline QMargins operator*(const QMargins &margins, qreal factor) noexcept;
0063 friend constexpr inline QMargins operator*(qreal factor, const QMargins &margins) noexcept;
0064 friend constexpr inline QMargins operator/(const QMargins &margins, int divisor);
0065 friend constexpr inline QMargins operator/(const QMargins &margins, qreal divisor);
0066 friend constexpr inline QMargins operator|(const QMargins &m1, const QMargins &m2) noexcept;
0067
0068 private:
0069 using Representation = QtPrivate::QCheckedIntegers::QCheckedInt<int>;
0070
0071 constexpr QMargins(Representation left,
0072 Representation top,
0073 Representation right,
0074 Representation bottom) noexcept
0075 : m_left(left), m_top(top), m_right(right), m_bottom(bottom)
0076 {
0077 }
0078
0079 Representation m_left;
0080 Representation m_top;
0081 Representation m_right;
0082 Representation m_bottom;
0083
0084 friend constexpr bool comparesEqual(const QMargins &lhs, const QMargins &rhs) noexcept
0085 {
0086 return lhs.m_left == rhs.m_left
0087 && lhs.m_top == rhs.m_top
0088 && lhs.m_right == rhs.m_right
0089 && lhs.m_bottom == rhs.m_bottom;
0090 }
0091 Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(QMargins)
0092
0093 template <std::size_t I,
0094 typename M,
0095 std::enable_if_t<(I < 4), bool> = true,
0096 std::enable_if_t<std::is_same_v<q20::remove_cvref_t<M>, QMargins>, bool> = true>
0097 friend constexpr decltype(auto) get(M &&m) noexcept
0098 {
0099 if constexpr (I == 0)
0100 return q23::forward_like<M>(m.m_left).as_underlying();
0101 else if constexpr (I == 1)
0102 return q23::forward_like<M>(m.m_top).as_underlying();
0103 else if constexpr (I == 2)
0104 return q23::forward_like<M>(m.m_right).as_underlying();
0105 else if constexpr (I == 3)
0106 return q23::forward_like<M>(m.m_bottom).as_underlying();
0107 }
0108 };
0109
0110 Q_DECLARE_TYPEINFO(QMargins, Q_RELOCATABLE_TYPE);
0111
0112
0113
0114
0115 #ifndef QT_NO_DATASTREAM
0116 Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QMargins &);
0117 Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QMargins &);
0118 #endif
0119
0120
0121
0122
0123
0124 constexpr inline QMargins::QMargins() noexcept : m_left(0), m_top(0), m_right(0), m_bottom(0) {}
0125
0126 constexpr inline QMargins::QMargins(int aleft, int atop, int aright, int abottom) noexcept
0127 : m_left(aleft), m_top(atop), m_right(aright), m_bottom(abottom) {}
0128
0129 constexpr inline bool QMargins::isNull() const noexcept
0130 { return m_left==0 && m_top==0 && m_right==0 && m_bottom==0; }
0131
0132 constexpr inline int QMargins::left() const noexcept
0133 { return m_left.value(); }
0134
0135 constexpr inline int QMargins::top() const noexcept
0136 { return m_top.value(); }
0137
0138 constexpr inline int QMargins::right() const noexcept
0139 { return m_right.value(); }
0140
0141 constexpr inline int QMargins::bottom() const noexcept
0142 { return m_bottom.value(); }
0143
0144
0145 constexpr inline void QMargins::setLeft(int aleft) noexcept
0146 { m_left.setValue(aleft); }
0147
0148 constexpr inline void QMargins::setTop(int atop) noexcept
0149 { m_top.setValue(atop); }
0150
0151 constexpr inline void QMargins::setRight(int aright) noexcept
0152 { m_right.setValue(aright); }
0153
0154 constexpr inline void QMargins::setBottom(int abottom) noexcept
0155 { m_bottom.setValue(abottom); }
0156
0157 constexpr inline QMargins operator+(const QMargins &m1, const QMargins &m2) noexcept
0158 {
0159 return QMargins(m1.m_left + m2.m_left, m1.m_top + m2.m_top,
0160 m1.m_right + m2.m_right, m1.m_bottom + m2.m_bottom);
0161 }
0162
0163 constexpr inline QMargins operator-(const QMargins &m1, const QMargins &m2) noexcept
0164 {
0165 return QMargins(m1.m_left - m2.m_left, m1.m_top - m2.m_top,
0166 m1.m_right - m2.m_right, m1.m_bottom - m2.m_bottom);
0167 }
0168
0169 constexpr inline QMargins operator+(const QMargins &lhs, int rhs) noexcept
0170 {
0171 return QMargins(lhs.m_left + rhs, lhs.m_top + rhs,
0172 lhs.m_right + rhs, lhs.m_bottom + rhs);
0173 }
0174
0175 constexpr inline QMargins operator+(int lhs, const QMargins &rhs) noexcept
0176 {
0177 return QMargins(rhs.m_left + lhs, rhs.m_top + lhs,
0178 rhs.m_right + lhs, rhs.m_bottom + lhs);
0179 }
0180
0181 constexpr inline QMargins operator-(const QMargins &lhs, int rhs) noexcept
0182 {
0183 return QMargins(lhs.m_left - rhs, lhs.m_top - rhs,
0184 lhs.m_right - rhs, lhs.m_bottom - rhs);
0185 }
0186
0187 constexpr inline QMargins operator*(const QMargins &margins, int factor) noexcept
0188 {
0189 return QMargins(margins.m_left * factor, margins.m_top * factor,
0190 margins.m_right * factor, margins.m_bottom * factor);
0191 }
0192
0193 constexpr inline QMargins operator*(int factor, const QMargins &margins) noexcept
0194 {
0195 return QMargins(margins.m_left * factor, margins.m_top * factor,
0196 margins.m_right * factor, margins.m_bottom * factor);
0197 }
0198
0199 constexpr inline QMargins operator*(const QMargins &margins, qreal factor) noexcept
0200 {
0201
0202 return QMargins(QtPrivate::qSaturateRound(margins.left() * factor),
0203 QtPrivate::qSaturateRound(margins.top() * factor),
0204 QtPrivate::qSaturateRound(margins.right() * factor),
0205 QtPrivate::qSaturateRound(margins.bottom() * factor));
0206 }
0207
0208 constexpr inline QMargins operator*(qreal factor, const QMargins &margins) noexcept
0209 {
0210 return QMargins(QtPrivate::qSaturateRound(margins.left() * factor),
0211 QtPrivate::qSaturateRound(margins.top() * factor),
0212 QtPrivate::qSaturateRound(margins.right() * factor),
0213 QtPrivate::qSaturateRound(margins.bottom() * factor));
0214 }
0215
0216 constexpr inline QMargins operator/(const QMargins &margins, int divisor)
0217 {
0218 return QMargins(margins.m_left / divisor, margins.m_top / divisor,
0219 margins.m_right / divisor, margins.m_bottom / divisor);
0220 }
0221
0222 constexpr inline QMargins operator/(const QMargins &margins, qreal divisor)
0223 {
0224 Q_ASSERT(!qFuzzyIsNull(divisor));
0225 return QMargins(QtPrivate::qSaturateRound(margins.left() / divisor),
0226 QtPrivate::qSaturateRound(margins.top() / divisor),
0227 QtPrivate::qSaturateRound(margins.right() / divisor),
0228 QtPrivate::qSaturateRound(margins.bottom() / divisor));
0229 }
0230
0231 constexpr inline QMargins operator|(const QMargins &m1, const QMargins &m2) noexcept
0232 {
0233 return QMargins(qMax(m1.m_left, m2.m_left), qMax(m1.m_top, m2.m_top),
0234 qMax(m1.m_right, m2.m_right), qMax(m1.m_bottom, m2.m_bottom));
0235 }
0236
0237 constexpr inline QMargins &QMargins::operator+=(const QMargins &margins) noexcept
0238 {
0239 return *this = *this + margins;
0240 }
0241
0242 constexpr inline QMargins &QMargins::operator-=(const QMargins &margins) noexcept
0243 {
0244 return *this = *this - margins;
0245 }
0246
0247 constexpr inline QMargins &QMargins::operator+=(int margin) noexcept
0248 {
0249 m_left += margin;
0250 m_top += margin;
0251 m_right += margin;
0252 m_bottom += margin;
0253 return *this;
0254 }
0255
0256 constexpr inline QMargins &QMargins::operator-=(int margin) noexcept
0257 {
0258 m_left -= margin;
0259 m_top -= margin;
0260 m_right -= margin;
0261 m_bottom -= margin;
0262 return *this;
0263 }
0264
0265 constexpr inline QMargins &QMargins::operator*=(int factor) noexcept
0266 {
0267 return *this = *this * factor;
0268 }
0269
0270 constexpr inline QMargins &QMargins::operator/=(int divisor)
0271 {
0272 return *this = *this / divisor;
0273 }
0274
0275 constexpr inline QMargins &QMargins::operator*=(qreal factor) noexcept
0276 {
0277 return *this = *this * factor;
0278 }
0279
0280 constexpr inline QMargins &QMargins::operator/=(qreal divisor)
0281 {
0282 return *this = *this / divisor;
0283 }
0284
0285 constexpr inline QMargins operator+(const QMargins &margins) noexcept
0286 {
0287 return margins;
0288 }
0289
0290 constexpr inline QMargins operator-(const QMargins &margins) noexcept
0291 {
0292 return QMargins(-margins.left(), -margins.top(), -margins.right(), -margins.bottom());
0293 }
0294
0295 #ifndef QT_NO_DEBUG_STREAM
0296 Q_CORE_EXPORT QDebug operator<<(QDebug, const QMargins &);
0297 #endif
0298
0299
0300
0301
0302
0303 class QMarginsF
0304 {
0305 public:
0306 constexpr QMarginsF() noexcept;
0307 constexpr QMarginsF(qreal left, qreal top, qreal right, qreal bottom) noexcept;
0308 constexpr QMarginsF(const QMargins &margins) noexcept;
0309
0310 constexpr bool isNull() const noexcept;
0311
0312 constexpr qreal left() const noexcept;
0313 constexpr qreal top() const noexcept;
0314 constexpr qreal right() const noexcept;
0315 constexpr qreal bottom() const noexcept;
0316
0317 constexpr void setLeft(qreal aleft) noexcept;
0318 constexpr void setTop(qreal atop) noexcept;
0319 constexpr void setRight(qreal aright) noexcept;
0320 constexpr void setBottom(qreal abottom) noexcept;
0321
0322 constexpr QMarginsF &operator+=(const QMarginsF &margins) noexcept;
0323 constexpr QMarginsF &operator-=(const QMarginsF &margins) noexcept;
0324 constexpr QMarginsF &operator+=(qreal addend) noexcept;
0325 constexpr QMarginsF &operator-=(qreal subtrahend) noexcept;
0326 constexpr QMarginsF &operator*=(qreal factor) noexcept;
0327 constexpr QMarginsF &operator/=(qreal divisor);
0328
0329 constexpr inline QMargins toMargins() const noexcept;
0330
0331 private:
0332 qreal m_left;
0333 qreal m_top;
0334 qreal m_right;
0335 qreal m_bottom;
0336
0337 friend constexpr bool qFuzzyCompare(const QMarginsF &lhs, const QMarginsF &rhs) noexcept
0338 {
0339 return QtPrivate::fuzzyCompare(lhs.m_left, rhs.m_left)
0340 && QtPrivate::fuzzyCompare(lhs.m_top, rhs.m_top)
0341 && QtPrivate::fuzzyCompare(lhs.m_right, rhs.m_right)
0342 && QtPrivate::fuzzyCompare(lhs.m_bottom, rhs.m_bottom);
0343 }
0344 friend constexpr bool qFuzzyIsNull(const QMarginsF &m) noexcept
0345 {
0346 return qFuzzyIsNull(m.m_left) && qFuzzyIsNull(m.m_top)
0347 && qFuzzyIsNull(m.m_right) && qFuzzyIsNull(m.m_bottom);
0348 }
0349
0350 friend constexpr bool comparesEqual(const QMarginsF &lhs, const QMarginsF &rhs) noexcept
0351 {
0352 return qFuzzyCompare(lhs, rhs);
0353 }
0354 Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(QMarginsF)
0355
0356 friend constexpr bool comparesEqual(const QMarginsF &lhs, const QMargins &rhs) noexcept
0357 { return comparesEqual(lhs, rhs.toMarginsF()); }
0358 Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(QMarginsF, QMargins)
0359
0360 template <std::size_t I,
0361 typename M,
0362 std::enable_if_t<(I < 4), bool> = true,
0363 std::enable_if_t<std::is_same_v<q20::remove_cvref_t<M>, QMarginsF>, bool> = true>
0364 friend constexpr decltype(auto) get(M &&m) noexcept
0365 {
0366 if constexpr (I == 0)
0367 return q23::forward_like<M>(m.m_left);
0368 else if constexpr (I == 1)
0369 return q23::forward_like<M>(m.m_top);
0370 else if constexpr (I == 2)
0371 return q23::forward_like<M>(m.m_right);
0372 else if constexpr (I == 3)
0373 return q23::forward_like<M>(m.m_bottom);
0374 }
0375 };
0376
0377 Q_DECLARE_TYPEINFO(QMarginsF, Q_RELOCATABLE_TYPE);
0378
0379
0380
0381
0382
0383 #ifndef QT_NO_DATASTREAM
0384 Q_CORE_EXPORT QDataStream &operator<<(QDataStream &, const QMarginsF &);
0385 Q_CORE_EXPORT QDataStream &operator>>(QDataStream &, QMarginsF &);
0386 #endif
0387
0388
0389
0390
0391
0392 constexpr inline QMarginsF::QMarginsF() noexcept
0393 : m_left(0), m_top(0), m_right(0), m_bottom(0) {}
0394
0395 constexpr inline QMarginsF::QMarginsF(qreal aleft, qreal atop, qreal aright, qreal abottom) noexcept
0396 : m_left(aleft), m_top(atop), m_right(aright), m_bottom(abottom) {}
0397
0398 constexpr inline QMarginsF::QMarginsF(const QMargins &margins) noexcept
0399 : m_left(margins.left()), m_top(margins.top()), m_right(margins.right()), m_bottom(margins.bottom()) {}
0400
0401 constexpr inline bool QMarginsF::isNull() const noexcept
0402 { return qFuzzyIsNull(m_left) && qFuzzyIsNull(m_top) && qFuzzyIsNull(m_right) && qFuzzyIsNull(m_bottom); }
0403
0404 constexpr inline qreal QMarginsF::left() const noexcept
0405 { return m_left; }
0406
0407 constexpr inline qreal QMarginsF::top() const noexcept
0408 { return m_top; }
0409
0410 constexpr inline qreal QMarginsF::right() const noexcept
0411 { return m_right; }
0412
0413 constexpr inline qreal QMarginsF::bottom() const noexcept
0414 { return m_bottom; }
0415
0416
0417 constexpr inline void QMarginsF::setLeft(qreal aleft) noexcept
0418 { m_left = aleft; }
0419
0420 constexpr inline void QMarginsF::setTop(qreal atop) noexcept
0421 { m_top = atop; }
0422
0423 constexpr inline void QMarginsF::setRight(qreal aright) noexcept
0424 { m_right = aright; }
0425
0426 constexpr inline void QMarginsF::setBottom(qreal abottom) noexcept
0427 { m_bottom = abottom; }
0428
0429 constexpr inline QMarginsF operator+(const QMarginsF &lhs, const QMarginsF &rhs) noexcept
0430 {
0431 return QMarginsF(lhs.left() + rhs.left(), lhs.top() + rhs.top(),
0432 lhs.right() + rhs.right(), lhs.bottom() + rhs.bottom());
0433 }
0434
0435 constexpr inline QMarginsF operator-(const QMarginsF &lhs, const QMarginsF &rhs) noexcept
0436 {
0437 return QMarginsF(lhs.left() - rhs.left(), lhs.top() - rhs.top(),
0438 lhs.right() - rhs.right(), lhs.bottom() - rhs.bottom());
0439 }
0440
0441 constexpr inline QMarginsF operator+(const QMarginsF &lhs, qreal rhs) noexcept
0442 {
0443 return QMarginsF(lhs.left() + rhs, lhs.top() + rhs,
0444 lhs.right() + rhs, lhs.bottom() + rhs);
0445 }
0446
0447 constexpr inline QMarginsF operator+(qreal lhs, const QMarginsF &rhs) noexcept
0448 {
0449 return QMarginsF(rhs.left() + lhs, rhs.top() + lhs,
0450 rhs.right() + lhs, rhs.bottom() + lhs);
0451 }
0452
0453 constexpr inline QMarginsF operator-(const QMarginsF &lhs, qreal rhs) noexcept
0454 {
0455 return QMarginsF(lhs.left() - rhs, lhs.top() - rhs,
0456 lhs.right() - rhs, lhs.bottom() - rhs);
0457 }
0458
0459 constexpr inline QMarginsF operator*(const QMarginsF &lhs, qreal rhs) noexcept
0460 {
0461 return QMarginsF(lhs.left() * rhs, lhs.top() * rhs,
0462 lhs.right() * rhs, lhs.bottom() * rhs);
0463 }
0464
0465 constexpr inline QMarginsF operator*(qreal lhs, const QMarginsF &rhs) noexcept
0466 {
0467 return QMarginsF(rhs.left() * lhs, rhs.top() * lhs,
0468 rhs.right() * lhs, rhs.bottom() * lhs);
0469 }
0470
0471 constexpr inline QMarginsF operator/(const QMarginsF &lhs, qreal divisor)
0472 {
0473 Q_ASSERT(divisor < 0 || divisor > 0);
0474 return QMarginsF(lhs.left() / divisor, lhs.top() / divisor,
0475 lhs.right() / divisor, lhs.bottom() / divisor);
0476 }
0477
0478 constexpr inline QMarginsF operator|(const QMarginsF &m1, const QMarginsF &m2) noexcept
0479 {
0480 return QMarginsF(qMax(m1.left(), m2.left()), qMax(m1.top(), m2.top()),
0481 qMax(m1.right(), m2.right()), qMax(m1.bottom(), m2.bottom()));
0482 }
0483
0484 constexpr inline QMarginsF &QMarginsF::operator+=(const QMarginsF &margins) noexcept
0485 {
0486 return *this = *this + margins;
0487 }
0488
0489 constexpr inline QMarginsF &QMarginsF::operator-=(const QMarginsF &margins) noexcept
0490 {
0491 return *this = *this - margins;
0492 }
0493
0494 constexpr inline QMarginsF &QMarginsF::operator+=(qreal addend) noexcept
0495 {
0496 m_left += addend;
0497 m_top += addend;
0498 m_right += addend;
0499 m_bottom += addend;
0500 return *this;
0501 }
0502
0503 constexpr inline QMarginsF &QMarginsF::operator-=(qreal subtrahend) noexcept
0504 {
0505 m_left -= subtrahend;
0506 m_top -= subtrahend;
0507 m_right -= subtrahend;
0508 m_bottom -= subtrahend;
0509 return *this;
0510 }
0511
0512 constexpr inline QMarginsF &QMarginsF::operator*=(qreal factor) noexcept
0513 {
0514 return *this = *this * factor;
0515 }
0516
0517 constexpr inline QMarginsF &QMarginsF::operator/=(qreal divisor)
0518 {
0519 return *this = *this / divisor;
0520 }
0521
0522 constexpr inline QMarginsF operator+(const QMarginsF &margins) noexcept
0523 {
0524 return margins;
0525 }
0526
0527 constexpr inline QMarginsF operator-(const QMarginsF &margins) noexcept
0528 {
0529 return QMarginsF(-margins.left(), -margins.top(), -margins.right(), -margins.bottom());
0530 }
0531
0532 constexpr QMarginsF QMargins::toMarginsF() const noexcept { return *this; }
0533
0534 constexpr inline QMargins QMarginsF::toMargins() const noexcept
0535 {
0536 return QMargins(QtPrivate::qSaturateRound(m_left),
0537 QtPrivate::qSaturateRound(m_top),
0538 QtPrivate::qSaturateRound(m_right),
0539 QtPrivate::qSaturateRound(m_bottom));
0540 }
0541
0542 #ifndef QT_NO_DEBUG_STREAM
0543 Q_CORE_EXPORT QDebug operator<<(QDebug, const QMarginsF &);
0544 #endif
0545
0546 QT_END_NAMESPACE
0547
0548
0549
0550
0551
0552 namespace std {
0553 template <>
0554 class tuple_size<QT_PREPEND_NAMESPACE(QMargins)> : public integral_constant<size_t, 4> {};
0555 template <>
0556 class tuple_element<0, QT_PREPEND_NAMESPACE(QMargins)> { public: using type = int; };
0557 template <>
0558 class tuple_element<1, QT_PREPEND_NAMESPACE(QMargins)> { public: using type = int; };
0559 template <>
0560 class tuple_element<2, QT_PREPEND_NAMESPACE(QMargins)> { public: using type = int; };
0561 template <>
0562 class tuple_element<3, QT_PREPEND_NAMESPACE(QMargins)> { public: using type = int; };
0563
0564 template <>
0565 class tuple_size<QT_PREPEND_NAMESPACE(QMarginsF)> : public integral_constant<size_t, 4> {};
0566 template <>
0567 class tuple_element<0, QT_PREPEND_NAMESPACE(QMarginsF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
0568 template <>
0569 class tuple_element<1, QT_PREPEND_NAMESPACE(QMarginsF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
0570 template <>
0571 class tuple_element<2, QT_PREPEND_NAMESPACE(QMarginsF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
0572 template <>
0573 class tuple_element<3, QT_PREPEND_NAMESPACE(QMarginsF)> { public: using type = QT_PREPEND_NAMESPACE(qreal); };
0574 }
0575
0576 #endif