QGridLayout

Synopsis

Functions

• def addItem (item, row, column[, rowSpan=1[, columnSpan=1[, alignment=0]]])
• def addLayout (arg__1, row, column, rowSpan, columnSpan[, alignment=0])
• def addLayout (arg__1, row, column[, alignment=0])
• def addWidget (arg__1, row, column, rowSpan, columnSpan[, alignment=0])
• def addWidget (arg__1, row, column[, alignment=0])
• 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

The PySide.QtGui.QGridLayout class lays out widgets in a grid.

PySide.QtGui.QGridLayout takes the space made available to it (by its parent layout or by the PySide.QtGui.QLayout.parentWidget() ), 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 PySide.QtGui.QGridLayout.setColumnMinimumWidth() and the minimum width of each widget in that column. The stretch factor is set using PySide.QtGui.QGridLayout.setColumnStretch() 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 PySide.QtGui.QGridLayout.addWidget() . It is also possible for a widget to occupy multiple cells using the row and column spanning overloads of PySide.QtGui.QGridLayout.addItem() and PySide.QtGui.QGridLayout.addWidget() . If you do this, PySide.QtGui.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 PySide.QtGui.QLayout.removeWidget() . Calling QWidget.hide() on a widget also effectively removes the widget from the layout until QWidget.show() 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 PySide.QtGui.QLabel , a PySide.QtGui.QLineEdit , and a QListBox . Columns 1 and 3 are placeholders made with PySide.QtGui.QGridLayout.setColumnMinimumWidth() . Row 0 consists of three PySide.QtGui.QLabel objects, row 1 of three PySide.QtGui.QLineEdit 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 PySide.QtGui.QGridLayout.setColumnMinimumWidth() and PySide.QtGui.QGridLayout.setColumnStretch() .

If the PySide.QtGui.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 calling PySide.QtGui.QGridLayout.addLayout() 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 PySide.QtGui.QGridLayout.addWidget() , PySide.QtGui.QGridLayout.addItem() , and PySide.QtGui.QGridLayout.addLayout() .

PySide.QtGui.QGridLayout also includes two margin widths: the contents margin and the PySide.QtGui.QGridLayout.spacing() . The contents margin is the width of the reserved space along each of the PySide.QtGui.QGridLayout ‘s four sides. The PySide.QtGui.QGridLayout.spacing() 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.

See also

PySide.QtGui.QBoxLayout PySide.QtGui.QStackedLayout Layout Management Basic Layouts Example

class PySide.QtGui.QGridLayout

class PySide.QtGui.QGridLayout(parent)

Parameters:parent – PySide.QtGui.QWidget

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 PySide.QtGui.QGridLayout with parent widget, parent . The layout has one row and one column initially, and will expand when new items are inserted.

PySide.QtGui.QGridLayout.addItem(item, row, column[, rowSpan=1[, columnSpan=1[, alignment=0]]])

Parameters:

• item – PySide.QtGui.QLayoutItem
• row – PySide.QtCore.int
• column – PySide.QtCore.int
• rowSpan – PySide.QtCore.int
• columnSpan – PySide.QtCore.int
• alignment – PySide.QtCore.Qt.Alignment

PySide.QtGui.QGridLayout.addLayout(arg__1, row, column, rowSpan, columnSpan[, alignment=0])

Parameters:

• arg__1 – PySide.QtGui.QLayout
• row – PySide.QtCore.int
• column – PySide.QtCore.int
• rowSpan – PySide.QtCore.int
• columnSpan – PySide.QtCore.int
• alignment – PySide.QtCore.Qt.Alignment

PySide.QtGui.QGridLayout.addLayout(arg__1, row, column[, alignment=0])

Parameters:

• arg__1 – PySide.QtGui.QLayout
• row – PySide.QtCore.int
• column – PySide.QtCore.int
• alignment – PySide.QtCore.Qt.Alignment

PySide.QtGui.QGridLayout.addWidget(arg__1, row, column[, alignment=0])

Parameters:

• arg__1 – PySide.QtGui.QWidget
• row – PySide.QtCore.int
• column – PySide.QtCore.int
• alignment – PySide.QtCore.Qt.Alignment

PySide.QtGui.QGridLayout.addWidget(arg__1, row, column, rowSpan, columnSpan[, alignment=0])

Parameters:

• arg__1 – PySide.QtGui.QWidget
• row – PySide.QtCore.int
• column – PySide.QtCore.int
• rowSpan – PySide.QtCore.int
• columnSpan – PySide.QtCore.int
• alignment – PySide.QtCore.Qt.Alignment

PySide.QtGui.QGridLayout.cellRect(row, column)

Parameters:

• row – PySide.QtCore.int
• column – PySide.QtCore.int

Return type:

PySide.QtCore.QRect

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.

Warning

