Класс QTabBar

Класс QTabBar предоставляет панель вкладок, например, для использования в диалоговых окнах с вкладками. Подробнее...

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

Типы публичного доступа

Свойства

Публичные функции

Реализованные общедоступные функции

Открытые слоты

Сигналы

Protected Functions

Reimplemented Protected Functions

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

QTabBar прост в использовании; он рисует вкладки, используя один из предопределённых видов, и испускает сигнал, когда вкладка выбирается. Его можно переопределить, чтобы настроить внешний вид.

Каждая вкладка имеет текст вкладки, необязательный иконку вкладки, необязательный инструментальную подсказку, необязательный WhatsThis и необязательные данные вкладки. Атрибуты вкладок можно изменить с помощью setTabText, setTabIcon, setTabToolTip, setTabWhatsThis и setTabData. Каждая вкладка может быть включена или выключена индивидуально с помощью setTabEnabled.

Каждая вкладка может отображать текст в отдельном цвете. Текущий цвет текста вкладки можно найти с помощью функции tabTextColor. Установите цвет текста для конкретной вкладки с помощью setTabTextColor.

Вкладки добавляются с помощью addTab или вставляются в определённых позициях с помощью insertTab. Общее количество вкладок задаётся свойством count. Вкладки могут быть удалены из панели вкладок с помощью removeTab. Объединение removeTab и insertTab позволяет перемещать вкладки в различные позиции.

Свойство shape определяет внешний вид вкладок. Выбор формы - дело вкуса, хотя диалоговые окна с вкладками (для настроек и тому подобного) неизменно используют RoundedNorth. Элементы управления вкладками в окнах, отличных от диалоговых, почти всегда используют либо RoundedSouth, либо TriangularSouth. Многие электронные таблицы и другие элементы управления вкладками, в которых все страницы в основном похожи, используют TriangularSouth, тогда как RoundedSouth используется в основном, когда страницы различаются (например, многостраничная палитра инструментов). По умолчанию в QTabBar используется RoundedNorth.

Самой важной частью API QTabBar является сигнал currentChanged. Он испускается всякий раз, когда текущая вкладка изменяется (даже при запуске, когда текущая вкладка меняется с "нет"). Также есть слот setCurrentIndex, который можно использовать для программированного выбора вкладки. Функция currentIndex() возвращает индекс текущей вкладки, а count хранит количество вкладок.

QTabBar создаёт автоматические мнемонические клавиши в соответствии со QAbstractButton; например, если метка вкладки — "&Graphics", Alt+G становится клавишей быстрого доступа для переключения на эту вкладку.

Следующие виртуальные функции могут потребовать переопределения в целях настройки внешнего вида или хранения дополнительных данных каждой вкладкой:

• tabSizeHint() вычисляет размер вкладки.
• tabInserted() уведомляет о добавлении новой вкладки.
• tabRemoved() уведомляет об удалении вкладки.
• tabLayoutChange() уведомляет о перераспределении вкладок.
• paintEvent() отрисовывает все вкладки.

Для подклассов вам могут также потребоваться функции tabRect(), которые возвращают визуальную геометрию отдельной вкладки.

	Панель вкладок, показанная в стиле виджетов Fusion.
	Усеченная панель вкладок, показанная в стиле виджетов Fusion.

См. такжеQTabWidget.

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

Перечисление QTabBar::ButtonPosition

Это перечисление типов, определяющих расположение виджета на вкладке.

Перечисление QTabBar::SelectionBehavior

Это перечисление типов, определяющих поведение QTabBar при удалении вкладки, которая также является текущей.

Перечисление QTabBar::Shape

Это перечисление типов, определяющих встроенные формы, поддерживаемые QTabBar. Считаются подсказками, поскольку некоторые стили могут не отображать некоторые формы. Однако позиция должна быть учтена.

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

QTabBar::QTabBar(QWidget *parent = nullptr)

Создаёт новую вкладку с данным parent.

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

Этот сигнал генерируется, когда текущая вкладка на панели вкладок изменяется. Новая текущая вкладка имеет указанный index или -1, если новой вкладки нет (например, если на вкладке QTabBar нет вкладок).

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

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

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

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

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

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

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

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

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

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

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

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

[signal] void QTabBar::tabMoved(int from, int to)

Этот сигнал генерируется, когда вкладка с индексом from перемещается на позицию с индексом to.

Примечание: QTabWidget автоматически переместит страницу, когда этот сигнал будет испущен из его панели вкладок.

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

[virtual] QTabBar::~QTabBar()

Удаляет панель вкладок.

