Spec-Zone.ru › Qt 5.13

Класс QBoxLayout

Класс QBoxLayout выстраивает дочерние виджеты горизонтально или вертикально. Подробнее...

Заголовок: #include <QBoxLayout>
qmake: QT += widgets
Наследуется от: QLayout
Наследует:

QHBoxLayout и QVBoxLayout

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

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

перечисление Direction { LeftToRight, RightToLeft, TopToBottom, BottomToTop }

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

QBoxLayout(QBoxLayout::Direction dir, QWidget *parent = nullptr)
виртуальный ~QBoxLayout()
void addLayout(QLayout *layout, int stretch = 0)
void addSpacerItem(QSpacerItem *spacerItem)
void addSpacing(int size)
void addStretch(int stretch = 0)
void addStrut(int size)
void addWidget(QWidget *widget, int stretch = 0, Qt::Alignment alignment = Qt::Alignment())
QBoxLayout::Direction direction() const
void insertItem(int index, QLayoutItem *item)
void insertLayout(int index, QLayout *layout, int stretch = 0)
void insertSpacerItem(int index, QSpacerItem *spacerItem)
void insertSpacing(int index, int size)
void insertStretch(int index, int stretch = 0)
void insertWidget(int index, QWidget *widget, int stretch = 0, Qt::Alignment alignment = Qt::Alignment())
void setDirection(QBoxLayout::Direction direction)
void setSpacing(int spacing)
void setStretch(int index, int stretch)
bool setStretchFactor(QWidget *widget, int stretch)
bool setStretchFactor(QLayout *layout, int stretch)
int spacing() const
int stretch(int index) const

Переопределённые открытые функции

виртуальный void addItem(QLayoutItem *item) override
виртуальный int count() const override
виртуальный Qt::Orientations expandingDirections() const override
виртуальный bool hasHeightForWidth() const override
виртуальный int heightForWidth(int w) const override
виртуальный void invalidate() override
виртуальный QLayoutItem * itemAt(int index) const override
виртуальный QSize maximumSize() const override
виртуальный int minimumHeightForWidth(int w) const override
виртуальный QSize minimumSize() const override
виртуальный void setGeometry(const QRect &r) override
виртуальный QSize sizeHint() const override
виртуальный QLayoutItem * takeAt(int index) override

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

QBoxLayout занимает всё предоставленное ему пространство (от родительского макета или из parentWidget()), делит его на ряд ячеек и размещает каждый управляемый виджет в отдельной ячейке.

Horizontal box layout with five child widgets

Если ориентация QBoxLayout — Qt::Horizontal, ячейки располагаются в ряд с подходящими размерами. Каждый виджет (или другая ячейка) получит как минимум свой минимальный размер и как максимум — свой максимальный размер. Любое оставшееся пространство делится в соответствии с коэффициентами растяжения (подробнее об этом ниже).

Vertical box layout with five child widgets

Если ориентация QBoxLayout — Qt::Vertical, ячейки располагаются в колонку, также с подходящими размерами.

Самый простой способ создать QBoxLayout — использовать один из вспомогательных классов, например, QHBoxLayout (для ячеек Qt::Horizontal) или QVBoxLayout (для ячеек Qt::Vertical). Также можно напрямую использовать конструктор QBoxLayout, указав направление как LeftToRight, RightToLeft, TopToBottom или BottomToTop.

Если QBoxLayout не является верхним макетом (т.е. он не управляет всей областью виджета и его дочерними элементами), вы должны добавить его в родительский макет, прежде чем что-либо делать с ним. Обычный способ добавить макет — вызвав parentLayout->addLayout().

После этого вы можете добавлять ячейки в QBoxLayout используя одну из четырёх функций:

  • addWidget() для добавления виджета в QBoxLayout и установки коэффициента растяжения виджета. (Коэффициент растяжения относится к ряду ячеек.)
  • addSpacing() для создания пустой ячейки; эта функция используется для создания диалогов с красивыми и просторными отступами. Способы установки отступов см. ниже.
  • addStretch() для создания пустой, растягиваемой ячейки.
  • addLayout() для добавления ячейки, содержащей другой QLayout, в ряд и установки коэффициента растяжения этого макета.

Используйте insertWidget(), insertSpacing(), insertStretch() или insertLayout(), чтобы вставить ячейку в заданную позицию макета.

QBoxLayout также включает две ширины отступов:

  • setContentsMargins() устанавливает ширину внешней границы с каждой стороны виджета. Это ширина зарезервированного пространства вдоль каждой из четырёх сторон QBoxLayout.
  • setSpacing() устанавливает ширину между соседними блоками. (Можно использовать addSpacing() для получения большего пространства в определённом месте.)

Поля по умолчанию задаются стилем. По умолчанию большинство стилей Qt устанавливают поля 9 для дочерних виджетов и 11 для окон. Отступы по умолчанию равны ширине полей для компоновки верхнего уровня или равны полям родительской компоновки.

Чтобы удалить виджет из компоновки, вызовите removeWidget(). Вызов QWidget::hide() для виджета также эффективно удаляет виджет из компоновки до вызова QWidget::show().

Почти всегда лучше использовать QVBoxLayout и QHBoxLayout, а не QBoxLayout, из-за удобства их конструкторов.

См. также QGridLayout, QStackedLayout и Управление компоновкой.

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

enum QBoxLayout::Direction

Этот тип используется для определения направления компоновки блока.

Константа Значение Описание
QBoxLayout::LeftToRight 0 Горизонтально слева направо.
QBoxLayout::RightToLeft 1 Горизонтально справа налево.
QBoxLayout::TopToBottom 2 Вертикально сверху вниз.
QBoxLayout::BottomToTop 3 Вертикально снизу вверх.

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

QBoxLayout::QBoxLayout(QBoxLayout::Direction dir, QWidget *parent = nullptr)

Создаёт новый QBoxLayout с направлением dir и родительским виджетом parent.

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

[virtual] QBoxLayout::~QBoxLayout()

Уничтожает эту компоновку блока.

Виджеты компоновки не уничтожаются.

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

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

void QBoxLayout::addLayout(QLayout *layout, int stretch = 0)

Добавляет layout в конец блока с коэффициентом растяжения stretch.

См. также insertLayout(), addItem() и addWidget().

void QBoxLayout::addSpacerItem(QSpacerItem *spacerItem)

Добавляет spacerItem в конец этой компоновки блока.

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

См. также addSpacing() и addStretch().

void QBoxLayout::addSpacing(int size)

Добавляет непротягиваемое пространство (a QSpacerItem) размером size в конец этой компоновки блока. QBoxLayout предоставляет поля и отступы по умолчанию. Эта функция добавляет дополнительное пространство.

См. также insertSpacing(), addItem() и QSpacerItem.

void QBoxLayout::addStretch(int stretch = 0)

Добавляет растягиваемое пространство (a QSpacerItem) с минимальным размером ноль и коэффициентом растяжения stretch в конец этой компоновки блока.

См. также insertStretch(), addItem() и QSpacerItem.

void QBoxLayout::addStrut(int size)

Ограничивает перпендикулярную размерность блока (например, высоту, если блок имеет направление LeftToRight) до минимума size. Другие ограничения могут увеличить эту величину.

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

void QBoxLayout::addWidget(QWidget *widget, int stretch = 0, Qt::Alignment alignment = Qt::Alignment())

Добавляет widget в конец этой компоновки блока с коэффициентом растяжения stretch и выравниванием alignment.

Коэффициент растяжения применяется только в направлении direction QBoxLayout, и он относителен к другим блокам и виджетам в этом QBoxLayout. Виджеты и блоки с более высокими коэффициентами растяжения растут больше.

Если коэффициент растяжения равен 0, и ничего больше в QBoxLayout не имеет коэффициента растяжения больше нуля, пространство распределяется в соответствии с QWidget:sizePolicy() каждого участвующего виджета.

Выравнивание задаётся параметром alignment. По умолчанию выравнивание 0, что означает, что виджет заполняет всю ячейку.

См. также insertWidget(), addItem(), addLayout(), addStretch(), addSpacing() и addStrut().

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

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

QBoxLayout::Direction QBoxLayout::direction() const

Возвращает направление блока. addWidget() и addSpacing() работают в этом направлении; растяжение растягивается в этом направлении.

См. также setDirection(), QBoxLayout::Direction, addWidget() и addSpacing().

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

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

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

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

[override virtual] int QBoxLayout::heightForWidth(int w) const

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

void QBoxLayout::insertItem(int index, QLayoutItem *item)

Вставляет item в эту компоновку блока в позиции index. Если index отрицательный, элемент добавляется в конец.

См. также addItem(), insertWidget(), insertLayout(), insertStretch() и insertSpacing().

void QBoxLayout::insertLayout(int index, QLayout *layout, int stretch = 0)

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

layout становится дочерним элементом компоновки блока.

См. также addLayout() и insertItem().

void QBoxLayout::insertSpacerItem(int index, QSpacerItem *spacerItem)

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

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

См. также addSpacerItem(), insertStretch() и insertSpacing().

void QBoxLayout::insertSpacing(int index, int size)

Вставляет непротягиваемое пространство (a QSpacerItem) в позицию index размером size. Если index отрицательный, пространство добавляется в конец.

Компоновка блока имеет поля и отступы по умолчанию. Эта функция добавляет дополнительное пространство.

См. также addSpacing(), insertItem() и QSpacerItem.

void QBoxLayout::insertStretch(int index, int stretch = 0)

Вставляет растяжимое пространство (объект QSpacerItem) в позицию index с нулевым минимальным размером и коэффициентом растяжения stretch. Если index отрицателен, пространство добавляется в конец.

См. также addStretch(), insertItem(), и QSpacerItem.

void QBoxLayout::insertWidget(int index, QWidget *widget, int stretch = 0, Qt::Alignment alignment = Qt::Alignment())

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

Коэффициент растяжения применяется только в направлении direction QBoxLayout и относится к другим ящикам и виджетам в этом QBoxLayout. Виджеты и ящики с более высокими коэффициентами растяжения растут больше.

Если коэффициент растяжения равен 0, и ничто другое в QBoxLayout не имеет коэффициента растяжения больше нуля, пространство распределяется в соответствии с QWidget:sizePolicy() каждого участвующего виджета.

Выравнивание задаётся параметром alignment. Значение по умолчанию 0 означает, что виджет заполняет всю ячейку.

См. также addWidget() и insertItem().

[override virtual] void QBoxLayout::invalidate()

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

Сбрасывает кешированную информацию.

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

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

[override virtual] QSize QBoxLayout::maximumSize() const

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

[override virtual] int QBoxLayout::minimumHeightForWidth(int w) const

Переопределяет: QLayoutItem::minimumHeightForWidth(int w) const.

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

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

void QBoxLayout::setDirection(QBoxLayout::Direction direction)

Устанавливает направление этого макета на direction.

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

[override virtual] void QBoxLayout::setGeometry(const QRect &r)

Переопределяет: QLayout::setGeometry(const QRect &r).

void QBoxLayout::setSpacing(int spacing)

Переопределяет QLayout::setSpacing(). Устанавливает свойство отступа в spacing.

См. также QLayout::setSpacing() и spacing().

void QBoxLayout::setStretch(int index, int stretch)

Устанавливает коэффициент растяжения в позиции index в stretch.

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

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

bool QBoxLayout::setStretchFactor(QWidget *widget, int stretch)

Устанавливает коэффициент растяжения для widget в stretch и возвращает true, если widget найден в этом макете (не включая дочерние макеты); иначе возвращает false.

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

bool QBoxLayout::setStretchFactor(QLayout *layout, int stretch)

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

Устанавливает коэффициент растяжения для макета layout в stretch и возвращает true, если layout найден в этом макете (не включая дочерние макеты); иначе возвращает false.

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

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

int QBoxLayout::spacing() const

Переопределяет QLayout::spacing(). Если свойство отступа имеет значение, возвращается это значение. Иначе вычисляется значение свойства отступа и возвращается. Поскольку отступ макета в виджете зависит от стиля, если родительский элемент является виджетом, запрашивается стиль для (горизонтального или вертикального) отступа макета. В противном случае родительский элемент — это макет, и запрашивается отступ родительского макета spacing().

См. также QLayout::spacing() и setSpacing().

int QBoxLayout::stretch(int index) const

Возвращает коэффициент растяжения в позиции index.

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

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

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

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

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.13/qboxlayout.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API