QLayout Class

Member Function Documentation

[explicit] QLayout::QLayout(QWidget *parent = nullptr)

Constructs a new top-level QLayout, with parent parent.

The layout is set directly as the top-level layout for parent. There can be only one top-level layout for a widget. It is returned by QWidget::layout().

If parent is nullptr, then you must insert this layout into another layout, or set it as a widget's layout using QWidget::setLayout().

See also QWidget::setLayout().

bool QLayout::activate()

Redoes the layout for parentWidget() if necessary.

You should generally not need to call this because it is automatically called at the most appropriate times. It returns true if the layout was redone.

See also update() and QWidget::updateGeometry().

[protected] void QLayout::addChildLayout(QLayout *childLayout)

This function is called from addLayout() or insertLayout() functions in subclasses to add layout childLayout as a sub-layout.

The only scenario in which you need to call it directly is if you implement a custom layout that supports nested layouts.

See also QBoxLayout::addLayout(), QBoxLayout::insertLayout(), and QGridLayout::addLayout().

[protected] void QLayout::addChildWidget(QWidget *w)

This function is called from addWidget() functions in subclasses to add w as a managed widget of a layout.

If w is already managed by a layout, this function will produce a warning, and remove w from that layout. This function must therefore be called before adding w to the layout's data structure.

[pure virtual] void QLayout::addItem(QLayoutItem *item)

Implemented in subclasses to add an item. How it is added is specific to each subclass.

This function is not usually called in application code. To add a widget to a layout, use the addWidget() function; to add a child layout, use the addLayout() function provided by the relevant QLayout subclass.

Note: The ownership of item is transferred to the layout, and it's the layout's responsibility to delete it.

See also addWidget(), QBoxLayout::addLayout(), and QGridLayout::addLayout().

void QLayout::addWidget(QWidget *w)

Adds widget w to this layout in a manner specific to the layout. This function uses addItem().

[protected] QRect QLayout::alignmentRect(const QRect &r) const

Returns the rectangle that should be covered when the geometry of this layout is set to r, provided that this layout supports setAlignment().

The result is derived from sizeHint() and expandingDirections(). It is never larger than r.

[override virtual protected] void QLayout::childEvent(QChildEvent *e)

Reimplements: QObject::childEvent(QChildEvent *event).

[static] QSize QLayout::closestAcceptableSize(const QWidget *widget, const QSize &size)

Returns a size that satisfies all size constraints on widget, including heightForWidth() and that is as close as possible to size.

QMargins QLayout::contentsMargins() const

Returns the margins used around the layout.

By default, QLayout uses the values provided by the style. On most platforms, the margin is 11 pixels in all directions.

See also setContentsMargins().

QRect QLayout::contentsRect() const

Returns the layout's geometry() rectangle, but taking into account the contents margins.

See also setContentsMargins() and getContentsMargins().

[override virtual] QSizePolicy::ControlTypes QLayout::controlTypes() const

Reimplements: QLayoutItem::controlTypes() const.

[pure virtual] int QLayout::count() const

Must be implemented in subclasses to return the number of items in the layout.

See also itemAt().

[override virtual] Qt::Orientations QLayout::expandingDirections() const

Reimplements: QLayoutItem::expandingDirections() const.

Returns whether this layout can make use of more space than sizeHint(). A value of Qt::Vertical or Qt::Horizontal means that it wants to grow in only one dimension, whereas Qt::Vertical | Qt::Horizontal means that it wants to grow in both dimensions.

The default implementation returns Qt::Horizontal | Qt::Vertical. Subclasses reimplement it to return a meaningful value based on their child widgets's size policies.

See also sizeHint().

[override virtual] QRect QLayout::geometry() const

Reimplements: QLayoutItem::geometry() const.

See also setGeometry().

void QLayout::getContentsMargins(int *left, int *top, int *right, int *bottom) const

For each of left, top, right and bottom that is not nullptr, stores the size of the margin named in the location the pointer refers to.

By default, QLayout uses the values provided by the style. On most platforms, the margin is 11 pixels in all directions.

See also setContentsMargins(), QStyle::pixelMetric(), PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin.

[virtual] int QLayout::indexOf(const QLayoutItem *layoutItem) const

Searches for layout item layoutItem in this layout (not including child layouts).

Returns the index of layoutItem, or -1 if layoutItem is not found.

[virtual] int QLayout::indexOf(const QWidget *widget) const

Searches for widget widget in this layout (not including child layouts).

Returns the index of widget, or -1 if widget is not found.

The default implementation iterates over all items using itemAt().

[override virtual] void QLayout::invalidate()

Reimplements: QLayoutItem::invalidate().

[override virtual] bool QLayout::isEmpty() const

Reimplements: QLayoutItem::isEmpty() const.

bool QLayout::isEnabled() const

Returns true if the layout is enabled; otherwise returns false.

See also setEnabled().

[pure virtual] QLayoutItem *QLayout::itemAt(int index) const

Must be implemented in subclasses to return the layout item at index. If there is no such item, the function must return nullptr. Items are numbered consecutively from 0. If an item is deleted, other items will be renumbered.

This function can be used to iterate over a layout. The following code will draw a rectangle for each layout item in the layout structure of the widget.

static void paintLayout(QPainter *painter, QLayoutItem *item)
{
    QLayout *layout = item->layout();
    if (layout) {
        for (int i = 0; i < layout->count(); ++i)
            paintLayout(painter, layout->itemAt(i));
    }
    painter->drawRect(item->geometry());
}

void MyWidget::paintEvent(QPaintEvent *)
{
    QPainter painter(this);
    if (layout())
        paintLayout(&painter, layout());
}

See also count() and takeAt().

[override virtual] QLayout *QLayout::layout()

Reimplements: QLayoutItem::layout().

[override virtual] QSize QLayout::maximumSize() const

Reimplements: QLayoutItem::maximumSize() const.

Returns the maximum size of this layout. This is the largest size that the layout can have while still respecting the specifications.

The returned value doesn't include the space required by QWidget::setContentsMargins() or menuBar().

The default implementation allows unlimited resizing.

QWidget *QLayout::menuBar() const

Returns the menu bar set for this layout, or nullptr if no menu bar is set.

See also setMenuBar().

[override virtual] QSize QLayout::minimumSize() const

Reimplements: QLayoutItem::minimumSize() const.

Returns the minimum size of this layout. This is the smallest size that the layout can have while still respecting the specifications.

The returned value doesn't include the space required by QWidget::setContentsMargins() or menuBar().

The default implementation allows unlimited resizing.

QWidget *QLayout::parentWidget() const

Returns the parent widget of this layout, or nullptr if this layout is not installed on any widget.

If the layout is a sub-layout, this function returns the parent widget of the parent layout.

See also parent().

void QLayout::removeItem(QLayoutItem *item)

Removes the layout item item from the layout. It is the caller's responsibility to delete the item.

Notice that item can be a layout (since QLayout inherits QLayoutItem).

See also removeWidget() and addItem().

void QLayout::removeWidget(QWidget *widget)

Removes the widget widget from the layout. After this call, it is the caller's responsibility to give the widget a reasonable geometry or to put the widget back into a layout or to explicitly hide it if necessary.

Note: The ownership of widget remains the same as when it was added.

See also removeItem(), QWidget::setGeometry(), and addWidget().

[virtual] QLayoutItem *QLayout::replaceWidget(QWidget *from, QWidget *to, Qt::FindChildOptions options = Qt::FindChildrenRecursively)

Searches for widget from and replaces it with widget to if found. Returns the layout item that contains the widget from on success. Otherwise nullptr is returned. If options contains Qt::FindChildrenRecursively (the default), sub-layouts are searched for doing the replacement. Any other flag in options is ignored.

Notice that the returned item therefore might not belong to this layout, but to a sub-layout.

The returned layout item is no longer owned by the layout and should be either deleted or inserted to another layout. The widget from is no longer managed by the layout and may need to be deleted or hidden. The parent of widget from is left unchanged.

This function works for the built-in Qt layouts, but might not work for custom layouts.

See also indexOf().

bool QLayout::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.

bool QLayout::setAlignment(QLayout *l, Qt::Alignment alignment)

This is an overloaded function.

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.

void QLayout::setContentsMargins(const QMargins &margins)

Sets the margins to use around the layout.

By default, QLayout uses the values provided by the style. On most platforms, the margin is 11 pixels in all directions.

See also contentsMargins().

void QLayout::setContentsMargins(int left, int top, int right, int bottom)

Sets the left, top, right, and bottom margins to use around the layout.

By default, QLayout uses the values provided by the style. On most platforms, the margin is 11 pixels in all directions.

See also getContentsMargins(), QStyle::pixelMetric(), PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin.

void QLayout::setEnabled(bool enable)

Enables this layout if enable is true, otherwise disables it.

An enabled layout adjusts dynamically to changes; a disabled layout acts as if it did not exist.

By default all layouts are enabled.

See also isEnabled().

[override virtual] void QLayout::setGeometry(const QRect &r)

Reimplements: QLayoutItem::setGeometry(const QRect &r).

See also geometry().

void QLayout::setMenuBar(QWidget *widget)

Tells the geometry manager to place the menu bar widget at the top of parentWidget(), outside QWidget::contentsMargins(). All child widgets are placed below the bottom edge of the menu bar.

See also menuBar().

[pure virtual] QLayoutItem *QLayout::takeAt(int index)

Must be implemented in subclasses to remove the layout item at index from the layout, and return the item. If there is no such item, the function must do nothing and return 0. Items are numbered consecutively from 0. If an item is removed, other items will be renumbered.

The following code fragment shows a safe way to remove all items from a layout:

QLayoutItem *child;
while ((child = layout->takeAt(0)) != nullptr) {
    ...
    delete child->widget(); // delete the widget
    delete child;   // delete the layout item
}

See also itemAt() and count().

[since 6.1] void QLayout::unsetContentsMargins()

Unsets any user-defined margins around the layout. The layout will use the default values provided by the style.

This function was introduced in Qt 6.1.

See also setContentsMargins().

void QLayout::update()

Updates the layout for parentWidget().

You should generally not need to call this because it is automatically called at the most appropriate times.

See also activate() and invalidate().