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