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

#include <qrect.h>

Public Member Functions
constexpr	QRectF () noexcept

constexpr	QRectF (const QPointF &topleft, const QSizeF &size) noexcept

constexpr	QRectF (const QPointF &topleft, const QPointF &bottomRight) noexcept

constexpr	QRectF (qreal left, qreal top, qreal width, qreal height) noexcept

constexpr	QRectF (const QRect &rect) noexcept

constexpr bool	isNull () const noexcept

constexpr bool	isEmpty () const noexcept

constexpr bool	isValid () const noexcept

QRectF	normalized () const noexcept

constexpr qreal	left () const noexcept

constexpr qreal	top () const noexcept

constexpr qreal	right () const noexcept

constexpr qreal	bottom () const noexcept

constexpr qreal	x () const noexcept

constexpr qreal	y () const noexcept

constexpr void	setLeft (qreal pos) noexcept

constexpr void	setTop (qreal pos) noexcept

constexpr void	setRight (qreal pos) noexcept

constexpr void	setBottom (qreal pos) noexcept

constexpr void	setX (qreal pos) noexcept

constexpr void	setY (qreal pos) noexcept

constexpr QPointF	topLeft () const noexcept

constexpr QPointF	bottomRight () const noexcept

constexpr QPointF	topRight () const noexcept

constexpr QPointF	bottomLeft () const noexcept

constexpr QPointF	center () const noexcept

constexpr void	setTopLeft (const QPointF &p) noexcept

constexpr void	setBottomRight (const QPointF &p) noexcept

constexpr void	setTopRight (const QPointF &p) noexcept

constexpr void	setBottomLeft (const QPointF &p) noexcept

constexpr void	moveLeft (qreal pos) noexcept

constexpr void	moveTop (qreal pos) noexcept

constexpr void	moveRight (qreal pos) noexcept

constexpr void	moveBottom (qreal pos) noexcept

constexpr void	moveTopLeft (const QPointF &p) noexcept

constexpr void	moveBottomRight (const QPointF &p) noexcept

constexpr void	moveTopRight (const QPointF &p) noexcept

constexpr void	moveBottomLeft (const QPointF &p) noexcept

constexpr void	moveCenter (const QPointF &p) noexcept

constexpr void	translate (qreal dx, qreal dy) noexcept

constexpr void	translate (const QPointF &p) noexcept

constexpr QRectF	translated (qreal dx, qreal dy) const noexcept

constexpr QRectF	translated (const QPointF &p) const noexcept

constexpr QRectF	transposed () const noexcept

constexpr void	moveTo (qreal x, qreal y) noexcept

constexpr void	moveTo (const QPointF &p) noexcept

constexpr void	setRect (qreal x, qreal y, qreal w, qreal h) noexcept

constexpr void	getRect (qreal x, qreal y, qreal w, qreal h) const

constexpr void	setCoords (qreal x1, qreal y1, qreal x2, qreal y2) noexcept

constexpr void	getCoords (qreal x1, qreal y1, qreal x2, qreal y2) const

constexpr void	adjust (qreal x1, qreal y1, qreal x2, qreal y2) noexcept

constexpr QRectF	adjusted (qreal x1, qreal y1, qreal x2, qreal y2) const noexcept

constexpr QSizeF	size () const noexcept

constexpr qreal	width () const noexcept

constexpr qreal	height () const noexcept

constexpr void	setWidth (qreal w) noexcept

constexpr void	setHeight (qreal h) noexcept

constexpr void	setSize (const QSizeF &s) noexcept

QRectF	operator\| (const QRectF &r) const noexcept

QRectF	operator& (const QRectF &r) const noexcept

QRectF &	operator\|= (const QRectF &r) noexcept

QRectF &	operator&= (const QRectF &r) noexcept

bool	contains (const QRectF &r) const noexcept

bool	contains (const QPointF &p) const noexcept

bool	contains (qreal x, qreal y) const noexcept

QRectF	united (const QRectF &other) const noexcept

QRectF	intersected (const QRectF &other) const noexcept

bool	intersects (const QRectF &r) const noexcept

constexpr QRectF	marginsAdded (const QMarginsF &margins) const noexcept

constexpr QRectF	marginsRemoved (const QMarginsF &margins) const noexcept

constexpr QRectF &	operator+= (const QMarginsF &margins) noexcept

constexpr QRectF &	operator-= (const QMarginsF &margins) noexcept

constexpr QRect	toRect () const noexcept

QRect	toAlignedRect () const noexcept

