PySide6.QtWidgets.QFormLayout¶

class QFormLayout¶

The QFormLayout class manages forms of input widgets and their associated labels.

Details

Warning

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

QFormLayout is a convenience layout class that lays out its children in a two-column form. The left column consists of labels and the right column consists of “field” widgets (line editors, spin boxes, etc.).

Traditionally, such two-column form layouts were achieved using QGridLayout . QFormLayout is a higher-level alternative that provides the following advantages:

Adherence to the different platform’s look and feel guidelines.

For example, the macOS Aqua and KDE guidelines specify that the labels should be right-aligned, whereas Windows and GNOME applications normally use left-alignment.

Support for wrapping long rows.

For devices with small displays, QFormLayout can be set to wrap long rows , or even to wrap all rows .
Convenient API for creating label–field pairs.

The addRow() overload that takes a QString and a QWidget * creates a QLabel behind the scenes and automatically set up its buddy. We can then write code like this:
formLayout = QFormLayout(self)
formLayout.addRow(tr("Name:"), nameLineEdit)
formLayout.addRow(tr("Email:"), emailLineEdit)
formLayout.addRow(tr("Age:"), ageSpinBox)
Compare this with the following code, written using QGridLayout :
gridLayout = QGridLayout(self)
nameLabel = QLabel(tr("Name:"))
nameLabel.setBuddy(nameLineEdit)
emailLabel = QLabel(tr("Name:"))
emailLabel.setBuddy(emailLineEdit)
ageLabel = QLabel(tr("Name:"))
ageLabel.setBuddy(ageSpinBox)
gridLayout.addWidget(nameLabel, 0, 0)
gridLayout.addWidget(nameLineEdit, 0, 1)
gridLayout.addWidget(emailLabel, 1, 0)
gridLayout.addWidget(emailLineEdit, 1, 1)
gridLayout.addWidget(ageLabel, 2, 0)
gridLayout.addWidget(ageSpinBox, 2, 1)

The table below shows the default appearance in different styles.

QCommonStyle derived styles (except QPlastiqueStyle)

QMacStyle

QPlastiqueStyle

Qt Extended styles

Traditional style used for Windows, GNOME, and earlier versions of KDE. Labels are left aligned, and expanding fields grow to fill the available space. (This normally corresponds to what we would get using a two-column QGridLayout .)

Style based on the macOS Aqua guidelines. Labels are right-aligned, the fields don’t grow beyond their size hint, and the form is horizontally centered.

Recommended style for KDE applications. Similar to MacStyle, except that the form is left-aligned and all fields grow to fill the available space.

Default style for Qt Extended styles. Labels are right-aligned, expanding fields grow to fill the available space, and row wrapping is enabled for long lines.

`QCommonStyle` derived styles (except QPlastiqueStyle)	QMacStyle	QPlastiqueStyle	Qt Extended styles

Traditional style used for Windows, GNOME, and earlier versions of KDE. Labels are left aligned, and expanding fields grow to fill the available space. (This normally corresponds to what we would get using a two-column `QGridLayout` .)	Style based on the macOS Aqua guidelines. Labels are right-aligned, the fields don’t grow beyond their size hint, and the form is horizontally centered.	Recommended style for KDE applications. Similar to MacStyle, except that the form is left-aligned and all fields grow to fill the available space.	Default style for Qt Extended styles. Labels are right-aligned, expanding fields grow to fill the available space, and row wrapping is enabled for long lines.

The form styles can be also be overridden individually by calling setLabelAlignment() , setFormAlignment() , setFieldGrowthPolicy() , and setRowWrapPolicy() . For example, to simulate the form layout appearance of QMacStyle on all platforms, but with left-aligned labels, you could write:

formLayout.setRowWrapPolicy(QFormLayout.DontWrapRows)
formLayout.setFieldGrowthPolicy(QFormLayout.FieldsStayAtSizeHint)
formLayout.setFormAlignment(Qt.AlignmentFlag.AlignHCenter | Qt.AlignmentFlag.AlignTop)
formLayout.setLabelAlignment(Qt.AlignmentFlag.AlignLeft)

Synopsis¶

Properties¶

fieldGrowthPolicyᅟ - The way in which the form’s fields grow
formAlignmentᅟ - The alignment of the form layout’s contents within the layout’s geometry
horizontalSpacingᅟ - The spacing between widgets that are laid out side by side
labelAlignmentᅟ - The horizontal alignment of the labels
rowWrapPolicyᅟ - The way in which the form’s rows wrap
verticalSpacingᅟ - The spacing between widgets that are laid out vertically

