QRectF

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

Inheritance diagram of PySide6.QtCore.QRectF

Synopsis

Functions

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 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:

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.

qrect-diagram-zero3

qrectf-diagram-one4

Logical representation

One pixel wide pen

qrectf-diagram-two5

qrectf-diagram-three6

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

../../_images/qrectf-coordinates.png

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

class PySide6.QtCore.QRectF

PySide6.QtCore.QRectF(topleft, bottomRight)

PySide6.QtCore.QRectF(topleft, size)

PySide6.QtCore.QRectF(rect)

PySide6.QtCore.QRectF(QRectF)

PySide6.QtCore.QRectF(left, top, width, height)

Parameters

Constructs a null rectangle.

See also

isNull()

Constructs a QRectF rectangle from the given QRect rectangle.

See also

toRect()

Constructs a rectangle with (x, y) as its top-left corner and the given width and height.

See also

setRect()

PySide6.QtCore.QRectF.__reduce__()
Return type

object

PySide6.QtCore.QRectF.__repr__()
Return type

object

PySide6.QtCore.QRectF.adjust(x1, y1, x2, y2)
Parameters
  • x1 – float

  • y1 – float

  • x2 – float

  • y2 – float

Adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle.

PySide6.QtCore.QRectF.adjusted(x1, y1, x2, y2)
Parameters
  • x1 – float

  • y1 – float

  • x2 – float

  • y2 – float

Return type

PySide6.QtCore.QRectF

Returns a new rectangle with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of this rectangle.

See also

adjust()

PySide6.QtCore.QRectF.bottom()
Return type

float

Returns the y-coordinate of the rectangle’s bottom edge.

PySide6.QtCore.QRectF.bottomLeft()
Return type

PySide6.QtCore.QPointF

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

PySide6.QtCore.QRectF.bottomRight()
Return type

PySide6.QtCore.QPointF

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

PySide6.QtCore.QRectF.center()
Return type

PySide6.QtCore.QPointF

Returns the center point of the rectangle.

See also

moveCenter()

PySide6.QtCore.QRectF.contains(r)
Parameters

rPySide6.QtCore.QRectF

Return type

bool

PySide6.QtCore.QRectF.contains(x, y)
Parameters
  • x – float

  • y – float

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 returns false.

PySide6.QtCore.QRectF.contains(p)
Parameters

pPySide6.QtCore.QPointF

Return type

bool

PySide6.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``.

PySide6.QtCore.QRectF.getRect()

Extracts the position of the rectangle’s top-left corner to *``x`` and *``y``, and its dimensions to *``width`` and *``height``.

PySide6.QtCore.QRectF.height()
Return type

float

Returns the height of the rectangle.

PySide6.QtCore.QRectF.intersected(other)
Parameters

otherPySide6.QtCore.QRectF

Return type

PySide6.QtCore.QRectF

Returns the intersection of this rectangle and the given rectangle. Note that r.intersected(s) is equivalent to r & s.

../../_images/qrect-intersect.png

See also

intersects() united() operator&=()

PySide6.QtCore.QRectF.intersects(r)
Parameters

rPySide6.QtCore.QRectF

Return type

bool

Returns true if this rectangle intersects with the given rectangle (i.e. there is a non-empty area of overlap between them), otherwise returns false.

The intersection rectangle can be retrieved using the intersected() function.

See also

contains()

PySide6.QtCore.QRectF.isEmpty()
Return type

bool

Returns true if the rectangle is empty, otherwise returns false.

An empty rectangle has width() <= 0 or height() <= 0. An empty rectangle is not valid (i.e., == ! isValid() ).

Use the normalized() function to retrieve a rectangle where the corners are swapped.

PySide6.QtCore.QRectF.isNull()
Return type

bool

Returns true if the rectangle is a null rectangle, otherwise returns false.

A null rectangle has both the width and the height set to 0. A null rectangle is also empty, and hence not valid.

See also

isEmpty() isValid()

PySide6.QtCore.QRectF.isValid()
Return type

bool

Returns true if the rectangle is valid, otherwise returns false.

A valid rectangle has a width() > 0 and height() > 0. Note that non-trivial operations like intersections are not defined for invalid rectangles. A valid rectangle is not empty (i.e., == ! isEmpty() ).

