QtCore.QRectF Class Reference

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

Inheritance diagram for QtCore.QRectF:

Collaboration diagram for QtCore.QRectF:

Public Member Functions
override bool	Equals (object o)
override int	GetHashCode ()
	QRectF ()
	QRectF (QRect rect)
	QRectF (QRectF copy)
	QRectF (QPointF topleft, QSizeF size)
	QRectF (QPointF topleft, QPointF bottomRight)
	QRectF (double left, double top, double width, double height)
virtual void	CreateProxy ()
new void	Adjust (double x1, double y1, double x2, double y2)
new QRectF	Adjusted (double x1, double y1, double x2, double y2)
new QPointF	Center ()
new bool	Contains (QPointF p)
new bool	Contains (QRectF r)
new bool	Contains (double x, double y)
new void	GetCoords (ref double x1, ref double y1, ref double x2, ref double y2)
new void	GetRect (ref double x, ref double y, ref double w, ref double h)
new QRectF	Intersect (QRectF r)
new QRectF	Intersected (QRectF other)
new bool	Intersects (QRectF r)
new bool	IsEmpty ()
new bool	IsNull ()
new bool	IsValid ()
new void	MoveBottom (double pos)
new void	MoveBottomLeft (QPointF p)
new void	MoveBottomRight (QPointF p)
new void	MoveCenter (QPointF p)
new void	MoveLeft (double pos)
new void	MoveRight (double pos)
new void	MoveTo (QPointF p)
new void	MoveTo (double x, double t)
new void	MoveTop (double pos)
new void	MoveTopLeft (QPointF p)
new void	MoveTopRight (QPointF p)
new QRectF	Normalized ()
new void	SetCoords (double x1, double y1, double x2, double y2)
new void	SetRect (double x, double y, double w, double h)
new QRect	ToAlignedRect ()
new QRect	ToRect ()
new void	Translate (QPointF p)
new void	Translate (double dx, double dy)
new QRectF	Translated (QPointF p)
new QRectF	Translated (double dx, double dy)
new QRectF	Unite (QRectF r)
new QRectF	United (QRectF other)
new void	Dispose ()

Static Public Member Functions
static bool	operator!= (QRectF arg1, QRectF arg2)
static bool	operator== (QRectF arg1, QRectF arg2)
static QRectF	operator& (QRectF arg1, QRectF arg2)
static QRectF	operator| (QRectF arg1, QRectF arg2)

Protected Member Functions
	QRectF (System.Type dummy)

Protected Attributes
SmokeInvocation	interceptor

Properties
new double	Bottom [get, set]
new QPointF	BottomLeft [get, set]
new QPointF	BottomRight [get, set]
new double	Height [get, set]
new double	Left [get, set]
new double	Right [get, set]
new QSizeF	Size [get, set]
new double	Top [get, set]
new QPointF	TopLeft [get, set]
new QPointF	TopRight [get, set]
new double	Width [get, set]
new double	X [get, set]
new double	Y [get, set]
virtual System.IntPtr	SmokeObject [get, set]

Detailed Description

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

A rectangle is normally expressed as an upper-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 integers, or from a QPoint and a QSize. The following code creates two identical rectangles.

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

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

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 provide 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 rectange'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 (otherwise false). The QRectF class also provides the intersected() function which returns the intersection rectangle, and the united() function which returns the rectangle that encloses the given rectangle and this:

intersected() united()

The isEmpty() function returns true if the rectangle's width or height is less than, or equal to, 0. Note that an empty rectangle is not valid: The isValid() function returns true if both width and height is larger than 0. A null rectangle (isNull() == true) on the other hand, has both width and height set to 0.

Note that due to the way QRect and QRectF are defined, an empty QRectF is defined in essentially the same way as QRect.

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

Rendering

When using an anti-aliased painter, the boundary line of a QRectF will be rendered symmetrically on both sides of the mathematical rectangle's boundary line. But when using an aliased painter (the default) other rules apply.

Then, when rendering with a one pixel wide pen the QRectF's boundary line will be rendered to the right and below the mathematical rectangle's boundary line.

