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

API reference - Class QRectF

Notation used in Ruby API documentation

Description: Binding of QRectF

Public constructors

new QRectFnewConstructor QRectF::QRectF()
new QRectFnew(const QPointF topleft,
const QSizeF size)		Constructor QRectF::QRectF(const QPointF &topleft, const QSizeF &size)
new QRectFnew(const QPointF topleft,
const QPointF bottomRight)		Constructor QRectF::QRectF(const QPointF &topleft, const QPointF &bottomRight)
new QRectFnew(double left,
double top,
double width,
double height)		Constructor QRectF::QRectF(double left, double top, double width, double height)
new QRectFnew(const QRect rect)Constructor QRectF::QRectF(const QRect &rect)

Public methods

[const]bool!=(const QRectF arg2)Operator bool ::operator!=(const QRectF &, const QRectF &)
[const]QRectF&(const QRectF r)Method QRectF QRectF::operator&(const QRectF &r)
QRectF&=(const QRectF r)Method QRectF &QRectF::operator&=(const QRectF &r)
[const]bool==(const QRectF arg2)Operator bool ::operator==(const QRectF &, const QRectF &)
void_createEnsures the C++ object is created
void_destroyExplicitly 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_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidadjust(double x1,
double y1,
double x2,
double y2)		Method void QRectF::adjust(double x1, double y1, double x2, double y2)
[const]QRectFadjusted(double x1,
double y1,
double x2,
double y2)		Method QRectF QRectF::adjusted(double x1, double y1, double x2, double y2)
voidassign(const QRectF other)Assigns another object to self
[const]doublebottomMethod double QRectF::bottom()
voidbottom=(double pos)Method void QRectF::setBottom(double pos)
[const]QPointFbottomLeftMethod QPointF QRectF::bottomLeft()
voidbottomLeft=(const QPointF p)Method void QRectF::setBottomLeft(const QPointF &p)
[const]QPointFbottomRightMethod QPointF QRectF::bottomRight()
voidbottomRight=(const QPointF p)Method void QRectF::setBottomRight(const QPointF &p)
[const]QPointFcenterMethod QPointF QRectF::center()
[const]boolcontains(const QPointF p)Method bool QRectF::contains(const QPointF &p)
[const]boolcontains(double x,
double y)		Method bool QRectF::contains(double x, double y)
[const]boolcontains(const QRectF r)Method bool QRectF::contains(const QRectF &r)
[const]new QRectF ptrdupCreates a copy of self
[const]voidgetCoords(double ptr x1,
double ptr y1,
double ptr x2,
double ptr y2)		Method void QRectF::getCoords(double *x1, double *y1, double *x2, double *y2)
[const]voidgetRect(double ptr x,
double ptr y,
double ptr w,
double ptr h)		Method void QRectF::getRect(double *x, double *y, double *w, double *h)
[const]doubleheightMethod double QRectF::height()
voidheight=(double h)Method void QRectF::setHeight(double h)
[const]QRectFintersect(const QRectF r)Method QRectF QRectF::intersect(const QRectF &r)
[const]QRectFintersected(const QRectF other)Method QRectF QRectF::intersected(const QRectF &other)
[const]boolintersects(const QRectF r)Method bool QRectF::intersects(const QRectF &r)
[const]boolisEmpty?Method bool QRectF::isEmpty()
[const]boolisNull?Method bool QRectF::isNull()
[const]boolisValid?Method bool QRectF::isValid()
[const]doubleleftMethod double QRectF::left()
voidleft=(double pos)Method void QRectF::setLeft(double pos)
voidmoveBottom(double pos)Method void QRectF::moveBottom(double pos)
voidmoveBottomLeft(const QPointF p)Method void QRectF::moveBottomLeft(const QPointF &p)
voidmoveBottomRight(const QPointF p)Method void QRectF::moveBottomRight(const QPointF &p)
voidmoveCenter(const QPointF p)Method void QRectF::moveCenter(const QPointF &p)
voidmoveLeft(double pos)Method void QRectF::moveLeft(double pos)
voidmoveRight(double pos)Method void QRectF::moveRight(double pos)
voidmoveTo(double x,
double t)		Method void QRectF::moveTo(double x, double t)
voidmoveTo(const QPointF p)Method void QRectF::moveTo(const QPointF &p)
voidmoveTop(double pos)Method void QRectF::moveTop(double pos)
voidmoveTopLeft(const QPointF p)Method void QRectF::moveTopLeft(const QPointF &p)
voidmoveTopRight(const QPointF p)Method void QRectF::moveTopRight(const QPointF &p)
[const]QRectFnormalizedMethod QRectF QRectF::normalized()
[const]doublerightMethod double QRectF::right()
voidright=(double pos)Method void QRectF::setRight(double pos)
voidsetBottom(double pos)Method void QRectF::setBottom(double pos)
voidsetBottomLeft(const QPointF p)Method void QRectF::setBottomLeft(const QPointF &p)
voidsetBottomRight(const QPointF p)Method void QRectF::setBottomRight(const QPointF &p)
voidsetCoords(double x1,
double y1,
double x2,
double y2)		Method void QRectF::setCoords(double x1, double y1, double x2, double y2)
voidsetHeight(double h)Method void QRectF::setHeight(double h)
voidsetLeft(double pos)Method void QRectF::setLeft(double pos)
voidsetRect(double x,
double y,
double w,
double h)		Method void QRectF::setRect(double x, double y, double w, double h)
voidsetRight(double pos)Method void QRectF::setRight(double pos)
voidsetSize(const QSizeF s)Method void QRectF::setSize(const QSizeF &s)
voidsetTop(double pos)Method void QRectF::setTop(double pos)
voidsetTopLeft(const QPointF p)Method void QRectF::setTopLeft(const QPointF &p)
voidsetTopRight(const QPointF p)Method void QRectF::setTopRight(const QPointF &p)
voidsetWidth(double w)Method void QRectF::setWidth(double w)
voidsetX(double pos)Method void QRectF::setX(double pos)
voidsetY(double pos)Method void QRectF::setY(double pos)
[const]QSizeFsizeMethod QSizeF QRectF::size()
voidsize=(const QSizeF s)Method void QRectF::setSize(const QSizeF &s)
[const]QRecttoAlignedRectMethod QRect QRectF::toAlignedRect()
[const]QRecttoRectMethod QRect QRectF::toRect()
[const]doubletopMethod double QRectF::top()
voidtop=(double pos)Method void QRectF::setTop(double pos)
[const]QPointFtopLeftMethod QPointF QRectF::topLeft()
voidtopLeft=(const QPointF p)Method void QRectF::setTopLeft(const QPointF &p)
[const]QPointFtopRightMethod QPointF QRectF::topRight()
voidtopRight=(const QPointF p)Method void QRectF::setTopRight(const QPointF &p)
voidtranslate(double dx,
double dy)		Method void QRectF::translate(double dx, double dy)
voidtranslate(const QPointF p)Method void QRectF::translate(const QPointF &p)
[const]QRectFtranslated(double dx,
double dy)		Method QRectF QRectF::translated(double dx, double dy)
[const]QRectFtranslated(const QPointF p)Method QRectF QRectF::translated(const QPointF &p)
[const]QRectFunite(const QRectF r)Method QRectF QRectF::unite(const QRectF &r)
[const]QRectFunited(const QRectF other)Method QRectF QRectF::united(const QRectF &other)
[const]doublewidthMethod double QRectF::width()
voidwidth=(double w)Method void QRectF::setWidth(double w)
[const]doublexMethod double QRectF::x()
voidx=(double pos)Method void QRectF::setX(double pos)
[const]doubleyMethod double QRectF::y()
voidy=(double pos)Method void QRectF::setY(double pos)
[const]QRectF|(const QRectF r)Method QRectF QRectF::operator|(const QRectF &r)
QRectF|=(const QRectF r)Method QRectF &QRectF::operator|=(const QRectF &r)

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

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

