NAME¶

QMenuData - Base class for QMenuBar and QPopupMenu

SYNOPSIS¶

#include <qmenudata.h>

Inherited by QMenuBar and QPopupMenu.

DESCRIPTION¶

The QMenuData class is a base class for QMenuBar and QPopupMenu.

QMenuData has an internal list of menu items. A menu item can have a text(), an accelerator, a pixmap(), an iconSet(), a whatsThis() text and a popup menu (unless it is a separator). Menu items may optionally be checked (except for separators).

The menu item sends out an activated() signal when it is chosen and a highlighted() signal when it receives the user input focus.

Menu items are assigned the menu identifier id that is passed in insertItem() or an automatically generated identifier if id is < 0 (the default). The generated identifiers (negative integers) are guaranteed to be unique within the entire application. The identifier is used to access the menu item in other functions.

Menu items can be removed with removeItem() and removeItemAt(), or changed with changeItem(). All menu items can be removed with clear(). Accelerators can be changed or set with setAccel(). Checkable items can be checked or unchecked with setItemChecked(). Items can be enabled or disabled using setItemEnabled() and connected and disconnected with connectItem() and disconnectItem() respectively. By default, newly created menu items are visible. They can be hidden (and shown again) with setItemVisible().

Menu items are stored in a list. Use findItem() to find an item by its list position or by its menu identifier. (See also indexOf() and idAt().)

See also QAccel, QPopupMenu, QAction, and Miscellaneous Classes.

MEMBER FUNCTION DOCUMENTATION¶

QMenuData::QMenuData ()¶

Constructs an empty menu data list.

QMenuData::~QMenuData () [virtual]¶

Removes all menu items and disconnects any signals that have been connected.

QKeySequence QMenuData::accel ( int id ) const¶

Returns the accelerator key that has been defined for the menu item id, or 0 if it has no accelerator key or if there is no such menu item.

See also setAccel(), QAccel, and qnamespace.h.

void QMenuData::activateItemAt ( int index ) [virtual]¶

Activates the menu item at position index.

If the index is invalid (for example, -1), the object itself is deactivated.

void QMenuData::changeItem ( int id, const QString & text )¶

Changes the text of the menu item id to text. If the item has an icon, the icon remains unchanged.

See also text().

void QMenuData::changeItem ( int id, const QPixmap & pixmap )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Changes the pixmap of the menu item id to the pixmap pixmap. If the item has an icon, the icon is unchanged.

See also pixmap().

void QMenuData::changeItem ( int id, const QIconSet & icon, const QString & text )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Changes the iconset and text of the menu item id to the icon and text respectively.

See also pixmap().

void QMenuData::changeItem ( int id, const QIconSet & icon, const QPixmap & pixmap )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Changes the iconset and pixmap of the menu item id to icon and pixmap respectively.

See also pixmap().

void QMenuData::changeItem ( const QString & text, int id )¶

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

Changes the text of the menu item id. If the item has an icon, the icon remains unchanged.

See also text().

void QMenuData::changeItem ( const QPixmap & pixmap, int id )¶

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

Changes the pixmap of the menu item id. If the item has an icon, the icon remains unchanged.

See also pixmap().

void QMenuData::changeItem ( const QIconSet & icon, const QString & text, int id )¶

This function is obsolete. It is provided to keep old source working. We strongly advise against using it in new code.

Changes the icon and text of the menu item id.

See also pixmap().

void QMenuData::clear ()¶

Removes all menu items.

See also removeItem() and removeItemAt().

Examples:

bool QMenuData::connectItem ( int id, const QObject * receiver, const char * member )¶

Connects the menu item with identifier id to receiver's member slot or signal.

The receiver's slot (or signal) is activated when the menu item is activated.

See also disconnectItem() and setItemParameter().

Example: menu/menu.cpp.

uint QMenuData::count () const¶

Returns the number of items in the menu.

bool QMenuData::disconnectItem ( int id, const QObject * receiver, const char * member )¶

Disconnects the receiver's member from the menu item with identifier id.

All connections are removed when the menu data object is destroyed.

See also connectItem() and setItemParameter().

QMenuItem * QMenuData::findItem ( int id ) const¶

Returns the menu item with identifier id, or 0 if there is no item with this identifier.

Note that QMenuItem is an internal class, and that you should not need to call this function. Use the higher level functions like text(), pixmap() and changeItem() to get and modify menu item attributes instead.

See also indexOf().

Example: chart/chartform.cpp.

QMenuItem * QMenuData::findItem ( int id, QMenuData ** parent ) const¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Returns the menu item with identifier id, or 0 if there is no item with this identifier. Changes *parent to point to the parent of the return value.

Note that QMenuItem is an internal class, and that you should not need to call this function. Use the higher level functions like text(), pixmap() and changeItem() to get and modify menu item attributes instead.

See also indexOf().

QIconSet * QMenuData::iconSet ( int id ) const¶

Returns the icon set that has been set for menu item id, or 0 if no icon set has been set.

See also changeItem(), text(), and pixmap().

int QMenuData::idAt ( int index ) const¶

Returns the identifier of the menu item at position index in the internal list, or -1 if index is out of range.

See also setId() and indexOf().

int QMenuData::indexOf ( int id ) const¶

Returns the index of the menu item with identifier id, or -1 if there is no item with this identifier.

See also idAt() and findItem().

Example: scrollview/scrollview.cpp.

int QMenuData::insertItem ( const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )¶

The family of insertItem() functions inserts menu items into a popup menu or a menu bar.

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 into existing menus or pulldown menus into 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 those items.

If you need to translate accelerators, use tr() with the text and accelerator. (For translations use a string key sequence.):

        fileMenu->insertItem( tr("Open"), myView, SLOT(open()),


                              tr("Ctrl+O") );

In the example above, pressing Ctrl+O 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 id specifies the identification number associated with the menu item. Note that only positive values are valid, as a negative value will make Qt select a unique id for the item.

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, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to 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.

Warning: On Mac OS X, items that connect to a slot that are inserted into a menubar will not function as we use the native menubar that knows nothing about signals or slots. Instead insert the items into a popup menu and insert the popup menu into the menubar. This may be fixed in a future Qt version.

Returns the allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and qnamespace.h.

Examples:

int QMenuData::insertItem ( const QIconSet & icon, const QString & text, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with icon icon, text text, accelerator accel, optional id id, and optional index position. The menu item is connected it to the receiver's member slot. The icon will be displayed to the left of the text in the item.

Returns the allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and qnamespace.h.

int QMenuData::insertItem ( const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with pixmap pixmap, accelerator accel, optional id id, and optional index position. The menu item is connected it to the receiver's member slot. The icon will be displayed to the left of the text in the item.

To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()).

Returns the allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, const QObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with icon icon, pixmap pixmap, accelerator accel, optional id id, and optional index position. The icon will be displayed to the left of the pixmap in the item. The item is connected to the member slot in the receiver object.

To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()).

Returns the allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and qnamespace.h.

