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 tabschangeCurrentOnDrag
- If true, then the current tab is automatically changed when dragging over the tabbarcount
- The number of tabs in the tab barcurrentIndex
- The index of the tab bar’s visible tabdocumentMode
- Whether or not the tab bar is rendered in a mode suitable for the main windowdrawBase
- Defines whether or not tab bar should draw its baseelideMode
- How to elide text in the tab barexpanding
- When expanding is true QTabBar will expand the tabs to use the empty spaceiconSize
- Size for icons in the tab barmovable
- This property holds whether the user can move the tabs within the tabbar areaselectionBehaviorOnRemove
- What tab should be set as current when removeTab is called if the removed tab is also the current tabshape
- The shape of the tabs in the tab bartabsClosable
- Whether or not a tab bar should place close buttons on each tabusesScrollButtons
- Whether or not a tab bar should use buttons to scroll tabs when it has many tabs
Functions#
def
accessibleTabName
(index)def
addTab
(icon, text)def
addTab
(text)def
autoHide
()def
changeCurrentOnDrag
()def
count
()def
currentIndex
()def
documentMode
()def
drawBase
()def
elideMode
()def
expanding
()def
iconSize
()def
insertTab
(index, icon, text)def
insertTab
(index, text)def
isMovable
()def
isTabEnabled
(index)def
isTabVisible
(index)def
moveTab
(from, to)def
removeTab
(index)def
selectionBehaviorOnRemove
()def
setAccessibleTabName
(index, name)def
setAutoHide
(hide)def
setChangeCurrentOnDrag
(change)def
setDocumentMode
(set)def
setDrawBase
(drawTheBase)def
setElideMode
(mode)def
setExpanding
(enabled)def
setIconSize
(size)def
setMovable
(movable)def
setSelectionBehaviorOnRemove
(behavior)def
setShape
(shape)def
setTabButton
(index, position, widget)def
setTabData
(index, data)def
setTabEnabled
(index, enabled)def
setTabIcon
(index, icon)def
setTabText
(index, text)def
setTabTextColor
(index, color)def
setTabToolTip
(index, tip)def
setTabVisible
(index, visible)def
setTabWhatsThis
(index, text)def
setTabsClosable
(closable)def
setUsesScrollButtons
(useButtons)def
shape
()def
tabAt
(pos)def
tabButton
(index, position)def
tabData
(index)def
tabIcon
(index)def
tabRect
(index)def
tabText
(index)def
tabTextColor
(index)def
tabToolTip
(index)def
tabWhatsThis
(index)def
tabsClosable
()def
usesScrollButtons
()
Virtual functions#
def
initStyleOption
(option, tabIndex)def
minimumTabSizeHint
(index)def
tabInserted
(index)def
tabLayoutChange
()def
tabRemoved
(index)def
tabSizeHint
(index)
Slots#
def
setCurrentIndex
(index)
Signals#
def
currentChanged
(index)def
tabBarClicked
(index)def
tabBarDoubleClicked
(index)def
tabCloseRequested
(index)def
tabMoved
(from, to)
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.
Screenshot of a Fusion style tab bar
A tab bar shown in the Fusion widget style .
Screenshot of a truncated Fusion tab bar
A truncated tab bar shown in the Fusion widget style.
See also
- class PySide6.QtWidgets.QTabBar([parent=None])#
- Parameters:
parent –
PySide6.QtWidgets.QWidget
Creates a new tab bar with the given parent
.
Note
Properties can be used directly when from __feature__ import true_property
is used or via accessor functions otherwise.
- property PᅟySide6.QtWidgets.QTabBar.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
(hide)
- property PᅟySide6.QtWidgets.QTabBar.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:
setChangeCurrentOnDrag
(change)
- property PᅟySide6.QtWidgets.QTabBar.count: int#
This property holds the number of tabs in the tab bar.
- Access functions:
count
()
- property PᅟySide6.QtWidgets.QTabBar.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
(index)Signal
currentChanged
(index)
- property PᅟySide6.QtWidgets.QTabBar.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
- Access functions:
documentMode
()setDocumentMode
(set)
- property PᅟySide6.QtWidgets.QTabBar.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
(drawTheBase)
- property PᅟySide6.QtWidgets.QTabBar.elideMode: 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
(mode)
- property PᅟySide6.QtWidgets.QTabBar.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
- Access functions:
expanding
()setExpanding
(enabled)
- property PᅟySide6.QtWidgets.QTabBar.iconSize: PySide6.QtCore.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
- Access functions:
iconSize
()setIconSize
(size)
- property PᅟySide6.QtWidgets.QTabBar.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
(movable)
- property PᅟySide6.QtWidgets.QTabBar.selectionBehaviorOnRemove: 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
- Access functions:
setSelectionBehaviorOnRemove
(behavior)
- property PᅟySide6.QtWidgets.QTabBar.shape: Shape#
This property holds the shape of the tabs in the tab bar.
Possible values for this property are described by the Shape enum.
- property PᅟySide6.QtWidgets.QTabBar.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
- Access functions:
tabsClosable
()setTabsClosable
(closable)
- property PᅟySide6.QtWidgets.QTabBar.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:
setUsesScrollButtons
(useButtons)
- PySide6.QtWidgets.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
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.
- PySide6.QtWidgets.QTabBar.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.
- PySide6.QtWidgets.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
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.
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.addTab(icon, text)#
- Parameters:
icon –
PySide6.QtGui.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.
- PySide6.QtWidgets.QTabBar.addTab(text)
- Parameters:
text – str
- Return type:
int
Adds a new tab with text text
. Returns the new tab’s index.
- PySide6.QtWidgets.QTabBar.autoHide()#
- Return type:
bool
See also
Getter of property autoHide
.
- PySide6.QtWidgets.QTabBar.changeCurrentOnDrag()#
- Return type:
bool
See also
Getter of property changeCurrentOnDrag
.
- PySide6.QtWidgets.QTabBar.count()#
- Return type:
int
Getter of property count
.
- PySide6.QtWidgets.QTabBar.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
.
- PySide6.QtWidgets.QTabBar.currentIndex()#
- Return type:
int
See also
Getter of property currentIndex
.
- PySide6.QtWidgets.QTabBar.documentMode()#
- Return type:
bool
See also
Getter of property documentMode
.
- PySide6.QtWidgets.QTabBar.drawBase()#
- Return type:
bool
See also
Getter of property drawBase
.
- PySide6.QtWidgets.QTabBar.elideMode()#
- Return type:
See also
Getter of property elideMode
.
- PySide6.QtWidgets.QTabBar.expanding()#
- Return type:
bool
See also
Getter of property expanding
.
- PySide6.QtWidgets.QTabBar.iconSize()#
- Return type:
See also
Getter of property iconSize
.
- PySide6.QtWidgets.QTabBar.initStyleOption(option, tabIndex)#
- Parameters:
option –
PySide6.QtWidgets.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
- PySide6.QtWidgets.QTabBar.insertTab(index, icon, text)#
- Parameters:
index – int
icon –
PySide6.QtGui.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.
- PySide6.QtWidgets.QTabBar.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.
- PySide6.QtWidgets.QTabBar.isMovable()#
- Return type:
bool
Getter of property movable
.
- PySide6.QtWidgets.QTabBar.isTabEnabled(index)#
- Parameters:
index – int
- Return type:
bool
Returns true
if the tab at position index
is enabled; otherwise returns false
.
- PySide6.QtWidgets.QTabBar.isTabVisible(index)#
- Parameters:
index – int
- Return type:
bool
Returns true if the tab at position index
is visible; otherwise returns false.
- PySide6.QtWidgets.QTabBar.minimumTabSizeHint(index)#
- Parameters:
index – int
- Return type:
Returns the minimum tab size hint for the tab at position index
.
- PySide6.QtWidgets.QTabBar.moveTab(from, to)#
- Parameters:
from – int
to – int
Moves the item at index position from
to index position to
.
See also
- PySide6.QtWidgets.QTabBar.removeTab(index)#
- Parameters:
index – int
Removes the tab at position index
.
See also
SelectionBehavior
- PySide6.QtWidgets.QTabBar.selectionBehaviorOnRemove()#
- Return type:
See also
Getter of property selectionBehaviorOnRemove
.
- PySide6.QtWidgets.QTabBar.setAccessibleTabName(index, name)#
- Parameters:
index – int
name – str
Sets the accessibleName of the tab at position index
to name
.
See also
- PySide6.QtWidgets.QTabBar.setAutoHide(hide)#
- Parameters:
hide – bool
See also
Setter of property autoHide
.
- PySide6.QtWidgets.QTabBar.setChangeCurrentOnDrag(change)#
- Parameters:
change – bool
See also
Setter of property changeCurrentOnDrag
.
- PySide6.QtWidgets.QTabBar.setCurrentIndex(index)#
- Parameters:
index – int
See also
Setter of property currentIndex
.
- PySide6.QtWidgets.QTabBar.setDocumentMode(set)#
- Parameters:
set – bool
See also
Setter of property documentMode
.
- PySide6.QtWidgets.QTabBar.setDrawBase(drawTheBase)#
- Parameters:
drawTheBase – bool
See also
Setter of property drawBase
.
- PySide6.QtWidgets.QTabBar.setElideMode(mode)#
- Parameters:
mode –
TextElideMode
See also
Setter of property elideMode
.
- PySide6.QtWidgets.QTabBar.setExpanding(enabled)#
- Parameters:
enabled – bool
See also
Setter of property expanding
.
- PySide6.QtWidgets.QTabBar.setIconSize(size)#
- Parameters:
size –
PySide6.QtCore.QSize
See also
Setter of property iconSize
.
- PySide6.QtWidgets.QTabBar.setMovable(movable)#
- Parameters:
movable – bool
See also
Setter of property movable
.
- PySide6.QtWidgets.QTabBar.setSelectionBehaviorOnRemove(behavior)#
- Parameters:
behavior –
SelectionBehavior
See also
Setter of property selectionBehaviorOnRemove
.
Setter of property shape
.
- PySide6.QtWidgets.QTabBar.setTabButton(index, position, widget)#
- Parameters:
index – int
position –
ButtonPosition
widget –
PySide6.QtWidgets.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
- PySide6.QtWidgets.QTabBar.setTabData(index, data)#
- Parameters:
index – int
data – object
Sets the data of the tab at position index
to data
.
See also
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.setTabIcon(index, icon)#
- Parameters:
index – int
icon –
PySide6.QtGui.QIcon
Sets the icon of the tab at position index
to icon
.
See also
- PySide6.QtWidgets.QTabBar.setTabText(index, text)#
- Parameters:
index – int
text – str
Sets the text of the tab at position index
to text
.
See also
- PySide6.QtWidgets.QTabBar.setTabTextColor(index, color)#
- Parameters:
index – int
color –
PySide6.QtGui.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
- PySide6.QtWidgets.QTabBar.setTabToolTip(index, tip)#
- Parameters:
index – int
tip – str
Sets the tool tip of the tab at position index
to tip
.
See also
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.setTabsClosable(closable)#
- Parameters:
closable – bool
See also
Setter of property tabsClosable
.
- PySide6.QtWidgets.QTabBar.setUsesScrollButtons(useButtons)#
- Parameters:
useButtons – bool
See also
Setter of property usesScrollButtons
.
- PySide6.QtWidgets.QTabBar.shape()#
- Return type:
See also
Getter of property shape
.
- PySide6.QtWidgets.QTabBar.tabAt(pos)#
- Parameters:
pos –
PySide6.QtCore.QPoint
- Return type:
int
Returns the index of the tab that covers position
or -1 if no tab covers position
;
- PySide6.QtWidgets.QTabBar.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.
- PySide6.QtWidgets.QTabBar.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.
- PySide6.QtWidgets.QTabBar.tabButton(index, position)#
- Parameters:
index – int
position –
ButtonPosition
- Return type:
Returns the widget set a tab index
and position
or None
if one is not set.
See also
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.tabIcon(index)#
- Parameters:
index – int
- Return type:
Returns the icon of the tab at position index
, or a null icon if index
is out of range.
See also
- PySide6.QtWidgets.QTabBar.tabInserted(index)#
- Parameters:
index – int
This virtual handler is called after a new tab was added or inserted at position index
.
See also
- PySide6.QtWidgets.QTabBar.tabLayoutChange()#
This virtual handler is called whenever the tab layout changes.
See also
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.tabRect(index)#
- Parameters:
index – int
- Return type:
Returns the visual rectangle of the tab at position index
, or a null rectangle if index
is hidden, or out of range.
- PySide6.QtWidgets.QTabBar.tabRemoved(index)#
- Parameters:
index – int
This virtual handler is called after a tab was removed from position index
.
See also
- PySide6.QtWidgets.QTabBar.tabSizeHint(index)#
- Parameters:
index – int
- Return type:
Returns the size hint for the tab at position index
.
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.tabTextColor(index)#
- Parameters:
index – int
- Return type:
Returns the text color of the tab with the given index
, or a invalid color if index
is out of range.
See also
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.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
- PySide6.QtWidgets.QTabBar.tabsClosable()#
- Return type:
bool
See also
Getter of property tabsClosable
.
- PySide6.QtWidgets.QTabBar.usesScrollButtons()#
- Return type:
bool
See also
Getter of property usesScrollButtons
.