QTabBar Class

Member Function Documentation

QTabBar::QTabBar(QWidget *parent = nullptr)

Creates a new tab bar with the given parent.

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

This signal is emitted when the tab bar's current tab changes. The new current has the given index, or -1 if there isn't a new one (for example, if there are no tab in the QTabBar)

Note: Notifier signal for property currentIndex.

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

This signal is emitted when user clicks on a tab at an index.

index is the index of a clicked tab, or -1 if no tab is under the cursor.

This function was introduced in Qt 5.2.

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

This signal is emitted when the user double clicks on a tab at index.

index refers to the tab clicked, or -1 if no tab is under the cursor.

This function was introduced in Qt 5.2.

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

This signal is emitted when the close button on a tab is clicked. The index is the index that should be removed.

This function was introduced in Qt 4.5.

See also setTabsClosable().

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

This signal is emitted when the tab has moved the tab at index position from to index position to.

note: QTabWidget will automatically move the page when this signal is emitted from its tab bar.

This function was introduced in Qt 4.5.

See also moveTab().

[virtual] QTabBar::~QTabBar()

Destroys the tab bar.

QString QTabBar::accessibleTabName(int index) const

Returns the accessibleName of the tab at position index, or an empty string if index is out of range.

See also setAccessibleTabName().

int QTabBar::addTab(const QString &text)

Adds a new tab with text text. Returns the new tab's index.

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

This is an overloaded function.

Adds a new tab with icon icon and text text. Returns the new tab's index.

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

Reimplements: QWidget::changeEvent(QEvent *event).

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

Reimplements: QWidget::event(QEvent *event).

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

Reimplements: QWidget::hideEvent(QHideEvent *event).

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

Initialize option with the values from the tab at tabIndex. This method is useful for subclasses when they need a QStyleOptionTab, but don't want to fill in all the information themselves.

See also QStyleOption::initFrom() and QTabWidget::initStyleOption().

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

Inserts a new tab with text text at position index. If index is out of range, the new tab is appened. Returns the new tab's index.

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

This is an overloaded function.

Inserts a new tab with icon icon and text text at position index. If index is out of range, the new tab is appended. Returns the new tab's index.

If the QTabBar was empty before this function is called, the inserted tab becomes the current tab.

Inserting a new tab at an index less than or equal to the current index will increment the current index, but keep the current tab.

bool QTabBar::isTabEnabled(int index) const

Returns true if the tab at position index is enabled; otherwise returns false.

bool QTabBar::isTabVisible(int index) const

Returns true if the tab at position index is visible; otherwise returns false.

This function was introduced in Qt 5.15.

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

Reimplements: QWidget::keyPressEvent(QKeyEvent *event).

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

Reimplements an access function for property: QWidget::minimumSizeHint.

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

Returns the minimum tab size hint for the tab at position index.

This function was introduced in Qt 5.0.

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

Reimplements: QWidget::mouseMoveEvent(QMouseEvent *event).

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

Reimplements: QWidget::mousePressEvent(QMouseEvent *event).

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

Reimplements: QWidget::mouseReleaseEvent(QMouseEvent *event).

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

Moves the item at index position from to index position to.

This function was introduced in Qt 4.5.

See also tabMoved() and tabLayoutChange().

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

Reimplements: QWidget::paintEvent(QPaintEvent *event).

void QTabBar::removeTab(int index)

Removes the tab at position index.

See also SelectionBehavior.

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

Reimplements: QWidget::resizeEvent(QResizeEvent *event).

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

Sets the accessibleName of the tab at position index to name.

See also accessibleTabName().

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

Sets widget on the tab index. The widget is placed on the left or right hand side depending upon the position.

Any previously set widget in position is hidden.

The tab bar will take ownership of the widget and so all widgets set here will be deleted by the tab bar when it is destroyed unless you separately reparent the widget after setting some other widget (or nullptr).

This function was introduced in Qt 4.5.

See also tabButton() and tabsClosable().

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

Sets the data of the tab at position index to data.

See also tabData().

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

If enabled is true then the tab at position index is enabled; otherwise the item at position index is disabled.

See also isTabEnabled().

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

Sets the icon of the tab at position index to icon.

See also tabIcon().

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

Sets the text of the tab at position index to text.

See also tabText().

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

Sets the color of the text in the tab with the given index to the specified color.

If an invalid color is specified, the tab will use the QTabBar foreground role instead.

See also tabTextColor().

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

Sets the tool tip of the tab at position index to tip.

See also tabToolTip().

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

If visible is true, make the tab at position index visible, otherwise make it hidden.

This function was introduced in Qt 5.15.

See also isTabVisible().

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

Sets the What's This help text of the tab at position index to text.

This function was introduced in Qt 4.1.

See also tabWhatsThis().

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

Reimplements: QWidget::showEvent(QShowEvent *event).

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

Reimplements an access function for property: QWidget::sizeHint.

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

Returns the index of the tab that covers position or -1 if no tab covers position;

This function was introduced in Qt 4.3.

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

Returns the widget set a tab index and position or nullptr if one is not set.

See also setTabButton().

QVariant QTabBar::tabData(int index) const

Returns the data of the tab at position index, or a null variant if index is out of range.

See also setTabData().

QIcon QTabBar::tabIcon(int index) const

Returns the icon of the tab at position index, or a null icon if index is out of range.

See also setTabIcon().

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

This virtual handler is called after a new tab was added or inserted at position index.

See also tabRemoved().

[virtual protected] void QTabBar::tabLayoutChange()

This virtual handler is called whenever the tab layout changes.

See also tabRect().

QRect QTabBar::tabRect(int index) const

Returns the visual rectangle of the tab at position index, or a null rectangle if index is hidden, or out of range.

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

This virtual handler is called after a tab was removed from position index.

See also tabInserted().

[virtual protected] QSize QTabBar::tabSizeHint(int index) const

Returns the size hint for the tab at position index.

QString QTabBar::tabText(int index) const

Returns the text of the tab at position index, or an empty string if index is out of range.

See also setTabText().

QColor QTabBar::tabTextColor(int index) const

Returns the text color of the tab with the given index, or a invalid color if index is out of range.

See also setTabTextColor().

QString QTabBar::tabToolTip(int index) const

Returns the tool tip of the tab at position index, or an empty string if index is out of range.

See also setTabToolTip().

QString QTabBar::tabWhatsThis(int index) const

Returns the What's This help text of the tab at position index, or an empty string if index is out of range.

This function was introduced in Qt 4.1.

See also setTabWhatsThis().

[override virtual protected] void QTabBar::timerEvent(QTimerEvent *event)

Reimplements: QObject::timerEvent(QTimerEvent *event).

[override virtual protected] void QTabBar::wheelEvent(QWheelEvent *event)

Reimplements: QWidget::wheelEvent(QWheelEvent *event).