Класс QRect

Класс QRect определяет прямоугольник на плоскости с целочисленной точностью. Подробнее...

• Список всех членов, включая унаследованные
• Устаревшие члены

Примечание: Все функции в этом классе являются перевключенными.

Открытые функции

Связанные нечлены

Подробное описание

Прямоугольник обычно представляется как верхний левый угол и размер. Размер (ширина и высота) QRect всегда соответствует математическому прямоугольнику, на основе которого происходит отрисовка.

QRect можно создать с помощью набора целых чисел левой, верхней, ширины и высоты или из QPoint и QSize. Следующий код создаёт два идентичных прямоугольника.

QRect r1(100, 200, 11, 16);
QRect r2(QPoint(100, 200), QSize(11, 16));

Существует третий конструктор, который создаёт QRect, используя координаты верхнего левого и нижнего правого углов, но мы рекомендуем его избегать. Причина заключается в том, что по историческим причинам значения, возвращаемые функциями bottom() и right(), отличаются от истинного нижнего правого угла прямоугольника.

Класс QRect предоставляет набор функций, возвращающих различные координаты прямоугольника и позволяющих манипулировать ими. QRect также предоставляет функции для перемещения прямоугольника относительно различных координат. Кроме того, есть функция moveTo(), которая перемещает прямоугольник, оставляя его верхний левый угол в заданных координатах. В качестве альтернативы, функция translate() перемещает прямоугольник на заданный смещение относительно текущего положения, а функция translated() возвращает скопированный и перемещённый прямоугольник.

Функция size() возвращает размеры прямоугольника в виде QSize. Размеры также можно получить отдельно с помощью функций ширина() и высота(). Для изменения размеров используйте функции setSize(), setWidth() или setHeight(). В качестве альтернативы, размеры можно изменить, применив любую из функций, устанавливающих координаты прямоугольника, например, setBottom() или setRight().

Функция contains() показывает, находится ли заданная точка внутри прямоугольника, а функция intersects() возвращает true , если этот прямоугольник пересекается с заданным прямоугольником. Класс QRect также предоставляет функцию intersected() для возвращения прямоугольника пересечения и функцию united() для возвращения прямоугольника, содержащего данный прямоугольник и этот:

intersected()	united()

Функция isEmpty() возвращает true , если left() > right() или top() > bottom(). Обратите внимание, что пустой прямоугольник не является допустимым: функция isValid() возвращает true , если left() <= right() и top() <= bottom(). В то же время нулевой прямоугольник ( isNull() == true) имеет ширину и высоту, установленные в 0.

Обратите внимание, что из-за способа определения QRect и QRectF, пустой QRect определяется по существу таким же образом, как и QRectF.

Наконец, объекты QRect можно поточить и сравнивать.

Отображение

При использовании антиалиасного холста, граничная линия QRect будет отображаться симметрично по обе стороны от граничной линии математического прямоугольника. Но при использовании алиасного холста (по умолчанию) применяются другие правила.

Затем, при отрисовке с пером шириной один пиксель, граничная линия QRect будет отображаться справа и снизу от граничной линии математического прямоугольника.

При отрисовке с пером шириной два пикселя, граничная линия будет разделена пополам математическим прямоугольником. Это будет происходить всякий раз, когда ширина пера будет четным числом пикселей, а при отрисовке с пером нечетной ширины пиксель будет отображаться справа и снизу от математического прямоугольника, как и в случае с пером шириной один пиксель.

Логическое представление	Перо шириной один пиксель
Перо шириной два пикселя	Перо шириной три пикселя

Координаты

Класс QRect предоставляет набор функций, которые возвращают различные координаты прямоугольника и позволяют управлять ими. QRect также предоставляет функции для перемещения прямоугольника относительно различных координат.

Например, функции left(), setLeft() и moveLeft() являются примерами: left() возвращает координату x левого края прямоугольника, setLeft() устанавливает левый край прямоугольника в заданную координату x (это может изменить ширину, но никогда не изменит правый край прямоугольника), а moveLeft() перемещает весь прямоугольник по горизонтали, оставляя левый край прямоугольника в заданной координате x, а его размер неизменным.

Обратите внимание, что по историческим причинам значения, возвращаемые функциями bottom() и right(), отличаются от истинного нижнего правого угла прямоугольника: функция right() возвращает left() + width() - 1, а функция bottom() возвращает top() + height() - 1. То же самое относится к точке, возвращаемой вспомогательной функцией bottomRight(). Кроме того, координаты x и y функций topRight() и bottomLeft() соответственно содержат ту же ошибку в правом и нижнем краях.

Рекомендуется использовать x() + width() и y() + height() для поиска истинного нижнего правого угла и избегать использования right() и bottom(). Другое решение — использовать QRectF: класс QRectF определяет прямоугольник в плоскости, используя для координат плавающую точку, и функции QRectF::right() и QRectF::bottom() возвращают координаты правого и нижнего края.

Также можно добавить смещения к координатам этого прямоугольника, используя функцию adjust(), а также получить новый прямоугольник на основе изменений исходного прямоугольника, используя функцию adjusted(). Если либо ширина, либо высота отрицательны, используйте функцию normalized() для получения прямоугольника, в котором углы поменяны местами.

Кроме того, QRect предоставляет функцию getCoords() для извлечения координат левого верхнего и правого нижнего углов прямоугольника, а также функцию getRect() для извлечения левого верхнего угла, ширины и высоты прямоугольника. Используйте функции setCoords() и setRect() для одновременного изменения координат и размеров прямоугольника.

Ограничения

QRect ограничен минимальными и максимальными значениями для типа int. Операции с QRect, которые могут привести к значениям за пределами этого диапазона, приведут к неопределенному поведению.

См. также QRectF и QRegion.

Документация функций-членов

QRect::QRect(int x, int y, int width, int height)

Создает прямоугольник с (x, y) в качестве левого верхнего угла и заданной width и height.

См. также setRect().

QRect::QRect(const QPoint &topLeft, const QSize &size)

Создает прямоугольник с заданным углом topLeft и заданным размером size.

См. также setTopLeft() и setSize().

QRect::QRect(const QPoint &topLeft, const QPoint &bottomRight)

Создает прямоугольник с заданными углами topLeft и bottomRight.

См. также setTopLeft() и setBottomRight().

QRect::QRect()

Создает нулевой прямоугольник.

См. также isNull().

void QRect::adjust(int dx1, int dy1, int dx2, int dy2)

Добавляет dx1, dy1, dx2 и dy2 соответственно к существующим координатам прямоугольника.

См. также adjusted() и setRect().

QRect QRect::adjusted(int dx1, int dy1, int dx2, int dy2) const

Возвращает новый прямоугольник, к которому добавлены dx1, dy1, dx2 и dy2 соответственно к существующим координатам этого прямоугольника.

См. также adjust().

int QRect::bottom() const

Возвращает координату y нижней грани прямоугольника.

Обратите внимание, что по историческим причинам эта функция возвращает top() + height() - 1; используйте y() + height() для получения истинной координаты y.

См. также setBottom(), bottomLeft() и bottomRight().

QPoint QRect::bottomLeft() const

Возвращает координаты левого нижнего угла прямоугольника. Обратите внимание, что по историческим причинам эта функция возвращает QPoint(left(), top() + height() - 1).

См. также setBottomLeft(), bottom() и left().

QPoint QRect::bottomRight() const

Возвращает координаты правого нижнего угла прямоугольника.

Обратите внимание, что по историческим причинам эта функция возвращает QPoint(left() + width() -1, top() + height() - 1).

См. также setBottomRight(), bottom() и right().

QPoint QRect::center() const

Возвращает центральную точку прямоугольника.

См. также moveCenter().

bool QRect::contains(const QPoint &point, bool proper = false) const

Возвращает true если заданная точка point находится внутри или на границе прямоугольника, в противном случае возвращает false. Если proper равно true, эта функция возвращает true только если заданная point находится внутри прямоугольника (т.е. не на границе).

См. также intersects().

bool QRect::contains(const QRect &rectangle, bool proper = false) const

Это перегруженный метод.

Возвращает true если заданный прямоугольник rectangle находится внутри этого прямоугольника. В противном случае возвращает false. Если proper равно true, этот метод возвращает true только если прямоугольник rectangle полностью находится внутри этого прямоугольника (не на границе).

bool QRect::contains(int x, int y) const

Это перегруженный метод.

Возвращает true если точка (x, y) находится внутри этого прямоугольника, в противном случае возвращает false.

bool QRect::contains(int x, int y, bool proper) const

Это перегруженный метод.

