Spec-Zone.ru › Qt 6.1

Класс QBoxLayout

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

Заголовок: #include <QBoxLayout>
CMake: find_package(Qt6 COMPONENTS Widgets REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::Widgets)
qmake: QT += widgets
Наследует: QLayout
Наследуется:

QHBoxLayout и QVBoxLayout

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

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

enum Direction { LeftToRight, RightToLeft, TopToBottom, BottomToTop }

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

QBoxLayout(QBoxLayout::Direction dir, QWidget *parent = nullptr)
virtual ~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 setStretch(int index, int stretch)
bool setStretchFactor(QWidget *widget, int stretch)
bool setStretchFactor(QLayout *layout, int stretch)
int stretch(int index) const

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

virtual void addItem(QLayoutItem *item) override
virtual int count() const override
virtual Qt::Orientations expandingDirections() const override
virtual bool hasHeightForWidth() const override
virtual int heightForWidth(int w) const override
virtual void invalidate() override
virtual QLayoutItem * itemAt(int index) const override
virtual QSize maximumSize() const override
virtual int minimumHeightForWidth(int w) const override
virtual QSize minimumSize() const override
virtual void setGeometry(const QRect &r) override
virtual void setSpacing(int spacing) override
virtual QSize sizeHint() const override
virtual int spacing() const override
virtual QLayoutItem * takeAt(int index) override

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

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

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

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

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

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.

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

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

[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 в конец этого макета коробки.

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

void QBoxLayout::addSpacing(int size)

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

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

void QBoxLayout::addStretch(int stretch = 0)

Добавляет растяжимое пространство (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 отрицательный, пространство добавляется в конец.

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

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

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

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

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

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

Вставляет растяжимое пространство (a 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).

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

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

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

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

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

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

См. также 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.

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

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

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

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

int QBoxLayout::stretch(int index) const

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

См. также 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-6.1/qboxlayout.html

Spec-Zone.ru

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