|  | Home · All Classes · Modules

# QMenuBar Class Reference
[QtGui module]

The QMenuBar class provides a horizontal menu bar. More...

Inherits QWidget.

### Methods

- __init__ (self, QWidget parent = None)
- QAction actionAt (self, QPoint)
- actionEvent (self, QActionEvent)
- QRect actionGeometry (self, QAction)
- QAction activeAction (self)
- addAction (self, QAction action)
- QAction addAction (self, QString text)
- QAction addAction (self, QString text, QObject receiver, SLOT()SLOT() member)
- QAction addAction (self, QString text, callable receiver)
- QAction addMenu (self, QMenu menu)
- QMenu addMenu (self, QString title)
- QMenu addMenu (self, QIcon icon, QString title)
- QAction addSeparator (self)
- changeEvent (self, QEvent)
- clear (self)
- QWidget cornerWidget (self, Qt.Corner corner = Qt.TopRightCorner)
- bool event (self, QEvent)
- bool eventFilter (self, QObject, QEvent)
- focusInEvent (self, QFocusEvent)
- focusOutEvent (self, QFocusEvent)
- int heightForWidth (self, int)
- initStyleOption (self, QStyleOptionMenuItem option, QAction action)
- QAction insertMenu (self, QAction before, QMenu menu)
- QAction insertSeparator (self, QAction before)
- bool isDefaultUp (self)
- bool isNativeMenuBar (self)
- keyPressEvent (self, QKeyEvent)
- leaveEvent (self, QEvent)
- QSize minimumSizeHint (self)
- mouseMoveEvent (self, QMouseEvent)
- mousePressEvent (self, QMouseEvent)
- mouseReleaseEvent (self, QMouseEvent)
- paintEvent (self, QPaintEvent)
- resizeEvent (self, QResizeEvent)
- setActiveAction (self, QAction action)
- setCornerWidget (self, QWidget widget, Qt.Corner corner = Qt.TopRightCorner)
- setDefaultUp (self, bool)
- setNativeMenuBar (self, bool nativeMenuBar)
- setVisible (self, bool visible)
- QSize sizeHint (self)
- timerEvent (self, QTimerEvent)

### Qt Signals

- void hovered (QAction *)
- void triggered (QAction *)

## Detailed Description

The QMenuBar class provides a horizontal menu bar.

A menu bar consists of a list of pull-down menu items. You add menu items with addMenu(). For example, asuming that `menubar` is a pointer to a QMenuBar and `fileMenu` is a pointer to a 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 menuBar() function provided in QMainWindow, adding QMenus to the menu bar and adding QActions to the pop-up menus.

Example (from the Menus example):

         fileMenu = menuBar()->addMenu(tr("&File"));
         fileMenu->addAction(newAct);

Menu items may be removed with removeAction().

Widgets can be added to menus by using instances of the QWidgetAction class to hold them. These actions can then be inserted into menus in the usual way; see the 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.

Plastique widget style. | The Plastique widget style, like most other styles, handles the Help menu in the same way as it handles any other menu.
Motif widget style. | 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

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 QMenuBar conform more closely to accepted Mac OS X menu bar layout. The merging functionality is based on string matching the title of a QMenu entry. These strings are translated (using QObject.tr()) in the "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:

     QMenuBar *menuBar = new QMenuBar(0);

Note: Do not call QMainWindow.menuBar() to create the shared menu bar, because that menu bar will have the QMainWindow as its parent. That menu bar would only be displayed for the parent 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

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 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 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 QMenuBar and QMenu. The other main window application examples also provide menus using these classes.

## Method Documentation

### QMenuBar.__init__ (self, QWidget parent = None)

The parent argument, if not None, causes self to be owned by Qt instead of PyQt.

Constructs a menu bar with parent parent.

### QAction QMenuBar.actionAt (self, QPoint)

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

See also addAction() and addSeparator().

### QMenuBar.actionEvent (self, QActionEvent)

Reimplemented from QWidget.actionEvent().

### QRect QMenuBar.actionGeometry (self, QAction)

Returns the geometry of action act as a QRect.

See also actionAt().

### QAction QMenuBar.activeAction (self)

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

See also setActiveAction().

### QMenuBar.addAction (self, QAction action)

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() and QWidget.actions().

### QAction QMenuBar.addAction (self, QString text)

This is an overloaded function.

This convenience function creates a new action with the given text. The action's 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() and QWidget.actions().

### QAction QMenuBar.addAction (self, QString text, QObject receiver, SLOT()SLOT() member)

This is an overloaded function.

Appends the action action to the menu bar's list of actions.

See also QMenu.addAction(), QWidget.addAction(), and QWidget.actions().

### QAction QMenuBar.addAction (self, QString text, callable receiver)

### QAction QMenuBar.addMenu (self, QMenu menu)

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