Возвращает true если точка (x, y) находится внутри или на границе прямоугольника, в противном случае возвращает false. Если proper равно true, этот метод возвращает true только если точка полностью находится внутри прямоугольника (не на границе).

void QRect::getCoords(int *x1, int *y1, int *x2, int *y2) const

Извлекает координаты левого верхнего угла прямоугольника в *x1 и *y1, а координаты правого нижнего угла в *x2 и *y2.

См. также setCoords() и getRect().

void QRect::getRect(int *x, int *y, int *width, int *height) const

Извлекает координаты левого верхнего угла прямоугольника в *x и *y, а его размеры в *width и *height.

См. также setRect() и getCoords().

int QRect::height() const

Возвращает высоту прямоугольника.

См. также setHeight(), width() и size().

QRect QRect::intersected(const QRect &rectangle) const

Возвращает пересечение этого прямоугольника и заданного прямоугольника rectangle. Обратите внимание, что r.intersected(s) эквивалентно r & s.

Этот метод был введен в Qt 4.2.

См. также intersects(), united() и operator&=().

bool QRect::intersects(const QRect &rectangle) const

Возвращает true если этот прямоугольник пересекается с заданным прямоугольником rectangle (т.е., существует по крайней мере один пиксель, который находится внутри обоих прямоугольников), в противном случае возвращает false.

Прямоугольник пересечения можно получить с помощью метода intersected().

См. также contains().

bool QRect::isEmpty() const

Возвращает true если прямоугольник пустой, в противном случае возвращает false.

Пустой прямоугольник имеет left() > right() или top() > bottom(). Пустой прямоугольник не является допустимым (т.е., isEmpty() == !isValid()).

Используйте метод normalized() для получения прямоугольника, где углы поменяны местами.

См. также isNull(), isValid() и normalized().

bool QRect::isNull() const

Возвращает true если прямоугольник является нулевым, в противном случае возвращает false.

Нулевой прямоугольник имеет ширину и высоту, равные 0 (т.е., right() == left() - 1 и bottom() == top() - 1). Нулевой прямоугольник также пустой и, следовательно, недопустимый.

См. также isEmpty() и isValid().

bool QRect::isValid() const

Возвращает true если прямоугольник допустимый, в противном случае возвращает false.

Для корректного прямоугольника выполняется условие left() <= right() и top() <= bottom(). Обратите внимание, что для некорректных прямоугольников не определены такие операции, как пересечение.

Корректный прямоугольник не пуст (т.е., isValid() == !isEmpty()).

См. также isNull(), isEmpty() и normalized().

int QRect::left() const

Возвращает координату x левой грани прямоугольника. Эквивалентно x().

См. также setLeft(), topLeft() и bottomLeft().

QRect QRect::marginsAdded(const QMargins &margins) const

Возвращает прямоугольник, увеличенный на margins.

Эта функция была добавлена в Qt 5.1.

См. также operator+=(), marginsRemoved() и operator-=().

QRect QRect::marginsRemoved(const QMargins &margins) const

Удаляет margins из прямоугольника, уменьшая его.

Эта функция была добавлена в Qt 5.1.

См. также marginsAdded(), operator+=() и operator-=().

void QRect::moveBottom(int y)

Перемещает прямоугольник вертикально, оставляя нижнюю грань на заданной координате y. Размер прямоугольника не изменяется.

См. также bottom(), setBottom() и moveTop().

void QRect::moveBottomLeft(const QPoint &position)

Перемещает прямоугольник, оставляя нижнюю левую точку в заданной position. Размер прямоугольника не изменяется.

См. также setBottomLeft(), moveBottom() и moveLeft().

void QRect::moveBottomRight(const QPoint &position)

Перемещает прямоугольник, оставляя нижнюю правую точку в заданной position. Размер прямоугольника не изменяется.

См. также setBottomRight(), moveRight() и moveBottom().

void QRect::moveCenter(const QPoint &position)

Перемещает прямоугольник, оставляя центр в заданной position. Размер прямоугольника не изменяется.

См. также center().

void QRect::moveLeft(int x)

Перемещает прямоугольник горизонтально, оставляя левую грань на заданной координате x. Размер прямоугольника не изменяется.

См. также left(), setLeft() и moveRight().

void QRect::moveRight(int x)

Перемещает прямоугольник горизонтально, оставляя правую грань на заданной координате x. Размер прямоугольника не изменяется.