When rendering with a two pixels wide pen the boundary line will be split in the middle by the mathematical rectangle. This will be the case whenever the pen is set to an even number of pixels, while rendering with a pen with an odd number of pixels, the spare pixel will be rendered to the right and below the mathematical rectangle as in the one pixel case.

Logical representation One pixel wide pen

Two pixel wide pen Three pixel wide pen

Coordinates

The QRectF class provides a collection of functions that return the various rectangle coordinates, and enable manipulation of these. QRectF also provide functions to move the rectangle relative to the various coordinates.

For example: the bottom(), setBottom() and moveBottom() functions: bottom() returns the y-coordinate of the rectangle's bottom edge, setBottom() sets the bottom edge of the rectangle to the given y coordinate (it may change the height, but will never change the rectangle's top edge) and moveBottom() moves the entire rectangle vertically, leaving the rectangle's bottom edge at the given y coordinate and its size unchanged.

It is also possible to add offsets to this rectangle's coordinates using the adjust() function, as well as retrieve a new rectangle based on adjustments of the original one using the adjusted() function. If either of the width and height is negative, use the normalized() function to retrieve a rectangle where the corners are swapped.

In addition, QRectF provides the getCoords() function which extracts the position of the rectangle's top-left and bottom-right corner, and the getRect() function which extracts the rectangle's top-left corner, width and height. Use the setCoords() and setRect() function to manipulate the rectangle's coordinates and dimensions in one go.

See also QRect and QRegion.

Constructor & Destructor Documentation

QtCore.QRectF.QRectF ( System.Type  dummy )

protected

QtCore.QRectF.QRectF

(

)

Constructs a null rectangle.

See also isNull().

QtCore.QRectF.QRectF

(

QRect

rect

)

Constructs a QRectF rectangle from the given QRect rectangle.

See also toRect().

QtCore.QRectF.QRectF

(

QRectF

copy

)

Constructs a null rectangle.

See also isNull().

QtCore.QRectF.QRectF	(	QPointF	topleft,
		QSizeF	size
	)

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

See also setTopLeft() and setSize().

QtCore.QRectF.QRectF	(	QPointF	topleft,
		QPointF	bottomRight
	)

Constructs a rectangle with the given topLeft and bottomRight corners.

This function was introduced in Qt 4.3.

See also setTopLeft() and setBottomRight().

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

Constructs a null rectangle.

See also isNull().

Member Function Documentation

new void QtCore.QRectF.Adjust	(	double	x1,
		double	y1,
		double	x2,
		double	y2
	)

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

See also adjusted() and setRect().

new QRectF QtCore.QRectF.Adjusted	(	double	x1,
		double	y1,
		double	x2,
		double	y2
	)

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

See also adjust().

new QPointF QtCore.QRectF.Center

(

)

Returns the center point of the rectangle.

See also moveCenter().

new bool QtCore.QRectF.Contains

(

QPointF

p

)

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

See also intersects().

new bool QtCore.QRectF.Contains

(

QRectF

r

)

This is an overloaded function.

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

new bool QtCore.QRectF.Contains	(	double	x,
		double	y
	)

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

See also intersects().

virtual void QtCore.QRectF.CreateProxy ( )

virtual

new void QtCore.QRectF.Dispose

(

)

override bool QtCore.QRectF.Equals

(

object

o

)

new void QtCore.QRectF.GetCoords	(	ref double	x1,
		ref double	y1,
		ref double	x2,
		ref double	y2
	)

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

override int QtCore.QRectF.GetHashCode

(

)

new void QtCore.QRectF.GetRect	(	ref double	x,
		ref double	y,
		ref double	w,
		ref double	h
	)

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

See also setRect() and getCoords().

new QRectF QtCore.QRectF.Intersect

(

QRectF

r

)

Use intersected(rectangle) instead.

new QRectF QtCore.QRectF.Intersected

(

QRectF

other

)

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

This function was introduced in Qt 4.2.

See also intersects(), united(), and operator&=().

new bool QtCore.QRectF.Intersects

(

QRectF

r

)

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

new bool QtCore.QRectF.IsEmpty

(

)

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(), and normalized().

new bool QtCore.QRectF.IsNull

(

)

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

