com.trolltech.qt.gui
Class QMenu

java.lang.Object
  extended by com.trolltech.qt.internal.QSignalEmitterInternal
      extended by com.trolltech.qt.QSignalEmitter
          extended by com.trolltech.qt.QtJambiObject
              extended by com.trolltech.qt.core.QObject
                  extended by com.trolltech.qt.gui.QWidget
                      extended by com.trolltech.qt.gui.QMenu
All Implemented Interfaces:
QPaintDeviceInterface, QtJambiInterface

public class QMenu
extends QWidget

The QMenu class provides a menu widget for use in menu bars, context menus, and other popup menus. 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 QMenuBar::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 with popup() or synchronously with exec(). Menus can also be invoked in response to button presses; these are just like context menus except for how they are invoked.







A menu shown in Plastique widget style, Windows XP widget style, and Macintosh widget style.

Actions

A menu consists of a list of action items. Actions are added with the
addAction(), addActions() and insertAction() functions. An action is represented vertically and rendered by QStyle. 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 with addMenu(), 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, activated() and highlighted(), which signal the QAction that was triggered from the menu.

You clear a menu with clear() and remove individual action items with removeAction().

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 with setTearOffEnabled(). 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 a QToolBar 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 the addAction() overload that takes a QAction.

Conversely, actions can be added to widgets with the addAction(), addActions() and insertAction() functions.

QMenu on Qt for Windows CE

If a menu is integrated into the native menubar on Windows Mobile we do not support the signals: aboutToHide (), aboutToShow () and hovered (). It is not possible to display an icon in a native menu on Windows Mobile.

See the Menus example for an example of how to use QMenuBar and QMenu in your application.

Important inherited functions:addAction(), removeAction(), clear(), addSeparator(), and addMenu().

See also:
QMenuBar, GUI Design Handbook: Menu, Drop-Down and Pop-Up, Application Example, Menus Example, and Recent Files 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.AbstractSignal, QSignalEmitter.PrivateSignal0, QSignalEmitter.PrivateSignal1, QSignalEmitter.PrivateSignal2, QSignalEmitter.PrivateSignal3, QSignalEmitter.PrivateSignal4, QSignalEmitter.PrivateSignal5, QSignalEmitter.PrivateSignal6, QSignalEmitter.PrivateSignal7, QSignalEmitter.PrivateSignal8, QSignalEmitter.PrivateSignal9, QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Nested classes/interfaces inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
com.trolltech.qt.internal.QSignalEmitterInternal.AbstractSignalInternal
 
Field Summary
 QSignalEmitter.Signal0 aboutToHide
          This signal is emitted just before the menu is hidden from the user.
 QSignalEmitter.Signal0 aboutToShow
          This signal is emitted just before the menu is shown to the user.
 QSignalEmitter.Signal1 hovered
          This signal takes 1 generic argument(s).
 QSignalEmitter.Signal1 triggered
          This signal takes 1 generic argument(s).
 
Fields inherited from class com.trolltech.qt.gui.QWidget
customContextMenuRequested
 
Fields inherited from class com.trolltech.qt.internal.QSignalEmitterInternal
currentSender
 
Constructor Summary
QMenu()
          Constructs a menu with parent parent.
QMenu(QWidget parent)
          Constructs a menu with parent parent.
QMenu(java.lang.String title)
          Constructs a menu with a title and a parent.
QMenu(java.lang.String title, QWidget parent)
          Constructs a menu with a title and a parent.
 
