Класс QTabBar

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

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

Типы

Свойства

Общедоступные функции

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

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

Сигналы

Protected Functions

Reimplemented Protected Functions

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

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

Каждая вкладка имеет текст вкладки, необязательный значок вкладки, необязательный инструментальную подсказку вкладки, необязательный справочный текст вкладки и необязательные данные вкладки. Атрибуты вкладок могут быть изменены с помощью 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. Он излучается всякий раз, когда текущая вкладка изменяется (даже при запуске, когда текущая вкладка изменяется с 'none'). Также есть слот setCurrentIndex, который можно использовать для выбора вкладки программно. Функция currentIndex() возвращает индекс текущей вкладки, а count хранит количество вкладок.

QTabBar создаёт автоматические мнемонические клавиши в стиле QAbstractButton; например, если метка вкладки — "&Графика", то сочетание клавиш 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. Виджет размещается слева или справа в зависимости от 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.

Если задан некорректный цвет, вкладка будет использовать роль переднего плана 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)

Устанавливает текст справки Что это? для вкладки в позиции 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

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

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

void QTabBar::timerEvent(QTimerEvent *event)

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

void QTabBar::wheelEvent(QWheelEvent *event)

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