QMenuBar Class

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

Header:	#include <QMenuBar>
qmake:	QT += widgets
Inherits:	QWidget

• List of all members, including inherited members

Properties

• defaultUp : bool
• nativeMenuBar : bool

Public Functions

	QMenuBar(QWidget *parent = nullptr)
virtual	~QMenuBar()
QAction *	actionAt(const QPoint &pt) const
QRect	actionGeometry(QAction *act) const
QAction *	activeAction() const
QAction *	addAction(const QString &text)
QAction *	addAction(const QString &text, const QObject *receiver, const char *member)
QAction *	addAction(const QString &text, const Obj *receiver, PointerToMemberFunctionOrFunctor method)
QAction *	addAction(const QString &text, Functor functor)
QAction *	addMenu(QMenu *menu)
QMenu *	addMenu(const QString &title)
QMenu *	addMenu(const QIcon &icon, const QString &title)
QAction *	addSeparator()
void	clear()
QWidget *	cornerWidget(Qt::Corner corner = Qt::TopRightCorner) const
QAction *	insertMenu(QAction *before, QMenu *menu)
QAction *	insertSeparator(QAction *before)
bool	isDefaultUp() const
bool	isNativeMenuBar() const
void	setActiveAction(QAction *act)
void	setCornerWidget(QWidget *widget, Qt::Corner corner = Qt::TopRightCorner)
void	setDefaultUp(bool)
void	setNativeMenuBar(bool nativeMenuBar)
NSMenu *	toNSMenu()

Reimplemented Public Functions

virtual int	heightForWidth(int) const override
virtual QSize	minimumSizeHint() const override
virtual QSize	sizeHint() const override

Public Slots

virtual void

setVisible(bool visible) override

Signals

void	hovered(QAction *action)
void	triggered(QAction *action)

Protected Functions

void	initStyleOption(QStyleOptionMenuItem *option, const QAction *action) const

Reimplemented Protected Functions

virtual void	actionEvent(QActionEvent *e) override
virtual void	changeEvent(QEvent *e) override
virtual bool	event(QEvent *e) override
virtual bool	eventFilter(QObject *object, QEvent *event) override
virtual void	focusInEvent(QFocusEvent *) override
virtual void	focusOutEvent(QFocusEvent *) override
virtual void	keyPressEvent(QKeyEvent *e) override
virtual void	leaveEvent(QEvent *) override
virtual void	mouseMoveEvent(QMouseEvent *e) override
virtual void	mousePressEvent(QMouseEvent *e) override
virtual void	mouseReleaseEvent(QMouseEvent *e) override
virtual void	paintEvent(QPaintEvent *e) override
virtual void	resizeEvent(QResizeEvent *) override
virtual void	timerEvent(QTimerEvent *e) override

Detailed Description

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.

QMenuBar as a Global Menu Bar

On macOS and on certain Linux desktop environments such as Ubuntu Unity, QMenuBar 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 macOS also provides a menu bar merging feature to make QMenuBar conform more closely to accepted macOS 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 QCoreApplication::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(nullptr);

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 macOS menu bar is obtained from the value set in the Info.plist file in the application's bundle. See Qt for macOS - Deployment for more information.

Note: On Linux, if the com.canonical.AppMenu.Registrar service is available on the D-Bus session bus, then Qt will communicate with it to install the application's menus into the global menu bar, as described.

Examples

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

See also QMenu, QShortcut, QAction, Introduction to Apple Human Interface Guidelines, GUI Design Handbook: Menu Bar, and Menus Example.

Member Function Documentation

QMenuBar::QMenuBar(QWidget *parent = nullptr)

Constructs a menu bar with parent parent.

[signal] void QMenuBar::hovered(QAction *action)

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

[override virtual slot] void QMenuBar::setVisible(bool visible)

Reimplements an access function for property: QWidget::visible.

[signal] void QMenuBar::triggered(QAction *action)

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

[virtual] QMenuBar::~QMenuBar()

Destroys the menu bar.

QAction *QMenuBar::actionAt(const QPoint &pt) const

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

See also addAction() and addSeparator().

[override virtual protected] void QMenuBar::actionEvent(QActionEvent *e)

Reimplements: QWidget::actionEvent(QActionEvent *event).

QRect QMenuBar::actionGeometry(QAction *act) const

Returns the geometry of action act as a QRect.

See also actionAt().

QAction *QMenuBar::activeAction() const

Returns the QAction that is currently highlighted, if any, else nullptr.

