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

API reference - Class QGraphicsLinearLayout

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QGraphicsLinearLayout

Class hierarchy: QGraphicsLinearLayout » QGraphicsLayout » QGraphicsLayoutItem

Public constructors

new QGraphicsLinearLayoutnew(QGraphicsLayoutItem ptr parent = nullptr)Constructor QGraphicsLinearLayout::QGraphicsLinearLayout(QGraphicsLayoutItem *parent)
new QGraphicsLinearLayoutnew(const Qt_Orientation orientation,
QGraphicsLayoutItem ptr parent = nullptr)
Constructor QGraphicsLinearLayout::QGraphicsLinearLayout(Qt::Orientation orientation, QGraphicsLayoutItem *parent)

Public methods

[const]QGraphicsLinearLayout 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.
voidaddItem(QGraphicsLayoutItem ptr item)Method void QGraphicsLinearLayout::addItem(QGraphicsLayoutItem *item)
voidaddStretch(int stretch = 1)Method void QGraphicsLinearLayout::addStretch(int stretch)
[const]Qt_QFlags_AlignmentFlagalignment(QGraphicsLayoutItem ptr item)Method QFlags<Qt::AlignmentFlag> QGraphicsLinearLayout::alignment(QGraphicsLayoutItem *item)
[const]intcountVirtual method int QGraphicsLinearLayout::count()
[const]voiddump(int indent = 0)Method void QGraphicsLinearLayout::dump(int indent)
voidgeometry=(const QRectF rect)Method void QGraphicsLinearLayout::setGeometry(const QRectF &rect)
[const]voidgetContentsMargins(double ptr left,
double ptr top,
double ptr right,
double ptr bottom)
Virtual method void QGraphicsLinearLayout::getContentsMargins(double *left, double *top, double *right, double *bottom)
voidinsertItem(int index,
QGraphicsLayoutItem ptr item)
Method void QGraphicsLinearLayout::insertItem(int index, QGraphicsLayoutItem *item)
voidinsertStretch(int index,
int stretch = 1)
Method void QGraphicsLinearLayout::insertStretch(int index, int stretch)
voidinvalidateVirtual method void QGraphicsLinearLayout::invalidate()
[const]QGraphicsLayoutItem ptritemAt(int index)Virtual method QGraphicsLayoutItem *QGraphicsLinearLayout::itemAt(int index)
[const]doubleitemSpacing(int index)Method double QGraphicsLinearLayout::itemSpacing(int index)
[const]Qt_OrientationorientationMethod Qt::Orientation QGraphicsLinearLayout::orientation()
voidorientation=(const Qt_Orientation orientation)Method void QGraphicsLinearLayout::setOrientation(Qt::Orientation orientation)
voidremoveAt(int index)Virtual method void QGraphicsLinearLayout::removeAt(int index)
voidremoveItem(QGraphicsLayoutItem ptr item)Method void QGraphicsLinearLayout::removeItem(QGraphicsLayoutItem *item)
voidsetAlignment(QGraphicsLayoutItem ptr item,
Qt_QFlags_AlignmentFlag alignment)
Method void QGraphicsLinearLayout::setAlignment(QGraphicsLayoutItem *item, QFlags<Qt::AlignmentFlag> alignment)
voidsetGeometry(const QRectF rect)Virtual method void QGraphicsLinearLayout::setGeometry(const QRectF &rect)
voidsetItemSpacing(int index,
double spacing)
Method void QGraphicsLinearLayout::setItemSpacing(int index, double spacing)
voidsetOrientation(const Qt_Orientation orientation)Method void QGraphicsLinearLayout::setOrientation(Qt::Orientation orientation)
voidsetSpacing(double spacing)Method void QGraphicsLinearLayout::setSpacing(double spacing)
voidsetStretchFactor(QGraphicsLayoutItem ptr item,
int stretch)
Method void QGraphicsLinearLayout::setStretchFactor(QGraphicsLayoutItem *item, int stretch)
[const]QSizeFsizeHint(const Qt_SizeHint which,
const QSizeF constraint)
Virtual method QSizeF QGraphicsLinearLayout::sizeHint(Qt::SizeHint which, const QSizeF &constraint)
[const]doublespacingMethod double QGraphicsLinearLayout::spacing()
voidspacing=(double spacing)Method void QGraphicsLinearLayout::setSpacing(double spacing)
[const]intstretchFactor(QGraphicsLayoutItem ptr item)Method int QGraphicsLinearLayout::stretchFactor(QGraphicsLayoutItem *item)
voidupdateGeometryVirtual method void QGraphicsLinearLayout::updateGeometry()
voidwidgetEvent(QEvent ptr e)Virtual method void QGraphicsLinearLayout::widgetEvent(QEvent *e)

Protected methods (static, non-static and constructors)

voidaddChildLayoutItem(QGraphicsLayoutItem ptr layoutItem)Method void QGraphicsLinearLayout::addChildLayoutItem(QGraphicsLayoutItem *layoutItem)
voidsetGraphicsItem(QGraphicsItem ptr item)Method void QGraphicsLinearLayout::setGraphicsItem(QGraphicsItem *item)
voidsetOwnedByLayout(bool ownedByLayout)Method void QGraphicsLinearLayout::setOwnedByLayout(bool ownedByLayout)

Detailed description

_const_cast

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

addChildLayoutItem

Signature: void addChildLayoutItem (QGraphicsLayoutItem ptr layoutItem)

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

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

addItem

Signature: void addItem (QGraphicsLayoutItem ptr item)

Description: Method void QGraphicsLinearLayout::addItem(QGraphicsLayoutItem *item)

addStretch

Signature: void addStretch (int stretch = 1)

Description: Method void QGraphicsLinearLayout::addStretch(int stretch)

alignment

Signature: [const] Qt_QFlags_AlignmentFlag alignment (QGraphicsLayoutItem ptr item)

Description: Method QFlags<Qt::AlignmentFlag> QGraphicsLinearLayout::alignment(QGraphicsLayoutItem *item)

count

Signature: [const] int count

Description: Virtual method int QGraphicsLinearLayout::count()

This method can be reimplemented in a derived class.

dump

Signature: [const] void dump (int indent = 0)

Description: Method void QGraphicsLinearLayout::dump(int indent)

geometry=

Signature: void geometry= (const QRectF rect)

Description: Method void QGraphicsLinearLayout::setGeometry(const QRectF &rect)

This is a reimplementation of QGraphicsLayoutItem::setGeometry

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

getContentsMargins

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

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

This method can be reimplemented in a derived class.

insertItem

Signature: void insertItem (int index, QGraphicsLayoutItem ptr item)

Description: Method void QGraphicsLinearLayout::insertItem(int index, QGraphicsLayoutItem *item)

insertStretch

Signature: void insertStretch (int index, int stretch = 1)

Description: Method void QGraphicsLinearLayout::insertStretch(int index, int stretch)

invalidate

Signature: void invalidate

Description: Virtual method void QGraphicsLinearLayout::invalidate()

This method can be reimplemented in a derived class.

itemAt

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

Description: Virtual method QGraphicsLayoutItem *QGraphicsLinearLayout::itemAt(int index)

This method can be reimplemented in a derived class.

itemSpacing

Signature: [const] double itemSpacing (int index)

Description: Method double QGraphicsLinearLayout::itemSpacing(int index)

new

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

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

This method creates an object of class QGraphicsLinearLayout.

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

(2) Signature: [static] new QGraphicsLinearLayout new (const Qt_Orientation orientation, QGraphicsLayoutItem ptr parent = nullptr)

Description: Constructor QGraphicsLinearLayout::QGraphicsLinearLayout(Qt::Orientation orientation, QGraphicsLayoutItem *parent)

This method creates an object of class QGraphicsLinearLayout.

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

orientation

Signature: [const] Qt_Orientation orientation

Description: Method Qt::Orientation QGraphicsLinearLayout::orientation()

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

orientation=

Signature: void orientation= (const Qt_Orientation orientation)

Description: Method void QGraphicsLinearLayout::setOrientation(Qt::Orientation orientation)

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

removeAt

Signature: void removeAt (int index)

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

This method can be reimplemented in a derived class.

removeItem

Signature: void removeItem (QGraphicsLayoutItem ptr item)

Description: Method void QGraphicsLinearLayout::removeItem(QGraphicsLayoutItem *item)

setAlignment

Signature: void setAlignment (QGraphicsLayoutItem ptr item, Qt_QFlags_AlignmentFlag alignment)

Description: Method void QGraphicsLinearLayout::setAlignment(QGraphicsLayoutItem *item, QFlags<Qt::AlignmentFlag> alignment)

setGeometry

Signature: void setGeometry (const QRectF rect)

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

This method can be reimplemented in a derived class.

setGraphicsItem

Signature: void setGraphicsItem (QGraphicsItem ptr item)

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

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

setItemSpacing

Signature: void setItemSpacing (int index, double spacing)

Description: Method void QGraphicsLinearLayout::setItemSpacing(int index, double spacing)

setOrientation

Signature: void setOrientation (const Qt_Orientation orientation)

Description: Method void QGraphicsLinearLayout::setOrientation(Qt::Orientation orientation)

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

setOwnedByLayout

Signature: void setOwnedByLayout (bool ownedByLayout)

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

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

setSpacing

Signature: void setSpacing (double spacing)

Description: Method void QGraphicsLinearLayout::setSpacing(double spacing)

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

setStretchFactor

Signature: void setStretchFactor (QGraphicsLayoutItem ptr item, int stretch)

Description: Method void QGraphicsLinearLayout::setStretchFactor(QGraphicsLayoutItem *item, int stretch)

sizeHint

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

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

This method can be reimplemented in a derived class.

spacing

Signature: [const] double spacing

Description: Method double QGraphicsLinearLayout::spacing()

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

spacing=

Signature: void spacing= (double spacing)

Description: Method void QGraphicsLinearLayout::setSpacing(double spacing)

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

stretchFactor

Signature: [const] int stretchFactor (QGraphicsLayoutItem ptr item)

Description: Method int QGraphicsLinearLayout::stretchFactor(QGraphicsLayoutItem *item)

updateGeometry

Signature: void updateGeometry

Description: Virtual method void QGraphicsLinearLayout::updateGeometry()

This method can be reimplemented in a derived class.

widgetEvent

Signature: void widgetEvent (QEvent ptr e)

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

This method can be reimplemented in a derived class.