[const] bool !=(const QRectF arg2)

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

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

[const] QRectF &(const QRectF r)

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

QRectF &=(const QRectF r)

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

[const] bool ==(const QRectF arg2)

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

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(double x1,double y1,double x2,double y2)

Description: Method void QRectF::adjust(double x1, double y1, double x2, double y2)

[const] QRectF adjusted(double x1,double y1,double x2,double y2)

Description: Method QRectF QRectF::adjusted(double x1, double y1, double x2, double y2)

void assign(const QRectF other)

Description: Assigns another object to self

[const] double bottom

Description: Method double QRectF::bottom()

Python specific notes:

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

void bottom=(double pos)

Description: Method void QRectF::setBottom(double pos)

Python specific notes:

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

[const] QPointF bottomLeft

Description: Method QPointF QRectF::bottomLeft()

Python specific notes:

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

void bottomLeft=(const QPointF p)

Description: Method void QRectF::setBottomLeft(const QPointF &p)

Python specific notes:

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

[const] QPointF bottomRight

Description: Method QPointF QRectF::bottomRight()

Python specific notes:

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

void bottomRight=(const QPointF p)

Description: Method void QRectF::setBottomRight(const QPointF &p)

Python specific notes:

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

[const] QPointF center

Description: Method QPointF QRectF::center()

