QTabWidget¶

The QTabWidget class provides a stack of tabbed widgets. More…

Synopsis¶

Functions¶

def addTab (widget, arg__2)
def addTab (widget, icon, label)
def clear ()
def cornerWidget ([corner=Qt.TopRightCorner])
def count ()
def currentIndex ()
def currentWidget ()
def documentMode ()
def elideMode ()
def iconSize ()
def indexOf (widget)
def insertTab (index, widget, arg__3)
def insertTab (index, widget, icon, label)
def isMovable ()
def isTabEnabled (index)
def isTabVisible (index)
def removeTab (index)
def setCornerWidget (w[, corner=Qt.TopRightCorner])
def setDocumentMode (set)
def setElideMode (mode)
def setIconSize (size)
def setMovable (movable)
def setTabBar (arg__1)
def setTabBarAutoHide (enabled)
def setTabEnabled (index, enabled)
def setTabIcon (index, icon)
def setTabPosition (position)
def setTabShape (s)
def setTabText (index, text)
def setTabToolTip (index, tip)
def setTabVisible (index, visible)
def setTabWhatsThis (index, text)
def setTabsClosable (closeable)
def setUsesScrollButtons (useButtons)
def tabBar ()
def tabBarAutoHide ()
def tabIcon (index)
def tabPosition ()
def tabShape ()
def tabText (index)
def tabToolTip (index)
def tabWhatsThis (index)
def tabsClosable ()
def usesScrollButtons ()
def widget (index)

Detailed Description¶

A tab widget provides a tab bar (see QTabBar ) and a “page area” that is used to display pages related to each tab. By default, the tab bar is shown above the page area, but different configurations are available (see TabPosition ). Each tab is associated with a different widget (called a page). Only the current page is shown in the page area; all the other pages are hidden. The user can show a different page by clicking on its tab or by pressing its Alt+*letter* shortcut if it has one.

The normal way to use QTabWidget is to do the following:

Create a QTabWidget .

Create a QWidget for each of the pages in the tab dialog, but do not specify parent widgets for them.

Insert child widgets into the page widget, using layouts to position them as normal.

Call addTab() or insertTab() to put the page widgets into the tab widget, giving each tab a suitable label with an optional keyboard shortcut.

The position of the tabs is defined by tabPosition , their shape by tabShape .

The signal currentChanged() is emitted when the user selects a page.

The current page index is available as currentIndex() , the current page widget with currentWidget() . You can retrieve a pointer to a page widget with a given index using widget() , and can find the index position of a widget with indexOf() . Use setCurrentWidget() or setCurrentIndex() to show a particular page.

You can change a tab’s text and icon using setTabText() or setTabIcon() . A tab and its associated page can be removed with removeTab() .

Each tab is either enabled or disabled at any given time (see setTabEnabled() ). If a tab is enabled, the tab text is drawn normally and the user can select that tab. If it is disabled, the tab is drawn in a different way and the user cannot select that tab. Note that even if a tab is disabled, the page can still be visible, for example if all of the tabs happen to be disabled.

Tab widgets can be a very good way to split up a complex dialog. An alternative is to use a QStackedWidget for which you provide some means of navigating between pages, for example, a QToolBar or a QListWidget .

Most of the functionality in QTabWidget is provided by a QTabBar (at the top, providing the tabs) and a QStackedWidget (most of the area, organizing the individual pages).

See also

QTabBar QStackedWidget QToolBox Tab Dialog Example

class PySide6.QtWidgets.QTabWidget([parent=None])¶

Parameters: parent – PySide6.QtWidgets.QWidget

Constructs a tabbed widget with parent parent.

PySide6.QtWidgets.QTabWidget.TabPosition¶

This enum type defines where QTabWidget draws the tab row:

Constant

Description

QTabWidget.North

The tabs are drawn above the pages.

QTabWidget.South

The tabs are drawn below the pages.

QTabWidget.West

The tabs are drawn to the left of the pages.

QTabWidget.East

The tabs are drawn to the right of the pages.

PySide6.QtWidgets.QTabWidget.TabShape¶

This enum type defines the shape of the tabs:

Constant

Description

QTabWidget.Rounded

The tabs are drawn with a rounded look. This is the default shape.

QTabWidget.Triangular

The tabs are drawn with a triangular look.

PySide6.QtWidgets.QTabWidget.addTab(widget, icon, label)¶

Parameters

widget – PySide6.QtWidgets.QWidget
icon – PySide6.QtGui.QIcon
label – str

Return type

int

This is an overloaded function.

Adds a tab with the given page, icon, and label to the tab widget, and returns the index of the tab in the tab bar. Ownership of page is passed on to the QTabWidget .

This function is the same as addTab() , but with an additional icon.

PySide6.QtWidgets.QTabWidget.addTab(widget, arg__2)

Parameters

widget – PySide6.QtWidgets.QWidget
arg__2 – str

Return type

int

Adds a tab with the given page and label to the tab widget, and returns the index of the tab in the tab bar. Ownership of page is passed on to the QTabWidget .

If the tab’s label contains an ampersand, the letter following the ampersand is used as a shortcut for the tab, e.g. if the label is “Bro&wse” then Alt+W becomes a shortcut which will move the focus to this tab.

Note

If you call after show() , the layout system will try to adjust to the changes in its widgets hierarchy and may cause flicker. To prevent this, you can set the updatesEnabled property to false prior to changes; remember to set the property to true when the changes are done, making the widget receive paint events again.

Table of Contents

Previous topic

Next topic

QTabWidget¶

Synopsis¶

Functions¶

Virtual functions¶

Slots¶

Signals¶

Detailed Description¶

Constant	Description
QTabWidget.North	The tabs are drawn above the pages.
QTabWidget.South	The tabs are drawn below the pages.
QTabWidget.West	The tabs are drawn to the left of the pages.
QTabWidget.East	The tabs are drawn to the right of the pages.

Constant	Description
QTabWidget.Rounded	The tabs are drawn with a rounded look. This is the default shape.
QTabWidget.Triangular	The tabs are drawn with a triangular look.