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

API reference - Class QVBoxLayout

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QVBoxLayout

Class hierarchy: QVBoxLayout » QBoxLayout » QLayout » QObject

Public constructors

new QVBoxLayoutnewConstructor QVBoxLayout::QVBoxLayout()
new QVBoxLayoutnew(QWidget ptr parent)Constructor QVBoxLayout::QVBoxLayout(QWidget *parent)

Public methods

[const]QVBoxLayout 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(QLayoutItem ptr arg1)Virtual method void QVBoxLayout::addItem(QLayoutItem *)
[const]QSizePolicy_QFlags_ControlTypecontrolTypesVirtual method QFlags<QSizePolicy::ControlType> QVBoxLayout::controlTypes()
[const]intcountVirtual method int QVBoxLayout::count()
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QVBoxLayout::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QVBoxLayout::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QVBoxLayout::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QVBoxLayout::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QVBoxLayout::eventFilter(QObject *watched, QEvent *event)
[const]Qt_QFlags_OrientationexpandingDirectionsVirtual method QFlags<Qt::Orientation> QVBoxLayout::expandingDirections()
[const]QRectgeometryVirtual method QRect QVBoxLayout::geometry()
[const]boolhasHeightForWidthVirtual method bool QVBoxLayout::hasHeightForWidth()
[const]intheightForWidth(int arg1)Virtual method int QVBoxLayout::heightForWidth(int)
[const]intindexOf(QWidget ptr arg1)Virtual method int QVBoxLayout::indexOf(QWidget *)
voidinvalidateVirtual method void QVBoxLayout::invalidate()
[const]boolisEmptyVirtual method bool QVBoxLayout::isEmpty()
[const]QLayoutItem ptritemAt(int arg1)Virtual method QLayoutItem *QVBoxLayout::itemAt(int)
QLayout ptrlayoutVirtual method QLayout *QVBoxLayout::layout()
[const]QSizemaximumSizeVirtual method QSize QVBoxLayout::maximumSize()
[const]intminimumHeightForWidth(int arg1)Virtual method int QVBoxLayout::minimumHeightForWidth(int)
[const]QSizeminimumSizeVirtual method QSize QVBoxLayout::minimumSize()
[signal]voidobjectNameChanged(string objectName)Signal declaration for QVBoxLayout::objectNameChanged(const QString &objectName)
voidsetGeometry(const QRect arg1)Virtual method void QVBoxLayout::setGeometry(const QRect &)
[const]QSizesizeHintVirtual method QSize QVBoxLayout::sizeHint()
QSpacerItem ptrspacerItemVirtual method QSpacerItem *QVBoxLayout::spacerItem()
QLayoutItem ptrtakeAt(int arg1)Virtual method QLayoutItem *QVBoxLayout::takeAt(int)
QWidget ptrwidgetVirtual method QWidget *QVBoxLayout::widget()

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QVBoxLayout::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QVBoxLayout::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidaddChildLayout(QLayout ptr l)Method void QVBoxLayout::addChildLayout(QLayout *l)
voidaddChildWidget(QWidget ptr w)Method void QVBoxLayout::addChildWidget(QWidget *w)
booladoptLayout(QLayout ptr layout)Method bool QVBoxLayout::adoptLayout(QLayout *layout)
[const]QRectalignmentRect(const QRect arg1)Method QRect QVBoxLayout::alignmentRect(const QRect &)
voidchildEvent(QChildEvent ptr e)Virtual method void QVBoxLayout::childEvent(QChildEvent *e)
voidcustomEvent(QEvent ptr event)Virtual method void QVBoxLayout::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QVBoxLayout::disconnectNotify(const QMetaMethod &signal)
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QVBoxLayout::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QVBoxLayout::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QVBoxLayout::sender()
[const]intsenderSignalIndexMethod int QVBoxLayout::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QVBoxLayout::timerEvent(QTimerEvent *event)
voidwidgetEvent(QEvent ptr arg1)Method void QVBoxLayout::widgetEvent(QEvent *)

Detailed description

_const_cast

Signature: [const] QVBoxLayout 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 QVBoxLayout::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 QVBoxLayout::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 QVBoxLayout::addItem(QLayoutItem *)

This method can be reimplemented in a derived class.

adoptLayout

Signature: bool adoptLayout (QLayout ptr layout)

Description: Method bool QVBoxLayout::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 QVBoxLayout::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 QVBoxLayout::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> QVBoxLayout::controlTypes()

This method can be reimplemented in a derived class.

count

Signature: [const] int count

Description: Virtual method int QVBoxLayout::count()

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QVBoxLayout::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.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QVBoxLayout::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 QVBoxLayout::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QVBoxLayout::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 QVBoxLayout::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> QVBoxLayout::expandingDirections()

This method can be reimplemented in a derived class.

geometry

Signature: [const] QRect geometry

Description: Virtual method QRect QVBoxLayout::geometry()

This method can be reimplemented in a derived class.

hasHeightForWidth

Signature: [const] bool hasHeightForWidth

Description: Virtual method bool QVBoxLayout::hasHeightForWidth()

This method can be reimplemented in a derived class.

heightForWidth

Signature: [const] int heightForWidth (int arg1)

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

This method can be reimplemented in a derived class.

indexOf

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

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

This method can be reimplemented in a derived class.

invalidate

Signature: void invalidate

Description: Virtual method void QVBoxLayout::invalidate()

This method can be reimplemented in a derived class.

isEmpty

Signature: [const] bool isEmpty

Description: Virtual method bool QVBoxLayout::isEmpty()

This method can be reimplemented in a derived class.

isSignalConnected

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

Description: Method bool QVBoxLayout::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 *QVBoxLayout::itemAt(int)

This method can be reimplemented in a derived class.

layout

Signature: QLayout ptr layout

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

This method can be reimplemented in a derived class.

maximumSize

Signature: [const] QSize maximumSize

Description: Virtual method QSize QVBoxLayout::maximumSize()

This method can be reimplemented in a derived class.

minimumHeightForWidth

Signature: [const] int minimumHeightForWidth (int arg1)

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

This method can be reimplemented in a derived class.

minimumSize

Signature: [const] QSize minimumSize

Description: Virtual method QSize QVBoxLayout::minimumSize()

This method can be reimplemented in a derived class.

new

(1) Signature: [static] new QVBoxLayout new

Description: Constructor QVBoxLayout::QVBoxLayout()

This method creates an object of class QVBoxLayout.

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

(2) Signature: [static] new QVBoxLayout new (QWidget ptr parent)

Description: Constructor QVBoxLayout::QVBoxLayout(QWidget *parent)

This method creates an object of class QVBoxLayout.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QVBoxLayout::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 QVBoxLayout::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 *QVBoxLayout::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QVBoxLayout::senderSignalIndex()

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

setGeometry

Signature: void setGeometry (const QRect arg1)

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

This method can be reimplemented in a derived class.

sizeHint

Signature: [const] QSize sizeHint

Description: Virtual method QSize QVBoxLayout::sizeHint()

This method can be reimplemented in a derived class.

spacerItem

Signature: QSpacerItem ptr spacerItem

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

This method can be reimplemented in a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

takeAt

Signature: QLayoutItem ptr takeAt (int arg1)

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

This method can be reimplemented in a derived class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QVBoxLayout::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 QVBoxLayout::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 QVBoxLayout::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 *QVBoxLayout::widget()

This method can be reimplemented in a derived class.

widgetEvent

Signature: void widgetEvent (QEvent ptr arg1)

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

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