QMenuData - Base class for
#include <qmenudata.h>
Inherited by QMenuBar and QPopupMenu.
Public Members
QMenuData ()
virtual ~QMenuData ()
uint count () const
int insertItem ( const QString & text, const QObject *
receiver, const char * member, int accel = 0, int id =
-1, int index = -1 )
int insertItem ( const QIconSet & icon, const QString &
text, const QObject * receiver, const char * member,
int accel = 0, int id = -1, int index = -1 )
int insertItem ( const QPixmap & pixmap, const QObject *
receiver, const char * member, int accel = 0, int id =
-1, int index = -1 )
int insertItem ( const QIconSet & icon, const QPixmap &
pixmap, const QObject * receiver, const char * member,
int accel = 0, int id = -1, int index = -1 )
int insertItem ( const QString & text, int id=-1, int
index=-1 )
int insertItem ( const QIconSet & icon, const QString &
text, int id=-1, int index=-1 )
int insertItem ( const QString & text, QPopupMenu * popup,
int id=-1, int index=-1 )
int insertItem ( const QIconSet & icon, const QString &
text, QPopupMenu * popup, int id=-1, int index=-1 )
int insertItem ( const QPixmap & pixmap, int id=-1, int
index=-1 )
int insertItem ( const QIconSet & icon, const QPixmap &
pixmap, int id=-1, int index=-1 )
int insertItem ( const QPixmap & pixmap, QPopupMenu *
popup, int id=-1, int index=-1 )
int insertItem ( const QIconSet & icon, const QPixmap &
pixmap, QPopupMenu * popup, int id=-1, int index=-1 )
int insertItem ( QWidget * widget, int id=-1, int index=-1
)
int insertItem ( const QIconSet & icon, QCustomMenuItem *
custom, int id=-1, int index=-1 )
int insertItem ( QCustomMenuItem * custom, int id=-1, int
index=-1 )
int insertSeparator ( int index=-1 )
void removeItem ( int id )
void removeItemAt ( int index )
void clear ()
int accel ( int id ) const
void setAccel ( int key, int id )
QIconSet* iconSet ( int id ) const
QString text ( int id ) const
void setWhatsThis ( int id, const QString & )
QString whatsThis ( int id ) const
void changeItem ( int id, const QString & text )
void changeItem ( int id, const QPixmap & pixmap )
void changeItem ( int id, const QIconSet & icon, const
QString & text )
void changeItem ( int id, const QIconSet & icon, const
QPixmap & pixmap )
void changeItem ( const QString & text, int id )
(obsolete)
void changeItem ( const QPixmap & pixmap, int id )
(obsolete)
void changeItem ( const QIconSet & icon, const QString &
text, int id ) (obsolete)
bool isItemEnabled ( int id ) const
void setItemEnabled ( int id, bool enable )
bool isItemChecked ( int id ) const
void setItemChecked ( int id, bool check )
virtual void updateItem ( int id )
int indexOf ( int id ) const
int idAt ( int index ) const
virtual void setId ( int index, int id )
bool connectItem ( int id, const QObject * receiver, const
char * member )
bool disconnectItem ( int id, const QObject * receiver,
const char * member )
bool setItemParameter ( int id, int param )
int itemParameter ( int id ) const
QMenuItem* findItem ( int id ) const
QMenuItem* findItem ( int id, QMenuData ** parent ) const
void activateItemAt ( int index )
Protected Members
virtual void menuContentsChanged ()
virtual void menuStateChanged ()
virtual void menuInsPopup ( QPopupMenu * )
virtual void menuDelPopup ( QPopupMenu * )
QMenuItem* findPopup ( QPopupMenu *, int * index = 0 )
DESCRIPTION
The QMenuData class is a base class for QMenuBar and
QPopupMenu.
QMenuData has an internal list of menu items. A menu item
is a text, pixmap or a 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.
MEMBER FUNCTION DOCUMENTATION
QMenuData::QMenuData ()
Constructs an empty list.
QMenuData::~QMenuData () [virtual]
Removes all menu items and disconnects any signals that
have been connected.
int 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.
See also setAccel(), QAccel and qnamespace.h.
void QMenuData::activateItemAt ( int index )
Activates the menu item at index index.
If the index is invalid (for example -1), the object
itself is deactivated.
void QMenuData::changeItem ( const QIconSet & icon, const QString
& text, int id )
This function is obsolete. It is provided to keep old
source working, and will probably be removed in a future
version of Qt. We strongly advise against using it in new
code.
Changes the icon and text of the menu item id.
See also pixmap().
void QMenuData::changeItem ( const QPixmap & pixmap, int id )
This function is obsolete. It is provided to keep old
source working, and will probably be removed in a future
version of Qt. 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 QString & text, int id )
This function is obsolete. It is provided to keep old
source working, and will probably be removed in a future
version of Qt. 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().
QPixmap & pixmap )
Changes the icon and pixmap of the menu item id.
See also pixmap().
void QMenuData::changeItem ( int id, const QIconSet & icon, const
QString & text )
Changes the icon and text of the menu item id.
See also pixmap().
void QMenuData::changeItem ( int id, const QPixmap & pixmap )
Changes the pixmap of the menu item id. If the item has an
icon, the icon remains unchanged.
See also pixmap().
void QMenuData::changeItem ( int id, const QString & text )
Changes the text of the menu item id. If the item has an
icon, the icon remains unchanged.
See also text().
void QMenuData::clear ()
Removes all menu items.
See also removeItem() and removeItemAt().
bool QMenuData::connectItem ( int id, const QObject * receiver,
const char * member )
Connects a menu item to a receiver and a slot or signal.
The receiver's slot/signal is activated when the menu item
is activated.
See also disconnectItem() and setItemParameter().
Examples: 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 a receiver/member from a menu item.
All connections are removed when the menu data object is
destroyed.
See also connectItem() and setItemParameter().
QMenuItem * QMenuData::findItem ( int id ) const
Returns a pointer to the menu item with identifier id, or
See also indexOf().
QMenuItem * QMenuData::findItem ( int id, QMenuData ** parent )
const
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().
QMenuItem * QMenuData::findPopup ( QPopupMenu * popup, int *
index = 0 ) [protected]
Internal function that finds the menu item where popup is
located, storing its index at index if index is not NULL.
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 such an identifier.
See also idAt() and findItem().
Examples: scrollview/scrollview.cpp
int QMenuData::insertItem ( const QString & text, const QObject *
receiver, const char * member, int 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 a pixmap,
both with an optional icon or keyboard accelerator. As
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 additional
argument. Use these to insert submenus to existing menus
or pulldown menus to a menu bar.
The amount of insert functions may look confusing, but is
actually quite handy to use.
accelerator key, an id and an optional index and connects
it to an object/slot.
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 bound to a certain toplevel 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. In that case, the accelerator will be installed
on the menu bar itself. It also works for stand-alone
popup menus that have a toplevel widget in their
parentWidget()- chain. The menu will then install its
accelerator object on that toplevel widget. For all other
cases, use an independent QAccel object.
Warning: Be careful when passing a literal 0 to
insertItem(), as some C++ compilers choose the wrong
overloaded function. Cast the 0 to what you mean, eg.
(QObject*)0.
connectItem(), QAccel and qnamespace.h.
int QMenuData::insertItem ( QCustomMenuItem * custom, int id=-1,
int index=-1 )
This is an overloaded member function, provided for
convenience. It differs from the above function only in
what argument(s) it accepts.
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.
int QMenuData::insertItem ( QWidget * widget, int id=-1, int
index=-1 )
This is an overloaded member function, provided for
convenience. It differs from the above function only in
what argument(s) it accepts.
Inserts a menu item that consists of the widget widget.
Ownership of widget is transferred to the popup menu or
the menubar.
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, the item is not selectable and will
never get focus. 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 the respective arrow key is hit one more time. This
works for example with a QLineEdit. If the widget accepts
the arrow keys itself, it must also provide the
possibility to put the focus back on the menu again by
calling QWidget::focusNextPrevChild() respectively.
Futhermore should the embedded widget close the menu when
the user made a selection. This can be done safely by
calling
parentWidget() &&
parentWidget()->inherits("QPopupMenu") )
parentWidget()->close();
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 differs from the above function only in
what argument(s) it accepts.
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.
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 differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with an icon, a pixmap and a sub menu.
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 menu item identifier.
See also removeItem(), changeItem(), setAccel() and
connectItem().
int QMenuData::insertItem ( const QIconSet & icon, const QPixmap
& pixmap, const QObject * receiver, const char * member,
int accel = 0, int id = -1, int index = -1 )
This is an overloaded member function, provided for
convenience. It differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with an icon, a pixmap, an accelerator
key, an id and an optional index and connects it to an
object/slot. The icon will be displayed to the left of the
pixmap in the item.
pixmap should provide a mask, see QPixmap::mask().
Returns the menu item identifier.
See also removeItem(), changeItem(), setAccel(),
connectItem(), QAccel and qnamespace.h.
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 differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with an icon and a pixmap. The icon
will be displayed to the left of the pixmap in the item.
Returns the menu item identifier.
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 differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with an icon, a text and a sub menu.
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 menu item identifier.
See also removeItem(), changeItem(), setAccel() and
connectItem().
int QMenuData::insertItem ( const QIconSet & icon, const QString
& text, const QObject * receiver, const char * member, int
accel = 0, int id = -1, int index = -1 )
This is an overloaded member function, provided for
convenience. It differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with an icon, a text, an accelerator
key, an id and an optional index and 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.
& text, int id=-1, int index=-1 )
This is an overloaded member function, provided for
convenience. It differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with an icon and a text. The icon will
be displayed to the left of the text in the item. Returns
the menu item identifier.
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 differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with a pixmap and a sub menu. 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 menu item identifier.
See also removeItem(), changeItem(), setAccel() and
connectItem().
int QMenuData::insertItem ( const QPixmap & pixmap, const QObject
* receiver, const char * member, int accel = 0, int id =
-1, int index = -1 )
This is an overloaded member function, provided for
convenience. It differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with a pixmap, an accelerator key, an
id and an optional index and 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().
int QMenuData::insertItem ( const QPixmap & pixmap, int id=-1,
int index=-1 )
This is an overloaded member function, provided for
convenience. It differs from the above function only in
Inserts a menu item with a pixmap. 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().
int QMenuData::insertItem ( const QString & text, QPopupMenu *
popup, int id=-1, int index=-1 )
This is an overloaded member function, provided for
convenience. It differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with a text and a sub menu.
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().
Examples: qtimage/qtimage.cpp grapher/grapher.cpp
mainlyQt/editor.cpp layout/layout.cpp menu/menu.cpp
progress/progress.cpp scrollview/scrollview.cpp
int QMenuData::insertItem ( const QString & text, int id=-1, int
index=-1 )
This is an overloaded member function, provided for
convenience. It differs from the above function only in
what argument(s) it accepts.
Inserts a menu item with a text. Returns the menu item
identifier.
See also removeItem(), changeItem(), setAccel() and
connectItem().
int QMenuData::insertSeparator ( int index=-1 )
Inserts a separator at position index. 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 menubar, a separator is spacing, so the
rest of the items (just "Help", normally) are drawn right-
justified. In a Windows menubar, separators are ignored
(to comply with the Windows style guide).
progress/progress.cpp scrollview/scrollview.cpp
bool QMenuData::isItemChecked ( int id ) const
Returns TRUE if the menu item has been checked, otherwise
FALSE.
See also setItemChecked().
Examples: progress/progress.cpp
bool QMenuData::isItemEnabled ( int id ) const
Returns TRUE if the item with identifier id is enabled or
FALSE if it is disabled.
See also setItemEnabled().
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().
Removes the menu item which has the identifier id.
See also removeItemAt() and clear().
void QMenuData::removeItemAt ( int index )
Removes the menu item at position index.
See also removeItem() and clear().
void QMenuData::setAccel ( int key, int id )
Defines an accelerator key for the menu item id.
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 which 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 bound to a certain toplevel 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. In that case, the accelerator will be installed
on the menu bar itself. It also works for stand-alone
popup menus that have a toplevel widget in their
parentWidget()- chain. The menu will then install its
accelerator object on that toplevel 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.
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 )
Checks the menu item with id id if check is TRUE, or
unchecks it if check is FALSE, and calls
QPopupMenu::setCheckable( TRUE ) if necessary.
See also isItemChecked().
Examples: grapher/grapher.cpp progress/progress.cpp
scrollview/scrollview.cpp
void QMenuData::setItemEnabled ( int id, bool enable )
Enables the menu item with identifier id if enable is
TRUE, or disables the item if enable is FALSE.
See also isItemEnabled().
Examples: menu/menu.cpp progress/progress.cpp
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().
void QMenuData::setWhatsThis ( int id, const QString & text )
Sets a Whats This help for a certain menu item.
Arguments:
id is the menu item id.
text is the Whats This help text in rich text format ( see
QStyleSheet)
See also whatsThis().
QString QMenuData::text ( int id ) const
Returns the text that has been set for menu item id, or a
null string if no text has been set.
See also changeItem(), pixmap() and iconSet().
Virtual function; notifies subclasses about an item that
has been changed.
Reimplemented in QMenuBar and QPopupMenu.
QString QMenuData::whatsThis ( int id ) const
Returns the Whats This help text for the specified item id
or QString::null if no text has been defined yet.
See also setWhatsThis().
SEE ALSO
http://doc.trolltech.com/qmenudata.html
http://www.trolltech.com/faq/tech.html
COPYRIGHT
Copyright 1992-2001 Trolltech AS,
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
make our job much simpler. Thank you.
In case of content or formattting problems with 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 (2.3.1).
Man(1) output converted with
man2html