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
QActioninstances 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.
QToolButtonsupports 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
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
setIconSize(). When used inside a
QMainWindow, the button automatically adjusts to
QMainWindow‘s settings (see
setIconSize()). Instead of an icon, a tool button can also display an arrow symbol, specified with
A tool button can offer additional choices in a popup menu. The popup menu can be set using
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
Qt Assistant’s toolbar contains tool buttons that are associated with actions used in other parts of the main window.
- param parent
Constructs an empty tool button with parent
Describes how a menu should be popped up for tool buttons that has a menu set or contains a list of actions.
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
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.
The menu is displayed, without delay, when the tool button is pressed. In this mode, the button’s own action is not triggered.
- Return type
Returns the default action.
- Return type
Returns the associated menu, or
Noneif no menu has been defined.
Sets the default action to
If a tool button has a default action, the action defines the following properties of the button:
popupMode(assuming the action has a menu)
Other properties, such as
autoRepeat, are not affected by actions.
Associates the given
menuwith this tool button.
The menu will be shown according to the button’s
Ownership of the menu is not transferred to the tool button.
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.
- Return type
© 2020 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.