Method Summary
 QAction actionAt(QPoint arg__1)
          Returns the item at pt; returns 0 if there is no item there.
 QRect actionGeometry(QAction arg__1)
          Returns the geometry of action act.
 QAction activeAction()
          Returns the currently highlighted action, or 0 if no action is currently highlighted.
 QAction addAction(QIcon icon, java.lang.String text)
          This is an overloaded member function, provided for convenience.
 QAction addAction(QIcon icon, java.lang.String text, java.lang.Object receiver, java.lang.String method)
          This method creates a new action with the given icon and text.
 QAction addAction(QIcon icon, java.lang.String text, java.lang.Object receiver, java.lang.String method, QKeySequence shortcut)
          This function creates a new action with the given icon, shortcut, and text.
 QAction addAction(QIcon icon, java.lang.String text, QSignalEmitter.AbstractSignal signal)
          This convenience function creates a new action with an icon and some text and an optional shortcut shortcut.
 QAction addAction(QIcon icon, java.lang.String text, QSignalEmitter.AbstractSignal signal, QKeySequence shortcut)
          This convenience function creates a new action with an icon and some text and an optional shortcut shortcut.
 QAction addAction(java.lang.String text)
          This is an overloaded member function, provided for convenience.
 QAction addAction(java.lang.String text, java.lang.Object receiver, java.lang.String method)
          This convenience function creates a new action with the text text.
 QAction addAction(java.lang.String text, java.lang.Object receiver, java.lang.String method, QKeySequence shortcut)
          This convenience function creates a new action with the text text.
 QAction addAction(java.lang.String text, QSignalEmitter.AbstractSignal signal)
          This convenience function creates a new action with the text text and an optional shortcut shortcut.
 QAction addAction(java.lang.String text, QSignalEmitter.AbstractSignal signal, QKeySequence shortcut)
          This convenience function creates a new action with the text text and an optional shortcut shortcut.
 QMenu addMenu(QIcon icon, java.lang.String title)
          Appends a new QMenu with icon and title to the menu.
 QAction addMenu(QMenu menu)
          This convenience function adds menu as a submenu to this menu.
 QMenu addMenu(java.lang.String title)
          Appends a new QMenu with title to the menu.
 QAction addSeparator()
          This convenience function creates a new separator action, i.
 void clear()
          Removes all the menu's actions.
protected  int columnCount()
          If a menu does not fit on the screen it lays itself out so that it does fit.
 QAction defaultAction()
          Returns the current default action.
 QAction exec()
          Executes this menu synchronously.
static QAction exec(java.util.List actions, QPoint pos)
          This is an overloaded member function, provided for convenience.
static QAction exec(java.util.List actions, QPoint pos, QAction at)
          This is an overloaded member function, provided for convenience.
static QAction exec(java.util.List actions, QPoint pos, QAction at, QWidget parent)
          This is an overloaded member function, provided for convenience.
 QAction exec(QPoint pos)
          This is an overloaded member function, provided for convenience.
 QAction exec(QPoint pos, QAction at)
          This is an overloaded member function, provided for convenience.
 void hideTearOffMenu()
          This function will forcibly hide the torn off menu making it disappear from the users desktop.
 QIcon icon()
          This property holds The icon of the menu.
protected  void initStyleOption(QStyleOptionMenuItem option, QAction action)
          Initialize option with the values from this menu 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.
 boolean isEmpty()
          Returns true if there are no visible actions inserted into the menu, false otherwise.
 boolean isTearOffEnabled()
          This property holds whether the menu supports being torn off.
 boolean isTearOffMenuVisible()
          When a menu is torn off a second menu is shown to display the menu contents in a new window.
 QAction menuAction()
          Returns the action associated with this menu.
 void popup(QPoint pos)
          Displays the menu so that the action atAction will be at the specified global position p.
 void popup(QPoint pos, QAction at)
          Displays the menu so that the action atAction will be at the specified global position p.
 boolean separatorsCollapsible()
          This property holds whether consecutive separators should be collapsed.
 void setActiveAction(QAction act)
          Sets the currently highlighted action to act.
 void setDefaultAction(QAction arg__1)
          This will set the default action to act.
 void setIcon(QIcon icon)
          This property holds The icon of the menu.
 void setSeparatorsCollapsible(boolean collapse)
          This property holds whether consecutive separators should be collapsed.
 void setTearOffEnabled(boolean arg__1)
          This property holds whether the menu supports being torn off.
 void setTitle(java.lang.String title)
          This property holds The title of the menu.
 java.lang.String title()
          This property holds The title of the menu.
 
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, graphicsProxyWidget, 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, overrideWindowState, 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 com.trolltech.qt.internal.QSignalEmitterInternal
__qt_signalInitialization
 
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

