QMenu¶
Synopsis¶
Functions¶
def
actionAt
(arg__1)def
actionGeometry
(arg__1)def
activeAction
()def
addAction
(arg__1, arg__2, arg__3[, arg__4=0])def
addAction
(arg__1, arg__2[, arg__3=0])def
addAction
(icon, text)def
addAction
(icon, text, receiver, member[, shortcut=0])def
addAction
(text)def
addAction
(text, receiver, member[, shortcut=0])def
addMenu
(icon, title)def
addMenu
(menu)def
addMenu
(title)def
addSection
(icon, text)def
addSection
(text)def
addSeparator
()def
clear
()def
columnCount
()def
defaultAction
()def
exec_
()def
exec_
(pos[, at=None])def
hideTearOffMenu
()def
icon
()def
initStyleOption
(option, action)def
insertMenu
(before, menu)def
insertSection
(before, icon, text)def
insertSection
(before, text)def
insertSeparator
(before)def
isEmpty
()def
isTearOffEnabled
()def
isTearOffMenuVisible
()def
menuAction
()def
popup
(pos[, at=None])def
separatorsCollapsible
()def
setActiveAction
(act)def
setDefaultAction
(arg__1)def
setIcon
(icon)def
setSeparatorsCollapsible
(collapse)def
setTearOffEnabled
(arg__1)def
setTitle
(title)def
setToolTipsVisible
(visible)def
showTearOffMenu
()def
showTearOffMenu
(pos)def
title
()def
toolTipsVisible
()
Signals¶
def
aboutToHide
()def
aboutToShow
()def
hovered
(action)def
triggered
(action)
Detailed Description¶
A menu widget is a selection menu. It can be either a pull-down menu in a menu bar or a standalone context menu. Pull-down menus are shown by the menu bar when the user clicks on the respective item or presses the specified shortcut key. Use
addMenu()
to insert a menu into a menu bar. Context menus are usually invoked by some special keyboard key or by right-clicking. They can be executed either asynchronously withpopup()
or synchronously withexec()
. Menus can also be invoked in response to button presses; these are just like context menus except for how they are invoked.
Actions¶
A menu consists of a list of action items. Actions are added with the
addAction()
,addActions()
andinsertAction()
functions. An action is represented vertically and rendered byQStyle
. In addition, actions can have a text label, an optional icon drawn on the very left side, and shortcut key sequence such as “Ctrl+X”.The existing actions held by a menu can be found with
actions()
.There are four kinds of action items: separators, actions that show a submenu, widgets, and actions that perform an action. Separators are inserted with
addSeparator()
, submenus withaddMenu()
, and all other items are considered action items.When inserting action items you usually specify a receiver and a slot. The receiver will be notifed whenever the item is
triggered()
. In addition,QMenu
provides two signals,triggered()
andhovered()
, which signal theQAction
that was triggered from the menu.You clear a menu with
clear()
and remove individual action items withremoveAction()
.A
QMenu
can also provide a tear-off menu. A tear-off menu is a top-level window that contains a copy of the menu. This makes it possible for the user to “tear off” frequently used menus and position them in a convenient place on the screen. If you want this functionality for a particular menu, insert a tear-off handle withsetTearOffEnabled()
. When using tear-off menus, bear in mind that the concept isn’t typically used on Microsoft Windows so some users may not be familiar with it. Consider using aQToolBar
instead.Widgets can be inserted into menus with the
QWidgetAction
class. Instances of this class are used to hold widgets, and are inserted into menus with theaddAction()
overload that takes aQAction
.Conversely, actions can be added to widgets with the
addAction()
,addActions()
andinsertAction()
functions.
QMenu on macOS with Qt Build Against Cocoa¶
QMenu
can be inserted only once in a menu/menubar. Subsequent insertions will have no effect or will result in a disabled menu item.See the Menus example for an example of how to use
QMenuBar
andQMenu
in your application.Important inherited functions:
addAction()
,removeAction()
,clear()
,addSeparator()
, andaddMenu()
.
-
class
QMenu
([parent=None])¶ QMenu(title[, parent=None])
- param parent
- param title
unicode
Constructs a menu with parent
parent
.Although a popup menu is always a top-level widget, if a parent is passed the popup menu will be deleted when that parent is destroyed (as with any other
QObject
).
-
PySide2.QtWidgets.QMenu.
aboutToHide
()¶
-
PySide2.QtWidgets.QMenu.
aboutToShow
()¶
-
PySide2.QtWidgets.QMenu.
actionAt
(arg__1)¶ - Parameters
arg__1 –
QPoint
- Return type
Returns the item at
pt
; returnsNone
if there is no item there.
-
PySide2.QtWidgets.QMenu.
actionGeometry
(arg__1)¶ - Parameters
arg__1 –
QAction
- Return type
QRect
Returns the geometry of action
act
.
-
PySide2.QtWidgets.QMenu.
activeAction
()¶ - Return type
Returns the currently highlighted action, or 0 if no action is currently highlighted.
See also
-
PySide2.QtWidgets.QMenu.
addAction
(text)¶ - Parameters
text – unicode
- Return type
This convenience function creates a new action with
text
. The function adds the newly created action to the menu’s list of actions, and returns it.QMenu
takes ownership of the returnedQAction
.See also
-
PySide2.QtWidgets.QMenu.
addAction
(text, receiver, member[, shortcut=0]) - Parameters
text – unicode
receiver –
QObject
member – str
shortcut –
QKeySequence
- Return type
-
PySide2.QtWidgets.QMenu.
addAction
(icon, text, receiver, member[, shortcut=0]) - Parameters
icon –
QIcon
text – unicode
receiver –
QObject
member – str
shortcut –
QKeySequence
- Return type
-
PySide2.QtWidgets.QMenu.
addAction
(icon, text) - Parameters
icon –
QIcon
text – unicode
- Return type
This is an overloaded function.
This convenience function creates a new action with an
icon
and sometext
. The function adds the newly created action to the menu’s list of actions, and returns it.QMenu
takes ownership of the returnedQAction
.See also
-
PySide2.QtWidgets.QMenu.
addAction
(arg__1, arg__2[, arg__3=0]) - Parameters
arg__1 – unicode
arg__2 –
PyObject
arg__3 –
QKeySequence
-
PySide2.QtWidgets.QMenu.
addAction
(arg__1, arg__2, arg__3[, arg__4=0]) - Parameters
arg__1 –
QIcon
arg__2 – unicode
arg__3 –
PyObject
arg__4 –
QKeySequence
-
PySide2.QtWidgets.QMenu.
addMenu
(menu)¶ -
This convenience function adds
menu
as a submenu to this menu. It returnsmenu
‘smenuAction()
. This menu does not take ownership ofmenu
.See also
-
PySide2.QtWidgets.QMenu.
addMenu
(icon, title) - Parameters
icon –
QIcon
title – unicode
- Return type
Appends a new
QMenu
withicon
andtitle
to the menu. The menu takes ownership of the menu. Returns the new menu.See also
-
PySide2.QtWidgets.QMenu.
addMenu
(title) - Parameters
title – unicode
- Return type
-
PySide2.QtWidgets.QMenu.
addSection
(icon, text)¶ - Parameters
icon –
QIcon
text – unicode
- Return type
This convenience function creates a new section action, i.e. an action with
isSeparator()
returning true but also havingtext
andicon
hints, and adds the new action to this menu’s list of actions. It returns the newly created action.The rendering of the hints is style and platform dependent. Widget styles can use the text and icon information in the rendering for sections, or can choose to ignore them and render sections like simple separators.
QMenu
takes ownership of the returnedQAction
.See also
-
PySide2.QtWidgets.QMenu.
addSection
(text) - Parameters
text – unicode
- Return type
This convenience function creates a new section action, i.e. an action with
isSeparator()
returning true but also havingtext
hint, and adds the new action to this menu’s list of actions. It returns the newly created action.The rendering of the hint is style and platform dependent. Widget styles can use the text information in the rendering for sections, or can choose to ignore it and render sections like simple separators.
QMenu
takes ownership of the returnedQAction
.See also
-
PySide2.QtWidgets.QMenu.
addSeparator
()¶ - Return type
This convenience function creates a new separator action, i.e. an action with
isSeparator()
returning true, and adds the new action to this menu’s list of actions. It returns the newly created action.QMenu
takes ownership of the returnedQAction
.See also
-
PySide2.QtWidgets.QMenu.
clear
()¶ Removes all the menu’s actions. Actions owned by the menu and not shown in any other widget are deleted.
See also
-
PySide2.QtWidgets.QMenu.
columnCount
()¶ - Return type
int
If a menu does not fit on the screen it lays itself out so that it does fit. It is style dependent what layout means (for example, on Windows it will use multiple columns).
This functions returns the number of columns necessary.
-
PySide2.QtWidgets.QMenu.
defaultAction
()¶ - Return type
Returns the current default action.
See also
-
PySide2.QtWidgets.QMenu.
exec_
()¶ - Return type
Executes this menu synchronously.
This is equivalent to
exec(pos())
.This returns the triggered
QAction
in either the popup menu or one of its submenus, or 0 if no item was triggered (normally because the user pressed Esc).In most situations you’ll want to specify the position yourself, for example, the current mouse position:
exec_(QCursor.pos())
or aligned to a widget:
exec_(somewidget.mapToGlobal(QPoint(0,0)))
or in reaction to a
QMouseEvent
*e:exec_(e.globalPos())
-
static
PySide2.QtWidgets.QMenu.
exec_
(actions, pos[, at=None[, parent=None]]) -
This is an overloaded function.
Executes a menu synchronously.
The menu’s actions are specified by the list of
actions
. The menu will pop up so that the specified action,at
, appears at global positionpos
. Ifat
is not specified then the menu appears at positionpos
.parent
is the menu’s parent widget; specifying the parent will provide context whenpos
alone is not enough to decide where the menu should go (e.g., with multiple desktops or when the parent is embedded inQGraphicsView
).The function returns the triggered
QAction
in either the popup menu or one of its submenus, or 0 if no item was triggered (normally because the user pressed Esc).This is equivalent to:
menu = QMenu() at = actions[0] // Assumes actions is not empty for a in actions: menu.addAction(a) menu.exec_(pos, at)
See also
-
PySide2.QtWidgets.QMenu.
exec_
(pos[, at=None]) -
This is an overloaded function.
Executes this menu synchronously.
Pops up the menu so that the action
action
will be at the specified global positionp
. To translate a widget’s local coordinates into global coordinates, usemapToGlobal()
.This returns the triggered
QAction
in either the popup menu or one of its submenus, or 0 if no item was triggered (normally because the user pressed Esc).Note that all signals are emitted as usual. If you connect a
QAction
to a slot and call the menu’sexec()
, you get the result both via the signal-slot connection and in the return value ofexec()
.Common usage is to position the menu at the current mouse position:
exec_(QCursor.pos())
or aligned to a widget:
exec_(somewidget.mapToGlobal(QPoint(0, 0)))
or in reaction to a
QMouseEvent
*e:exec_(e.globalPos())
When positioning a menu with
exec()
orpopup()
, bear in mind that you cannot rely on the menu’s currentsize()
. For performance reasons, the menu adapts its size only when necessary. So in many cases, the size before and after the show is different. Instead, usesizeHint()
which calculates the proper size depending on the menu’s current contents.See also
-
PySide2.QtWidgets.QMenu.
hideTearOffMenu
()¶ This function will forcibly hide the torn off menu making it disappear from the user’s desktop.
-
PySide2.QtWidgets.QMenu.
initStyleOption
(option, action)¶ - Parameters
option –
QStyleOptionMenuItem
action –
QAction
Initialize
option
with the values from this menu and information fromaction
. This method is useful for subclasses when they need aQStyleOptionMenuItem
, but don’t want to fill in all the information themselves.See also
-
PySide2.QtWidgets.QMenu.
insertMenu
(before, menu)¶ -
This convenience function inserts
menu
before actionbefore
and returns the menusmenuAction()
.See also
-
PySide2.QtWidgets.QMenu.
insertSection
(before, icon, text)¶ -
This convenience function creates a new title action, i.e. an action with
isSeparator()
returning true but also havingtext
andicon
hints. The function inserts the newly created action into this menu’s list of actions before actionbefore
and returns it.The rendering of the hints is style and platform dependent. Widget styles can use the text and icon information in the rendering for sections, or can choose to ignore them and render sections like simple separators.
QMenu
takes ownership of the returnedQAction
.See also
-
PySide2.QtWidgets.QMenu.
insertSection
(before, text) -
This convenience function creates a new title action, i.e. an action with
isSeparator()
returning true but also havingtext
hint. The function inserts the newly created action into this menu’s list of actions before actionbefore
and returns it.The rendering of the hint is style and platform dependent. Widget styles can use the text information in the rendering for sections, or can choose to ignore it and render sections like simple separators.
QMenu
takes ownership of the returnedQAction
.See also
-
PySide2.QtWidgets.QMenu.
insertSeparator
(before)¶ -
This convenience function creates a new separator action, i.e. an action with
isSeparator()
returning true. The function inserts the newly created action into this menu’s list of actions before actionbefore
and returns it.QMenu
takes ownership of the returnedQAction
.See also
-
PySide2.QtWidgets.QMenu.
isEmpty
()¶ - Return type
bool
Returns
true
if there are no visible actions inserted into the menu, false otherwise.See also
-
PySide2.QtWidgets.QMenu.
isTearOffEnabled
()¶ - Return type
bool
-
PySide2.QtWidgets.QMenu.
isTearOffMenuVisible
()¶ - Return type
bool
When a menu is torn off a second menu is shown to display the menu contents in a new window. When the menu is in this mode and the menu is visible returns
true
; otherwise false.
-
PySide2.QtWidgets.QMenu.
menuAction
()¶ - Return type
Returns the action associated with this menu.
-
PySide2.QtWidgets.QMenu.
popup
(pos[, at=None])¶ - Parameters
pos –
QPoint
at –
QAction
Displays the menu so that the action
atAction
will be at the specified global positionp
. To translate a widget’s local coordinates into global coordinates, usemapToGlobal()
.When positioning a menu with
exec()
or , bear in mind that you cannot rely on the menu’s currentsize()
. For performance reasons, the menu adapts its size only when necessary, so in many cases, the size before and after the show is different. Instead, usesizeHint()
which calculates the proper size depending on the menu’s current contents.See also
mapToGlobal()
exec()
-
PySide2.QtWidgets.QMenu.
separatorsCollapsible
()¶ - Return type
bool
See also
-
PySide2.QtWidgets.QMenu.
setActiveAction
(act)¶ - Parameters
act –
QAction
Sets the currently highlighted action to
act
.See also
-
PySide2.QtWidgets.QMenu.
setDefaultAction
(arg__1)¶ - Parameters
arg__1 –
QAction
This sets the default action to
act
. The default action may have a visual cue, depending on the currentQStyle
. A default action usually indicates what will happen by default when a drop occurs.See also
-
PySide2.QtWidgets.QMenu.
setSeparatorsCollapsible
(collapse)¶ - Parameters
collapse –
bool
See also
-
PySide2.QtWidgets.QMenu.
setTearOffEnabled
(arg__1)¶ - Parameters
arg__1 –
bool
See also
-
PySide2.QtWidgets.QMenu.
setToolTipsVisible
(visible)¶ - Parameters
visible –
bool
See also
-
PySide2.QtWidgets.QMenu.
showTearOffMenu
(pos)¶ - Parameters
pos –
QPoint
This function will forcibly show the torn off menu making it appear on the user’s desktop at the specified global position
pos
.
-
PySide2.QtWidgets.QMenu.
showTearOffMenu
() This is an overloaded function.
This function will forcibly show the torn off menu making it appear on the user’s desktop under the mouse currsor.
-
PySide2.QtWidgets.QMenu.
title
()¶ - Return type
unicode
See also
-
PySide2.QtWidgets.QMenu.
toolTipsVisible
()¶ - Return type
bool
See also
© 2018 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.