Класс QFormLayout

Класс QFormLayout управляет формами виджетов ввода и их соответствующими метками. Подробнее...

• Список всех членов, включая унаследованные

Открытые типы

Свойства

Открытые функции

Реализованные открытые функции

Подробное описание

QFormLayout — это вспомогательный класс макета, который выстраивает свои дочерние элементы в форме с двумя колонками. Левая колонка содержит метки, а правая — виджеты «поля» (линейные редакторы, спин-боксы и т. д.).

Традиционно такие макеты форм с двумя колонками создавались с помощью QGridLayout. QFormLayout — это альтернатива более высокого уровня, которая предоставляет следующие преимущества:

• Соответствие рекомендациям по внешнему виду различных платформ.

  Например, рекомендации macOS Aqua и KDE указывают, что метки должны выравниваться справа, в то время как приложения Windows и GNOME обычно используют выравнивание слева.

• Поддержка переноса длинных строк.

  Для устройств с небольшими экранами QFormLayout можно настроить на перенос длинных строк, или даже на перенос всех строк.

• Удобный API для создания пар метка-поле.

  Перегрузка метода addRow(), принимающая QString и QWidget *, создает QLabel за кулисами и автоматически настраивает его партнера. Затем мы можем написать код, подобный этому:

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

  Сравните это с кодом, написанным с помощью 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);

В таблице ниже показан вид по умолчанию в разных стилях.

QCommonStyle производные стили (кроме QPlastiqueStyle)	QMacStyle	QPlastiqueStyle	Расширенные стили Qt
Традиционный стиль, используемый для Windows, GNOME и более ранних версий KDE. Метки выравниваются слева, а расширяющиеся поля увеличиваются, чтобы заполнить доступное пространство. (Это обычно соответствует тому, что мы получим, используя двуколоночный QGridLayout.)	Стиль, основанный на рекомендациях macOS Aqua. Метки выравниваются справа, поля не расширяются за пределы своего размера, а форма центрируется по горизонтали.	Рекомендованный стиль для приложений KDE. Похож на MacStyle, за исключением того, что форма выравнивается по левому краю, а все поля расширяются, чтобы заполнить доступное пространство.	Стиль по умолчанию для расширенных стилей Qt. Метки выравниваются справа, расширяющиеся поля занимают доступное пространство, а перенос строк включен для длинных строк.

Стиль формы также можно переопределить индивидуально, вызвав setLabelAlignment(), setFormAlignment(), setFieldGrowthPolicy() и setRowWrapPolicy(). Например, чтобы смоделировать внешний вид макета формы QMacStyle на всех платформах, но с метками, выровненными по левому краю, можно написать:

formLayout->setRowWrapPolicy(QFormLayout::DontWrapRows);
formLayout->setFieldGrowthPolicy(QFormLayout::FieldsStayAtSizeHint);
formLayout->setFormAlignment(Qt::AlignHCenter | Qt::AlignTop);
formLayout->setLabelAlignment(Qt::AlignLeft);

См. также QGridLayout, QBoxLayout и QStackedLayout.

Документация по типам членов

перечисление QFormLayout::FieldGrowthPolicy

Это перечисление определяет различные политики, которые могут использоваться для управления способом расширения полей формы.

См. также fieldGrowthPolicy.

перечисление QFormLayout::ItemRole

Это перечисление определяет типы виджетов (или других элементов макета), которые могут появляться в строке.

См. также itemAt() и getItemPosition().

перечисление QFormLayout::RowWrapPolicy

Это перечисление определяет различные политики, которые могут использоваться для управления тем, как переносятся строки формы.

См. также rowWrapPolicy.

Документация по членам-функциям

QFormLayout::QFormLayout(QWidget *parent = nullptr)

Создаёт новый макет формы с заданным виджетом parent.

Макет устанавливается непосредственно как основной макет для parent. Для виджета может быть только один основной макет. Он возвращается методом QWidget::layout().

См. также QWidget::setLayout().

[virtual] QFormLayout::~QFormLayout()