Friends
constexpr friend bool	operator== (const QRectF &r1, const QRectF &r2) noexcept

constexpr friend bool	operator!= (const QRectF &r1, const QRectF &r2) noexcept

Related Functions
(Note that these are not member functions.)
QRectF	operator+ (const QRectF &lhs, const QMarginsF &rhs)

QRectF	operator- (const QRectF &lhs, const QMarginsF &rhs)

QRectF	operator+ (const QMarginsF &lhs, const QRectF &rhs)

QDataStream &	operator<< (QDataStream &stream, const QRectF &rectangle)

QDataStream &	operator>> (QDataStream &stream, QRectF &rectangle)

Detailed Description

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

\inmodule QtCore

\reentrant

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.

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:

\table \row

\inlineimage qrect-intersect.png
\inlineimage qrect-unite.png \row
intersected()
united() \endtable

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.

Definition at line 510 of file qrect.h.

Constructor & Destructor Documentation

◆ QRectF() [1/5]

QRectF::QRectF ( )

inlineconstexprnoexcept

Constructs a null rectangle.

See also: isNull()

Definition at line 513 of file qrect.h.

Here is the caller graph for this function:

◆ QRectF() [2/5]

constexpr QRectF::QRectF	(	const QPointF &	topLeft,
		const QSizeF &	size
	)

inlineconstexprnoexcept

Constructs a rectangle with the given topLeft corner and the given size.

See also: setTopLeft(), setSize()

Definition at line 648 of file qrect.h.

◆ QRectF() [3/5]

constexpr QRectF::QRectF	(	const QPointF &	topLeft,
		const QPointF &	bottomRight
	)

inlineconstexprnoexcept

Since: 4.3

Constructs a rectangle with the given topLeft and bottomRight corners.

See also: setTopLeft(), setBottomRight()

Definition at line 654 of file qrect.h.

◆ QRectF() [4/5]

constexpr QRectF::QRectF	(	qreal	x,
		qreal	y,
		qreal	width,
		qreal	height
	)

inlineconstexprnoexcept

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

See also: setRect()

Definition at line 643 of file qrect.h.

◆ QRectF() [5/5]

constexpr QRectF::QRectF ( const QRect & rectangle )

inlineconstexprnoexcept

Constructs a QRectF rectangle from the given QRect rectangle.

See also: toRect()

Definition at line 659 of file qrect.h.

Member Function Documentation

◆ adjust()

constexpr void QRectF::adjust	(	qreal	dx1,
		qreal	dy1,
		qreal	dx2,
		qreal	dy2
	)

inlineconstexprnoexcept

Adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle. All parameters must be finite.

See also: adjusted(), setRect()

Definition at line 814 of file qrect.h.

Here is the caller graph for this function:

◆ adjusted()

constexpr QRectF QRectF::adjusted	(	qreal	dx1,
		qreal	dy1,
		qreal	dx2,
		qreal	dy2
	)		const

inlineconstexprnoexcept

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

See also: adjust()

Definition at line 822 of file qrect.h.

Here is the caller graph for this function:

◆ bottom()

qreal QRectF::bottom ( ) const

inlineconstexprnoexcept

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

See also: setBottom(), bottomLeft(), bottomRight()

Definition at line 527 of file qrect.h.

Here is the caller graph for this function:

◆ bottomLeft()

QPointF QRectF::bottomLeft ( ) const

inlineconstexprnoexcept

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

See also: setBottomLeft(), bottom(), left()

Definition at line 541 of file qrect.h.

◆ bottomRight()

QPointF QRectF::bottomRight ( ) const

inlineconstexprnoexcept

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

See also: setBottomRight(), bottom(), right()

Definition at line 539 of file qrect.h.

Here is the caller graph for this function:

◆ center()

constexpr QPointF QRectF::center ( ) const

inlineconstexprnoexcept

Returns the center point of the rectangle.

See also: moveCenter()

Definition at line 708 of file qrect.h.

Here is the caller graph for this function:

◆ contains() [1/3]

bool QRectF::contains ( const QPointF & point ) const

noexcept

Returns true if the given point is inside or on the edge of the rectangle; otherwise returns false.

See also: intersects()

Definition at line 1960 of file qrect.cpp.

◆ contains() [2/3]

bool QRectF::contains ( const QRectF & rectangle ) const

noexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns true if the given rectangle is inside this rectangle; otherwise returns false.

Definition at line 2006 of file qrect.cpp.

Here is the caller graph for this function:

◆ contains() [3/3]

