![]() |
| ||
Classes - Annotated - Tree - Functions - Home - Structure |
The QMenuData class is a base class for QMenuBar and QPopupMenu. More...
#include <qmenudata.h>
Inherited by QMenuBar and QPopupMenu.
QMenuData has an internal list of menu items. A menu item is a text, pixmap or separator, and may also have a popup menu (separators have no popup menus).
The menu item sends out an activated() signal when it is selected and a highlighted() signal when it receives the user input focus.
Menu items can be accessed through identifiers.
See also QAccel.
See also setAccel(), QAccel and qnamespace.h.
If the index is invalid (for example, -1), the object itself is deactivated.
See also text().
See also pixmap().
See also pixmap().
Changes the iconset and pixmap of the menu item id to the iconset icon and to the pixmap pixmap.
See also pixmap().
Changes the text of the menu item id. If the item has an icon, the icon remains unchanged.
See also text().
Changes the pixmap of the menu item id. If the item has an icon, the icon remains unchanged.
See also pixmap().
Changes the icon and text of the menu item id.
See also pixmap().
See also removeItem() and removeItemAt().
Examples: mdi/application.cpp and qwerty/qwerty.cpp.
The receiver's slot/signal is activated when the menu item is activated.
See also disconnectItem() and setItemParameter().
Example: menu/menu.cpp.
All connections are removed when the menu data object is destroyed.
See also connectItem() and setItemParameter().
See also indexOf().
Returns a pointer to the menu item with identifier id, or 0 if there is no item with such an identifier, and changes parent to point to the parent of the return value.
See also indexOf().
See also changeItem(), text() and pixmap().
See also setId() and indexOf().
See also idAt() and findItem().
Example: scrollview/scrollview.cpp.
A menu item is usually either a text string or a pixmap, both with an optional icon or keyboard accelerator. For special cases it is also possible to insert custom items (see QCustomMenuItem) or even widgets into popup menus.
Some insertItem() members take a popup menu as an additional argument. Use this to insert submenus to existing menus or pulldown menus to a menu bar.
The number of insert functions may look confusing, but they are actually quite simple to use.
This default version inserts a menu item with the text text, the accelerator key accel, an id and an optional index and connects it to the slot member in the object receiver.
Example:
QMenuBar *mainMenu = new QMenuBar; QPopupMenu *fileMenu = new QPopupMenu; fileMenu->insertItem( "New", myView, SLOT(newFile()), CTRL+Key_N ); fileMenu->insertItem( "Open", myView, SLOT(open()), CTRL+Key_O ); mainMenu->insertItem( "File", fileMenu );
Not all insert functions take an object/slot parameter or an accelerator key. Use connectItem() and setAccel() on these items.
If you will need to translate accelerators, use QAccel::stringToKey() to calculate the accelerator key:
fileMenu->insertItem( tr("Open"), myView, SLOT(open()), QAccel::stringToKey( tr("Ctrl+O") ) );
In the example above, pressing CTRL+N or selecting "open" from the menu activates the myView->open() function.
Some insert functions take a QIconSet parameter to specify the little menu item icon. Note that you can always pass a QPixmap object instead.
The menu item is assigned the identifier id or an automatically generated identifier if id is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application.
The index specifies the position in the menu. The menu item is appended at the end of the list if index is negative.
Note that keyboard accelerators in Qt are not application-global but are bound to a certain top-level window. Accelerators in QPopupMenu items therefore only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar, for instance; the accelerator will then be installed on the menu bar itself. It also works for stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object.
Warning: Be careful when passing a literal 0 to insertItem() because some C++ compilers choose the wrong overloaded function. Cast the 0 to what you mean, e.g., (QObject*)0.
See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel and qnamespace.h.
Examples: addressbook/mainwindow.cpp, mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp and showimg/showimg.cpp.
Inserts a menu item with an icon, a text, an accelerator key, an id, and an optional index; connects it to an object/slot. The icon will be displayed to the left of the text in the item.
See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel and qnamespace.h.
Inserts a menu item with a pixmap, an accelerator key, an id and an optional index; connects it to an object/slot.
To look best when being highlighted as menu item, the pixmap should provide a mask (see QPixmap::mask()).
Returns the menu item identifier.
See also removeItem(), changeItem(), setAccel() and connectItem().
Inserts a menu item with the icon icon, and the pixmap pixmap The icon will be displayed to the left of the pixmap in the item.
The accelerator key is set to accel and the item is connected it to the member slot in the receiver object.
The menu item is assigned the identifier id or an automatically generated identifier if id is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application.
The index specifies the position in the menu. The menu item is appended at the end of the list if index is negative.
To look best when being highlighted as menu item, the pixmap should provide a mask (see QPixmap::mask()).
Returns the menu item identifier.
See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel and qnamespace.h.
Inserts a menu item with a text. Returns the menu item identifier.
See also removeItem(), changeItem(), setAccel() and connectItem().
Inserts a menu item with the icon icon, and the text text The icon will be displayed to the left of the text in the item.
The menu item is assigned the identifier id or an automatically generated identifier if id is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application.
The index specifies the position in the menu. The menu item is appended at the end of the list if index is negative.
See also removeItem(), changeItem(), setAccel() and connectItem().
Inserts a menu item with a text and a submenu.
The popup must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted.
Returns the menu item identifier.
See also removeItem(), changeItem(), setAccel() and connectItem().
Inserts a menu item with the icon icon, the text text and the submenu popup. The icon will be displayed to the left of the text in the item.
The menu item is assigned the identifier id or an automatically generated identifier if id is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application.
The index specifies the position in the menu. The menu item is appended at the end of the list if index is negative.
The popup must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted.
Returns the menu item identifier.
See also removeItem(), changeItem(), setAccel() and connectItem().
Inserts a menu item with the the pixmap pixmap.
The menu item is assigned the identifier id or an automatically generated identifier if id is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application.
The index specifies the position in the menu. The menu item is appended at the end of the list if index is negative.
Returns the menu item identifier.
To look best when being highlighted as menu item, the pixmap should provide a mask (see QPixmap::mask()).
See also removeItem(), changeItem(), setAccel() and connectItem().
Inserts a menu item with the icon icon, the pixmap pixmap The icon will be displayed to the left of the pixmap in the item.
The menu item is assigned the identifier id or an automatically generated identifier if id is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application.
The index specifies the position in the menu. The menu item is appended at the end of the list if index is negative.
Returns the menu item identifier.
See also removeItem(), changeItem(), setAccel() and connectItem().
Inserts a menu item with the pixmap pixmap and the submenu popup.
The menu item is assigned the identifier id or an automatically generated identifier if id is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application.
The index specifies the position in the menu. The menu item is appended at the end of the list if index is negative.
The popup must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted.
Returns the menu item identifier.
See also removeItem(), changeItem(), setAccel() and connectItem().
Inserts a menu item with the icon icon, the pixmap pixmap and the submenu popup. The icon will be displayed to the left of the pixmap in the item.
The menu item is assigned the identifier id or an automatically generated identifier if id is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application.
The index specifies the position in the menu. The menu item is appended at the end of the list if index is negative.
The popup must be deleted by the programmer or by its parent widget. It is not deleted when this menu item is removed or when the menu is deleted.
Returns the menu item identifier.
See also removeItem(), changeItem(), setAccel() and connectItem().
Inserts a menu item that consists of the widget widget.
Ownership of widget is transferred to the popup menu or to the menu bar.
Theoretically, any widget can be inserted into a popup menu. In practice, this only makes sense with certain widgets.
If a widget is not focus-enabled (see QWidget::isFocusEnabled() ), the menu treats it as a separator; this means that the item is not selectable and will never get focus. In this way you can, for example, simply insert a QLabel if you need a popup menu with a title.
If the widget is focus-enabled it will get focus when the user traverses the popup menu with the arrow keys. If the widget does not accept ArrowUp and ArrowDown in its key event handler, the focus will move back to the menu when the respective arrow key is hit one more time. This works with a QLineEdit, for example. If the widget accepts the arrow key itself, it must also provide the possibility to put the focus back on the menu again by calling QWidget::focusNextPrevChild(). Futhermore, if the embedded widget closes the menu when the user made a selection, this can be done safely by calling
if ( isVisible() && parentWidget() && parentWidget()->inherits("QPopupMenu") ) parentWidget()->close();
See also removeItem().
Inserts a custom menu item custom with an icon.
This only works with popup menus. It is not supported for menu bars. Ownership of custom is transferred to the popup menu.
If you want to connect a custom item to a certain slot, use connectItem().
See also connectItem(), removeItem() and QCustomMenuItem.
Inserts a custom menu item custom.
This only works with popup menus. It is not supported for menu bars. Ownership of custom is transferred to the popup menu.
If you want to connect a custom item to a certain slot, use connectItem().
See also connectItem(), removeItem() and QCustomMenuItem.
In a popup menu a separator is rendered as a horizontal line. In a Motif menu bar a separator is spacing, so the rest of the items (normally just "Help") are drawn right-justified. In a Windows menu bar separators are ignored (to comply with the Windows style guide).
Examples: addressbook/mainwindow.cpp, application/application.cpp, mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, scrollview/scrollview.cpp and showimg/showimg.cpp.
See also setItemChecked().
Examples: progress/progress.cpp and showimg/showimg.cpp.
See also setItemEnabled().
If no parameter has been specified for this item with setItemParameter(), the value defaults to id.
See also connectItem(), disconnectItem() and setItemParameter().
Reimplemented in QMenuBar.
Reimplemented in QMenuBar.
See also changeItem(), text() and iconSet().
See also removeItemAt() and clear().
See also removeItem() and clear().
An accelerator key consists of a key code and a combination of the modifiers SHIFT, CTRL, ALT or UNICODE_ACCEL (OR'ed or added). The header file qnamespace.h contains a list of key codes.
Defining an accelerator key generates a text that is added to the menu item; for instance, CTRL + Key_O generates "Ctrl+O". The text is formatted differently for different platforms.
Note that keyboard accelerators in Qt are not application-global, but are bound to a certain top-level window. Accelerators in QPopupMenu items therefore work only for menus that are associated with a certain window. This is true for popup menus that live in a menu bar, for instance; the accelerator will then be installed on the menu bar itself. It also works for stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object.
Example:
QMenuBar *mainMenu = new QMenuBar; QPopupMenu *fileMenu = new QPopupMenu; // file sub menu fileMenu->insertItem( "Open Document", 67 );// add "Open" item fileMenu->setAccel( CTRL + Key_O, 67 ); // Control and O to open fileMenu->insertItem( "Quit", 69 ); // add "Quit" item fileMenu->setAccel( CTRL + ALT + Key_Delete, 69 ); mainMenu->insertItem( "File", fileMenu ); // add the file menu
If you will need to translate accelerators, use QAccel::stringToKey():
fileMenu->setAccel( QAccel::stringToKey(tr("Ctrl+O")), 67 );
You can also specify the accelerator in the insertItem() function.
See also accel(), insertItem(), QAccel and qnamespace.h.
Example: menu/menu.cpp.
If index is out of range, the operation is ignored.
See also idAt().
See also isItemChecked().
Examples: grapher/grapher.cpp, mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, scrollview/scrollview.cpp and showimg/showimg.cpp.
See also isItemEnabled().
Examples: mdi/application.cpp, menu/menu.cpp, progress/progress.cpp and showimg/showimg.cpp.
If any receiver takes an integer parameter, this value is passed.
See also connectItem(), disconnectItem() and itemParameter().
Example: mdi/application.cpp.
See also whatsThis().
Examples: application/application.cpp and mdi/application.cpp.
See also changeItem(), pixmap() and iconSet().
Examples: qdir/qdir.cpp and showimg/showimg.cpp.
Reimplemented in QPopupMenu.
See also setWhatsThis().
Search the documentation, FAQ, qt-interest archive and more (uses
www.trolltech.com):
This file is part of the Qt toolkit, copyright © 1995-2001 Trolltech, all rights reserved.
Copyright © 2001 Trolltech | Trademarks | Qt version 3.0.0-beta1-beta1
|