com.trolltech.qt.gui
Class QBoxLayout

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.core.QObject
                  extended by com.trolltech.qt.gui.QLayout
                      extended by com.trolltech.qt.gui.QBoxLayout
All Implemented Interfaces:
QLayoutItemInterface, QtJambiInterface
Direct Known Subclasses:
QHBoxLayout, QVBoxLayout

public class QBoxLayout
extends QLayout

The QBoxLayout class lines up child widgets horizontally or vertically. QBoxLayout takes the space it gets (from its parent layout or from the parentWidget()), divides it up into a row of boxes, and makes each managed widget fill one box.


If the QBoxLayout's orientation is Qt::Horizontal the boxes are placed in a row, with suitable sizes. Each widget (or other box) will get at least its minimum size and at most its maximum size. Any excess space is shared according to the stretch factors (more about that below).

If the QBoxLayout's orientation is Qt::Vertical , the boxes are placed in a column, again with suitable sizes.

The easiest way to create a QBoxLayout is to use one of the convenience classes, e.g. QHBoxLayout (for Qt::Horizontal boxes) or QVBoxLayout (for Qt::Vertical boxes). You can also use the QBoxLayout constructor directly, specifying its direction as LeftToRight , RightToLeft , TopToBottom , or BottomToTop .

If the QBoxLayout is not the top-level layout (i.e. it is not managing all of the widget's area and children), you must add it to its parent layout before you can do anything with it. The normal way to add a layout is by calling parentLayout->addLayout().

Once you have done this, you can add boxes to the QBoxLayout using one of four functions:

Use insertWidget(), insertSpacing(), insertStretch() or insertLayout() to insert a box at a specified position in the layout.

QBoxLayout also includes two margin widths:

The margin default is provided by the style. The default margin most Qt styles specify is 9 for child widgets and 11 for windows. The spacing defaults to the same as the margin width for a top-level layout, or to the same as the parent layout.

To remove a widget from a layout, call removeWidget(). Calling QWidget::hide() on a widget also effectively removes the widget from the layout until QWidget::show() is called.

You will almost always want to use QVBoxLayout and QHBoxLayout rather than QBoxLayout because of their convenient constructors.

See also:
QGridLayout, QStackedLayout, and Layout Classes.


Nested Class Summary
static class QBoxLayout.Direction
          This type is used to determine the direction of a box layout.
 
Nested classes/interfaces inherited from class com.trolltech.qt.gui.QLayout
QLayout.SizeConstraint
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
QBoxLayout(QBoxLayout.Direction arg__1)
          Constructs a new QBoxLayout with direction dir and parent widget parent.
QBoxLayout(QBoxLayout.Direction arg__1, QWidget parent)
          Constructs a new QBoxLayout with direction dir and parent widget parent.
 
Method Summary
 void addLayout(QLayout layout)
          Adds layout to the end of the box, with serial stretch factor stretch.
 void addLayout(QLayout layout, int stretch)
          Adds layout to the end of the box, with serial stretch factor stretch.
 void addSpacerItem(QSpacerItem spacerItem)
          Adds spacerItem to the end of this box layout.
 void addSpacing(int size)
          Adds a non-stretchable space (a QSpacerItem) with size size to the end of this box layout.
 void addStretch()
          Adds a stretchable space (a QSpacerItem) with zero minimum size and stretch factor stretch to the end of this box layout.
 void addStretch(int stretch)
          Adds a stretchable space (a QSpacerItem) with zero minimum size and stretch factor stretch to the end of this box layout.
 void addStrut(int arg__1)
          Limits the perpendicular dimension of the box (e.
 void addWidget(QWidget arg__1, int stretch, Qt.Alignment alignment)
          Adds widget to the end of this box layout, with a stretch factor of stretch and alignment alignment.
 void addWidget(QWidget arg__1, int stretch, Qt.AlignmentFlag[] alignment)
          This is an overloaded method provided for convenience.
 QBoxLayout.Direction direction()
          Returns the direction of the box.
protected  void insertItem(int index, QLayoutItemInterface arg__2)
          Inserts item into this box layout at position index.
 void insertLayout(int index, QLayout layout)
          Inserts layout at position index, with stretch factor stretch.
 void insertLayout(int index, QLayout layout, int stretch)
          Inserts layout at position index, with stretch factor stretch.
 void insertSpacerItem(int index, QSpacerItem spacerItem)
          Inserts spacerItem at position index, with zero minimum size and stretch factor.
 void insertSpacing(int index, int size)
          Inserts a non-stretchable space (a QSpacerItem) at position index, with size size.
 void insertStretch(int index)
          Inserts a stretchable space (a QSpacerItem) at position index, with zero minimum size and stretch factor stretch.
 void insertStretch(int index, int stretch)
          Inserts a stretchable space (a QSpacerItem) at position index, with zero minimum size and stretch factor stretch.
 void insertWidget(int index, QWidget widget)
          Inserts widget at position index, with stretch factor stretch and alignment alignment.
 void insertWidget(int index, QWidget widget, int stretch)
          Inserts widget at position index, with stretch factor stretch and alignment alignment.
 void insertWidget(int index, QWidget widget, int stretch, Qt.Alignment alignment)
          Inserts widget at position index, with stretch factor stretch and alignment alignment.
 void insertWidget(int index, QWidget widget, int stretch, Qt.AlignmentFlag[] alignment)
          This is an overloaded method provided for convenience.
 void setDirection(QBoxLayout.Direction arg__1)
          Sets the direction of this layout to direction.
 void setSpacing(int spacing)
          Reimplements QLayout.:setSpacing().
 void setStretch(int index, int stretch)
          Sets the stretch factor at position index.
 boolean setStretchFactor(QLayout l, int stretch)
          This is an overloaded member function, provided for convenience.
 boolean setStretchFactor(QWidget w, int stretch)
          Sets the stretch factor for widget to stretch and returns true if widget is found in this layout (not including child layouts); otherwise returns false.
 int spacing()
          Reimplements QLayout.:spacing().
 int stretch(int index)
          Returns the stretch factor at position index.
 
Methods inherited from class com.trolltech.qt.gui.QLayout
activate, addChildLayout, addChildWidget, addItem, addWidget, alignment, alignmentRect, closestAcceptableSize, contentsRect, controlTypes, count, expandingDirections, geometry, getContentsMargins, hasHeightForWidth, heightForWidth, indexOf, invalidate, isEmpty, isEnabled, itemAt, layout, maximumSize, menuBar, minimumHeightForWidth, minimumSize, parentWidget, removeItem, removeWidget, setAlignment, setAlignment, setAlignment, setAlignment, setAlignment, setContentsMargins, setContentsMargins, setEnabled, setGeometry, setMargin, setMenuBar, setSizeConstraint, setWidgetSpacing, sizeConstraint, sizeHint, spacerItem, takeAt, update, widget, widgetSpacing
 
Methods inherited from class com.trolltech.qt.core.QObject
childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QBoxLayout

public QBoxLayout(QBoxLayout.Direction arg__1)
Constructs a new QBoxLayout with direction dir and parent widget parent.

See also:
direction().


QBoxLayout

public QBoxLayout(QBoxLayout.Direction arg__1,
                  QWidget parent)
Constructs a new QBoxLayout with direction dir and parent widget parent.

See also:
direction().

Method Detail

addLayout

public final void addLayout(QLayout layout)
Adds layout to the end of the box, with serial stretch factor stretch.

See also:
insertLayout(), addItem(), and addWidget().


addLayout

public final void addLayout(QLayout layout,
                            int stretch)
Adds layout to the end of the box, with serial stretch factor stretch.

See also:
insertLayout(), addItem(), and addWidget().


addSpacerItem

public final void addSpacerItem(QSpacerItem spacerItem)
Adds spacerItem to the end of this box layout.

See also:
addSpacing(), and addStretch().


addSpacing

public final void addSpacing(int size)
Adds a non-stretchable space (a QSpacerItem) with size size to the end of this box layout. QBoxLayout provides default margin and spacing. This function adds additional space.

See also:
insertSpacing(), addItem(), and QSpacerItem.


addStretch

public final void addStretch()
Adds a stretchable space (a QSpacerItem) with zero minimum size and stretch factor stretch to the end of this box layout.

See also:
insertStretch(), addItem(), and QSpacerItem.


addStretch

public final void addStretch(int stretch)
Adds a stretchable space (a QSpacerItem) with zero minimum size and stretch factor stretch to the end of this box layout.

See also:
insertStretch(), addItem(), and QSpacerItem.


addStrut

public final void addStrut(int arg__1)
Limits the perpendicular dimension of the box (e. . height if the box is LeftToRight ) to a minimum of size. Other constraints may increase the limit.

See also:
addItem().


addWidget

public final void addWidget(QWidget arg__1,
                            int stretch,
                            Qt.AlignmentFlag[] alignment)
This is an overloaded method provided for convenience.


addWidget

public final void addWidget(QWidget arg__1,
                            int stretch,
                            Qt.Alignment alignment)
Adds widget to the end of this box layout, with a stretch factor of stretch and alignment alignment.

The stretch factor applies only in the direction of the QBoxLayout, and is relative to the other boxes and widgets in this QBoxLayout. Widgets and boxes with higher stretch factors grow more.

If the stretch factor is 0 and nothing else in the QBoxLayout has a stretch factor greater than zero, the space is distributed according to the QWidget:sizePolicy() of each widget that's involved.

The alignment is specified by alignment. The default alignment is 0, which means that the widget fills the entire cell.

See also:
insertWidget(), addItem(), addLayout(), addStretch(), addSpacing(), and addStrut().


direction

public final QBoxLayout.Direction direction()
Returns the direction of the box. addWidget() and addSpacing() work in this direction; the stretch stretches in this direction.

See also:
setDirection(), QBoxLayout::Direction , addWidget(), and addSpacing().


insertItem

protected final void insertItem(int index,
                                QLayoutItemInterface arg__2)
Inserts item into this box layout at position index. If index is negative, the item is added at the end.

See also:
addItem(), insertWidget(), insertLayout(), insertStretch(), and insertSpacing().


insertLayout

public final void insertLayout(int index,
                               QLayout layout)
Inserts layout at position index, with stretch factor stretch. If index is negative, the layout is added at the end.

layout becomes a child of the box layout.

See also:
addLayout(), and insertItem().


insertLayout

public final void insertLayout(int index,
                               QLayout layout,
                               int stretch)
Inserts layout at position index, with stretch factor stretch. If index is negative, the layout is added at the end.

layout becomes a child of the box layout.

See also:
addLayout(), and insertItem().


insertSpacerItem

public final void insertSpacerItem(int index,
                                   QSpacerItem spacerItem)
Inserts spacerItem at position index, with zero minimum size and stretch factor. If index is negative the space is added at the end.

See also:
addSpacerItem(), insertStretch(), and insertSpacing().


insertSpacing

public final void insertSpacing(int index,
                                int size)
Inserts a non-stretchable space (a QSpacerItem) at position index, with size size. If index is negative the space is added at the end.

The box layout has default margin and spacing. This function adds additional space.

See also:
addSpacing(), insertItem(), and QSpacerItem.


insertStretch

public final void insertStretch(int index)
Inserts a stretchable space (a QSpacerItem) at position index, with zero minimum size and stretch factor stretch. If index is negative the space is added at the end.

See also:
addStretch(), insertItem(), and QSpacerItem.


insertStretch

public final void insertStretch(int index,
                                int stretch)
Inserts a stretchable space (a QSpacerItem) at position index, with zero minimum size and stretch factor stretch. If index is negative the space is added at the end.

See also:
addStretch(), insertItem(), and QSpacerItem.


insertWidget

public final void insertWidget(int index,
                               QWidget widget,
                               int stretch,
                               Qt.AlignmentFlag[] alignment)
This is an overloaded method provided for convenience.


insertWidget

public final void insertWidget(int index,
                               QWidget widget,
                               int stretch)
Inserts widget at position index, with stretch factor stretch and alignment alignment. If index is negative, the widget is added at the end.

The stretch factor applies only in the direction of the QBoxLayout, and is relative to the other boxes and widgets in this QBoxLayout. Widgets and boxes with higher stretch factors grow more.

If the stretch factor is 0 and nothing else in the QBoxLayout has a stretch factor greater than zero, the space is distributed according to the QWidget:sizePolicy() of each widget that's involved.

The alignment is specified by alignment. The default alignment is 0, which means that the widget fills the entire cell.

See also:
addWidget(), and insertItem().


insertWidget

public final void insertWidget(int index,
                               QWidget widget)
Inserts widget at position index, with stretch factor stretch and alignment alignment. If index is negative, the widget is added at the end.

The stretch factor applies only in the direction of the QBoxLayout, and is relative to the other boxes and widgets in this QBoxLayout. Widgets and boxes with higher stretch factors grow more.

If the stretch factor is 0 and nothing else in the QBoxLayout has a stretch factor greater than zero, the space is distributed according to the QWidget:sizePolicy() of each widget that's involved.

The alignment is specified by alignment. The default alignment is 0, which means that the widget fills the entire cell.

See also:
addWidget(), and insertItem().


insertWidget

public final void insertWidget(int index,
                               QWidget widget,
                               int stretch,
                               Qt.Alignment alignment)
Inserts widget at position index, with stretch factor stretch and alignment alignment. If index is negative, the widget is added at the end.

The stretch factor applies only in the direction of the QBoxLayout, and is relative to the other boxes and widgets in this QBoxLayout. Widgets and boxes with higher stretch factors grow more.

If the stretch factor is 0 and nothing else in the QBoxLayout has a stretch factor greater than zero, the space is distributed according to the QWidget:sizePolicy() of each widget that's involved.

The alignment is specified by alignment. The default alignment is 0, which means that the widget fills the entire cell.

See also:
addWidget(), and insertItem().


setDirection

public final void setDirection(QBoxLayout.Direction arg__1)
Sets the direction of this layout to direction.

See also:
direction().


setSpacing

public final void setSpacing(int spacing)
Reimplements QLayout.:setSpacing(). Sets the spacing property to spacing.

See also:
QLayout::setSpacing(), and spacing().


setStretch

public final void setStretch(int index,
                             int stretch)
Sets the stretch factor at position index. to stretch.

See also:
stretch().


setStretchFactor

public final boolean setStretchFactor(QLayout l,
                                      int stretch)
This is an overloaded member function, provided for convenience.

Sets the stretch factor for the layout layout to stretch and returns true if layout is found in this layout (not including child layouts); otherwise returns false.


setStretchFactor

public final boolean setStretchFactor(QWidget w,
                                      int stretch)
Sets the stretch factor for widget to stretch and returns true if widget is found in this layout (not including child layouts); otherwise returns false.

See also:
setAlignment().


spacing

public final int spacing()
Reimplements QLayout.:spacing(). If the spacing property is valid, that value is returned. Otherwise, a value for the spacing property is computed and returned. Since layout spacing in a widget is style dependent, if the parent is a widget, it queries the style for the (horizontal or vertical) spacing of the layout. Otherwise, the parent is a layout, and it queries the parent layout for the spacing().

See also:
QLayout::spacing(), and setSpacing().


stretch

public final int stretch(int index)
Returns the stretch factor at position index.

See also:
setStretch().