krect.h

Go to the documentation of this file.

/****************************************************************************
**
** This file is part of KDWinutils, KDAB's MFC to Qt migration tool.
**
** Copyright (C) 2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
** All rights reserved.
**
** This file is intended solely for use by the migration tools and services
** provided by Klarälvdalens Datakonsult AB.
**
**  Any other use or distribution of this software that is not otherwise agreed
**  upon in writing and signed by an authorized representative of Klarälvdalens
**  Datakonsult AB, KDAB (USA) LLC, KDAB (Deutschland) GmbH & Co. K.G.,
**  KDAB (France) SAS, KDAB (UK), Ltd., or any future subsidiary of Klarälvdalens
**  Datakonsult AB is hereby prohibited.
**
**  Contact info@kdab.com if any conditions stated above are unclear to you.
**
****************************************************************************/
 
#pragma once
 
#include "../kdwinutils_global.h"
 
#include <QRect>
 
#include "kpoint.h"
#include "ksize.h"
 
KDWINUTILS_BEGIN_NAMESPACE
 
class KDWINUTILS_EXPORT KRect
{
public:
    int &left = m_topLeft.x;
    int &top = m_topLeft.y;
    int &right = m_bottomRight.x;
    int &bottom = m_bottomRight.y;
 
    KRect();
    explicit KRect(int l, int t, int r, int b);
    explicit KRect(const KPoint &cp, const KSize &cs);
    explicit KRect(const KPoint &topLeft, const KPoint &bottomRight);
 
    // Rule of 5.
    // These are needed because of the presence of reference members.
    ~KRect() = default;
    KRect(const KRect &rect);
    KRect(KRect &&rect) noexcept;
    KRect &operator=(const KRect &rect);
    KRect &operator=(KRect &&rect) noexcept;
    void swap(KRect &rect) noexcept;
 
    // QRect specific methods
    /* implicit */ KRect(const QRect &qr);
    KRect &operator=(const QRect &rect);
    QRect toQRect() const;
    /* implicit */ operator QRect() const;
 
#ifdef KDWINUTILS_WITHMFC
    // CRect specific methods, available only on Windows with MFC set
    explicit KRect(const CRect &cr);
    KRect &operator=(const CRect &rect);
    CRect toCRect() const;
    /* implicit */ operator CRect() const;
#endif // KDWINUTILS_WITHMFC
 
    // MFC API from here on
 
    void operator+=(const KPoint &point);
    void operator+=(const KSize &size);
    void operator+=(const KRect &rect);
 
    void operator-=(const KPoint &point);
    void operator-=(const KSize &size);
    void operator-=(const KRect &rect);
 
    void operator&=(const KRect &rect);
 
    void operator|=(const KRect &rect);
 
    KPoint &BottomRight();
    const KPoint &BottomRight() const;
 
    KPoint CenterPoint() const;
 
    void CopyRect(const KRect *rect);
    void CopyRect(const KRect &rect);
 
    void DeflateRect(int x, int y);
    void DeflateRect(const KSize &size);
    void DeflateRect(const KRect &rect);
    void DeflateRect(int l, int t, int r, int b);
 
    bool EqualRect(const KRect *cr) const;
    bool EqualRect(const KRect &cr) const;
 
    int Height() const;
 
    void InflateRect(int x, int y);
    void InflateRect(const KSize &size);
    void InflateRect(const KRect &rect);
    void InflateRect(int l, int t, int r, int b);
 
    bool IntersectRect(const KRect *rect1, const KRect *rect2);
    bool IntersectRect(const KRect &rect1, const KRect &rect2);
 
    bool IsRectEmpty() const;
 
    bool IsRectNull() const;
 
    void MoveToX(int x);
    void MoveToY(int y);
 
    void MoveToXY(int x, int y) noexcept;
    void MoveToXY(const KPoint &point) noexcept;
 
    void NormalizeRect();
 
    void OffsetRect(int x, int y);
    void OffsetRect(const KPoint &point);
    void OffsetRect(const KSize &size);
 
    bool PtInRect(const KPoint &point) const;
 
    void SetRect(int left, int top, int right, int bottom);
 
    void SetRectEmpty();
 
    KSize Size() const;
 
    bool SubtractRect(const KRect *rectSrc1, const KRect *rectSrc2);
    bool SubtractRect(const KRect &rectSrc1, const KRect &rectSrc2);
 
    KPoint &TopLeft();
    const KPoint &TopLeft() const;
 
    void UnionRect(const KRect *rectSrc1, const KRect *rectSrc2);
    void UnionRect(const KRect &rectSrc1, const KRect &rectSrc2);
 
    int Width() const;
 
private:
    KPoint m_topLeft;
    KPoint m_bottomRight;
};
 
KDWINUTILS_EXPORT bool operator==(const KRect &lhs, const KRect &rhs) noexcept;
KDWINUTILS_EXPORT bool operator!=(const KRect &lhs, const KRect &rhs) noexcept;
 
KDWINUTILS_EXPORT KRect operator+(const KRect &lhs, const KRect &rhs);
KDWINUTILS_EXPORT KRect operator+(const KRect &lhs, const KPoint &rhs);
KDWINUTILS_EXPORT KRect operator+(const KPoint &lhs, const KRect &rhs);
KDWINUTILS_EXPORT KRect operator+(const KRect &lhs, const KSize &rhs);
KDWINUTILS_EXPORT KRect operator+(const KSize &lhs, const KRect &rhs);
 
KDWINUTILS_EXPORT KRect operator-(const KRect &lhs, const KRect &rhs);
KDWINUTILS_EXPORT KRect operator-(const KRect &lhs, const KPoint &rhs);
KDWINUTILS_EXPORT KRect operator-(const KPoint &lhs, const KRect &rhs);
KDWINUTILS_EXPORT KRect operator-(const KRect &lhs, const KSize &rhs);
KDWINUTILS_EXPORT KRect operator-(const KSize &lhs, const KRect &rhs);
 
KDWINUTILS_EXPORT KRect operator&(const KRect &lhs, const KRect &rhs);
KDWINUTILS_EXPORT KRect operator|(const KRect &lhs, const KRect &rhs);
 
KDWINUTILS_END_NAMESPACE