API reference - Class QBoxLayout

BottomToTop

Signature: [static,const] QBoxLayout_Direction BottomToTop

Description: Enum constant QBoxLayout::BottomToTop

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

Down

Signature: [static,const] QBoxLayout_Direction Down

Description: Enum constant QBoxLayout::Down

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

LeftToRight

Signature: [static,const] QBoxLayout_Direction LeftToRight

Description: Enum constant QBoxLayout::LeftToRight

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

RightToLeft

Signature: [static,const] QBoxLayout_Direction RightToLeft

Description: Enum constant QBoxLayout::RightToLeft

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

TopToBottom

Signature: [static,const] QBoxLayout_Direction TopToBottom

Description: Enum constant QBoxLayout::TopToBottom

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

Up

Signature: [static,const] QBoxLayout_Direction Up

Description: Enum constant QBoxLayout::Up

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

_const_cast

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

addChildLayout

Signature: void addChildLayout (QLayout ptr l)

Description: Method void QBoxLayout::addChildLayout(QLayout *l)

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

addChildWidget

Signature: void addChildWidget (QWidget ptr w)

Description: Method void QBoxLayout::addChildWidget(QWidget *w)

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

addItem

Signature: void addItem (QLayoutItem ptr arg1)

Description: Virtual method void QBoxLayout::addItem(QLayoutItem *)

This method can be reimplemented in a derived class.

addLayout

Signature: void addLayout (QLayout ptr layout, int stretch = 0)

Description: Method void QBoxLayout::addLayout(QLayout *layout, int stretch)

addSpacerItem

Signature: void addSpacerItem (QSpacerItem ptr spacerItem)

Description: Method void QBoxLayout::addSpacerItem(QSpacerItem *spacerItem)

addSpacing

Signature: void addSpacing (int size)

Description: Method void QBoxLayout::addSpacing(int size)

addStretch

Signature: void addStretch (int stretch = 0)

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

addStrut

Signature: void addStrut (int arg1)

Description: Method void QBoxLayout::addStrut(int)

addWidget

Signature: void addWidget (QWidget ptr arg1, int stretch = 0, Qt_QFlags_AlignmentFlag alignment = Qt::Alignment())

Description: Method void QBoxLayout::addWidget(QWidget *, int stretch, QFlags<Qt::AlignmentFlag> alignment)

adoptLayout

Signature: bool adoptLayout (QLayout ptr layout)

Description: Method bool QBoxLayout::adoptLayout(QLayout *layout)

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

alignmentRect

Signature: [const] QRect alignmentRect (const QRect arg1)

Description: Method QRect QBoxLayout::alignmentRect(const QRect &)

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

childEvent

Signature: void childEvent (QChildEvent ptr e)

Description: Virtual method void QBoxLayout::childEvent(QChildEvent *e)

This method can be reimplemented in a derived class.

controlTypes

Signature: [const] QSizePolicy_QFlags_ControlType controlTypes

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

This method can be reimplemented in a derived class.

count

Signature: [const] int count

Description: Virtual method int QBoxLayout::count()

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QBoxLayout::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QBoxLayout::destroyed(QObject *)

You can bind a procedure to this signal.

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

direction

Signature: [const] QBoxLayout_Direction direction

Description: Method QBoxLayout::Direction QBoxLayout::direction()

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

direction=

Signature: void direction= (const QBoxLayout_Direction arg1)

Description: Method void QBoxLayout::setDirection(QBoxLayout::Direction)

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QBoxLayout::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QBoxLayout::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QBoxLayout::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QBoxLayout::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QBoxLayout::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

expandingDirections

Signature: [const] Qt_QFlags_Orientation expandingDirections

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

This method can be reimplemented in a derived class.

geometry

Signature: [const] QRect geometry

Description: Virtual method QRect QBoxLayout::geometry()

This method can be reimplemented in a derived class.

geometry=

Signature: void geometry= (const QRect arg1)

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

This is a reimplementation of QLayout::setGeometry

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

hasHeightForWidth

Signature: [const] bool hasHeightForWidth

Description: Virtual method bool QBoxLayout::hasHeightForWidth()

This method can be reimplemented in a derived class.

heightForWidth

Signature: [const] int heightForWidth (int arg1)

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

This method can be reimplemented in a derived class.

indexOf

Signature: [const] int indexOf (QWidget ptr arg1)

Description: Virtual method int QBoxLayout::indexOf(QWidget *)

This method can be reimplemented in a derived class.

insertItem

Signature: void insertItem (int index, QLayoutItem ptr arg2)

Description: Method void QBoxLayout::insertItem(int index, QLayoutItem *)

insertLayout

Signature: void insertLayout (int index, QLayout ptr layout, int stretch = 0)

Description: Method void QBoxLayout::insertLayout(int index, QLayout *layout, int stretch)

insertSpacerItem

Signature: void insertSpacerItem (int index, QSpacerItem ptr spacerItem)

Description: Method void QBoxLayout::insertSpacerItem(int index, QSpacerItem *spacerItem)

insertSpacing

Signature: void insertSpacing (int index, int size)

Description: Method void QBoxLayout::insertSpacing(int index, int size)

insertStretch

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

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

insertWidget

Signature: void insertWidget (int index, QWidget ptr widget, int stretch = 0, Qt_QFlags_AlignmentFlag alignment = Qt::Alignment())

Description: Method void QBoxLayout::insertWidget(int index, QWidget *widget, int stretch, QFlags<Qt::AlignmentFlag> alignment)

invalidate

Signature: void invalidate

Description: Virtual method void QBoxLayout::invalidate()

This method can be reimplemented in a derived class.

isEmpty

Signature: [const] bool isEmpty

Description: Virtual method bool QBoxLayout::isEmpty()

This method can be reimplemented in a derived class.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QBoxLayout::isSignalConnected(const QMetaMethod &signal)

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

itemAt

Signature: [const] QLayoutItem ptr itemAt (int arg1)

Description: Virtual method QLayoutItem *QBoxLayout::itemAt(int)

This method can be reimplemented in a derived class.

layout

Signature: QLayout ptr layout

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

This method can be reimplemented in a derived class.

maximumSize

Signature: [const] QSize maximumSize

Description: Virtual method QSize QBoxLayout::maximumSize()

This method can be reimplemented in a derived class.

minimumHeightForWidth

Signature: [const] int minimumHeightForWidth (int arg1)

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

This method can be reimplemented in a derived class.

minimumSize

Signature: [const] QSize minimumSize

Description: Virtual method QSize QBoxLayout::minimumSize()

This method can be reimplemented in a derived class.

new

Signature: [static] new QBoxLayout new (const QBoxLayout_Direction arg1, QWidget ptr parent = nullptr)

Description: Constructor QBoxLayout::QBoxLayout(QBoxLayout::Direction, QWidget *parent)

This method creates an object of class QBoxLayout.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QBoxLayout::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

receivers

Signature: [const] int receivers (string signal)

Description: Method int QBoxLayout::receivers(const char *signal)

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

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QBoxLayout::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QBoxLayout::senderSignalIndex()

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

setDirection

Signature: void setDirection (const QBoxLayout_Direction arg1)

Description: Method void QBoxLayout::setDirection(QBoxLayout::Direction)

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

setGeometry

Signature: void setGeometry (const QRect arg1)

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

This method can be reimplemented in a derived class.

setSpacing

Signature: void setSpacing (int spacing)

Description: Method void QBoxLayout::setSpacing(int spacing)

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

setStretch

Signature: void setStretch (int index, int stretch)

Description: Method void QBoxLayout::setStretch(int index, int stretch)

setStretchFactor

(1) Signature: bool setStretchFactor (QWidget ptr w, int stretch)

Description: Method bool QBoxLayout::setStretchFactor(QWidget *w, int stretch)

(2) Signature: bool setStretchFactor (QLayout ptr l, int stretch)

Description: Method bool QBoxLayout::setStretchFactor(QLayout *l, int stretch)

sizeHint

Signature: [const] QSize sizeHint

Description: Virtual method QSize QBoxLayout::sizeHint()

This method can be reimplemented in a derived class.

spacerItem

Signature: QSpacerItem ptr spacerItem

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

This method can be reimplemented in a derived class.

spacing

Signature: [const] int spacing

Description: Method int QBoxLayout::spacing()

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

spacing=

Signature: void spacing= (int spacing)

Description: Method void QBoxLayout::setSpacing(int spacing)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

stretch

Signature: [const] int stretch (int index)

Description: Method int QBoxLayout::stretch(int index)

takeAt

Signature: QLayoutItem ptr takeAt (int arg1)

Description: Virtual method QLayoutItem *QBoxLayout::takeAt(int)

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QBoxLayout::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QBoxLayout::tr(const char *s, const char *c, int n)

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

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QBoxLayout::trUtf8(const char *s, const char *c, int n)

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

widget

Signature: QWidget ptr widget

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

This method can be reimplemented in a derived class.

widgetEvent

Signature: void widgetEvent (QEvent ptr arg1)

Description: Method void QBoxLayout::widgetEvent(QEvent *)

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