KLayout Manual: Main Index » Class Index » API reference - Class QRect

API reference - Class QRect

Description: Binding of QRect

Public constructors
Public methods
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description

Public constructors

new QRect	new		Constructor QRect::QRect()
new QRect	new	(const QPoint topleft, const QPoint bottomright)	Constructor QRect::QRect(const QPoint &topleft, const QPoint &bottomright)
new QRect	new	(const QPoint topleft, const QSize size)	Constructor QRect::QRect(const QPoint &topleft, const QSize &size)
new QRect	new	(int left, int top, int width, int height)	Constructor QRect::QRect(int left, int top, int width, int height)

Public methods

[const]	bool	!=	(const QRect arg2)	Operator bool ::operator!=(const QRect &, const QRect &)
[const]	QRect	&	(const QRect r)	Method QRect QRect::operator&(const QRect &r)
	QRect	&=	(const QRect r)	Method QRect &QRect::operator&=(const QRect &r)
[const]	bool	==	(const QRect arg2)	Operator bool ::operator==(const QRect &, const QRect &)
	void	_create		Ensures the C++ object is created
	void	_destroy		Explicitly destroys the object
[const]	bool	_destroyed?		Returns a value indicating whether the object was already destroyed
[const]	bool	_is_const_object?		Returns a value indicating whether the reference is a const reference
	void	_manage		Marks the object as managed by the script side.
	void	_unmanage		Marks the object as no longer owned by the script side.
	void	adjust	(int x1, int y1, int x2, int y2)	Method void QRect::adjust(int x1, int y1, int x2, int y2)
[const]	QRect	adjusted	(int x1, int y1, int x2, int y2)	Method QRect QRect::adjusted(int x1, int y1, int x2, int y2)
	void	assign	(const QRect other)	Assigns another object to self
[const]	int	bottom		Method int QRect::bottom()
	void	bottom=	(int pos)	Method void QRect::setBottom(int pos)
[const]	QPoint	bottomLeft		Method QPoint QRect::bottomLeft()
	void	bottomLeft=	(const QPoint p)	Method void QRect::setBottomLeft(const QPoint &p)
[const]	QPoint	bottomRight		Method QPoint QRect::bottomRight()
	void	bottomRight=	(const QPoint p)	Method void QRect::setBottomRight(const QPoint &p)
[const]	QPoint	center		Method QPoint QRect::center()
[const]	bool	contains	(const QPoint p, bool proper = false)	Method bool QRect::contains(const QPoint &p, bool proper)
[const]	bool	contains	(int x, int y)	Method bool QRect::contains(int x, int y)
[const]	bool	contains	(int x, int y, bool proper)	Method bool QRect::contains(int x, int y, bool proper)
[const]	bool	contains	(const QRect r, bool proper = false)	Method bool QRect::contains(const QRect &r, bool proper)
[const]	new QRect ptr	dup		Creates a copy of self
[const]	void	getCoords	(int ptr x1, int ptr y1, int ptr x2, int ptr y2)	Method void QRect::getCoords(int x1, int y1, int x2, int y2)
[const]	void	getRect	(int ptr x, int ptr y, int ptr w, int ptr h)	Method void QRect::getRect(int x, int y, int w, int h)
[const]	int	height		Method int QRect::height()
	void	height=	(int h)	Method void QRect::setHeight(int h)
