QMenuBar

Synopsis

Functions

• def actionAt (arg__1)
• def actionGeometry (arg__1)
• def activeAction ()
• def addAction (arg__1, arg__2)
• def addAction (text)
• def addAction (text, receiver, member)
• def addMenu (icon, title)
• def addMenu (menu)
• def addMenu (title)
• def addSeparator ()
• def clear ()
• def cornerWidget ([corner=Qt.TopRightCorner])
• def initStyleOption (option, action)
• def insertMenu (before, menu)
• def insertSeparator (before)
• def isDefaultUp ()
• def isNativeMenuBar ()
• def setActiveAction (action)
• def setCornerWidget (w[, corner=Qt.TopRightCorner])
• def setDefaultUp (arg__1)
• def setNativeMenuBar (nativeMenuBar)

Signals

• def hovered (action)
• def triggered (action)

Detailed Description

The PySide.QtGui.QMenuBar class provides a horizontal menu bar.

A menu bar consists of a list of pull-down menu items. You add menu items with PySide.QtGui.QMenuBar.addMenu() . For example, asuming that menubar is a pointer to a PySide.QtGui.QMenuBar and fileMenu is a pointer to a PySide.QtGui.QMenu , the following statement inserts the menu into the menu bar:

menubar.addMenu(fileMenu)

The ampersand in the menu item’s text sets Alt+F as a shortcut for this menu. (You can use “&&” to get a real ampersand in the menu bar.)

There is no need to lay out a menu bar. It automatically sets its own geometry to the top of the parent widget and changes it appropriately whenever the parent is resized.

Usage

In most main window style applications you would use the PySide.QtGui.QMainWindow.menuBar() function provided in PySide.QtGui.QMainWindow , adding PySide.QtGui.QMenu s to the menu bar and adding PySide.QtGui.QAction s to the pop-up menus.

Example (from the Menus example):

fileMenu = menuBar().addMenu(tr("&File"))
fileMenu.addAction(Act)

Menu items may be removed with PySide.QtGui.QWidget.removeAction() .

Widgets can be added to menus by using instances of the PySide.QtGui.QWidgetAction class to hold them. These actions can then be inserted into menus in the usual way; see the PySide.QtGui.QMenu documentation for more details.

Platform Dependent Look and Feel

Different platforms have different requirements for the appearance of menu bars and their behavior when the user interacts with them. For example, Windows systems are often configured so that the underlined character mnemonics that indicate keyboard shortcuts for items in the menu bar are only shown when the Alt key is pressed.

	The Plastique widget style , like most other styles, handles the Help menu in the same way as it handles any other menu.
	The Motif widget style treats Help menus in a special way, placing them at right-hand end of the menu bar.

QMenuBar on Mac OS X

PySide.QtGui.QMenuBar on Mac OS X is a wrapper for using the system-wide menu bar. If you have multiple menu bars in one dialog the outermost menu bar (normally inside a widget with widget flag Qt.Window ) will be used for the system-wide menu bar.

Qt for Mac OS X also provides a menu bar merging feature to make PySide.QtGui.QMenuBar conform more closely to accepted Mac OS X menu bar layout. The merging functionality is based on string matching the title of a PySide.QtGui.QMenu entry. These strings are translated (using QObject.tr() ) in the ” PySide.QtGui.QMenuBar ” context. If an entry is moved its slots will still fire as if it was in the original place. The table below outlines the strings looked for and where the entry is placed if matched:

String matches	Placement	Notes
about.*	Application Menu | About <application name>	The application name is fetched from the Info.plist file (see note below). If this entry is not found no About item will appear in the Application Menu.
config, options, setup, settings or preferences	Application Menu | Preferences	If this entry is not found the Settings item will be disabled
quit or exit	Application Menu | Quit <application name>	If this entry is not found a default Quit item will be created to call QApplication.quit()

You can override this behavior by using the QAction.menuRole() property.

If you want all windows in a Mac application to share one menu bar, you must create a menu bar that does not have a parent. Create a parent-less menu bar this way:

menuBar = QMenuBar()

Note

Do not call QMainWindow.menuBar() to create the shared menu bar, because that menu bar will have the PySide.QtGui.QMainWindow as its parent. That menu bar would only be displayed for the parent PySide.QtGui.QMainWindow .

Note

The text used for the application name in the menu bar is obtained from the value set in the Info.plist file in the application’s bundle. See Deploying an Application on Mac OS X for more information.

QMenuBar on Windows CE

PySide.QtGui.QMenuBar on Windows CE is a wrapper for using the system-wide menu bar, similar to the Mac. This feature is activated for Windows Mobile and integrates PySide.QtGui.QMenuBar with the native soft keys. The left soft key can be controlled with QMenuBar.setDefaultAction() and the right soft key can be used to access the menu bar.

The PySide.QtGui.QMenuBar.hovered() signal is not supported for the native menu integration. Also, it is not possible to display an icon in a native menu on Windows Mobile.

Examples

The Menus example shows how to use PySide.QtGui.QMenuBar and PySide.QtGui.QMenu . The other main window application examples also provide menus using these classes.

See also

PySide.QtGui.QMenu PySide.QtGui.QShortcut PySide.QtGui.QAction GUI Design Handbook: Menu Bar Menus Example

class PySide.QtGui.QMenuBar([parent=None])

Parameters:parent – PySide.QtGui.QWidget

Constructs a menu bar with parent parent .

PySide.QtGui.QMenuBar.actionAt(arg__1)

Parameters:arg__1 – PySide.QtCore.QPoint Return type:PySide.QtGui.QAction

Returns the PySide.QtGui.QAction at pt . Returns 0 if there is no action at pt or if the location has a separator.

See also

PySide.QtGui.QMenuBar.addAction() PySide.QtGui.QMenuBar.addSeparator()

PySide.QtGui.QMenuBar.actionGeometry(arg__1)

Parameters:arg__1 – PySide.QtGui.QAction Return type:PySide.QtCore.QRect

Returns the geometry of action act as a PySide.QtCore.QRect .

See also

PySide.QtGui.QMenuBar.actionAt()

PySide.QtGui.QMenuBar.activeAction()

Return type:PySide.QtGui.QAction

Returns the PySide.QtGui.QAction that is currently highlighted. A null pointer will be returned if no action is currently selected.

See also

PySide.QtGui.QMenuBar.setActiveAction()

PySide.QtGui.QMenuBar.addAction(text)

Parameters:text – unicode Return type:PySide.QtGui.QAction

This is an overloaded function.

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.

See also

QWidget.addAction() QWidget.actions()

PySide.QtGui.QMenuBar.addAction(text, receiver, member)

Parameters:

• text – unicode
• receiver – PySide.QtCore.QObject
• member – str

Return type:

PySide.QtGui.QAction

This is an overloaded function.

This convenience function creates a new action with the given text . The action’s PySide.QtGui.QMenuBar.triggered() signal is connected to the receiver ‘s member slot. The function adds the newly created action to the menu’s list of actions and returns it.

See also

QWidget.addAction() QWidget.actions()

PySide.QtGui.QMenuBar.addAction(arg__1, arg__2)

Parameters:

• arg__1 – unicode
• arg__2 – PyObject

PySide.QtGui.QMenuBar.addMenu(icon, title)

Parameters:

• icon – PySide.QtGui.QIcon
• title – unicode

Return type:

PySide.QtGui.QMenu

Appends a new PySide.QtGui.QMenu with icon and title to the menu bar. The menu bar takes ownership of the menu. Returns the new menu.

See also

QWidget.addAction() QMenu.menuAction()

PySide.QtGui.QMenuBar.addMenu(menu)

Parameters:menu – PySide.QtGui.QMenu Return type:PySide.QtGui.QAction

Appends menu to the menu bar. Returns the menu’s menuAction().

Note

The returned PySide.QtGui.QAction object can be used to hide the corresponding menu.

See also

QWidget.addAction() QMenu.menuAction()

PySide.QtGui.QMenuBar.addMenu(title)

Parameters:title – unicode Return type:PySide.QtGui.QMenu

Appends a new PySide.QtGui.QMenu with title to the menu bar. The menu bar takes ownership of the menu. Returns the new menu.

See also

QWidget.addAction() QMenu.menuAction()

PySide.QtGui.QMenuBar.addSeparator()

Return type:PySide.QtGui.QAction

Appends a separator to the menu.

PySide.QtGui.QMenuBar.clear()

Removes all the actions from the menu bar.

Note

