QGridLayout¶
The
QGridLayout
class lays out widgets in a grid. More…
Synopsis¶
Functions¶
def
addItem
(item, row, column[, rowSpan=1[, columnSpan=1[, alignment=Qt.Alignment()]]])def
addLayout
(arg__1, row, column, rowSpan, columnSpan[, alignment=Qt.Alignment()])def
addLayout
(arg__1, row, column[, alignment=Qt.Alignment()])def
addWidget
(arg__1, row, column, rowSpan, columnSpan[, alignment=Qt.Alignment()])def
addWidget
(arg__1, row, column[, alignment=Qt.Alignment()])def
cellRect
(row, column)def
columnCount
()def
columnMinimumWidth
(column)def
columnStretch
(column)def
getItemPosition
(idx)def
horizontalSpacing
()def
itemAtPosition
(row, column)def
originCorner
()def
rowCount
()def
rowMinimumHeight
(row)def
rowStretch
(row)def
setColumnMinimumWidth
(column, minSize)def
setColumnStretch
(column, stretch)def
setDefaultPositioning
(n, orient)def
setHorizontalSpacing
(spacing)def
setOriginCorner
(arg__1)def
setRowMinimumHeight
(row, minSize)def
setRowStretch
(row, stretch)def
setVerticalSpacing
(spacing)def
verticalSpacing
()
Detailed Description¶
QGridLayout
takes the space made available to it (by its parent layout or by theparentWidget()
), divides it up into rows and columns, and puts each widget it manages into the correct cell.Columns and rows behave identically; we will discuss columns, but there are equivalent functions for rows.
Each column has a minimum width and a stretch factor. The minimum width is the greatest of that set using
setColumnMinimumWidth()
and the minimum width of each widget in that column. The stretch factor is set usingsetColumnStretch()
and determines how much of the available space the column will get over and above its necessary minimum.Normally, each managed widget or layout is put into a cell of its own using
addWidget()
. It is also possible for a widget to occupy multiple cells using the row and column spanning overloads ofaddItem()
andaddWidget()
. If you do this,QGridLayout
will guess how to distribute the size over the columns/rows (based on the stretch factors).To remove a widget from a layout, call
removeWidget()
. Callinghide()
on a widget also effectively removes the widget from the layout untilshow()
is called.This illustration shows a fragment of a dialog with a five-column, three-row grid (the grid is shown overlaid in magenta):
Columns 0, 2 and 4 in this dialog fragment are made up of a
QLabel
, aQLineEdit
, and a QListBox. Columns 1 and 3 are placeholders made withsetColumnMinimumWidth()
. Row 0 consists of threeQLabel
objects, row 1 of threeQLineEdit
objects and row 2 of three QListBox objects. We used placeholder columns (1 and 3) to get the right amount of space between the columns.Note that the columns and rows are not equally wide or tall. If you want two columns to have the same width, you must set their minimum widths and stretch factors to be the same yourself. You do this using
setColumnMinimumWidth()
andsetColumnStretch()
.If the
QGridLayout
is not the top-level layout (i.e. does not manage all of the widget’s area and children), you must add it to its parent layout when you create it, but before you do anything with it. The normal way to add a layout is by callingaddLayout()
on the parent layout.Once you have added your layout you can start putting widgets and other layouts into the cells of your grid layout using
addWidget()
,addItem()
, andaddLayout()
.
QGridLayout
also includes two margin widths: thecontents margin
and thespacing()
. The contents margin is the width of the reserved space along each of theQGridLayout
‘s four sides. Thespacing()
is the width of the automatically allocated spacing between neighboring boxes.The default contents margin values are provided by the
style
. The default value 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.
- class PySide2.QtWidgets.QGridLayout¶
PySide2.QtWidgets.QGridLayout(parent)
- param parent:
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.
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 bylayout()
.See also
- PySide2.QtWidgets.QGridLayout.addItem(item, row, column[, rowSpan=1[, columnSpan=1[, alignment=Qt.Alignment()]]])¶
- Parameters:
row – int
column – int
rowSpan – int
columnSpan – int
alignment –
Alignment
Adds
item
at positionrow
,column
, spanningrowSpan
rows andcolumnSpan
columns, and aligns it according toalignment
. IfrowSpan
and/orcolumnSpan
is -1, then the item will extend to the bottom and/or right edge, respectively. The layout takes ownership of theitem
.Warning
Do not use this function to add child layouts or child widget items. Use
addLayout()
oraddWidget()
instead.
- PySide2.QtWidgets.QGridLayout.addLayout(arg__1, row, column[, alignment=Qt.Alignment()])¶
- Parameters:
arg__1 –
PySide2.QtWidgets.QLayout
row – int
column – int
alignment –
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.
- PySide2.QtWidgets.QGridLayout.addLayout(arg__1, row, column, rowSpan, columnSpan[, alignment=Qt.Alignment()])
- Parameters:
arg__1 –
PySide2.QtWidgets.QLayout
row – int
column – int
rowSpan – int
columnSpan – int
alignment –
Alignment
This is an overloaded function.
This version adds the layout
layout
to the cell grid, spanning multiple rows/columns. The cell will start atrow
,column
spanningrowSpan
rows andcolumnSpan
columns.If
rowSpan
and/orcolumnSpan
is -1, then the layout will extend to the bottom and/or right edge, respectively.
- PySide2.QtWidgets.QGridLayout.addWidget(arg__1, row, column[, alignment=Qt.Alignment()])¶
- Parameters:
arg__1 –
PySide2.QtWidgets.QWidget
row – int
column – int
alignment –
Alignment
Adds the given
widget
to the cell grid atrow
,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.
- PySide2.QtWidgets.QGridLayout.addWidget(arg__1, row, column, rowSpan, columnSpan[, alignment=Qt.Alignment()])
- Parameters:
arg__1 –
PySide2.QtWidgets.QWidget
row – int
column – int
rowSpan – int
columnSpan – int
alignment –
Alignment
This is an overloaded function.
This version adds the given
widget
to the cell grid, spanning multiple rows/columns. The cell will start atfromRow
,fromColumn
spanningrowSpan
rows andcolumnSpan
columns. Thewidget
will have the givenalignment
.If
rowSpan
and/orcolumnSpan
is -1, then the widget will extend to the bottom and/or right edge, respectively.
- PySide2.QtWidgets.QGridLayout.cellRect(row, column)¶
- Parameters:
row – int
column – int
- Return type:
Returns the geometry of the cell with row
row
and columncolumn
in the grid. Returns an invalid rectangle ifrow
orcolumn
is outside the grid.Warning
in the current version of Qt this function does not return valid results until
setGeometry()
has been called, i.e. after theparentWidget()
is visible.
- PySide2.QtWidgets.QGridLayout.columnCount()¶
- Return type:
int
Returns the number of columns in this grid.
- PySide2.QtWidgets.QGridLayout.columnMinimumWidth(column)¶
- Parameters:
column – int
- Return type:
int
Returns the column spacing for column
column
.See also
- PySide2.QtWidgets.QGridLayout.columnStretch(column)¶
- Parameters:
column – int
- Return type:
int
Returns the stretch factor for column
column
.See also
- PySide2.QtWidgets.QGridLayout.getItemPosition(idx)¶
- Parameters:
idx – int
Returns the position information of the item with the given
index
.The variables passed as
row
andcolumn
are updated with the position of the item in the layout, and therowSpan
andcolumnSpan
variables are updated with the vertical and horizontal spans of the item.See also
itemAtPosition()
itemAt()
- PySide2.QtWidgets.QGridLayout.horizontalSpacing()¶
- Return type:
int
See also
- PySide2.QtWidgets.QGridLayout.itemAtPosition(row, column)¶
- Parameters:
row – int
column – int
- Return type:
Returns the layout item that occupies cell (
row
,column
), orNone
if the cell is empty.See also
- PySide2.QtWidgets.QGridLayout.originCorner()¶
- Return type:
Returns the corner that’s used for the grid’s origin, i.e. for position (0, 0).
See also
- PySide2.QtWidgets.QGridLayout.rowCount()¶
- Return type:
int
Returns the number of rows in this grid.
- PySide2.QtWidgets.QGridLayout.rowMinimumHeight(row)¶
- Parameters:
row – int
- Return type:
int
Returns the minimum width set for row
row
.See also
- PySide2.QtWidgets.QGridLayout.rowStretch(row)¶
- Parameters:
row – int
- Return type:
int
Returns the stretch factor for row
row
.See also
- PySide2.QtWidgets.QGridLayout.setColumnMinimumWidth(column, minSize)¶
- Parameters:
column – int
minSize – int
Sets the minimum width of column
column
tominSize
pixels.
- PySide2.QtWidgets.QGridLayout.setColumnStretch(column, stretch)¶
- Parameters:
column – int
stretch – int
Sets the stretch factor of column
column
tostretch
. 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 aQSpacerItem
.See also
- PySide2.QtWidgets.QGridLayout.setDefaultPositioning(n, orient)¶
- Parameters:
n – int
orient –
Orientation
Sets the positioning mode used by
addItem()
. Iforient
isHorizontal
, this layout is expanded ton
columns, and items will be added columns-first. Otherwise it is expanded ton
rows and items will be added rows-first.
- PySide2.QtWidgets.QGridLayout.setHorizontalSpacing(spacing)¶
- Parameters:
spacing – int
See also
- PySide2.QtWidgets.QGridLayout.setOriginCorner(arg__1)¶
- Parameters:
arg__1 –
Corner
Sets the grid’s origin corner, i.e. position (0, 0), to
corner
.See also
- PySide2.QtWidgets.QGridLayout.setRowMinimumHeight(row, minSize)¶
- Parameters:
row – int
minSize – int
Sets the minimum height of row
row
tominSize
pixels.
- PySide2.QtWidgets.QGridLayout.setRowStretch(row, stretch)¶
- Parameters:
row – int
stretch – int
Sets the stretch factor of row
row
tostretch
. 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.
- PySide2.QtWidgets.QGridLayout.setVerticalSpacing(spacing)¶
- Parameters:
spacing – int
See also
- PySide2.QtWidgets.QGridLayout.verticalSpacing()¶
- Return type:
int
See also
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.