in the current version of Qt this function does not return valid results until PySide.QtGui.QGridLayout.setGeometry() has been called, i.e. after the PySide.QtGui.QLayout.parentWidget() is visible.

PySide.QtGui.QGridLayout.columnCount()

Return type:PySide.QtCore.int

Returns the number of columns in this grid.

PySide.QtGui.QGridLayout.columnMinimumWidth(column)

Parameters:column – PySide.QtCore.int Return type:PySide.QtCore.int

Returns the column spacing for column column .

See also

PySide.QtGui.QGridLayout.setColumnMinimumWidth()

PySide.QtGui.QGridLayout.columnStretch(column)

Parameters:column – PySide.QtCore.int Return type:PySide.QtCore.int

Returns the stretch factor for column column .

See also

PySide.QtGui.QGridLayout.setColumnStretch()

PySide.QtGui.QGridLayout.getItemPosition(idx)

Parameters:idx – PySide.QtCore.int

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

PySide.QtGui.QGridLayout.itemAtPosition() PySide.QtGui.QGridLayout.itemAt()

PySide.QtGui.QGridLayout.horizontalSpacing()

Return type:PySide.QtCore.int

See also

PySide.QtGui.QGridLayout.setHorizontalSpacing()

PySide.QtGui.QGridLayout.itemAtPosition(row, column)

Parameters:

• row – PySide.QtCore.int
• column – PySide.QtCore.int

Return type:

PySide.QtGui.QLayoutItem

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

See also

PySide.QtGui.QGridLayout.getItemPosition() PySide.QtGui.QLayout.indexOf()

PySide.QtGui.QGridLayout.originCorner()

Return type:PySide.QtCore.Qt.Corner

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

See also

PySide.QtGui.QGridLayout.setOriginCorner()

PySide.QtGui.QGridLayout.rowCount()

Return type:PySide.QtCore.int

Returns the number of rows in this grid.

PySide.QtGui.QGridLayout.rowMinimumHeight(row)

Parameters:row – PySide.QtCore.int Return type:PySide.QtCore.int

Returns the minimum width set for row row .

See also

PySide.QtGui.QGridLayout.setRowMinimumHeight()

PySide.QtGui.QGridLayout.rowStretch(row)

Parameters:row – PySide.QtCore.int Return type:PySide.QtCore.int

Returns the stretch factor for row row .

See also

PySide.QtGui.QGridLayout.setRowStretch()

PySide.QtGui.QGridLayout.setColumnMinimumWidth(column, minSize)

Parameters:

• column – PySide.QtCore.int
• minSize – PySide.QtCore.int

Sets the minimum width of column column to minSize pixels.

See also

PySide.QtGui.QGridLayout.columnMinimumWidth() PySide.QtGui.QGridLayout.setRowMinimumHeight()

PySide.QtGui.QGridLayout.setColumnStretch(column, stretch)

Parameters:

• column – PySide.QtCore.int
• stretch – PySide.QtCore.int

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 PySide.QtGui.QGridLayout.addItem() with a PySide.QtGui.QSpacerItem .

See also

PySide.QtGui.QGridLayout.columnStretch() PySide.QtGui.QGridLayout.setRowStretch()

PySide.QtGui.QGridLayout.setDefaultPositioning(n, orient)

Parameters:

• n – PySide.QtCore.int
• orient – PySide.QtCore.Qt.Orientation

PySide.QtGui.QGridLayout.setHorizontalSpacing(spacing)

Parameters:spacing – PySide.QtCore.int

See also

PySide.QtGui.QGridLayout.horizontalSpacing()

PySide.QtGui.QGridLayout.setOriginCorner(arg__1)

Parameters:arg__1 – PySide.QtCore.Qt.Corner

PySide.QtGui.QGridLayout.setRowMinimumHeight(row, minSize)

Parameters:

• row – PySide.QtCore.int
• minSize – PySide.QtCore.int

Sets the minimum height of row row to minSize pixels.

See also

PySide.QtGui.QGridLayout.rowMinimumHeight() PySide.QtGui.QGridLayout.setColumnMinimumWidth()

PySide.QtGui.QGridLayout.setRowStretch(row, stretch)

Parameters:

• row – PySide.QtCore.int
• stretch – PySide.QtCore.int

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

PySide.QtGui.QGridLayout.rowStretch() PySide.QtGui.QGridLayout.setRowMinimumHeight() PySide.QtGui.QGridLayout.setColumnStretch()

PySide.QtGui.QGridLayout.setVerticalSpacing(spacing)

Parameters:spacing – PySide.QtCore.int

See also

PySide.QtGui.QGridLayout.verticalSpacing()

PySide.QtGui.QGridLayout.verticalSpacing()

Return type:PySide.QtCore.int

See also

PySide.QtGui.QGridLayout.setVerticalSpacing()