Qt 4.8
Public Functions | List of all members
QVBoxLayout Class Reference

The QVBoxLayout class lines up widgets vertically. More...

#include <qboxlayout.h>

Inheritance diagram for QVBoxLayout:
QBoxLayout QLayout QObject QLayoutItem

Public Functions

 QVBoxLayout ()
 Constructs a new vertical box. More...
 
 QVBoxLayout (QWidget *parent)
 Constructs a new top-level vertical box with parent parent. More...
 
 ~QVBoxLayout ()
 Destroys this box layout. More...
 
- Public Functions inherited from QBoxLayout
void addItem (QLayoutItem *)
 Reimplemented Function More...
 
void addLayout (QLayout *layout, int stretch=0)
 Adds layout to the end of the box, with serial stretch factor stretch. More...
 
void addSpacerItem (QSpacerItem *spacerItem)
 Adds spacerItem to the end of this box layout. More...
 
void addSpacing (int size)
 Adds a non-stretchable space (a QSpacerItem) with size size to the end of this box layout. More...
 
void addStretch (int stretch=0)
 Adds a stretchable space (a QSpacerItem) with zero minimum size and stretch factor stretch to the end of this box layout. More...
 
void addStrut (int)
 Limits the perpendicular dimension of the box (e.g. More...
 
void addWidget (QWidget *, int stretch=0, Qt::Alignment alignment=0)
 Adds widget to the end of this box layout, with a stretch factor of stretch and alignment alignment. More...
 
int count () const
 Reimplemented Function More...
 
Direction direction () const
 Returns the direction of the box. More...
 
Qt::Orientations expandingDirections () const
 Reimplemented Function More...
 
bool hasHeightForWidth () const
 Reimplemented Function More...
 
int heightForWidth (int) const
 Reimplemented Function More...
 
void insertLayout (int index, QLayout *layout, int stretch=0)
 Inserts layout at position index, with stretch factor stretch. More...
 
void insertSpacerItem (int index, QSpacerItem *spacerItem)
 Inserts spacerItem at position index, with zero minimum size and stretch factor. More...
 
void insertSpacing (int index, int size)
 Inserts a non-stretchable space (a QSpacerItem) at position index, with size size. More...
 
void insertStretch (int index, int stretch=0)
 Inserts a stretchable space (a QSpacerItem) at position index, with zero minimum size and stretch factor stretch. More...
 
void insertWidget (int index, QWidget *widget, int stretch=0, Qt::Alignment alignment=0)
 Inserts widget at position index, with stretch factor stretch and alignment alignment. More...
 
void invalidate ()
 Resets cached information. More...
 
QLayoutItemitemAt (int) const
 Reimplemented Function More...
 
QSize maximumSize () const
 Reimplemented Function More...
 
int minimumHeightForWidth (int) const
 Reimplemented Function More...
 
QSize minimumSize () const
 Reimplemented Function More...
 
 QBoxLayout (Direction, QWidget *parent=0)
 Constructs a new QBoxLayout with direction dir and parent widget parent. More...
 
void setDirection (Direction)
 Sets the direction of this layout to direction. More...
 
void setGeometry (const QRect &)
 Reimplemented Function More...
 
void setSpacing (int spacing)
 Reimplements QLayout::setSpacing(). More...
 
void setStretch (int index, int stretch)
 Sets the stretch factor at position index. More...
 
bool 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. More...
 
bool setStretchFactor (QLayout *l, int stretch)
 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. More...
 
QSize sizeHint () const
 Reimplemented Function More...
 
int spacing () const
 Reimplements QLayout::spacing(). More...
 
int stretch (int index) const
 Returns the stretch factor at position index. More...
 
QLayoutItemtakeAt (int)
 Reimplemented Function More...
 
 ~QBoxLayout ()
 Destroys this box layout. More...
 
- Public Functions inherited from QLayout
bool activate ()
 Redoes the layout for parentWidget() if necessary. More...
 
void addWidget (QWidget *w)
 Adds widget w to this layout in a manner specific to the layout. More...
 
QMargins contentsMargins () const
 Returns the margins used around the layout. More...
 
QRect contentsRect () const
 Returns the layout's geometry() rectangle, but taking into account the contents margins. More...
 
Qt::Orientations expandingDirections () const
 Returns whether this layout can make use of more space than sizeHint(). More...
 
QRect geometry () const
 Reimplemented Function More...
 
void getContentsMargins (int *left, int *top, int *right, int *bottom) const
 
virtual int indexOf (QWidget *) const
 Searches for widget widget in this layout (not including child layouts). More...
 
void invalidate ()
 Reimplemented Function More...
 
bool isEmpty () const
 Reimplemented Function More...
 
bool isEnabled () const
 Returns true if the layout is enabled; otherwise returns false. More...
 
QLayoutlayout ()
 Reimplemented Function More...
 
int margin () const
 
QSize maximumSize () const
 Returns the maximum size of this layout. More...
 
QWidgetmenuBar () const
 Returns the menu bar set for this layout, or 0 if no menu bar is set. More...
 
QSize minimumSize () const
 Returns the minimum size of this layout. More...
 
QWidgetparentWidget () const
 Returns the parent widget of this layout, or 0 if this layout is not installed on any widget. More...
 
 QLayout (QWidget *parent)
 Constructs a new top-level QLayout, with parent parent. More...
 
 QLayout ()
 Constructs a new child QLayout. More...
 
void removeItem (QLayoutItem *)
 Removes the layout item item from the layout. More...
 
void removeWidget (QWidget *w)
 Removes the widget widget from the layout. More...
 
bool setAlignment (QWidget *w, Qt::Alignment alignment)
 Sets the alignment for widget w to alignment and returns true if w is found in this layout (not including child layouts); otherwise returns false. More...
 
bool setAlignment (QLayout *l, Qt::Alignment alignment)
 Sets the alignment for the layout l to alignment and returns true if l is found in this layout (not including child layouts); otherwise returns false. More...
 
void setContentsMargins (int left, int top, int right, int bottom)
 Sets the left, top, right, and bottom margins to use around the layout. More...
 
void setContentsMargins (const QMargins &margins)
 Sets the margins to use around the layout. More...
 
void setEnabled (bool)
 Enables this layout if enable is true, otherwise disables it. More...
 
void setMargin (int)
 
void setMenuBar (QWidget *w)
 Tells the geometry manager to place the menu bar widget at the top of parentWidget(), outside QWidget::contentsMargins(). More...
 
void setSizeConstraint (SizeConstraint)
 
void setSpacing (int)
 
SizeConstraint sizeConstraint () const
 
int spacing () const
 
int totalHeightForWidth (int w) const
 Also takes contentsMargins and menu bar into account. More...
 
QSize totalMaximumSize () const
 Also takes contentsMargins and menu bar into account. More...
 
QSize totalMinimumSize () const
 Also takes contentsMargins and menu bar into account. More...
 
QSize totalSizeHint () const
 Also takes contentsMargins and menu bar into account. More...
 
void update ()
 Updates the layout for parentWidget(). More...
 
 ~QLayout ()
 Destroys the layout, deleting all child layouts. More...
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool event (QEvent *)
 This virtual function receives events to an object and should return true if the event e was recognized and processed. More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 
- Public Functions inherited from QLayoutItem
Qt::Alignment alignment () const
 Returns the alignment of this item. More...
 
QSizePolicy::ControlTypes controlTypes () const
 Returns the control type(s) for the layout item. More...
 
 QLayoutItem (Qt::Alignment alignment=0)
 Constructs a layout item with an alignment. More...
 
void setAlignment (Qt::Alignment a)
 Sets the alignment of this item to alignment. More...
 
virtual QSpacerItemspacerItem ()
 If this item is a QSpacerItem, it is returned as a QSpacerItem; otherwise 0 is returned. More...
 
virtual QWidgetwidget ()
 If this item is a QWidget, it is returned as a QWidget; otherwise 0 is returned. More...
 
virtual ~QLayoutItem ()
 Destroys the QLayoutItem. More...
 

Additional Inherited Members

- Public Types inherited from QBoxLayout
enum  Direction {
  LeftToRight, RightToLeft, TopToBottom, BottomToTop,
  Down = TopToBottom, Up = BottomToTop
}
 This type is used to determine the direction of a box layout. More...
 
- Public Types inherited from QLayout
enum  SizeConstraint {
  SetDefaultConstraint, SetNoConstraint, SetMinimumSize, SetFixedSize,
  SetMaximumSize, SetMinAndMaxSize
}
 The possible values are: More...
 
- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 
- Static Public Functions inherited from QLayout
static QSize closestAcceptableSize (const QWidget *w, const QSize &s)
 Returns a size that satisfies all size constraints on widget, including heightForWidth() and that is as close as possible to size. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Functions inherited from QBoxLayout
void insertItem (int index, QLayoutItem *)
 Inserts item into this box layout at position index. More...
 
- Protected Functions inherited from QLayout
void addChildLayout (QLayout *l)
 This function is called from addLayout() or insertLayout() functions in subclasses to add layout l as a sub-layout. More...
 
void addChildWidget (QWidget *w)
 This function is called from addWidget() functions in subclasses to add w as a managed widget of a layout. More...
 
bool adoptLayout (QLayout *layout)
 
QRect alignmentRect (const QRect &) const
 Returns the rectangle that should be covered when the geometry of this layout is set to r, provided that this layout supports setAlignment(). More...
 
void childEvent (QChildEvent *e)
 Reimplemented Function More...
 
 QLayout (QLayoutPrivate &d, QLayout *, QWidget *)
 
void widgetEvent (QEvent *)
 Performs child widget layout when the parent widget is resized. More...
 
- Protected Functions inherited from QObject
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *)
 This event handler can be reimplemented in a subclass to receive timer events for the object. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Protected Variables inherited from QLayoutItem
