Skip to content

PythonQt.Qt.QRect

QRect

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

Detailed Description

A rectangle is normally expressed as a top-left corner and a size. The size (width and height) of a QRect is always equivalent to the mathematical rectangle that forms the basis for its rendering.

A QRect can be constructed with a set of left, top, width and height integers, or from a QPoint and a QSize. The following code creates two identical rectangles.

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

There is a third constructor that creates a QRect using the top-left and bottom-right coordinates, but we recommend that you avoid using it. The rationale is that for historical reasons the values returned by the bottom() and right() functions deviate from the true bottom-right corner of the rectangle.

The QRect class provides a collection of functions that return the various rectangle coordinates, and enable manipulation of these. QRect also provides functions to move the rectangle relative to the various coordinates. In addition there is a moveTo() function that moves the rectangle, leaving its top left corner at the given coordinates. Alternatively, the translate() function moves the rectangle the given offset relative to the current position, and the translated() function returns a translated copy of this rectangle.

The size() function returns the rectangle's dimensions as a QSize. The dimensions can also be retrieved separately using the width() and height() functions. To manipulate the dimensions use the setSize(), setWidth() or setHeight() functions. Alternatively, the size can be changed by applying either of the functions setting the rectangle coordinates, for example, setBottom() or setRight().

The contains() function tells whether a given point is inside the rectangle or not, and the intersects() function returns true if this rectangle intersects with a given rectangle. The QRect class also provides the intersected() function which returns the intersection rectangle, and the united() function which returns the rectangle that encloses the given rectangle and this:

intersected() united()

The isEmpty() function returns true if left() > right() or top() > bottom(). Note that an empty rectangle is not valid: The isValid() function returns true if left() \<\= right() and top() \<\= bottom(). A null rectangle (isNull() \=\= true) on the other hand, has both width and height set to 0.

Note that due to the way QRect and QRectF are defined, an empty QRect is defined in essentially the same way as QRectF.

Finally, QRect objects can be streamed as well as compared.

Rendering

When using an anti-aliased painter, the boundary line of a QRect will be rendered symmetrically on both sides of the mathematical rectangle's boundary line. But when using an aliased painter (the default) other rules apply.

Then, when rendering with a one pixel wide pen the QRect's boundary line will be rendered to the right and below the mathematical rectangle's boundary line.

When rendering with a two pixels wide pen the boundary line will be split in the middle by the mathematical rectangle. This will be the case whenever the pen is set to an even number of pixels, while rendering with a pen with an odd number of pixels, the spare pixel will be rendered to the right and below the mathematical rectangle as in the one pixel case.

Logical representation One pixel wide pen
Two pixel wide pen Three pixel wide pen

Coordinates

The QRect class provides a collection of functions that return the various rectangle coordinates, and enable manipulation of these. QRect also provides functions to move the rectangle relative to the various coordinates.

For example the left(), setLeft() and moveLeft() functions as an example: left() returns the x-coordinate of the rectangle's left edge, setLeft() sets the left edge of the rectangle to the given x coordinate (it may change the width, but will never change the rectangle's right edge) and moveLeft() moves the entire rectangle horizontally, leaving the rectangle's left edge at the given x coordinate and its size unchanged.

Note that for historical reasons the values returned by the bottom() and right() functions deviate from the true bottom-right corner of the rectangle: The right() function returns left() + width() - 1 and the bottom() function returns top() + height() - 1. The same is the case for the point returned by the bottomRight() convenience function. In addition, the x and y coordinate of the topRight() and bottomLeft() functions, respectively, contain the same deviation from the true right and bottom edges.

We recommend that you use x() + width() and y() + height() to find the true bottom-right corner, and avoid right() and bottom(). Another solution is to use QRectF: The QRectF class defines a rectangle in the plane using floating point accuracy for coordinates, and the QRectF::right() and QRectF::bottom() functions do return the right and bottom coordinates.

It is also possible to add offsets to this rectangle's coordinates using the adjust() function, as well as retrieve a new rectangle based on adjustments of the original one using the adjusted() function. If either of the width and height is negative, use the normalized() function to retrieve a rectangle where the corners are swapped.

In addition, QRect provides the getCoords() function which extracts the position of the rectangle's top-left and bottom-right corner, and the getRect() function which extracts the rectangle's top-left corner, width and height. Use the setCoords() and setRect() function to manipulate the rectangle's coordinates and dimensions in one go.

Constraints

QRect is limited to the minimum and maximum values for the int type. Operations on a QRect that could potentially result in values outside this range will result in undefined behavior.

