class QTabBar

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

Synopsis

Properties

• autoHideᅟ - If true, the tab bar is automatically hidden when it contains less than 2 tabs

• changeCurrentOnDragᅟ - If true, then the current tab is automatically changed when dragging over the tabbar

• countᅟ - The number of tabs in the tab bar

• currentIndexᅟ - The index of the tab bar’s visible tab

• documentModeᅟ - Whether or not the tab bar is rendered in a mode suitable for the main window

• drawBaseᅟ - Defines whether or not tab bar should draw its base

• elideModeᅟ - How to elide text in the tab bar

• expandingᅟ - When expanding is true QTabBar will expand the tabs to use the empty space

• iconSizeᅟ - Size for icons in the tab bar

• movableᅟ - This property holds whether the user can move the tabs within the tabbar area

• selectionBehaviorOnRemoveᅟ - What tab should be set as current when removeTab is called if the removed tab is also the current tab

• shapeᅟ - The shape of the tabs in the tab bar

• tabsClosableᅟ - Whether or not a tab bar should place close buttons on each tab

• usesScrollButtonsᅟ - Whether or not a tab bar should use buttons to scroll tabs when it has many tabs

Methods

• def __init__()

• def accessibleTabName()

• def addTab()

• def autoHide()

• def changeCurrentOnDrag()

• def count()

• def currentIndex()

• def documentMode()

• def drawBase()

• def elideMode()

• def expanding()

• def iconSize()

• def insertTab()

• def isMovable()

• def isTabEnabled()

• def isTabVisible()

• def moveTab()

• def removeTab()

• def selectionBehaviorOnRemove()

• def setAccessibleTabName()

• def setAutoHide()

• def setChangeCurrentOnDrag()

• def setDocumentMode()

• def setDrawBase()

• def setElideMode()

• def setExpanding()

• def setIconSize()

• def setMovable()

• def setSelectionBehaviorOnRemove()

• def setShape()

• def setTabButton()

• def setTabData()

• def setTabEnabled()

• def setTabIcon()

• def setTabText()

• def setTabTextColor()

• def setTabToolTip()

• def setTabVisible()

• def setTabWhatsThis()

• def setTabsClosable()

• def setUsesScrollButtons()

• def shape()

• def tabAt()

• def tabButton()

• def tabData()

• def tabIcon()

• def tabRect()

• def tabText()

• def tabTextColor()

• def tabToolTip()

• def tabWhatsThis()

• def tabsClosable()

• def usesScrollButtons()

Virtual methods

• def initStyleOption()

• def minimumTabSizeHint()

• def tabInserted()

• def tabLayoutChange()

• def tabRemoved()

• def tabSizeHint()

Slots

• def setCurrentIndex()

Signals

• def currentChanged()

• def tabBarClicked()

• def tabBarDoubleClicked()

• def tabCloseRequested()

• def tabMoved()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

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 Fusion widget style .
	A truncated tab bar shown in the Fusion widget style.

See also

QTabWidget

class 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	Description
QTabBar.RoundedNorth	The normal rounded look above the pages
QTabBar.RoundedSouth	The normal rounded look below the pages
QTabBar.RoundedWest	The normal rounded look on the left side of the pages
QTabBar.RoundedEast	The normal rounded look on the right side the pages
QTabBar.TriangularNorth	Triangular tabs above the pages.
QTabBar.TriangularSouth	Triangular tabs similar to those used in the Excel spreadsheet, for example
QTabBar.TriangularWest	Triangular tabs on the left of the pages.
QTabBar.TriangularEast	Triangular tabs on the right of the pages.

class ButtonPosition

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

Constant	Description
QTabBar.LeftSide	Left side of the tab.
QTabBar.RightSide	Right side of the tab.

class 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	Description
QTabBar.SelectLeftTab	Select the tab to the left of the one being removed.
QTabBar.SelectRightTab	Select the tab to the right of the one being removed.
QTabBar.SelectPreviousTab	Select the previously selected tab.

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property autoHideᅟ: bool

This property holds If true, the tab bar is automatically hidden when it contains less than 2 tabs..

By default, this property is false.

See also

visible

Access functions:

• autoHide()

• setAutoHide()

property changeCurrentOnDragᅟ: bool

This property holds If true, then the current tab is automatically changed when dragging over the tabbar..

Note

You should also set acceptDrops property to true to make this feature work.

By default, this property is false.

Access functions:

• changeCurrentOnDrag()

• setChangeCurrentOnDrag()

property countᅟ: int

This property holds the number of tabs in the tab bar.

Access functions:

• count()

property currentIndexᅟ: int

This property holds the index of the tab bar’s visible tab.

The current index is -1 if there is no current tab.

Access functions:

• currentIndex()

• setCurrentIndex()

• Signal currentChanged()

property documentModeᅟ: bool

This property holds Whether or not the tab bar is rendered in a mode suitable for the main window..

This property is used as a hint for styles to draw the tabs in a different way then they would normally look in a tab widget. On macOS this will look similar to the tabs in Safari or Sierra’s Terminal.app.

