PySide6.QtCore.QRectF¶

class QRectF¶

The QRectF class defines a finite rectangle in the plane using floating point precision. More…

Synopsis¶

Methods¶

def __init__()
def __reduce__()
def __repr__()
def adjust()
def adjusted()
def bottom()
def bottomLeft()
def bottomRight()
def center()
def contains()
def getCoords()
def getRect()
def height()
def intersected()
def intersects()
def isEmpty()
def isNull()
def isValid()
def left()
def marginsAdded()
def marginsRemoved()
def moveBottom()
def moveBottomLeft()
def moveBottomRight()
def moveCenter()
def moveLeft()
def moveRight()
def moveTo()
def moveTop()
def moveTopLeft()
def moveTopRight()
def normalized()
def __ne__()
def __and__()
def __iand__()
def __add__()
def __iadd__()
def __sub__()
def __isub__()
def __eq__()
def __or__()
def __ior__()
def right()
def setBottom()
def setBottomLeft()
def setBottomRight()
def setCoords()
def setHeight()
def setLeft()
def setRect()
def setRight()
def setSize()
def setTop()
def setTopLeft()
def setTopRight()
def setWidth()
def setX()
def setY()
def size()
def toAlignedRect()
def toRect()
def top()
def topLeft()
def topRight()
def translate()
def translated()
def transposed()
def united()
def width()
def x()
def y()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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 a QPointF and a QSizeF . The following code creates two identical rectangles.

r1 = QRectF(100.0, 200.1, 11.2, 16.3)
r2 = QRectF(QPointF(100.0, 200.1), QSizeF(11.2, 16.3))

There is also a third constructor creating a QRectF from a QRect , and a corresponding toRect() function that returns a QRect 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 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 QSizeF . 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 (otherwise false). The QRectF 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 the rectangle’s width or height is less than, or equal to, 0. Note that an empty rectangle is not valid: The isValid() function returns true 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 and QRectF are defined, an empty QRectF is defined in essentially the same way as QRect .

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

Rendering¶

When using an anti-aliased painter, the boundary line of a QRectF 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¶

For example: the bottom() , setBottom() and moveBottom() 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) and moveBottom() 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 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, QRectF 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.

See also

QRect QRegion

__init__()¶

Constructs a null rectangle.

See also

isNull()

__init__(rect)

Parameters:: rect – QRect

Constructs a QRectF rectangle from the given QRect rectangle.

Note

This function, like toRectF() , preserves the size() of rectangle, not its bottomRight() corner.

See also

qFuzzyCompare

__or__(r)¶

Parameters:: r – QRectF
Return type:: QRectF

Returns the bounding rectangle of this rectangle and the given rectangle.

See also

united() operator|=()

__ior__(r)¶

Parameters:: r – QRectF
Return type:: QRectF

Unites this rectangle with the given rectangle.

See also

united() operator|()

right()¶

Return type:: float

Returns the x-coordinate of the rectangle’s right edge.

See also

setRight() topRight() bottomRight()

setBottom(pos)¶

Parameters:: pos – float

Sets the bottom edge of the rectangle to the given finite y coordinate. May change the height, but will never change the top edge of the rectangle.

See also

bottom() moveBottom()

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

bottomLeft() moveBottomLeft()

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

bottomRight() moveBottomRight()

setCoords(x1, y1, x2, y2)¶

Parameters:

x1 – float
y1 – float
x2 – float
y2 – float

Sets the coordinates of the rectangle’s top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2). All parameters must be finite.

See also

getCoords() setRect()

setHeight(h)¶

Parameters:: h – float

Sets the height of the rectangle to the given finite height. The bottom edge is changed, but not the top one.

See also

height() setSize()

setLeft(pos)¶

Parameters:: pos – float

Sets the left edge of the rectangle to the given finite x coordinate. May change the width, but will never change the right edge of the rectangle.

Equivalent to setX() .

See also

left() moveLeft()

setRect(x, y, w, h)¶

Parameters:

x – float
y – float
w – float
h – float

Sets the coordinates of the rectangle’s top-left corner to (x, y), and its size to the given width and height. All parameters must be finite.

See also

getRect() setCoords()

setRight(pos)¶

Parameters:: pos – float

Sets the right edge of the rectangle to the given finite x coordinate. May change the width, but will never change the left edge of the rectangle.

See also

right() moveRight()

setSize(s)¶

Parameters:: s – QSizeF

Sets the size of the rectangle to the given finite size. The top-left corner is not moved.

See also

size() setWidth() setHeight()

setTop(pos)¶

Parameters:: pos – float

Sets the top edge of the rectangle to the given finite y coordinate. May change the height, but will never change the bottom edge of the rectangle.

Equivalent to setY() .

See also

top() moveTop()

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

topLeft() moveTopLeft()

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

topRight() moveTopRight()

setWidth(w)¶

Parameters:: w – float

Sets the width of the rectangle to the given finite width. The right edge is changed, but not the left one.

See also

width() setSize()

setX(pos)¶

Parameters:: pos – float

Sets the left edge of the rectangle to the given finite x coordinate. May change the width, but will never change the right edge of the rectangle.

Equivalent to setLeft() .

See also

x() setY() setTopLeft()

setY(pos)¶

Parameters:: pos – float

Sets the top edge of the rectangle to the given finite y coordinate. May change the height, but will never change the bottom edge of the rectangle.

Equivalent to setTop() .

See also

y() setX() setTopLeft()

size()¶

Return type:: QSizeF

Returns the size of the rectangle.

See also

setSize() width() height()

toAlignedRect()¶

Return type:: QRect

Returns a QRect based on the values of this rectangle that is the smallest possible integer rectangle that completely contains this rectangle.

See also

toRect()

toRect()¶

Return type:: QRect

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() toRectF()

top()¶

Return type:: float

Returns the y-coordinate of the rectangle’s top edge. Equivalent to y() .

See also

setTop() topLeft() topRight()

topLeft()¶

Return type:: QPointF

Returns the position of the rectangle’s top-left corner.

See also

setTopLeft() top() left()

topRight()¶

Return type:: QPointF

Returns the position of the rectangle’s top-right corner.

See also

setTopRight() top() right()

translate(p)¶

Parameters:: p – QPointF

This is an overloaded function.

Moves the rectangle offset. x() along the x axis and offset. y() along the y axis, relative to the current position.

translate(dx, dy)

Parameters:

dx – float
dy – float

Moves the rectangle dx along the x-axis and dy along the y-axis, relative to the current position. Positive values move the rectangle to the right and downwards. Both parameters must be finite.

See also

moveTopLeft() moveTo() translated()

translated(p)¶

Parameters:: p – QPointF
Return type:: QRectF

This is an overloaded function.

Returns a copy of the rectangle that is translated offset. x() along the x axis and offset. y() along the y axis, relative to the current position.

translated(dx, dy)

Parameters:

dx – float
dy – float

Return type:

QRectF

Returns a copy of the rectangle that is translated dx along the x axis and dy along the y axis, relative to the current position. Positive values move the rectangle to the right and down. Both parameters must be finite.

See also

translate()

transposed()¶

Return type:: QRectF

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns a copy of the rectangle that has its width and height exchanged:

r = {1.5, 5.1, 4.2, 2.4}
r = r.transposed() # r == {1.5, 5.1, 2.4, 4.2}


Logical representation	One pixel wide pen

Two pixel wide pen	Three pixel wide pen