QToolBar

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

Inheritance diagram of PySide2.QtWidgets.QToolBar

Synopsis

Functions

Slots

Signals

Detailed Description

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.

See also

QToolButton QMenu QAction Application Example

class PySide2.QtWidgets.QToolBar([parent=None])

PySide2.QtWidgets.QToolBar(title[, parent=None])

param parent:

PySide2.QtWidgets.QWidget

param title:

str

Constructs a QToolBar with the given parent .

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()

PySide2.QtWidgets.QToolBar.actionAt(p)
Parameters:

p – PySide2.QtCore.QPoint

Return type:

PySide2.QtWidgets.QAction

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

See also

childAt()

PySide2.QtWidgets.QToolBar.actionAt(x, y)
Parameters:

  • x – int

  • y – int

Return type:

PySide2.QtWidgets.QAction

This is an overloaded function.

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

PySide2.QtWidgets.QToolBar.actionGeometry(action)
Parameters:

action – PySide2.QtWidgets.QAction

Return type:

PySide2.QtCore.QRect

Returns the geometry of the toolbar item associated with the given action , or an invalid QRect if no matching item is found.

PySide2.QtWidgets.QToolBar.actionTriggered(action)
Parameters:

action – PySide2.QtWidgets.QAction

PySide2.QtWidgets.QToolBar.addAction(icon, text)
Parameters:
Return type:

PySide2.QtWidgets.QAction

PySide2.QtWidgets.QToolBar.addAction(icon, text, receiver)
Parameters:
Return type:

PySide2.QtWidgets.QAction

PySide2.QtWidgets.QToolBar.addAction(text)
Parameters:

text – str

Return type:

PySide2.QtWidgets.QAction

Creates a new action with the given text . This action is added to the end of the toolbar.

PySide2.QtWidgets.QToolBar.addAction(text, receiver)
Parameters:
Return type:

PySide2.QtWidgets.QAction

PySide2.QtWidgets.QToolBar.addSeparator()
Return type:

PySide2.QtWidgets.QAction

Adds a separator to the end of the toolbar.

See also

insertSeparator()

PySide2.QtWidgets.QToolBar.addWidget(widget)
Parameters:

widget – PySide2.QtWidgets.QWidget

Return type:

PySide2.QtWidgets.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 ToolButtonStyle will not be respected.

Note

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

See also

insertWidget()

PySide2.QtWidgets.QToolBar.allowedAreas()
Return type:

ToolBarAreas

This property holds areas where the toolbar may be placed.

The default is AllToolBarAreas .

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

See also

movable

PySide2.QtWidgets.QToolBar.allowedAreasChanged(allowedAreas)
Parameters:

allowedAreas – ToolBarAreas

PySide2.QtWidgets.QToolBar.clear()

Removes all actions from the toolbar.

See also

removeAction()

PySide2.QtWidgets.QToolBar.iconSize()
Return type:

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

PySide2.QtWidgets.QToolBar.iconSizeChanged(iconSize)
Parameters:

iconSize – PySide2.QtCore.QSize

PySide2.QtWidgets.QToolBar.initStyleOption(option)
Parameters:

option – PySide2.QtWidgets.QStyleOptionToolBar

PySide2.QtWidgets.QToolBar.insertSeparator(before)
Parameters:

before – PySide2.QtWidgets.QAction

Return type:

PySide2.QtWidgets.QAction

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

See also

addSeparator()

PySide2.QtWidgets.QToolBar.insertWidget(before, widget)
Parameters:
Return type:

PySide2.QtWidgets.QAction

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

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

See also

addWidget()

PySide2.QtWidgets.QToolBar.isAreaAllowed(area)
Parameters:

area – ToolBarArea

Return type:

bool

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

PySide2.QtWidgets.QToolBar.isFloatable()
Return type:

bool

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

The default is true.

PySide2.QtWidgets.QToolBar.isFloating()
Return type:

bool

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

By default, this property is true .

See also

isWindow()

PySide2.QtWidgets.QToolBar.isMovable()
Return type:

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

PySide2.QtWidgets.QToolBar.movableChanged(movable)
Parameters:

movable – bool

PySide2.QtWidgets.QToolBar.orientation()
Return type:

Orientation

This property holds orientation of the toolbar.

The default is 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 ToolBarArea .

PySide2.QtWidgets.QToolBar.orientationChanged(orientation)
Parameters:

orientation – Orientation

PySide2.QtWidgets.QToolBar.setAllowedAreas(areas)
Parameters:

areas – ToolBarAreas

This property holds areas where the toolbar may be placed.

The default is AllToolBarAreas .

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

See also

movable

PySide2.QtWidgets.QToolBar.setFloatable(floatable)
Parameters:

floatable – bool

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

The default is true.

PySide2.QtWidgets.QToolBar.setIconSize(iconSize)
Parameters:

iconSize – PySide2.QtCore.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.

PySide2.QtWidgets.QToolBar.setMovable(movable)
Parameters:

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

PySide2.QtWidgets.QToolBar.setOrientation(orientation)
Parameters:

orientation – Orientation

This property holds orientation of the toolbar.

The default is 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 ToolBarArea .

PySide2.QtWidgets.QToolBar.setToolButtonStyle(toolButtonStyle)
Parameters:

toolButtonStyle – ToolButtonStyle

This property holds the style of toolbar buttons.

This property defines the style of all tool buttons that are added as QAction s. 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 ToolButtonFollowStyle . On Unix, the user settings from the desktop environment will be used. On other platforms, ToolButtonFollowStyle means icon only.

The default is ToolButtonIconOnly .

PySide2.QtWidgets.QToolBar.toggleViewAction()
Return type:

PySide2.QtWidgets.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

text windowTitle

PySide2.QtWidgets.QToolBar.toolButtonStyle()
Return type:

ToolButtonStyle

This property holds the style of toolbar buttons.

This property defines the style of all tool buttons that are added as QAction s. 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 ToolButtonFollowStyle . On Unix, the user settings from the desktop environment will be used. On other platforms, ToolButtonFollowStyle means icon only.

The default is ToolButtonIconOnly .

PySide2.QtWidgets.QToolBar.toolButtonStyleChanged(toolButtonStyle)
Parameters:

toolButtonStyle – ToolButtonStyle

PySide2.QtWidgets.QToolBar.topLevelChanged(topLevel)
Parameters:

topLevel – bool

PySide2.QtWidgets.QToolBar.visibilityChanged(visible)
Parameters:

visible – bool

PySide2.QtWidgets.QToolBar.widgetForAction(action)
Parameters:

action – PySide2.QtWidgets.QAction

Return type:

PySide2.QtWidgets.QWidget

Returns the widget associated with the specified action .

See also

addWidget()