Класс QTabWidget

Класс QTabWidget предоставляет стопку вкладок. Подробнее...

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

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

Свойства

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

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

Public Slots

Signals

Protected Functions

Reimplemented Protected Functions

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

Виджет вкладок предоставляет панель вкладок (см. QTabBar) и область "страниц", которая используется для отображения страниц, связанных с каждой вкладкой. По умолчанию панель вкладок отображается над областью страниц, но доступны различные конфигурации (см. TabPosition). Каждая вкладка связана с другим виджетом (называемым страницей). Только текущая страница отображается в области страниц; все остальные страницы скрыты. Пользователь может отобразить другую страницу, нажав на её вкладку или нажав сочетание клавиш Alt+буква, если оно есть.

Обычный способ использования QTabWidget заключается в следующем:

1. Создать QTabWidget.
2. Создать QWidget для каждой страницы в диалоге вкладок, но не указывать родительские виджеты для них.
3. Вставить дочерние виджеты в виджет страницы, используя макеты для их позиционирования как обычно.
4. Вызвать addTab() или insertTab() для размещения виджетов страниц в виджете вкладок, присвоив каждой вкладке подходящее имя с необязательной комбинацией клавиш.

Позиция вкладок определяется свойством tabPosition, их форма — свойством tabShape.

Сигнал currentChanged() генерируется при выборе пользователем страницы.

Индекс текущей страницы доступен как currentIndex(), а текущий виджет страницы — как currentWidget(). Вы можете получить указатель на виджет страницы с заданным индексом с помощью widget(), а позицию индекса виджета найти с помощью indexOf(). Используйте setCurrentWidget() или setCurrentIndex() для отображения конкретной страницы.

Вы можете изменить текст и значок вкладки с помощью setTabText() или setTabIcon(). Вкладку и её связанную страницу можно удалить с помощью removeTab().

Каждая вкладка может быть включена или выключена в любой момент (см. setTabEnabled()). Если вкладка включена, текст вкладки отображается нормально, и пользователь может выбрать эту вкладку. Если она выключена, вкладка отображается по-другому, и пользователь не может выбрать эту вкладку. Обратите внимание, что даже если вкладка выключена, страница может по-прежнему быть видимой, например, если все вкладки отключены.

Виджеты вкладок могут быть очень полезным способом разделения сложного диалога. Альтернативой является использование QStackedWidget, для которого вам необходимо предоставить способ перемещения между страницами, например, QToolBar или QListWidget.

Большая часть функциональности в QTabWidget предоставляется QTabBar (вверху, предоставляющий вкладки) и QStackedWidget (большая часть области, организующая отдельные страницы).

См. также QTabBar, QStackedWidget, QToolBox и Пример диалога вкладок.

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

перечисление QTabWidget::TabPosition

Это перечисление определяет, где QTabWidget рисует строку вкладок:

перечисление QTabWidget::TabShape

Это перечисление определяет форму вкладок:

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

QTabWidget::QTabWidget(QWidget *parent = nullptr)

Создаёт виджет с вкладками с родителем parent.

[signal] void QTabWidget::currentChanged(int index)

Этот сигнал излучается всякий раз, когда изменяется индекс текущей страницы. Параметр — новый индекс текущей страницы index, или -1, если его нет (например, если в QTabWidget нет виджетов).

Примечание: Сигнал уведомления для свойства currentIndex.

См. также currentWidget() и currentIndex.

[slot] void QTabWidget::setCurrentWidget(QWidget *widget)

Устанавливает widget в качестве текущего виджета. Используемый widget должен быть страницей в этом виджете вкладок.

См. также addTab(), setCurrentIndex() и currentWidget().

[signal, since 5.2] void QTabWidget::tabBarClicked(int index)

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

index ссылается на нажатую вкладку или -1, если под курсором нет вкладки.

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

[signal, since 5.2] void QTabWidget::tabBarDoubleClicked(int index)

Этот сигнал излучается, когда пользователь дважды щелкает по вкладке по индексу index.

index — индекс нажатой вкладки, или -1, если под курсором нет вкладки.

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

[signal] void QTabWidget::tabCloseRequested(int index)

Этот сигнал испускается, когда нажата кнопка закрытия вкладки. Переменная index содержит индекс вкладки, которую нужно удалить.

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

[virtual] QTabWidget::~QTabWidget()

Удаляет виджет с вкладками.

int QTabWidget::addTab(QWidget *page, const QString &label)

Добавляет вкладку с заданным page и label в виджет с вкладками и возвращает индекс вкладки в панели вкладок. Владение page передаётся QTabWidget.

Если label вкладки содержит амперсанд, то буква, следующая за амперсандом, используется в качестве сочетания клавиш для вкладки, например, если label — "Bro&wse", то Alt+W станет сочетанием клавиш для перехода на эту вкладку.

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

int QTabWidget::addTab(QWidget *page, const QIcon &icon, const QString &label)

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

Добавляет вкладку с заданным page, icon и label в виджет с вкладками и возвращает индекс вкладки в панели вкладок. Владение page передаётся QTabWidget.

Эта функция аналогична addTab(), но с дополнительным параметром icon.

[override virtual protected] void QTabWidget::changeEvent(QEvent *ev)

Переопределяет: QWidget::changeEvent(QEvent *event).

void QTabWidget::clear()

Удаляет все страницы, но не удаляет их. Вызов этой функции эквивалентен вызову removeTab() до тех пор, пока виджет с вкладками не станет пустым.

QWidget *QTabWidget::cornerWidget(Qt::Corner corner = Qt::TopRightCorner) const

Возвращает виджет, отображаемый в corner углу виджета с вкладками или nullptr.

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

QWidget *QTabWidget::currentWidget() const

Возвращает указатель на страницу, которая в данный момент отображается в диалоге вкладок. Диалог вкладок делает всё возможное, чтобы это значение никогда не было 0 (но если постараться, то оно может быть).

См. также currentIndex() и setCurrentWidget().

[override virtual protected] bool QTabWidget::event(QEvent *ev)

Переопределяет: QWidget::event(QEvent *event).

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

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

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

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

int QTabWidget::indexOf(const QWidget *w) const

Возвращает индекс страницы, занятой виджетом w, или -1, если виджет не найден.

[virtual protected] void QTabWidget::initStyleOption(QStyleOptionTabWidgetFrame *option) const

Инициализирует option значениями из этого QTabWidget. Этот метод полезен для подклассов, когда им нужен QStyleOptionTabWidgetFrame, но они не хотят заполнять всю информацию самостоятельно.

См. также QStyleOption::initFrom() и QTabBar::initStyleOption().

int QTabWidget::insertTab(int index, QWidget *page, const QString &label)

Вставляет вкладку с заданным label и page в виджет с вкладками по указанному index и возвращает индекс вставленной вкладки в панели вкладок. Владение page передаётся QTabWidget.

Текст label отображается на вкладке и может меняться в зависимости от настроек виджета с вкладками.

Если label вкладки содержит амперсанд, то буква, следующая за амперсандом, используется в качестве сочетания клавиш для вкладки, например, если label — "Bro&wse", то Alt+W станет сочетанием клавиш для перехода на эту вкладку.

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

Если QTabWidget был пустым до вызова этой функции, новая страница становится текущей страницей. Вставка новой вкладки в индекс, меньший или равный текущему индексу, увеличит текущий индекс, но сохранит текущую страницу.

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

int QTabWidget::insertTab(int index, QWidget *page, const QIcon &icon, const QString &label)

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

Вставляет вкладку с заданным label, page и icon в виджет с вкладками по указанному index и возвращает индекс вставленной вкладки в панели вкладок. Владение page передаётся QTabWidget.

Эта функция аналогична insertTab(), но с дополнительным параметром icon.

bool QTabWidget::isTabEnabled(int index) const

Возвращает true если страница в позиции index включена; в противном случае возвращает false.

См. также setTabEnabled() и QWidget::isEnabled().

[since 5.15] bool QTabWidget::isTabVisible(int index) const

Возвращает true, если страница в позиции index видима; в противном случае возвращает false.

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

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

[override virtual protected] void QTabWidget::keyPressEvent(QKeyEvent *e)

Переопределяет: QWidget::keyPressEvent(QKeyEvent *event).

[override virtual] QSize QTabWidget::minimumSizeHint() const

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

Возвращает подходящий минимальный размер для виджета с вкладками.

[override virtual protected] void QTabWidget::paintEvent(QPaintEvent *event)

Переопределяет: QWidget::paintEvent(QPaintEvent *event).

Рисует панель вкладок виджета с вкладками в ответ на событие рисования event.

void QTabWidget::removeTab(int index)

Удаляет вкладку в позиции index из этого стека виджетов. Сам виджет страницы не удаляется.

См. также addTab() и insertTab().

[override virtual protected] void QTabWidget::resizeEvent(QResizeEvent *e)

Переопределяет: QWidget::resizeEvent(QResizeEvent *event).

void QTabWidget::setCornerWidget(QWidget *widget, Qt::Corner corner = Qt::TopRightCorner)

Устанавливает указанный widget для отображения в указанном corner углу виджета с вкладками. Геометрия виджета определяется на основе его sizeHint() и style().

Используется только горизонтальная составляющая corner.

Передача nullptr не отображает виджет в углу.

Любой ранее установленный виджет угла скрывается.

Все виджеты, установленные здесь, будут удалены виджетом вкладки при его уничтожении, если вы не переместите виджет в другое место после установки другого виджета угла (или nullptr).

Примечание: Виджеты угла предназначены для положений вкладок Север и Юг; другие ориентации, как известно, работают неправильно.

См. также cornerWidget() и setTabPosition().

[protected] void QTabWidget::setTabBar(QTabBar *tb)

Заменяет заголовок диалогового окна QTabBar на вкладку tb. Обратите внимание, что это необходимо выполнить до добавления вкладок, иначе поведение будет неопределённым.

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

void QTabWidget::setTabEnabled(int index, bool enable)

Если enable имеет значение true, страница в позиции index включена; в противном случае страница в позиции index отключена. Вкладка страницы перерисовывается соответствующим образом.

QTabWidget использует QWidget::setEnabled() внутри, а не сохраняет отдельный флаг.

Обратите внимание, что даже отключённая вкладка/страница может быть видимой. Если страница уже видна, QTabWidget не будет скрывать её; если все страницы отключены, QTabWidget отобразит одну из них.

См. также isTabEnabled() и QWidget::setEnabled().

void QTabWidget::setTabIcon(int index, const QIcon &icon)

Устанавливает icon для вкладки в позиции index.

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

void QTabWidget::setTabText(int index, const QString &label)

Определяет новую метку для вкладки страницы в позиции index.

Если предоставленный текст содержит символ амперсанд ('&'), для него автоматически создается сочетание клавиш. Символ, следующий за '&', будет использоваться в качестве сочетания клавиш. Любое предыдущее сочетание клавиш будет перезаписано или очищено, если сочетание клавиш не определено текстом. Подробности см. в документации QShortcut (чтобы отобразить фактический амперсанд, используйте '&&').

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

void QTabWidget::setTabToolTip(int index, const QString &tip)

Устанавливает подсказку инструмента вкладки для страницы в позиции index в tip.

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

[since 5.15] void QTabWidget::setTabVisible(int index, bool visible)

Если visible имеет значение true, страница в позиции index видна; в противном случае страница в позиции index скрыта. Вкладка страницы перерисовывается соответствующим образом.

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

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

void QTabWidget::setTabWhatsThis(int index, const QString &text)

Устанавливает текст справки What's This для страницы в позиции index в text.

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

[override virtual protected] void QTabWidget::showEvent(QShowEvent *)

Переопределяет: QWidget::showEvent(QShowEvent *event).

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

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

QTabBar *QTabWidget::tabBar() const

Возвращает текущую QTabBar.

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

QIcon QTabWidget::tabIcon(int index) const

Возвращает значок для вкладки на странице в позиции index.

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

[virtual protected] void QTabWidget::tabInserted(int index)

Этот виртуальный обработчик вызывается после добавления или вставки новой вкладки в позицию index.

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

[virtual protected] void QTabWidget::tabRemoved(int index)

Этот виртуальный обработчик вызывается после удаления вкладки из позиции index.

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

QString QTabWidget::tabText(int index) const

Возвращает текст метки для вкладки на странице в позиции index.

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

QString QTabWidget::tabToolTip(int index) const

Возвращает подсказку инструмента вкладки для страницы в позиции index или пустую строку, если подсказка не установлена.

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

QString QTabWidget::tabWhatsThis(int index) const

Возвращает текст справки What's This для страницы в позиции index или пустую строку, если текст справки не установлен.

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

QWidget *QTabWidget::widget(int index) const

Возвращает вкладку страницы в позиции index или nullptr если index находится вне диапазона.