|  | Home · All Classes · Modules

# QTabBar Class Reference
[QtGui module]

The QTabBar class provides a tab bar, e.g. for use in tabbed dialogs. More...

Inherits QWidget.

### Types

- enum ButtonPosition { LeftSide, RightSide }
- enum SelectionBehavior { SelectLeftTab, SelectRightTab, SelectPreviousTab }
- enum Shape { RoundedNorth, RoundedSouth, RoundedWest, RoundedEast, ..., TriangularEast }

### Methods

- __init__ (self, QWidget parent = None)
- int addTab (self, QString text)
- int addTab (self, QIcon icon, QString text)
- changeEvent (self, QEvent)
- int count (self)
- int currentIndex (self)
- bool documentMode (self)
- bool drawBase (self)
- Qt.TextElideMode elideMode (self)
- bool event (self, QEvent)
- bool expanding (self)
- hideEvent (self, QHideEvent)
- QSize iconSize (self)
- initStyleOption (self, QStyleOptionTab option, int tabIndex)
- int insertTab (self, int index, QString text)
- int insertTab (self, int index, QIcon icon, QString text)
- bool isMovable (self)
- bool isTabEnabled (self, int index)
- keyPressEvent (self, QKeyEvent)
- QSize minimumSizeHint (self)
- mouseMoveEvent (self, QMouseEvent)
- mousePressEvent (self, QMouseEvent)
- mouseReleaseEvent (self, QMouseEvent)
- moveTab (self, int from, int to)
- paintEvent (self, QPaintEvent)
- removeTab (self, int index)
- resizeEvent (self, QResizeEvent)
- SelectionBehavior selectionBehaviorOnRemove (self)
- setCurrentIndex (self, int index)
- setDocumentMode (self, bool set)
- setDrawBase (self, bool drawTheBase)
- setElideMode (self, Qt.TextElideMode)
- setExpanding (self, bool enabled)
- setIconSize (self, QSize size)
- setMovable (self, bool movable)
- setSelectionBehaviorOnRemove (self, SelectionBehavior behavior)
- setShape (self, Shape shape)
- setTabButton (self, int index, ButtonPosition position, QWidget widget)
- setTabData (self, int index, QVariant data)
- setTabEnabled (self, int index, bool)
- setTabIcon (self, int index, QIcon icon)
- setTabsClosable (self, bool closable)
- setTabText (self, int index, QString text)
- setTabTextColor (self, int index, QColor color)
- setTabToolTip (self, int index, QString tip)
- setTabWhatsThis (self, int index, QString text)
- setUsesScrollButtons (self, bool useButtons)
- Shape shape (self)
- showEvent (self, QShowEvent)
- QSize sizeHint (self)
- int tabAt (self, QPoint pos)
- QWidget tabButton (self, int index, ButtonPosition position)
- QVariant tabData (self, int index)
- QIcon tabIcon (self, int index)
- tabInserted (self, int index)
- tabLayoutChange (self)
- QRect tabRect (self, int index)
- tabRemoved (self, int index)
- bool tabsClosable (self)
- QSize tabSizeHint (self, int index)
- QString tabText (self, int index)
- QColor tabTextColor (self, int index)
- QString tabToolTip (self, int index)
- QString tabWhatsThis (self, int index)
- bool usesScrollButtons (self)
- wheelEvent (self, QWheelEvent event)

### Special Methods

- int __len__ (self)

### Qt Signals

- void currentChanged (int)
- void tabCloseRequested (int)
- void tabMoved (int,int)

## Detailed Description

The QTabBar class provides a tab bar, e.g. for use in tabbed dialogs.

QTabBar is straightforward to use; it draws the tabs using one of the predefined shapes, and emits a signal when a tab is selected. It can be subclassed to tailor the look and feel. Qt also provides a ready-made QTabWidget.

Each tab has a tabText(), an optional tabIcon(), an optional tabToolTip(), optional tabWhatsThis() and optional tabData(). The tabs's attributes can be changed with setTabText(), setTabIcon(), setTabToolTip(), setTabWhatsThis and setTabData(). Each tabs can be enabled or disabled individually with setTabEnabled().

Each tab can display text in a distinct color. The current text color for a tab can be found with the tabTextColor() function. Set the text color for a particular tab with setTabTextColor().

Tabs are added using addTab(), or inserted at particular positions using insertTab(). The total number of tabs is given by count(). Tabs can be removed from the tab bar with removeTab(). Combining removeTab() and insertTab() allows you to move tabs to different positions.