[const]	QRect	intersect	(const QRect r)	Method QRect QRect::intersect(const QRect &r)
[const]	QRect	intersected	(const QRect other)	Method QRect QRect::intersected(const QRect &other)
[const]	bool	intersects	(const QRect r)	Method bool QRect::intersects(const QRect &r)
[const]	bool	isEmpty?		Method bool QRect::isEmpty()
[const]	bool	isNull?		Method bool QRect::isNull()
[const]	bool	isValid?		Method bool QRect::isValid()
[const]	int	left		Method int QRect::left()
	void	left=	(int pos)	Method void QRect::setLeft(int pos)
	void	moveBottom	(int pos)	Method void QRect::moveBottom(int pos)
	void	moveBottomLeft	(const QPoint p)	Method void QRect::moveBottomLeft(const QPoint &p)
	void	moveBottomRight	(const QPoint p)	Method void QRect::moveBottomRight(const QPoint &p)
	void	moveCenter	(const QPoint p)	Method void QRect::moveCenter(const QPoint &p)
	void	moveLeft	(int pos)	Method void QRect::moveLeft(int pos)
	void	moveRight	(int pos)	Method void QRect::moveRight(int pos)
	void	moveTo	(int x, int t)	Method void QRect::moveTo(int x, int t)
	void	moveTo	(const QPoint p)	Method void QRect::moveTo(const QPoint &p)
	void	moveTop	(int pos)	Method void QRect::moveTop(int pos)
	void	moveTopLeft	(const QPoint p)	Method void QRect::moveTopLeft(const QPoint &p)
	void	moveTopRight	(const QPoint p)	Method void QRect::moveTopRight(const QPoint &p)
[const]	QRect	normalized		Method QRect QRect::normalized()
[const]	int	right		Method int QRect::right()
	void	right=	(int pos)	Method void QRect::setRight(int pos)
	void	setBottom	(int pos)	Method void QRect::setBottom(int pos)
	void	setBottomLeft	(const QPoint p)	Method void QRect::setBottomLeft(const QPoint &p)
	void	setBottomRight	(const QPoint p)	Method void QRect::setBottomRight(const QPoint &p)
	void	setCoords	(int x1, int y1, int x2, int y2)	Method void QRect::setCoords(int x1, int y1, int x2, int y2)
	void	setHeight	(int h)	Method void QRect::setHeight(int h)
	void	setLeft	(int pos)	Method void QRect::setLeft(int pos)
	void	setRect	(int x, int y, int w, int h)	Method void QRect::setRect(int x, int y, int w, int h)
	void	setRight	(int pos)	Method void QRect::setRight(int pos)
	void	setSize	(const QSize s)	Method void QRect::setSize(const QSize &s)
	void	setTop	(int pos)	Method void QRect::setTop(int pos)
	void	setTopLeft	(const QPoint p)	Method void QRect::setTopLeft(const QPoint &p)
	void	setTopRight	(const QPoint p)	Method void QRect::setTopRight(const QPoint &p)
	void	setWidth	(int w)	Method void QRect::setWidth(int w)
	void	setX	(int x)	Method void QRect::setX(int x)
	void	setY	(int y)	Method void QRect::setY(int y)
[const]	QSize	size		Method QSize QRect::size()
	void	size=	(const QSize s)	Method void QRect::setSize(const QSize &s)
[const]	int	top		Method int QRect::top()
	void	top=	(int pos)	Method void QRect::setTop(int pos)
[const]	QPoint	topLeft		Method QPoint QRect::topLeft()
	void	topLeft=	(const QPoint p)	Method void QRect::setTopLeft(const QPoint &p)
[const]	QPoint	topRight		Method QPoint QRect::topRight()
	void	topRight=	(const QPoint p)	Method void QRect::setTopRight(const QPoint &p)
	void	translate	(int dx, int dy)	Method void QRect::translate(int dx, int dy)
	void	translate	(const QPoint p)	Method void QRect::translate(const QPoint &p)
[const]	QRect	translated	(int dx, int dy)	Method QRect QRect::translated(int dx, int dy)
[const]	QRect	translated	(const QPoint p)	Method QRect QRect::translated(const QPoint &p)
[const]	QRect	unite	(const QRect r)	Method QRect QRect::unite(const QRect &r)
[const]	QRect	united	(const QRect other)	Method QRect QRect::united(const QRect &other)
[const]	int	width		Method int QRect::width()
	void	width=	(int w)	Method void QRect::setWidth(int w)
[const]	int	x		Method int QRect::x()
	void	x=	(int x)	Method void QRect::setX(int x)
[const]	int	y		Method int QRect::y()
	void	y=	(int y)	Method void QRect::setY(int y)