QString QTabBar::accessibleTabName(int index) const

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

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

int QTabBar::addTab(const QString &text)

Добавляет новую вкладку с текстом text. Возвращает индекс новой вкладки.

int QTabBar::addTab(const QIcon &icon, const QString &text)

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

Добавляет новую вкладку с иконкой icon и текстом text. Возвращает индекс новой вкладки.

[override virtual protected] void QTabBar::changeEvent(QEvent *event)

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

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

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

[override virtual protected] void QTabBar::hideEvent(QHideEvent *)

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

[virtual protected] void QTabBar::initStyleOption(QStyleOptionTab *option, int tabIndex) const

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

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

int QTabBar::insertTab(int index, const QString &text)

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

int QTabBar::insertTab(int index, const QIcon &icon, const QString &text)

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

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

Если QTabBar был пустым до вызова этой функции, вставленная вкладка становится текущей вкладкой.

Вставка новой вкладки на индекс, меньший или равный текущему индексу, увеличит текущий индекс, но сохранит текущую вкладку.

bool QTabBar::isTabEnabled(int index) const

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

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

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

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

[override virtual protected] void QTabBar::keyPressEvent(QKeyEvent *event)

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

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

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

[virtual protected, since 5.0] QSize QTabBar::minimumTabSizeHint(int index) const

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

Эта функция была представлена в Qt 5.0.

[override virtual protected] void QTabBar::mouseDoubleClickEvent(QMouseEvent *event)

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

[override virtual protected] void QTabBar::mouseMoveEvent(QMouseEvent *event)

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

[override virtual protected] void QTabBar::mousePressEvent(QMouseEvent *event)

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

[override virtual protected] void QTabBar::mouseReleaseEvent(QMouseEvent *event)

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

void QTabBar::moveTab(int from, int to)

Перемещает элемент с индексом from на позицию с индексом to.

См. также tabMoved() и tabLayoutChange().

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

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

void QTabBar::removeTab(int index)

Удаляет вкладку с индексом index.

См. также SelectionBehavior.

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

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

void QTabBar::setAccessibleTabName(int index, const QString &name)

Устанавливает accessibleName вкладки с индексом index на name.

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

void QTabBar::setTabButton(int index, QTabBar::ButtonPosition position, QWidget *widget)

Устанавливает widget на вкладке index. Widget размещается слева или справа в зависимости от position.

Любой ранее установленный widget в position будет скрыт.

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

См. также tabButton() и tabsClosable().

void QTabBar::setTabData(int index, const QVariant &data)

Устанавливает данные вкладки с позицией index на data.

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

void QTabBar::setTabEnabled(int index, bool enabled)

Если enabled имеет значение true, то вкладка с позицией index активируется; в противном случае элемент с позицией index отключается.

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

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

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

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

void QTabBar::setTabText(int index, const QString &text)

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

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

void QTabBar::setTabTextColor(int index, const QColor &color)

Устанавливает цвет текста вкладки с заданным index на указанный color.

Если указан недопустимый цвет, вкладка будет использовать роль foreground панели QTabBar вместо этого.

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

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

Устанавливает всплывающую подсказку вкладки с позицией index на tip.

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

void QTabBar::setTabVisible(int index, bool visible)

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

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

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

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

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

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

void QTabBar::showEvent(QShowEvent *)

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

QSize QTabBar::sizeHint() const

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

int QTabBar::tabAt(const QPoint &position) const

Возвращает индекс вкладки, которая покрывает position, или -1, если ни одна вкладка не покрывает position;

QWidget *QTabBar::tabButton(int index, QTabBar::ButtonPosition position) const

Возвращает виджет, установленный для вкладки index и position, или nullptr если такой не установлен.

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

QVariant QTabBar::tabData(int index) const

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

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

QIcon QTabBar::tabIcon(int index) const

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

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

void QTabBar::tabInserted(int index)

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

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

void QTabBar::tabLayoutChange()

Этот виртуальный обработчик вызывается всякий раз, когда изменяется макет вкладок.

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

QRect QTabBar::tabRect(int index) const

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

void QTabBar::tabRemoved(int index)

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

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

QSize QTabBar::tabSizeHint(int index) const

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

QString QTabBar::tabText(int index) const

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

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

QColor QTabBar::tabTextColor(int index) const

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

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

QString QTabBar::tabToolTip(int index) const

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

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

QString QTabBar::tabWhatsThis(int index) const

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

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

void QTabBar::timerEvent(QTimerEvent *event)

Переопределяет: QObject::timerEvent(QTimerEvent *event).

void QTabBar::wheelEvent(QWheelEvent *event)

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