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

API reference - Class QGraphicsLayout

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QGraphicsLayout

Class hierarchy: QGraphicsLayout » QGraphicsLayoutItem

Public constructors

new QGraphicsLayoutnew(QGraphicsLayoutItem ptr parent = nullptr)Constructor QGraphicsLayout::QGraphicsLayout(QGraphicsLayoutItem *parent)

Public methods

[const]QGraphicsLayout 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.
voidactivateMethod void QGraphicsLayout::activate()
[const]intcountVirtual method int QGraphicsLayout::count()
[const]voidgetContentsMargins(double ptr left,
double ptr top,
double ptr right,
double ptr bottom)
Virtual method void QGraphicsLayout::getContentsMargins(double *left, double *top, double *right, double *bottom)
voidinvalidateVirtual method void QGraphicsLayout::invalidate()
[const]boolisActivated?Method bool QGraphicsLayout::isActivated()
[const]QGraphicsLayoutItem ptritemAt(int i)Virtual method QGraphicsLayoutItem *QGraphicsLayout::itemAt(int i)
voidremoveAt(int index)Virtual method void QGraphicsLayout::removeAt(int index)
voidsetContentsMargins(double left,
double top,
double right,
double bottom)
Method void QGraphicsLayout::setContentsMargins(double left, double top, double right, double bottom)
voidsetGeometry(const QRectF rect)Virtual method void QGraphicsLayout::setGeometry(const QRectF &rect)
voidupdateGeometryVirtual method void QGraphicsLayout::updateGeometry()
voidwidgetEvent(QEvent ptr e)Virtual method void QGraphicsLayout::widgetEvent(QEvent *e)

Public static methods and constants

boolinstantInvalidatePropagationStatic method bool QGraphicsLayout::instantInvalidatePropagation()
voidinstantInvalidatePropagation=(bool enable)Static method void QGraphicsLayout::setInstantInvalidatePropagation(bool enable)
voidsetInstantInvalidatePropagation(bool enable)Static method void QGraphicsLayout::setInstantInvalidatePropagation(bool enable)

Protected methods (static, non-static and constructors)

voidaddChildLayoutItem(QGraphicsLayoutItem ptr layoutItem)Method void QGraphicsLayout::addChildLayoutItem(QGraphicsLayoutItem *layoutItem)
voidsetGraphicsItem(QGraphicsItem ptr item)Method void QGraphicsLayout::setGraphicsItem(QGraphicsItem *item)
voidsetOwnedByLayout(bool ownedByLayout)Method void QGraphicsLayout::setOwnedByLayout(bool ownedByLayout)
[const]QSizeFsizeHint(const Qt_SizeHint which,
const QSizeF constraint)
Virtual method QSizeF QGraphicsLayout::sizeHint(Qt::SizeHint which, const QSizeF &constraint)

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

_const_cast

Signature: [const] QGraphicsLayout 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.

activate

Signature: void activate

Description: Method void QGraphicsLayout::activate()

addChildLayoutItem

Signature: void addChildLayoutItem (QGraphicsLayoutItem ptr layoutItem)

Description: Method void QGraphicsLayout::addChildLayoutItem(QGraphicsLayoutItem *layoutItem)

This method is protected and can only be called from inside a derived class.

count

Signature: [const] int count

Description: Virtual method int QGraphicsLayout::count()

This method can be reimplemented in a derived class.

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.

getContentsMargins

Signature: [const] void getContentsMargins (double ptr left, double ptr top, double ptr right, double ptr bottom)

Description: Virtual method void QGraphicsLayout::getContentsMargins(double *left, double *top, double *right, double *bottom)

This method can be reimplemented in a derived class.

instantInvalidatePropagation

Signature: [static] bool instantInvalidatePropagation

Description: Static method bool QGraphicsLayout::instantInvalidatePropagation()

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

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

instantInvalidatePropagation=

Signature: [static] void instantInvalidatePropagation= (bool enable)

Description: Static method void QGraphicsLayout::setInstantInvalidatePropagation(bool enable)

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

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

invalidate

Signature: void invalidate

Description: Virtual method void QGraphicsLayout::invalidate()

This method can be reimplemented in a derived class.

isActivated?

Signature: [const] bool isActivated?

Description: Method bool QGraphicsLayout::isActivated()

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.

itemAt

Signature: [const] QGraphicsLayoutItem ptr itemAt (int i)

Description: Virtual method QGraphicsLayoutItem *QGraphicsLayout::itemAt(int i)

This method can be reimplemented in a derived class.

new

Signature: [static] new QGraphicsLayout new (QGraphicsLayoutItem ptr parent = nullptr)

Description: Constructor QGraphicsLayout::QGraphicsLayout(QGraphicsLayoutItem *parent)

This method creates an object of class QGraphicsLayout.

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

removeAt

Signature: void removeAt (int index)

Description: Virtual method void QGraphicsLayout::removeAt(int index)

This method can be reimplemented in a derived class.

setContentsMargins

Signature: void setContentsMargins (double left, double top, double right, double bottom)

Description: Method void QGraphicsLayout::setContentsMargins(double left, double top, double right, double bottom)

setGeometry

Signature: void setGeometry (const QRectF rect)

Description: Virtual method void QGraphicsLayout::setGeometry(const QRectF &rect)

This method can be reimplemented in a derived class.

setGraphicsItem

Signature: void setGraphicsItem (QGraphicsItem ptr item)

Description: Method void QGraphicsLayout::setGraphicsItem(QGraphicsItem *item)

This method is protected and can only be called from inside a derived class.

setInstantInvalidatePropagation

Signature: [static] void setInstantInvalidatePropagation (bool enable)

Description: Static method void QGraphicsLayout::setInstantInvalidatePropagation(bool enable)

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

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

setOwnedByLayout

Signature: void setOwnedByLayout (bool ownedByLayout)

Description: Method void QGraphicsLayout::setOwnedByLayout(bool ownedByLayout)

This method is protected and can only be called from inside a derived class.

sizeHint

Signature: [const] QSizeF sizeHint (const Qt_SizeHint which, const QSizeF constraint)

Description: Virtual method QSizeF QGraphicsLayout::sizeHint(Qt::SizeHint which, const QSizeF &constraint)

This method can be reimplemented in a derived class.

updateGeometry

Signature: void updateGeometry

Description: Virtual method void QGraphicsLayout::updateGeometry()

This method can be reimplemented in a derived class.

widgetEvent

Signature: void widgetEvent (QEvent ptr e)

Description: Virtual method void QGraphicsLayout::widgetEvent(QEvent *e)

This method can be reimplemented in a derived class.