API reference - Class QPoint

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QPoint

Public constructors

new QPointnewConstructor QPoint::QPoint()
new QPointnew(int xpos,
int ypos)
Constructor QPoint::QPoint(int xpos, int ypos)

Public methods

[const]bool!=(const QPoint p2)Operator bool ::operator!=(const QPoint &p1, const QPoint &p2)
[const]QPoint*(float factor)Operator const QPoint ::operator*(const QPoint &p, float factor)
[const]QPoint*(double factor)Operator const QPoint ::operator*(const QPoint &p, double factor)
[const]QPoint*(int factor)Operator const QPoint ::operator*(const QPoint &p, int factor)
QPoint*=(float factor)Method QPoint &QPoint::operator*=(float factor)
QPoint*=(double factor)Method QPoint &QPoint::operator*=(double factor)
QPoint*=(int factor)Method QPoint &QPoint::operator*=(int factor)
[const]QPoint+(const QPoint p2)Operator const QPoint ::operator+(const QPoint &p1, const QPoint &p2)
[const]QPoint+Operator const QPoint ::operator+(const QPoint &p)
QPoint+=(const QPoint p)Method QPoint &QPoint::operator+=(const QPoint &p)
[const]QPoint-(const QPoint p2)Operator const QPoint ::operator-(const QPoint &p1, const QPoint &p2)
[const]QPoint-Operator const QPoint ::operator-(const QPoint &p)
QPoint-=(const QPoint p)Method QPoint &QPoint::operator-=(const QPoint &p)
[const]QPoint/(double c)Operator const QPoint ::operator/(const QPoint &p, qreal c)
QPoint/=(double divisor)Method QPoint &QPoint::operator/=(double divisor)
[const]bool==(const QPoint p2)Operator bool ::operator==(const QPoint &p1, const QPoint &p2)
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 QPoint other)Assigns another object to self
[const]new QPoint ptrdupCreates a copy of self
[const]boolisNull?Method bool QPoint::isNull()
[const]intmanhattanLengthMethod int QPoint::manhattanLength()
intrxMethod int &QPoint::rx()
intryMethod int &QPoint::ry()
voidsetX(int x)Method void QPoint::setX(int x)
voidsetY(int y)Method void QPoint::setY(int y)
[const]intxMethod int QPoint::x()
voidx=(int x)Method void QPoint::setX(int x)
[const]intyMethod int QPoint::y()
voidy=(int y)Method void QPoint::setY(int y)

Public static methods and constants

intdotProduct(const QPoint p1,
const QPoint p2)
Static method int QPoint::dotProduct(const QPoint &p1, const QPoint &p2)

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 QPoint p2)

Description: Operator bool ::operator!=(const QPoint &p1, const QPoint &p2)

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

*

(1) Signature: [const] QPoint * (float factor)

Description: Operator const QPoint ::operator*(const QPoint &p, float factor)

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

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

(2) Signature: [const] QPoint * (double factor)

Description: Operator const QPoint ::operator*(const QPoint &p, double factor)

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

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

(3) Signature: [const] QPoint * (int factor)

Description: Operator const QPoint ::operator*(const QPoint &p, int factor)

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

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

*=

(1) Signature: QPoint *= (float factor)

Description: Method QPoint &QPoint::operator*=(float factor)

(2) Signature: QPoint *= (double factor)

Description: Method QPoint &QPoint::operator*=(double factor)

(3) Signature: QPoint *= (int factor)

Description: Method QPoint &QPoint::operator*=(int factor)

+

(1) Signature: [const] QPoint + (const QPoint p2)

Description: Operator const QPoint ::operator+(const QPoint &p1, const QPoint &p2)

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

(2) Signature: [const] QPoint +

Description: Operator const QPoint ::operator+(const QPoint &p)

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

+=

Signature: QPoint += (const QPoint p)

Description: Method QPoint &QPoint::operator+=(const QPoint &p)

-

(1) Signature: [const] QPoint - (const QPoint p2)

Description: Operator const QPoint ::operator-(const QPoint &p1, const QPoint &p2)

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

(2) Signature: [const] QPoint -

Description: Operator const QPoint ::operator-(const QPoint &p)

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

-=

Signature: QPoint -= (const QPoint p)

Description: Method QPoint &QPoint::operator-=(const QPoint &p)

/

Signature: [const] QPoint / (double c)

Description: Operator const QPoint ::operator/(const QPoint &p, qreal c)

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

/=

Signature: QPoint /= (double divisor)

Description: Method QPoint &QPoint::operator/=(double divisor)

==

Signature: [const] bool == (const QPoint p2)

Description: Operator bool ::operator==(const QPoint &p1, const QPoint &p2)

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

_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 QPoint other)

Description: Assigns another object to self

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.

dotProduct

Signature: [static] int dotProduct (const QPoint p1, const QPoint p2)

Description: Static method int QPoint::dotProduct(const QPoint &p1, const QPoint &p2)

This method is static and can be called without an instance.

dup

Signature: [const] new QPoint ptr dup

Description: Creates a copy of self

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

isNull?

Signature: [const] bool isNull?

Description: Method bool QPoint::isNull()

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.

manhattanLength

Signature: [const] int manhattanLength

Description: Method int QPoint::manhattanLength()

new

(1) Signature: [static] new QPoint new

Description: Constructor QPoint::QPoint()

This method creates an object of class QPoint.

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

(2) Signature: [static] new QPoint new (int xpos, int ypos)

Description: Constructor QPoint::QPoint(int xpos, int ypos)

This method creates an object of class QPoint.

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

rx

Signature: int rx

Description: Method int &QPoint::rx()

ry

Signature: int ry

Description: Method int &QPoint::ry()

setX

Signature: void setX (int x)

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

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

setY

Signature: void setY (int y)

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

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

x

Signature: [const] int x

Description: Method int QPoint::x()

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

x=

Signature: void x= (int x)

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

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

y

Signature: [const] int y

Description: Method int QPoint::y()

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

y=

Signature: void y= (int y)

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

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