\inmodule QtCore\reentrant More...

#include <qrect.h>

Inheritance diagram for QRectF:

Collaboration diagram for QRectF:

Public Member Functions
constexpr	QRectF () noexcept
	Constructs a null rectangle.

constexpr	QRectF (const QPointF &topleft, const QSizeF &size) noexcept
	Constructs a rectangle with the given topLeft corner and the given size.

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

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

constexpr	QRectF (const QRect &rect) noexcept
	Constructs a QRectF rectangle from the given QRect rectangle.

constexpr bool	isNull () const noexcept
	Returns `true` if the rectangle is a null rectangle, otherwise returns `false`.

constexpr bool	isEmpty () const noexcept
	Returns `true` if the rectangle is empty, otherwise returns `false`.

constexpr bool	isValid () const noexcept
	Returns `true` if the rectangle is valid, otherwise returns `false`.

QRectF	normalized () const noexcept
	Returns a normalized rectangle; i.e., a rectangle that has a non-negative width and height.

constexpr qreal	left () const noexcept
	Returns the x-coordinate of the rectangle's left edge.

constexpr qreal	top () const noexcept
	Returns the y-coordinate of the rectangle's top edge.

constexpr qreal	right () const noexcept
	Returns the x-coordinate of the rectangle's right edge.

constexpr qreal	bottom () const noexcept
	Returns the y-coordinate of the rectangle's bottom edge.

constexpr qreal	x () const noexcept
	Returns the x-coordinate of the rectangle's left edge.

constexpr qreal	y () const noexcept
	Returns the y-coordinate of the rectangle's top edge.

constexpr void	setLeft (qreal pos) noexcept
	Sets the left edge of the rectangle to the given finite x coordinate.

constexpr void	setTop (qreal pos) noexcept
	Sets the top edge of the rectangle to the given finite y coordinate.

constexpr void	setRight (qreal pos) noexcept
	Sets the right edge of the rectangle to the given finite x coordinate.

constexpr void	setBottom (qreal pos) noexcept
	Sets the bottom edge of the rectangle to the given finite y coordinate.

constexpr void	setX (qreal pos) noexcept
	Sets the left edge of the rectangle to the given finite x coordinate.

constexpr void	setY (qreal pos) noexcept
	Sets the top edge of the rectangle to the given finite y coordinate.

constexpr QPointF	topLeft () const noexcept
	Returns the position of the rectangle's top-left corner.

constexpr QPointF	bottomRight () const noexcept
	Returns the position of the rectangle's bottom-right corner.

constexpr QPointF	topRight () const noexcept
	Returns the position of the rectangle's top-right corner.

constexpr QPointF	bottomLeft () const noexcept
	Returns the position of the rectangle's bottom-left corner.

constexpr QPointF	center () const noexcept
	Returns the center point of the rectangle.

constexpr void	setTopLeft (const QPointF &p) noexcept
	Set the top-left corner of the rectangle to the given position.

constexpr void	setBottomRight (const QPointF &p) noexcept
	Set the bottom-right corner of the rectangle to the given position.

constexpr void	setTopRight (const QPointF &p) noexcept
	Set the top-right corner of the rectangle to the given position.

constexpr void	setBottomLeft (const QPointF &p) noexcept
	Set the bottom-left corner of the rectangle to the given position.

constexpr void	moveLeft (qreal pos) noexcept
	Moves the rectangle horizontally, leaving the rectangle's left edge at the given finite x coordinate.

constexpr void	moveTop (qreal pos) noexcept
	Moves the rectangle vertically, leaving the rectangle's top line at the given finite y coordinate.

constexpr void	moveRight (qreal pos) noexcept
	Moves the rectangle horizontally, leaving the rectangle's right edge at the given finite x coordinate.

constexpr void	moveBottom (qreal pos) noexcept
	Moves the rectangle vertically, leaving the rectangle's bottom edge at the given finite y coordinate.

constexpr void	moveTopLeft (const QPointF &p) noexcept
	Moves the rectangle, leaving the top-left corner at the given position.

constexpr void	moveBottomRight (const QPointF &p) noexcept
	Moves the rectangle, leaving the bottom-right corner at the given position.

constexpr void	moveTopRight (const QPointF &p) noexcept
	Moves the rectangle, leaving the top-right corner at the given position.

