class QGraphicsGridLayout#

The QGraphicsGridLayout class provides a grid layout for managing widgets in Graphics View. More

Inheritance diagram of PySide6.QtWidgets.QGraphicsGridLayout

Synopsis#

Methods#

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description#

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

The most common way to use QGraphicsGridLayout is to construct an object on the heap, passing a parent widget to the constructor, then add widgets and layouts by calling addItem() . QGraphicsGridLayout automatically computes the dimensions of the grid as you add items.

scene = QGraphicsScene()
textEdit = scene.addWidget(QTextEdit())
pushButton = scene.addWidget(QPushButton())
form = QGraphicsWidget()
scene.addItem(form)
layout = QGraphicsGridLayout(form)
layout.addItem(textEdit, 0, 0)
layout.addItem(pushButton, 0, 1)

Alternatively, if you do not pass a parent widget to the layout’s constructor, you will need to call setLayout() to set this layout as the top-level layout for that widget, the widget will take ownership of the layout.

The layout takes ownership of the items. In some cases when the layout item also inherits from QGraphicsItem (such as QGraphicsWidget ) there will be a ambiguity in ownership because the layout item belongs to two ownership hierarchies. See the documentation of setOwnedByLayout() how to handle this. You can access each item in the layout by calling count() and itemAt() . Calling removeAt() will remove an item from the layout, without destroying it.

Size Hints and Size Policies in QGraphicsGridLayout#

QGraphicsGridLayout respects each item’s size hints and size policies, and when a cell in the grid has more space than the items can fill, each item is arranged according to the layout’s alignment for that item. You can set an alignment for each item by calling setAlignment() , and check the alignment for any item by calling alignment() . You can also set the alignment for an entire row or column by calling setRowAlignment() and setColumnAlignment() respectively. By default, items are aligned to the top left.

__init__([parent=None])#
Parameters:

parentQGraphicsLayoutItem

Constructs a QGraphicsGridLayout instance. parent is passed to QGraphicsLayout ‘s constructor.

addItem(item, row, column[, alignment=Qt.Alignment()])#
Parameters:

Adds item to the grid on row and column. You can specify an optional alignment for item.

addItem(item, row, column, rowSpan, columnSpan[, alignment=Qt.Alignment()])
Parameters:

Adds item to the grid on row and column. You can specify a rowSpan and columnSpan and an optional alignment.

alignment(item)#
Parameters:

itemQGraphicsLayoutItem

Return type:

Combination of AlignmentFlag

Returns the alignment for item.

See also

setAlignment()

columnAlignment(column)#
Parameters:

column – int

Return type:

Combination of AlignmentFlag

Returns the alignment for column.

columnCount()#
Return type:

int

Returns the number of columns in the grid layout. This is always one more than the index of the last column that is occupied by a layout item (empty columns are counted except for those at the end).

columnMaximumWidth(column)#
Parameters:

column – int

Return type:

float

Returns the maximum width for column.

columnMinimumWidth(column)#
Parameters:

column – int

Return type:

float

Returns the minimum width for column.

columnPreferredWidth(column)#
Parameters:

column – int

Return type:

float

Returns the preferred width for column.

columnSpacing(column)#
Parameters:

column – int

Return type:

float

Returns the column spacing for column.

columnStretchFactor(column)#
Parameters:

column – int

Return type:

int

Returns the stretch factor for column.

horizontalSpacing()#
Return type:

float

Returns the default horizontal spacing for the grid layout.

itemAt(row, column)#
Parameters:
  • row – int

  • column – int

Return type:

QGraphicsLayoutItem

Returns a pointer to the layout item at (row, column).

removeItem(item)#
Parameters:

itemQGraphicsLayoutItem

Removes the layout item item without destroying it. Ownership of the item is transferred to the caller.

See also

addItem()

rowAlignment(row)#
Parameters:

row – int

Return type:

Combination of AlignmentFlag

Returns the alignment of row.

rowCount()#
Return type:

int

Returns the number of rows in the grid layout. This is always one more than the index of the last row that is occupied by a layout item (empty rows are counted except for those at the end).

rowMaximumHeight(row)#
Parameters:

row – int

Return type:

float

Returns the maximum height for row, row.

rowMinimumHeight(row)#
Parameters:

row – int

Return type:

float

Returns the minimum height for row, row.

rowPreferredHeight(row)#
Parameters:

row – int

Return type:

float

Returns the preferred height for row, row.

rowSpacing(row)#
Parameters:

row – int

Return type:

float

Returns the row spacing for row.

See also

setRowSpacing()

rowStretchFactor(row)#
Parameters:

row – int

Return type:

int

Returns the stretch factor for row.

setAlignment(item, alignment)#
Parameters:

Sets the alignment for item to alignment.

See also

alignment()

setColumnAlignment(column, alignment)#
Parameters:

Sets the alignment for column to alignment.

setColumnFixedWidth(column, width)#
Parameters:
  • column – int

  • width – float

Sets the fixed width of column to width.

setColumnMaximumWidth(column, width)#
Parameters:
  • column – int

  • width – float

Sets the maximum width of column to width.

setColumnMinimumWidth(column, width)#
Parameters:
  • column – int

  • width – float

Sets the minimum width for column to width.

setColumnPreferredWidth(column, width)#
Parameters:
  • column – int

  • width – float

Sets the preferred width for column to width.

setColumnSpacing(column, spacing)#
Parameters:
  • column – int

  • spacing – float

Sets the spacing for column to spacing.

See also

columnSpacing()

setColumnStretchFactor(column, stretch)#
Parameters:
  • column – int

  • stretch – int

Sets the stretch factor for column to stretch.

setHorizontalSpacing(spacing)#
Parameters:

spacing – float

Sets the default horizontal spacing for the grid layout to spacing.

setRowAlignment(row, alignment)#
Parameters:

Sets the alignment of row to alignment.

See also

rowAlignment()

setRowFixedHeight(row, height)#
Parameters:
  • row – int

  • height – float

Sets the fixed height for row, row, to height.

setRowMaximumHeight(row, height)#
Parameters:
  • row – int

  • height – float

Sets the maximum height for row, row, to height.

setRowMinimumHeight(row, height)#
Parameters:
  • row – int

  • height – float

Sets the minimum height for row, row, to height.

setRowPreferredHeight(row, height)#
Parameters:
  • row – int

  • height – float

Sets the preferred height for row, row, to height.

setRowSpacing(row, spacing)#
Parameters:
  • row – int

  • spacing – float

Sets the spacing for row to spacing.

See also

rowSpacing()

setRowStretchFactor(row, stretch)#
Parameters:
  • row – int

  • stretch – int

Sets the stretch factor for row to stretch.

setSpacing(spacing)#
Parameters:

spacing – float

Sets the grid layout’s default spacing, both vertical and horizontal, to spacing.

setVerticalSpacing(spacing)#
Parameters:

spacing – float

Sets the default vertical spacing for the grid layout to spacing.

verticalSpacing()#
Return type:

float

Returns the default vertical spacing for the grid layout.