QRect¶
Synopsis¶
Functions¶
def
__add__
(, margins)def
__add__
(margins)def
__and__
(r)def
__eq__
(, arg__2)def
__eq__
(, r2)def
__iadd__
(margins)def
__iand__
(r)def
__ior__
(r)def
__isub__
(margins)def
__ne__
(, arg__2)def
__ne__
(, r2)def
__or__
(r)def
__reduce__
()def
__repr__
()def
__sub__
(, rhs)def
adjust
(x1, y1, x2, y2)def
adjusted
(x1, y1, x2, y2)def
bottom
()def
bottomLeft
()def
bottomRight
()def
center
()def
contains
(p[, proper=false])def
contains
(r[, proper=false])def
contains
(x, y)def
contains
(x, y, proper)def
getCoords
()def
getRect
()def
height
()def
intersected
(other)def
intersects
(r)def
isEmpty
()def
isNull
()def
isValid
()def
left
()def
marginsAdded
(margins)def
marginsRemoved
(margins)def
moveBottom
(pos)def
moveBottomLeft
(p)def
moveBottomRight
(p)def
moveCenter
(p)def
moveLeft
(pos)def
moveRight
(pos)def
moveTo
(p)def
moveTo
(x, t)def
moveTop
(pos)def
moveTopLeft
(p)def
moveTopRight
(p)def
normalized
()def
right
()def
setBottom
(pos)def
setBottomLeft
(p)def
setBottomRight
(p)def
setCoords
(x1, y1, x2, y2)def
setHeight
(h)def
setLeft
(pos)def
setRect
(x, y, w, h)def
setRight
(pos)def
setSize
(s)def
setTop
(pos)def
setTopLeft
(p)def
setTopRight
(p)def
setWidth
(w)def
setX
(x)def
setY
(y)def
size
()def
top
()def
topLeft
()def
topRight
()def
translate
(dx, dy)def
translate
(p)def
translated
(dx, dy)def
translated
(p)def
transposed
()def
united
(other)def
width
()def
x
()def
y
()
Detailed Description¶
A rectangle is normally expressed as a topleft 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 aQPoint
and aQSize
. The following code creates two identical rectangles.r1 = QRect(100, 200, 11, 16) r2 = QRect(QPoint(100, 200), QSize(11, 16))There is a third constructor that creates a
QRect
using the topleft and bottomright coordinates, but we recommend that you avoid using it. The rationale is that for historical reasons the values returned by thebottom()
andright()
functions deviate from the true bottomright 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 amoveTo()
function that moves the rectangle, leaving its top left corner at the given coordinates. Alternatively, thetranslate()
function moves the rectangle the given offset relative to the current position, and thetranslated()
function returns a translated copy of this rectangle.The
size()
function returns the rectange’s dimensions as aQSize
. The dimensions can also be retrieved separately using thewidth()
andheight()
functions. To manipulate the dimensions use thesetSize()
,setWidth()
orsetHeight()
functions. Alternatively, the size can be changed by applying either of the functions setting the rectangle coordinates, for example,setBottom()
orsetRight()
.The
contains()
function tells whether a given point is inside the rectangle or not, and theintersects()
function returnstrue
if this rectangle intersects with a given rectangle. TheQRect
class also provides theintersected()
function which returns the intersection rectangle, and theunited()
function which returns the rectangle that encloses the given rectangle and this:
The
isEmpty()
function returnstrue
ifleft()
>right()
ortop()
>bottom()
. Note that an empty rectangle is not valid: TheisValid()
function returnstrue
ifleft()
<=right()
andtop()
<=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
andQRectF
are defined, an emptyQRect
is defined in essentially the same way asQRectF
.Finally,
QRect
objects can be streamed as well as compared.
Rendering¶
When using an
antialiased
painter, the boundary line of aQRect
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()
andmoveLeft()
functions as an example:left()
returns the xcoordinate 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) andmoveLeft()
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()
andright()
functions deviate from the true bottomright corner of the rectangle: Theright()
function returns **left()
+width()
 1 and thebottom()
function returns **top()
+height()
 1 . The same is the case for the point returned by thebottomRight()
convenience function. In addition, the x and y coordinate of thetopRight()
andbottomLeft()
functions, respectively, contain the same deviation from the true right and bottom edges.We recommend that you use
x()
+width()
andy()
+height()
to find the true bottomright corner, and avoidright()
andbottom()
. Another solution is to useQRectF
: TheQRectF
class defines a rectangle in the plane using floating point accuracy for coordinates, and theright()
andbottom()
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 theadjusted()
function. If either of the width and height is negative, use thenormalized()
function to retrieve a rectangle where the corners are swapped.In addition,
QRect
provides thegetCoords()
function which extracts the position of the rectangle’s topleft and bottomright corner, and thegetRect()
function which extracts the rectangle’s topleft corner, width and height. Use thesetCoords()
andsetRect()
function to manipulate the rectangle’s coordinates and dimensions in one go.
Constraints¶