aboutToHide

public final QSignalEmitter.Signal0 aboutToHide
This signal is emitted just before the menu is hidden from the user.

See also:
aboutToShow() , and hide().


aboutToShow

public final QSignalEmitter.Signal0 aboutToShow
This signal is emitted just before the menu is shown to the user.

See also:
aboutToHide() , and show().


hovered

public final QSignalEmitter.Signal1 hovered

This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <com.trolltech.qt.gui.QAction(named: action)>:

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

Often this is used to update status information.

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


triggered

public final QSignalEmitter.Signal1 triggered

This signal takes 1 generic argument(s). We list their type and the name they go by in the description of this signal. <com.trolltech.qt.gui.QAction(named: action)>:

This signal is emitted when an action in this menu is triggered; action is the action that caused the signal to be emitted.

Normally, you connect each menu action's triggered() signal to its own custom slot, but sometimes you will want to connect several actions to a single slot, for example, when you have a group of closely related actions, such as "left justify", "center", "right justify".

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

Constructor Detail

QMenu

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


QMenu

public QMenu(QWidget parent)
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).


QMenu

public QMenu(java.lang.String title)
Constructs a menu with a title and a 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).

See also:
title.


QMenu

public QMenu(java.lang.String title,
             QWidget parent)
Constructs a menu with a title and a 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).

See also:
title.

Method Detail

actionAt

public final QAction actionAt(QPoint arg__1)
Returns the item at pt; returns 0 if there is no item there.


actionGeometry

public final QRect actionGeometry(QAction arg__1)
Returns the geometry of action act.


activeAction

public final QAction activeAction()
Returns the currently highlighted action, or 0 if no action is currently highlighted.

See also:
setActiveAction().


addAction

public final QAction addAction(QIcon icon,
                               java.lang.String text)
This is an overloaded member function, provided for convenience.

This convenience function creates a new action with an icon and some text. The function adds the newly created action to the menu's list of actions, and returns it.

See also:
QWidget::addAction().


addAction

public final QAction addAction(java.lang.String text)
This is an overloaded member function, provided for convenience.

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)
This convenience function adds menu as a submenu to this menu. It returns menu's menuAction(). This menu does not take ownership of menu.

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. The menu 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. The menu takes ownership of the menu. Returns the new menu.

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


addSeparator

public final QAction addSeparator()
This convenience function creates a new separator action, i. . an action with QAction::isSeparator() returning true, and adds the new action to this menu's list of actions. It returns the newly created action.

See also:
QWidget::addAction().


clear

public final void clear()
Removes all the menu's actions. Actions owned by the menu and not shown in any other widget are deleted.

See also:
removeAction().


columnCount

protected final int columnCount()
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.


defaultAction

public final QAction defaultAction()
Returns the current default action.

See also:
setDefaultAction().


exec

public final QAction exec()
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:

      menu.exec(QCursor.pos());
or aligned to a widget:
      menu.exec(somewidget.mapToGlobal(new QPoint(0,0)));
or in reaction to a QMouseEvent *e:
      menu.exec(e.globalPos());


exec

public final QAction exec(QPoint pos)
This is an overloaded member function, provided for convenience.

Executes this menu synchronously.

Pops up the menu so that the action action will be at the specified global position p. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal().

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's exec(), you get the result both via the signal-slot connection and in the return value of exec().

Common usage is to position the menu at the current mouse position:

      menu.exec(QCursor.pos());
or aligned to a widget:
      menu.exec(somewidget.mapToGlobal(new QPoint(0, 0)));
or in reaction to a QMouseEvent *e:
      menu.exec(e.globalPos());
When positioning a menu with exec() or popup(), bear in mind that you cannot rely on the menu's current size(). 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, use sizeHint() which calculates the proper size depending on the menu's current contents.

See also:
popup(), and QWidget::mapToGlobal().


exec