constexpr void	moveBottomLeft (const QPointF &p) noexcept
	Moves the rectangle, leaving the bottom-left corner at the given position.

constexpr void	moveCenter (const QPointF &p) noexcept
	Moves the rectangle, leaving the center point at the given position.

constexpr void	translate (qreal dx, qreal dy) noexcept
	Moves the rectangle dx along the x-axis and dy along the y-axis, relative to the current position.

constexpr void	translate (const QPointF &p) noexcept
	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}.

constexpr QRectF	translated (qreal dx, qreal dy) const noexcept
	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.

constexpr QRectF	translated (const QPointF &p) 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 a copy of the rectangle that is translated {offset}.

constexpr QRectF	transposed () const noexcept

constexpr void	moveTo (qreal x, qreal y) noexcept
	Moves the rectangle, leaving the top-left corner at the given position (x, y).

constexpr void	moveTo (const QPointF &p) noexcept
	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.

constexpr void	setRect (qreal x, qreal y, qreal w, qreal h) noexcept
	Sets the coordinates of the rectangle's top-left corner to (x, y), and its size to the given width and height.

constexpr void	getRect (qreal x, qreal y, qreal w, qreal h) const
	Extracts the position of the rectangle's top-left corner to x and y, and its dimensions to width and *height.

constexpr void	setCoords (qreal x1, qreal y1, qreal x2, qreal y2) noexcept
	Sets the coordinates of the rectangle's top-left corner to (x1, y1), and the coordinates of its bottom-right corner to (x2, y2).

constexpr void	getCoords (qreal x1, qreal y1, qreal x2, qreal y2) const
	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.

constexpr void	adjust (qreal x1, qreal y1, qreal x2, qreal y2) noexcept
	Adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle.

constexpr QRectF	adjusted (qreal x1, qreal y1, qreal x2, qreal y2) const noexcept
	Returns a new rectangle with dx1, dy1, dx2 and dy2 added respectively to the existing coordinates of this rectangle.

constexpr QSizeF	size () const noexcept
	Returns the size of the rectangle.

constexpr qreal	width () const noexcept
	Returns the width of the rectangle.

constexpr qreal	height () const noexcept
	Returns the height of the rectangle.

constexpr void	setWidth (qreal w) noexcept
	Sets the width of the rectangle to the given finite width.

constexpr void	setHeight (qreal h) noexcept
	Sets the height of the rectangle to the given finite height.

constexpr void	setSize (const QSizeF &s) noexcept
	Sets the size of the rectangle to the given finite size.

QRectF	operator\| (const QRectF &r) const noexcept
	Returns the bounding rectangle of this rectangle and the given rectangle.

QRectF	operator& (const QRectF &r) const noexcept
	Returns the intersection of this rectangle and the given rectangle.

QRectF &	operator\|= (const QRectF &r) noexcept
	Unites this rectangle with the given rectangle.

QRectF &	operator&= (const QRectF &r) noexcept
	Intersects this rectangle with the given rectangle.

