PySide6.QtWidgets.QToolButton

class QToolButton

The QToolButton class provides a quick-access button to commands or options, usually used inside a QToolBar . More…

Inheritance diagram of PySide6.QtWidgets.QToolButton

Synopsis

Properties

  • arrowTypeᅟ - Whether the button displays an arrow instead of a normal icon

  • autoRaiseᅟ - Whether auto-raising is enabled or not

  • popupModeᅟ - Describes the way that popup menus are used with tool buttons

  • toolButtonStyleᅟ - Whether the tool button displays an icon only, text only, or text beside/below the icon

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 tool button is a special button that provides quick-access to specific commands or options. As opposed to a normal command button, a tool button usually doesn’t show a text label, but shows an icon instead.

Tool buttons are normally created when new QAction instances are created with addAction() or existing actions are added to a toolbar with addAction() . It is also possible to construct tool buttons in the same way as any other widget, and arrange them alongside other widgets in layouts.

One classic use of a tool button is to select tools; for example, the “pen” tool in a drawing program. This would be implemented by using a QToolButton as a toggle button (see setCheckable() ).

QToolButton supports auto-raising. In auto-raise mode, the button draws a 3D frame only when the mouse points at it. The feature is automatically turned on when a button is used inside a QToolBar . Change it with setAutoRaise() .

A tool button’s icon is set as QIcon. This makes it possible to specify different pixmaps for the disabled and active state. The disabled pixmap is used when the button’s functionality is not available. The active pixmap is displayed when the button is auto-raised because the mouse pointer is hovering over it.

The button’s look and dimension is adjustable with setToolButtonStyle() and setIconSize() . When used inside a QToolBar in a QMainWindow , the button automatically adjusts to QMainWindow ‘s settings (see setToolButtonStyle() and setIconSize() ). Instead of an icon, a tool button can also display an arrow symbol, specified with arrowType .

A tool button can offer additional choices in a popup menu. The popup menu can be set using setMenu() . Use setPopupMode() to configure the different modes available for tool buttons with a menu set. The default mode is DelayedPopupMode which is sometimes used with the “Back” button in a web browser. After pressing and holding the button down for a while, a menu pops up showing a list of possible pages to jump to. The timeout is style dependent, see SH_ToolButton_PopupDelay .

assistant-toolbar1 Qt Assistant’s toolbar with tool buttons

Qt Assistant’s toolbar contains tool buttons that are associated with actions used in other parts of the main window.

See also

QPushButton QToolBar QMainWindow QAction

class ToolButtonPopupMode

Describes how a menu should be popped up for tool buttons that has a menu set or contains a list of actions.

Constant

Description

QToolButton.DelayedPopup

After pressing and holding the tool button down for a certain amount of time (the timeout is style dependent, see SH_ToolButton_PopupDelay ), the menu is displayed. A typical application example is the “back” button in some web browsers’s tool bars. If the user clicks it, the browser simply browses back to the previous page. If the user presses and holds the button down for a while, the tool button shows a menu containing the current history list

QToolButton.MenuButtonPopup

In this mode the tool button displays a special arrow to indicate that a menu is present. The menu is displayed when the arrow part of the button is pressed.

QToolButton.InstantPopup

The menu is displayed, without delay, when the tool button is pressed. In this mode, the button’s own action is not triggered.

Note

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

property arrowTypeᅟ: Qt.ArrowType

This property holds whether the button displays an arrow instead of a normal icon.

This displays an arrow as the icon for the QToolButton .

By default, this property is set to Qt::NoArrow.

Access functions:
property autoRaiseᅟ: bool

This property holds whether auto-raising is enabled or not..

The default is disabled (i.e. false).

This property is currently ignored on macOS when using QMacStyle.

Access functions:
property popupModeᅟ: QToolButton.ToolButtonPopupMode

This property describes the way that popup menus are used with tool buttons.

By default, this property is set to DelayedPopup .

Access functions:
property toolButtonStyleᅟ: Qt.ToolButtonStyle

This property holds whether the tool button displays an icon only, text only, or text beside/below the icon..

The default is Qt::ToolButtonIconOnly.

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.

QToolButton automatically connects this slot to the relevant signal in the QMainWindow in which is resides.

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

parent – QWidget

Constructs an empty tool button with parent parent.

arrowType()
Return type:

ArrowType

See also

setArrowType()

Getter of property arrowTypeᅟ .

autoRaise()
Return type:

bool

See also

setAutoRaise()

Getter of property autoRaiseᅟ .

defaultAction()
Return type:

QAction

Returns the default action.

initStyleOption(option)
Parameters:

option – QStyleOptionToolButton

Initialize option with the values from this QToolButton . This method is useful for subclasses when they need a QStyleOptionToolButton , but don’t want to fill in all the information themselves.

See also

initFrom()

menu()
Return type:

QMenu

Returns the associated menu, or None if no menu has been defined.

See also

setMenu()

popupMode()
Return type:

ToolButtonPopupMode

See also

setPopupMode()

Getter of property popupModeᅟ .

setArrowType(type)
Parameters:

type – ArrowType

See also

arrowType()

Setter of property arrowTypeᅟ .

setAutoRaise(enable)
Parameters:

enable – bool

See also

autoRaise()

Setter of property autoRaiseᅟ .

setDefaultAction(action)
Parameters:

action – QAction

Sets the default action to action.

If a tool button has a default action, the action defines the following properties of the button:

Other properties, such as autoRepeat , are not affected by actions.

See also

defaultAction()

setMenu(menu)
Parameters:

menu – QMenu

Associates the given menu with this tool button.

The menu will be shown according to the button’s popupMode .

Ownership of the menu is not transferred to the tool button.

See also

menu()

setPopupMode(mode)
Parameters:

mode – ToolButtonPopupMode

See also

popupMode()

Setter of property popupModeᅟ .

setToolButtonStyle(style)
Parameters:

style – ToolButtonStyle

See also

toolButtonStyle()

Setter of property toolButtonStyleᅟ .

showMenu()

Shows (pops up) the associated popup menu. If there is no such menu, this function does nothing. This function does not return until the popup menu has been closed by the user.

toolButtonStyle()
Return type:

ToolButtonStyle

See also

setToolButtonStyle()

Getter of property toolButtonStyleᅟ .

triggered(action)
Parameters:

action – QAction

This signal is emitted when the given action is triggered.

The action may also be associated with other parts of the user interface, such as menu items and keyboard shortcuts. Sharing actions in this way helps make the user interface more consistent and is often less work to implement.