Table of Contents
- QToolButton
- Synopsis
- Detailed Description
PySide2.QtWidgets.QToolButton
PySide2.QtWidgets.QToolButton.ToolButtonPopupMode
PySide2.QtWidgets.QToolButton.arrowType()
PySide2.QtWidgets.QToolButton.autoRaise()
PySide2.QtWidgets.QToolButton.defaultAction()
PySide2.QtWidgets.QToolButton.initStyleOption()
PySide2.QtWidgets.QToolButton.menu()
PySide2.QtWidgets.QToolButton.popupMode()
PySide2.QtWidgets.QToolButton.setArrowType()
PySide2.QtWidgets.QToolButton.setAutoRaise()
PySide2.QtWidgets.QToolButton.setDefaultAction()
PySide2.QtWidgets.QToolButton.setMenu()
PySide2.QtWidgets.QToolButton.setPopupMode()
PySide2.QtWidgets.QToolButton.setToolButtonStyle()
PySide2.QtWidgets.QToolButton.showMenu()
PySide2.QtWidgets.QToolButton.toolButtonStyle()
PySide2.QtWidgets.QToolButton.triggered()
Previous topic
Next topic
Quick search
QToolButton¶
The
QToolButton
class provides a quick-access button to commands or options, usually used inside aQToolBar
. More…
Synopsis¶
Functions¶
def
arrowType
()def
autoRaise
()def
defaultAction
()def
initStyleOption
(option)def
menu
()def
popupMode
()def
setArrowType
(type)def
setAutoRaise
(enable)def
setMenu
(menu)def
setPopupMode
(mode)def
toolButtonStyle
()
Slots¶
def
setDefaultAction
(arg__1)def
setToolButtonStyle
(style)def
showMenu
()
Signals¶
def
triggered
(arg__1)
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 withaddAction()
or existing actions are added to a toolbar withaddAction()
. 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 (seesetCheckable()
).
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 aQToolBar
. Change it withsetAutoRaise()
.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()
andsetIconSize()
. When used inside aQToolBar
in aQMainWindow
, the button automatically adjusts toQMainWindow
‘s settings (seesetToolButtonStyle()
andsetIconSize()
). Instead of an icon, a tool button can also display an arrow symbol, specified witharrowType
.A tool button can offer additional choices in a popup menu. The popup menu can be set using
setMenu()
. UsesetPopupMode()
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, seeSH_ToolButton_PopupDelay
.
Qt Assistant’s toolbar contains tool buttons that are associated with actions used in other parts of the main window.
- class PySide2.QtWidgets.QToolButton([parent=None])¶
- param parent:
Constructs an empty tool button with parent
parent
.
- PySide2.QtWidgets.QToolButton.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 listQToolButton.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.
- PySide2.QtWidgets.QToolButton.arrowType()¶
- Return type:
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
NoArrow
.
- PySide2.QtWidgets.QToolButton.autoRaise()¶
- Return type:
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.
- PySide2.QtWidgets.QToolButton.defaultAction()¶
- Return type:
Returns the default action.
See also
- PySide2.QtWidgets.QToolButton.initStyleOption(option)¶
- Parameters:
Initialize
option
with the values from thisQToolButton
. This method is useful for subclasses when they need aQStyleOptionToolButton
, but don’t want to fill in all the information themselves.See also
- PySide2.QtWidgets.QToolButton.menu()¶
- Return type:
Returns the associated menu, or
None
if no menu has been defined.See also
- PySide2.QtWidgets.QToolButton.popupMode()¶
- Return type:
This property describes the way that popup menus are used with tool buttons.
By default, this property is set to
DelayedPopup
.
- PySide2.QtWidgets.QToolButton.setArrowType(type)¶
- Parameters:
type –
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
NoArrow
.
- PySide2.QtWidgets.QToolButton.setAutoRaise(enable)¶
- Parameters:
enable – 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.
- PySide2.QtWidgets.QToolButton.setDefaultAction(arg__1)¶
- Parameters:
arg__1 –
PySide2.QtWidgets.QAction
Sets the default action to
action
.If a tool button has a default action, the action defines the following properties of the button:
checkable
checked
enabled
popupMode
(assuming the action has a menu)
Other properties, such as
autoRepeat
, are not affected by actions.See also
- PySide2.QtWidgets.QToolButton.setMenu(menu)¶
- Parameters:
menu –
PySide2.QtWidgets.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
- PySide2.QtWidgets.QToolButton.setPopupMode(mode)¶
- Parameters:
mode –
ToolButtonPopupMode
This property describes the way that popup menus are used with tool buttons.
By default, this property is set to
DelayedPopup
.
- PySide2.QtWidgets.QToolButton.setToolButtonStyle(style)¶
- Parameters:
style –
ToolButtonStyle
This property holds whether the tool button displays an icon only, text only, or text beside/below the icon..
The default is
ToolButtonIconOnly
.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.QToolButton
automatically connects this slot to the relevant signal in theQMainWindow
in which is resides.
- PySide2.QtWidgets.QToolButton.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.
- PySide2.QtWidgets.QToolButton.toolButtonStyle()¶
- Return type:
This property holds whether the tool button displays an icon only, text only, or text beside/below the icon..
The default is
ToolButtonIconOnly
.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.QToolButton
automatically connects this slot to the relevant signal in theQMainWindow
in which is resides.
- PySide2.QtWidgets.QToolButton.triggered(arg__1)¶
- Parameters:
arg__1 –
PySide2.QtWidgets.QAction
© 2022 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.