public final QAction exec(QPoint pos,
                          QAction at)
This is an overloaded member function, provided for convenience.

Executes this menu synchronously.

Pops up the menu so that the action action will be at the specified global position p. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal().

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's exec(), you get the result both via the signal-slot connection and in the return value of exec().

Common usage is to position the menu at the current mouse position:

      menu.exec(QCursor.pos());
or aligned to a widget:
      menu.exec(somewidget.mapToGlobal(new QPoint(0, 0)));
or in reaction to a QMouseEvent *e:
      menu.exec(e.globalPos());
When positioning a menu with exec() or popup(), bear in mind that you cannot rely on the menu's current size(). 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, use sizeHint() which calculates the proper size depending on the menu's current contents.

See also:
popup(), and QWidget::mapToGlobal().


hideTearOffMenu

public final void hideTearOffMenu()
This function will forcibly hide the torn off menu making it disappear from the users desktop.

See also:
isTearOffMenuVisible(), and isTearOffEnabled().


icon

public final QIcon icon()
This property holds The icon of the menu. This is equivalent to the QAction::icon property of the menuAction().

By default, if no icon is explicitly set, this property contains a null icon.


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. . an action with QAction::isSeparator() returning true. The function inserts the newly created action into this menu's list of actions before action before and returns it.

See also:
QWidget::insertAction(), and addSeparator().


isEmpty

public final boolean isEmpty()
Returns true if there are no visible actions inserted into the menu, false otherwise.

See also:
QWidget::actions().


isTearOffEnabled

public final boolean isTearOffEnabled()
This property holds whether the menu supports being torn off. When true, the menu contains a special tear-off item (often shown as a dashed line at the top of the menu) that creates a copy of the menu when it is triggered.

This "torn-off" copy lives in a separate window. It contains the same menu items as the original menu, with the exception of the tear-off handle.

By default, this property is false.


isTearOffMenuVisible

public final boolean isTearOffMenuVisible()
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.

See also:
hideTearOffMenu(), and isTearOffEnabled().


menuAction

public final QAction menuAction()
Returns the action associated with this menu.


popup

public final void popup(QPoint pos)
Displays the menu so that the action atAction will be at the specified global position p. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal().

When positioning a menu with exec() or popup(), bear in mind that you cannot rely on the menu's current size(). 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, use sizeHint() which calculates the proper size depending on the menu's current contents.

See also:
QWidget::mapToGlobal(), and exec().


popup

public final void popup(QPoint pos,
                        QAction at)
Displays the menu so that the action atAction will be at the specified global position p. To translate a widget's local coordinates into global coordinates, use QWidget::mapToGlobal().

When positioning a menu with exec() or popup(), bear in mind that you cannot rely on the menu's current size(). 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, use sizeHint() which calculates the proper size depending on the menu's current contents.

See also:
QWidget::mapToGlobal(), and exec().


separatorsCollapsible

public final boolean separatorsCollapsible()
This property holds whether consecutive separators should be collapsed. This property specifies whether consecutive separators in the menu should be visually collapsed to a single one. Separators at the beginning or the end of the menu are also hidden.

By default, this property is true.


setActiveAction

public final void setActiveAction(QAction act)
Sets the currently highlighted action to act.

See also:
activeAction().


setDefaultAction

public final void setDefaultAction(QAction arg__1)
This will set the default action to act. The default action may have a visual queue depending on the current QStyle. A default action is usually meant to indicate what will defaultly happen on a drop, as shown in a context menu.

See also:
defaultAction().


setIcon

public final void setIcon(QIcon icon)
This property holds The icon of the menu. This is equivalent to the QAction::icon property of the menuAction().

By default, if no icon is explicitly set, this property contains a null icon.


setSeparatorsCollapsible

public final void setSeparatorsCollapsible(boolean collapse)
This property holds whether consecutive separators should be collapsed. This property specifies whether consecutive separators in the menu should be visually collapsed to a single one. Separators at the beginning or the end of the menu are also hidden.

By default, this property is true.


setTearOffEnabled

