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

API reference - Class QMargins

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QMargins

Public constructors

new QMarginsnewConstructor QMargins::QMargins()
new QMarginsnew(int left,
int top,
int right,
int bottom)
Constructor QMargins::QMargins(int left, int top, int right, int bottom)

Public methods

[const]bool!=(const QMargins m2)Operator bool ::operator!=(const QMargins &m1, const QMargins &m2)
[const]QMargins*(int factor)Operator QMargins ::operator*(const QMargins &margins, int factor)
[const]QMargins*(double factor)Operator QMargins ::operator*(const QMargins &margins, qreal factor)
QMargins*=(int arg1)Method QMargins &QMargins::operator*=(int)
QMargins*=(double arg1)Method QMargins &QMargins::operator*=(double)
[const]QMargins+(const QMargins m2)Operator QMargins ::operator+(const QMargins &m1, const QMargins &m2)
[const]QMargins+(int rhs)Operator QMargins ::operator+(const QMargins &lhs, int rhs)
[const]QMargins+Operator QMargins ::operator+(const QMargins &margins)
[const]QRect+(const QRect rectangle)Operator QRect ::operator+(const QMargins &margins, const QRect &rectangle)
QMargins+=(const QMargins margins)Method QMargins &QMargins::operator+=(const QMargins &margins)
QMargins+=(int arg1)Method QMargins &QMargins::operator+=(int)
[const]QMargins-(const QMargins m2)Operator QMargins ::operator-(const QMargins &m1, const QMargins &m2)
[const]QMargins-(int rhs)Operator QMargins ::operator-(const QMargins &lhs, int rhs)
[const]QMargins-Operator QMargins ::operator-(const QMargins &margins)
QMargins-=(const QMargins margins)Method QMargins &QMargins::operator-=(const QMargins &margins)
QMargins-=(int arg1)Method QMargins &QMargins::operator-=(int)
[const]QMargins/(int divisor)Operator QMargins ::operator/(const QMargins &margins, int divisor)
[const]QMargins/(double divisor)Operator QMargins ::operator/(const QMargins &margins, qreal divisor)
QMargins/=(int arg1)Method QMargins &QMargins::operator/=(int)
QMargins/=(double arg1)Method QMargins &QMargins::operator/=(double)
[const]bool==(const QMargins m2)Operator bool ::operator==(const QMargins &m1, const QMargins &m2)
[const]QMargins 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 QMargins other)Assigns another object to self
[const]intbottomMethod int QMargins::bottom()
voidbottom=(int bottom)Method void QMargins::setBottom(int bottom)
[const]new QMargins ptrdupCreates a copy of self
[const]boolisNull?Method bool QMargins::isNull()
[const]intleftMethod int QMargins::left()
voidleft=(int left)Method void QMargins::setLeft(int left)
[const]intrightMethod int QMargins::right()
voidright=(int right)Method void QMargins::setRight(int right)
voidsetBottom(int bottom)Method void QMargins::setBottom(int bottom)
voidsetLeft(int left)Method void QMargins::setLeft(int left)
voidsetRight(int right)Method void QMargins::setRight(int right)
voidsetTop(int top)Method void QMargins::setTop(int top)
[const]inttopMethod int QMargins::top()
voidtop=(int top)Method void QMargins::setTop(int top)

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 QMargins m2)

Description: Operator bool ::operator!=(const QMargins &m1, const QMargins &m2)

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

*

(1) Signature: [const] QMargins * (int factor)

Description: Operator QMargins ::operator*(const QMargins &margins, int factor)

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

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

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

Description: Operator QMargins ::operator*(const QMargins &margins, qreal factor)

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

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

*=

(1) Signature: QMargins *= (int arg1)

Description: Method QMargins &QMargins::operator*=(int)

(2) Signature: QMargins *= (double arg1)

Description: Method QMargins &QMargins::operator*=(double)

+

(1) Signature: [const] QMargins + (const QMargins m2)

Description: Operator QMargins ::operator+(const QMargins &m1, const QMargins &m2)

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

(2) Signature: [const] QMargins + (int rhs)

Description: Operator QMargins ::operator+(const QMargins &lhs, int rhs)

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

(3) Signature: [const] QMargins +

Description: Operator QMargins ::operator+(const QMargins &margins)

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

(4) Signature: [const] QRect + (const QRect rectangle)

Description: Operator QRect ::operator+(const QMargins &margins, const QRect &rectangle)

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

+=

(1) Signature: QMargins += (const QMargins margins)

Description: Method QMargins &QMargins::operator+=(const QMargins &margins)

(2) Signature: QMargins += (int arg1)

Description: Method QMargins &QMargins::operator+=(int)

-

(1) Signature: [const] QMargins - (const QMargins m2)

Description: Operator QMargins ::operator-(const QMargins &m1, const QMargins &m2)

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

(2) Signature: [const] QMargins - (int rhs)

Description: Operator QMargins ::operator-(const QMargins &lhs, int rhs)

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

(3) Signature: [const] QMargins -

Description: Operator QMargins ::operator-(const QMargins &margins)

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

-=

(1) Signature: QMargins -= (const QMargins margins)

Description: Method QMargins &QMargins::operator-=(const QMargins &margins)

(2) Signature: QMargins -= (int arg1)

Description: Method QMargins &QMargins::operator-=(int)

/

(1) Signature: [const] QMargins / (int divisor)

Description: Operator QMargins ::operator/(const QMargins &margins, int divisor)

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

(2) Signature: [const] QMargins / (double divisor)

Description: Operator QMargins ::operator/(const QMargins &margins, qreal divisor)

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

/=

(1) Signature: QMargins /= (int arg1)

Description: Method QMargins &QMargins::operator/=(int)

(2) Signature: QMargins /= (double arg1)

Description: Method QMargins &QMargins::operator/=(double)

==

Signature: [const] bool == (const QMargins m2)

Description: Operator bool ::operator==(const QMargins &m1, const QMargins &m2)

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

_const_cast

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

Description: Assigns another object to self

bottom

Signature: [const] int bottom

Description: Method int QMargins::bottom()

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

bottom=

Signature: void bottom= (int bottom)

Description: Method void QMargins::setBottom(int bottom)

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

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

left

Signature: [const] int left

Description: Method int QMargins::left()

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

left=

Signature: void left= (int left)

Description: Method void QMargins::setLeft(int left)

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

new

(1) Signature: [static] new QMargins new

Description: Constructor QMargins::QMargins()

This method creates an object of class QMargins.

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

(2) Signature: [static] new QMargins new (int left, int top, int right, int bottom)

Description: Constructor QMargins::QMargins(int left, int top, int right, int bottom)

This method creates an object of class QMargins.

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

right

Signature: [const] int right

Description: Method int QMargins::right()

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

right=

Signature: void right= (int right)

Description: Method void QMargins::setRight(int right)

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

setBottom

Signature: void setBottom (int bottom)

Description: Method void QMargins::setBottom(int bottom)

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

setLeft

Signature: void setLeft (int left)

Description: Method void QMargins::setLeft(int left)

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

setRight

Signature: void setRight (int right)

Description: Method void QMargins::setRight(int right)

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

setTop

Signature: void setTop (int top)

Description: Method void QMargins::setTop(int top)

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

top

Signature: [const] int top

Description: Method int QMargins::top()

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

top=

Signature: void top= (int top)

Description: Method void QMargins::setTop(int top)

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