Struct qt_widgets::QFormLayout

#[repr(C)]pub struct QFormLayout { /* fields omitted */ }

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

C++ class: QFormLayout.

C++ documentation:

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

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:

  QFormLayout *formLayout = new QFormLayout;
  formLayout->addRow(tr("&Name:"), nameLineEdit);
  formLayout->addRow(tr("&Email:"), emailLineEdit);
  formLayout->addRow(tr("&Age:"), ageSpinBox);
  setLayout(formLayout);
  

  Compare this with the following code, written using QGridLayout:

  nameLabel = new QLabel(tr("&Name:"));
  nameLabel->setBuddy(nameLineEdit);
  emailLabel = new QLabel(tr("&Name:"));
  emailLabel->setBuddy(emailLineEdit);
  ageLabel = new QLabel(tr("&Name:"));
  ageLabel->setBuddy(ageSpinBox);
  QGridLayout *gridLayout = new QGridLayout;
  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);
  setLayout(gridLayout);
  

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.

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::AlignHCenter | Qt::AlignTop);
formLayout->setLabelAlignment(Qt::AlignLeft);

Methods

impl QFormLayout

pub unsafe fn add_item(&self, item: impl CastInto<Ptr<QLayoutItem>>)

Reimplemented from QLayout::addItem().

Calls C++ function: virtual void QFormLayout::addItem(QLayoutItem* item).

C++ documentation:

Reimplemented from QLayout::addItem().

pub unsafe fn add_row_2_q_widget(
    &self,
    label: impl CastInto<Ptr<QWidget>>,
    field: impl CastInto<Ptr<QWidget>>
)

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

Calls C++ function: void QFormLayout::addRow(QWidget* label, QWidget* field).

C++ documentation:

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

See also insertRow().

pub unsafe fn add_row_q_widget_q_layout(
    &self,
    label: impl CastInto<Ptr<QWidget>>,
    field: impl CastInto<Ptr<QLayout>>
)

This is an overloaded function.

Calls C++ function: void QFormLayout::addRow(QWidget* label, QLayout* field).

C++ documentation:

This is an overloaded function.

pub unsafe fn add_row_q_string_q_widget(
    &self,
    label_text: impl CastInto<Ref<QString>>,
    field: impl CastInto<Ptr<QWidget>>
)

This is an overloaded function.

Calls C++ function: void QFormLayout::addRow(const QString& labelText, QWidget* field).

C++ documentation:

This is an overloaded function.

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

pub unsafe fn add_row_q_string_q_layout(
    &self,
    label_text: impl CastInto<Ref<QString>>,
    field: impl CastInto<Ptr<QLayout>>
)

This is an overloaded function.

Calls C++ function: void QFormLayout::addRow(const QString& labelText, QLayout* field).

C++ documentation:

This is an overloaded function.

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

pub unsafe fn add_row_q_widget(&self, widget: impl CastInto<Ptr<QWidget>>)

This is an overloaded function.

Calls C++ function: void QFormLayout::addRow(QWidget* widget).

C++ documentation:

This is an overloaded function.

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

pub unsafe fn add_row_q_layout(&self, layout: impl CastInto<Ptr<QLayout>>)

This is an overloaded function.

Calls C++ function: void QFormLayout::addRow(QLayout* layout).

C++ documentation:

This is an overloaded function.

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

pub unsafe fn count(&self) -> c_int

Reimplemented from QLayout::count().

Calls C++ function: virtual int QFormLayout::count() const.

C++ documentation:

Reimplemented from QLayout::count().

pub unsafe fn expanding_directions(&self) -> QFlags<Orientation>

Reimplemented from QLayoutItem::expandingDirections().

Calls C++ function: virtual QFlags<Qt::Orientation> QFormLayout::expandingDirections() const.

C++ documentation:

Reimplemented from QLayoutItem::expandingDirections().

pub unsafe fn field_growth_policy(&self) -> FieldGrowthPolicy

This property holds the way in which the form's fields grow

Calls C++ function: QFormLayout::FieldGrowthPolicy QFormLayout::fieldGrowthPolicy() const.

C++ documentation:

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.

Access functions:

FieldGrowthPolicy	fieldGrowthPolicy() const
void	setFieldGrowthPolicy(FieldGrowthPolicy policy)

See also formAlignment and rowWrapPolicy.

pub unsafe fn form_alignment(&self) -> QFlags<AlignmentFlag>

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

Calls C++ function: QFlags<Qt::AlignmentFlag> QFormLayout::formAlignment() const.

C++ documentation:

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.

Access functions:

Qt::Alignment	formAlignment() const
void	setFormAlignment(Qt::Alignment alignment)

See also labelAlignment and rowWrapPolicy.

pub unsafe fn get_item_position(
    &self,
    index: c_int,
    row_ptr: *mut c_int,
    role_ptr: *mut ItemRole
)

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.

Calls C++ function: void QFormLayout::getItemPosition(int index, int* rowPtr, QFormLayout::ItemRole* rolePtr) const.

C++ documentation:

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(), and getWidgetPosition().

pub unsafe fn get_layout_position(
    &self,
    layout: impl CastInto<Ptr<QLayout>>,
    row_ptr: *mut c_int,
    role_ptr: *mut ItemRole
)

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.

Calls C++ function: void QFormLayout::getLayoutPosition(QLayout* layout, int* rowPtr, QFormLayout::ItemRole* rolePtr) const.

C++ documentation:

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.

pub unsafe fn get_widget_position(
    &self,
    widget: impl CastInto<Ptr<QWidget>>,
    row_ptr: *mut c_int,
    role_ptr: *mut ItemRole
)

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.

Calls C++ function: void QFormLayout::getWidgetPosition(QWidget* widget, int* rowPtr, QFormLayout::ItemRole* rolePtr) const.