new bool QtCore.QRectF.IsValid

(

)

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(), and normalized().

new void QtCore.QRectF.MoveBottom

(

double

pos

)

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(), and moveTop().

new void QtCore.QRectF.MoveBottomLeft

(

QPointF

p

)

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

See also setBottomLeft(), moveBottom(), and moveLeft().

new void QtCore.QRectF.MoveBottomRight

(

QPointF

p

)

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

See also setBottomRight(), moveBottom(), and moveRight().

new void QtCore.QRectF.MoveCenter

(

QPointF

p

)

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

See also center().

new void QtCore.QRectF.MoveLeft

(

double

pos

)

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(), and moveRight().

new void QtCore.QRectF.MoveRight

(

double

pos

)

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(), and moveLeft().

new void QtCore.QRectF.MoveTo

(

QPointF

p

)

This is an overloaded function.

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

new void QtCore.QRectF.MoveTo	(	double	x,
		double	t
	)

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

See also translate() and moveTopLeft().

new void QtCore.QRectF.MoveTop

(

double

pos

)

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

See also top(), setTop(), and moveBottom().

new void QtCore.QRectF.MoveTopLeft

(

QPointF

p

)

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

See also setTopLeft(), moveTop(), and moveLeft().

new void QtCore.QRectF.MoveTopRight

(

QPointF

p

)

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

See also setTopRight(), moveTop(), and moveRight().

new QRectF QtCore.QRectF.Normalized

(

)

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

static bool QtCore.QRectF.operator!= ( QRectF  arg1, QRectF  arg2  )

static

static QRectF QtCore.QRectF.operator& ( QRectF  arg1, QRectF  arg2  )

static

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

See also operator&=() and intersected().

static bool QtCore.QRectF.operator== ( QRectF  arg1, QRectF  arg2  )

static

static QRectF QtCore.QRectF.operator| ( QRectF  arg1, QRectF  arg2  )

static

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

See also united() and operator|=().

new void QtCore.QRectF.SetCoords	(	double	x1,
		double	y1,
		double	x2,
		double	y2
	)

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

new void QtCore.QRectF.SetRect	(	double	x,
		double	y,
		double	w,
		double	h
	)

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

new QRect QtCore.QRectF.ToAlignedRect

(

)

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

This function was introduced in Qt 4.3.

See also toRect().

new QRect QtCore.QRectF.ToRect

(

)

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

new void QtCore.QRectF.Translate

(

QPointF

p

)

This is an overloaded function.

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

new void QtCore.QRectF.Translate	(	double	dx,
		double	dy
	)

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.

See also moveTopLeft(), moveTo(), and translated().

new QRectF QtCore.QRectF.Translated

(

QPointF

p

)

This is an overloaded function.

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

new QRectF QtCore.QRectF.Translated	(	double	dx,
		double	dy
	)

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

new QRectF QtCore.QRectF.Unite

(

QRectF

r

)

Use united(rectangle) instead.

new QRectF QtCore.QRectF.United

(

QRectF

other

)

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

This function was introduced in Qt 4.2.

See also intersected().

Member Data Documentation

SmokeInvocation QtCore.QRectF.interceptor

protected

Property Documentation

new double QtCore.QRectF.Bottom

getset

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

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.

new QPointF QtCore.QRectF.BottomLeft

getset

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

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.

new QPointF QtCore.QRectF.BottomRight

getset

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

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.

new double QtCore.QRectF.Height

getset

Returns the height of the rectangle.

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

new double QtCore.QRectF.Left

getset

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

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

new double QtCore.QRectF.Right

getset

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

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.

new QSizeF QtCore.QRectF.Size

getset

Returns the size of the rectangle.

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

virtual System.IntPtr QtCore.QRectF.SmokeObject

getset

new double QtCore.QRectF.Top

getset

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

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

new QPointF QtCore.QRectF.TopLeft

getset

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

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.

new QPointF QtCore.QRectF.TopRight

getset

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

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.

new double QtCore.QRectF.Width

getset

Returns the width of the rectangle.

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

new double QtCore.QRectF.X

getset

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

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

new double QtCore.QRectF.Y

getset

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

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