[const]	QRect	\|	(const QRect r)	Method QRect QRect::operator\|(const QRect &r)
	QRect	\|=	(const QRect r)	Method QRect &QRect::operator\|=(const QRect &r)

Deprecated methods (protected, public, static, non-static and constructors)

	void	create	Use of this method is deprecated. Use _create instead
	void	destroy	Use of this method is deprecated. Use _destroy instead
[const]	bool	destroyed?	Use of this method is deprecated. Use _destroyed? instead
[const]	bool	is_const_object?	Use of this method is deprecated. Use _is_const_object? instead

Detailed description

[const] bool !=(const QRect arg2)

Description: Operator bool ::operator!=(const QRect &, const QRect &)

This is the mapping of the global operator to the instance method.

[const] QRect &(const QRect r)

Description: Method QRect QRect::operator&(const QRect &r)

QRect &=(const QRect r)

Description: Method QRect &QRect::operator&=(const QRect &r)

[const] bool ==(const QRect arg2)

Description: Operator bool ::operator==(const QRect &, const QRect &)

This is the mapping of the global operator to the instance method.

void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

[const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

void adjust(int x1,int y1,int x2,int y2)

Description: Method void QRect::adjust(int x1, int y1, int x2, int y2)

[const] QRect adjusted(int x1,int y1,int x2,int y2)

Description: Method QRect QRect::adjusted(int x1, int y1, int x2, int y2)

void assign(const QRect other)

Description: Assigns another object to self

[const] int bottom

Description: Method int QRect::bottom()

Python specific notes:

The object exposes a readable attribute 'bottom'. This is the getter.

void bottom=(int pos)

Description: Method void QRect::setBottom(int pos)

Python specific notes:

The object exposes a writable attribute 'bottom'. This is the setter.

[const] QPoint bottomLeft

Description: Method QPoint QRect::bottomLeft()

Python specific notes:

The object exposes a readable attribute 'bottomLeft'. This is the getter.

void bottomLeft=(const QPoint p)

Description: Method void QRect::setBottomLeft(const QPoint &p)

Python specific notes:

The object exposes a writable attribute 'bottomLeft'. This is the setter.

[const] QPoint bottomRight

Description: Method QPoint QRect::bottomRight()

Python specific notes:

The object exposes a readable attribute 'bottomRight'. This is the getter.

void bottomRight=(const QPoint p)

Description: Method void QRect::setBottomRight(const QPoint &p)

Python specific notes:

The object exposes a writable attribute 'bottomRight'. This is the setter.

[const] QPoint center

Description: Method QPoint QRect::center()

[const] bool contains(const QPoint p,bool proper = false)

Description: Method bool QRect::contains(const QPoint &p, bool proper)

[const] bool contains(int x,int y)

Description: Method bool QRect::contains(int x, int y)

[const] bool contains(int x,int y,bool proper)

Description: Method bool QRect::contains(int x, int y, bool proper)

[const] bool contains(const QRect r,bool proper = false)

Description: Method bool QRect::contains(const QRect &r, bool proper)

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] new QRect ptr dup

Description: Creates a copy of self

[const] void getCoords(int ptr x1,int ptr y1,int ptr x2,int ptr y2)

Description: Method void QRect::getCoords(int *x1, int *y1, int *x2, int *y2)

[const] void getRect(int ptr x,int ptr y,int ptr w,int ptr h)

Description: Method void QRect::getRect(int *x, int *y, int *w, int *h)

[const] int height

Description: Method int QRect::height()

Python specific notes:

The object exposes a readable attribute 'height'. This is the getter.

void height=(int h)

Description: Method void QRect::setHeight(int h)

Python specific notes:

The object exposes a writable attribute 'height'. This is the setter.

[const] QRect intersect(const QRect r)

Description: Method QRect QRect::intersect(const QRect &r)

[const] QRect intersected(const QRect other)

Description: Method QRect QRect::intersected(const QRect &other)

[const] bool intersects(const QRect r)

