KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QLine

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QLine

Public constructors

new QLinenewConstructor QLine::QLine()
new QLinenew(const QPoint pt1,
const QPoint pt2)
Constructor QLine::QLine(const QPoint &pt1, const QPoint &pt2)
new QLinenew(int x1,
int y1,
int x2,
int y2)
Constructor QLine::QLine(int x1, int y1, int x2, int y2)

Public methods

[const]bool!=(const QLine d)Method bool QLine::operator!=(const QLine &d)
[const]bool==(const QLine d)Method bool QLine::operator==(const QLine &d)
[const]QLine 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 QLine other)Assigns another object to self
[const]QPointcenterMethod QPoint QLine::center()
[const]new QLine ptrdupCreates a copy of self
[const]intdxMethod int QLine::dx()
[const]intdyMethod int QLine::dy()
[const]boolisNull?Method bool QLine::isNull()
[const]QPointp1Method QPoint QLine::p1()
voidp1=(const QPoint p1)Method void QLine::setP1(const QPoint &p1)
[const]QPointp2Method QPoint QLine::p2()
voidp2=(const QPoint p2)Method void QLine::setP2(const QPoint &p2)
voidsetLine(int x1,
int y1,
int x2,
int y2)
Method void QLine::setLine(int x1, int y1, int x2, int y2)
voidsetP1(const QPoint p1)Method void QLine::setP1(const QPoint &p1)
voidsetP2(const QPoint p2)Method void QLine::setP2(const QPoint &p2)
voidsetPoints(const QPoint p1,
const QPoint p2)
Method void QLine::setPoints(const QPoint &p1, const QPoint &p2)
voidtranslate(const QPoint p)Method void QLine::translate(const QPoint &p)
voidtranslate(int dx,
int dy)
Method void QLine::translate(int dx, int dy)
[const]QLinetranslated(const QPoint p)Method QLine QLine::translated(const QPoint &p)
[const]QLinetranslated(int dx,
int dy)
Method QLine QLine::translated(int dx, int dy)
[const]intx1Method int QLine::x1()
[const]intx2Method int QLine::x2()
[const]inty1Method int QLine::y1()
[const]inty2Method int QLine::y2()

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 QLine d)

Description: Method bool QLine::operator!=(const QLine &d)

==

Signature: [const] bool == (const QLine d)

Description: Method bool QLine::operator==(const QLine &d)

_const_cast

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

Description: Assigns another object to self

center

Signature: [const] QPoint center

Description: Method QPoint QLine::center()

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

Description: Creates a copy of self

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

dx

Signature: [const] int dx

Description: Method int QLine::dx()

dy

Signature: [const] int dy

Description: Method int QLine::dy()

isNull?

Signature: [const] bool isNull?

Description: Method bool QLine::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.

new

(1) Signature: [static] new QLine new

Description: Constructor QLine::QLine()

This method creates an object of class QLine.

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

(2) Signature: [static] new QLine new (const QPoint pt1, const QPoint pt2)

Description: Constructor QLine::QLine(const QPoint &pt1, const QPoint &pt2)

This method creates an object of class QLine.

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

(3) Signature: [static] new QLine new (int x1, int y1, int x2, int y2)

Description: Constructor QLine::QLine(int x1, int y1, int x2, int y2)

This method creates an object of class QLine.

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

p1

Signature: [const] QPoint p1

Description: Method QPoint QLine::p1()

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

p1=

Signature: void p1= (const QPoint p1)

Description: Method void QLine::setP1(const QPoint &p1)

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

p2

Signature: [const] QPoint p2

Description: Method QPoint QLine::p2()

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

p2=

Signature: void p2= (const QPoint p2)

Description: Method void QLine::setP2(const QPoint &p2)

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

setLine

Signature: void setLine (int x1, int y1, int x2, int y2)

Description: Method void QLine::setLine(int x1, int y1, int x2, int y2)

setP1

Signature: void setP1 (const QPoint p1)

Description: Method void QLine::setP1(const QPoint &p1)

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

setP2

Signature: void setP2 (const QPoint p2)

Description: Method void QLine::setP2(const QPoint &p2)

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

setPoints

Signature: void setPoints (const QPoint p1, const QPoint p2)

Description: Method void QLine::setPoints(const QPoint &p1, const QPoint &p2)

translate

(1) Signature: void translate (const QPoint p)

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

(2) Signature: void translate (int dx, int dy)

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

translated

(1) Signature: [const] QLine translated (const QPoint p)

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

(2) Signature: [const] QLine translated (int dx, int dy)

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

x1

Signature: [const] int x1

Description: Method int QLine::x1()

x2

Signature: [const] int x2

Description: Method int QLine::x2()

y1

Signature: [const] int y1

Description: Method int QLine::y1()

y2

Signature: [const] int y2

Description: Method int QLine::y2()