On Mac OS X, menu items that have been merged to the system menu bar are not removed by this function. One way to handle this would be to remove the extra actions yourself. You can set the menu role on the different menus, so that you know ahead of time which menu items get merged and which do not. Then decide what to recreate or remove yourself.

See also

PySide.QtGui.QWidget.removeAction()

PySide.QtGui.QMenuBar.cornerWidget([corner=Qt.TopRightCorner])

Parameters:corner – PySide.QtCore.Qt.Corner Return type:PySide.QtGui.QWidget

PySide.QtGui.QMenuBar.hovered(action)

Parameters:action – PySide.QtGui.QAction

PySide.QtGui.QMenuBar.initStyleOption(option, action)

Parameters:

• option – PySide.QtGui.QStyleOptionMenuItem
• action – PySide.QtGui.QAction

Initialize option with the values from the menu bar and information from action . This method is useful for subclasses when they need a PySide.QtGui.QStyleOptionMenuItem , but don’t want to fill in all the information themselves.

See also

QStyleOption.initFrom() QMenu.initStyleOption()

PySide.QtGui.QMenuBar.insertMenu(before, menu)

Parameters:

• before – PySide.QtGui.QAction
• menu – PySide.QtGui.QMenu

Return type:

PySide.QtGui.QAction

This convenience function inserts menu before action before and returns the menus menuAction().

See also

QWidget.insertAction() PySide.QtGui.QMenuBar.addMenu()

PySide.QtGui.QMenuBar.insertSeparator(before)

Parameters:before – PySide.QtGui.QAction Return type:PySide.QtGui.QAction

This convenience function creates a new separator action, i.e. an action with QAction.isSeparator() returning true. The function inserts the newly created action into this menu bar’s list of actions before action before and returns it.

See also

QWidget.insertAction() PySide.QtGui.QMenuBar.addSeparator()

PySide.QtGui.QMenuBar.isDefaultUp()

Return type:PySide.QtCore.bool

This property holds the popup orientation.

The default popup orientation. By default, menus pop “down” the screen. By setting the property to true, the menu will pop “up”. You might call this for menus that are below the document to which they refer.

If the menu would not fit on the screen, the other direction is used automatically.

PySide.QtGui.QMenuBar.isNativeMenuBar()

Return type:PySide.QtCore.bool

This property holds Whether or not a menubar will be used as a native menubar on platforms that support it.

This property specifies whether or not the menubar should be used as a native menubar on platforms that support it. The currently supported platforms are Mac OS X and Windows CE. On these platforms if this property is true, the menubar is used in the native menubar and is not in the window of its parent, if false the menubar remains in the window. On other platforms the value of this attribute has no effect.

The default is to follow whether the Qt.AA_DontUseNativeMenuBar attribute is set for the application. Explicitly settings this property overrides the presence (or abscence) of the attribute.

PySide.QtGui.QMenuBar.setActiveAction(action)

Parameters:action – PySide.QtGui.QAction

Sets the currently highlighted action to act .

See also

PySide.QtGui.QMenuBar.activeAction()

PySide.QtGui.QMenuBar.setCornerWidget(w[, corner=Qt.TopRightCorner])

Parameters:

• w – PySide.QtGui.QWidget
• corner – PySide.QtCore.Qt.Corner

PySide.QtGui.QMenuBar.setDefaultUp(arg__1)

Parameters:arg__1 – PySide.QtCore.bool

This property holds the popup orientation.

The default popup orientation. By default, menus pop “down” the screen. By setting the property to true, the menu will pop “up”. You might call this for menus that are below the document to which they refer.

If the menu would not fit on the screen, the other direction is used automatically.

PySide.QtGui.QMenuBar.setNativeMenuBar(nativeMenuBar)

Parameters:nativeMenuBar – PySide.QtCore.bool

This property holds Whether or not a menubar will be used as a native menubar on platforms that support it.

This property specifies whether or not the menubar should be used as a native menubar on platforms that support it. The currently supported platforms are Mac OS X and Windows CE. On these platforms if this property is true, the menubar is used in the native menubar and is not in the window of its parent, if false the menubar remains in the window. On other platforms the value of this attribute has no effect.

The default is to follow whether the Qt.AA_DontUseNativeMenuBar attribute is set for the application. Explicitly settings this property overrides the presence (or abscence) of the attribute.

PySide.QtGui.QMenuBar.triggered(action)

Parameters:action – PySide.QtGui.QAction