PySide6.QtCore.QRectF.left()
Return type

float

Returns the x-coordinate of the rectangle’s left edge. Equivalent to x() .

PySide6.QtCore.QRectF.marginsAdded(margins)
Parameters

marginsPySide6.QtCore.QMarginsF

Return type

PySide6.QtCore.QRectF

Returns a rectangle grown by the margins.

See also

operator+=() marginsRemoved() operator-=()

PySide6.QtCore.QRectF.marginsRemoved(margins)
Parameters

marginsPySide6.QtCore.QMarginsF

Return type

PySide6.QtCore.QRectF

Removes the margins from the rectangle, shrinking it.

See also

marginsAdded() operator+=() operator-=()

PySide6.QtCore.QRectF.moveBottom(pos)
Parameters

pos – float

Moves the rectangle vertically, leaving the rectangle’s bottom edge at the given y coordinate. The rectangle’s size is unchanged.

PySide6.QtCore.QRectF.moveBottomLeft(p)
Parameters

pPySide6.QtCore.QPointF

Moves the rectangle, leaving the bottom-left corner at the given position. The rectangle’s size is unchanged.

PySide6.QtCore.QRectF.moveBottomRight(p)
Parameters

pPySide6.QtCore.QPointF

Moves the rectangle, leaving the bottom-right corner at the given position. The rectangle’s size is unchanged.

PySide6.QtCore.QRectF.moveCenter(p)
Parameters

pPySide6.QtCore.QPointF

Moves the rectangle, leaving the center point at the given position. The rectangle’s size is unchanged.

See also

center()

PySide6.QtCore.QRectF.moveLeft(pos)
Parameters

pos – float

Moves the rectangle horizontally, leaving the rectangle’s left edge at the given x coordinate. The rectangle’s size is unchanged.

PySide6.QtCore.QRectF.moveRight(pos)
Parameters

pos – float

Moves the rectangle horizontally, leaving the rectangle’s right edge at the given x coordinate. The rectangle’s size is unchanged.

PySide6.QtCore.QRectF.moveTo(p)
Parameters

pPySide6.QtCore.QPointF

This is an overloaded function.

Moves the rectangle, leaving the top-left corner at the given position.

PySide6.QtCore.QRectF.moveTo(x, y)
Parameters
  • x – float

  • y – float

Moves the rectangle, leaving the top-left corner at the given position (x, y). The rectangle’s size is unchanged.

PySide6.QtCore.QRectF.moveTop(pos)
Parameters

pos – float

Moves the rectangle vertically, leaving the rectangle’s top line at the given y coordinate. The rectangle’s size is unchanged.

PySide6.QtCore.QRectF.moveTopLeft(p)
Parameters

pPySide6.QtCore.QPointF

Moves the rectangle, leaving the top-left corner at the given position. The rectangle’s size is unchanged.

PySide6.QtCore.QRectF.moveTopRight(p)
Parameters

pPySide6.QtCore.QPointF

Moves the rectangle, leaving the top-right corner at the given position. The rectangle’s size is unchanged.

PySide6.QtCore.QRectF.normalized()
Return type

PySide6.QtCore.QRectF

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 if height() < 0.

See also

isValid() isEmpty()

PySide6.QtCore.QRectF.__ne__(r2)
Parameters

r2PySide6.QtCore.QRectF

Return type

bool

PySide6.QtCore.QRectF.__and__(r)
Parameters

rPySide6.QtCore.QRectF

Return type

PySide6.QtCore.QRectF

PySide6.QtCore.QRectF.__iand__(r)
Parameters

rPySide6.QtCore.QRectF

Return type

PySide6.QtCore.QRectF

PySide6.QtCore.QRectF.__add__(lhs)
Parameters

lhsPySide6.QtCore.QMarginsF

Return type

PySide6.QtCore.QRectF

PySide6.QtCore.QRectF.__add__(rhs)
Parameters

rhsPySide6.QtCore.QMarginsF

Return type

PySide6.QtCore.QRectF

PySide6.QtCore.QRectF.__iadd__(margins)
Parameters

marginsPySide6.QtCore.QMarginsF

Return type

PySide6.QtCore.QRectF

Adds the margins to the rectangle, growing it.

See also

marginsAdded() marginsRemoved() operator-=()