Methods¶

def __init__()
def addRow()
def fieldGrowthPolicy()
def formAlignment()
def getItemPosition()
def getLayoutPosition()
def getWidgetPosition()
def horizontalSpacing()
def insertRow()
def isRowVisible()
def itemAt()
def labelAlignment()
def labelForField()
def removeRow()
def rowCount()
def rowWrapPolicy()
def setFieldGrowthPolicy()
def setFormAlignment()
def setHorizontalSpacing()
def setItem()
def setLabelAlignment()
def setLayout()
def setRowVisible()
def setRowWrapPolicy()
def setVerticalSpacing()
def setWidget()
def takeRow()
def verticalSpacing()

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

class FieldGrowthPolicy¶

This enum specifies the different policies that can be used to control the way in which the form’s fields grow.

Constant

Description

QFormLayout.FieldsStayAtSizeHint

The fields never grow beyond their effective size hint . This is the default for QMacStyle.

QFormLayout.ExpandingFieldsGrow

Fields with an horizontal size policy of Expanding or MinimumExpanding will grow to fill the available space. The other fields will not grow beyond their effective size hint. This is the default policy for Plastique.

QFormLayout.AllNonFixedFieldsGrow

All fields with a size policy that allows them to grow will grow to fill the available space. This is the default policy for most styles.

See also

fieldGrowthPolicy

Constant	Description
QFormLayout.FieldsStayAtSizeHint	The fields never grow beyond their `effective size hint` . This is the default for QMacStyle.
QFormLayout.ExpandingFieldsGrow	Fields with an horizontal `size policy` of `Expanding` or `MinimumExpanding` will grow to fill the available space. The other fields will not grow beyond their effective size hint. This is the default policy for Plastique.
QFormLayout.AllNonFixedFieldsGrow	All fields with a size policy that allows them to grow will grow to fill the available space. This is the default policy for most styles.

class RowWrapPolicy¶

This enum specifies the different policies that can be used to control the way in which the form’s rows wrap.

Constant

Description

QFormLayout.DontWrapRows

Fields are always laid out next to their label. This is the default policy for all styles except Qt Extended styles.

QFormLayout.WrapLongRows

Labels are given enough horizontal space to fit the widest label, and the rest of the space is given to the fields. If the minimum size of a field pair is wider than the available space, the field is wrapped to the next line. This is the default policy for Qt Extended styles.

QFormLayout.WrapAllRows

Fields are always laid out below their label.

See also

rowWrapPolicy

Constant	Description
QFormLayout.DontWrapRows	Fields are always laid out next to their label. This is the default policy for all styles except Qt Extended styles.
QFormLayout.WrapLongRows	Labels are given enough horizontal space to fit the widest label, and the rest of the space is given to the fields. If the minimum size of a field pair is wider than the available space, the field is wrapped to the next line. This is the default policy for Qt Extended styles.
QFormLayout.WrapAllRows	Fields are always laid out below their label.

class ItemRole¶

This enum specifies the types of widgets (or other layout items) that may appear in a row.

Constant

Description

QFormLayout.LabelRole

A label widget.

QFormLayout.FieldRole

A field widget.

QFormLayout.SpanningRole

A widget that spans label and field columns.

See also

itemAt() getItemPosition()

Constant	Description
QFormLayout.LabelRole	A label widget.
QFormLayout.FieldRole	A field widget.
QFormLayout.SpanningRole	A widget that spans label and field columns.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property fieldGrowthPolicyᅟ: QFormLayout.FieldGrowthPolicy¶

This property holds the way in which the form’s fields grow.

The default value depends on the widget or application style. For QMacStyle, the default is FieldsStayAtSizeHint ; for QCommonStyle derived styles (like Plastique and Windows), the default is ExpandingFieldsGrow ; for Qt Extended styles, the default is AllNonFixedFieldsGrow .

If none of the fields can grow and the form is resized, extra space is distributed according to the current form alignment .

See also

formAlignment rowWrapPolicy

Access functions:

fieldGrowthPolicy()
setFieldGrowthPolicy()

property formAlignmentᅟ: Combination of Qt.AlignmentFlag¶

This property holds the alignment of the form layout’s contents within the layout’s geometry.

