PySide6.QtWidgets.QToolBox

class QToolBox

The QToolBox class provides a column of tabbed widget items. More…

Synopsis

Properties

• countᅟ - Number of items contained in the toolbox

• currentIndexᅟ - The index of the current item

Methods

• def __init__()

• def addItem()

• def count()

• def currentIndex()

• def currentWidget()

• def indexOf()

• def insertItem()

• def isItemEnabled()

• def itemIcon()

• def itemText()

• def itemToolTip()

• def removeItem()

• def setItemEnabled()

• def setItemIcon()

• def setItemText()

• def setItemToolTip()

• def widget()

Virtual methods

• def itemInserted()

• def itemRemoved()

Slots

• def setCurrentIndex()

• def setCurrentWidget()

Signals

• def currentChanged()

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

A toolbox is a widget that displays a column of tabs one above the other, with the current item displayed below the current tab. Every tab has an index position within the column of tabs. A tab’s item is a QWidget .

Each item has an itemText() , an optional itemIcon() , an optional itemToolTip() , and a widget() . The item’s attributes can be changed with setItemText() , setItemIcon() , and setItemToolTip() . Each item can be enabled or disabled individually with setItemEnabled() .

Items are added using addItem() , or inserted at particular positions using insertItem() . The total number of items is given by count() . Items can be deleted with delete, or removed from the toolbox with removeItem() . Combining removeItem() and insertItem() allows you to move items to different positions.

The index of the current item widget is returned by currentIndex() , and set with setCurrentIndex() . The index of a particular item can be found using indexOf() , and the item at a given index is returned by item().

The currentChanged() signal is emitted when the current item is changed.

See also

QTabWidget

Note

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

property countᅟ: int

This property holds The number of items contained in the toolbox..

By default, this property has a value of 0.

Access functions:

• count()

property currentIndexᅟ: int

This property holds the index of the current item.

By default, for an empty toolbox, this property has a value of -1.

See also

indexOf() widget()

Access functions:

• currentIndex()

• setCurrentIndex()

• Signal currentChanged()

__init__([parent=None[, f=Qt.WindowFlags()]])

Parameters:

• parent – QWidget

• f – Combination of WindowType

Constructs a new toolbox with the given parent and the flags, f.

addItem(widget, text)

Parameters:

• widget – QWidget

• text – str

Return type:

int

This is an overloaded function.

Adds the widget w in a new tab at bottom of the toolbox. The new tab’s text is set to text. Returns the new tab’s index.

addItem(widget, icon, text)

Parameters:

• widget – QWidget

• icon – QIcon

• text – str

Return type:

int

Adds the widget in a new tab at bottom of the toolbox. The new tab’s text is set to text, and the iconSet is displayed to the left of the text. Returns the new tab’s index.

count()

Return type:

int

Getter of property countᅟ .

currentChanged(index)

Parameters:

index – int

This signal is emitted when the current item is changed. The new current item’s index is passed in index, or -1 if there is no current item.

Notification signal of property currentIndexᅟ .

currentIndex()

Return type:

int

See also

setCurrentIndex()

Getter of property currentIndexᅟ .

currentWidget()

Return type:

QWidget

Returns a pointer to the current widget, or None if there is no such item.

See also

currentIndex() setCurrentWidget()

indexOf(widget)

Parameters:

widget – QWidget

Return type:

int

Returns the index of widget, or -1 if the item does not exist.

insertItem(index, widget, text)

Parameters:

• index – int

• widget – QWidget

• text – str

Return type:

int

This is an overloaded function.

Inserts the widget at position index, or at the bottom of the toolbox if index is out of range. The new item’s text is set to text. Returns the new item’s index.

insertItem(index, widget, icon, text)

Parameters:

• index – int

• widget – QWidget

• icon – QIcon

• text – str

Return type:

int

Inserts the widget at position index, or at the bottom of the toolbox if index is out of range. The new item’s text is set to text, and the icon is displayed to the left of the text. Returns the new item’s index.

isItemEnabled(index)

Parameters:

index – int

Return type:

bool

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

itemIcon(index)

Parameters:

index – int

Return type:

QIcon

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

See also

setItemIcon()

itemInserted(index)

Parameters:

index – int

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

See also

itemRemoved()

itemRemoved(index)

Parameters:

index – int

This virtual handler is called after an item was removed from position index.

See also

itemInserted()

itemText(index)

Parameters:

index – int

Return type:

str

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

See also

setItemText()

itemToolTip(index)

Parameters:

index – int

Return type:

str

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

See also

setItemToolTip()

removeItem(index)

Parameters:

index – int

Removes the item at position index from the toolbox. Note that the widget is not deleted.

setCurrentIndex(index)

Parameters:

index – int

See also

currentIndex()

Setter of property currentIndexᅟ .

setCurrentWidget(widget)

Parameters:

widget – QWidget

Makes``widget`` the current widget. The widget must be an item in this tool box.

See also

addItem() setCurrentIndex() currentWidget()

setItemEnabled(index, enabled)

Parameters:

• index – int

• enabled – bool

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

See also

isItemEnabled()

setItemIcon(index, icon)

Parameters:

• index – int

• icon – QIcon

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

See also

itemIcon()

setItemText(index, text)

Parameters:

• index – int

• text – str

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

If the provided text contains an ampersand character (’&’), a mnemonic is automatically created for it. The character that follows the ‘&’ will be used as the shortcut key. Any previous mnemonic will be overwritten, or cleared if no mnemonic is defined by the text. See the QShortcut documentation for details (to display an actual ampersand, use ‘&&’).

See also

itemText()

setItemToolTip(index, toolTip)

Parameters:

• index – int

• toolTip – str

Sets the tooltip of the item at position index to toolTip.

See also

itemToolTip()

widget(index)

Parameters:

index – int

Return type:

QWidget

Returns the widget at position index, or None if there is no such item.