QWidgetAction¶
The
QWidgetAction
class extendsQAction
by an interface for inserting custom widgets into action based containers, such as toolbars. More…
Synopsis¶
Functions¶
def
createdWidgets
()def
defaultWidget
()def
releaseWidget
(widget)def
requestWidget
(parent)def
setDefaultWidget
(w)
Virtual functions¶
def
createWidget
(parent)def
deleteWidget
(widget)
Detailed Description¶
Most actions in an application are represented as items in menus or buttons in toolbars. However sometimes more complex widgets are necessary. For example a zoom action in a word processor may be realized using a
QComboBox
in aQToolBar
, presenting a range of different zoom levels.QToolBar
providesinsertWidget()
as convenience function for inserting a single widget. However if you want to implement an action that uses custom widgets for visualization in multiple containers then you have to subclassQWidgetAction
.If a
QWidgetAction
is added for example to aQToolBar
thencreateWidget()
is called. Reimplementations of that function should create a new custom widget with the specified parent.If the action is removed from a container widget then
deleteWidget()
is called with the previously created custom widget as argument. The default implementation hides the widget and deletes it usingdeleteLater()
.If you have only one single custom widget then you can set it as default widget using
setDefaultWidget()
. That widget will then be used if the action is added to aQToolBar
, or in general to an action container that supportsQWidgetAction
. If aQWidgetAction
with only a default widget is added to two toolbars at the same time then the default widget is shown only in the first toolbar the action was added to.QWidgetAction
takes over ownership of the default widget.Note that it is up to the widget to activate the action, for example by reimplementing mouse event handlers and calling
trigger()
.macOS : If you add a widget to a menu in the application’s menu bar on macOS, the widget will be added and it will function but with some limitations:
The widget is reparented away from the
QMenu
to the native menu view. If you show the menu in some other place (e.g. as a popup menu), the widget will not be there.Focus/Keyboard handling of the widget is not possible.
Due to Apple’s design, mouse tracking on the widget currently does not work.
Connecting the
triggered()
signal to a slot that opens a modal dialog will cause a crash in macOS 10.4 (known bug acknowledged by Apple), a workaround is to use a QueuedConnection instead of a DirectConnection.See also
- class PySide2.QtWidgets.QWidgetAction(parent)¶
- param parent:
Constructs an action with
parent
.
- PySide2.QtWidgets.QWidgetAction.createWidget(parent)¶
- Parameters:
parent –
PySide2.QtWidgets.QWidget
- Return type:
This function is called whenever the action is added to a container widget that supports custom widgets. If you don’t want a custom widget to be used as representation of the action in the specified
parent
widget then 0 should be returned.See also
- PySide2.QtWidgets.QWidgetAction.createdWidgets()¶
- Return type:
Returns the list of widgets that have been using
createWidget()
and are currently in use by widgets the action has been added to.
- PySide2.QtWidgets.QWidgetAction.defaultWidget()¶
- Return type:
Returns the default widget.
See also
- PySide2.QtWidgets.QWidgetAction.deleteWidget(widget)¶
- Parameters:
widget –
PySide2.QtWidgets.QWidget
This function is called whenever the action is removed from a container widget that displays the action using a custom
widget
previously created usingcreateWidget()
. The default implementation hides thewidget
and schedules it for deletion usingdeleteLater()
.See also
- PySide2.QtWidgets.QWidgetAction.releaseWidget(widget)¶
- Parameters:
widget –
PySide2.QtWidgets.QWidget
Releases the specified
widget
.Container widgets that support actions call this function when a widget action is removed.
See also
- PySide2.QtWidgets.QWidgetAction.requestWidget(parent)¶
- Parameters:
parent –
PySide2.QtWidgets.QWidget
- Return type:
Returns a widget that represents the action, with the given
parent
.Container widgets that support actions can call this function to request a widget as visual representation of the action.
See also
- PySide2.QtWidgets.QWidgetAction.setDefaultWidget(w)¶
- Parameters:
Sets
widget
to be the default widget. The ownership is transferred toQWidgetAction
. UnlesscreateWidget()
is reimplemented by a subclass to return a new widget the default widget is used when a container widget requests a widget throughrequestWidget()
.See also
© 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.