C++ documentation:

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

pub unsafe fn has_height_for_width(&self) -> bool

Reimplemented from QLayoutItem::hasHeightForWidth().

Calls C++ function: virtual bool QFormLayout::hasHeightForWidth() const.

C++ documentation:

Reimplemented from QLayoutItem::hasHeightForWidth().

pub unsafe fn height_for_width(&self, width: c_int) -> c_int

Reimplemented from QLayoutItem::heightForWidth().

Calls C++ function: virtual int QFormLayout::heightForWidth(int width) const.

C++ documentation:

Reimplemented from QLayoutItem::heightForWidth().

pub unsafe fn horizontal_spacing(&self) -> c_int

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

Calls C++ function: int QFormLayout::horizontalSpacing() const.

C++ documentation:

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.

Access functions:

int	horizontalSpacing() const
void	setHorizontalSpacing(int spacing)

See also verticalSpacing, QStyle::pixelMetric(), and PM_LayoutHorizontalSpacing.

pub unsafe fn insert_row_int2_q_widget(
    &self,
    row: c_int,
    label: impl CastInto<Ptr<QWidget>>,
    field: impl CastInto<Ptr<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.

Calls C++ function: void QFormLayout::insertRow(int row, QWidget* label, QWidget* field).

C++ documentation:

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

pub unsafe fn insert_row_int_q_widget_q_layout(
    &self,
    row: c_int,
    label: impl CastInto<Ptr<QWidget>>,
    field: impl CastInto<Ptr<QLayout>>
)

This is an overloaded function.

Calls C++ function: void QFormLayout::insertRow(int row, QWidget* label, QLayout* field).

C++ documentation:

This is an overloaded function.

pub unsafe fn insert_row_int_q_string_q_widget(
    &self,
    row: c_int,
    label_text: impl CastInto<Ref<QString>>,
    field: impl CastInto<Ptr<QWidget>>
)

This is an overloaded function.

Calls C++ function: void QFormLayout::insertRow(int row, const QString& labelText, QWidget* field).

C++ documentation:

This is an overloaded function.

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

pub unsafe fn insert_row_int_q_string_q_layout(
    &self,
    row: c_int,
    label_text: impl CastInto<Ref<QString>>,
    field: impl CastInto<Ptr<QLayout>>
)

This is an overloaded function.

Calls C++ function: void QFormLayout::insertRow(int row, const QString& labelText, QLayout* field).

C++ documentation:

This is an overloaded function.

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

pub unsafe fn insert_row_int_q_widget(
    &self,
    row: c_int,
    widget: impl CastInto<Ptr<QWidget>>
)

This is an overloaded function.

Calls C++ function: void QFormLayout::insertRow(int row, QWidget* widget).

C++ documentation:

This is an overloaded function.

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.

pub unsafe fn insert_row_int_q_layout(
    &self,
    row: c_int,
    layout: impl CastInto<Ptr<QLayout>>
)

This is an overloaded function.

Calls C++ function: void QFormLayout::insertRow(int row, QLayout* layout).

C++ documentation:

This is an overloaded function.

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.

pub unsafe fn invalidate(&self)

Reimplemented from QLayoutItem::invalidate().

Calls C++ function: virtual void QFormLayout::invalidate().

C++ documentation:

Reimplemented from QLayoutItem::invalidate().

pub unsafe fn item_at_2a(&self, row: c_int, role: ItemRole) -> Ptr<QLayoutItem>

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

Calls C++ function: QLayoutItem* QFormLayout::itemAt(int row, QFormLayout::ItemRole role) const.

C++ documentation:

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

See also QLayout::itemAt() and setItem().

pub unsafe fn item_at_1a(&self, index: c_int) -> Ptr<QLayoutItem>

Reimplemented from QLayout::itemAt().

Calls C++ function: virtual QLayoutItem* QFormLayout::itemAt(int index) const.

C++ documentation:

Reimplemented from QLayout::itemAt().

pub unsafe fn label_alignment(&self) -> QFlags<AlignmentFlag>

This property holds the horizontal alignment of the labels

Calls C++ function: QFlags<Qt::AlignmentFlag> QFormLayout::labelAlignment() const.

C++ documentation:

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.

Access functions:

Qt::Alignment	labelAlignment() const
void	setLabelAlignment(Qt::Alignment alignment)

See also formAlignment.

pub unsafe fn label_for_field_q_widget(
    &self,
    field: impl CastInto<Ptr<QWidget>>
) -> QPtr<QWidget>

Returns the label associated with the given field.

Calls C++ function: QWidget* QFormLayout::labelForField(QWidget* field) const.

C++ documentation:

Returns the label associated with the given field.

See also itemAt().

pub unsafe fn label_for_field_q_layout(
    &self,
    field: impl CastInto<Ptr<QLayout>>
) -> QPtr<QWidget>

This is an overloaded function.

Calls C++ function: QWidget* QFormLayout::labelForField(QLayout* field) const.

C++ documentation:

This is an overloaded function.

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QFormLayout::metaObject() const.

pub unsafe fn minimum_size(&self) -> CppBox<QSize>

Reimplemented from QLayoutItem::minimumSize().

Calls C++ function: virtual QSize QFormLayout::minimumSize() const.

C++ documentation:

Reimplemented from QLayoutItem::minimumSize().

pub unsafe fn new_1a(parent: impl CastInto<Ptr<QWidget>>) -> QBox<QFormLayout>

Constructs a new form layout with the given parent widget.

Calls C++ function: [constructor] void QFormLayout::QFormLayout(QWidget* parent = …).

C++ documentation:

Constructs a new form layout with the given parent widget.

See also QWidget::setLayout().

pub unsafe fn new_0a() -> QBox<QFormLayout>

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

Calls C++ function: [constructor] void QFormLayout::QFormLayout().

C++ documentation:

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

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:

  QFormLayout *formLayout = new QFormLayout;
  formLayout->addRow(tr("&Name:"), nameLineEdit);
  formLayout->addRow(tr("&Email:"), emailLineEdit);
  formLayout->addRow(tr("&Age:"), ageSpinBox);
  setLayout(formLayout);
  

  Compare this with the following code, written using QGridLayout:

  nameLabel = new QLabel(tr("&Name:"));
  nameLabel->setBuddy(nameLineEdit);
  emailLabel = new QLabel(tr("&Name:"));
  emailLabel->setBuddy(emailLineEdit);
  ageLabel = new QLabel(tr("&Name:"));
  ageLabel->setBuddy(ageSpinBox);
  QGridLayout *gridLayout = new QGridLayout;
  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);
  setLayout(gridLayout);
  

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.

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::AlignHCenter | Qt::AlignTop);
formLayout->setLabelAlignment(Qt::AlignLeft);