Уничтожает макет формы.

[override virtual] void QFormLayout::addItem(QLayoutItem *item)

Переопределяет: QLayout::addItem(QLayoutItem *item).

void QFormLayout::addRow(QWidget *label, QWidget *field)

Добавляет новую строку в конец этого макета формы с заданной меткой и полем.

См. также insertRow().

void QFormLayout::addRow(QWidget *label, QLayout *field)

Это перегруженная функция.

void QFormLayout::addRow(const QString &labelText, QWidget *field)

Это перегруженная функция.

Этот перегруз автоматически создаёт QLabel со значением labelText в качестве текста. field устанавливается в качестве «помощника» QLabel с помощью buddy.

void QFormLayout::addRow(const QString &labelText, QLayout *field)

Это перегруженная функция.

Этот перегруз автоматически создаёт QLabel со значением labelText в качестве текста.

void QFormLayout::addRow(QWidget *widget)

Это перегруженная функция.

Добавляет указанный widget в конец этого макета формы. widget занимает оба столбца.

void QFormLayout::addRow(QLayout *layout)

Это перегруженная функция.

Добавляет указанный layout в конец этого макета формы. layout занимает оба столбца.

[override virtual] int QFormLayout::count() const

Переопределяет: QLayout::count() const.

[override virtual] Qt::Orientations QFormLayout::expandingDirections() const

Переопределяет: QLayout::expandingDirections() const.

void QFormLayout::getItemPosition(int index, int *rowPtr, QFormLayout::ItemRole *rolePtr) const

Получает строку и роль (столбец) элемента по заданному индексу. Если индекс выходит за пределы, *rowPtr устанавливается в -1; в противном случае строка сохраняется в *rowPtr, а роль — в *rolePtr.

См. также itemAt(), count(), getLayoutPosition() и getWidgetPosition().

void QFormLayout::getLayoutPosition(QLayout *layout, int *rowPtr, QFormLayout::ItemRole *rolePtr) const

Возвращает строку и роль (столбец) указанного дочернего layout. Если layout не находится в форме, *rowPtr устанавливается в -1; в противном случае строка сохраняется в *rowPtr, а роль — в *rolePtr.

void QFormLayout::getWidgetPosition(QWidget *widget, int *rowPtr, QFormLayout::ItemRole *rolePtr) const

Возвращает строку и роль (столбец) указанного widget в макете. Если widget не находится в макете, *rowPtr устанавливается в -1; в противном случае строка сохраняется в *rowPtr, а роль — в *rolePtr.

См. также getItemPosition() и itemAt().

[override virtual] bool QFormLayout::hasHeightForWidth() const

Реализует: QLayoutItem::hasHeightForWidth() const.

[override virtual] int QFormLayout::heightForWidth(int width) const

Реализует: QLayoutItem::heightForWidth(int) const.

void QFormLayout::insertRow(int row, QWidget *label, QWidget *field)

Вставляет новую строку в позицию row в этом макете формы с заданным label и field. Если row выходит за пределы, новая строка добавляется в конец.

См. также addRow().

void QFormLayout::insertRow(int row, QWidget *label, QLayout *field)

Это перегруженный метод.

void QFormLayout::insertRow(int row, const QString &labelText, QWidget *field)

Это перегруженный метод.

Этот перегруз автоматически создаёт QLabel за кулисами с labelText в качестве текста. field устанавливается как новый QLabel‘s buddy.

void QFormLayout::insertRow(int row, const QString &labelText, QLayout *field)

Это перегруженный метод.

Этот перегруз автоматически создаёт QLabel за кулисами с labelText в качестве текста.

void QFormLayout::insertRow(int row, QWidget *widget)

Это перегруженный метод.

Вставляет указанный widget в позицию row в этом макете формы. widget занимает оба столбца. Если row выходит за пределы, виджет добавляется в конец.

void QFormLayout::insertRow(int row, QLayout *layout)

Это перегруженный метод.

Вставляет указанный layout в позицию row в этом макете формы. layout занимает оба столбца. Если row выходит за пределы, виджет добавляется в конец.

[override virtual] void QFormLayout::invalidate()

Реализует: QLayout::invalidate().

QLayoutItem *QFormLayout::itemAt(int row, QFormLayout::ItemRole role) const

Возвращает элемент макета в заданной row с заданной role (столбец). Возвращает nullptr если такого элемента нет.

См. также QLayout::itemAt() и setItem().

[override virtual] QLayoutItem *QFormLayout::itemAt(int index) const

Реализует: QLayout::itemAt(int index) const.

QWidget *QFormLayout::labelForField(QWidget *field) const

Возвращает метку, связанную с заданным field.

См. также itemAt().

QWidget *QFormLayout::labelForField(QLayout *field) const

Это перегруженный метод.

[override virtual] QSize QFormLayout::minimumSize() const

Реализует: QLayout::minimumSize() const.

[since 5.8] void QFormLayout::removeRow(int row)

Удаляет строку row из этого макета формы.

row должен быть неотрицательным и меньше rowCount().

После этого вызова rowCount() уменьшается на единицу. Все виджеты и вложенные макеты, которые занимали эту строку, удаляются. Включая виджет(ы) поля и метку, если таковая имеется. Все последующие строки сдвигаются вверх на одну строку, и освобожденное вертикальное пространство перераспределяется между оставшимися строками.

Вы можете использовать эту функцию для отмены предыдущего addRow() или insertRow():

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

Если вы хотите удалить строку из макета без удаления виджетов, используйте takeRow() вместо этого.

Эта функция была добавлена в Qt 5.8.

См. также takeRow().

[since 5.8] void QFormLayout::removeRow(QWidget *widget)

Это перегруженный метод.

Удаляет строку, соответствующую widget, из этого макета формы.

После этого вызова rowCount() уменьшается на единицу. Все виджеты и вложенные макеты, которые занимали эту строку, удаляются. Включая виджет(ы) поля и метку, если таковая имеется. Все последующие строки сдвигаются вверх на одну строку, и освобожденное вертикальное пространство перераспределяется между оставшимися строками.

Вы можете использовать эту функцию для отмены предыдущего addRow() или insertRow():

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

Если вы хотите удалить строку из макета без удаления виджетов, используйте takeRow() вместо этого.

Эта функция была добавлена в Qt 5.8.

См. также takeRow().

[since 5.8] void QFormLayout::removeRow(QLayout *layout)

Это перегруженный метод.

Удаляет строку, соответствующую layout, из этого макета формы.

После этого вызова rowCount() уменьшается на единицу. Все виджеты и вложенные макеты, которые занимали эту строку, удаляются. Включая виджет(ы) поля и метку, если таковая имеется. Все последующие строки сдвигаются вверх на одну строку, и освобожденное вертикальное пространство перераспределяется между оставшимися строками.

Вы можете использовать эту функцию для отмены предыдущего addRow() или insertRow():

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

Если вы хотите удалить строку из макета формы без удаления вставленного макета, используйте takeRow() вместо этого.

Эта функция была добавлена в Qt 5.8.

См. также takeRow().

int QFormLayout::rowCount() const

Возвращает количество строк в форме.

См. также QLayout::count().

[override virtual] void QFormLayout::setGeometry(const QRect &rect)

Реализует: QLayout::setGeometry(const QRect &r).

void QFormLayout::setItem(int row, QFormLayout::ItemRole role, QLayoutItem *item)

Устанавливает элемент в заданной row для заданной role на item, расширяя макет пустыми строками при необходимости.

Если ячейка уже занята, item не вставляется, и сообщение об ошибке отправляется в консоль. item занимает оба столбца.

См. также setLayout().

void QFormLayout::setLayout(int row, QFormLayout::ItemRole role, QLayout *layout)

Устанавливает подрасположение в заданной строке для заданной роли в расположение, расширяя расположение формы пустыми строками при необходимости.

Если ячейка уже занята, расположение не вставляется, и сообщение об ошибке отправляется в консоль.

Примечание: Для большинства приложений следует использовать addRow() или insertRow() вместо setLayout().

См. также setWidget().

[override virtual] void QFormLayout::setSpacing(int spacing)

Переопределяет функцию доступа к свойству: QLayout::spacing.

Эта функция устанавливает вертикальный и горизонтальный отступы в spacing.

См. также spacing(), setVerticalSpacing() и setHorizontalSpacing().

void QFormLayout::setWidget(int row, QFormLayout::ItemRole role, QWidget *widget)

Устанавливает виджет в заданной строке для заданной роли в widget, расширяя расположение пустыми строками при необходимости.

Если ячейка уже занята, widget не вставляется, и сообщение об ошибке отправляется в консоль.

Примечание: Для большинства приложений следует использовать addRow() или insertRow() вместо setWidget().

См. также setLayout().

[override virtual] QSize QFormLayout::sizeHint() const

Переопределяет: QLayoutItem::sizeHint() const.

[override virtual] int QFormLayout::spacing() const

Переопределяет функцию доступа к свойству: QLayout::spacing.

Если вертикальный отступ равен горизонтальному отступу, эта функция возвращает это значение; в противном случае она возвращает -1.

См. также setSpacing(), verticalSpacing() и horizontalSpacing().

[override virtual] QLayoutItem *QFormLayout::takeAt(int index)

Переопределяет: QLayout::takeAt(int index).

[since 5.8] QFormLayout::TakeRowResult QFormLayout::takeRow(int row)

Удаляет указанную строку из этого макета формы.

row должно быть неотрицательным и меньше rowCount().

После этого вызова rowCount() уменьшается на единицу. Все последующие строки смещаются вверх на одну строку, и освободившееся вертикальное пространство перераспределяется между оставшимися строками.

Вы можете использовать эту функцию для отмены предыдущего вызова addRow() или insertRow():

QFormLayout *flay = ...;
QPointer<QLineEdit> le = new QLineEdit;
flay->insertRow(2, "User:", le);
// later:
QFormLayout::TakeRowResult result = flay->takeRow(2);

Если вы хотите удалить строку из макета и удалить виджеты, используйте removeRow() вместо этого.

Возвращает структуру, содержащую как виджет, так и соответствующие элементы макета метки.

Эта функция была введена в Qt 5.8.

См. также removeRow().

[since 5.8] QFormLayout::TakeRowResult QFormLayout::takeRow(QWidget *widget)

Это перегруженная функция.

Удаляет указанный виджет из этого макета формы.

После этого вызова rowCount() уменьшается на единицу. Все последующие строки смещаются вверх на одну строку, и освободившееся вертикальное пространство перераспределяется между оставшимися строками.

QFormLayout *flay = ...;
QPointer<QLineEdit> le = new QLineEdit;
flay->insertRow(2, "User:", le);
// later:
QFormLayout::TakeRowResult result = flay->takeRow(widget);

Если вы хотите удалить строку из макета и удалить виджеты, используйте removeRow() вместо этого.

Возвращает структуру, содержащую как виджет, так и соответствующие элементы макета метки.

Эта функция была введена в Qt 5.8.

См. также removeRow().

[since 5.8] QFormLayout::TakeRowResult QFormLayout::takeRow(QLayout *layout)

Это перегруженная функция.

Удаляет указанный макет из этого макета формы.

После этого вызова rowCount() уменьшается на единицу. Все последующие строки смещаются вверх на одну строку, и освободившееся вертикальное пространство перераспределяется между оставшимися строками.

QFormLayout *flay = ...;
QPointer<QVBoxLayout> vbl = new QVBoxLayout;
flay->insertRow(2, "User:", vbl);
// later:
QFormLayout::TakeRowResult result = flay->takeRow(widget);

Если вы хотите удалить строку из макета формы и удалить вставленный макет, используйте removeRow() вместо этого.

Возвращает структуру, содержащую как виджет, так и соответствующие элементы макета метки.

Эта функция была введена в Qt 5.8.

См. также removeRow().