PySide6.QtCore.QRectF.__sub__(rhs)
Parameters

rhsPySide6.QtCore.QMarginsF

Return type

PySide6.QtCore.QRectF

PySide6.QtCore.QRectF.__isub__(margins)
Parameters

marginsPySide6.QtCore.QMarginsF

Return type

PySide6.QtCore.QRectF

Returns a rectangle shrunk by the margins.

See also

marginsRemoved() operator+=() marginsAdded()

PySide6.QtCore.QRectF.__eq__(r2)
Parameters

r2PySide6.QtCore.QRectF

Return type

bool

PySide6.QtCore.QRectF.__or__(r)
Parameters

rPySide6.QtCore.QRectF

Return type

PySide6.QtCore.QRectF

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

See also

united() operator|=()

PySide6.QtCore.QRectF.__ior__(r)
Parameters

rPySide6.QtCore.QRectF

Return type

PySide6.QtCore.QRectF

Unites this rectangle with the given rectangle.

See also

united() operator|()

PySide6.QtCore.QRectF.right()
Return type

float

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

PySide6.QtCore.QRectF.setBottom(pos)
Parameters

pos – float

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.

PySide6.QtCore.QRectF.setBottomLeft(p)
Parameters

pPySide6.QtCore.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.

PySide6.QtCore.QRectF.setBottomRight(p)
Parameters

pPySide6.QtCore.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.

PySide6.QtCore.QRectF.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).

PySide6.QtCore.QRectF.setHeight(h)
Parameters

h – float

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

See also

height() setSize()

PySide6.QtCore.QRectF.setLeft(pos)
Parameters

pos – float

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

left() moveLeft()

PySide6.QtCore.QRectF.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.

PySide6.QtCore.QRectF.setRight(pos)
Parameters

pos – float

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

right() moveRight()

PySide6.QtCore.QRectF.setSize(s)
Parameters

sPySide6.QtCore.QSizeF

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

PySide6.QtCore.QRectF.setTop(pos)
Parameters

pos – float

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

See also

top() moveTop()

PySide6.QtCore.QRectF.setTopLeft(p)
Parameters

pPySide6.QtCore.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.

PySide6.QtCore.QRectF.setTopRight(p)
Parameters

pPySide6.QtCore.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.

PySide6.QtCore.QRectF.setWidth(w)
Parameters

w – float

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

See also

width() setSize()

PySide6.QtCore.QRectF.setX(pos)
Parameters

pos – float

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

PySide6.QtCore.QRectF.setY(pos)
Parameters

pos – float

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

PySide6.QtCore.QRectF.size()
Return type

PySide6.QtCore.QSizeF

Returns the size of the rectangle.

PySide6.QtCore.QRectF.toAlignedRect()
Return type

PySide6.QtCore.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()

PySide6.QtCore.QRectF.toRect()
Return type

PySide6.QtCore.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()

PySide6.QtCore.QRectF.top()
Return type

float

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

PySide6.QtCore.QRectF.topLeft()
Return type

PySide6.QtCore.QPointF

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

PySide6.QtCore.QRectF.topRight()
Return type

PySide6.QtCore.QPointF

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

PySide6.QtCore.QRectF.translate(p)
Parameters

pPySide6.QtCore.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.

PySide6.QtCore.QRectF.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.

PySide6.QtCore.QRectF.translated(p)
Parameters

pPySide6.QtCore.QPointF

Return type

PySide6.QtCore.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.

PySide6.QtCore.QRectF.translated(dx, dy)
Parameters
  • dx – float

  • dy – float

Return type

PySide6.QtCore.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.

See also

translate()

PySide6.QtCore.QRectF.transposed()
Return type

PySide6.QtCore.QRectF

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}

See also

transposed()

PySide6.QtCore.QRectF.united(other)
Parameters

otherPySide6.QtCore.QRectF

Return type

PySide6.QtCore.QRectF

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

../../_images/qrect-unite.png

See also

intersected()

PySide6.QtCore.QRectF.width()
Return type

float

Returns the width of the rectangle.

PySide6.QtCore.QRectF.x()
Return type

float

Returns the x-coordinate of the rectangle’s left edge. Equivalent to left() .

See also

setX() y() topLeft()

PySide6.QtCore.QRectF.y()
Return type

float

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

See also

setY() x() topLeft()