bool	contains (const QRectF &r) 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`.

bool	contains (const QPointF &p) const noexcept
	Returns `true` if the given point is inside or on the edge of the rectangle; otherwise returns `false`.

bool	contains (qreal x, qreal y) 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 point (x, y) is inside or on the edge of the rectangle; otherwise returns `false`.

QRectF	united (const QRectF &other) const noexcept

QRectF	intersected (const QRectF &other) const noexcept

bool	intersects (const QRectF &r) const noexcept
	Returns `true` if this rectangle intersects with the given rectangle (i.e.

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
	Returns a QRect based on the values of this rectangle.

QRect	toAlignedRect () const noexcept

Friends
constexpr bool	comparesEqual (const QRectF &r1, const QRectF &r2) noexcept

constexpr bool	comparesEqual (const QRectF &r1, const QRect &r2) noexcept

constexpr bool	qFuzzyCompare (const QRectF &lhs, const QRectF &rhs) noexcept

constexpr bool	qFuzzyIsNull (const QRectF &rect) noexcept

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

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

QRectF	operator+ (const QMarginsF &lhs, const QRectF &rhs)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QDataStream &	operator<< (QDataStream &stream, const QRectF &rectangle)
	Writes the rectangle to the stream, and returns a reference to the stream.

QDataStream &	operator>> (QDataStream &stream, QRectF &rectangle)
	Reads a rectangle from the stream, and returns a reference to the stream.

Detailed Description

\inmodule QtCore

\reentrant

\compares equality \compareswith equality QRect \endcompareswith

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

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.

QRectF r1(100.0, 200.1, 11.2, 16.3);

QRectF r2(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:

\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 483 of file qrect.h.

Constructor & Destructor Documentation

◆ QRectF() [1/5]

QRectF::QRectF ( )

inlineconstexprnoexcept

Constructs a null rectangle.

See also: isNull()

Definition at line 486 of file qrect.h.

◆ QRectF() [2/5]

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 639 of file qrect.h.

◆ QRectF() [3/5]

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 645 of file qrect.h.

◆ QRectF() [4/5]

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 634 of file qrect.h.

◆ QRectF() [5/5]

QRectF::QRectF ( const QRect & rectangle )

inlineconstexprnoexcept

Constructs a QRectF rectangle from the given QRect rectangle.

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

See also: toRect(), QRect::toRectF()

Definition at line 650 of file qrect.h.

Member Function Documentation

◆ adjust()

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 805 of file qrect.h.

◆ adjusted()

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

inlinenodiscardconstexprnoexcept

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 813 of file qrect.h.

◆ bottom()

qreal QRectF::bottom ( ) const

inlineconstexprnoexcept

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

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

Definition at line 500 of file qrect.h.

◆ bottomLeft()

QPointF QRectF::bottomLeft ( ) const

inlineconstexprnoexcept

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

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

Definition at line 514 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 512 of file qrect.h.

◆ center()

QPointF QRectF::center ( ) const

inlineconstexprnoexcept

Returns the center point of the rectangle.

See also: moveCenter()

Definition at line 699 of file qrect.h.

◆ 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 1943 of file qrect.cpp.

◆ contains() [2/3]

bool QRectF::contains ( const QRectF & r ) 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 1989 of file qrect.cpp.

◆ 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 830 of file qrect.h.

◆ getCoords()

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 789 of file qrect.h.

◆ getRect()

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 773 of file qrect.h.

◆ height()

qreal QRectF::height ( ) const

inlineconstexprnoexcept

Returns the height of the rectangle.

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

Definition at line 732 of file qrect.h.

◆ intersected()

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

inlinenodiscardnoexcept

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 847 of file qrect.h.

◆ 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 2267 of file qrect.cpp.

◆ isEmpty()

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 661 of file qrect.h.

◆ isNull()

QT_WARNING_PUSH QT_WARNING_DISABLE_FLOAT_COMPARE constexpr 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 658 of file qrect.h.

◆ isValid()

QT_WARNING_POP constexpr 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 666 of file qrect.h.

◆ 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 497 of file qrect.h.

Referenced by testing.tools.safetynet_image.ImageLocations::Left().

Here is the caller graph for this function:

◆ marginsAdded()

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 889 of file qrect.h.

◆ marginsRemoved()

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 895 of file qrect.h.

◆ moveBottom()

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 711 of file qrect.h.

◆ moveBottomLeft()

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 720 of file qrect.h.

◆ moveBottomRight()

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 723 of file qrect.h.

◆ moveCenter()

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 726 of file qrect.h.

◆ moveLeft()

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 702 of file qrect.h.

◆ moveRight()

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 708 of file qrect.h.

◆ moveTo() [1/2]

void QRectF::moveTo ( const QPointF & p )

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 756 of file qrect.h.

◆ moveTo() [2/2]

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 750 of file qrect.h.

◆ moveTop()

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 705 of file qrect.h.

◆ moveTopLeft()

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 714 of file qrect.h.

◆ moveTopRight()

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 717 of file qrect.h.

◆ normalized()

QRectF QRectF::normalized ( ) const

nodiscardnoexcept

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 1518 of file qrect.cpp.

◆ 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 2189 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 841 of file qrect.h.

◆ operator+=()

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 901 of file qrect.h.

◆ operator-=()

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 907 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 2127 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 835 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 499 of file qrect.h.

Referenced by testing.tools.safetynet_image.ImageLocations::Right().

Here is the caller graph for this function:

◆ setBottom()

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 684 of file qrect.h.

◆ setBottomLeft()

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 693 of file qrect.h.

◆ setBottomRight()

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 696 of file qrect.h.

◆ setCoords()

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 797 of file qrect.h.

◆ setHeight()

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 821 of file qrect.h.

◆ setLeft()

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 675 of file qrect.h.

◆ setRect()

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 781 of file qrect.h.

◆ setRight()

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 678 of file qrect.h.

◆ setSize()

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 824 of file qrect.h.

◆ setTop()

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 681 of file qrect.h.

◆ setTopLeft()

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 687 of file qrect.h.

◆ setTopRight()

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 690 of file qrect.h.

◆ setWidth()

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 818 of file qrect.h.

◆ 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 508 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 509 of file qrect.h.

◆ size()

QSizeF QRectF::size ( ) const

inlineconstexprnoexcept

Returns the size of the rectangle.

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

Definition at line 735 of file qrect.h.

◆ toAlignedRect()

QRect QRectF::toAlignedRect ( ) const

nodiscardnoexcept

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 2334 of file qrect.cpp.

◆ 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 498 of file qrect.h.

◆ topLeft()

QPointF QRectF::topLeft ( ) const

inlineconstexprnoexcept

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

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

Definition at line 511 of file qrect.h.

◆ topRight()

QPointF QRectF::topRight ( ) const

inlineconstexprnoexcept

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

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

Definition at line 513 of file qrect.h.

◆ toRect()

QRect QRectF::toRect ( ) const

inlinenodiscardconstexprnoexcept

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(), QRect::toRectF()

Definition at line 859 of file qrect.h.

◆ translate() [1/2]

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 744 of file qrect.h.

◆ translate() [2/2]

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 738 of file qrect.h.

◆ translated() [1/2]

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

inlinenodiscardconstexprnoexcept

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 767 of file qrect.h.

◆ translated() [2/2]

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

inlinenodiscardconstexprnoexcept

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 762 of file qrect.h.

◆ transposed()

QRectF QRectF::transposed ( ) const

inlinenodiscardconstexprnoexcept

Since: 5.7

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}

QRectF::transposed

constexpr QRectF transposed() const noexcept

Definition qrect.h:770

QRect::transposed

constexpr QRect transposed() const noexcept

Definition qrect.h:267

r2

QRect r2(QPoint(100, 200), QSize(11, 16))

r1

QRect r1(100, 200, 11, 16)

[0]

See also: QSizeF::transposed()

Definition at line 770 of file qrect.h.

◆ united()

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

inlinenodiscardnoexcept

Since: 4.2

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

See also: intersected()

Definition at line 852 of file qrect.h.

◆ width()

qreal QRectF::width ( ) const

inlineconstexprnoexcept

Returns the width of the rectangle.

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

Definition at line 729 of file qrect.h.

◆ x()

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 669 of file qrect.h.

◆ y()

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 672 of file qrect.h.

Friends And Related Symbol Documentation

◆ comparesEqual [1/2]

bool comparesEqual	(	const QRectF &	r1,
		const QRect &	r2 )

friend

Definition at line 584 of file qrect.h.

◆ comparesEqual [2/2]

bool comparesEqual	(	const QRectF &	r1,
		const QRectF &	r2 )

friend

Definition at line 577 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 877 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 871 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 883 of file qrect.h.

◆ operator<<()

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

See also: {Serializing Qt Data Types}

◆ operator>>()

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

See also: {Serializing Qt Data Types}

◆ qFuzzyCompare

bool qFuzzyCompare	(	const QRectF &	lhs,
		const QRectF &	rhs )

friend

Since: 6.8

Returns true if the rectangle lhs is approximately equal to the rectangle rhs; otherwise returns false.

Definition at line 588 of file qrect.h.

◆ qFuzzyIsNull

bool qFuzzyIsNull ( const QRectF & rect )

friend

Since: 6.8

Returns true if both width and height of the rectangle rect are approximately equal to zero; otherwise returns false.

Definition at line 594 of file qrect.h.

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

qtbase/src/corelib/tools/qrect.h (9d4e1b9f8d36821ee7a38ca6485c7a9ad57cb27b)
qtbase/src/corelib/tools/qrect.cpp (cd8244131e2d6fe2c2453ae40213e7f12bff893d)

Public Member Functions

Friends

Related Symbols

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