Класс QFormLayout

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

Этот класс был представлен в Qt 4.4.

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

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

Свойства

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

Реализованные публичные функции

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

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.

См. также 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's 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 не имеет формы 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.

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

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

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() или setWidget() вместо этого.

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

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

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

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

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

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

void QFormLayout::setSpacing(int spacing)

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

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

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

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

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

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

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

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

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

int QFormLayout::spacing() const

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

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

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

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

QFormLayout::TakeRowResult QFormLayout::takeRow(int row)

Удаляет указанную строку 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().

QFormLayout::TakeRowResult QFormLayout::takeRow(QWidget *widget)

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

Удаляет указанный 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().

QFormLayout::TakeRowResult QFormLayout::takeRow(QLayout *layout)

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

Удаляет указанный 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().