API reference - Class QSize

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QSize

Public constructors

new QSizenewConstructor QSize::QSize()
new QSizenew(int w,
int h)
Constructor QSize::QSize(int w, int h)

Public methods

[const]bool!=(const QSize s2)Operator bool ::operator!=(const QSize &s1, const QSize &s2)
[const]QSize*(double c)Operator const QSize ::operator*(const QSize &s, qreal c)
QSize*=(double c)Method QSize &QSize::operator*=(double c)
[const]QSize+(const QSize s2)Operator const QSize ::operator+(const QSize &s1, const QSize &s2)
QSize+=(const QSize arg1)Method QSize &QSize::operator+=(const QSize &)
[const]QSize-(const QSize s2)Operator const QSize ::operator-(const QSize &s1, const QSize &s2)
QSize-=(const QSize arg1)Method QSize &QSize::operator-=(const QSize &)
[const]QSize/(double c)Operator const QSize ::operator/(const QSize &s, qreal c)
QSize/=(double c)Method QSize &QSize::operator/=(double c)
[const]bool==(const QSize s2)Operator bool ::operator==(const QSize &s1, const QSize &s2)
[const]QSize 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 QSize other)Assigns another object to self
[const]QSizeboundedTo(const QSize arg1)Method QSize QSize::boundedTo(const QSize &)
[const]new QSize ptrdupCreates a copy of self
[const]QSizeexpandedTo(const QSize arg1)Method QSize QSize::expandedTo(const QSize &)
[const]intheightMethod int QSize::height()
voidheight=(int h)Method void QSize::setHeight(int h)
[const]boolisEmpty?Method bool QSize::isEmpty()
[const]boolisNull?Method bool QSize::isNull()
[const]boolisValid?Method bool QSize::isValid()
intrheightMethod int &QSize::rheight()
intrwidthMethod int &QSize::rwidth()
voidscale(int w,
int h,
const Qt_AspectRatioMode mode)
Method void QSize::scale(int w, int h, Qt::AspectRatioMode mode)
voidscale(const QSize s,
const Qt_AspectRatioMode mode)
Method void QSize::scale(const QSize &s, Qt::AspectRatioMode mode)
[const]QSizescaled(int w,
int h,
const Qt_AspectRatioMode mode)
Method QSize QSize::scaled(int w, int h, Qt::AspectRatioMode mode)
[const]QSizescaled(const QSize s,
const Qt_AspectRatioMode mode)
Method QSize QSize::scaled(const QSize &s, Qt::AspectRatioMode mode)
voidsetHeight(int h)Method void QSize::setHeight(int h)
voidsetWidth(int w)Method void QSize::setWidth(int w)
voidtransposeMethod void QSize::transpose()
[const]QSizetransposedMethod QSize QSize::transposed()
[const]intwidthMethod int QSize::width()
voidwidth=(int w)Method void QSize::setWidth(int 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 QSize s2)

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

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

*

Signature: [const] QSize * (double c)

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

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

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

*=

Signature: QSize *= (double c)

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

+

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

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

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

+=

Signature: QSize += (const QSize arg1)

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

-

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

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

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

-=

Signature: QSize -= (const QSize arg1)

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

/

Signature: [const] QSize / (double c)

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

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

/=

Signature: QSize /= (double c)

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

==

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

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

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

_const_cast

Signature: [const] QSize 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 QSize other)

Description: Assigns another object to self

boundedTo

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

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

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

Description: Creates a copy of self

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

expandedTo

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

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

height

Signature: [const] int height

Description: Method int QSize::height()

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

height=

Signature: void height= (int h)

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

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

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QSize::isEmpty()

isNull?

Signature: [const] bool isNull?

Description: Method bool QSize::isNull()

isValid?

Signature: [const] bool isValid?

Description: Method bool QSize::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 QSize new

Description: Constructor QSize::QSize()

This method creates an object of class QSize.

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

(2) Signature: [static] new QSize new (int w, int h)

Description: Constructor QSize::QSize(int w, int h)

This method creates an object of class QSize.

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

rheight

Signature: int rheight

Description: Method int &QSize::rheight()

rwidth

Signature: int rwidth

Description: Method int &QSize::rwidth()

scale

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

Description: Method void QSize::scale(int w, int h, Qt::AspectRatioMode mode)

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

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

scaled

(1) Signature: [const] QSize scaled (int w, int h, const Qt_AspectRatioMode mode)

Description: Method QSize QSize::scaled(int w, int h, Qt::AspectRatioMode mode)

(2) Signature: [const] QSize scaled (const QSize s, const Qt_AspectRatioMode mode)

Description: Method QSize QSize::scaled(const QSize &s, Qt::AspectRatioMode mode)

setHeight

Signature: void setHeight (int h)

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

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

setWidth

Signature: void setWidth (int w)

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

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

transpose

Signature: void transpose

Description: Method void QSize::transpose()

transposed

Signature: [const] QSize transposed

Description: Method QSize QSize::transposed()

width

Signature: [const] int width

Description: Method int QSize::width()

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

width=

Signature: void width= (int w)

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

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