Класс QTabWidget

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

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

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

Свойства

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

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

Public Slots

Сигналы

Protected Functions

Переопределённые 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 и Пример диалога вкладок.

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

enum QTabWidget::TabPosition

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

enum 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 станет сочетанием, перемещающим фокус на эту вкладку.

Примечание: Если вы вызываете addTab() после show(), система макета попытается скорректировать изменения в иерархии виджетов и может привести к мерцанию. Чтобы предотвратить это, вы можете установить свойство QWidget::updatesEnabled в false перед изменениями; не забудьте установить свойство в true, когда изменения будут выполнены, чтобы виджет снова получал события рисования.

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

Текст метки отображается на вкладке и может отличаться в зависимости от конфигурации виджета вкладок.

Если метка вкладки содержит амперсанд (&), символ, следующий за амперсандом, используется в качестве сочетания клавиш для вкладки. Например, если метка — «Bro&wse», то сочетание Alt+W станет сочетанием, перемещающим фокус на эту вкладку.

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

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

Примечание: Если вы вызываете insertTab() после show(), система макета попытается скорректировать изменения в иерархии виджетов и может привести к мерцанию. Чтобы предотвратить это, вы можете установить свойство QWidget::updatesEnabled в false перед изменениями; не забудьте установить свойство в true, когда изменения будут выполнены, чтобы виджет снова получал события рисования.

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

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

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

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

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

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 находится вне диапазона.