Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.trolltech.qt.gui
Class QMenuBar

    java.lang.Object
      com.trolltech.qt.QSignalEmitter
          com.trolltech.qt.QtJambiObject
              com.trolltech.qt.core.QObject
                  com.trolltech.qt.gui.QWidget
                      com.trolltech.qt.gui.QMenuBar

All Implemented Interfaces:
  QPaintDeviceInterface, QtJambiInterface

    public class QMenuBar

extends QWidget

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.

In most main window style applications you would use the `menuBar()` provided in `QMainWindow`, adding `QMenu`s to the menu bar and adding `QAction`s to the popup menus.

Example (from the Menus example):
The following code example is written in c++.

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

Menu items may be removed with `removeAction()`.

## 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 Qt/Mac

`QMenuBar` on Qt/Mac 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/Mac 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> | 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 Qt/Mac for more information.

## QMenuBar on Qt/CE

`QMenuBar` on Qt/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.

See also:
  `QMenu`, `QShortcut`, `QAction`, GUI Design Handbook: Menu Bar, and Menus Example.

Nested Class Summary

Nested classes/interfaces inherited from class com.trolltech.qt.gui.QWidget
`QWidget.RenderFlag, QWidget.RenderFlags`

Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
`QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9`

Field Summary
`QSignalEmitter.Signal1` | `hovered` This signal is emitted when a menu action is highlighted; `action` is the action that caused the event to be sent.
`QSignalEmitter.Signal1` | `triggered` 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.

Fields inherited from class com.trolltech.qt.gui.QWidget
`customContextMenuRequested`

Constructor Summary
`QMenuBar()` Constructs a menu bar with parent `parent`.
`QMenuBar(QWidget parent)` Constructs a menu bar with parent `parent`.

Method Summary
`QAction` | `activeAction()` Returns the `QAction` that is currently highlighted.
`QAction` | `addAction(java.lang.String text)` This convenience function creates a new action with `text`.
`QAction` | `addAction(java.lang.String text, java.lang.Object receiver, java.lang.String method)` This convenience function creates a new action with the given `text`.
`QAction` | `addAction(java.lang.String text, QSignalEmitter.AbstractSignal signal)`
`QMenu` | `addMenu(QIcon icon, java.lang.String title)` Appends a new `QMenu` with `icon` and `title` to the menu bar.
`QAction` | `addMenu(QMenu menu)` Appends `menu` to the menu bar.
`QMenu` | `addMenu(java.lang.String title)` Appends a new `QMenu` with `title` to the menu bar.
`QAction` | `addSeparator()` Appends a separator to the menu.
`void` | `clear()` Removes all the actions from the menu bar.
`static QMenuBar` | `fromNativePointer(QNativePointer nativePointer)` This method returns the QMenuBar instance pointed to by `nativePointer`.
`protected void` | `initStyleOption(QStyleOptionMenuItem option, QAction action)` Initialize `option` with the values from the menu bar and information from `action`.
`QAction` | `insertMenu(QAction before, QMenu menu)` This convenience function inserts `menu` before action `before` and returns the menus `menuAction()`.
`QAction` | `insertSeparator(QAction before)` This convenience function creates a new separator action, i.e.
`boolean` | `isDefaultUp()` This property holds the popup orientation.
`void` | `setActiveAction(QAction action)` Sets the currently highlighted action to `act`.
`void` | `setDefaultUp(boolean arg__1)` This property holds the popup orientation.

