QGridLayout Class

Member Function Documentation

QGridLayout::QGridLayout()

Constructs a new grid layout.

You must insert this grid into another layout. You can insert widgets and layouts into this layout at any time, but laying out will not be performed before this is inserted into another layout.

QGridLayout::QGridLayout(QWidget *parent)

Constructs a new QGridLayout with parent widget, parent. The layout has one row and one column initially, and will expand when new items are inserted.

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().

See also QWidget::setLayout().

[virtual] QGridLayout::~QGridLayout()

Destroys the grid layout. Geometry management is terminated if this is a top-level grid.

The layout's widgets aren't destroyed.

void QGridLayout::addItem(QLayoutItem *item, int row, int column, int rowSpan = 1, int columnSpan = 1, Qt::Alignment alignment = Qt::Alignment())

Adds item at position row, column, spanning rowSpan rows and columnSpan columns, and aligns it according to alignment. If rowSpan and/or columnSpan is -1, then the item will extend to the bottom and/or right edge, respectively. The layout takes ownership of the item.

[override virtual protected] void QGridLayout::addItem(QLayoutItem *item)

Reimplements: QLayout::addItem(QLayoutItem *item).

void QGridLayout::addLayout(QLayout *layout, int row, int column, Qt::Alignment alignment = Qt::Alignment())

Places the layout at position (row, column) in the grid. The top-left position is (0, 0).

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

A non-zero alignment indicates that the layout should not grow to fill the available space but should be sized according to sizeHint().

layout becomes a child of the grid layout.

void QGridLayout::addLayout(QLayout *layout, int row, int column, int rowSpan, int columnSpan, Qt::Alignment alignment = Qt::Alignment())

This is an overloaded function.

This version adds the layout layout to the cell grid, spanning multiple rows/columns. The cell will start at row, column spanning rowSpan rows and columnSpan columns.

If rowSpan and/or columnSpan is -1, then the layout will extend to the bottom and/or right edge, respectively.

void QGridLayout::addWidget(QWidget *widget, int row, int column, Qt::Alignment alignment = Qt::Alignment())

Adds the given widget to the cell grid at row, column. The top-left position is (0, 0) by default.

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

void QGridLayout::addWidget(QWidget *widget, int fromRow, int fromColumn, int rowSpan, int columnSpan, Qt::Alignment alignment = Qt::Alignment())

This is an overloaded function.

This version adds the given widget to the cell grid, spanning multiple rows/columns. The cell will start at fromRow, fromColumn spanning rowSpan rows and columnSpan columns. The widget will have the given alignment.

If rowSpan and/or columnSpan is -1, then the widget will extend to the bottom and/or right edge, respectively.

QRect QGridLayout::cellRect(int row, int column) const

Returns the geometry of the cell with row row and column column in the grid. Returns an invalid rectangle if row or column is outside the grid.

int QGridLayout::columnCount() const

Returns the number of columns in this grid.

int QGridLayout::columnMinimumWidth(int column) const

Returns the column spacing for column column.

See also setColumnMinimumWidth().

int QGridLayout::columnStretch(int column) const

Returns the stretch factor for column column.

See also setColumnStretch().

[override virtual] int QGridLayout::count() const

Reimplements: QLayout::count() const.

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

Reimplements: QLayout::expandingDirections() const.

void QGridLayout::getItemPosition(int index, int *row, int *column, int *rowSpan, int *columnSpan) const

Returns the position information of the item with the given index.

The variables passed as row and column are updated with the position of the item in the layout, and the rowSpan and columnSpan variables are updated with the vertical and horizontal spans of the item.

See also itemAtPosition() and itemAt().

[override virtual] bool QGridLayout::hasHeightForWidth() const

Reimplements: QLayoutItem::hasHeightForWidth() const.

[override virtual] int QGridLayout::heightForWidth(int w) const

Reimplements: QLayoutItem::heightForWidth(int ) const.

[override virtual] void QGridLayout::invalidate()

Reimplements: QLayout::invalidate().

[override virtual] QLayoutItem *QGridLayout::itemAt(int index) const

Reimplements: QLayout::itemAt(int index) const.

QLayoutItem *QGridLayout::itemAtPosition(int row, int column) const

Returns the layout item that occupies cell (row, column), or nullptr if the cell is empty.

This function was introduced in Qt 4.4.

See also getItemPosition() and indexOf().

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

Reimplements: QLayout::maximumSize() const.

[override virtual] int QGridLayout::minimumHeightForWidth(int w) const

Reimplements: QLayoutItem::minimumHeightForWidth(int w) const.

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

Reimplements: QLayout::minimumSize() const.

Qt::Corner QGridLayout::originCorner() const

Returns the corner that's used for the grid's origin, i.e. for position (0, 0).

See also setOriginCorner().

int QGridLayout::rowCount() const

Returns the number of rows in this grid.

int QGridLayout::rowMinimumHeight(int row) const

Returns the minimum width set for row row.

See also setRowMinimumHeight().

int QGridLayout::rowStretch(int row) const

Returns the stretch factor for row row.

See also setRowStretch().

void QGridLayout::setColumnMinimumWidth(int column, int minSize)

Sets the minimum width of column column to minSize pixels.

See also columnMinimumWidth() and setRowMinimumHeight().

void QGridLayout::setColumnStretch(int column, int stretch)

Sets the stretch factor of column column to stretch. The first column is number 0.

The stretch factor is relative to the other columns in this grid. Columns with a higher stretch factor take more of the available space.

The default stretch factor is 0. If the stretch factor is 0 and no other column in this table can grow at all, the column may still grow.

An alternative approach is to add spacing using addItem() with a QSpacerItem.

See also columnStretch() and setRowStretch().

[override virtual] void QGridLayout::setGeometry(const QRect &rect)

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

void QGridLayout::setOriginCorner(Qt::Corner corner)

Sets the grid's origin corner, i.e. position (0, 0), to corner.

See also originCorner().

void QGridLayout::setRowMinimumHeight(int row, int minSize)

Sets the minimum height of row row to minSize pixels.

See also rowMinimumHeight() and setColumnMinimumWidth().

void QGridLayout::setRowStretch(int row, int stretch)

Sets the stretch factor of row row to stretch. The first row is number 0.

The stretch factor is relative to the other rows in this grid. Rows with a higher stretch factor take more of the available space.

The default stretch factor is 0. If the stretch factor is 0 and no other row in this table can grow at all, the row may still grow.

See also rowStretch(), setRowMinimumHeight(), and setColumnStretch().

void QGridLayout::setSpacing(int spacing)

This function sets both the vertical and horizontal spacing to spacing.

See also spacing(), setVerticalSpacing(), and setHorizontalSpacing().

[override virtual] QSize QGridLayout::sizeHint() const

Reimplements: QLayoutItem::sizeHint() const.

int QGridLayout::spacing() const

If the vertical spacing is equal to the horizontal spacing, this function returns that value; otherwise it return -1.

See also setSpacing(), verticalSpacing(), and horizontalSpacing().

[override virtual] QLayoutItem *QGridLayout::takeAt(int index)

Reimplements: QLayout::takeAt(int index).