class
QRect
¶ Constructs a null rectangle.
See also
Constructs a rectangle with (
x
,y
) as its topleft corner and the givenwidth
andheight
.See also

PySide2.QtCore.QRect.
__reduce__
()¶  Return type
PyObject

PySide2.QtCore.QRect.
__repr__
()¶  Return type
PyObject

PySide2.QtCore.QRect.
adjust
(x1, y1, x2, y2)¶  Parameters
x1 –
int
y1 –
int
x2 –
int
y2 –
int
Adds
dx1
,dy1
,dx2
anddy2
respectively to the existing coordinates of the rectangle.See also

PySide2.QtCore.QRect.
adjusted
(x1, y1, x2, y2)¶  Parameters
x1 –
int
y1 –
int
x2 –
int
y2 –
int
 Return type
Returns a new rectangle with
dx1
,dy1
,dx2
anddy2
added respectively to the existing coordinates of this rectangle.See also

PySide2.QtCore.QRect.
bottom
()¶  Return type
int
Returns the ycoordinate of the rectangle’s bottom edge.
Note that for historical reasons this function returns
top()
+height()
 1; usey()
+height()
to retrieve the true ycoordinate.See also

PySide2.QtCore.QRect.
bottomLeft
()¶  Return type
Returns the position of the rectangle’s bottomleft corner. Note that for historical reasons this function returns
QPoint
(left()
,top()
+height()
 1).See also

PySide2.QtCore.QRect.
bottomRight
()¶  Return type
Returns the position of the rectangle’s bottomright corner.
Note that for historical reasons this function returns
QPoint
(left()
+width()
1,top()
+height()
 1).See also

PySide2.QtCore.QRect.
center
()¶  Return type
Returns the center point of the rectangle.
See also

PySide2.QtCore.QRect.
contains
(r[, proper=false])¶  Parameters
r –
QRect
proper –
bool
 Return type
bool

PySide2.QtCore.QRect.
contains
(x, y, proper)  Parameters
x –
int
y –
int
proper –
bool
 Return type
bool
This is an overloaded function.
Returns
true
if the point (x
,y
) is inside or on the edge of the rectangle, otherwise returnsfalse
. Ifproper
is true, this function only returnstrue
if the point is entirely inside the rectangle(not on the edge).

PySide2.QtCore.QRect.
contains
(x, y)  Parameters
x –
int
y –
int
 Return type
bool
This is an overloaded function.
Returns
true
if the point (x
,y
) is inside this rectangle, otherwise returnsfalse
.

PySide2.QtCore.QRect.
contains
(p[, proper=false])  Parameters
p –
QPoint
proper –
bool
 Return type
bool

PySide2.QtCore.QRect.
getCoords
()¶ Extracts the position of the rectangle’s topleft corner to *``x1`` and *``y1`` , and the position of the bottomright corner to *``x2`` and *``y2`` .
See also

PySide2.QtCore.QRect.
getRect
()¶ Extracts the position of the rectangle’s topleft corner to *``x`` and *``y`` , and its dimensions to *``width`` and *``height`` .
See also

PySide2.QtCore.QRect.
height
()¶  Return type
int
Returns the height of the rectangle.
See also

PySide2.QtCore.QRect.
intersected
(other)¶ 
Returns the intersection of this rectangle and the given
rectangle
. Note thatr.intersected(s)
is equivalent tor & s
.See also
intersects()
united()
operator&=()

PySide2.QtCore.QRect.
intersects
(r)¶  Parameters
r –
QRect
 Return type
bool
Returns
true
if this rectangle intersects with the givenrectangle
(i.e., there is at least one pixel that is within both rectangles), otherwise returnsfalse
.The intersection rectangle can be retrieved using the
intersected()
function.See also

PySide2.QtCore.QRect.
isEmpty
()¶  Return type
bool
Returns
true
if the rectangle is empty, otherwise returnsfalse
.An empty rectangle has a
left()
>right()
ortop()
>bottom()
. An empty rectangle is not valid (i.e., == !isValid()
).Use the
normalized()
function to retrieve a rectangle where the corners are swapped.See also

PySide2.QtCore.QRect.
isNull
()¶  Return type
bool
Returns
true
if the rectangle is a null rectangle, otherwise returnsfalse
.A null rectangle has both the width and the height set to 0 (i.e.,
right()
==left()
 1 andbottom()
==top()
 1). A null rectangle is also empty, and hence is not valid.

PySide2.QtCore.QRect.
isValid
()¶  Return type
bool
Returns
true
if the rectangle is valid, otherwise returnsfalse
.A valid rectangle has a
left()
<=right()
andtop()
<=bottom()
. Note that nontrivial operations like intersections are not defined for invalid rectangles. A valid rectangle is not empty (i.e., == !isEmpty()
).See also

PySide2.QtCore.QRect.
left
()¶  Return type
int
Returns the xcoordinate of the rectangle’s left edge. Equivalent to
x()
.See also

PySide2.QtCore.QRect.
marginsAdded
(margins)¶ 
Returns a rectangle grown by the
margins
.See also
operator+=()
marginsRemoved()
operator=()

PySide2.QtCore.QRect.
marginsRemoved
(margins)¶ 
Removes the
margins
from the rectangle, shrinking it.See also
marginsAdded()
operator+=()
operator=()

PySide2.QtCore.QRect.
moveBottom
(pos)¶  Parameters
pos –
int
Moves the rectangle vertically, leaving the rectangle’s bottom edge at the given
y
coordinate. The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
moveBottomLeft
(p)¶  Parameters
p –
QPoint
Moves the rectangle, leaving the bottomleft corner at the given
position
. The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
moveBottomRight
(p)¶  Parameters
p –
QPoint
Moves the rectangle, leaving the bottomright corner at the given
position
. The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
moveCenter
(p)¶  Parameters
p –
QPoint
Moves the rectangle, leaving the center point at the given
position
. The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
moveLeft
(pos)¶  Parameters
pos –
int
Moves the rectangle horizontally, leaving the rectangle’s left edge at the given
x
coordinate. The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
moveRight
(pos)¶  Parameters
pos –
int
Moves the rectangle horizontally, leaving the rectangle’s right edge at the given
x
coordinate. The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
moveTo
(p)¶  Parameters
p –
QPoint
Moves the rectangle, leaving the topleft corner at the given
position
.

PySide2.QtCore.QRect.
moveTo
(x, t)  Parameters
x –
int
t –
int
Moves the rectangle, leaving the topleft corner at the given position (
x
,y
). The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
moveTop
(pos)¶  Parameters
pos –
int
Moves the rectangle vertically, leaving the rectangle’s top edge at the given
y
coordinate. The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
moveTopLeft
(p)¶  Parameters
p –
QPoint
Moves the rectangle, leaving the topleft corner at the given
position
. The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
moveTopRight
(p)¶  Parameters
p –
QPoint
Moves the rectangle, leaving the topright corner at the given
position
. The rectangle’s size is unchanged.See also

PySide2.QtCore.QRect.
normalized
()¶  Return type
Returns a normalized rectangle; i.e., a rectangle that has a nonnegative width and height.
If
width()
< 0 the function swaps the left and right corners, and it swaps the top and bottom corners ifheight()
< 0.

PySide2.QtCore.QRect.
__ne__
(arg__2)  Parameters
arg__2 –
QRect
 Return type
bool

PySide2.QtCore.QRect.
__iadd__
(margins)¶ 
Adds the
margins
to the rectangle, growing it.See also
marginsAdded()
marginsRemoved()
operator=()

PySide2.QtCore.QRect.
__isub__
(margins)¶ 
Returns a rectangle shrunk by the
margins
.See also
marginsRemoved()
operator+=()
marginsAdded()

PySide2.QtCore.QRect.
__eq__
(r2)  Parameters
r2 –
QRect
 Return type
bool

PySide2.QtCore.QRect.
__or__
(r)¶ 
Returns the bounding rectangle of this rectangle and the given
rectangle
.See also
operator=()
united()

PySide2.QtCore.QRect.
__ior__
(r)¶ 
Unites this rectangle with the given
rectangle
.See also
united()
operator()

PySide2.QtCore.QRect.
right
()¶  Return type
int
Returns the xcoordinate of the rectangle’s right edge.
Note that for historical reasons this function returns
left()
+width()
 1; usex()
+width()
to retrieve the true xcoordinate.See also

PySide2.QtCore.QRect.
setBottom
(pos)¶  Parameters
pos –
int
Sets the bottom edge of the rectangle to the given
y
coordinate. May change the height, but will never change the top edge of the rectangle.See also

PySide2.QtCore.QRect.
setBottomLeft
(p)¶  Parameters
p –
QPoint
Set the bottomleft corner of the rectangle to the given
position
. May change the size, but will never change the topright corner of the rectangle.See also

PySide2.QtCore.QRect.
setBottomRight
(p)¶  Parameters
p –
QPoint
Set the bottomright corner of the rectangle to the given
position
. May change the size, but will never change the topleft corner of the rectangle.See also