pub unsafe fn qt_metacall(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int QFormLayout::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* QFormLayout::qt_metacast(const char* arg1).

pub unsafe fn remove_row_int(&self, row: c_int)

Deletes row row from this form layout.

Calls C++ function: void QFormLayout::removeRow(int row).

C++ documentation:

Deletes row row from this form layout.

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

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

QFormLayout *flay = ...;
QPointer<QLineEdit> le = new QLineEdit;
flay->insertRow(2, "User:", le);
// later:
flay->removeRow(2); // le == nullptr at this point

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

This function was introduced in Qt 5.8.

See also takeRow().

pub unsafe fn remove_row_q_widget(&self, widget: impl CastInto<Ptr<QWidget>>)

This is an overloaded function.

Calls C++ function: void QFormLayout::removeRow(QWidget* widget).

C++ documentation:

This is an overloaded function.

Deletes the row corresponding to widget 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():

QFormLayout *flay = ...;
QPointer<QLineEdit> le = new QLineEdit;
flay->insertRow(2, "User:", le);
// later:
flay->removeRow(le); // le == nullptr at this point

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

This function was introduced in Qt 5.8.

See also takeRow().

pub unsafe fn remove_row_q_layout(&self, layout: impl CastInto<Ptr<QLayout>>)

This is an overloaded function.

Calls C++ function: void QFormLayout::removeRow(QLayout* layout).

C++ documentation:

This is an overloaded function.

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

QFormLayout *flay = ...;
QPointer<QVBoxLayout> vbl = new QVBoxLayout;
flay->insertRow(2, "User:", vbl);
// later:
flay->removeRow(layout); // vbl == nullptr at this point

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

This function was introduced in Qt 5.8.

See also takeRow().

pub unsafe fn row_count(&self) -> c_int

Returns the number of rows in the form.

Calls C++ function: int QFormLayout::rowCount() const.

C++ documentation:

Returns the number of rows in the form.

See also QLayout::count().

pub unsafe fn row_wrap_policy(&self) -> RowWrapPolicy

This property holds the way in which the form's rows wrap

Calls C++ function: QFormLayout::RowWrapPolicy QFormLayout::rowWrapPolicy() const.

C++ documentation:

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.

Access functions:

RowWrapPolicy	rowWrapPolicy() const
void	setRowWrapPolicy(RowWrapPolicy policy)

See also fieldGrowthPolicy.

pub unsafe fn set_field_growth_policy(&self, policy: FieldGrowthPolicy)

This property holds the way in which the form's fields grow

Calls C++ function: void QFormLayout::setFieldGrowthPolicy(QFormLayout::FieldGrowthPolicy policy).

C++ documentation:

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.

Access functions:

FieldGrowthPolicy	fieldGrowthPolicy() const
void	setFieldGrowthPolicy(FieldGrowthPolicy policy)

See also formAlignment and rowWrapPolicy.

pub unsafe fn set_form_alignment(&self, alignment: QFlags<AlignmentFlag>)

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

Calls C++ function: void QFormLayout::setFormAlignment(QFlags<Qt::AlignmentFlag> alignment).

C++ documentation:

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.

Access functions:

Qt::Alignment	formAlignment() const
void	setFormAlignment(Qt::Alignment alignment)

See also labelAlignment and rowWrapPolicy.

pub unsafe fn set_geometry(&self, rect: impl CastInto<Ref<QRect>>)

Reimplemented from QLayoutItem::setGeometry().

Calls C++ function: virtual void QFormLayout::setGeometry(const QRect& rect).

C++ documentation:

Reimplemented from QLayoutItem::setGeometry().

pub unsafe fn set_horizontal_spacing(&self, spacing: c_int)

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

Calls C++ function: void QFormLayout::setHorizontalSpacing(int spacing).

C++ documentation:

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.

Access functions:

int	horizontalSpacing() const
void	setHorizontalSpacing(int spacing)

See also verticalSpacing, QStyle::pixelMetric(), and PM_LayoutHorizontalSpacing.

pub unsafe fn set_item(
    &self,
    row: c_int,
    role: ItemRole,
    item: impl CastInto<Ptr<QLayoutItem>>
)

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

Calls C++ function: void QFormLayout::setItem(int row, QFormLayout::ItemRole role, QLayoutItem* item).

C++ documentation:

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

pub unsafe fn set_label_alignment(&self, alignment: QFlags<AlignmentFlag>)

This property holds the horizontal alignment of the labels

Calls C++ function: void QFormLayout::setLabelAlignment(QFlags<Qt::AlignmentFlag> alignment).

C++ documentation:

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.

Access functions:

Qt::Alignment	labelAlignment() const
void	setLabelAlignment(Qt::Alignment alignment)

See also formAlignment.

pub unsafe fn set_layout(
    &self,
    row: c_int,
    role: ItemRole,
    layout: impl CastInto<Ptr<QLayout>>
)

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

Calls C++ function: void QFormLayout::setLayout(int row, QFormLayout::ItemRole role, QLayout* layout).

C++ documentation:

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

pub unsafe fn set_row_wrap_policy(&self, policy: RowWrapPolicy)

This property holds the way in which the form's rows wrap

Calls C++ function: void QFormLayout::setRowWrapPolicy(QFormLayout::RowWrapPolicy policy).

C++ documentation:

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.

Access functions:

RowWrapPolicy	rowWrapPolicy() const
void	setRowWrapPolicy(RowWrapPolicy policy)

See also fieldGrowthPolicy.

pub unsafe fn set_spacing(&self, arg1: c_int)

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

Calls C++ function: void QFormLayout::setSpacing(int arg1).

C++ documentation:

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

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

pub unsafe fn set_vertical_spacing(&self, spacing: c_int)

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

Calls C++ function: void QFormLayout::setVerticalSpacing(int spacing).

C++ documentation:

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.

Access functions:

int	verticalSpacing() const
void	setVerticalSpacing(int spacing)

See also horizontalSpacing, QStyle::pixelMetric(), and PM_LayoutHorizontalSpacing.

pub unsafe fn set_widget(
    &self,
    row: c_int,
    role: ItemRole,
    widget: impl CastInto<Ptr<QWidget>>
)

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

Calls C++ function: void QFormLayout::setWidget(int row, QFormLayout::ItemRole role, QWidget* widget).

C++ documentation:

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

pub unsafe fn size_hint(&self) -> CppBox<QSize>

Reimplemented from QLayoutItem::sizeHint().

Calls C++ function: virtual QSize QFormLayout::sizeHint() const.

C++ documentation:

Reimplemented from QLayoutItem::sizeHint().

pub unsafe fn spacing(&self) -> c_int

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

Calls C++ function: int QFormLayout::spacing() const.

C++ documentation:

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

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

pub unsafe fn static_meta_object() -> Ref<QMetaObject>

Returns a reference to the staticMetaObject field.

pub unsafe fn take_at(&self, index: c_int) -> Ptr<QLayoutItem>

Reimplemented from QLayout::takeAt().

Calls C++ function: virtual QLayoutItem* QFormLayout::takeAt(int index).

C++ documentation:

Reimplemented from QLayout::takeAt().

pub unsafe fn take_row_int(&self, row: c_int) -> CppBox<TakeRowResult>

Removes the specified row from this form layout.

Calls C++ function: QFormLayout::TakeRowResult QFormLayout::takeRow(int row).

C++ documentation:

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

QFormLayout *flay = ...;
QPointer<QLineEdit> le = new 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

This function was introduced in Qt 5.8.

See also removeRow().

pub unsafe fn take_row_q_widget(
    &self,
    widget: impl CastInto<Ptr<QWidget>>
) -> CppBox<TakeRowResult>

This is an overloaded function.

Calls C++ function: QFormLayout::TakeRowResult QFormLayout::takeRow(QWidget* widget).

C++ documentation:

This is an overloaded function.

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.

QFormLayout *flay = ...;
QPointer<QLineEdit> le = new 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

This function was introduced in Qt 5.8.

See also removeRow().

pub unsafe fn take_row_q_layout(
    &self,
    layout: impl CastInto<Ptr<QLayout>>
) -> CppBox<TakeRowResult>

This is an overloaded function.

Calls C++ function: QFormLayout::TakeRowResult QFormLayout::takeRow(QLayout* layout).

C++ documentation:

This is an overloaded function.

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.

QFormLayout *flay = ...;
QPointer<QVBoxLayout> vbl = new 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

This function was introduced in Qt 5.8.

See also removeRow().

pub unsafe fn tr(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QFormLayout::tr(const char* s, const char* c, int n).

pub unsafe fn tr_utf8(
    s: *const c_char,
    c: *const c_char,
    n: c_int
) -> CppBox<QString>

Calls C++ function: static QString QFormLayout::trUtf8(const char* s, const char* c, int n).

pub unsafe fn vertical_spacing(&self) -> c_int

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

Calls C++ function: int QFormLayout::verticalSpacing() const.

C++ documentation:

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.

Access functions:

int	verticalSpacing() const
void	setVerticalSpacing(int spacing)

See also horizontalSpacing, QStyle::pixelMetric(), and PM_LayoutHorizontalSpacing.

Methods from Deref<Target = QLayout>

pub unsafe fn activate(&self) -> bool

Redoes the layout for parentWidget() if necessary.

Calls C++ function: bool QLayout::activate().

C++ documentation:

Redoes the layout for parentWidget() if necessary.

You should generally not need to call this because it is automatically called at the most appropriate times. It returns true if the layout was redone.

See also update() and QWidget::updateGeometry().

pub unsafe fn add_item(&self, arg1: impl CastInto<Ptr<QLayoutItem>>)

Implemented in subclasses to add an item. How it is added is specific to each subclass.

Calls C++ function: pure virtual void QLayout::addItem(QLayoutItem* arg1).

C++ documentation:

Implemented in subclasses to add an item. How it is added is specific to each subclass.

This function is not usually called in application code. To add a widget to a layout, use the addWidget() function; to add a child layout, use the addLayout() function provided by the relevant QLayout subclass.

Note: The ownership of item is transferred to the layout, and it's the layout's responsibility to delete it.

See also addWidget(), QBoxLayout::addLayout(), and QGridLayout::addLayout().

pub unsafe fn add_widget(&self, w: impl CastInto<Ptr<QWidget>>)

Adds widget w to this layout in a manner specific to the layout. This function uses addItem().

Calls C++ function: void QLayout::addWidget(QWidget* w).

C++ documentation:

Adds widget w to this layout in a manner specific to the layout. This function uses addItem().

pub unsafe fn contents_margins(&self) -> CppBox<QMargins>

Returns the margins used around the layout.

Calls C++ function: QMargins QLayout::contentsMargins() const.

C++ documentation:

Returns the margins used around the layout.

By default, QLayout uses the values provided by the style. On most platforms, the margin is 11 pixels in all directions.

This function was introduced in Qt 4.6.

See also setContentsMargins().

pub unsafe fn contents_rect(&self) -> CppBox<QRect>

Returns the layout's geometry() rectangle, but taking into account the contents margins.

Calls C++ function: QRect QLayout::contentsRect() const.

C++ documentation:

Returns the layout's geometry() rectangle, but taking into account the contents margins.

This function was introduced in Qt 4.3.

See also setContentsMargins() and getContentsMargins().

pub unsafe fn control_types(&self) -> QFlags<ControlType>

Reimplemented from QLayoutItem::controlTypes().

Calls C++ function: virtual QFlags<QSizePolicy::ControlType> QLayout::controlTypes() const.

C++ documentation:

Reimplemented from QLayoutItem::controlTypes().

pub unsafe fn count(&self) -> c_int

Must be implemented in subclasses to return the number of items in the layout.

Calls C++ function: pure virtual int QLayout::count() const.

C++ documentation:

Must be implemented in subclasses to return the number of items in the layout.

See also itemAt().

pub unsafe fn expanding_directions(&self) -> QFlags<Orientation>

Reimplemented from QLayoutItem::expandingDirections().

Calls C++ function: virtual QFlags<Qt::Orientation> QLayout::expandingDirections() const.

C++ documentation:

Reimplemented from QLayoutItem::expandingDirections().

Returns whether this layout can make use of more space than sizeHint(). A value of Qt::Vertical or Qt::Horizontal means that it wants to grow in only one dimension, whereas Qt::Vertical | Qt::Horizontal means that it wants to grow in both dimensions.

The default implementation returns Qt::Horizontal | Qt::Vertical. Subclasses reimplement it to return a meaningful value based on their child widgets's size policies.

See also sizeHint().

pub unsafe fn geometry(&self) -> CppBox<QRect>

Reimplemented from QLayoutItem::geometry().

Calls C++ function: virtual QRect QLayout::geometry() const.

C++ documentation:

Reimplemented from QLayoutItem::geometry().

See also setGeometry().

pub unsafe fn get_contents_margins(
    &self,
    left: *mut c_int,
    top: *mut c_int,
    right: *mut c_int,
    bottom: *mut c_int
)

Extracts the left, top, right, and bottom margins used around the layout, and assigns them to *left, *top, *right, and *bottom (unless they are null pointers).

Calls C++ function: void QLayout::getContentsMargins(int* left, int* top, int* right, int* bottom) const.

C++ documentation:

Extracts the left, top, right, and bottom margins used around the layout, and assigns them to *left, *top, *right, and *bottom (unless they are null pointers).

By default, QLayout uses the values provided by the style. On most platforms, the margin is 11 pixels in all directions.

This function was introduced in Qt 4.3.

See also setContentsMargins(), QStyle::pixelMetric(), PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin.

pub unsafe fn index_of_q_widget(
    &self,
    arg1: impl CastInto<Ptr<QWidget>>
) -> c_int

Searches for widget widget in this layout (not including child layouts).

Calls C++ function: virtual int QLayout::indexOf(QWidget* arg1) const.

C++ documentation:

Searches for widget widget in this layout (not including child layouts).

Returns the index of widget, or -1 if widget is not found.

The default implementation iterates over all items using itemAt()

pub unsafe fn index_of_q_layout_item(
    &self,
    arg1: impl CastInto<Ptr<QLayoutItem>>
) -> c_int

This is supported on cpp_lib_version="5.12.2" or cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0" only.

Searches for layout item layoutItem in this layout (not including child layouts).

Calls C++ function: int QLayout::indexOf(QLayoutItem* arg1) const.

C++ documentation:

Searches for layout item layoutItem in this layout (not including child layouts).

Returns the index of layoutItem, or -1 if layoutItem is not found.

This function was introduced in Qt 5.12.

pub unsafe fn invalidate(&self)

Reimplemented from QLayoutItem::invalidate().

Calls C++ function: virtual void QLayout::invalidate().

C++ documentation:

Reimplemented from QLayoutItem::invalidate().

pub unsafe fn is_empty(&self) -> bool

Reimplemented from QLayoutItem::isEmpty().

Calls C++ function: virtual bool QLayout::isEmpty() const.

C++ documentation:

Reimplemented from QLayoutItem::isEmpty().

pub unsafe fn is_enabled(&self) -> bool

Returns true if the layout is enabled; otherwise returns false.

Calls C++ function: bool QLayout::isEnabled() const.

C++ documentation:

Returns true if the layout is enabled; otherwise returns false.

See also setEnabled().

pub unsafe fn item_at(&self, index: c_int) -> Ptr<QLayoutItem>

Must be implemented in subclasses to return the layout item at index. If there is no such item, the function must return 0. Items are numbered consecutively from 0. If an item is deleted, other items will be renumbered.

Calls C++ function: pure virtual QLayoutItem* QLayout::itemAt(int index) const.

C++ documentation:

Must be implemented in subclasses to return the layout item at index. If there is no such item, the function must return 0. Items are numbered consecutively from 0. If an item is deleted, other items will be renumbered.

This function can be used to iterate over a layout. The following code will draw a rectangle for each layout item in the layout structure of the widget.

static void paintLayout(QPainter painter, QLayoutItem item)
{
      QLayout *layout = item->layout();
      if (layout) {
          for (int i = 0; i < layout->count(); ++i)
              paintLayout(painter, layout->itemAt(i));
      }
      painter->drawRect(item->geometry());
}
void MyWidget::paintEvent(QPaintEvent *)
{
      QPainter painter(this);
      if (layout())
          paintLayout(&painter, layout());
}

See also count() and takeAt().

pub unsafe fn layout(&self) -> QPtr<QLayout>

Reimplemented from QLayoutItem::layout().

Calls C++ function: virtual QLayout* QLayout::layout().

C++ documentation:

Reimplemented from QLayoutItem::layout().

pub unsafe fn margin(&self) -> c_int

This property holds the width of the outside border of the layout

Calls C++ function: int QLayout::margin() const.

C++ documentation:

This property holds the width of the outside border of the layout

Use setContentsMargins() and getContentsMargins() instead.

Access functions:

int	margin() const
void	setMargin(int margin)

See also contentsRect() and spacing.

Member Function Documentation

pub unsafe fn maximum_size(&self) -> CppBox<QSize>

Reimplemented from QLayoutItem::maximumSize().

Calls C++ function: virtual QSize QLayout::maximumSize() const.

C++ documentation:

Reimplemented from QLayoutItem::maximumSize().

Returns the maximum size of this layout. This is the largest size that the layout can have while still respecting the specifications.

The returned value doesn't include the space required by QWidget::setContentsMargins() or menuBar().

The default implementation allows unlimited resizing.

pub unsafe fn menu_bar(&self) -> QPtr<QWidget>

Returns the menu bar set for this layout, or 0 if no menu bar is set.

Calls C++ function: QWidget* QLayout::menuBar() const.

C++ documentation:

Returns the menu bar set for this layout, or 0 if no menu bar is set.

See also setMenuBar().

pub unsafe fn meta_object(&self) -> Ptr<QMetaObject>

Calls C++ function: virtual const QMetaObject* QLayout::metaObject() const.

pub unsafe fn minimum_size(&self) -> CppBox<QSize>

Reimplemented from QLayoutItem::minimumSize().

Calls C++ function: virtual QSize QLayout::minimumSize() const.

C++ documentation:

Reimplemented from QLayoutItem::minimumSize().

Returns the minimum size of this layout. This is the smallest size that the layout can have while still respecting the specifications.

The returned value doesn't include the space required by QWidget::setContentsMargins() or menuBar().

The default implementation allows unlimited resizing.

pub unsafe fn parent_widget(&self) -> QPtr<QWidget>

Returns the parent widget of this layout, or 0 if this layout is not installed on any widget.

Calls C++ function: QWidget* QLayout::parentWidget() const.

C++ documentation:

Returns the parent widget of this layout, or 0 if this layout is not installed on any widget.

If the layout is a sub-layout, this function returns the parent widget of the parent layout.

See also parent().

pub unsafe fn qt_metacall(
    &self,
    arg1: Call,
    arg2: c_int,
    arg3: *mut *mut c_void
) -> c_int

Calls C++ function: virtual int QLayout::qt_metacall(QMetaObject::Call arg1, int arg2, void** arg3).

pub unsafe fn qt_metacast(&self, arg1: *const c_char) -> *mut c_void

Calls C++ function: virtual void* QLayout::qt_metacast(const char* arg1).

pub unsafe fn remove_item(&self, arg1: impl CastInto<Ptr<QLayoutItem>>)

Removes the layout item item from the layout. It is the caller's responsibility to delete the item.

Calls C++ function: void QLayout::removeItem(QLayoutItem* arg1).

C++ documentation:

Removes the layout item item from the layout. It is the caller's responsibility to delete the item.

Notice that item can be a layout (since QLayout inherits QLayoutItem).

See also removeWidget() and addItem().

pub unsafe fn remove_widget(&self, w: impl CastInto<Ptr<QWidget>>)

Removes the widget widget from the layout. After this call, it is the caller's responsibility to give the widget a reasonable geometry or to put the widget back into a layout or to explicitly hide it if necessary.

Calls C++ function: void QLayout::removeWidget(QWidget* w).

C++ documentation:

Removes the widget widget from the layout. After this call, it is the caller's responsibility to give the widget a reasonable geometry or to put the widget back into a layout or to explicitly hide it if necessary.

Note: The ownership of widget remains the same as when it was added.

See also removeItem(), QWidget::setGeometry(), and addWidget().

pub unsafe fn replace_widget_3a(
    &self,
    from: impl CastInto<Ptr<QWidget>>,
    to: impl CastInto<Ptr<QWidget>>,
    options: QFlags<FindChildOption>
) -> Ptr<QLayoutItem>

Searches for widget from and replaces it with widget to if found. Returns the layout item that contains the widget from on success. Otherwise 0 is returned. If options contains Qt::FindChildrenRecursively (the default), sub-layouts are searched for doing the replacement. Any other flag in options is ignored.

Calls C++ function: QLayoutItem* QLayout::replaceWidget(QWidget* from, QWidget* to, QFlags<Qt::FindChildOption> options = …).

C++ documentation:

Searches for widget from and replaces it with widget to if found. Returns the layout item that contains the widget from on success. Otherwise 0 is returned. If options contains Qt::FindChildrenRecursively (the default), sub-layouts are searched for doing the replacement. Any other flag in options is ignored.

Notice that the returned item therefore might not belong to this layout, but to a sub-layout.

The returned layout item is no longer owned by the layout and should be either deleted or inserted to another layout. The widget from is no longer managed by the layout and may need to be deleted or hidden. The parent of widget from is left unchanged.

This function works for the built-in Qt layouts, but might not work for custom layouts.

This function was introduced in Qt 5.2.

See also indexOf().

pub unsafe fn replace_widget_2a(
    &self,
    from: impl CastInto<Ptr<QWidget>>,
    to: impl CastInto<Ptr<QWidget>>
) -> Ptr<QLayoutItem>

Searches for widget from and replaces it with widget to if found. Returns the layout item that contains the widget from on success. Otherwise 0 is returned. If options contains Qt::FindChildrenRecursively (the default), sub-layouts are searched for doing the replacement. Any other flag in options is ignored.

Calls C++ function: QLayoutItem* QLayout::replaceWidget(QWidget* from, QWidget* to).

C++ documentation:

Searches for widget from and replaces it with widget to if found. Returns the layout item that contains the widget from on success. Otherwise 0 is returned. If options contains Qt::FindChildrenRecursively (the default), sub-layouts are searched for doing the replacement. Any other flag in options is ignored.

Notice that the returned item therefore might not belong to this layout, but to a sub-layout.

The returned layout item is no longer owned by the layout and should be either deleted or inserted to another layout. The widget from is no longer managed by the layout and may need to be deleted or hidden. The parent of widget from is left unchanged.

This function works for the built-in Qt layouts, but might not work for custom layouts.

This function was introduced in Qt 5.2.

See also indexOf().

pub unsafe fn set_alignment_q_widget_q_flags_alignment_flag(
    &self,
    w: impl CastInto<Ptr<QWidget>>,
    alignment: QFlags<AlignmentFlag>
) -> bool

Sets the alignment for widget w to alignment and returns true if w is found in this layout (not including child layouts); otherwise returns false.

Calls C++ function: bool QLayout::setAlignment(QWidget* w, QFlags<Qt::AlignmentFlag> alignment).

C++ documentation:

Sets the alignment for widget w to alignment and returns true if w is found in this layout (not including child layouts); otherwise returns false.

pub unsafe fn set_alignment_q_layout_q_flags_alignment_flag(
    &self,
    l: impl CastInto<Ptr<QLayout>>,
    alignment: QFlags<AlignmentFlag>
) -> bool

This is an overloaded function.

Calls C++ function: bool QLayout::setAlignment(QLayout* l, QFlags<Qt::AlignmentFlag> alignment).

C++ documentation:

This is an overloaded function.

Sets the alignment for the layout l to alignment and returns true if l is found in this layout (not including child layouts); otherwise returns false.

pub unsafe fn set_contents_margins_4a(
    &self,
    left: c_int,
    top: c_int,
    right: c_int,
    bottom: c_int
)

Sets the left, top, right, and bottom margins to use around the layout.

Calls C++ function: void QLayout::setContentsMargins(int left, int top, int right, int bottom).

C++ documentation:

Sets the left, top, right, and bottom margins to use around the layout.

By default, QLayout uses the values provided by the style. On most platforms, the margin is 11 pixels in all directions.

This function was introduced in Qt 4.3.

See also contentsMargins(), getContentsMargins(), QStyle::pixelMetric(), PM_LayoutLeftMargin, PM_LayoutTopMargin, PM_LayoutRightMargin, and PM_LayoutBottomMargin.

pub unsafe fn set_contents_margins_1a(
    &self,
    margins: impl CastInto<Ref<QMargins>>
)

Sets the margins to use around the layout.

Calls C++ function: void QLayout::setContentsMargins(const QMargins& margins).

C++ documentation:

Sets the margins to use around the layout.

By default, QLayout uses the values provided by the style. On most platforms, the margin is 11 pixels in all directions.

This function was introduced in Qt 4.6.

See also contentsMargins().

pub unsafe fn set_enabled(&self, arg1: bool)

Enables this layout if enable is true, otherwise disables it.

Calls C++ function: void QLayout::setEnabled(bool arg1).

C++ documentation:

Enables this layout if enable is true, otherwise disables it.

An enabled layout adjusts dynamically to changes; a disabled layout acts as if it did not exist.

By default all layouts are enabled.

See also isEnabled().

pub unsafe fn set_geometry(&self, arg1: impl CastInto<Ref<QRect>>)

Reimplemented from QLayoutItem::setGeometry().

Calls C++ function: virtual void QLayout::setGeometry(const QRect& arg1).

C++ documentation:

Reimplemented from QLayoutItem::setGeometry().

See also geometry().

pub unsafe fn set_margin(&self, arg1: c_int)

Note: Setter function for property margin.

Calls C++ function: void QLayout::setMargin(int arg1).

C++ documentation:

Note: Setter function for property margin.

See also margin().

pub unsafe fn set_menu_bar(&self, w: impl CastInto<Ptr<QWidget>>)

Tells the geometry manager to place the menu bar widget at the top of parentWidget(), outside QWidget::contentsMargins(). All child widgets are placed below the bottom edge of the menu bar.

Calls C++ function: void QLayout::setMenuBar(QWidget* w).

C++ documentation:

Tells the geometry manager to place the menu bar widget at the top of parentWidget(), outside QWidget::contentsMargins(). All child widgets are placed below the bottom edge of the menu bar.

See also menuBar().

pub unsafe fn set_size_constraint(&self, arg1: SizeConstraint)

This property holds the resize mode of the layout

Calls C++ function: void QLayout::setSizeConstraint(QLayout::SizeConstraint arg1).

C++ documentation:

This property holds the resize mode of the layout

The default mode is SetDefaultConstraint.

Access functions:

SizeConstraint	sizeConstraint() const
void	setSizeConstraint(SizeConstraint)

pub unsafe fn set_spacing(&self, arg1: c_int)

This property holds the spacing between widgets inside the layout

Calls C++ function: void QLayout::setSpacing(int arg1).

C++ documentation:

This property holds the spacing between widgets inside the layout

If no value is explicitly set, the layout's spacing is inherited from the parent layout, or from the style settings for the parent widget.

For QGridLayout and QFormLayout, it is possible to set different horizontal and vertical spacings using setHorizontalSpacing() and setVerticalSpacing(). In that case, spacing() returns -1.

Access functions:

int	spacing() const
void	setSpacing(int)

See also contentsRect(), getContentsMargins(), QStyle::layoutSpacing(), and QStyle::pixelMetric().

pub unsafe fn size_constraint(&self) -> SizeConstraint

This property holds the resize mode of the layout

Calls C++ function: QLayout::SizeConstraint QLayout::sizeConstraint() const.

C++ documentation:

This property holds the resize mode of the layout

The default mode is SetDefaultConstraint.

Access functions:

SizeConstraint	sizeConstraint() const
void	setSizeConstraint(SizeConstraint)

pub unsafe fn spacing(&self) -> c_int

This property holds the spacing between widgets inside the layout

Calls C++ function: int QLayout::spacing() const.

C++ documentation:

This property holds the spacing between widgets inside the layout

If no value is explicitly set, the layout's spacing is inherited from the parent layout, or from the style settings for the parent widget.

For QGridLayout and QFormLayout, it is possible to set different horizontal and vertical spacings using setHorizontalSpacing() and setVerticalSpacing(). In that case, spacing() returns -1.

Access functions:

int	spacing() const
void	setSpacing(int)

See also contentsRect(), getContentsMargins(), QStyle::layoutSpacing(), and QStyle::pixelMetric().

pub unsafe fn take_at(&self, index: c_int) -> Ptr<QLayoutItem>

Must be implemented in subclasses to remove the layout item at index from the layout, and return the item. If there is no such item, the function must do nothing and return 0. Items are numbered consecutively from 0. If an item is removed, other items will be renumbered.

Calls C++ function: pure virtual QLayoutItem* QLayout::takeAt(int index).

C++ documentation:

Must be implemented in subclasses to remove the layout item at index from the layout, and return the item. If there is no such item, the function must do nothing and return 0. Items are numbered consecutively from 0. If an item is removed, other items will be renumbered.

The following code fragment shows a safe way to remove all items from a layout:

QLayoutItem *child;
while ((child = layout->takeAt(0)) != 0) {
      ...
      delete child;
}

See also itemAt() and count().

pub unsafe fn total_height_for_width(&self, w: c_int) -> c_int

Calls C++ function: int QLayout::totalHeightForWidth(int w) const.

pub unsafe fn total_maximum_size(&self) -> CppBox<QSize>

Calls C++ function: QSize QLayout::totalMaximumSize() const.

pub unsafe fn total_minimum_size(&self) -> CppBox<QSize>

Calls C++ function: QSize QLayout::totalMinimumSize() const.

pub unsafe fn total_size_hint(&self) -> CppBox<QSize>

Calls C++ function: QSize QLayout::totalSizeHint() const.

pub unsafe fn update(&self)

Updates the layout for parentWidget().

Calls C++ function: void QLayout::update().

C++ documentation:

Updates the layout for parentWidget().

You should generally not need to call this because it is automatically called at the most appropriate times.

See also activate() and invalidate().

Trait Implementations

impl CppDeletable for QFormLayout

unsafe fn delete(&self)

Destroys the form layout.

Calls C++ function: virtual [destructor] void QFormLayout::~QFormLayout().

C++ documentation:

Destroys the form layout.

impl Deref for QFormLayout

type Target = QLayout

The resulting type after dereferencing.

fn deref(&self) -> &QLayout

Calls C++ function: QLayout* static_cast<QLayout*>(QFormLayout* ptr).

impl DynamicCast<QFormLayout> for QLayout

unsafe fn dynamic_cast(ptr: Ptr<QLayout>) -> Ptr<QFormLayout>

Calls C++ function: QFormLayout* dynamic_cast<QFormLayout*>(QLayout* ptr).

impl DynamicCast<QFormLayout> for QObject

unsafe fn dynamic_cast(ptr: Ptr<QObject>) -> Ptr<QFormLayout>

Calls C++ function: QFormLayout* dynamic_cast<QFormLayout*>(QObject* ptr).

impl DynamicCast<QFormLayout> for QLayoutItem

unsafe fn dynamic_cast(ptr: Ptr<QLayoutItem>) -> Ptr<QFormLayout>

Calls C++ function: QFormLayout* dynamic_cast<QFormLayout*>(QLayoutItem* ptr).

impl StaticDowncast<QFormLayout> for QLayout

unsafe fn static_downcast(ptr: Ptr<QLayout>) -> Ptr<QFormLayout>

Calls C++ function: QFormLayout* static_cast<QFormLayout*>(QLayout* ptr).

impl StaticDowncast<QFormLayout> for QObject

unsafe fn static_downcast(ptr: Ptr<QObject>) -> Ptr<QFormLayout>

Calls C++ function: QFormLayout* static_cast<QFormLayout*>(QObject* ptr).

impl StaticDowncast<QFormLayout> for QLayoutItem

unsafe fn static_downcast(ptr: Ptr<QLayoutItem>) -> Ptr<QFormLayout>

Calls C++ function: QFormLayout* static_cast<QFormLayout*>(QLayoutItem* ptr).

impl StaticUpcast<QLayout> for QFormLayout

unsafe fn static_upcast(ptr: Ptr<QFormLayout>) -> Ptr<QLayout>

Calls C++ function: QLayout* static_cast<QLayout*>(QFormLayout* ptr).

impl StaticUpcast<QLayoutItem> for QFormLayout

unsafe fn static_upcast(ptr: Ptr<QFormLayout>) -> Ptr<QLayoutItem>

Calls C++ function: QLayoutItem* static_cast<QLayoutItem*>(QFormLayout* ptr).

impl StaticUpcast<QObject> for QFormLayout

unsafe fn static_upcast(ptr: Ptr<QFormLayout>) -> Ptr<QObject>

Calls C++ function: QObject* static_cast<QObject*>(QFormLayout* ptr).