bool QRectF::contains	(	qreal	x,
		qreal	y
	)		const

inlinenoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns true if the point (x, y) is inside or on the edge of the rectangle; otherwise returns false.

Definition at line 839 of file qrect.h.

Here is the call graph for this function:

◆ getCoords()

constexpr void QRectF::getCoords	(	qreal *	x1,
		qreal *	y1,
		qreal *	x2,
		qreal *	y2
	)		const

inlineconstexpr

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: setCoords(), getRect()

Definition at line 798 of file qrect.h.

◆ getRect()

constexpr void QRectF::getRect	(	qreal *	x,
		qreal *	y,
		qreal *	width,
		qreal *	height
	)		const

inlineconstexpr

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

See also: setRect(), getCoords()

Definition at line 782 of file qrect.h.

◆ height()

constexpr qreal QRectF::height ( ) const

inlineconstexprnoexcept

Returns the height of the rectangle.

See also: setHeight(), width(), size()

Definition at line 741 of file qrect.h.

Here is the caller graph for this function:

◆ intersected()

QRectF QRectF::intersected ( const QRectF & rectangle ) const

inlinenoexcept

Since: 4.2

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

See also: intersects(), united(), operator&=()

Definition at line 856 of file qrect.h.

Here is the caller graph for this function:

◆ intersects()

bool QRectF::intersects ( const QRectF & rectangle ) const

noexcept

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

Definition at line 2284 of file qrect.cpp.

Here is the caller graph for this function:

◆ isEmpty()

constexpr bool QRectF::isEmpty ( ) const

inlineconstexprnoexcept

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., isEmpty() == !isValid()).

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

See also: isNull(), isValid(), normalized()

Definition at line 670 of file qrect.h.

Here is the caller graph for this function:

◆ isNull()

QT_WARNING_PUSH constexpr QT_WARNING_DISABLE_FLOAT_COMPARE bool QRectF::isNull ( ) const

inlineconstexprnoexcept

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

Definition at line 667 of file qrect.h.

Here is the caller graph for this function:

◆ isValid()

constexpr QT_WARNING_POP bool QRectF::isValid ( ) const

inlineconstexprnoexcept

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., isValid() == !isEmpty()).

See also: isNull(), isEmpty(), normalized()

Definition at line 675 of file qrect.h.

Here is the caller graph for this function:

◆ left()

qreal QRectF::left ( ) const

inlineconstexprnoexcept

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

See also: setLeft(), topLeft(), bottomLeft()

Definition at line 524 of file qrect.h.

Here is the caller graph for this function:

◆ marginsAdded()

constexpr QRectF QRectF::marginsAdded ( const QMarginsF & margins ) const

inlineconstexprnoexcept

Since: 5.3

Returns a rectangle grown by the margins.

See also: operator+=(), marginsRemoved(), operator-=()

Definition at line 896 of file qrect.h.

◆ marginsRemoved()

constexpr QRectF QRectF::marginsRemoved ( const QMarginsF & margins ) const

inlineconstexprnoexcept

Since: 5.3

Removes the margins from the rectangle, shrinking it.

See also: marginsAdded(), operator+=(), operator-=()

Definition at line 902 of file qrect.h.

◆ moveBottom()

constexpr void QRectF::moveBottom ( qreal y )

inlineconstexprnoexcept

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

See also: bottom(), setBottom(), moveTop()

Definition at line 720 of file qrect.h.

◆ moveBottomLeft()

constexpr void QRectF::moveBottomLeft ( const QPointF & position )

inlineconstexprnoexcept

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

See also: setBottomLeft(), moveBottom(), moveLeft()

Definition at line 729 of file qrect.h.

◆ moveBottomRight()

constexpr void QRectF::moveBottomRight ( const QPointF & position )

inlineconstexprnoexcept

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

See also: setBottomRight(), moveBottom(), moveRight()

Definition at line 732 of file qrect.h.

◆ moveCenter()

constexpr void QRectF::moveCenter ( const QPointF & position )

inlineconstexprnoexcept

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

See also: center()

Definition at line 735 of file qrect.h.

Here is the caller graph for this function:

◆ moveLeft()

constexpr void QRectF::moveLeft ( qreal x )

inlineconstexprnoexcept

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

See also: left(), setLeft(), moveRight()

Definition at line 711 of file qrect.h.

Here is the caller graph for this function:

◆ moveRight()

constexpr void QRectF::moveRight ( qreal x )

inlineconstexprnoexcept

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