Note: The returned QAction object can be used to hide the corresponding menu.

See also QWidget.addAction() and QMenu.menuAction().

### QMenu QMenuBar.addMenu (self, QString title)

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

See also QWidget.addAction() and QMenu.menuAction().

### QMenu QMenuBar.addMenu (self, QIcon icon, QString title)

Appends a new 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() and QMenu.menuAction().

### QAction QMenuBar.addSeparator (self)

Appends a separator to the menu.

### QMenuBar.changeEvent (self, QEvent)

Reimplemented from QWidget.changeEvent().

### QMenuBar.clear (self)

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 removeAction().

### QWidget QMenuBar.cornerWidget (self, Qt.Corner corner = Qt.TopRightCorner)

Returns the widget on the left of the first or on the right of the last menu item, depending on corner.

Note: Using a corner other than Qt.TopRightCorner or Qt.TopLeftCorner will result in a warning.

See also setCornerWidget().

### bool QMenuBar.event (self, QEvent)

Reimplemented from QObject.event().

### bool QMenuBar.eventFilter (self, QObject, QEvent)

Reimplemented from QObject.eventFilter().

### QMenuBar.focusInEvent (self, QFocusEvent)

Reimplemented from QWidget.focusInEvent().

### QMenuBar.focusOutEvent (self, QFocusEvent)

Reimplemented from QWidget.focusOutEvent().

### int QMenuBar.heightForWidth (self, int)

Reimplemented from QWidget.heightForWidth().

### QMenuBar.initStyleOption (self, QStyleOptionMenuItem option, QAction action)

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

See also QStyleOption.initFrom() and QMenu.initStyleOption().

### QAction QMenuBar.insertMenu (self, QAction before, QMenu menu)

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

See also QWidget.insertAction() and addMenu().

### QAction QMenuBar.insertSeparator (self, QAction before)

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() and addSeparator().

### bool QMenuBar.isDefaultUp (self)

### bool QMenuBar.isNativeMenuBar (self)

### QMenuBar.keyPressEvent (self, QKeyEvent)

Reimplemented from QWidget.keyPressEvent().

### QMenuBar.leaveEvent (self, QEvent)

Reimplemented from QWidget.leaveEvent().

### QSize QMenuBar.minimumSizeHint (self)

Reimplemented from QWidget.minimumSizeHint().

### QMenuBar.mouseMoveEvent (self, QMouseEvent)

Reimplemented from QWidget.mouseMoveEvent().

### QMenuBar.mousePressEvent (self, QMouseEvent)

Reimplemented from QWidget.mousePressEvent().

### QMenuBar.mouseReleaseEvent (self, QMouseEvent)

Reimplemented from QWidget.mouseReleaseEvent().

### QMenuBar.paintEvent (self, QPaintEvent)

Reimplemented from QWidget.paintEvent().

### QMenuBar.resizeEvent (self, QResizeEvent)

Reimplemented from QWidget.resizeEvent().

### QMenuBar.setActiveAction (self, QAction action)

Sets the currently highlighted action to act.

This function was introduced in Qt 4.1.

See also activeAction().

### QMenuBar.setCornerWidget (self, QWidget widget, Qt.Corner corner = Qt.TopRightCorner)

The widget argument has it's ownership transferred to Qt.

This sets the given widget to be shown directly on the left of the first menu item, or on the right of the last menu item, depending on corner.

The menu bar takes ownership of widget, reparenting it into the menu bar. However, if the corner already contains a widget, this previous widget will no longer be managed and will still be a visible child of the menu bar.

Note: Using a corner other than Qt.TopRightCorner or Qt.TopLeftCorner will result in a warning.

See also cornerWidget().

### QMenuBar.setDefaultUp (self, bool)

### QMenuBar.setNativeMenuBar (self, bool nativeMenuBar)

### QMenuBar.setVisible (self, bool visible)

Reimplemented from QWidget.setVisible().

### QSize QMenuBar.sizeHint (self)

Reimplemented from QWidget.sizeHint().

### QMenuBar.timerEvent (self, QTimerEvent)

Reimplemented from QObject.timerEvent().

## Qt Signal Documentation

### void hovered (QAction *)

This is the default overload of this signal.

This signal is emitted when a menu action is highlighted; action is the action that caused the event to be sent.

Often this is used to update status information.

See also triggered() and QAction.hovered().

### void triggered (QAction *)

This is the default overload of this signal.

This signal is emitted when an action in a menu belonging to this menubar is triggered as a result of a mouse click; action is the action that caused the signal to be emitted.

Note: QMenuBar has to have ownership of the QMenu in order this signal to work.

Normally, you connect each menu action to a single slot using QAction.triggered(), but sometimes you will want to connect several items to a single slot (most often if the user selects from an array). This signal is useful in such cases.

See also hovered() and QAction.triggered().