See also

documentMode

Access functions:

• documentMode()

• setDocumentMode()

property drawBaseᅟ: bool

This property defines whether or not tab bar should draw its base..

If true then QTabBar draws a base in relation to the styles overlap. Otherwise only the tabs are drawn.

See also

pixelMetric() PM_TabBarBaseOverlap QStyleOptionTabBarBase

Access functions:

• drawBase()

• setDrawBase()

property elideModeᅟ: Qt.TextElideMode

This property holds how to elide text in the tab bar.

This property controls how items are elided when there is not enough space to show them for a given tab bar size.

By default the value is style-dependent.

See also

elideMode usesScrollButtons SH_TabBar_ElideMode

Access functions:

• elideMode()

• setElideMode()

property expandingᅟ: bool

This property holds When expanding is true QTabBar will expand the tabs to use the empty space..

By default the value is true.

See also

documentMode

Access functions:

• expanding()

• setExpanding()

property iconSizeᅟ: QSize

This property holds The size for icons in the tab bar.

The default value is style-dependent. iconSize is a maximum size; icons that are smaller are not scaled up.

See also

iconSize

Access functions:

• iconSize()

• setIconSize()

property movableᅟ: bool

This property holds This property holds whether the user can move the tabs within the tabbar area..

By default, this property is false;

Access functions:

• isMovable()

• setMovable()

property selectionBehaviorOnRemoveᅟ: QTabBar.SelectionBehavior

This property holds What tab should be set as current when removeTab is called if the removed tab is also the current tab..

By default the value is SelectRightTab .

See also

removeTab()

Access functions:

• selectionBehaviorOnRemove()

• setSelectionBehaviorOnRemove()

property shapeᅟ: QTabBar.Shape

This property holds the shape of the tabs in the tab bar.

Possible values for this property are described by the Shape enum.

Access functions:

• shape()

• setShape()

property tabsClosableᅟ: bool

This property holds Whether or not a tab bar should place close buttons on each tab.

When tabsClosable is set to true a close button will appear on the tab on either the left or right hand side depending upon the style. When the button is clicked the tab the signal tabCloseRequested will be emitted.

By default the value is false.

See also

setTabButton() tabRemoved()

Access functions:

• tabsClosable()

• setTabsClosable()

property usesScrollButtonsᅟ: bool

This property holds Whether or not a tab bar should use buttons to scroll tabs when it has many tabs..

When there are too many tabs in a tab bar for its size, the tab bar can either choose to expand its size or to add buttons that allow you to scroll through the tabs.

By default the value is style-dependent.

See also

elideMode usesScrollButtons SH_TabBar_PreferNoArrows

Access functions:

• usesScrollButtons()

• setUsesScrollButtons()

__init__([parent=None])

Parameters:

parent – QWidget

Creates a new tab bar with the given parent.

accessibleTabName(index)

Parameters:

index – int

Return type:

str

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

See also

setAccessibleTabName()

addTab(text)

Parameters:

text – str

Return type:

int

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

addTab(icon, text)

Parameters:

• icon – QIcon

• text – str

Return type:

int

This is an overloaded function.

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

autoHide()

Return type:

bool

See also

setAutoHide()

Getter of property autoHideᅟ .

changeCurrentOnDrag()

Return type:

bool

See also

setChangeCurrentOnDrag()

Getter of property changeCurrentOnDragᅟ .

count()

Return type:

int

Getter of property countᅟ .

currentChanged(index)

Parameters:

index – int

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 )

Notification signal of property currentIndexᅟ .

currentIndex()

Return type:

int

See also

setCurrentIndex()

Getter of property currentIndexᅟ .

documentMode()

Return type:

bool

See also

setDocumentMode()

Getter of property documentModeᅟ .

drawBase()

Return type:

bool

See also

setDrawBase()

Getter of property drawBaseᅟ .

elideMode()

Return type:

TextElideMode

See also

setElideMode()

Getter of property elideModeᅟ .

expanding()

Return type:

bool

See also

setExpanding()

Getter of property expandingᅟ .

iconSize()

Return type:

QSize

See also

setIconSize()

Getter of property iconSizeᅟ .

initStyleOption(option, tabIndex)

Parameters:

• option – QStyleOptionTab

• tabIndex – int

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

initFrom() initStyleOption()

insertTab(index, text)

Parameters:

• index – int

• text – str

Return type:

int

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

insertTab(index, icon, text)

Parameters:

• index – int

• icon – QIcon

• text – str

Return type:

int

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.

isMovable()

Return type:

bool

Getter of property movableᅟ .

isTabEnabled(index)

Parameters:

index – int

Return type:

bool

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

isTabVisible(index)

Parameters:

index – int

Return type:

bool

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

minimumTabSizeHint(index)

Parameters:

index – int

Return type:

QSize

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

moveTab(from, to)

Parameters:

• from – int

• to – int

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

See also

tabMoved() tabLayoutChange()

removeTab(index)

Parameters:

index – int

Removes the tab at position index.

See also

SelectionBehavior

