Tool Box Widget (toolbox)

Tool Box Widget

A reimplementation of the QToolBox widget that keeps all the tabs in a single QScrollArea instance and can keep multiple open tabs.

class orangecanvas.gui.toolbox.ToolBox(parent: Optional[PyQt5.QtWidgets.QWidget] = None, **kwargs: Any)

Bases: PyQt5.QtWidgets.QFrame

A tool box widget.

tabToggled(index: int, state: bool)

Signal emitted when a tab at index is toggled.

setExclusive(exclusive: bool) → None

Set exclusive tabs (only one tab can be open at a time).

exclusive() → bool

Are the tabs in the toolbox exclusive.

exclusive_

Exclusive tabs

setTabButtonHeight(height: int) → None

Set the tab button height.

tabButtonHeight() → int

Return the tab button height.

setTabIconSize(size: PyQt5.QtCore.QSize) → None

Set the tab button icon size.

tabIconSize() → PyQt5.QtCore.QSize

Return the tab icon size.

tabButton(index: int) → PyQt5.QtWidgets.QAbstractButton

Return the tab button at index

tabAction(index: int) → PyQt5.QtWidgets.QAction

Return open/close action for the tab at index.

addItem(widget: PyQt5.QtWidgets.QWidget, text: str, icon: PyQt5.QtGui.QIcon = <PyQt5.QtGui.QIcon object>, toolTip: str = '') → int

Append the widget in a new tab and return its index.

Parameters

• widget (QWidget) – A widget to be inserted. The toolbox takes ownership of the widget.

• text (str) – Name/title of the new tab.

• icon (QIcon) – An icon for the tab button.

• toolTip (str) – Tool tip for the tab button.

Returns

index – Index of the inserted tab

Return type

int

insertItem(index: int, widget: PyQt5.QtWidgets.QWidget, text: str, icon: PyQt5.QtGui.QIcon = <PyQt5.QtGui.QIcon object>, toolTip: str = '') → int

Insert the widget in a new tab at position index.

See also

ToolBox.addItem

removeItem(index: int) → None

Remove the widget at index.

Note

The widget is hidden but is is not deleted. It is up to the caller to delete it.

count() → int

Return the number of widgets inserted in the toolbox.

widget(index: int) → PyQt5.QtWidgets.QWidget

Return the widget at index.

createTabButton(widget: PyQt5.QtWidgets.QWidget, text: str, icon: PyQt5.QtGui.QIcon = <PyQt5.QtGui.QIcon object>, toolTip: str = '') → PyQt5.QtWidgets.QAbstractButton

Create the tab button for widget.

ensureWidgetVisible(child: PyQt5.QtWidgets.QWidget, xmargin: int = 50, ymargin: int = 50) → None

Scroll the contents so child widget instance is visible inside the viewport.

sizeHint() → PyQt5.QtCore.QSize

Reimplemented.