QToolBox

Synopsis

Functions

• def addItem (widget, icon, text)
• def addItem (widget, text)
• def count ()
• def currentIndex ()
• def currentWidget ()
• def indexOf (widget)
• def insertItem (index, widget, icon, text)
• def insertItem (index, widget, text)
• def isItemEnabled (index)
• def itemIcon (index)
• def itemText (index)
• def itemToolTip (index)
• def removeItem (index)
• def setItemEnabled (index, enabled)
• def setItemIcon (index, icon)
• def setItemText (index, text)
• def setItemToolTip (index, toolTip)
• def widget (index)

Virtual functions

• def itemInserted (index)
• def itemRemoved (index)

Slots

• def setCurrentIndex (index)
• def setCurrentWidget (widget)

Signals

• def currentChanged (index)

Detailed Description

The PySide.QtGui.QToolBox class provides a column of tabbed widget items.

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 PySide.QtGui.QWidget .

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

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

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

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

See also

PySide.QtGui.QTabWidget

class PySide.QtGui.QToolBox([parent=None[, f=0]])

Parameters:

• f – PySide.QtCore.Qt.WindowFlags
• parent – PySide.QtGui.QWidget

PySide.QtGui.QToolBox.addItem(widget, text)

Parameters:

• widget – PySide.QtGui.QWidget
• text – unicode

Return type:

PySide.QtCore.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.

PySide.QtGui.QToolBox.addItem(widget, icon, text)

Parameters:

• widget – PySide.QtGui.QWidget
• icon – PySide.QtGui.QIcon
• text – unicode

Return type:

PySide.QtCore.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.

PySide.QtGui.QToolBox.count()

Return type:PySide.QtCore.int

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

By default, this property has a value of 0.

PySide.QtGui.QToolBox.currentChanged(index)

Parameters:index – PySide.QtCore.int

PySide.QtGui.QToolBox.currentIndex()

Return type:PySide.QtCore.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

PySide.QtGui.QToolBox.indexOf() PySide.QtGui.QToolBox.widget()

PySide.QtGui.QToolBox.currentWidget()

Return type:PySide.QtGui.QWidget

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

See also

PySide.QtGui.QToolBox.currentIndex() PySide.QtGui.QToolBox.setCurrentWidget()

PySide.QtGui.QToolBox.indexOf(widget)

Parameters:widget – PySide.QtGui.QWidget Return type:PySide.QtCore.int

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

PySide.QtGui.QToolBox.insertItem(index, widget, icon, text)

Parameters:

• index – PySide.QtCore.int
• widget – PySide.QtGui.QWidget
• icon – PySide.QtGui.QIcon
• text – unicode

Return type:

PySide.QtCore.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.

PySide.QtGui.QToolBox.insertItem(index, widget, text)

Parameters:

• index – PySide.QtCore.int
• widget – PySide.QtGui.QWidget
• text – unicode

Return type:

PySide.QtCore.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.

PySide.QtGui.QToolBox.isItemEnabled(index)

Parameters:index – PySide.QtCore.int Return type:PySide.QtCore.bool

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

PySide.QtGui.QToolBox.itemIcon(index)

Parameters:index – PySide.QtCore.int Return type:PySide.QtGui.QIcon

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

See also

PySide.QtGui.QToolBox.setItemIcon()

PySide.QtGui.QToolBox.itemInserted(index)

Parameters:index – PySide.QtCore.int

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

See also

PySide.QtGui.QToolBox.itemRemoved()

PySide.QtGui.QToolBox.itemRemoved(index)

Parameters:index – PySide.QtCore.int

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

See also

PySide.QtGui.QToolBox.itemInserted()

PySide.QtGui.QToolBox.itemText(index)

Parameters:index – PySide.QtCore.int Return type:unicode

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

See also

PySide.QtGui.QToolBox.setItemText()

PySide.QtGui.QToolBox.itemToolTip(index)

Parameters:index – PySide.QtCore.int Return type:unicode

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

See also

PySide.QtGui.QToolBox.setItemToolTip()

PySide.QtGui.QToolBox.removeItem(index)

Parameters:index – PySide.QtCore.int

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

PySide.QtGui.QToolBox.setCurrentIndex(index)

Parameters:index – PySide.QtCore.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

PySide.QtGui.QToolBox.indexOf() PySide.QtGui.QToolBox.widget()

PySide.QtGui.QToolBox.setCurrentWidget(widget)

Parameters:widget – PySide.QtGui.QWidget

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

See also

PySide.QtGui.QToolBox.addItem() PySide.QtGui.QToolBox.setCurrentIndex() PySide.QtGui.QToolBox.currentWidget()

PySide.QtGui.QToolBox.setItemEnabled(index, enabled)

Parameters:

• index – PySide.QtCore.int
• enabled – PySide.QtCore.bool

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

See also

PySide.QtGui.QToolBox.isItemEnabled()

PySide.QtGui.QToolBox.setItemIcon(index, icon)

Parameters:

• index – PySide.QtCore.int
• icon – PySide.QtGui.QIcon

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

See also

PySide.QtGui.QToolBox.itemIcon()

PySide.QtGui.QToolBox.setItemText(index, text)

Parameters:

• index – PySide.QtCore.int
• text – unicode

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

PySide.QtGui.QToolBox.itemText()

PySide.QtGui.QToolBox.setItemToolTip(index, toolTip)

Parameters:

• index – PySide.QtCore.int
• toolTip – unicode

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

See also

PySide.QtGui.QToolBox.itemToolTip()

PySide.QtGui.QToolBox.widget(index)

Parameters:index – PySide.QtCore.int Return type:PySide.QtGui.QWidget

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