Qt::Alignment align
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

The QVBoxLayout class lines up widgets vertically.

This class is used to construct vertical box layout objects. See QBoxLayout for details.

The simplest use of the class is like this:

QPushButton *button1 = new QPushButton("One");
QPushButton *button2 = new QPushButton("Two");
QPushButton *button3 = new QPushButton("Three");
QPushButton *button4 = new QPushButton("Four");
QPushButton *button5 = new QPushButton("Five");
layout->addWidget(button1);
layout->addWidget(button2);
layout->addWidget(button3);
layout->addWidget(button4);
layout->addWidget(button5);
window->setLayout(layout);
window->show();

First, we create the widgets we want in the layout. Then, we create the QVBoxLayout object and add the widgets into the layout. Finally, we call QWidget::setLayout() to install the QVBoxLayout object onto the widget. At that point, the widgets in the layout are reparented to have window as their parent.

qvboxlayout-with-5-children.png
Horizontal box layout with five child widgets
See also
QHBoxLayout, QGridLayout, QStackedLayout, {Layout Management}, {Basic Layouts Example}

Definition at line 149 of file qboxlayout.h.

Constructors and Destructors

◆ QVBoxLayout() [1/2]

QVBoxLayout::QVBoxLayout ( )

Constructs a new vertical box.

You must add it to another layout.

Definition at line 1480 of file qboxlayout.cpp.

1482 {
1483 }
QBoxLayout(Direction, QWidget *parent=0)
Constructs a new QBoxLayout with direction dir and parent widget parent.
Definition: qboxlayout.cpp:558

◆ QVBoxLayout() [2/2]

QVBoxLayout::QVBoxLayout ( QWidget parent)
explicit

Constructs a new top-level vertical box with parent parent.

Definition at line 1470 of file qboxlayout.cpp.

1471  : QBoxLayout(TopToBottom, parent)
1472 {
1473 }
QBoxLayout(Direction, QWidget *parent=0)
Constructs a new QBoxLayout with direction dir and parent widget parent.
Definition: qboxlayout.cpp:558

◆ ~QVBoxLayout()

QVBoxLayout::~QVBoxLayout ( )

Destroys this box layout.

The layout's widgets aren't destroyed.

Definition at line 1547 of file qboxlayout.cpp.

1548 {
1549 }

The documentation for this class was generated from the following files: