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

API reference - Class QMarginsF

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QMarginsF

Public constructors

new QMarginsFnewConstructor QMarginsF::QMarginsF()
new QMarginsFnew(double left,
double top,
double right,
double bottom)
Constructor QMarginsF::QMarginsF(double left, double top, double right, double bottom)
new QMarginsFnew(const QMargins margins)Constructor QMarginsF::QMarginsF(const QMargins &margins)

Public methods

[const]bool!=(const QMarginsF rhs)Operator bool ::operator!=(const QMarginsF &lhs, const QMarginsF &rhs)
[const]QMarginsF*(double rhs)Operator QMarginsF ::operator*(const QMarginsF &lhs, qreal rhs)
QMarginsF*=(double factor)Method QMarginsF &QMarginsF::operator*=(double factor)
[const]QMarginsF+(const QMarginsF rhs)Operator QMarginsF ::operator+(const QMarginsF &lhs, const QMarginsF &rhs)
[const]QMarginsF+(double rhs)Operator QMarginsF ::operator+(const QMarginsF &lhs, qreal rhs)
[const]QMarginsF+Operator QMarginsF ::operator+(const QMarginsF &margins)
[const]QRectF+(const QRectF rhs)Operator QRectF ::operator+(const QMarginsF &lhs, const QRectF &rhs)
QMarginsF+=(const QMarginsF margins)Method QMarginsF &QMarginsF::operator+=(const QMarginsF &margins)
QMarginsF+=(double addend)Method QMarginsF &QMarginsF::operator+=(double addend)
[const]QMarginsF-(const QMarginsF rhs)Operator QMarginsF ::operator-(const QMarginsF &lhs, const QMarginsF &rhs)
[const]QMarginsF-(double rhs)Operator QMarginsF ::operator-(const QMarginsF &lhs, qreal rhs)
[const]QMarginsF-Operator QMarginsF ::operator-(const QMarginsF &margins)
QMarginsF-=(const QMarginsF margins)Method QMarginsF &QMarginsF::operator-=(const QMarginsF &margins)
QMarginsF-=(double subtrahend)Method QMarginsF &QMarginsF::operator-=(double subtrahend)
[const]QMarginsF/(double divisor)Operator QMarginsF ::operator/(const QMarginsF &lhs, qreal divisor)
QMarginsF/=(double divisor)Method QMarginsF &QMarginsF::operator/=(double divisor)
[const]bool==(const QMarginsF rhs)Operator bool ::operator==(const QMarginsF &lhs, const QMarginsF &rhs)
[const]QMarginsF 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 QMarginsF other)Assigns another object to self
[const]doublebottomMethod double QMarginsF::bottom()
voidbottom=(double bottom)Method void QMarginsF::setBottom(double bottom)
[const]new QMarginsF ptrdupCreates a copy of self
[const]boolisNull?Method bool QMarginsF::isNull()
[const]doubleleftMethod double QMarginsF::left()
voidleft=(double left)Method void QMarginsF::setLeft(double left)
[const]doublerightMethod double QMarginsF::right()
voidright=(double right)Method void QMarginsF::setRight(double right)
voidsetBottom(double bottom)Method void QMarginsF::setBottom(double bottom)
voidsetLeft(double left)Method void QMarginsF::setLeft(double left)
voidsetRight(double right)Method void QMarginsF::setRight(double right)
voidsetTop(double top)Method void QMarginsF::setTop(double top)
[const]QMarginstoMarginsMethod QMargins QMarginsF::toMargins()
[const]doubletopMethod double QMarginsF::top()
voidtop=(double top)Method void QMarginsF::setTop(double 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 QMarginsF rhs)

Description: Operator bool ::operator!=(const QMarginsF &lhs, const QMarginsF &rhs)

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

*

Signature: [const] QMarginsF * (double rhs)

Description: Operator QMarginsF ::operator*(const QMarginsF &lhs, qreal rhs)

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

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

*=

Signature: QMarginsF *= (double factor)

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

+

(1) Signature: [const] QMarginsF + (const QMarginsF rhs)

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

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

(2) Signature: [const] QMarginsF + (double rhs)

Description: Operator QMarginsF ::operator+(const QMarginsF &lhs, qreal rhs)

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

(3) Signature: [const] QMarginsF +

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

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

(4) Signature: [const] QRectF + (const QRectF rhs)

Description: Operator QRectF ::operator+(const QMarginsF &lhs, const QRectF &rhs)

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

+=

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

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

(2) Signature: QMarginsF += (double addend)

Description: Method QMarginsF &QMarginsF::operator+=(double addend)

-

(1) Signature: [const] QMarginsF - (const QMarginsF rhs)

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

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

(2) Signature: [const] QMarginsF - (double rhs)

Description: Operator QMarginsF ::operator-(const QMarginsF &lhs, qreal rhs)

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

(3) Signature: [const] QMarginsF -

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

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

-=

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

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

(2) Signature: QMarginsF -= (double subtrahend)

Description: Method QMarginsF &QMarginsF::operator-=(double subtrahend)

/

Signature: [const] QMarginsF / (double divisor)

Description: Operator QMarginsF ::operator/(const QMarginsF &lhs, qreal divisor)

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

/=

Signature: QMarginsF /= (double divisor)

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

==

Signature: [const] bool == (const QMarginsF rhs)

Description: Operator bool ::operator==(const QMarginsF &lhs, const QMarginsF &rhs)

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

_const_cast

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

Description: Assigns another object to self

bottom

Signature: [const] double bottom

Description: Method double QMarginsF::bottom()

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

bottom=

Signature: void bottom= (double bottom)

Description: Method void QMarginsF::setBottom(double 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 QMarginsF 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 QMarginsF::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] double left

Description: Method double QMarginsF::left()

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

left=

Signature: void left= (double left)

Description: Method void QMarginsF::setLeft(double left)

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

new

(1) Signature: [static] new QMarginsF new

Description: Constructor QMarginsF::QMarginsF()

This method creates an object of class QMarginsF.

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

(2) Signature: [static] new QMarginsF new (double left, double top, double right, double bottom)

Description: Constructor QMarginsF::QMarginsF(double left, double top, double right, double bottom)

This method creates an object of class QMarginsF.

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

(3) Signature: [static] new QMarginsF new (const QMargins margins)

Description: Constructor QMarginsF::QMarginsF(const QMargins &margins)

This method creates an object of class QMarginsF.

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

right

Signature: [const] double right

Description: Method double QMarginsF::right()

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

right=

Signature: void right= (double right)

Description: Method void QMarginsF::setRight(double right)

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

setBottom

Signature: void setBottom (double bottom)

Description: Method void QMarginsF::setBottom(double bottom)

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

setLeft

Signature: void setLeft (double left)

Description: Method void QMarginsF::setLeft(double left)

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

setRight

Signature: void setRight (double right)

Description: Method void QMarginsF::setRight(double right)

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

setTop

Signature: void setTop (double top)

Description: Method void QMarginsF::setTop(double top)

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

toMargins

Signature: [const] QMargins toMargins

Description: Method QMargins QMarginsF::toMargins()

top

Signature: [const] double top

Description: Method double QMarginsF::top()

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

top=

Signature: void top= (double top)

Description: Method void QMarginsF::setTop(double top)

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