class QToolBar#

The QToolBar class provides a movable panel that contains a set of controls. More…

Inheritance diagram of PySide6.QtWidgets.QToolBar

Synopsis#

Properties#

Methods#

Virtual methods#

Slots#

Signals#

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 toolbar is typically created by calling addToolBar(const QString &title) , but it can also be added as the first widget in a QVBoxLayout , for example.

Toolbar buttons are added by adding actions, using addAction() or insertAction() . Groups of buttons can be separated using addSeparator() or insertSeparator() . If a toolbar button is not appropriate, a widget can be inserted instead using addWidget() or insertWidget() . Examples of suitable widgets are QSpinBox , QDoubleSpinBox , and QComboBox . When a toolbar button is pressed, it emits the actionTriggered() signal.

A toolbar can be fixed in place in a particular area (e.g., at the top of the window), or it can be movable between toolbar areas; see setMovable() , isMovable() , allowedAreas() and isAreaAllowed() .

When a toolbar is resized in such a way that it is too small to show all the items it contains, an extension button will appear as the last item in the toolbar. Pressing the extension button will pop up a menu containing the items that do not currently fit in the toolbar.

When a QToolBar is not a child of a QMainWindow , it loses the ability to populate the extension pop up with widgets added to the toolbar using addWidget() . Please use widget actions created by inheriting QWidgetAction and implementing createWidget() instead.

Note

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

property allowedAreasᅟ: Combination of Qt.ToolBarArea#

This property holds areas where the toolbar may be placed.

The default is Qt::AllToolBarAreas.

This property only makes sense if the toolbar is in a QMainWindow .

See also

movable

Access functions:
property floatableᅟ: bool#

This property holds whether the toolbar can be dragged and dropped as an independent window..

The default is true.

Access functions:
property floatingᅟ: bool#

This property holds whether the toolbar is an independent window..

By default, this property is true.

See also

isWindow()

Access functions:
property iconSizeᅟ: QSize#

This property holds size of icons in the toolbar..

The default size is determined by the application’s style and is derived from the PM_ToolBarIconSize pixel metric. It is the maximum size an icon can have. Icons of smaller size will not be scaled up.

Access functions:
property movableᅟ: bool#

This property holds whether the user can move the toolbar within the toolbar area, or between toolbar areas..

By default, this property is true.

This property only makes sense if the toolbar is in a QMainWindow .

See also

allowedAreas

Access functions:
property orientationᅟ: Qt.Orientation#

This property holds orientation of the toolbar.

The default is Qt::Horizontal.

This function should not be used when the toolbar is managed by QMainWindow . You can use addToolBar() or insertToolBar() if you wish to move a toolbar that is already added to a main window to another Qt::ToolBarArea.

Access functions:
property toolButtonStyleᅟ: Qt.ToolButtonStyle#

This property holds the style of toolbar buttons.

This property defines the style of all tool buttons that are added as QActions. Note that if you add a QToolButton with the addWidget() method, it will not get this button style.

To have the style of toolbuttons follow the system settings, set this property to Qt::ToolButtonFollowStyle. On Unix, the user settings from the desktop environment will be used. On other platforms, Qt::ToolButtonFollowStyle means icon only.

The default is Qt::ToolButtonIconOnly.

Access functions:
__init__(title[, parent=None])#
Parameters:

Constructs a QToolBar with the given parent.

The given window title identifies the toolbar and is shown in the context menu provided by QMainWindow .

See also

setWindowTitle()

__init__([parent=None])
Parameters:

parent – QWidget

Constructs a QToolBar with the given parent.

actionAt(p)#
Parameters:

p – QPoint

Return type:

QAction

Returns the action at point p. This function returns zero if no action was found.

See also

childAt()

actionAt(x, y)
Parameters:

  • x – int

  • y – int

Return type:

QAction

This is an overloaded function.

Returns the action at the point x, y. This function returns zero if no action was found.

actionGeometry(action)#
Parameters:

action – QAction

Return type:

QRect

actionTriggered(action)#
Parameters:

action – QAction

This signal is emitted when an action in this toolbar is triggered. This happens when the action’s tool button is pressed, or when the action is triggered in some other way outside the toolbar. The parameter holds the triggered action.

addSeparator()#
Return type:

QAction

Adds a separator to the end of the toolbar.

addWidget(widget)#
Parameters:

widget – QWidget

Return type:

QAction

Adds the given widget to the toolbar as the toolbar’s last item.

The toolbar takes ownership of widget.

If you add a QToolButton with this method, the toolbar’s Qt::ToolButtonStyle will not be respected.

Note

You should use QAction::setVisible() to change the visibility of the widget. Using setVisible() , show() and hide() does not work.

See also

insertWidget()

allowedAreas()#
Return type:

Combination of ToolBarArea

See also

setAllowedAreas()

Getter of property allowedAreasᅟ .

allowedAreasChanged(allowedAreas)#
Parameters:

allowedAreas – Combination of ToolBarArea

This signal is emitted when the collection of allowed areas for the toolbar is changed. The new areas in which the toolbar can be positioned are specified by allowedAreas.

See also

allowedAreas

Notification signal of property allowedAreasᅟ .

clear()#

Removes all actions from the toolbar.

See also

removeAction()

iconSize()#
Return type:

QSize

See also

setIconSize()

Getter of property iconSizeᅟ .

iconSizeChanged(iconSize)#
Parameters:

iconSize – QSize

This signal is emitted when the icon size is changed. The iconSize parameter holds the toolbar’s new icon size.

See also

iconSize iconSize

Notification signal of property iconSizeᅟ .

initStyleOption(option)#
Parameters:

option – QStyleOptionToolBar

insertSeparator(before)#
Parameters:

before – QAction

Return type:

QAction

Inserts a separator into the toolbar in front of the toolbar item associated with the before action.

See also

addSeparator()

insertWidget(before, widget)#
Parameters:
Return type:

QAction

Inserts the given widget in front of the toolbar item associated with the before action.

Note: You should use QAction::setVisible() to change the visibility of the widget. Using setVisible() , show() and hide() does not work.

See also

addWidget()

isAreaAllowed(area)#
Parameters:

area – ToolBarArea

Return type:

bool

Returns true if this toolbar is dockable in the given area; otherwise returns false.

isFloatable()#
Return type:

bool

Getter of property floatableᅟ .

isFloating()#
Return type:

bool

Getter of property floatingᅟ .

isMovable()#
Return type:

bool

Getter of property movableᅟ .

movableChanged(movable)#
Parameters:

movable – bool

This signal is emitted when the toolbar becomes movable or fixed. If the toolbar can be moved, movable is true; otherwise it is false.

See also

movable

Notification signal of property movableᅟ .

orientation()#
Return type:

Orientation

See also

setOrientation()

Getter of property orientationᅟ .

orientationChanged(orientation)#
Parameters:

orientation – Orientation

This signal is emitted when the orientation of the toolbar changes. The orientation parameter holds the toolbar’s new orientation.

See also

orientation

Notification signal of property orientationᅟ .

setAllowedAreas(areas)#
Parameters:

areas – Combination of ToolBarArea

See also

allowedAreas()

Setter of property allowedAreasᅟ .

setFloatable(floatable)#
Parameters:

floatable – bool

See also

isFloatable()

Setter of property floatableᅟ .

setIconSize(iconSize)#
Parameters:

iconSize – QSize

See also

iconSize()

Setter of property iconSizeᅟ .

setMovable(movable)#
Parameters:

movable – bool

See also

isMovable()

Setter of property movableᅟ .

setOrientation(orientation)#
Parameters:

orientation – Orientation

See also

orientation()

Setter of property orientationᅟ .

setToolButtonStyle(toolButtonStyle)#
Parameters:

toolButtonStyle – ToolButtonStyle

See also

toolButtonStyle()

Setter of property toolButtonStyleᅟ .

toggleViewAction()#
Return type:

QAction

Returns a checkable action that can be used to show or hide this toolbar.

The action’s text is set to the toolbar’s window title.

See also

windowTitle

toolButtonStyle()#
Return type:

ToolButtonStyle

See also

setToolButtonStyle()

Getter of property toolButtonStyleᅟ .

toolButtonStyleChanged(toolButtonStyle)#
Parameters:

toolButtonStyle – ToolButtonStyle

This signal is emitted when the tool button style is changed. The toolButtonStyle parameter holds the toolbar’s new tool button style.

Notification signal of property toolButtonStyleᅟ .

topLevelChanged(topLevel)#
Parameters:

topLevel – bool

This signal is emitted when the floating property changes. The topLevel parameter is true if the toolbar is now floating; otherwise it is false.

See also

isWindow()

visibilityChanged(visible)#
Parameters:

visible – bool

This signal is emitted when the toolbar becomes visible (or invisible). This happens when the widget is hidden or shown.

widgetForAction(action)#
Parameters:

action – QAction

Return type:

QWidget

Returns the widget associated with the specified action.

See also

addWidget()