int QMenuData::insertItem ( const QString & text, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with text text, optional id id, and optional index position.

Returns the allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QString & text, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with icon icon, text text, optional id id, and optional index position. The icon will be displayed to the left of the text in the item.

Returns the allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with text text, submenu popup, optional id id, and optional index position.

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 allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QString & text, QPopupMenu * popup, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with icon icon, text text, submenu popup, optional id id, and optional index position. The icon will be displayed to the left of the text in the item.

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 allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with pixmap pixmap, optional id id, and optional index position.

To look best when being highlighted as a menu item, the pixmap should provide a mask (see QPixmap::mask()).

Returns the allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with icon icon, pixmap pixmap, optional id id, and optional index position. The icon will be displayed to the left of the pixmap in the item.

Returns the allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with pixmap pixmap, submenu popup, optional id id, and optional index position.

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 allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( const QIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item with icon icon, pixmap pixmap submenu popup, optional id id, and optional index position. The icon will be displayed to the left of the pixmap in the item.

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 allocated menu identifier number (id if id >= 0).

See also removeItem(), changeItem(), setAccel(), and connectItem().

int QMenuData::insertItem ( QWidget * widget, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a menu item that consists of the widget widget with optional id id, and optional index position.

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

Returns the allocated menu identifier number (id if id >= 0).

See also removeItem().

int QMenuData::insertItem ( const QIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a custom menu item custom with an icon and with optional id id, and optional index position.

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 slot, use connectItem().

Returns the allocated menu identifier number (id if id >= 0).

See also connectItem(), removeItem(), and QCustomMenuItem.

int QMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )¶

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Inserts a custom menu item custom with optional id id, and optional index position.

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 slot, use connectItem().

Returns the allocated menu identifier number (id if id >= 0).

See also connectItem(), removeItem(), and QCustomMenuItem.

int QMenuData::insertSeparator ( int index = -1 )¶

Inserts a separator at position index, and returns the menu identifier number allocated to it. The separator becomes the last menu item if index is negative.

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

Examples:

bool QMenuData::isItemActive ( int id ) const¶

Returns TRUE if the menu item with the id id is currently active; otherwise returns FALSE.

bool QMenuData::isItemChecked ( int id ) const¶

Returns TRUE if the menu item with the id id has been checked; otherwise returns FALSE.

See also setItemChecked().

Examples:

bool QMenuData::isItemEnabled ( int id ) const¶

Returns TRUE if the item with identifier id is enabled; otherwise returns FALSE

See also setItemEnabled() and isItemVisible().

bool QMenuData::isItemVisible ( int id ) const¶

Returns TRUE if the menu item with the id id is visible; otherwise returns FALSE.

See also setItemVisible().

int QMenuData::itemParameter ( int id ) const¶

Returns the parameter of the activation signal of item id.

If no parameter has been specified for this item with setItemParameter(), the value defaults to id.

See also connectItem(), disconnectItem(), and setItemParameter().

void QMenuData::menuContentsChanged () [virtual protected]¶

Virtual function; notifies subclasses that one or more items have been inserted or removed.

Reimplemented in QMenuBar.

void QMenuData::menuDelPopup ( QPopupMenu * ) [virtual protected]¶

Virtual function; notifies subclasses that a popup menu item has been removed.

void QMenuData::menuInsPopup ( QPopupMenu * ) [virtual protected]¶

Virtual function; notifies subclasses that a popup menu item has been inserted.

void QMenuData::menuStateChanged () [virtual protected]¶

Virtual function; notifies subclasses that one or more items have changed state (enabled/disabled or checked/unchecked).

Reimplemented in QMenuBar.

QPixmap * QMenuData::pixmap ( int id ) const¶

Returns the pixmap that has been set for menu item id, or 0 if no pixmap has been set.

See also changeItem(), text(), and iconSet().

void QMenuData::removeItem ( int id )¶

Removes the menu item that has the identifier id.

See also removeItemAt() and clear().

Example: chart/chartform.cpp.

void QMenuData::removeItemAt ( int index )¶

Removes the menu item at position index.

See also removeItem() and clear().

void QMenuData::setAccel ( const QKeySequence & key, int id )¶

Sets the accelerator key for the menu item id to key.

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 produces a text that is added to the menu item; for instance, CTRL + Key_O produces "Ctrl+O". The text is formatted differently for different platforms.

Note that keyboard accelerators in Qt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to 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 );      // Ctrl+O to open


        fileMenu->insertItem( "Quit", 69 );          // add "Quit" item


        fileMenu->setAccel( CTRL + ALT + Key_Delete, 69 ); // add Alt+Del to quit


        mainMenu->insertItem( "File", fileMenu );    // add the file menu

If you need to translate accelerators, use tr() with a string:

        fileMenu->setAccel( tr("Ctrl+O"), 67 );

You can also specify the accelerator in the insertItem() function. You may prefer to use QAction to associate accelerators with menu items.

See also accel(), insertItem(), QAccel, and QAction.

Example: menu/menu.cpp.

void QMenuData::setId ( int index, int id ) [virtual]¶

Sets the menu identifier of the item at index to id.

If index is out of range, the operation is ignored.

See also idAt().

void QMenuData::setItemChecked ( int id, bool check )¶

If check is TRUE, checks the menu item with id id; otherwise unchecks the menu item with id id. Calls QPopupMenu::setCheckable( TRUE ) if necessary.

See also isItemChecked().

Examples:

void QMenuData::setItemEnabled ( int id, bool enable )¶

If enable is TRUE, enables the menu item with identifier id; otherwise disables the menu item with identifier id.

See also isItemEnabled().

Examples:

bool QMenuData::setItemParameter ( int id, int param )¶

Sets the parameter of the activation signal of item id to param.

If any receiver takes an integer parameter, this value is passed.

See also connectItem(), disconnectItem(), and itemParameter().

Example: mdi/application.cpp.

void QMenuData::setItemVisible ( int id, bool visible )¶

If visible is TRUE, shows the menu item with id id; otherwise hides the menu item with id id.

See also isItemVisible() and isItemEnabled().

void QMenuData::setWhatsThis ( int id, const QString & text )¶

Sets text as What's This help for the menu item with identifier id.

See also whatsThis().

Examples:

QString QMenuData::text ( int id ) const¶

Returns the text that has been set for menu item id, or QString::null if no text has been set.

See also changeItem(), pixmap(), and iconSet().

Examples:

void QMenuData::updateItem ( int id ) [virtual]¶

Virtual function; notifies subclasses about an item with id that has been changed.

Reimplemented in QPopupMenu.

QString QMenuData::whatsThis ( int id ) const¶

Returns the What's This help text for the item with identifier id or QString::null if no text has yet been defined.

See also setWhatsThis().

SEE ALSO¶

http://doc.trolltech.com/qmenudata.html http://www.trolltech.com/faq/tech.html

COPYRIGHT¶

Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

AUTHOR¶

Generated automatically from the source code.

BUGS¶

If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you.

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech.

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qmenudata.3qt) and the Qt version (3.3.8).