Класс QTabWidget

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

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

Типы

Свойства

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

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

Public Slots

Сигналы

Защищенные функции

Переопределенные защищенные функции

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

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

void QTabWidget::currentChanged(int index)

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

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

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

void QTabWidget::setCurrentWidget(QWidget *widget)

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

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

void QTabWidget::tabBarClicked(int index)

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

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

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

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

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

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

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

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

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

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

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

[virtual] QTabWidget::~QTabWidget()

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

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

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

Если метка вкладки содержит амперсанд (&), буква, следующая за амперсандом, используется в качестве сочетания клавиш для вкладки. Например, если метка — "Обзор&", то Alt+B станет сочетанием, которое переведёт фокус на эту вкладку.

Примечание: Если вы вызываете 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

Возвращает виджет, отображаемый в углу виджета с вкладками или 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(QWidget *w) const

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

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

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

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

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

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

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

Если метка вкладки содержит амперсанд (&), буква, следующая за амперсандом, используется в качестве сочетания клавиш для вкладки. Например, если метка — "Обзор&", то Alt+B станет сочетанием, которое переведёт фокус на эту вкладку.

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

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

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

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

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

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

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

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

bool QTabWidget::isTabEnabled(int index) const

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

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

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

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

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

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

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

[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 для отображения в указанном углу виджета с вкладками. Геометрия виджета определяется на основе его sizeHint() и стиля().

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

Передача 0 скрывает виджет в углу.

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

Все виджеты, установленные здесь, будут удалены виджетом вкладки при его уничтожении, если вы не переместите виджет в другое место после установки другого виджета угла (или 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().

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

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

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

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

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

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

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

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

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, или пустую строку, если текст справки не был задан.

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

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

QWidget *QTabWidget::widget(int index) const

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