QRectF¶
Synopsis¶
Functions¶
def
__add__
(, rhs)def
__add__
(lhs)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)def
contains
(r)def
contains
(x, y)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, y)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
(pos)def
setY
(pos)def
size
()def
toAlignedRect
()def
toRect
()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 top-left corner and a size. The size (width and height) of a
QRectF
is always equivalent to the mathematical rectangle that forms the basis for its rendering.A
QRectF
can be constructed with a set of left, top, width and height coordinates, or from aQPointF
and aQSizeF
. The following code creates two identical rectangles.r1 = QRectF(100, 200, 11, 16) r2 = QRectF(QPoint(100, 200), QSize(11, 16))There is also a third constructor creating a
QRectF
from aQRect
, and a correspondingtoRect()
function that returns aQRect
object based on the values of this rectangle (note that the coordinates in the returned rectangle are rounded to the nearest integer).The
QRectF
class provides a collection of functions that return the various rectangle coordinates, and enable manipulation of these.QRectF
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 aQSizeF
. 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 (otherwise false). TheQRectF
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
if the rectangle’s width or height is less than, or equal to, 0. Note that an empty rectangle is not valid: TheisValid()
function returnstrue
if both width and height is larger than 0. 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 emptyQRectF
is defined in essentially the same way asQRect
.Finally,
QRectF
objects can be streamed as well as compared.
Rendering¶
When using an
anti-aliased
painter, the boundary line of aQRectF
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
QRectF
‘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
QRectF
class provides a collection of functions that return the various rectangle coordinates, and enable manipulation of these.QRectF
also provides functions to move the rectangle relative to the various coordinates.For example: the
bottom()
,setBottom()
andmoveBottom()
functions:bottom()
returns the y-coordinate of the rectangle’s bottom edge,setBottom()
sets the bottom edge of the rectangle to the given y coordinate (it may change the height, but will never change the rectangle’s top edge) andmoveBottom()
moves the entire rectangle vertically, leaving the rectangle’s bottom edge at the given y coordinate and its size unchanged.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,
QRectF
provides thegetCoords()
function which extracts the position of the rectangle’s top-left and bottom-right corner, and thegetRect()
function which extracts the rectangle’s top-left corner, width and height. Use thesetCoords()
andsetRect()
function to manipulate the rectangle’s coordinates and dimensions in one go.
-
class
QRectF
¶ Constructs a null rectangle.
See also
Constructs a
QRectF
rectangle from the givenQRect
rectangle
.See also
Constructs a rectangle with (
x
,y
) as its top-left corner and the givenwidth
andheight
.See also
-
PySide2.QtCore.QRectF.
__reduce__
()¶ - Return type
PyObject
-
PySide2.QtCore.QRectF.
__repr__
()¶ - Return type
PyObject
-
PySide2.QtCore.QRectF.
adjust
(x1, y1, x2, y2)¶ - Parameters
x1 –
qreal
y1 –
qreal
x2 –
qreal
y2 –
qreal
Adds
dx1
,dy1
,dx2
anddy2
respectively to the existing coordinates of the rectangle.See also
-
PySide2.QtCore.QRectF.
adjusted
(x1, y1, x2, y2)¶ - Parameters
x1 –
qreal
y1 –
qreal
x2 –
qreal
y2 –
qreal
- Return type
Returns a new rectangle with
dx1
,dy1
,dx2
anddy2
added respectively to the existing coordinates of this rectangle.See also
-
PySide2.QtCore.QRectF.
bottom
()¶ - Return type
qreal
Returns the y-coordinate of the rectangle’s bottom edge.
See also
-
PySide2.QtCore.QRectF.
bottomLeft
()¶ - Return type
Returns the position of the rectangle’s bottom-left corner.
See also
-
PySide2.QtCore.QRectF.
bottomRight
()¶ - Return type
Returns the position of the rectangle’s bottom-right corner.
See also
-
PySide2.QtCore.QRectF.
center
()¶ - Return type
Returns the center point of the rectangle.
See also
-
PySide2.QtCore.QRectF.
contains
(x, y) - Parameters
x –
qreal
y –
qreal
- 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
.
-
PySide2.QtCore.QRectF.
contains
(p) - Parameters
p –
QPointF
- Return type
bool
-
PySide2.QtCore.QRectF.
getCoords
()¶ Extracts the position of the rectangle’s top-left corner to *``x1`` and *``y1`` , and the position of the bottom-right corner to *``x2`` and *``y2`` .
See also
-
PySide2.QtCore.QRectF.
getRect
()¶ Extracts the position of the rectangle’s top-left corner to *``x`` and *``y`` , and its dimensions to *``width`` and *``height`` .
See also
-
PySide2.QtCore.QRectF.
height
()¶ - Return type
qreal
Returns the height of the rectangle.
See also
-
PySide2.QtCore.QRectF.
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.QRectF.
intersects
(r)¶ - Parameters
r –
QRectF
- Return type
bool
Returns
true
if this rectangle intersects with the givenrectangle
(i.e. there is a non-empty area of overlap between them), otherwise returnsfalse
.The intersection rectangle can be retrieved using the
intersected()
function.See also
-
PySide2.QtCore.QRectF.
isEmpty
()¶ - Return type
bool
Returns
true
if the rectangle is empty, otherwise returnsfalse
.An empty rectangle has
width()
<= 0 orheight()
<= 0. 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.QRectF.
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. A null rectangle is also empty, and hence not valid.
-
PySide2.QtCore.QRectF.
isValid
()¶ - Return type
bool
Returns
true
if the rectangle is valid, otherwise returnsfalse
.A valid rectangle has a
width()
> 0 andheight()
> 0. Note that non-trivial operations like intersections are not defined for invalid rectangles. A valid rectangle is not empty (i.e., == !isEmpty()
).See also
-
PySide2.QtCore.QRectF.
left
()¶ - Return type
qreal
Returns the x-coordinate of the rectangle’s left edge. Equivalent to
x()
.See also
-
PySide2.QtCore.QRectF.
marginsAdded
(margins)¶ -
Returns a rectangle grown by the
margins
.See also
operator+=()
marginsRemoved()
operator-=()
-
PySide2.QtCore.QRectF.
marginsRemoved
(margins)¶ -
Removes the
margins
from the rectangle, shrinking it.See also
marginsAdded()
operator+=()
operator-=()
-
PySide2.QtCore.QRectF.
moveBottom
(pos)¶ - Parameters
pos –
qreal
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.QRectF.
moveBottomLeft
(p)¶ - Parameters
p –
QPointF
Moves the rectangle, leaving the bottom-left corner at the given
position
. The rectangle’s size is unchanged.See also
-
PySide2.QtCore.QRectF.
moveBottomRight
(p)¶ - Parameters
p –
QPointF
Moves the rectangle, leaving the bottom-right corner at the given
position
. The rectangle’s size is unchanged.See also
-
PySide2.QtCore.QRectF.
moveCenter
(p)¶ - Parameters
p –
QPointF
Moves the rectangle, leaving the center point at the given
position
. The rectangle’s size is unchanged.See also
-
PySide2.QtCore.QRectF.
moveLeft
(pos)¶ - Parameters
pos –
qreal
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.QRectF.
moveRight
(pos)¶ - Parameters
pos –
qreal
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.QRectF.
moveTo
(p)¶ - Parameters
p –
QPointF
This is an overloaded function.
Moves the rectangle, leaving the top-left corner at the given
position
.
-
PySide2.QtCore.QRectF.
moveTo
(x, y) - Parameters
x –
qreal
y –
qreal
Moves the rectangle, leaving the top-left corner at the given position (
x
,y
). The rectangle’s size is unchanged.See also
-
PySide2.QtCore.QRectF.
moveTop
(pos)¶ - Parameters
pos –
qreal
Moves the rectangle vertically, leaving the rectangle’s top line at the given
y
coordinate. The rectangle’s size is unchanged.See also
-
PySide2.QtCore.QRectF.
moveTopLeft
(p)¶ - Parameters
p –
QPointF
Moves the rectangle, leaving the top-left corner at the given
position
. The rectangle’s size is unchanged.See also
-
PySide2.QtCore.QRectF.
moveTopRight
(p)¶ - Parameters
p –
QPointF
Moves the rectangle, leaving the top-right corner at the given
position
. The rectangle’s size is unchanged.See also
-
PySide2.QtCore.QRectF.
normalized
()¶ - Return type
Returns a normalized rectangle; i.e., a rectangle that has a non-negative 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.QRectF.
__ne__
(r2) - Parameters
r2 –
QRectF
- Return type
bool
-
PySide2.QtCore.QRectF.
__iadd__
(margins)¶ -
Adds the
margins
to the rectangle, growing it.See also
marginsAdded()
marginsRemoved()
operator-=()
-
PySide2.QtCore.QRectF.
__isub__
(margins)¶ -
Returns a rectangle shrunk by the
margins
.See also
marginsRemoved()
operator+=()
marginsAdded()
-
PySide2.QtCore.QRectF.
__eq__
(r2) - Parameters
r2 –
QRectF
- Return type
bool
-
PySide2.QtCore.QRectF.
__or__
(r)¶ -
Returns the bounding rectangle of this rectangle and the given
rectangle
.See also
united()
operator|=()
-
PySide2.QtCore.QRectF.
__ior__
(r)¶ -
Unites this rectangle with the given
rectangle
.See also
united()
operator|()
-
PySide2.QtCore.QRectF.
right
()¶ - Return type
qreal
Returns the x-coordinate of the rectangle’s right edge.
See also
-
PySide2.QtCore.QRectF.
setBottom
(pos)¶ - Parameters
pos –
qreal
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.QRectF.
setBottomLeft
(p)¶ - Parameters
p –
QPointF
Set the bottom-left corner of the rectangle to the given
position
. May change the size, but will never change the top-right corner of the rectangle.See also
-
PySide2.QtCore.QRectF.
setBottomRight
(p)¶ - Parameters
p –
QPointF
Set the bottom-right corner of the rectangle to the given
position
. May change the size, but will never change the top-left corner of the rectangle.See also
-
PySide2.QtCore.QRectF.
setCoords
(x1, y1, x2, y2)¶ - Parameters
x1 –
qreal
y1 –
qreal
x2 –
qreal
y2 –
qreal
Sets the coordinates of the rectangle’s top-left corner to (
x1
,y1
), and the coordinates of its bottom-right corner to (x2
,y2
).See also
-
PySide2.QtCore.QRectF.
setHeight
(h)¶ - Parameters
h –
qreal
Sets the height of the rectangle to the given
height
. The bottom edge is changed, but not the top one.
-
PySide2.QtCore.QRectF.
setLeft
(pos)¶ - Parameters
pos –
qreal
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.QRectF.
setRect
(x, y, w, h)¶ - Parameters
x –
qreal
y –
qreal
w –
qreal
h –
qreal
Sets the coordinates of the rectangle’s top-left corner to (
x
,y
), and its size to the givenwidth
andheight
.See also
-
PySide2.QtCore.QRectF.
setRight
(pos)¶ - Parameters
pos –
qreal
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.QRectF.
setSize
(s)¶ - Parameters
s –
QSizeF
Sets the size of the rectangle to the given
size
. The top-left corner is not moved.See also
-
PySide2.QtCore.QRectF.
setTop
(pos)¶ - Parameters
pos –
qreal
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.QRectF.
setTopLeft
(p)¶ - Parameters
p –
QPointF
Set the top-left corner of the rectangle to the given
position
. May change the size, but will never change the bottom-right corner of the rectangle.See also
-
PySide2.QtCore.QRectF.
setTopRight
(p)¶ - Parameters
p –
QPointF
Set the top-right corner of the rectangle to the given
position
. May change the size, but will never change the bottom-left corner of the rectangle.See also
-
PySide2.QtCore.QRectF.
setWidth
(w)¶ - Parameters
w –
qreal
Sets the width of the rectangle to the given
width
. The right edge is changed, but not the left one.
-
PySide2.QtCore.QRectF.
setX
(pos)¶ - Parameters
pos –
qreal
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.QRectF.
setY
(pos)¶ - Parameters
pos –
qreal
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.QRectF.
toAlignedRect
()¶ - Return type
Returns a
QRect
based on the values of this rectangle that is the smallest possible integer rectangle that completely contains this rectangle.See also
-
PySide2.QtCore.QRectF.
toRect
()¶ - Return type
Returns a
QRect
based on the values of this rectangle. Note that the coordinates in the returned rectangle are rounded to the nearest integer.See also
QRectF()
toAlignedRect()
-
PySide2.QtCore.QRectF.
top
()¶ - Return type
qreal
Returns the y-coordinate of the rectangle’s top edge. Equivalent to
y()
.See also
-
PySide2.QtCore.QRectF.
topLeft
()¶ - Return type
Returns the position of the rectangle’s top-left corner.
See also
-
PySide2.QtCore.QRectF.
topRight
()¶ - Return type
Returns the position of the rectangle’s top-right corner.
See also
-
PySide2.QtCore.QRectF.
translate
(p)¶ - Parameters
p –
QPointF
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.QRectF.
translate
(dx, dy) - Parameters
dx –
qreal
dy –
qreal
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 downwards.See also
-
PySide2.QtCore.QRectF.
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.QRectF.
translated
(dx, dy) - Parameters
dx –
qreal
dy –
qreal
- 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.QRectF.
transposed
()¶ - Return type
Returns a copy of the rectangle that has its width and height exchanged:
QRectF r = {1.5, 5.1, 4.2, 2.4}; r = r.transposed(); // r == {1.5, 5.1, 2.4, 4.2}
See also
-
PySide2.QtCore.QRectF.
united
(other)¶ -
Returns the bounding rectangle of this rectangle and the given
rectangle
.See also
-
PySide2.QtCore.QRectF.
width
()¶ - Return type
qreal
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.