Description: Method bool QRect::intersects(const QRect &r)

[const] bool isEmpty?

Description: Method bool QRect::isEmpty()

[const] bool isNull?

Description: Method bool QRect::isNull()

[const] bool isValid?

Description: Method bool QRect::isValid()

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

[const] int left

Description: Method int QRect::left()

Python specific notes:

The object exposes a readable attribute 'left'. This is the getter.

void left=(int pos)

Description: Method void QRect::setLeft(int pos)

Python specific notes:

The object exposes a writable attribute 'left'. This is the setter.

void moveBottom(int pos)

Description: Method void QRect::moveBottom(int pos)

void moveBottomLeft(const QPoint p)

Description: Method void QRect::moveBottomLeft(const QPoint &p)

void moveBottomRight(const QPoint p)

Description: Method void QRect::moveBottomRight(const QPoint &p)

void moveCenter(const QPoint p)

Description: Method void QRect::moveCenter(const QPoint &p)

void moveLeft(int pos)

Description: Method void QRect::moveLeft(int pos)

void moveRight(int pos)

Description: Method void QRect::moveRight(int pos)

void moveTo(int x,int t)

Description: Method void QRect::moveTo(int x, int t)

void moveTo(const QPoint p)

Description: Method void QRect::moveTo(const QPoint &p)

void moveTop(int pos)

Description: Method void QRect::moveTop(int pos)

void moveTopLeft(const QPoint p)

Description: Method void QRect::moveTopLeft(const QPoint &p)

void moveTopRight(const QPoint p)

Description: Method void QRect::moveTopRight(const QPoint &p)

[static] new QRect new

Description: Constructor QRect::QRect()

This method creates an object of class QRect.

Python specific notes:

This method is the default initializer of the object

[static] new QRect new(const QPoint topleft,const QPoint bottomright)

Description: Constructor QRect::QRect(const QPoint &topleft, const QPoint &bottomright)

This method creates an object of class QRect.

Python specific notes:

This method is the default initializer of the object

[static] new QRect new(const QPoint topleft,const QSize size)

Description: Constructor QRect::QRect(const QPoint &topleft, const QSize &size)

This method creates an object of class QRect.

Python specific notes:

This method is the default initializer of the object

[static] new QRect new(int left,int top,int width,int height)

Description: Constructor QRect::QRect(int left, int top, int width, int height)

This method creates an object of class QRect.

Python specific notes:

This method is the default initializer of the object

[const] QRect normalized

Description: Method QRect QRect::normalized()

[const] int right

Description: Method int QRect::right()

Python specific notes:

The object exposes a readable attribute 'right'. This is the getter.

void right=(int pos)

Description: Method void QRect::setRight(int pos)

Python specific notes:

The object exposes a writable attribute 'right'. This is the setter.

void setBottom(int pos)

Description: Method void QRect::setBottom(int pos)

Python specific notes:

The object exposes a writable attribute 'bottom'. This is the setter.

void setBottomLeft(const QPoint p)

Description: Method void QRect::setBottomLeft(const QPoint &p)

Python specific notes:

The object exposes a writable attribute 'bottomLeft'. This is the setter.

void setBottomRight(const QPoint p)

Description: Method void QRect::setBottomRight(const QPoint &p)

Python specific notes:

The object exposes a writable attribute 'bottomRight'. This is the setter.

void setCoords(int x1,int y1,int x2,int y2)

Description: Method void QRect::setCoords(int x1, int y1, int x2, int y2)

void setHeight(int h)

Description: Method void QRect::setHeight(int h)

Python specific notes:

The object exposes a writable attribute 'height'. This is the setter.

void setLeft(int pos)

Description: Method void QRect::setLeft(int pos)

Python specific notes:

The object exposes a writable attribute 'left'. This is the setter.

void setRect(int x,int y,int w,int h)

Description: Method void QRect::setRect(int x, int y, int w, int h)

void setRight(int pos)

Description: Method void QRect::setRight(int pos)

Python specific notes:

The object exposes a writable attribute 'right'. This is the setter.

void setSize(const QSize s)

Description: Method void QRect::setSize(const QSize &s)

Python specific notes:

The object exposes a writable attribute 'size'. This is the setter.

void setTop(int pos)

Description: Method void QRect::setTop(int pos)

Python specific notes:

The object exposes a writable attribute 'top'. This is the setter.

void setTopLeft(const QPoint p)

Description: Method void QRect::setTopLeft(const QPoint &p)

Python specific notes:

The object exposes a writable attribute 'topLeft'. This is the setter.

void setTopRight(const QPoint p)

Description: Method void QRect::setTopRight(const QPoint &p)

Python specific notes:

The object exposes a writable attribute 'topRight'. This is the setter.

void setWidth(int w)

Description: Method void QRect::setWidth(int w)

Python specific notes:

The object exposes a writable attribute 'width'. This is the setter.

void setX(int x)

Description: Method void QRect::setX(int x)

Python specific notes:

The object exposes a writable attribute 'x'. This is the setter.

void setY(int y)

Description: Method void QRect::setY(int y)

Python specific notes:

The object exposes a writable attribute 'y'. This is the setter.

[const] QSize size

Description: Method QSize QRect::size()

Python specific notes:

The object exposes a readable attribute 'size'. This is the getter.

void size=(const QSize s)

Description: Method void QRect::setSize(const QSize &s)

Python specific notes:

The object exposes a writable attribute 'size'. This is the setter.

[const] int top

Description: Method int QRect::top()

Python specific notes:

The object exposes a readable attribute 'top'. This is the getter.

void top=(int pos)

Description: Method void QRect::setTop(int pos)

Python specific notes:

The object exposes a writable attribute 'top'. This is the setter.

[const] QPoint topLeft

Description: Method QPoint QRect::topLeft()

Python specific notes:

The object exposes a readable attribute 'topLeft'. This is the getter.

void topLeft=(const QPoint p)

Description: Method void QRect::setTopLeft(const QPoint &p)

Python specific notes:

The object exposes a writable attribute 'topLeft'. This is the setter.

[const] QPoint topRight

Description: Method QPoint QRect::topRight()

Python specific notes:

The object exposes a readable attribute 'topRight'. This is the getter.

void topRight=(const QPoint p)

Description: Method void QRect::setTopRight(const QPoint &p)

Python specific notes:

The object exposes a writable attribute 'topRight'. This is the setter.

void translate(int dx,int dy)

Description: Method void QRect::translate(int dx, int dy)

void translate(const QPoint p)

Description: Method void QRect::translate(const QPoint &p)

[const] QRect translated(int dx,int dy)

Description: Method QRect QRect::translated(int dx, int dy)

[const] QRect translated(const QPoint p)

Description: Method QRect QRect::translated(const QPoint &p)

[const] QRect unite(const QRect r)

Description: Method QRect QRect::unite(const QRect &r)

[const] QRect united(const QRect other)

Description: Method QRect QRect::united(const QRect &other)

[const] int width

Description: Method int QRect::width()

Python specific notes:

The object exposes a readable attribute 'width'. This is the getter.

void width=(int w)

Description: Method void QRect::setWidth(int w)

Python specific notes:

The object exposes a writable attribute 'width'. This is the setter.

[const] int x

Description: Method int QRect::x()

Python specific notes:

The object exposes a readable attribute 'x'. This is the getter.

void x=(int x)

Description: Method void QRect::setX(int x)

Python specific notes:

The object exposes a writable attribute 'x'. This is the setter.

[const] int y

Description: Method int QRect::y()

Python specific notes:

The object exposes a readable attribute 'y'. This is the getter.

void y=(int y)

Description: Method void QRect::setY(int y)

Python specific notes:

The object exposes a writable attribute 'y'. This is the setter.

[const] QRect |(const QRect r)

Description: Method QRect QRect::operator|(const QRect &r)

QRect |=(const QRect r)

Description: Method QRect &QRect::operator|=(const QRect &r)