PySide2.QtCore.QRect.
setCoords
(x1, y1, x2, y2)¶  Parameters
x1 –
int
y1 –
int
x2 –
int
y2 –
int
Sets the coordinates of the rectangle’s topleft corner to (
x1
,y1
), and the coordinates of its bottomright corner to (x2
,y2
).See also

PySide2.QtCore.QRect.
setHeight
(h)¶  Parameters
h –
int
Sets the height of the rectangle to the given
height
. The bottom edge is changed, but not the top one.

PySide2.QtCore.QRect.
setLeft
(pos)¶  Parameters
pos –
int
Sets the left edge of the rectangle to the given
x
coordinate. May change the width, but will never change the right edge of the rectangle.Equivalent to
setX()
.See also

PySide2.QtCore.QRect.
setRect
(x, y, w, h)¶  Parameters
x –
int
y –
int
w –
int
h –
int
Sets the coordinates of the rectangle’s topleft corner to (
x
,y
), and its size to the givenwidth
andheight
.See also

PySide2.QtCore.QRect.
setRight
(pos)¶  Parameters
pos –
int
Sets the right edge of the rectangle to the given
x
coordinate. May change the width, but will never change the left edge of the rectangle.See also

PySide2.QtCore.QRect.
setSize
(s)¶  Parameters
s –
QSize
Sets the size of the rectangle to the given
size
. The topleft corner is not moved.See also

PySide2.QtCore.QRect.
setTop
(pos)¶  Parameters
pos –
int
Sets the top edge of the rectangle to the given
y
coordinate. May change the height, but will never change the bottom edge of the rectangle.Equivalent to
setY()
.

PySide2.QtCore.QRect.
setTopLeft
(p)¶  Parameters
p –
QPoint
Set the topleft corner of the rectangle to the given
position
. May change the size, but will never change the bottomright corner of the rectangle.See also

PySide2.QtCore.QRect.
setTopRight
(p)¶  Parameters
p –
QPoint
Set the topright corner of the rectangle to the given
position
. May change the size, but will never change the bottomleft corner of the rectangle.See also

PySide2.QtCore.QRect.
setWidth
(w)¶  Parameters
w –
int
Sets the width of the rectangle to the given
width
. The right edge is changed, but not the left one.

PySide2.QtCore.QRect.
setX
(x)¶  Parameters
x –
int
Sets the left edge of the rectangle to the given
x
coordinate. May change the width, but will never change the right edge of the rectangle.Equivalent to
setLeft()
.See also

PySide2.QtCore.QRect.
setY
(y)¶  Parameters
y –
int
Sets the top edge of the rectangle to the given
y
coordinate. May change the height, but will never change the bottom edge of the rectangle.Equivalent to
setTop()
.See also

PySide2.QtCore.QRect.
top
()¶  Return type
int
Returns the ycoordinate of the rectangle’s top edge. Equivalent to
y()
.See also

PySide2.QtCore.QRect.
topLeft
()¶  Return type
Returns the position of the rectangle’s topleft corner.
See also

PySide2.QtCore.QRect.
topRight
()¶  Return type
Returns the position of the rectangle’s topright corner.
Note that for historical reasons this function returns
QPoint
(left()
+width()
1,top()
).See also

PySide2.QtCore.QRect.
translate
(p)¶  Parameters
p –
QPoint
This is an overloaded function.
Moves the rectangle
offset
.x()
along the x axis andoffset
.y()
along the y axis, relative to the current position.

PySide2.QtCore.QRect.
translate
(dx, dy)  Parameters
dx –
int
dy –
int
Moves the rectangle
dx
along the x axis anddy
along the y axis, relative to the current position. Positive values move the rectangle to the right and down.See also

PySide2.QtCore.QRect.
translated
(p)¶ 
This is an overloaded function.
Returns a copy of the rectangle that is translated
offset
.x()
along the x axis andoffset
.y()
along the y axis, relative to the current position.

PySide2.QtCore.QRect.
translated
(dx, dy)  Parameters
dx –
int
dy –
int
 Return type
Returns a copy of the rectangle that is translated
dx
along the x axis anddy
along the y axis, relative to the current position. Positive values move the rectangle to the right and down.See also

PySide2.QtCore.QRect.
transposed
()¶  Return type
Returns a copy of the rectangle that has its width and height exchanged:
QRect r = {15, 51, 42, 24}; r = r.transposed(); // r == {15, 51, 24, 42}
See also

PySide2.QtCore.QRect.
united
(other)¶ 
Returns the bounding rectangle of this rectangle and the given
rectangle
.See also

PySide2.QtCore.QRect.
width
()¶  Return type
int
Returns the width of the rectangle.
See also
© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.