The default value depends on the widget or application style. For QMacStyle, the default is Qt::AlignHCenter | Qt::AlignTop; for the other styles, the default is Qt::AlignLeft | Qt::AlignTop.

See also

labelAlignment rowWrapPolicy

Access functions:

formAlignment()
setFormAlignment()

property horizontalSpacingᅟ: int¶

This property holds the spacing between widgets that are laid out side by side.

By default, if no value is explicitly set, the layout’s horizontal spacing is inherited from the parent layout, or from the style settings for the parent widget.

See also

verticalSpacing pixelMetric() PM_LayoutHorizontalSpacing

Access functions:

horizontalSpacing()
setHorizontalSpacing()

property labelAlignmentᅟ: Combination of Qt.AlignmentFlag¶

This property holds the horizontal alignment of the labels.

The default value depends on the widget or application style. For QCommonStyle derived styles, except for QPlastiqueStyle, the default is Qt::AlignLeft; for the other styles, the default is Qt::AlignRight.

See also

formAlignment

Access functions:

labelAlignment()
setLabelAlignment()

property rowWrapPolicyᅟ: QFormLayout.RowWrapPolicy¶

This property holds the way in which the form’s rows wrap.

The default value depends on the widget or application style. For Qt Extended styles, the default is WrapLongRows ; for the other styles, the default is DontWrapRows .

If you want to display each label above its associated field (instead of next to it), set this property to WrapAllRows .

See also

fieldGrowthPolicy

Access functions:

rowWrapPolicy()
setRowWrapPolicy()

property verticalSpacingᅟ: int¶

This property holds the spacing between widgets that are laid out vertically.

By default, if no value is explicitly set, the layout’s vertical spacing is inherited from the parent layout, or from the style settings for the parent widget.

See also

horizontalSpacing pixelMetric() PM_LayoutHorizontalSpacing

Access functions:

verticalSpacing()
setVerticalSpacing()

__init__([parent=None])¶

Parameters:: parent – QWidget

Constructs a new form layout with the given parent widget.

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

See also

setLayout()

addRow(layout)¶

Parameters:: layout – QLayout

Adds the specified layout at the end of this form layout. The layout spans both columns.

addRow(widget)

Parameters:: widget – QWidget

Adds the specified widget at the end of this form layout. The widget spans both columns.

addRow(label, field)

Parameters:

label – QWidget
field – QLayout

addRow(label, field)

Parameters:

label – QWidget
field – QWidget

Adds a new row to the bottom of this form layout, with the given label and field.

See also

insertRow()

addRow(labelText, field)

Parameters:

labelText – str
field – QLayout

This overload automatically creates a QLabel behind the scenes with labelText as its text.

addRow(labelText, field)

Parameters:

labelText – str
field – QWidget

This overload automatically creates a QLabel behind the scenes with labelText as its text. The field is set as the new QLabel ‘s buddy .

fieldGrowthPolicy()¶

Return type:: FieldGrowthPolicy

See also

setFieldGrowthPolicy()

Getter of property fieldGrowthPolicyᅟ .

formAlignment()¶

Return type:: Combination of AlignmentFlag

See also

setFormAlignment()

Getter of property formAlignmentᅟ .

getItemPosition(index)¶

Parameters:: index – int
Return type:: PyObject

Retrieves the row and role (column) of the item at the specified index. If index is out of bounds, *``rowPtr`` is set to -1; otherwise the row is stored in *``rowPtr`` and the role is stored in *``rolePtr``.

See also

itemAt() count() getLayoutPosition() getWidgetPosition()

getLayoutPosition(layout)¶

Parameters:: layout – QLayout
Return type:: PyTuple

Retrieves the row and role (column) of the specified child layout. If layout is not in the form layout, *``rowPtr`` is set to -1; otherwise the row is stored in *``rowPtr`` and the role is stored in *``rolePtr``.

getWidgetPosition(widget)¶

Parameters:: widget – QWidget
Return type:: PyObject

Retrieves the row and role (column) of the specified widget in the layout. If widget is not in the layout, *``rowPtr`` is set to -1; otherwise the row is stored in *``rowPtr`` and the role is stored in *``rolePtr``.

See also

getItemPosition() itemAt()

horizontalSpacing()¶

Return type:: int

See also

setHorizontalSpacing()

Getter of property horizontalSpacingᅟ .

insertRow(row, layout)¶

Parameters:

row – int
layout – QLayout

Inserts the specified layout at position row in this form layout. The layout spans both columns. If row is out of bounds, the widget is added at the end.

