|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.core.QObject
com.trolltech.qt.gui.QWidget
com.trolltech.qt.gui.QMenu
public class QMenu
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. |
A menu consists of a list of action items. Actions are added with addAction. 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".
There are three kinds of action items: separators, actions that show a submenu, and actions that perform an action. Separators are inserted with addSeparator. For submenus use addMenu. 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.
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.
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.Signal0, QSignalEmitter.Signal1<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I> |
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<QAction> |
hovered
This signal is emitted when a menu action is highlighted; action is the action that caused the signal to be emitted. |
QSignalEmitter.Signal1<QAction> |
triggered
This signal is emitted when an action in this menu is triggered; action is the action that caused the signal to be emitted. |
Fields inherited from class com.trolltech.qt.gui.QWidget |
---|
customContextMenuRequested |
Constructor Summary | |
---|---|
QMenu()
Equivalent to QMenu(0). |
|
QMenu(QWidget parent)
Constructs a menu with parent parent. |
|
QMenu(java.lang.String title)
Equivalent to QMenu(title, 0). |
|
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 arg__1; returns 0 if there is no item there. |
protected void |
actionEvent(QActionEvent arg__1)
This function is reimplemented for internal reasons. |
QRect |
actionGeometry(QAction arg__1)
Returns the geometry of action arg__1. |
QAction |
activeAction()
Returns the currently highlighted action, or 0 if no action is currently highlighted. |
QAction |
addAction(QIcon icon,
java.lang.String text)
This convenience function creates a new action with an icon and some text. |
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 method creates an action with the given icon and text. |
QAction |
addAction(QIcon icon,
java.lang.String text,
QSignalEmitter.AbstractSignal signal,
QKeySequence shortcut)
This function creates a new action with the given icon, shortcut, and text. |
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 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 given text. |
QAction |
addAction(java.lang.String text,
QSignalEmitter.AbstractSignal signal,
QKeySequence shortcut)
This convenience function creates a new action with the text text and specified 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.e. an action with QAction::isSeparator() returning true, and adds the new action to this menu's list of actions. |
protected void |
changeEvent(QEvent arg__1)
This function is reimplemented for internal reasons. |
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. |
protected void |
enterEvent(QEvent arg__1)
This function is reimplemented for internal reasons. |
boolean |
event(QEvent arg__1)
This function is reimplemented for internal reasons. |
QAction |
exec()
Executes this menu synchronously. |
static QAction |
exec(java.util.List<QAction> actions,
QPoint pos)
Equivalent to exec(actions, pos, 0). |
static QAction |
exec(java.util.List<QAction> actions,
QPoint pos,
QAction at)
Executes this menu synchronously. |
QAction |
exec(QPoint pos)
Equivalent to exec(pos, 0). |
QAction |
exec(QPoint pos,
QAction at)
Executes this menu synchronously. |
protected boolean |
focusNextPrevChild(boolean next)
This function is reimplemented for internal reasons. |
static QMenu |
fromNativePointer(QNativePointer nativePointer)
This function returns the QMenu instance pointed to by nativePointer |
protected void |
hideEvent(QHideEvent arg__1)
This function is reimplemented for internal reasons. |
void |
hideTearOffMenu()
This function will forcibly hide the torn off menu making it disappear from the users desktop. |
QIcon |
icon()
Returns 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.e. an action with QAction::isSeparator() returning true. |
boolean |
isEmpty()
Returns true if there are no actions inserted into the menu, false otherwise. |
boolean |
isTearOffEnabled()
Returns 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. |
protected void |
keyPressEvent(QKeyEvent arg__1)
This function is reimplemented for internal reasons. |
protected void |
leaveEvent(QEvent arg__1)
This function is reimplemented for internal reasons. |
QAction |
menuAction()
Returns the action associated with this menu. |
protected void |
mouseMoveEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons. |
protected void |
mousePressEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons. |
protected void |
mouseReleaseEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons. |
protected void |
paintEvent(QPaintEvent arg__1)
This function is reimplemented for internal reasons. |
void |
popup(QPoint pos)
Equivalent to popup(pos, 0). |
void |
popup(QPoint pos,
QAction at)
Displays the menu so that the action at will be at the specified global position pos. |
boolean |
separatorsCollapsible()
Returns 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 arg__1. |
void |
setIcon(QIcon icon)
Sets The icon of the menu to icon. |
void |
setSeparatorsCollapsible(boolean collapse)
Sets whether consecutive separators should be collapsed to collapse. |
void |
setTearOffEnabled(boolean arg__1)
Sets whether the menu supports being torn off to arg__1. |
void |
setTitle(java.lang.String title)
Sets The title of the menu to title. |
QSize |
sizeHint()
This function is reimplemented for internal reasons. |
protected void |
timerEvent(QTimerEvent arg__1)
This function is reimplemented for internal reasons. |
java.lang.String |
title()
Returns The title of the menu. |
protected void |
wheelEvent(QWheelEvent arg__1)
This function is reimplemented for internal reasons. |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
blockSignals, childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, property, removeEventFilter, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
disconnect, disconnect, signalSender |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal0 aboutToHide
This signal is emitted just before the menu is hidden from the user.
public final QSignalEmitter.Signal0 aboutToShow
This signal is emitted just before the menu is shown to the user.
public final QSignalEmitter.Signal1<QAction> hovered
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.
public final QSignalEmitter.Signal1<QAction> triggered
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".
Constructor Detail |
---|
public QMenu()
Equivalent to QMenu(0).
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).
public QMenu(java.lang.String title)
Equivalent to QMenu(title, 0).
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).
Method Detail |
---|
public final QAction actionAt(QPoint arg__1)
Returns the item at arg__1; returns 0 if there is no item there.
public final QRect actionGeometry(QAction arg__1)
Returns the geometry of action arg__1.
public final QAction activeAction()
Returns the currently highlighted action, or 0 if no action is currently highlighted.
public final QAction addAction(QIcon icon, java.lang.String text)
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.
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.
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.
public final QAction addMenu(QMenu menu)
This convenience function adds menu as a submenu to this menu. It returns the menus menuAction.
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.
public final QAction addSeparator()
This convenience function creates a new separator action, i.e. 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.
public final void clear()
Removes all the menu's actions. Actions owned by the menu and not shown in any other widget are deleted.
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.
public final QAction defaultAction()
Returns the current default action.
public final QAction exec(QPoint pos)
Equivalent to exec(pos, 0).
public final QAction exec(QPoint pos, QAction at)
Executes this menu synchronously.
Pops up the menu so that the action at will be at the specified global position pos. 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:
exec(QCursor::pos());
or aligned to a widget:
exec(somewidget.mapToGlobal(QPoint(0, 0)));
or in reaction to a QMouseEvent *e:
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.
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:
exec(QCursor::pos());
or aligned to a widget:
exec(somewidget.mapToGlobal(QPoint(0,0)));
or in reaction to a QMouseEvent *e:
exec(e->globalPos());
public final void hideTearOffMenu()
This function will forcibly hide the torn off menu making it disappear from the users desktop.
public final QIcon icon()
Returns The icon of the menu.
This is equivalent to the QAction::icon property of the menuAction.
public final QAction insertMenu(QAction before, QMenu menu)
This convenience function inserts menu before action before and returns the menus menuAction.
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's list of actions before action before and returns it.
public final boolean isEmpty()
Returns true if there are no actions inserted into the menu, false otherwise.
public final boolean isTearOffEnabled()
Returns whether the menu supports being torn off.
When true, QMenu has a special menu item (often shown as a dashed line at the top of the menu) that creates a copy of the menu when the tear-off menu item 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.
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.
public final QAction menuAction()
Returns the action associated with this menu.
public final void popup(QPoint pos)
Equivalent to popup(pos, 0).
public final void popup(QPoint pos, QAction at)
Displays the menu so that the action at will be at the specified global position pos. 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.
public final boolean separatorsCollapsible()
Returns 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.
public final void setActiveAction(QAction act)
Sets the currently highlighted action to act.
public final void setDefaultAction(QAction arg__1)
This will set the default action to arg__1. 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.
public final void setIcon(QIcon icon)
Sets The icon of the menu to icon.
This is equivalent to the QAction::icon property of the menuAction.
public final void setSeparatorsCollapsible(boolean collapse)
Sets whether consecutive separators should be collapsed to collapse.
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.
public final void setTearOffEnabled(boolean arg__1)
Sets whether the menu supports being torn off to arg__1.
When true, QMenu has a special menu item (often shown as a dashed line at the top of the menu) that creates a copy of the menu when the tear-off menu item 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.
public final void setTitle(java.lang.String title)
Sets The title of the menu to title.
This is equivalent to the QAction::text property of the menuAction.
public final java.lang.String title()
Returns The title of the menu.
This is equivalent to the QAction::text property of the menuAction.
protected void actionEvent(QActionEvent arg__1)
This function is reimplemented for internal reasons.
actionEvent
in class QWidget
protected void changeEvent(QEvent arg__1)
This function is reimplemented for internal reasons.
changeEvent
in class QWidget
protected void enterEvent(QEvent arg__1)
This function is reimplemented for internal reasons.
enterEvent
in class QWidget
public boolean event(QEvent arg__1)
This function is reimplemented for internal reasons.
event
in class QWidget
protected boolean focusNextPrevChild(boolean next)
This function is reimplemented for internal reasons.
focusNextPrevChild
in class QWidget
protected void hideEvent(QHideEvent arg__1)
This function is reimplemented for internal reasons.
hideEvent
in class QWidget
visible
,
event,
QHideEventprotected void keyPressEvent(QKeyEvent arg__1)
This function is reimplemented for internal reasons.
keyPressEvent
in class QWidget
protected void leaveEvent(QEvent arg__1)
This function is reimplemented for internal reasons.
leaveEvent
in class QWidget
protected void mouseMoveEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons.
mouseMoveEvent
in class QWidget
Example
protected void mousePressEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons.
mousePressEvent
in class QWidget
Example
protected void mouseReleaseEvent(QMouseEvent arg__1)
This function is reimplemented for internal reasons.
mouseReleaseEvent
in class QWidget
Example
protected void paintEvent(QPaintEvent arg__1)
This function is reimplemented for internal reasons.
paintEvent
in class QWidget
public QSize sizeHint()
This function is reimplemented for internal reasons.
sizeHint
in class QWidget
protected void timerEvent(QTimerEvent arg__1)
This function is reimplemented for internal reasons.
timerEvent
in class QObject
protected void wheelEvent(QWheelEvent arg__1)
This function is reimplemented for internal reasons.
wheelEvent
in class QWidget
public static QAction exec(java.util.List<QAction> actions, QPoint pos)
Equivalent to exec(actions, pos, 0).
public static QAction exec(java.util.List<QAction> actions, QPoint pos, QAction at)
Executes this 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;
QAction *at = actions[0]; // Assumes actions is not empty
foreach (QAction *a, actions)
menu.addAction(a);
menu.exec(pos, at);
public static QMenu fromNativePointer(QNativePointer nativePointer)
nativePointer
- the QNativePointer of which object should be returned.protected final void initStyleOption(QStyleOptionMenuItem option, QAction action)
public final QAction addAction(java.lang.String text, java.lang.Object receiver, java.lang.String method, QKeySequence shortcut)
public final QAction addAction(java.lang.String text, QSignalEmitter.AbstractSignal signal, QKeySequence shortcut)
public final QAction addAction(java.lang.String text, java.lang.Object receiver, java.lang.String method)
public final QAction addAction(java.lang.String text, QSignalEmitter.AbstractSignal signal)
public final QAction addAction(QIcon icon, java.lang.String text, java.lang.Object receiver, java.lang.String method, QKeySequence shortcut)
public final QAction addAction(QIcon icon, java.lang.String text, QSignalEmitter.AbstractSignal signal, QKeySequence shortcut)
public final QAction addAction(QIcon icon, java.lang.String text, java.lang.Object receiver, java.lang.String method)
public final QAction addAction(QIcon icon, java.lang.String text, QSignalEmitter.AbstractSignal signal)
|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |