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

API reference - Class QLayoutItem

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QLayoutItem

Class hierarchy: QLayoutItem

Public constructors

new QLayoutItemnew(Qt_QFlags_AlignmentFlag alignment = Qt::Alignment())Constructor QLayoutItem::QLayoutItem(QFlags<Qt::AlignmentFlag> alignment)

Public methods

[const]QLayoutItem 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.
[const]Qt_QFlags_AlignmentFlagalignmentMethod QFlags<Qt::AlignmentFlag> QLayoutItem::alignment()
voidalignment=(Qt_QFlags_AlignmentFlag a)Method void QLayoutItem::setAlignment(QFlags<Qt::AlignmentFlag> a)
voidassign(const QLayoutItem other)Assigns another object to self
[const]QSizePolicy_QFlags_ControlTypecontrolTypesVirtual method QFlags<QSizePolicy::ControlType> QLayoutItem::controlTypes()
[const]new QLayoutItem ptrdupCreates a copy of self
[const]Qt_QFlags_OrientationexpandingDirectionsVirtual method QFlags<Qt::Orientation> QLayoutItem::expandingDirections()
[const]QRectgeometryVirtual method QRect QLayoutItem::geometry()
voidgeometry=(const QRect arg1)Method void QLayoutItem::setGeometry(const QRect &)
[const]boolhasHeightForWidthVirtual method bool QLayoutItem::hasHeightForWidth()
[const]intheightForWidth(int arg1)Virtual method int QLayoutItem::heightForWidth(int)
voidinvalidateVirtual method void QLayoutItem::invalidate()
[const]boolisEmptyVirtual method bool QLayoutItem::isEmpty()
[const]boolisEmpty?Method bool QLayoutItem::isEmpty()
QLayout ptrlayoutVirtual method QLayout *QLayoutItem::layout()
[const]QSizemaximumSizeVirtual method QSize QLayoutItem::maximumSize()
[const]intminimumHeightForWidth(int arg1)Virtual method int QLayoutItem::minimumHeightForWidth(int)
[const]QSizeminimumSizeVirtual method QSize QLayoutItem::minimumSize()
voidsetAlignment(Qt_QFlags_AlignmentFlag a)Method void QLayoutItem::setAlignment(QFlags<Qt::AlignmentFlag> a)
voidsetGeometry(const QRect arg1)Virtual method void QLayoutItem::setGeometry(const QRect &)
[const]QSizesizeHintVirtual method QSize QLayoutItem::sizeHint()
QSpacerItem ptrspacerItemVirtual method QSpacerItem *QLayoutItem::spacerItem()
QWidget ptrwidgetVirtual method QWidget *QLayoutItem::widget()

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] QLayoutItem 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.

alignment

Signature: [const] Qt_QFlags_AlignmentFlag alignment

Description: Method QFlags<Qt::AlignmentFlag> QLayoutItem::alignment()

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

alignment=

Signature: void alignment= (Qt_QFlags_AlignmentFlag a)

Description: Method void QLayoutItem::setAlignment(QFlags<Qt::AlignmentFlag> a)

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

assign

Signature: void assign (const QLayoutItem other)

Description: Assigns another object to self

controlTypes

Signature: [const] QSizePolicy_QFlags_ControlType controlTypes

Description: Virtual method QFlags<QSizePolicy::ControlType> QLayoutItem::controlTypes()

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.

dup

Signature: [const] new QLayoutItem ptr dup

Description: Creates a copy of self

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

expandingDirections

Signature: [const] Qt_QFlags_Orientation expandingDirections

Description: Virtual method QFlags<Qt::Orientation> QLayoutItem::expandingDirections()

This method can be reimplemented in a derived class.

geometry

Signature: [const] QRect geometry

Description: Virtual method QRect QLayoutItem::geometry()

This method can be reimplemented in a derived class.

geometry=

Signature: void geometry= (const QRect arg1)

Description: Method void QLayoutItem::setGeometry(const QRect &)

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

hasHeightForWidth

Signature: [const] bool hasHeightForWidth

Description: Virtual method bool QLayoutItem::hasHeightForWidth()

This method can be reimplemented in a derived class.

heightForWidth

Signature: [const] int heightForWidth (int arg1)

Description: Virtual method int QLayoutItem::heightForWidth(int)

This method can be reimplemented in a derived class.

invalidate

Signature: void invalidate

Description: Virtual method void QLayoutItem::invalidate()

This method can be reimplemented in a derived class.

isEmpty

Signature: [const] bool isEmpty

Description: Virtual method bool QLayoutItem::isEmpty()

This method can be reimplemented in a derived class.

isEmpty?

Signature: [const] bool isEmpty?

Description: Method bool QLayoutItem::isEmpty()

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.

layout

Signature: QLayout ptr layout

Description: Virtual method QLayout *QLayoutItem::layout()

This method can be reimplemented in a derived class.

maximumSize

Signature: [const] QSize maximumSize

Description: Virtual method QSize QLayoutItem::maximumSize()

This method can be reimplemented in a derived class.

minimumHeightForWidth

Signature: [const] int minimumHeightForWidth (int arg1)

Description: Virtual method int QLayoutItem::minimumHeightForWidth(int)

This method can be reimplemented in a derived class.

minimumSize

Signature: [const] QSize minimumSize

Description: Virtual method QSize QLayoutItem::minimumSize()

This method can be reimplemented in a derived class.

new

Signature: [static] new QLayoutItem new (Qt_QFlags_AlignmentFlag alignment = Qt::Alignment())

Description: Constructor QLayoutItem::QLayoutItem(QFlags<Qt::AlignmentFlag> alignment)

This method creates an object of class QLayoutItem.

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

setAlignment

Signature: void setAlignment (Qt_QFlags_AlignmentFlag a)

Description: Method void QLayoutItem::setAlignment(QFlags<Qt::AlignmentFlag> a)

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

setGeometry

Signature: void setGeometry (const QRect arg1)

Description: Virtual method void QLayoutItem::setGeometry(const QRect &)

This method can be reimplemented in a derived class.

sizeHint

Signature: [const] QSize sizeHint

Description: Virtual method QSize QLayoutItem::sizeHint()

This method can be reimplemented in a derived class.

spacerItem

Signature: QSpacerItem ptr spacerItem

Description: Virtual method QSpacerItem *QLayoutItem::spacerItem()

This method can be reimplemented in a derived class.

widget

Signature: QWidget ptr widget

Description: Virtual method QWidget *QLayoutItem::widget()

This method can be reimplemented in a derived class.