insertRow(row, widget)

Parameters:

row – int
widget – QWidget

Inserts the specified widget at position row in this form layout. The widget spans both columns. If row is out of bounds, the widget is added at the end.

insertRow(row, label, field)

Parameters:

row – int
label – QWidget
field – QLayout

insertRow(row, label, field)

Parameters:

row – int
label – QWidget
field – QWidget

Inserts a new row at position row in this form layout, with the given label and field. If row is out of bounds, the new row is added at the end.

See also

addRow()

insertRow(row, labelText, field)

Parameters:

row – int
labelText – str
field – QLayout

This overload automatically creates a QLabel behind the scenes with labelText as its text.

insertRow(row, labelText, field)

Parameters:

row – int
labelText – str
field – QWidget

This overload automatically creates a QLabel behind the scenes with labelText as its text. The field is set as the new QLabel ‘s buddy .

isRowVisible(layout)¶

Parameters:: layout – QLayout
Return type:: bool

Returns true if some items in the row corresponding to layout are visible, otherwise returns false.

isRowVisible(widget)

Parameters:: widget – QWidget
Return type:: bool

Returns true if some items in the row corresponding to widget are visible, otherwise returns false.

isRowVisible(row)

Parameters:: row – int
Return type:: bool

Returns true if some items in the row row are visible, otherwise returns false.

itemAt(row, role)¶

Parameters:

row – int
role – ItemRole

Return type:

QLayoutItem

Returns the layout item in the given row with the specified role (column). Returns None if there is no such item.

See also

itemAt() setItem()

labelAlignment()¶

Return type:: Combination of AlignmentFlag

See also

setLabelAlignment()

Getter of property labelAlignmentᅟ .

labelForField(field)¶

Parameters:: field – QLayout
Return type:: QWidget

labelForField(field)

Parameters:: field – QWidget
Return type:: QWidget

Returns the label associated with the given field.

See also

itemAt()

removeRow(layout)¶

Parameters:: layout – QLayout

Warning

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

Deletes the row corresponding to layout from this form layout.

After this call, rowCount() is decremented by one. All widgets and nested layouts that occupied this row are deleted. That includes both the field widget(s) and the label, if any. All following rows are shifted up one row and the freed vertical space is redistributed amongst the remaining rows.

You can use this function to undo a previous addRow() or insertRow() :

flay = ...
vbl = QVBoxLayout()
flay.insertRow(2, "User:", vbl)
# later:
flay.removeRow(layout) # vbl == None at this point

If you want to remove the row from the form layout without deleting the inserted layout, use takeRow() instead.

See also

takeRow()

removeRow(widget)

Parameters:: widget – QWidget

Warning

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

Deletes the row corresponding to widget from this form layout.

You can use this function to undo a previous addRow() or insertRow() :

flay = ...
le = QLineEdit()
flay.insertRow(2, "User:", le)
# later:
flay.removeRow(le) # le == None at this point

If you want to remove the row from the layout without deleting the widgets, use takeRow() instead.

See also

takeRow()

removeRow(row)

Parameters:: row – int

Warning

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

Deletes row row from this form layout.

row must be non-negative and less than rowCount() .

You can use this function to undo a previous addRow() or insertRow() :

flay = ...
le = QLineEdit()
flay.insertRow(2, "User:", le)
# later:
flay.removeRow(2) # le == None at this point

If you want to remove the row from the layout without deleting the widgets, use takeRow() instead.

See also

takeRow()

rowCount()¶

Return type:: int

Returns the number of rows in the form.

See also

count()

rowWrapPolicy()¶

Return type:: RowWrapPolicy

See also

setRowWrapPolicy()

Getter of property rowWrapPolicyᅟ .

setFieldGrowthPolicy(policy)¶

Parameters:: policy – FieldGrowthPolicy

See also

fieldGrowthPolicy()

Setter of property fieldGrowthPolicyᅟ .

setFormAlignment(alignment)¶

Parameters:: alignment – Combination of AlignmentFlag

See also

formAlignment()

Setter of property formAlignmentᅟ .

setHorizontalSpacing(spacing)¶

Parameters:: spacing – int

See also

horizontalSpacing()

Setter of property horizontalSpacingᅟ .

setItem(row, role, item)¶

Parameters:

row – int
role – ItemRole
item – QLayoutItem

Sets the item in the given row for the given role to item, extending the layout with empty rows if necessary.