selectionBehaviorOnRemove()

Return type:

SelectionBehavior

See also

setSelectionBehaviorOnRemove()

Getter of property selectionBehaviorOnRemoveᅟ .

setAccessibleTabName(index, name)

Parameters:

• index – int

• name – str

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

See also

accessibleTabName()

setAutoHide(hide)

Parameters:

hide – bool

See also

autoHide()

Setter of property autoHideᅟ .

setChangeCurrentOnDrag(change)

Parameters:

change – bool

See also

changeCurrentOnDrag()

Setter of property changeCurrentOnDragᅟ .

setCurrentIndex(index)

Parameters:

index – int

See also

currentIndex()

Setter of property currentIndexᅟ .

setDocumentMode(set)

Parameters:

set – bool

See also

documentMode()

Setter of property documentModeᅟ .

setDrawBase(drawTheBase)

Parameters:

drawTheBase – bool

See also

drawBase()

Setter of property drawBaseᅟ .

setElideMode(mode)

Parameters:

mode – TextElideMode

See also

elideMode()

Setter of property elideModeᅟ .

setExpanding(enabled)

Parameters:

enabled – bool

See also

expanding()

Setter of property expandingᅟ .

setIconSize(size)

Parameters:

size – QSize

See also

iconSize()

Setter of property iconSizeᅟ .

setMovable(movable)

Parameters:

movable – bool

See also

isMovable()

Setter of property movableᅟ .

setSelectionBehaviorOnRemove(behavior)

Parameters:

behavior – SelectionBehavior

See also

selectionBehaviorOnRemove()

Setter of property selectionBehaviorOnRemoveᅟ .

setShape(shape)

Parameters:

shape – Shape

See also

shape()

Setter of property shapeᅟ .

setTabButton(index, position, widget)

Parameters:

• index – int

• position – ButtonPosition

• widget – QWidget

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

Any previously set widget in position is hidden. Setting widget to None will hide the current widget at position.

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

See also

tabButton() tabsClosable()

setTabData(index, data)

Parameters:

• index – int

• data – object

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

See also

tabData()

setTabEnabled(index, enabled)

Parameters:

• index – int

• enabled – bool

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

See also

isTabEnabled()

setTabIcon(index, icon)

Parameters:

• index – int

• icon – QIcon

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

See also

tabIcon()

setTabText(index, text)

Parameters:

• index – int

• text – str

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

See also

tabText()

setTabTextColor(index, color)

Parameters:

• index – int

• color – QColor

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

setTabToolTip(index, tip)

Parameters:

• index – int

• tip – str

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

See also

tabToolTip()

setTabVisible(index, visible)

Parameters:

• index – int

• visible – bool

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

See also

isTabVisible()

setTabWhatsThis(index, text)

Parameters:

• index – int

• text – str

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

See also

tabWhatsThis()

setTabsClosable(closable)

Parameters:

closable – bool

See also

tabsClosable()

Setter of property tabsClosableᅟ .

setUsesScrollButtons(useButtons)

Parameters:

useButtons – bool

See also

usesScrollButtons()

Setter of property usesScrollButtonsᅟ .

shape()

Return type:

Shape

See also

setShape()

Getter of property shapeᅟ .

tabAt(pos)

Parameters:

pos – QPoint

Return type:

int

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

tabBarClicked(index)

Parameters:

index – int

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.

tabBarDoubleClicked(index)

Parameters:

index – int

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.

tabButton(index, position)

Parameters:

• index – int

• position – ButtonPosition

Return type:

QWidget

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

See also

setTabButton()

tabCloseRequested(index)

Parameters:

index – int

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

See also

setTabsClosable()

tabData(index)

Parameters:

index – int

Return type:

object

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

See also

setTabData()

tabIcon(index)

Parameters:

index – int

Return type:

QIcon

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

See also

setTabIcon()

tabInserted(index)

Parameters:

index – int

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

See also

tabRemoved()

tabLayoutChange()

This virtual handler is called whenever the tab layout changes.

See also

tabRect()

tabMoved(from, to)

Parameters:

• from – int

• to – int

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.

See also

moveTab()

tabRect(index)

Parameters:

index – int

Return type:

QRect

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

tabRemoved(index)

Parameters:

index – int

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

See also

tabInserted()

tabSizeHint(index)

Parameters:

index – int

Return type:

QSize

Returns the size hint for the tab at position index.

tabText(index)

Parameters:

index – int

Return type:

str

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

See also

setTabText()

tabTextColor(index)

Parameters:

index – int

Return type:

QColor

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

See also

setTabTextColor()

tabToolTip(index)

Parameters:

index – int

Return type:

str

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

See also

setTabToolTip()

tabWhatsThis(index)

Parameters:

index – int

Return type:

str

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

See also

setTabWhatsThis()

tabsClosable()

Return type:

bool

See also

setTabsClosable()

Getter of property tabsClosableᅟ .

usesScrollButtons()

Return type:

bool

See also

setUsesScrollButtons()

Getter of property usesScrollButtonsᅟ .