See also setActiveAction().

QAction *QMenuBar::addAction(const QString &text)

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(const QString &text, const QObject *receiver, const char *member)

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

template <typename Obj, typename PointerToMemberFunctionOrFunctor> QAction *QMenuBar::addAction(const QString &text, const Obj *receiver, PointerToMemberFunctionOrFunctor method)

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 method of the receiver. The function adds the newly created action to the menu's list of actions and returns it.

QMenuBar takes ownership of the returned QAction.

This function was introduced in Qt 5.11.

See also QWidget::addAction() and QWidget::actions().

template <typename Functor> QAction *QMenuBar::addAction(const QString &text, Functor functor)

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 functor. The function adds the newly created action to the menu's list of actions and returns it.

QMenuBar takes ownership of the returned QAction.

This function was introduced in Qt 5.11.

See also QWidget::addAction() and QWidget::actions().

QAction *QMenuBar::addMenu(QMenu *menu)

Appends menu to the menu bar. Returns the menu's menuAction(). The menu bar does not take ownership of the menu.

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

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

QMenu *QMenuBar::addMenu(const 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(const QIcon &icon, const 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()

Appends a separator to the menu.

[override virtual protected] void QMenuBar::changeEvent(QEvent *e)

Reimplements: QWidget::changeEvent(QEvent *event).

void QMenuBar::clear()

Removes all the actions from the menu bar.

Note: On macOS, 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(Qt::Corner corner = Qt::TopRightCorner) const

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

[override virtual protected] bool QMenuBar::event(QEvent *e)

Reimplements: QWidget::event(QEvent *event).

[override virtual protected] bool QMenuBar::eventFilter(QObject *object, QEvent *event)

Reimplements: QObject::eventFilter(QObject *watched, QEvent *event).

[override virtual protected] void QMenuBar::focusInEvent(QFocusEvent *)

Reimplements: QWidget::focusInEvent(QFocusEvent *event).

[override virtual protected] void QMenuBar::focusOutEvent(QFocusEvent *)

Reimplements: QWidget::focusOutEvent(QFocusEvent *event).

[override virtual] int QMenuBar::heightForWidth(int) const

Reimplements: QWidget::heightForWidth(int w) const.

[protected] void QMenuBar::initStyleOption(QStyleOptionMenuItem *option, const QAction *action) const

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

[override virtual protected] void QMenuBar::keyPressEvent(QKeyEvent *e)

Reimplements: QWidget::keyPressEvent(QKeyEvent *event).

[override virtual protected] void QMenuBar::leaveEvent(QEvent *)

Reimplements: QWidget::leaveEvent(QEvent *event).

[override virtual] QSize QMenuBar::minimumSizeHint() const

Reimplements an access function for property: QWidget::minimumSizeHint.

[override virtual protected] void QMenuBar::mouseMoveEvent(QMouseEvent *e)

Reimplements: QWidget::mouseMoveEvent(QMouseEvent *event).

[override virtual protected] void QMenuBar::mousePressEvent(QMouseEvent *e)

Reimplements: QWidget::mousePressEvent(QMouseEvent *event).

[override virtual protected] void QMenuBar::mouseReleaseEvent(QMouseEvent *e)

Reimplements: QWidget::mouseReleaseEvent(QMouseEvent *event).

[override virtual protected] void QMenuBar::paintEvent(QPaintEvent *e)

Reimplements: QWidget::paintEvent(QPaintEvent *event).

[override virtual protected] void QMenuBar::resizeEvent(QResizeEvent *)

Reimplements: QWidget::resizeEvent(QResizeEvent *event).

void QMenuBar::setActiveAction(QAction *act)

Sets the currently highlighted action to act.

This function was introduced in Qt 4.1.

See also activeAction().

void QMenuBar::setCornerWidget(QWidget *widget, Qt::Corner corner = Qt::TopRightCorner)

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

[override virtual] QSize QMenuBar::sizeHint() const

Reimplements an access function for property: QWidget::sizeHint.

[override virtual protected] void QMenuBar::timerEvent(QTimerEvent *e)

Reimplements: QObject::timerEvent(QTimerEvent *event).

NSMenu *QMenuBar::toNSMenu()

Returns the native NSMenu for this menu bar. Available on macOS only.

Note: Qt may set the delegate on the native menu bar. If you need to set your own delegate, make sure you save the original one and forward any calls to it.

This function was introduced in Qt 5.2.