KLayout Manual: Main Index » Class Index » API reference - Class QBoxLayout

API reference - Class QBoxLayout

Notation used in Ruby API documentation

Description: Binding of QBoxLayout

Class hierarchy: QBoxLayout » QLayout » QObject

Sub-classes: Direction

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QBoxLayout_Direction ptr BottomToTop

Description: Enum constant QBoxLayout::BottomToTop

[static,const] new QBoxLayout_Direction ptr Down

Description: Enum constant QBoxLayout::Down

[static,const] new QBoxLayout_Direction ptr LeftToRight

Description: Enum constant QBoxLayout::LeftToRight

[static,const] new QBoxLayout_Direction ptr RightToLeft

Description: Enum constant QBoxLayout::RightToLeft

[static,const] new QBoxLayout_Direction ptr TopToBottom

Description: Enum constant QBoxLayout::TopToBottom

[static,const] new QBoxLayout_Direction ptr Up

Description: Enum constant QBoxLayout::Up

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.

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.

[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.

[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.

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.

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.

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.

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.

[virtual] void addItem(QLayoutItem ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

void addSpacerItem(QSpacerItem ptr spacerItem)

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

void addSpacing(int size)

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

void addStretch(int stretch = 0)

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

void addStrut(int arg1)

Description: Method void QBoxLayout::addStrut(int)

void addWidget(QWidget ptr arg1,int stretch = 0,const Qt_QFlags_AlignmentFlag alignment = 0)

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

[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.

[virtual] void childEvent(QChildEvent ptr e)

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

This method can be reimplemented in a derived class.

[virtual,const] int count

Description: Virtual method int QBoxLayout::count()

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] QBoxLayout_Direction direction

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

Python specific notes:

The object exposes a readable attribute 'direction'. This is the getter.

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.

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QBoxLayout::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

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

This method can be reimplemented in a derived class.

[virtual,const] Qt_QFlags_Orientation expandingDirections

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

This method can be reimplemented in a derived class.

[virtual,const] QRect geometry

Description: Virtual method QRect QBoxLayout::geometry()

This method can be reimplemented in a derived class.

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.

[virtual,const] bool hasHeightForWidth

Description: Virtual method bool QBoxLayout::hasHeightForWidth()

This method can be reimplemented in a derived class.

[virtual,const] int heightForWidth(int arg1)

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

This method can be reimplemented in a derived class.

[virtual,const] int indexOf(QWidget ptr arg1)

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

This method can be reimplemented in a derived class.

void insertItem(int index,QLayoutItem ptr arg2)

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

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

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

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

void insertSpacerItem(int index,QSpacerItem ptr spacerItem)

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

void insertSpacing(int index,int size)

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

void insertStretch(int index,int stretch = 0)

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

void insertWidget(int index,QWidget ptr widget,int stretch = 0,const Qt_QFlags_AlignmentFlag alignment = 0)

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

[virtual] void invalidate

Description: Virtual method void QBoxLayout::invalidate()

This method can be reimplemented in a derived class.

[virtual,const] bool isEmpty

Description: Virtual method bool QBoxLayout::isEmpty()

This method can be reimplemented in a derived class.

[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

[virtual,const] QLayoutItem ptr itemAt(int arg1)

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

This method can be reimplemented in a derived class.

[virtual] QLayout ptr layout

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

This method can be reimplemented in a derived class.

[virtual,const] QSize maximumSize

Description: Virtual method QSize QBoxLayout::maximumSize()

This method can be reimplemented in a derived class.

[virtual,const] int minimumHeightForWidth(int arg1)

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

This method can be reimplemented in a derived class.

[virtual,const] QSize minimumSize

Description: Virtual method QSize QBoxLayout::minimumSize()

This method can be reimplemented in a derived class.

[static] new QBoxLayout new(const QBoxLayout_Direction arg1,QWidget ptr parent = 0)

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

[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.

[const] QObject ptr sender

Description: Method QObject *QBoxLayout::sender()

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

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.

[virtual] void setGeometry(const QRect arg1)

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

This method can be reimplemented in a derived class.

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.

void setStretch(int index,int stretch)

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

bool setStretchFactor(QWidget ptr w,int stretch)

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

bool setStretchFactor(QLayout ptr l,int stretch)

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

[virtual,const] QSize sizeHint

Description: Virtual method QSize QBoxLayout::sizeHint()

This method can be reimplemented in a derived class.

[virtual] QSpacerItem ptr spacerItem

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

This method can be reimplemented in a derived class.

[const] int spacing

Description: Method int QBoxLayout::spacing()

Python specific notes:

The object exposes a readable attribute 'spacing'. This is the getter.

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.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[const] int stretch(int index)

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

[virtual] QLayoutItem ptr takeAt(int arg1)

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

This method can be reimplemented in a derived class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

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

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

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

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

[static] string trUtf8(string s,string c,int n)

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.

[virtual] QWidget ptr widget

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

This method can be reimplemented in a derived class.

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.