If the cell is already occupied, the item is not inserted and an error message is sent to the console. The item spans both columns.

Warning

Do not use this function to add child layouts or child widget items. Use setLayout() or setWidget() instead.

See also

setLayout()

setLabelAlignment(alignment)¶

Parameters:: alignment – Combination of AlignmentFlag

See also

labelAlignment()

Setter of property labelAlignmentᅟ .

setLayout(row, role, layout)¶

Parameters:

row – int
role – ItemRole
layout – QLayout

Sets the sub-layout in the given row for the given role to layout, extending the form layout with empty rows if necessary.

If the cell is already occupied, the layout is not inserted and an error message is sent to the console.

Note

For most applications, addRow() or insertRow() should be used instead of setLayout().

See also

setWidget()

setRowVisible(layout, on)¶

Parameters:

layout – QLayout
on – bool

Shows the row corresponding to layout if on is true, otherwise hides the row.

See also

removeRow() takeRow()

setRowVisible(widget, on)

Parameters:

widget – QWidget
on – bool

Shows the row corresponding to widget if on is true, otherwise hides the row.

See also

removeRow() takeRow()

setRowVisible(row, on)

Parameters:

row – int
on – bool

Shows the row row if on is true, otherwise hides the row.

row must be non-negative and less than rowCount() .

See also

isRowVisible() removeRow() takeRow()

setRowWrapPolicy(policy)¶

Parameters:: policy – RowWrapPolicy

See also

rowWrapPolicy()

Setter of property rowWrapPolicyᅟ .

setVerticalSpacing(spacing)¶

Parameters:: spacing – int

See also

verticalSpacing()

Setter of property verticalSpacingᅟ .

setWidget(row, role, widget)¶

Parameters:

row – int
role – ItemRole
widget – QWidget

Sets the widget in the given row for the given role to widget, extending the layout with empty rows if necessary.

If the cell is already occupied, the widget is not inserted and an error message is sent to the console.

Note

For most applications, addRow() or insertRow() should be used instead of setWidget().

See also

setLayout()

takeRow(layout)¶

Parameters:: layout – QLayout
Return type:: TakeRowResult

Warning

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

Removes the specified layout from this form layout.

Note

This function doesn’t delete anything.

After this call, rowCount() is decremented by one. All following rows are shifted up one row and the freed vertical space is redistributed amongst the remaining rows.

flay = ...
vbl = QVBoxLayout()
flay.insertRow(2, "User:", vbl)
# later:
QFormLayout.TakeRowResult result = flay.takeRow(widget)

If you want to remove the row from the form layout and delete the inserted layout, use removeRow() instead.

Returns A structure containing both the widget and corresponding label layout items

See also

removeRow()

takeRow(widget)

Parameters:: widget – QWidget
Return type:: TakeRowResult

Warning

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

Removes the specified widget from this form layout.

Note

This function doesn’t delete anything.

After this call, rowCount() is decremented by one. All following rows are shifted up one row and the freed vertical space is redistributed amongst the remaining rows.

flay = ...
le = QLineEdit()
flay.insertRow(2, "User:", le)
# later:
QFormLayout.TakeRowResult result = flay.takeRow(widget)

If you want to remove the row from the layout and delete the widgets, use removeRow() instead.

Returns A structure containing both the widget and corresponding label layout items

See also

removeRow()

takeRow(row)

Parameters:: row – int
Return type:: TakeRowResult

Warning

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

Removes the specified row from this form layout.

row must be non-negative and less than rowCount() .

Note

This function doesn’t delete anything.

After this call, rowCount() is decremented by one. All following rows are shifted up one row and the freed vertical space is redistributed amongst the remaining rows.

You can use this function to undo a previous addRow() or insertRow() :

flay = ...
le = QLineEdit()
flay.insertRow(2, "User:", le)
# later:
QFormLayout.TakeRowResult result = flay.takeRow(2)

If you want to remove the row from the layout and delete the widgets, use removeRow() instead.

Returns A structure containing both the widget and corresponding label layout items

See also

removeRow()

verticalSpacing()¶

Return type:: int

See also

setVerticalSpacing()

Getter of property verticalSpacingᅟ .

class TakeRowResult¶

Contains the result of a takeRow() call.

Details

See also

takeRow()

Note

PySide6.QtWidgets.QFormLayout.TakeRowResult.labelItem¶

PySide6.QtWidgets.QFormLayout.TakeRowResult.fieldItem¶