The shape property defines the tabs' appearance. The choice of shape is a matter of taste, although tab dialogs (for preferences and similar) invariably use RoundedNorth. Tab controls in windows other than dialogs almost always use either RoundedSouth or TriangularSouth. Many spreadsheets and other tab controls in which all the pages are essentially similar use TriangularSouth, whereas RoundedSouth is used mostly when the pages are different (e.g. a multi-page tool palette). The default in QTabBar is RoundedNorth.

The most important part of QTabBar's API is the currentChanged() signal. This is emitted whenever the current tab changes (even at startup, when the current tab changes from 'none'). There is also a slot, setCurrentIndex(), which can be used to select a tab programmatically. The function currentIndex() returns the index of the current tab, count holds the number of tabs.

QTabBar creates automatic mnemonic keys in the manner of QAbstractButton; e.g. if a tab's label is "&Graphics", Alt+G becomes a shortcut key for switching to that tab.

The following virtual functions may need to be reimplemented in order to tailor the look and feel or store extra data with each tab:

- tabSizeHint() calcuates the size of a tab.
- tabInserted() notifies that a new tab was added.
- tabRemoved() notifies that a tab was removed.
- tabLayoutChange() notifies that the tabs have been re-laid out.
- paintEvent() paints all tabs.

For subclasses, you might also need the tabRect() functions which returns the visual geometry of a single tab.

| A tab bar shown in the Plastique widget style.
| A truncated tab bar shown in the Plastique widget style.

## Type Documentation

### QTabBar.ButtonPosition

This enum type lists the location of the widget on a tab.

Constant | Value | Description
--- | --- | ---
`QTabBar.LeftSide` | `0` | Left side of the tab.
`QTabBar.RightSide` | `1` | Right side of the tab.

This enum was introduced or modified in Qt 4.5.

### QTabBar.SelectionBehavior

This enum type lists the behavior of QTabBar when a tab is removed and the tab being removed is also the current tab.

Constant | Value | Description
--- | --- | ---
`QTabBar.SelectLeftTab` | `0` | Select the tab to the left of the one being removed.
`QTabBar.SelectRightTab` | `1` | Select the tab to the right of the one being removed.
`QTabBar.SelectPreviousTab` | `2` | Select the previously selected tab.

This enum was introduced or modified in Qt 4.5.

### QTabBar.Shape

This enum type lists the built-in shapes supported by QTabBar. Treat these as hints as some styles may not render some of the shapes. However, position should be honored.

Constant | Value | Description
--- | --- | ---
`QTabBar.RoundedNorth` | `0` | The normal rounded look above the pages
`QTabBar.RoundedSouth` | `1` | The normal rounded look below the pages
`QTabBar.RoundedWest` | `2` | The normal rounded look on the left side of the pages
`QTabBar.RoundedEast` | `3` | The normal rounded look on the right side the pages
`QTabBar.TriangularNorth` | `4` | Triangular tabs above the pages.
`QTabBar.TriangularSouth` | `5` | Triangular tabs similar to those used in the Excel spreadsheet, for example
`QTabBar.TriangularWest` | `6` | Triangular tabs on the left of the pages.
`QTabBar.TriangularEast` | `7` | Triangular tabs on the right of the pages.

## Method Documentation

### QTabBar.__init__ (self, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Creates a new tab bar with the given parent.

### int QTabBar.addTab (self, QString text)

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

### int QTabBar.addTab (self, QIcon icon, QString text)

This is an overloaded function.

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

### QTabBar.changeEvent (self, QEvent)

Reimplemented from QWidget.changeEvent().

### int QTabBar.count (self)

### int QTabBar.currentIndex (self)

### bool QTabBar.documentMode (self)

### bool QTabBar.drawBase (self)

### Qt.TextElideMode QTabBar.elideMode (self)

### bool QTabBar.event (self, QEvent)

Reimplemented from QObject.event().

### bool QTabBar.expanding (self)

### QTabBar.hideEvent (self, QHideEvent)

Reimplemented from QWidget.hideEvent().

### QSize QTabBar.iconSize (self)

### QTabBar.initStyleOption (self, QStyleOptionTab option, int tabIndex)

Initialize option with the values from the tab at tabIndex. This method is useful for subclasses when they need a QStyleOptionTab, QStyleOptionTabV2, or QStyleOptionTabV3 but don't want to fill in all the information themselves. This function will check the version of the QStyleOptionTab and fill in the additional values for a QStyleOptionTabV2 and QStyleOptionTabV3.

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

### int QTabBar.insertTab (self, int index, 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 (self, int index, QIcon icon, 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.isMovable (self)

### bool QTabBar.isTabEnabled (self, int index)

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

### QTabBar.keyPressEvent (self, QKeyEvent)

Reimplemented from QWidget.keyPressEvent().

### QSize QTabBar.minimumSizeHint (self)

Reimplemented from QWidget.minimumSizeHint().

### QTabBar.mouseMoveEvent (self, QMouseEvent)

Reimplemented from QWidget.mouseMoveEvent().

### QTabBar.mousePressEvent (self, QMouseEvent)

Reimplemented from QWidget.mousePressEvent().

### QTabBar.mouseReleaseEvent (self, QMouseEvent)

Reimplemented from QWidget.mouseReleaseEvent().

### QTabBar.moveTab (self, 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().

### QTabBar.paintEvent (self, QPaintEvent)

Reimplemented from QWidget.paintEvent().

### QTabBar.removeTab (self, int index)

Removes the tab at position index.

See also SelectionBehavior.

### QTabBar.resizeEvent (self, QResizeEvent)

Reimplemented from QWidget.resizeEvent().

### SelectionBehavior QTabBar.selectionBehaviorOnRemove (self)

### QTabBar.setCurrentIndex (self, int index)

This method is also a Qt slot with the C++ signature `void setCurrentIndex(int)`.

### QTabBar.setDocumentMode (self, bool set)

### QTabBar.setDrawBase (self, bool drawTheBase)

### QTabBar.setElideMode (self, Qt.TextElideMode)

### QTabBar.setExpanding (self, bool enabled)

### QTabBar.setIconSize (self, QSize size)

### QTabBar.setMovable (self, bool movable)

### QTabBar.setSelectionBehaviorOnRemove (self, SelectionBehavior behavior)

### QTabBar.setShape (self, Shape shape)

### QTabBar.setTabButton (self, int index, ButtonPosition position, QWidget widget)

The widget argument has it's ownership transferred to Qt.

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 0).

This function was introduced in Qt 4.5.

See also tabButton() and tabsClosable().

### QTabBar.setTabData (self, int index, QVariant data)

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

See also tabData().

### QTabBar.setTabEnabled (self, int index, bool)

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

See also isTabEnabled().

### QTabBar.setTabIcon (self, int index, QIcon icon)

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

See also tabIcon().

### QTabBar.setTabsClosable (self, bool closable)

### QTabBar.setTabText (self, int index, QString text)

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

See also tabText().

### QTabBar.setTabTextColor (self, int index, 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().

### QTabBar.setTabToolTip (self, int index, QString tip)

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

See also tabToolTip().

### QTabBar.setTabWhatsThis (self, int index, 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().

### QTabBar.setUsesScrollButtons (self, bool useButtons)

### Shape QTabBar.shape (self)

### QTabBar.showEvent (self, QShowEvent)

Reimplemented from QWidget.showEvent().

### QSize QTabBar.sizeHint (self)

Reimplemented from QWidget.sizeHint().

### int QTabBar.tabAt (self, QPoint pos)

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 (self, int index, ButtonPosition position)

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

See also setTabButton().

### QVariant QTabBar.tabData (self, int index)

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 (self, int index)

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

See also setTabIcon().

### QTabBar.tabInserted (self, int index)

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

See also tabRemoved().

### QTabBar.tabLayoutChange (self)

This virtual handler is called whenever the tab layout changes.

See also tabRect().

### QRect QTabBar.tabRect (self, int index)

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

### QTabBar.tabRemoved (self, int index)

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

See also tabInserted().

### bool QTabBar.tabsClosable (self)

### QSize QTabBar.tabSizeHint (self, int index)

Returns the size hint for the tab at position index.

### QString QTabBar.tabText (self, int index)

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 (self, int index)

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 (self, int index)

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 (self, int index)

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().

### bool QTabBar.usesScrollButtons (self)

### QTabBar.wheelEvent (self, QWheelEvent event)

Reimplemented from QWidget.wheelEvent().

### int QTabBar.__len__ (self)

## Qt Signal Documentation

### void currentChanged (int)

This is the default overload of this signal.

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)

### void tabCloseRequested (int)

This is the default overload of this signal.

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().

### void tabMoved (int,int)

This is the default overload of this signal.

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().