[const] bool contains(const QPointF p)

Description: Method bool QRectF::contains(const QPointF &p)

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

Description: Method bool QRectF::contains(double x, double y)

[const] bool contains(const QRectF r)

Description: Method bool QRectF::contains(const QRectF &r)

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 QRectF ptr dup

Description: Creates a copy of self

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

Description: Method void QRectF::getCoords(double *x1, double *y1, double *x2, double *y2)

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

Description: Method void QRectF::getRect(double *x, double *y, double *w, double *h)

[const] double height

Description: Method double QRectF::height()

Python specific notes:

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

void height=(double h)

Description: Method void QRectF::setHeight(double h)

Python specific notes:

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

[const] QRectF intersect(const QRectF r)

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

[const] QRectF intersected(const QRectF other)

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

[const] bool intersects(const QRectF r)

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

[const] bool isEmpty?

Description: Method bool QRectF::isEmpty()

[const] bool isNull?

Description: Method bool QRectF::isNull()

[const] bool isValid?

Description: Method bool QRectF::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] double left

Description: Method double QRectF::left()

Python specific notes:

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

void left=(double pos)

Description: Method void QRectF::setLeft(double pos)

Python specific notes:

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

void moveBottom(double pos)

Description: Method void QRectF::moveBottom(double pos)

void moveBottomLeft(const QPointF p)

Description: Method void QRectF::moveBottomLeft(const QPointF &p)

void moveBottomRight(const QPointF p)

Description: Method void QRectF::moveBottomRight(const QPointF &p)

void moveCenter(const QPointF p)

Description: Method void QRectF::moveCenter(const QPointF &p)

void moveLeft(double pos)

Description: Method void QRectF::moveLeft(double pos)

void moveRight(double pos)

Description: Method void QRectF::moveRight(double pos)

void moveTo(double x,double t)

Description: Method void QRectF::moveTo(double x, double t)

void moveTo(const QPointF p)

Description: Method void QRectF::moveTo(const QPointF &p)

void moveTop(double pos)

Description: Method void QRectF::moveTop(double pos)

void moveTopLeft(const QPointF p)

Description: Method void QRectF::moveTopLeft(const QPointF &p)

void moveTopRight(const QPointF p)

Description: Method void QRectF::moveTopRight(const QPointF &p)

[static] new QRectF new

Description: Constructor QRectF::QRectF()

This method creates an object of class QRectF.

Python specific notes:

This method is the default initializer of the object

[static] new QRectF new(const QPointF topleft,const QSizeF size)

Description: Constructor QRectF::QRectF(const QPointF &topleft, const QSizeF &size)

This method creates an object of class QRectF.

Python specific notes:

This method is the default initializer of the object

[static] new QRectF new(const QPointF topleft,const QPointF bottomRight)

Description: Constructor QRectF::QRectF(const QPointF &topleft, const QPointF &bottomRight)

This method creates an object of class QRectF.

Python specific notes:

This method is the default initializer of the object

[static] new QRectF new(double left,double top,double width,double height)

Description: Constructor QRectF::QRectF(double left, double top, double width, double height)

This method creates an object of class QRectF.

Python specific notes:

This method is the default initializer of the object

[static] new QRectF new(const QRect rect)

Description: Constructor QRectF::QRectF(const QRect &rect)

This method creates an object of class QRectF.

Python specific notes:

This method is the default initializer of the object

[const] QRectF normalized

Description: Method QRectF QRectF::normalized()

[const] double right

Description: Method double QRectF::right()

Python specific notes:

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

void right=(double pos)

Description: Method void QRectF::setRight(double pos)

Python specific notes:

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

void setBottom(double pos)

Description: Method void QRectF::setBottom(double pos)

Python specific notes:

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

void setBottomLeft(const QPointF p)

Description: Method void QRectF::setBottomLeft(const QPointF &p)

Python specific notes:

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

void setBottomRight(const QPointF p)

Description: Method void QRectF::setBottomRight(const QPointF &p)

Python specific notes:

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

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

Description: Method void QRectF::setCoords(double x1, double y1, double x2, double y2)

void setHeight(double h)

Description: Method void QRectF::setHeight(double h)

Python specific notes:

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

void setLeft(double pos)

Description: Method void QRectF::setLeft(double pos)

Python specific notes:

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

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

Description: Method void QRectF::setRect(double x, double y, double w, double h)

void setRight(double pos)

Description: Method void QRectF::setRight(double pos)

Python specific notes:

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

void setSize(const QSizeF s)

Description: Method void QRectF::setSize(const QSizeF &s)

Python specific notes:

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

void setTop(double pos)

Description: Method void QRectF::setTop(double pos)

Python specific notes:

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

void setTopLeft(const QPointF p)

Description: Method void QRectF::setTopLeft(const QPointF &p)

Python specific notes:

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

void setTopRight(const QPointF p)

Description: Method void QRectF::setTopRight(const QPointF &p)

Python specific notes:

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

void setWidth(double w)

Description: Method void QRectF::setWidth(double w)

Python specific notes:

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

void setX(double pos)

Description: Method void QRectF::setX(double pos)

Python specific notes:

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

void setY(double pos)

Description: Method void QRectF::setY(double pos)

Python specific notes:

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

[const] QSizeF size

Description: Method QSizeF QRectF::size()

Python specific notes:

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

void size=(const QSizeF s)

Description: Method void QRectF::setSize(const QSizeF &s)

Python specific notes:

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

[const] QRect toAlignedRect

Description: Method QRect QRectF::toAlignedRect()

[const] QRect toRect

Description: Method QRect QRectF::toRect()

[const] double top

Description: Method double QRectF::top()

Python specific notes:

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

void top=(double pos)

Description: Method void QRectF::setTop(double pos)

Python specific notes:

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

[const] QPointF topLeft

Description: Method QPointF QRectF::topLeft()

Python specific notes:

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

void topLeft=(const QPointF p)

Description: Method void QRectF::setTopLeft(const QPointF &p)

Python specific notes:

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

[const] QPointF topRight

Description: Method QPointF QRectF::topRight()

Python specific notes:

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

void topRight=(const QPointF p)

Description: Method void QRectF::setTopRight(const QPointF &p)

Python specific notes:

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

void translate(double dx,double dy)

Description: Method void QRectF::translate(double dx, double dy)

void translate(const QPointF p)

Description: Method void QRectF::translate(const QPointF &p)

[const] QRectF translated(double dx,double dy)

Description: Method QRectF QRectF::translated(double dx, double dy)

[const] QRectF translated(const QPointF p)

Description: Method QRectF QRectF::translated(const QPointF &p)

[const] QRectF unite(const QRectF r)

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

[const] QRectF united(const QRectF other)

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

[const] double width

Description: Method double QRectF::width()

Python specific notes:

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

void width=(double w)

Description: Method void QRectF::setWidth(double w)

Python specific notes:

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

[const] double x

Description: Method double QRectF::x()

Python specific notes:

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

void x=(double pos)

Description: Method void QRectF::setX(double pos)

Python specific notes:

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

[const] double y

Description: Method double QRectF::y()

Python specific notes:

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

void y=(double pos)

Description: Method void QRectF::setY(double pos)

Python specific notes:

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

[const] QRectF |(const QRectF r)

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

QRectF |=(const QRectF r)

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