См. также right(), setRight() и moveLeft().

void QRect::moveTo(int x, int y)

Перемещает прямоугольник, оставляя верхний левый угол в заданной позиции (x, y). Размер прямоугольника не изменяется.

См. также translate() и moveTopLeft().

void QRect::moveTo(const QPoint &position)

Перемещает прямоугольник, оставляя верхний левый угол в заданной position.

void QRect::moveTop(int y)

Перемещает прямоугольник вертикально, оставляя верхнюю грань на заданной координате y. Размер прямоугольника не изменяется.

См. также top(), setTop() и moveBottom().

void QRect::moveTopLeft(const QPoint &position)

Перемещает прямоугольник, оставляя верхний левый угол в заданном положении. Размер прямоугольника не изменяется.

См. также setTopLeft(), moveTop() и moveLeft().

void QRect::moveTopRight(const QPoint &position)

Перемещает прямоугольник, оставляя верхний правый угол в заданном положении. Размер прямоугольника не изменяется.

См. также setTopRight(), moveTop() и moveRight().

QRect QRect::normalized() const

Возвращает нормализованный прямоугольник; т.е. прямоугольник с неотрицательной шириной и высотой.

Если width() < 0, функция меняет местами левую и правую вершины, а если height() < 0, меняет местами верхнюю и нижнюю вершины.

См. также isValid() и isEmpty().

int QRect::right() const

Возвращает координату x правого края прямоугольника.

Обратите внимание, что по историческим причинам эта функция возвращает left() + width() - 1; используйте x() + width() для получения истинной координаты x.

См. также setRight(), topRight() и bottomRight().

void QRect::setBottom(int y)

Устанавливает нижний край прямоугольника в заданную координату y. Может изменить высоту, но никогда не изменит верхний край прямоугольника.

См. также bottom() и moveBottom().

void QRect::setBottomLeft(const QPoint &position)

Устанавливает нижний левый угол прямоугольника в заданное position. Может изменить размер, но никогда не изменит верхний правый угол прямоугольника.

См. также bottomLeft() и moveBottomLeft().

void QRect::setBottomRight(const QPoint &position)

Устанавливает нижний правый угол прямоугольника в заданное position. Может изменить размер, но никогда не изменит верхний левый угол прямоугольника.

См. также bottomRight() и moveBottomRight().

void QRect::setCoords(int x1, int y1, int x2, int y2)

Устанавливает координаты верхнего левого угла прямоугольника в (x1, y1), а координаты его нижнего правого угла в (x2, y2).

См. также getCoords() и setRect().

void QRect::setHeight(int height)

Устанавливает высоту прямоугольника в заданную height. Нижний край изменяется, но не верхний.

См. также height() и setSize().

void QRect::setLeft(int x)

Устанавливает левый край прямоугольника в заданную координату x. Может изменить ширину, но никогда не изменит правый край прямоугольника.

Эквивалентно setX().

См. также left() и moveLeft().

void QRect::setRect(int x, int y, int width, int height)

Устанавливает координаты верхнего левого угла прямоугольника в (x, y), а его размер в заданную width и height.

См. также getRect() и setCoords().

void QRect::setRight(int x)

Устанавливает правый край прямоугольника в заданную координату x. Может изменить ширину, но никогда не изменит левый край прямоугольника.

См. также right() и moveRight().

void QRect::setSize(const QSize &size)

Устанавливает размер прямоугольника в заданный size. Верхний левый угол не перемещается.

См. также size(), setWidth() и setHeight().

void QRect::setTop(int y)

Устанавливает верхнюю границу прямоугольника в заданную координату y. Может изменить высоту, но никогда не изменит нижнюю границу прямоугольника.

Эквивалентно setY().

См. также top() и moveTop().

void QRect::setTopLeft(const QPoint &position)

Устанавливает верхний левый угол прямоугольника в заданную position. Может изменить размер, но никогда не изменит нижний правый угол прямоугольника.

См. также topLeft() и moveTopLeft().

void QRect::setTopRight(const QPoint &position)

Устанавливает верхний правый угол прямоугольника в заданную position. Может изменить размер, но никогда не изменит нижний левый угол прямоугольника.

См. также topRight() и moveTopRight().

void QRect::setWidth(int width)

Устанавливает ширину прямоугольника в заданную width. Правая граница меняется, но левая - нет.

См. также width() и setSize().

void QRect::setX(int x)

Устанавливает левую границу прямоугольника в заданную координату x. Может изменить ширину, но никогда не изменит правую границу прямоугольника.

Эквивалентно setLeft().

См. также x(), setY(), и setTopLeft().

void QRect::setY(int y)

Устанавливает верхнюю границу прямоугольника в заданную координату y. Может изменить высоту, но никогда не изменит нижнюю границу прямоугольника.

Эквивалентно setTop().

См. также y(), setX(), и setTopLeft().

QSize QRect::size() const

Возвращает размер прямоугольника.

См. также setSize(), width(), и height().

CGRect QRect::toCGRect() const

Создает CGRect из QRect.

Эта функция была добавлена в Qt 5.8.

См. также QRectF::fromCGRect().

int QRect::top() const

Возвращает координату y верхней границы прямоугольника. Эквивалентно y().

См. также setTop(), topLeft(), и topRight().

QPoint QRect::topLeft() const

Возвращает координаты верхнего левого угла прямоугольника.

См. также setTopLeft(), top(), и left().

QPoint QRect::topRight() const

Возвращает координаты верхнего правого угла прямоугольника.

Обратите внимание, что по историческим причинам эта функция возвращает QPoint(left() + width() -1, top()).

См. также setTopRight(), top(), и right().

void QRect::translate(int dx, int dy)

Перемещает прямоугольник на dx по оси x и dy по оси y относительно текущего положения. Положительные значения перемещают прямоугольник вправо и вниз.

См. также moveTopLeft(), moveTo(), и translated().

void QRect::translate(const QPoint &offset)

Это перегруженная функция.

Перемещает прямоугольник на offset.x() по оси x и offset.y() по оси y относительно текущего положения.

QRect QRect::translated(int dx, int dy) const

Возвращает копию прямоугольника, перемещённого на dx по оси x и dy по оси y относительно текущего положения. Положительные значения перемещают прямоугольник вправо и вниз.

См. также translate().

QRect QRect::translated(const QPoint &смещение) const

Это перегруженный метод.

Возвращает копию прямоугольника, сдвинутого на смещение. x() по оси X и смещение.y() по оси Y, относительно текущего положения.

QRect QRect::transposed() const

Возвращает копию прямоугольника, в котором поменяны местами ширина и высота:

QRect r = {15, 51, 42, 24};
r = r.transposed(); // r == {15, 51, 24, 42}

Этот метод был добавлен в Qt 5.7.

См. также QSize::transposed().

QRect QRect::united(const QRect &прямоугольник) const

Возвращает ограничивающий прямоугольник этого прямоугольника и заданного прямоугольника.

Этот метод был добавлен в Qt 4.2.

См. также intersected().

int QRect::width() const

Возвращает ширину прямоугольника.

См. также setWidth(), height() и size().

int QRect::x() const

Возвращает координату x левой границы прямоугольника. Эквивалентно left().

См. также setX(), y() и topLeft().

int QRect::y() const

Возвращает координату y верхней границы прямоугольника. Эквивалентно top().

См. также setY(), x() и topLeft().

QRect QRect::operator&(const QRect &прямоугольник) const

Возвращает пересечение этого прямоугольника и заданного прямоугольника. Возвращает пустой прямоугольник, если пересечения нет.

См. также operator&=() и intersected().

QRect &QRect::operator&=(const QRect &прямоугольник)

Пересекает этот прямоугольник с заданным прямоугольником.

См. также intersected() и operator&().

QRect &QRect::operator+=(const QMargins &отступы)

Добавляет отступы к прямоугольнику, расширяя его.

Этот метод был добавлен в Qt 5.1.

См. также marginsAdded(), marginsRemoved() и operator-=().

QRect &QRect::operator-=(const QMargins &отступы)

Возвращает прямоугольник, уменьшенный на отступы.

Этот метод был добавлен в Qt 5.1.

См. также marginsRemoved(), operator+=() и marginsAdded().

QRect QRect::operator|(const QRect &прямоугольник) const

Возвращает ограничивающий прямоугольник этого прямоугольника и заданного прямоугольника.

См. также operator|=() и united().

QRect &QRect::operator|=(const QRect &прямоугольник)

Объединяет этот прямоугольник с заданным прямоугольником.

См. также united() и operator|().