KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QSizeF

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QSizeF

Public constructors

new QSizeFnewConstructor QSizeF::QSizeF()
new QSizeFnew(const QSize sz)Constructor QSizeF::QSizeF(const QSize &sz)
new QSizeFnew(double w,
double h)
Constructor QSizeF::QSizeF(double w, double h)

Public methods

[const]bool!=(const QSizeF s2)Operator bool ::operator!=(const QSizeF &s1, const QSizeF &s2)
[const]QSizeF*(double c)Operator const QSizeF ::operator*(const QSizeF &s, qreal c)
QSizeF*=(double c)Method QSizeF &QSizeF::operator*=(double c)
[const]QSizeF+(const QSizeF s2)Operator const QSizeF ::operator+(const QSizeF &s1, const QSizeF &s2)
QSizeF+=(const QSizeF arg1)Method QSizeF &QSizeF::operator+=(const QSizeF &)
[const]QSizeF-(const QSizeF s2)Operator const QSizeF ::operator-(const QSizeF &s1, const QSizeF &s2)
QSizeF-=(const QSizeF arg1)Method QSizeF &QSizeF::operator-=(const QSizeF &)
[const]QSizeF/(double c)Operator const QSizeF ::operator/(const QSizeF &s, qreal c)
QSizeF/=(double c)Method QSizeF &QSizeF::operator/=(double c)
[const]bool==(const QSizeF s2)Operator bool ::operator==(const QSizeF &s1, const QSizeF &s2)
[const]QSizeF ptr_const_castReturns a non-const reference to self.
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.
voidassign(const QSizeF other)Assigns another object to self
[const]QSizeFboundedTo(const QSizeF arg1)Method QSizeF QSizeF::boundedTo(const QSizeF &)
[const]new QSizeF ptrdupCreates a copy of self
[const]QSizeFexpandedTo(const QSizeF arg1)Method QSizeF QSizeF::expandedTo(const QSizeF &)
[const]doubleheightMethod double QSizeF::height()
voidheight=(double h)Method void QSizeF::setHeight(double h)
[const]boolisEmpty?Method bool QSizeF::isEmpty()
[const]boolisNull?Method bool QSizeF::isNull()
[const]boolisValid?Method bool QSizeF::isValid()
doublerheightMethod double &QSizeF::rheight()
doublerwidthMethod double &QSizeF::rwidth()
voidscale(double w,
double h,
const Qt_AspectRatioMode mode)
Method void QSizeF::scale(double w, double h, Qt::AspectRatioMode mode)
voidscale(const QSizeF s,
const Qt_AspectRatioMode mode)
Method void QSizeF::scale(const QSizeF &s, Qt::AspectRatioMode mode)
voidsetHeight(double h)Method void QSizeF::setHeight(double h)
voidsetWidth(double w)Method void QSizeF::setWidth(double w)
[const]QSizetoSizeMethod QSize QSizeF::toSize()
voidtransposeMethod void QSizeF::transpose()
[const]doublewidthMethod double QSizeF::width()
voidwidth=(double w)Method void QSizeF::setWidth(double w)

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

!=

Signature: [const] bool != (const QSizeF s2)

Description: Operator bool ::operator!=(const QSizeF &s1, const QSizeF &s2)

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

*

Signature: [const] QSizeF * (double c)

Description: Operator const QSizeF ::operator*(const QSizeF &s, qreal c)

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

Python specific notes:
This method also implements '__rmul__'.

*=

Signature: QSizeF *= (double c)

Description: Method QSizeF &QSizeF::operator*=(double c)

+

Signature: [const] QSizeF + (const QSizeF s2)

Description: Operator const QSizeF ::operator+(const QSizeF &s1, const QSizeF &s2)

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

+=

Signature: QSizeF += (const QSizeF arg1)

Description: Method QSizeF &QSizeF::operator+=(const QSizeF &)

-

Signature: [const] QSizeF - (const QSizeF s2)

Description: Operator const QSizeF ::operator-(const QSizeF &s1, const QSizeF &s2)

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

-=

Signature: QSizeF -= (const QSizeF arg1)

Description: Method QSizeF &QSizeF::operator-=(const QSizeF &)

/

Signature: [const] QSizeF / (double c)

Description: Operator const QSizeF ::operator/(const QSizeF &s, qreal c)

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

/=

Signature: QSizeF /= (double c)

Description: Method QSizeF &QSizeF::operator/=(double c)

==

Signature: [const] bool == (const QSizeF s2)

Description: Operator bool ::operator==(const QSizeF &s1, const QSizeF &s2)

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

_const_cast

Signature: [const] QSizeF ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: 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.

_destroy

Signature: 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.

_destroyed?

Signature: [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.

_is_const_object?

Signature: [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.

_manage

Signature: 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.

_unmanage

Signature: 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.

assign

Signature: void assign (const QSizeF other)

Description: Assigns another object to self

boundedTo

Signature: [const] QSizeF boundedTo (const QSizeF arg1)

Description: Method QSizeF QSizeF::boundedTo(const QSizeF &)

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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.

destroyed?

Signature: [const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

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.

dup

Signature: [const] new QSizeF ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

expandedTo

Signature: [const] QSizeF expandedTo (const QSizeF arg1)

Description: Method QSizeF QSizeF::expandedTo(const QSizeF &)

height

Signature: [const] double height

Description: Method double QSizeF::height()

Python specific notes:
The object exposes a readable attribute 'height'. This is the getter.

height=

Signature: void height= (double h)

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

Python specific notes:
The object exposes a writable attribute 'height'. This is the setter.

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QSizeF::isEmpty()

isNull?

Signature: [const] bool isNull?

Description: Method bool QSizeF::isNull()

isValid?

Signature: [const] bool isValid?

Description: Method bool QSizeF::isValid()

is_const_object?

Signature: [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

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

new

(1) Signature: [static] new QSizeF new

Description: Constructor QSizeF::QSizeF()

This method creates an object of class QSizeF.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QSizeF new (const QSize sz)

Description: Constructor QSizeF::QSizeF(const QSize &sz)

This method creates an object of class QSizeF.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QSizeF new (double w, double h)

Description: Constructor QSizeF::QSizeF(double w, double h)

This method creates an object of class QSizeF.

Python specific notes:
This method is the default initializer of the object.

rheight

Signature: double rheight

Description: Method double &QSizeF::rheight()

rwidth

Signature: double rwidth

Description: Method double &QSizeF::rwidth()

scale

(1) Signature: void scale (double w, double h, const Qt_AspectRatioMode mode)

Description: Method void QSizeF::scale(double w, double h, Qt::AspectRatioMode mode)

(2) Signature: void scale (const QSizeF s, const Qt_AspectRatioMode mode)

Description: Method void QSizeF::scale(const QSizeF &s, Qt::AspectRatioMode mode)

setHeight

Signature: void setHeight (double h)

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

Python specific notes:
The object exposes a writable attribute 'height'. This is the setter.

setWidth

Signature: void setWidth (double w)

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

Python specific notes:
The object exposes a writable attribute 'width'. This is the setter.

toSize

Signature: [const] QSize toSize

Description: Method QSize QSizeF::toSize()

transpose

Signature: void transpose

Description: Method void QSizeF::transpose()

width

Signature: [const] double width

Description: Method double QSizeF::width()

Python specific notes:
The object exposes a readable attribute 'width'. This is the getter.

width=

Signature: void width= (double w)

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

Python specific notes:
The object exposes a writable attribute 'width'. This is the setter.