public final void setTearOffEnabled(boolean arg__1)
This property holds whether the menu supports being torn off. When true, the menu contains a special tear-off item (often shown as a dashed line at the top of the menu) that creates a copy of the menu when it is triggered.

This "torn-off" copy lives in a separate window. It contains the same menu items as the original menu, with the exception of the tear-off handle.

By default, this property is false.


setTitle

public final void setTitle(java.lang.String title)
This property holds The title of the menu. This is equivalent to the QAction::text property of the menuAction().

By default, this property contains an empty string.


title

public final java.lang.String title()
This property holds The title of the menu. This is equivalent to the QAction::text property of the menuAction().

By default, this property contains an empty string.


exec

public static QAction exec(java.util.List actions,
                           QPoint pos)
This is an overloaded member function, provided for convenience.

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 position pos. If at is not specified then the menu appears at position pos.

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:

       QMenu menu = new QMenu();
       QAction at = actions.get(0); // Assumes actions is not empty
       for (QAction a: actions)
          menu.addAction(a);
       menu.exec(pos, at);

See also:
popup(), and QWidget::mapToGlobal().


exec

public static QAction exec(java.util.List actions,
                           QPoint pos,
                           QAction at)
This is an overloaded member function, provided for convenience.

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 position pos. If at is not specified then the menu appears at position pos.

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:

       QMenu menu = new QMenu();
       QAction at = actions.get(0); // Assumes actions is not empty
       for (QAction a: actions)
          menu.addAction(a);
       menu.exec(pos, at);

See also:
popup(), and QWidget::mapToGlobal().


exec

public static QAction exec(java.util.List actions,
                           QPoint pos,
                           QAction at,
                           QWidget parent)
This is an overloaded member function, provided for convenience.

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 position pos. If at is not specified then the menu appears at position pos. parent is the menu's parent widget; specifying the parent will provide context when pos alone is not enough to decide where the menu should go (e.g., with multiple desktops or when the parent is embedded in QGraphicsView).

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:

       QMenu menu = new QMenu();
       QAction at = actions.get(0); // Assumes actions is not empty
       for (QAction a: actions)
          menu.addAction(a);
       menu.exec(pos, at);

See also:
popup(), and QWidget::mapToGlobal().


initStyleOption

protected final void initStyleOption(QStyleOptionMenuItem option,
                                     QAction action)
Initialize option with the values from this menu 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,
                               QKeySequence shortcut)
This convenience function creates a new action with the text text. The action's QAction.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,
                               QKeySequence shortcut)
This convenience function creates a new action with the text text and an optional shortcut shortcut. The action's QAction.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().


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 text text. The action's QAction.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)
This convenience function creates a new action with the text text and an optional shortcut shortcut. The action's QAction.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().


addAction

public final QAction addAction(QIcon icon,
                               java.lang.String text,
                               java.lang.Object receiver,
                               java.lang.String method,
                               QKeySequence shortcut)
This function creates a new action with the given icon, shortcut, and text. It is connected to the receiver's method slot. It returns the created action.


addAction

public final QAction addAction(QIcon icon,
                               java.lang.String text,
                               QSignalEmitter.AbstractSignal signal,
                               QKeySequence shortcut)
This convenience function creates a new action with an icon and some text and an optional shortcut shortcut. The action's QAction.triggered signal is connected to the member slot of the receiver object. The function adds the newly created action to the menu's list of actions, and returns it.

See also:
QWidget::addAction().


addAction

public final QAction addAction(QIcon icon,
                               java.lang.String text,
                               java.lang.Object receiver,
                               java.lang.String method)
This method creates a new action with the given icon and text. It is connected to the receiver's method slot. It returns the created action.


addAction

public final QAction addAction(QIcon icon,
                               java.lang.String text,
                               QSignalEmitter.AbstractSignal signal)
This convenience function creates a new action with an icon and some text and an optional shortcut shortcut. The action's QAction.triggered signal is connected to the member slot of the receiver object. The function adds the newly created action to the menu's list of actions, and returns it.

See also:
QWidget::addAction().