Source: https://doc.qt.io/archives/qt-5.15/qrect.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
adjust function (self, x1: int, y1: int, x2: int, y2: int) -> None X.adjust(x1, y1, x2, y2) (shared captured text)
adjusted function (self, x1: int, y1: int, x2: int, y2: int) -> Any X.adjusted(x1, y1, x2, y2) -> PythonQt.QtCore.QRect (shared captured text)
bottom function (self) -> int X.bottom() -> int (shared captured text)
bottomLeft function (self) -> Any X.bottomLeft() -> PythonQt.QtCore.QPoint (shared captured text)
bottomRight function (self) -> Any X.bottomRight() -> PythonQt.QtCore.QPoint (shared captured text)
center function (self) -> Any X.center() -> PythonQt.QtCore.QPoint (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
contains function (self, x: Any, y: Any, proper: Any) -> bool X.contains(x, y, proper) -> bool (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
height function (self) -> int X.height() -> int (shared captured text)
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
intersected function (self, other: Any) -> Any X.intersected(other) -> PythonQt.QtCore.QRect (shared captured text)
intersects function (self, r: Any) -> bool X.intersects(r) -> bool (shared captured text)
isEmpty function (self) -> bool X.isEmpty() -> bool (shared captured text)
isNull function (self) -> bool X.isNull() -> bool (shared captured text)
isValid function (self) -> bool X.isValid() -> bool (shared captured text)
left function (self) -> int X.left() -> int (shared captured text)
marginsAdded function (self, margins: Any) -> Any X.marginsAdded(margins) -> PythonQt.QtCore.QRect (shared captured text)
marginsRemoved function (self, margins: Any) -> Any X.marginsRemoved(margins) -> PythonQt.QtCore.QRect (shared captured text)
moveBottom function (self, pos: int) -> None Moves the rectangle vertically, leaving the rectangle's bottom edge at the given y coordinate. (shared captured text)
moveBottomLeft function (self, p: Any) -> None Moves the rectangle, leaving the bottom-left corner at the given position. (shared captured text)
moveBottomRight function (self, p: Any) -> None Moves the rectangle, leaving the bottom-right corner at the given position. (shared captured text)
moveCenter function (self, p: Any) -> None Moves the rectangle, leaving the center point at the given position. (shared captured text)
moveLeft function (self, pos: int) -> None Moves the rectangle horizontally, leaving the rectangle's left edge at the given x coordinate. (shared captured text)
moveRight function (self, pos: int) -> None Moves the rectangle horizontally, leaving the rectangle's right edge at the given x coordinate. (shared captured text)
moveTo function (self, x: Any, t: Any) -> None X.moveTo(x, t) (shared captured text)
moveTop function (self, pos: int) -> None Moves the rectangle vertically, leaving the rectangle's top edge at the given y coordinate. (shared captured text)
moveTopLeft function (self, p: Any) -> None Moves the rectangle, leaving the top-left corner at the given position. (shared captured text)
moveTopRight function (self, p: Any) -> None Moves the rectangle, leaving the top-right corner at the given position. (shared captured text)
normalized function (self) -> Any X.normalized() -> PythonQt.QtCore.QRect (shared captured text)
readFrom function (self, arg__1: Any) -> Any (shared captured text)
right function (self) -> int X.right() -> int (shared captured text)
setBottom function (self, pos: int) -> None Sets the bottom edge of the rectangle to the given y coordinate. (shared captured text)
setBottomLeft function (self, p: Any) -> None Set the bottom-left corner of the rectangle to the given position. (shared captured text)
setBottomRight function (self, p: Any) -> None Set the bottom-right corner of the rectangle to the given position. (shared captured text)
setCoords function (self, x1: int, y1: int, x2: int, y2: int) -> None X.setCoords(x1, y1, x2, y2) (shared captured text)
setHeight function (self, h: int) -> None Sets the height of the rectangle to the given height. (shared captured text)
setLeft function (self, pos: int) -> None Sets the left edge of the rectangle to the given x coordinate. (shared captured text)
setRect function (self, x: int, y: int, w: int, h: int) -> None X.setRect(x, y, w, h) (shared captured text)
setRight function (self, pos: int) -> None Sets the right edge of the rectangle to the given x coordinate. (shared captured text)
setSize function (self, s: Any) -> None Sets the size of the rectangle to the given size. (shared captured text)
setTop function (self, pos: int) -> None Sets the top edge of the rectangle to the given y coordinate. (shared captured text)
setTopLeft function (self, p: Any) -> None Set the top-left corner of the rectangle to the given position. (shared captured text)
setTopRight function (self, p: Any) -> None Set the top-right corner of the rectangle to the given position. (shared captured text)
setWidth function (self, w: int) -> None Sets the width of the rectangle to the given width. (shared captured text)
setX function (self, x: int) -> None Sets the left edge of the rectangle to the given x coordinate. (shared captured text)
setY function (self, y: int) -> None Sets the top edge of the rectangle to the given y coordinate. (shared captured text)
size function (self) -> Any X.size() -> PythonQt.QtCore.QSize (shared captured text)
top function (self) -> int X.top() -> int (shared captured text)
topLeft function (self) -> Any X.topLeft() -> PythonQt.QtCore.QPoint (shared captured text)
topRight function (self) -> Any X.topRight() -> PythonQt.QtCore.QPoint (shared captured text)
translate function (self, dx: Any, dy: Any) -> None X.translate(dx, dy) (shared captured text)
translated function (self, dx: Any, dy: Any) -> Any X.translated(dx, dy) -> PythonQt.QtCore.QRect (shared captured text)
united function (self, other: Any) -> Any X.united(other) -> PythonQt.QtCore.QRect (shared captured text)
width function (self) -> int X.width() -> int (shared captured text)
writeTo function (self, arg__1: Any) -> Any (shared captured text)
x function (self) -> int X.x() -> int (shared captured text)
y function (self) -> int X.y() -> int (shared captured text)