See also: right(), setRight(), moveLeft()

Definition at line 717 of file qrect.h.

◆ moveTo() [1/2]

constexpr void QRectF::moveTo ( const QPointF & position )

inlineconstexprnoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

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

Definition at line 765 of file qrect.h.

◆ moveTo() [2/2]

constexpr void QRectF::moveTo	(	qreal	x,
		qreal	y
	)

inlineconstexprnoexcept

Moves the rectangle, leaving the top-left corner at the given position (x, y). The rectangle's size is unchanged. Both parameters must be finite.

See also: translate(), moveTopLeft()

Definition at line 759 of file qrect.h.

Here is the caller graph for this function:

◆ moveTop()

constexpr void QRectF::moveTop ( qreal y )

inlineconstexprnoexcept

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

See also: top(), setTop(), moveBottom()

Definition at line 714 of file qrect.h.

Here is the caller graph for this function:

◆ moveTopLeft()

constexpr void QRectF::moveTopLeft ( const QPointF & position )

inlineconstexprnoexcept

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

See also: setTopLeft(), moveTop(), moveLeft()

Definition at line 723 of file qrect.h.

Here is the caller graph for this function:

◆ moveTopRight()

constexpr void QRectF::moveTopRight ( const QPointF & position )

inlineconstexprnoexcept

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

See also: setTopRight(), moveTop(), moveRight()

Definition at line 726 of file qrect.h.

◆ normalized()

QRectF QRectF::normalized ( ) const

noexcept

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

Definition at line 1535 of file qrect.cpp.

Here is the caller graph for this function:

◆ operator&()

QRectF QRectF::operator& ( const QRectF & rectangle ) const

noexcept

Returns the intersection of this rectangle and the given rectangle. Returns an empty rectangle if there is no intersection.

See also: operator&=(), intersected()

Definition at line 2206 of file qrect.cpp.

◆ operator&=()

QRectF & QRectF::operator&= ( const QRectF & rectangle )

inlinenoexcept

Intersects this rectangle with the given rectangle.

See also: intersected(), operator&()

Definition at line 850 of file qrect.h.

◆ operator+=()

constexpr QRectF & QRectF::operator+= ( const QMarginsF & margins )

inlineconstexprnoexcept

Since: 5.3

Adds the margins to the rectangle, growing it.

See also: marginsAdded(), marginsRemoved(), operator-=()

Definition at line 908 of file qrect.h.

◆ operator-=()

constexpr QRectF & QRectF::operator-= ( const QMarginsF & margins )

inlineconstexprnoexcept

Since: 5.3

Returns a rectangle shrunk by the margins.

See also: marginsRemoved(), operator+=(), marginsAdded()

Definition at line 914 of file qrect.h.

◆ operator|()

QRectF QRectF::operator| ( const QRectF & rectangle ) const

noexcept

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

See also: united(), operator|=()

Definition at line 2144 of file qrect.cpp.

◆ operator|=()

QRectF & QRectF::operator|= ( const QRectF & rectangle )

inlinenoexcept

Unites this rectangle with the given rectangle.

See also: united(), operator|()

Definition at line 844 of file qrect.h.

◆ right()

qreal QRectF::right ( ) const

inlineconstexprnoexcept

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

See also: setRight(), topRight(), bottomRight()

Definition at line 526 of file qrect.h.

Here is the caller graph for this function:

◆ setBottom()

constexpr void QRectF::setBottom ( qreal y )

inlineconstexprnoexcept

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

Definition at line 693 of file qrect.h.

Here is the caller graph for this function:

◆ setBottomLeft()

constexpr void QRectF::setBottomLeft ( const QPointF & position )

inlineconstexprnoexcept

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

Definition at line 702 of file qrect.h.

◆ setBottomRight()

constexpr void QRectF::setBottomRight ( const QPointF & position )

inlineconstexprnoexcept

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

Definition at line 705 of file qrect.h.

◆ setCoords()

constexpr void QRectF::setCoords	(	qreal	x1,
		qreal	y1,
		qreal	x2,
		qreal	y2
	)

inlineconstexprnoexcept

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

Definition at line 806 of file qrect.h.

◆ setHeight()

constexpr void QRectF::setHeight ( qreal height )

inlineconstexprnoexcept

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

Definition at line 830 of file qrect.h.

Here is the caller graph for this function:

◆ setLeft()

constexpr void QRectF::setLeft ( qreal x )

inlineconstexprnoexcept

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

Definition at line 684 of file qrect.h.

Here is the caller graph for this function:

◆ setRect()

constexpr void QRectF::setRect	(	qreal	x,
		qreal	y,
		qreal	width,
		qreal	height
	)

inlineconstexprnoexcept

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

Definition at line 790 of file qrect.h.

Here is the caller graph for this function:

◆ setRight()

constexpr void QRectF::setRight ( qreal x )

inlineconstexprnoexcept

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

Definition at line 687 of file qrect.h.

Here is the caller graph for this function:

◆ setSize()

constexpr void QRectF::setSize ( const QSizeF & size )

inlineconstexprnoexcept

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

See also: size(), setWidth(), setHeight()

Definition at line 833 of file qrect.h.

Here is the caller graph for this function:

◆ setTop()

constexpr void QRectF::setTop ( qreal y )

inlineconstexprnoexcept

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

Definition at line 690 of file qrect.h.

Here is the caller graph for this function:

◆ setTopLeft()

constexpr void QRectF::setTopLeft ( const QPointF & position )

inlineconstexprnoexcept

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

Definition at line 696 of file qrect.h.

◆ setTopRight()

constexpr void QRectF::setTopRight ( const QPointF & position )

inlineconstexprnoexcept

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

Definition at line 699 of file qrect.h.

◆ setWidth()

constexpr void QRectF::setWidth ( qreal width )

inlineconstexprnoexcept

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

Definition at line 827 of file qrect.h.

Here is the caller graph for this function:

◆ setX()

void QRectF::setX ( qreal x )

inlineconstexprnoexcept

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

Definition at line 535 of file qrect.h.

◆ setY()

void QRectF::setY ( qreal y )

inlineconstexprnoexcept

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

Definition at line 536 of file qrect.h.

◆ size()

constexpr QSizeF QRectF::size ( ) const

inlineconstexprnoexcept

Returns the size of the rectangle.

See also: setSize(), width(), height()

Definition at line 744 of file qrect.h.

Here is the caller graph for this function:

◆ toAlignedRect()

QRect QRectF::toAlignedRect ( ) const

noexcept

Since: 4.3

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

Definition at line 2351 of file qrect.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ top()

qreal QRectF::top ( ) const

inlineconstexprnoexcept

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

See also: setTop(), topLeft(), topRight()

Definition at line 525 of file qrect.h.

Here is the caller graph for this function:

◆ topLeft()

QPointF QRectF::topLeft ( ) const

inlineconstexprnoexcept

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

See also: setTopLeft(), top(), left()

Definition at line 538 of file qrect.h.

Here is the caller graph for this function:

◆ topRight()

QPointF QRectF::topRight ( ) const

inlineconstexprnoexcept

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

See also: setTopRight(), top(), right()

Definition at line 540 of file qrect.h.

◆ toRect()

constexpr QRect QRectF::toRect ( ) const

inlineconstexprnoexcept

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

Definition at line 866 of file qrect.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ translate() [1/2]

constexpr void QRectF::translate ( const QPointF & offset )

inlineconstexprnoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Moves the rectangle {offset}.\l{QPointF::x()}{x()} along the x axis and {offset}.\l{QPointF::y()}{y()} along the y axis, relative to the current position.

Definition at line 753 of file qrect.h.

◆ translate() [2/2]

constexpr void QRectF::translate	(	qreal	dx,
		qreal	dy
	)

inlineconstexprnoexcept

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

Definition at line 747 of file qrect.h.

Here is the caller graph for this function:

◆ translated() [1/2]

constexpr QRectF QRectF::translated ( const QPointF & offset ) const

inlineconstexprnoexcept

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Returns a copy of the rectangle that is translated {offset}.\l{QPointF::x()}{x()} along the x axis and {offset}.\l{QPointF::y()}{y()} along the y axis, relative to the current position.

Definition at line 776 of file qrect.h.

◆ translated() [2/2]

constexpr QRectF QRectF::translated	(	qreal	dx,
		qreal	dy
	)		const

inlineconstexprnoexcept

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

Definition at line 771 of file qrect.h.

Here is the caller graph for this function:

◆ transposed()

constexpr QRectF QRectF::transposed ( ) const

inlineconstexprnoexcept

Since: 5.7

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

See also: QSizeF::transposed()

Definition at line 779 of file qrect.h.

Here is the call graph for this function:

◆ united()

QRectF QRectF::united ( const QRectF & rectangle ) const

inlinenoexcept

Since: 4.2

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

See also: intersected()

Definition at line 861 of file qrect.h.

◆ width()

constexpr qreal QRectF::width ( ) const

inlineconstexprnoexcept

Returns the width of the rectangle.

See also: setWidth(), height(), size()

Definition at line 738 of file qrect.h.

Here is the caller graph for this function:

◆ x()

constexpr qreal QRectF::x ( ) const

inlineconstexprnoexcept

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

See also: setX(), y(), topLeft()

Definition at line 678 of file qrect.h.

Here is the caller graph for this function:

◆ y()

constexpr qreal QRectF::y ( ) const

inlineconstexprnoexcept

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

See also: setY(), x(), topLeft()

Definition at line 681 of file qrect.h.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator!=

bool QRectF::operator!=	(	const QRectF &	r1,
		const QRectF &	r2
	)

friend

Returns true if the rectangles r1 and r2 are sufficiently different, otherwise returns false.

Warning: This function does not check for strict inequality; instead, it uses a fuzzy comparison to compare the rectangles' coordinates.

Definition at line 608 of file qrect.h.

◆ operator+() [1/2]

QRectF operator+	(	const QMarginsF &	lhs,
		const QRectF &	rhs
	)

Since: 5.3

Returns the lhs rectangle grown by the rhs margins.

Definition at line 884 of file qrect.h.

◆ operator+() [2/2]

QRectF operator+	(	const QRectF &	lhs,
		const QMarginsF &	rhs
	)

Since: 5.3

Returns the lhs rectangle grown by the rhs margins.

Definition at line 878 of file qrect.h.

◆ operator-()

QRectF operator-	(	const QRectF &	lhs,
		const QMarginsF &	rhs
	)

Since: 5.3

Returns the lhs rectangle shrunk by the rhs margins.

Definition at line 890 of file qrect.h.

◆ operator<<()

QDataStream & operator<<	(	QDataStream &	stream,
		const QRectF &	rectangle
	)

See also: {Serializing Qt Data Types}

Definition at line 2468 of file qrect.cpp.

◆ operator==

bool QRectF::operator==	(	const QRectF &	r1,
		const QRectF &	r2
	)

friend

Returns true if the rectangles r1 and r2 are approximately equal, otherwise returns false.

Warning: This function does not check for strict equality; instead, it uses a fuzzy comparison to compare the rectangles' coordinates.

See also: qFuzzyCompare

Definition at line 603 of file qrect.h.

◆ operator>>()

QDataStream & operator>>	(	QDataStream &	stream,
		QRectF &	rectangle
	)

See also: {Serializing Qt Data Types}

Definition at line 2485 of file qrect.cpp.

The documentation for this class was generated from the following files:

src/corelib/tools/qrect.h
src/corelib/tools/qrect.cpp

Public Member Functions

Friends

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ QRectF() [1/5]

◆ QRectF() [2/5]

◆ QRectF() [3/5]

◆ QRectF() [4/5]

◆ QRectF() [5/5]

Member Function Documentation

◆ adjust()

◆ adjusted()

◆ bottom()

◆ bottomLeft()

◆ bottomRight()

◆ center()

◆ contains() [1/3]

◆ contains() [2/3]

◆ contains() [3/3]

◆ getCoords()

◆ getRect()

◆ height()

◆ intersected()

◆ intersects()

◆ isEmpty()

◆ isNull()

◆ isValid()

◆ left()

◆ marginsAdded()

◆ marginsRemoved()

◆ moveBottom()

◆ moveBottomLeft()

◆ moveBottomRight()

◆ moveCenter()

◆ moveLeft()

◆ moveRight()

◆ moveTo() [1/2]

◆ moveTo() [2/2]

◆ moveTop()

◆ moveTopLeft()

◆ moveTopRight()

◆ normalized()

◆ operator&()

◆ operator&=()

◆ operator+=()

◆ operator-=()

◆ operator|()

◆ operator|=()

◆ right()

◆ setBottom()

◆ setBottomLeft()

◆ setBottomRight()

◆ setCoords()

◆ setHeight()

◆ setLeft()

◆ setRect()

◆ setRight()

◆ setSize()

◆ setTop()

◆ setTopLeft()

◆ setTopRight()

◆ setWidth()

◆ setX()

◆ setY()

◆ size()

◆ toAlignedRect()

◆ top()

◆ topLeft()

◆ topRight()

◆ toRect()

◆ translate() [1/2]

◆ translate() [2/2]

◆ translated() [1/2]

◆ translated() [2/2]

◆ transposed()

◆ united()

◆ width()

◆ x()

◆ y()