Methods inherited from class com.trolltech.qt.gui.QWidget
`acceptDrops, accessibleDescription, accessibleName, actionEvent, actions, activateWindow, addAction, addActions, adjustSize, autoFillBackground, backgroundRole, baseSize, changeEvent, childAt, childAt, childrenRect, childrenRegion, clearFocus, clearMask, close, closeEvent, contentsRect, contextMenuEvent, contextMenuPolicy, cursor, depth, destroy, destroy, destroy, dragEnterEvent, dragLeaveEvent, dragMoveEvent, dropEvent, effectiveWinId, ensurePolished, enterEvent, focusInEvent, focusNextChild, focusNextPrevChild, focusOutEvent, focusPolicy, focusPreviousChild, focusProxy, focusWidget, font, fontInfo, fontMetrics, foregroundRole, frameGeometry, frameSize, geometry, getContentsMargins, grabKeyboard, grabMouse, grabMouse, grabShortcut, grabShortcut, hasFocus, hasMouseTracking, height, heightForWidth, heightMM, hide, hideEvent, inputContext, inputMethodEvent, inputMethodQuery, insertAction, insertActions, isActiveWindow, isAncestorOf, isEnabled, isEnabledTo, isFullScreen, isHidden, isMaximized, isMinimized, isModal, isVisible, isVisibleTo, isWindow, isWindowModified, keyboardGrabber, keyPressEvent, keyReleaseEvent, languageChange, layout, layoutDirection, leaveEvent, locale, logicalDpiX, logicalDpiY, lower, mapFrom, mapFromGlobal, mapFromParent, mapTo, mapToGlobal, mapToParent, mask, maximumHeight, maximumSize, maximumWidth, metric, minimumHeight, minimumSize, minimumSizeHint, minimumWidth, mouseDoubleClickEvent, mouseGrabber, mouseMoveEvent, mousePressEvent, mouseReleaseEvent, move, move, moveEvent, nativeParentWidget, nextInFocusChain, normalGeometry, numColors, overrideWindowFlags, overrideWindowFlags, paintEngine, paintEvent, paintingActive, palette, parentWidget, physicalDpiX, physicalDpiY, pos, raise, rect, releaseKeyboard, releaseMouse, releaseShortcut, removeAction, render, render, render, render, render, render, render, render, render, repaint, repaint, repaint, repaint, resetInputContext, resize, resize, resizeEvent, restoreGeometry, saveGeometry, scroll, scroll, setAcceptDrops, setAccessibleDescription, setAccessibleName, setAttribute, setAttribute, setAutoFillBackground, setBackgroundRole, setBaseSize, setBaseSize, setContentsMargins, setContentsMargins, setContextMenuPolicy, setCursor, setDisabled, setEnabled, setFixedHeight, setFixedSize, setFixedSize, setFixedWidth, setFocus, setFocus, setFocusPolicy, setFocusProxy, setFont, setForegroundRole, setGeometry, setGeometry, setHidden, setInputContext, setLayout, setLayoutDirection, setLocale, setMask, setMask, setMaximumHeight, setMaximumSize, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumSize, setMinimumWidth, setMouseTracking, setPalette, setParent, setParent, setParent, setShortcutAutoRepeat, setShortcutAutoRepeat, setShortcutEnabled, setShortcutEnabled, setSizeIncrement, setSizeIncrement, setSizePolicy, setSizePolicy, setStatusTip, setStyle, setStyleSheet, setTabOrder, setToolTip, setUpdatesEnabled, setVisible, setWhatsThis, setWindowFilePath, setWindowFlags, setWindowFlags, setWindowIcon, setWindowIconText, setWindowModality, setWindowModified, setWindowOpacity, setWindowRole, setWindowState, setWindowState, setWindowTitle, show, showEvent, showFullScreen, showMaximized, showMinimized, showNormal, size, sizeHint, sizeIncrement, sizePolicy, stackUnder, statusTip, style, styleSheet, tabletEvent, testAttribute, toolTip, underMouse, unsetCursor, unsetLayoutDirection, unsetLocale, update, update, update, update, updateGeometry, updateMicroFocus, updatesEnabled, visibleRegion, whatsThis, wheelEvent, width, widthMM, window, windowFilePath, windowFlags, windowIcon, windowIconText, windowModality, windowOpacity, windowRole, windowState, windowTitle, windowType, winId, x, y`

Methods inherited from class com.trolltech.qt.core.QObject
`childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty`

Methods inherited from class com.trolltech.qt.QtJambiObject
`dispose, disposed, equals, finalize, reassignNativeResources, tr, tr, tr`

Methods inherited from class com.trolltech.qt.QSignalEmitter
`blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread`

Methods inherited from class java.lang.Object
`clone, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface com.trolltech.qt.QtJambiInterface
`disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership`

Field Detail

### hovered

    public final QSignalEmitter.Signal1 hovered

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

### triggered

    public final QSignalEmitter.Signal1 triggered

  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.

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

Constructor Detail

### QMenuBar

    public QMenuBar()

  Constructs a menu bar with parent `parent`.

### QMenuBar

    public QMenuBar(QWidget parent)

  Constructs a menu bar with parent `parent`.

Method Detail

### activeAction

    public final QAction activeAction()

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

See also:
  `setActiveAction()`.

### addAction

    public final QAction addAction(java.lang.String 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()`.

### addMenu

    public final QAction addMenu(QMenu menu)

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

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

### addMenu

    public final QMenu addMenu(QIcon icon,
                               java.lang.String 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()`.

### addMenu

    public final QMenu addMenu(java.lang.String 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()`.

### addSeparator

    public final QAction addSeparator()

  Appends a separator to the menu.

### clear

    public final void clear()

  Removes all the actions from the menu bar.

See also:
  `removeAction()`.

### insertMenu

    public final QAction insertMenu(QAction before,
                                    QMenu menu)

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

See also:
  `QWidget::insertAction()`, and `addMenu()`.

### insertSeparator

    public final QAction 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()`.

### isDefaultUp

    public final boolean isDefaultUp()

  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.

### setActiveAction

    public final void setActiveAction(QAction action)

  Sets the currently highlighted action to `act`.

See also:
  `activeAction()`.

### setDefaultUp

    public final void setDefaultUp(boolean arg__1)

  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.

### fromNativePointer

    public static QMenuBar fromNativePointer(QNativePointer nativePointer)

  This method returns the QMenuBar instance pointed to by `nativePointer`.

### initStyleOption

    protected final void initStyleOption(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.

### addAction

    public final QAction addAction(java.lang.String text,
                                   java.lang.Object receiver,
                                   java.lang.String method)

  This convenience function creates a new action with the given `text`. The action's triggered() signal is connected to the `receiver`'s `method` slot. The function adds the newly created action to the menu's list of actions and returns it.

### addAction

    public final QAction addAction(java.lang.String text,
                                   QSignalEmitter.AbstractSignal signal)

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD