\inmodule QtCore\reentrant More...

#include <qrect.h>

Inheritance diagram for QRect:

Collaboration diagram for QRect:

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

constexpr	QRect (const QPoint &topleft, const QPoint &bottomright) noexcept
	Constructs a rectangle with the given topLeft and bottomRight corners, both included.

constexpr	QRect (const QPoint &topleft, const QSize &size) noexcept
	Constructs a rectangle with the given topLeft corner and the given size.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

constexpr void	translate (int dx, int 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 QPoint &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 QRect	translated (int dx, int 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 QRect	translated (const QPoint &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 QRect	transposed () const noexcept

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

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

constexpr void	setRect (int x, int y, int w, int 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 (int x, int y, int w, int 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 (int x1, int y1, int x2, int 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 (int x1, int y1, int x2, int 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 (int x1, int y1, int x2, int y2) noexcept
	Adds dx1, dy1, dx2 and dy2 respectively to the existing coordinates of the rectangle.

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

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

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

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

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

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

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

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

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

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

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

bool	contains (const QRect &r, bool proper=false) 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.

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

bool	contains (int x, int 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 this rectangle, otherwise returns `false`.

bool	contains (int x, int y, bool proper) 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`.

QRect	united (const QRect &other) const noexcept

QRect	intersected (const QRect &other) const noexcept

bool	intersects (const QRect &r) const noexcept
	Returns `true` if this rectangle intersects with the given rectangle (i.e., there is at least one pixel that is within both rectangles), otherwise returns `false`.

constexpr QRect	marginsAdded (const QMargins &margins) const noexcept
	Returns a rectangle grown by the margins.

constexpr QRect	marginsRemoved (const QMargins &margins) const noexcept
	Removes the margins from the rectangle, shrinking it.

constexpr QRect &	operator+= (const QMargins &margins) noexcept
	Adds the margins to the rectangle, growing it.

constexpr QRect &	operator-= (const QMargins &margins) noexcept
	Returns a rectangle shrunk by the margins.

constexpr QRectF	toRectF () const noexcept

Static Public Member Functions
static constexpr QRect	span (const QPoint &p1, const QPoint &p2) noexcept
	Returns a rectangle spanning the two points p1 and p2, including both and everything in between.

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

constexpr size_t	qHash (const QRect &r, size_t seed=0)

Related Symbols
(Note that these are not member symbols.)
QRect	operator+ (const QRect &rectangle, const QMargins &margins)
	Returns the rectangle grown by the margins.

QRect	operator+ (const QMargins &margins, const QRect &rectangle)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the rectangle grown by the margins.

QRect	operator- (const QRect &lhs, const QMargins &rhs)
	Returns the lhs rectangle shrunk by the rhs margins.

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

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

Detailed Description

\inmodule QtCore

\reentrant

\compares equality \compareswith equality QRectF \endcompareswith

The QRect class defines a rectangle in the plane using integer precision.

A rectangle is normally expressed as a top-left corner and a size. The size (width and height) of a QRect is always equivalent to the mathematical rectangle that forms the basis for its rendering.

A QRect can be constructed with a set of left, top, width and height integers, or from a QPoint and a QSize. The following code creates two identical rectangles.

QRect r1(100, 200, 11, 16);

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

There is a third constructor that creates a QRect using the top-left and bottom-right coordinates, but we recommend that you avoid using it. The rationale is that for historical reasons the values returned by the bottom() and right() functions deviate from the true bottom-right corner of the rectangle.

The QRect class provides a collection of functions that return the various rectangle coordinates, and enable manipulation of these. QRect 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 QSize. 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. The QRect 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 left() > right() or top() > bottom(). Note that an empty rectangle is not valid: The isValid() function returns true if left() <= right() and top() <= bottom(). 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 QRect is defined in essentially the same way as QRectF.

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

Definition at line 30 of file qrect.h.

Constructor & Destructor Documentation

◆ QRect() [1/4]

QRect::QRect ( )

inlineconstexprnoexcept

Constructs a null rectangle.

See also: isNull()

Definition at line 33 of file qrect.h.

◆ QRect() [2/4]

QRect::QRect	(	const QPoint &	topLeft,
		const QPoint &	bottomRight )

inlineconstexprnoexcept

Constructs a rectangle with the given topLeft and bottomRight corners, both included.

If bottomRight is to higher and to the left of topLeft, the rectangle defined is instead non-inclusive of the corners.

Note: To ensure both points are included regardless of relative order, use span().

See also: setTopLeft(), setBottomRight(), span()

Definition at line 169 of file qrect.h.

◆ QRect() [3/4]

QRect::QRect	(	const QPoint &	topLeft,
		const QSize &	size )

inlineconstexprnoexcept

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

See also: setTopLeft(), setSize()

Definition at line 172 of file qrect.h.

◆ QRect() [4/4]

QRect::QRect	(	int	x,
		int	y,
		int	width,
		int	height )

inlineconstexprnoexcept

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

See also: setRect()

Definition at line 166 of file qrect.h.

Member Function Documentation

◆ adjust()

void QRect::adjust	(	int	dx1,
		int	dy1,
		int	dx2,
		int	dy2 )

inlineconstexprnoexcept

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

See also: adjusted(), setRect()

Definition at line 398 of file qrect.h.

◆ adjusted()

QRect QRect::adjusted	(	int	dx1,
		int	dy1,
		int	dx2,
		int	dy2 ) const

inlinenodiscardconstexprnoexcept

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

See also: adjust()

Definition at line 395 of file qrect.h.

◆ bottom()

int QRect::bottom ( ) const

inlineconstexprnoexcept

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

Note that for historical reasons this function returns top() + height() - 1; use y() + height() to retrieve the true y-coordinate.

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

Definition at line 201 of file qrect.h.

◆ bottomLeft()

QPoint QRect::bottomLeft ( ) const

inlineconstexprnoexcept

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

Note that for historical reasons this function returns QPoint(left(), top() + height() - 1).

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

Definition at line 249 of file qrect.h.

◆ bottomRight()

QPoint QRect::bottomRight ( ) const

inlineconstexprnoexcept

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

Note that for historical reasons this function returns QPoint(left() + width() -1, top() + height() - 1).

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

Definition at line 243 of file qrect.h.

◆ center()

QPoint QRect::center ( ) const

inlineconstexprnoexcept

Returns the center point of the rectangle.

See also: moveCenter()

Definition at line 252 of file qrect.h.

◆ contains() [1/4]

bool QRect::contains	(	const QPoint &	point,
		bool	proper = false ) const

noexcept

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

If proper is true, this function only returns true if the given point is inside the rectangle (i.e., not on the edge).

See also: intersects()

Definition at line 789 of file qrect.cpp.

◆ contains() [2/4]

bool QRect::contains	(	const QRect &	rectangle,
		bool	proper = false ) 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. If proper is true, this function only returns true if the rectangle is entirely inside this rectangle (not on the edge).

Definition at line 853 of file qrect.cpp.

◆ contains() [3/4]

bool QRect::contains	(	int	x,
		int	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 this rectangle, otherwise returns false.

Definition at line 423 of file qrect.h.

◆ contains() [4/4]

bool QRect::contains	(	int	x,
		int	y,
		bool	proper ) 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.

If proper is true, this function only returns true if the point is entirely inside the rectangle(not on the edge).

Definition at line 418 of file qrect.h.

◆ getCoords()

void QRect::getCoords	(	int *	x1,
		int *	y1,
		int *	x2,
		int *	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 379 of file qrect.h.

◆ getRect()

void QRect::getRect	(	int *	x,
		int *	y,
		int *	width,
		int *	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 363 of file qrect.h.

◆ height()

int QRect::height ( ) const

inlineconstexprnoexcept

Returns the height of the rectangle.

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

Definition at line 262 of file qrect.h.

◆ intersected()

QRect QRect::intersected ( const QRect & 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 440 of file qrect.h.

◆ intersects()

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

noexcept

Returns true if this rectangle intersects with the given rectangle (i.e., there is at least one pixel that is within both rectangles), otherwise returns false.

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

See also: contains()

Definition at line 1067 of file qrect.cpp.

◆ isEmpty()

bool QRect::isEmpty ( ) const

inlineconstexprnoexcept

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

An empty rectangle has a left() > right() or top() > bottom(). 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 186 of file qrect.h.

◆ isNull()

bool QRect::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 (i.e., right() == left() - 1 and bottom() == top() - 1). A null rectangle is also empty, and hence is not valid.

See also: isEmpty(), isValid()

Definition at line 175 of file qrect.h.

◆ isValid()

bool QRect::isValid ( ) const

inlineconstexprnoexcept

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

A valid rectangle has a left() <= right() and top() <= bottom(). 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 189 of file qrect.h.

◆ left()

int QRect::left ( ) const

inlineconstexprnoexcept

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

Equivalent to x().

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

Definition at line 192 of file qrect.h.

◆ marginsAdded()

QRect QRect::marginsAdded ( const QMargins & margins ) const

inlineconstexprnoexcept

Returns a rectangle grown by the margins.

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

Since: 5.1

Definition at line 473 of file qrect.h.

◆ marginsRemoved()

QRect QRect::marginsRemoved ( const QMargins & margins ) const

inlineconstexprnoexcept

Removes the margins from the rectangle, shrinking it.

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

Since: 5.1

Definition at line 479 of file qrect.h.

◆ moveBottom()

void QRect::moveBottom ( int y )

inlineconstexprnoexcept

Moves the rectangle vertically, leaving the rectangle's bottom edge at the given y coordinate.

The rectangle's size is unchanged.

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

Definition at line 323 of file qrect.h.

◆ moveBottomLeft()

void QRect::moveBottomLeft ( const QPoint & 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 347 of file qrect.h.

◆ moveBottomRight()

void QRect::moveBottomRight ( const QPoint & position )

inlineconstexprnoexcept

Moves the rectangle, leaving the bottom-right corner at the given position.

The rectangle's size is unchanged.

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

Definition at line 335 of file qrect.h.

◆ moveCenter()

void QRect::moveCenter ( const QPoint & 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 353 of file qrect.h.

◆ moveLeft()

void QRect::moveLeft ( int x )

inlineconstexprnoexcept

Moves the rectangle horizontally, leaving the rectangle's left edge at the given x coordinate.

The rectangle's size is unchanged.

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

Definition at line 311 of file qrect.h.

◆ moveRight()

void QRect::moveRight ( int x )

inlineconstexprnoexcept

Moves the rectangle horizontally, leaving the rectangle's right edge at the given x coordinate.

The rectangle's size is unchanged.

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

Definition at line 317 of file qrect.h.

◆ moveTo() [1/2]

void QRect::moveTo ( const QPoint & p )

inlineconstexprnoexcept

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

Definition at line 303 of file qrect.h.

◆ moveTo() [2/2]

void QRect::moveTo	(	int	x,
		int	y )

inlineconstexprnoexcept

Moves the rectangle, leaving the top-left corner at the given position (x, y).

The rectangle's size is unchanged.

See also: translate(), moveTopLeft()

Definition at line 293 of file qrect.h.

◆ moveTop()

void QRect::moveTop ( int y )

inlineconstexprnoexcept

Moves the rectangle vertically, leaving the rectangle's top edge at the given y coordinate.

The rectangle's size is unchanged.

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

Definition at line 314 of file qrect.h.

◆ moveTopLeft()

void QRect::moveTopLeft ( const QPoint & 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 329 of file qrect.h.

◆ moveTopRight()

void QRect::moveTopRight ( const QPoint & 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 341 of file qrect.h.

◆ normalized()

QRect QRect::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. The corners are at the same time changed from being non-inclusive to inclusive.

See also: isValid(), isEmpty()

Definition at line 275 of file qrect.cpp.

◆ operator&()

QRect QRect::operator& ( const QRect & 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 995 of file qrect.cpp.

◆ operator&=()

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

inlinenoexcept

Intersects this rectangle with the given rectangle.

See also: intersected(), operator&()

Definition at line 434 of file qrect.h.

◆ operator+=()

QRect & QRect::operator+= ( const QMargins & margins )

inlineconstexprnoexcept

Adds the margins to the rectangle, growing it.

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

Since: 5.1

Definition at line 485 of file qrect.h.

◆ operator-=()

QRect & QRect::operator-= ( const QMargins & margins )

inlineconstexprnoexcept

Returns a rectangle shrunk by the margins.

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

Since: 5.1

Definition at line 491 of file qrect.h.

◆ operator|()

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

noexcept

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

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

Definition at line 931 of file qrect.cpp.

◆ operator|=()

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

inlinenoexcept

Unites this rectangle with the given rectangle.

See also: united(), operator|()

Definition at line 428 of file qrect.h.

◆ right()

int QRect::right ( ) const

inlineconstexprnoexcept

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

Note that for historical reasons this function returns left() + width() - 1; use x() + width() to retrieve the true x-coordinate.

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

Definition at line 198 of file qrect.h.

◆ setBottom()

void QRect::setBottom ( int y )

inlineconstexprnoexcept

Sets the bottom edge of the rectangle to the given y coordinate.

May change the height, but will never change the top edge of the rectangle.

See also: bottom(), moveBottom(),

Definition at line 219 of file qrect.h.

◆ setBottomLeft()

void QRect::setBottomLeft ( const QPoint & 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 231 of file qrect.h.

◆ setBottomRight()

void QRect::setBottomRight ( const QPoint & 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 225 of file qrect.h.

◆ setCoords()

void QRect::setCoords	(	int	x1,
		int	y1,
		int	x2,
		int	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).

See also: getCoords(), setRect()

Definition at line 387 of file qrect.h.

◆ setHeight()

void QRect::setHeight ( int height )

inlineconstexprnoexcept

Sets the height of the rectangle to the given height.

The bottom edge is changed, but not the top one.

See also: height(), setSize()

Definition at line 409 of file qrect.h.

◆ setLeft()

void QRect::setLeft ( int x )

inlineconstexprnoexcept

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

Definition at line 210 of file qrect.h.

◆ setRect()

void QRect::setRect	(	int	x,
		int	y,
		int	width,
		int	height )

inlineconstexprnoexcept

Sets the coordinates of the rectangle's top-left corner to ({x}, {y}), and its size to the given width and height.

See also: getRect(), setCoords()

Definition at line 371 of file qrect.h.

◆ setRight()

void QRect::setRight ( int x )

inlineconstexprnoexcept

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

Definition at line 216 of file qrect.h.

◆ setSize()

void QRect::setSize ( const QSize & size )

inlineconstexprnoexcept

Sets the size of the rectangle to the given size.

The top-left corner is not moved.

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

Definition at line 412 of file qrect.h.

◆ setTop()

void QRect::setTop ( int y )

inlineconstexprnoexcept

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

Definition at line 213 of file qrect.h.

◆ setTopLeft()

void QRect::setTopLeft ( const QPoint & 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 222 of file qrect.h.

◆ setTopRight()

void QRect::setTopRight ( const QPoint & 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 228 of file qrect.h.

◆ setWidth()

void QRect::setWidth ( int width )

inlineconstexprnoexcept

Sets the width of the rectangle to the given width.

The right edge is changed, but not the left one.

See also: width(), setSize()

Definition at line 406 of file qrect.h.

◆ setX()

void QRect::setX ( int x )

inlineconstexprnoexcept

Sets the left edge of the rectangle to the given x coordinate.

May change the width, but will never change the right edge of the rectangle.

Equivalent to setLeft().

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

Definition at line 234 of file qrect.h.

◆ setY()

void QRect::setY ( int y )

inlineconstexprnoexcept

Sets the top edge of the rectangle to the given y coordinate.

May change the height, but will never change the bottom edge of the rectangle.

Equivalent to setTop().

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

Definition at line 237 of file qrect.h.

◆ size()

QSize QRect::size ( ) const

inlineconstexprnoexcept

Returns the size of the rectangle.

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

Definition at line 265 of file qrect.h.

◆ span()

QRect QRect::span	(	const QPoint &	p1,
		const QPoint &	p2 )

inlinestaticnodiscardconstexprnoexcept

Returns a rectangle spanning the two points p1 and p2, including both and everything in between.

Since: 6.0

Definition at line 497 of file qrect.h.

◆ top()

int QRect::top ( ) const

inlineconstexprnoexcept

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

Equivalent to y().

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

Definition at line 195 of file qrect.h.

◆ topLeft()

QPoint QRect::topLeft ( ) const

inlineconstexprnoexcept

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

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

Definition at line 240 of file qrect.h.

◆ topRight()

QPoint QRect::topRight ( ) const

inlineconstexprnoexcept

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

Note that for historical reasons this function returns QPoint(left() + width() -1, top()).

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

Definition at line 246 of file qrect.h.

◆ toRectF()

QRectF QRect::toRectF ( ) const

inlinenodiscardconstexprnoexcept

Since: 6.4

Returns this rectangle as a rectangle with floating point accuracy.

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

See also: QRectF::toRect()

Definition at line 885 of file qrect.h.

◆ translate() [1/2]

void QRect::translate ( const QPoint & 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{QPoint::x()}{x()} along the x axis and {offset}.\l{QPoint::y()}{y()} along the y axis, relative to the current position.

Definition at line 276 of file qrect.h.

◆ translate() [2/2]

void QRect::translate	(	int	dx,
		int	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 down.

See also: moveTopLeft(), moveTo(), translated()

Definition at line 268 of file qrect.h.

◆ translated() [1/2]

QRect QRect::translated ( const QPoint & 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{QPoint::x()}{x()} along the x axis and {offset}.\l{QPoint::y()}{y()} along the y axis, relative to the current position.

Definition at line 287 of file qrect.h.

◆ translated() [2/2]

QRect QRect::translated	(	int	dx,
		int	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.

See also: translate()

Definition at line 284 of file qrect.h.

◆ transposed()

QRect QRect::transposed ( ) const

inlinenodiscardconstexprnoexcept

Since: 5.7

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

QRect r = {15, 51, 42, 24};

r = r.transposed(); // r == {15, 51, 24, 42}

See also: QSize::transposed()

Definition at line 290 of file qrect.h.

◆ united()

QRect QRect::united ( const QRect & rectangle ) const

inlinenodiscardnoexcept

Since: 4.2

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

See also: intersected()

Definition at line 445 of file qrect.h.

◆ width()

int QRect::width ( ) const

inlineconstexprnoexcept

Returns the width of the rectangle.

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

Definition at line 259 of file qrect.h.

◆ x()

int QRect::x ( ) const

inlineconstexprnoexcept

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

Equivalent to left().

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

Definition at line 204 of file qrect.h.

◆ y()

int QRect::y ( ) const

inlineconstexprnoexcept

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

Equivalent to top().

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

Definition at line 207 of file qrect.h.

Friends And Related Symbol Documentation

◆ comparesEqual

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

friend

Definition at line 124 of file qrect.h.

◆ operator+() [1/2]

QRect operator+	(	const QMargins &	margins,
		const QRect &	rectangle )

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

Since: 5.1

Definition at line 461 of file qrect.h.

◆ operator+() [2/2]

QRect operator+	(	const QRect &	rectangle,
		const QMargins &	margins )

Returns the rectangle grown by the margins.

Since: 5.1

Definition at line 455 of file qrect.h.

◆ operator-()

QRect operator-	(	const QRect &	lhs,
		const QMargins &	rhs )

Returns the lhs rectangle shrunk by the rhs margins.

Since: 5.3

Definition at line 467 of file qrect.h.

◆ operator<<()

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

Writes the given rectangle to the given stream, and returns a reference to the stream.

See also: {Serializing Qt Data Types}

◆ operator>>()

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

Reads a rectangle from the given stream into the given rectangle, and returns a reference to the stream.

See also: {Serializing Qt Data Types}

◆ qHash

size_t qHash	(	const QRect &	r,
		size_t	seed = 0 )

friend

Definition at line 450 of file qrect.h.

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

qtbase/src/corelib/tools/qrect.h (c5608c675a61a413b4a32c6c99721a1bb2f41e71)
qtbase/src/corelib/tools/qrect.cpp (1145e1709d1072f7dd45683e9c25a14615603854)

Public Member Functions

Static Public Member Functions

Friends

Related Symbols

Detailed Description

Constructor & Destructor Documentation

◆ QRect() [1/4]

◆ QRect() [2/4]

◆ QRect() [3/4]

◆ QRect() [4/4]

Member Function Documentation

◆ adjust()

◆ adjusted()

◆ bottom()

◆ bottomLeft()

◆ bottomRight()

◆ center()

◆ contains() [1/4]

◆ contains() [2/4]

◆ contains() [3/4]

◆ contains() [4/4]

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

◆ span()

◆ top()

◆ topLeft()

◆ topRight()

◆ toRectF()

◆ translate() [1/2]

◆ translate() [2/2]

◆ translated() [1/2]

◆ translated() [2/2]

◆ transposed()

◆ united()

◆ width()

◆ x()