<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt - 3.3.8 - espenr - 2499/qt - x11 - free - 3.3.8/src/widgets/tqpopupmenu.cpp:126 -->
< html >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
< title > TQPopupMenu Class< / title >
< style type = "text/css" > < ! - -
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
-->< / style >
< / head >
< body >
< table border = "0" cellpadding = "0" cellspacing = "0" width = "100%" >
< tr bgcolor = "#E5E5E5" >
< td valign = center >
< a href = "index.html" >
< font color = "#004faf" > Home< / font > < / a >
| < a href = "classes.html" >
< font color = "#004faf" > All Classes< / font > < / a >
| < a href = "mainclasses.html" >
< font color = "#004faf" > Main Classes< / font > < / a >
| < a href = "annotated.html" >
< font color = "#004faf" > Annotated< / font > < / a >
| < a href = "groups.html" >
< font color = "#004faf" > Grouped Classes< / font > < / a >
| < a href = "functions.html" >
< font color = "#004faf" > Functions< / font > < / a >
< / td >
< td align = "right" valign = "center" > < img src = "logo32.png" align = "right" width = "64" height = "32" border = "0" > < / td > < / tr > < / table > < h1 align = center > TQPopupMenu Class Reference< / h1 >
< p > The TQPopupMenu class provides a popup menu widget.
< a href = "#details" > More...< / a >
< p > < tt > #include < < a href = "tqpopupmenu-h.html" > tqpopupmenu.h< / a > > < / tt >
< p > Inherits < a href = "tqframe.html" > TQFrame< / a > and < a href = "tqmenudata.html" > TQMenuData< / a > .
< p > < a href = "tqpopupmenu-members.html" > List of all member functions.< / a >
< h2 > Public Members< / h2 >
< ul >
< li class = fn > < a href = "#TQPopupMenu" > < b > TQPopupMenu< / b > < / a > ( TQWidget * parent = 0, const char * name = 0 )< / li >
< li class = fn > < a href = "#~TQPopupMenu" > < b > ~TQPopupMenu< / b > < / a > ()< / li >
< li class = fn > void < a href = "#popup" > < b > popup< / b > < / a > ( const TQPoint & pos, int indexAtPoint = -1 )< / li >
< li class = fn > virtual void < a href = "#updateItem" > < b > updateItem< / b > < / a > ( int id )< / li >
< li class = fn > virtual void < a href = "#setCheckable" > < b > setCheckable< / b > < / a > ( bool )< / li >
< li class = fn > bool < a href = "#isCheckable" > < b > isCheckable< / b > < / a > () const< / li >
< li class = fn > int < a href = "#exec" > < b > exec< / b > < / a > ()< / li >
< li class = fn > int < a href = "#exec-2" > < b > exec< / b > < / a > ( const TQPoint & pos, int indexAtPoint = 0 )< / li >
< li class = fn > virtual void < a href = "#setActiveItem" > < b > setActiveItem< / b > < / a > ( int i )< / li >
< li class = fn > int < a href = "#idAt" > < b > idAt< / b > < / a > ( int index ) const< / li >
< li class = fn > int < a href = "#idAt-2" > < b > idAt< / b > < / a > ( const TQPoint & pos ) const< / li >
< li class = fn > int < a href = "#insertTearOffHandle" > < b > insertTearOffHandle< / b > < / a > ( int id = -1, int index = -1 )< / li >
< / ul >
< h2 > Signals< / h2 >
< ul >
< li class = fn > void < a href = "#activated" > < b > activated< / b > < / a > ( int id )< / li >
< li class = fn > void < a href = "#highlighted" > < b > highlighted< / b > < / a > ( int id )< / li >
< li class = fn > void < a href = "#aboutToShow" > < b > aboutToShow< / b > < / a > ()< / li >
< li class = fn > void < a href = "#aboutToHide" > < b > aboutToHide< / b > < / a > ()< / li >
< / ul >
< h2 > Important Inherited Members< / h2 >
< ul >
< li class = fn > int < a href = "#insertItem" > < b > insertItem< / b > < / a > ( const TQString & text, const TQObject * receiver, const char * member, const TQKeySequence & accel = 0, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-2" > < b > insertItem< / b > < / a > ( const TQIconSet & icon, const TQString & text, const TQObject * receiver, const char * member, const TQKeySequence & accel = 0, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-3" > < b > insertItem< / b > < / a > ( const TQPixmap & pixmap, const TQObject * receiver, const char * member, const TQKeySequence & accel = 0, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-4" > < b > insertItem< / b > < / a > ( const TQIconSet & icon, const TQPixmap & pixmap, const TQObject * receiver, const char * member, const TQKeySequence & accel = 0, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-5" > < b > insertItem< / b > < / a > ( const TQString & text, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-6" > < b > insertItem< / b > < / a > ( const TQIconSet & icon, const TQString & text, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-7" > < b > insertItem< / b > < / a > ( const TQString & text, TQPopupMenu * popup, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-8" > < b > insertItem< / b > < / a > ( const TQIconSet & icon, const TQString & text, TQPopupMenu * popup, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-9" > < b > insertItem< / b > < / a > ( const TQPixmap & pixmap, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-a" > < b > insertItem< / b > < / a > ( const TQIconSet & icon, const TQPixmap & pixmap, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-b" > < b > insertItem< / b > < / a > ( const TQPixmap & pixmap, TQPopupMenu * popup, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-c" > < b > insertItem< / b > < / a > ( const TQIconSet & icon, const TQPixmap & pixmap, TQPopupMenu * popup, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-d" > < b > insertItem< / b > < / a > ( TQWidget * widget, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-e" > < b > insertItem< / b > < / a > ( const TQIconSet & icon, TQCustomMenuItem * custom, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertItem-f" > < b > insertItem< / b > < / a > ( TQCustomMenuItem * custom, int id = -1, int index = -1 )< / li >
< li class = fn > int < a href = "#insertSeparator" > < b > insertSeparator< / b > < / a > ( int index = -1 )< / li >
< li class = fn > void < a href = "#removeItem" > < b > removeItem< / b > < / a > ( int id )< / li >
< li class = fn > void < a href = "#removeItemAt" > < b > removeItemAt< / b > < / a > ( int index )< / li >
< li class = fn > void < a href = "#clear" > < b > clear< / b > < / a > ()< / li >
< li class = fn > TQKeySequence < a href = "#accel" > < b > accel< / b > < / a > ( int id ) const< / li >
< li class = fn > void < a href = "#setAccel" > < b > setAccel< / b > < / a > ( const TQKeySequence & key, int id )< / li >
< li class = fn > TQIconSet * < a href = "#iconSet" > < b > iconSet< / b > < / a > ( int id ) const< / li >
< li class = fn > TQString < a href = "#text" > < b > text< / b > < / a > ( int id ) const< / li >
< li class = fn > TQPixmap * < a href = "#pixmap" > < b > pixmap< / b > < / a > ( int id ) const< / li >
< li class = fn > void < a href = "#setWhatsThis" > < b > setWhatsThis< / b > < / a > ( int id, const TQString & text )< / li >
< li class = fn > TQString < a href = "#whatsThis" > < b > whatsThis< / b > < / a > ( int id ) const< / li >
< li class = fn > void < a href = "#changeItem" > < b > changeItem< / b > < / a > ( int id, const TQString & text )< / li >
< li class = fn > void < a href = "#changeItem-2" > < b > changeItem< / b > < / a > ( int id, const TQPixmap & pixmap )< / li >
< li class = fn > void < a href = "#changeItem-3" > < b > changeItem< / b > < / a > ( int id, const TQIconSet & icon, const TQString & text )< / li >
< li class = fn > void < a href = "#changeItem-4" > < b > changeItem< / b > < / a > ( int id, const TQIconSet & icon, const TQPixmap & pixmap )< / li >
< li class = fn > bool < a href = "#isItemEnabled" > < b > isItemEnabled< / b > < / a > ( int id ) const< / li >
< li class = fn > void < a href = "#setItemEnabled" > < b > setItemEnabled< / b > < / a > ( int id, bool enable )< / li >
< li class = fn > bool < a href = "#isItemChecked" > < b > isItemChecked< / b > < / a > ( int id ) const< / li >
< li class = fn > void < a href = "#setItemChecked" > < b > setItemChecked< / b > < / a > ( int id, bool check )< / li >
< li class = fn > bool < a href = "#isItemVisible" > < b > isItemVisible< / b > < / a > ( int id ) const< / li >
< li class = fn > void < a href = "#setItemVisible" > < b > setItemVisible< / b > < / a > ( int id, bool visible )< / li >
< li class = fn > bool < a href = "#connectItem" > < b > connectItem< / b > < / a > ( int id, const TQObject * receiver, const char * member )< / li >
< li class = fn > bool < a href = "#disconnectItem" > < b > disconnectItem< / b > < / a > ( int id, const TQObject * receiver, const char * member )< / li >
< li class = fn > bool < a href = "#setItemParameter" > < b > setItemParameter< / b > < / a > ( int id, int param )< / li >
< li class = fn > int < a href = "#itemParameter" > < b > itemParameter< / b > < / a > ( int id ) const< / li >
< / ul >
< h2 > Properties< / h2 >
< ul >
< li class = fn > bool < a href = "#checkable-prop" > < b > checkable< / b > < / a > - whether the display of check marks on menu items is enabled< / li >
< / ul >
< h2 > Protected Members< / h2 >
< ul >
< li class = fn > int < a href = "#itemHeight" > < b > itemHeight< / b > < / a > ( int row ) const< / li >
< li class = fn > int < a href = "#itemHeight-2" > < b > itemHeight< / b > < / a > ( TQMenuItem * mi ) const< / li >
< li class = fn > void < a href = "#drawItem" > < b > drawItem< / b > < / a > ( TQPainter * p, int tab_, TQMenuItem * mi, bool act, int x, int y, int w, int h )< / li >
< li class = fn > virtual void < a href = "#drawContents" > < b > drawContents< / b > < / a > ( TQPainter * p )< / li >
< li class = fn > int < a href = "#columns" > < b > columns< / b > < / a > () const< / li >
< / ul >
< hr > < a name = "details" > < / a > < h2 > Detailed Description< / h2 >
The TQPopupMenu class provides a popup menu widget.
< p >
< p > A popup menu widget is a selection menu. It can be either a
pull-down menu in a menu bar or a standalone context (popup) 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
< a href = "tqmenudata.html#insertItem" > TQMenuBar::insertItem< / a > () to insert a popup menu into a menu bar.
Show a context menu either asynchronously with < a href = "#popup" > popup< / a > () or
synchronously with < a href = "#exec" > exec< / a > ().
< p > Technically, a popup menu consists of a list of menu items. You
add items with < a href = "tqmenudata.html#insertItem" > insertItem< / a > (). An item is either a string, a pixmap
or a custom item that provides its own drawing function (see
< a href = "tqcustommenuitem.html" > TQCustomMenuItem< / a > ). In addition, items can have an optional icon
drawn on the very left side and an accelerator key such as
"Ctrl+X".
< p > There are three kinds of menu items: separators, menu items that
perform an action and menu items that show a submenu. Separators
are inserted with < a href = "tqmenudata.html#insertSeparator" > insertSeparator< / a > (). For submenus, you pass a
pointer to a TQPopupMenu in your call to insertItem(). All other
items are considered action items.
< p > When inserting action items you usually specify a receiver and a
slot. The receiver will be notifed whenever the item is selected.
In addition, TQPopupMenu provides two signals, < a href = "#activated" > activated< / a > () and
< a href = "#highlighted" > highlighted< / a > (), which signal the identifier of the respective menu
item. It is sometimes practical to connect several items to one
slot. To distinguish between them, specify a slot that takes an
integer argument and use < a href = "tqmenudata.html#setItemParameter" > setItemParameter< / a > () to associate a unique
value with each item.
< p > You clear a popup menu with < a href = "tqmenudata.html#clear" > clear< / a > () and remove single items with
< a href = "tqmenudata.html#removeItem" > removeItem< / a > () or < a href = "tqmenudata.html#removeItemAt" > removeItemAt< / a > ().
< p > A popup menu can display check marks for certain items when
enabled with < a href = "#setCheckable" > setCheckable< / a > (TRUE). You check or uncheck items with
< a href = "tqmenudata.html#setItemChecked" > setItemChecked< / a > ().
< p > Items are either enabled or disabled. You toggle their state with
< a href = "tqmenudata.html#setItemEnabled" > setItemEnabled< / a > (). Just before a popup menu becomes visible, it
emits the < a href = "#aboutToShow" > aboutToShow< / a > () signal. You can use this signal to set the
correct enabled/disabled states of all menu items before the user
sees it. The corresponding < a href = "#aboutToHide" > aboutToHide< / a > () signal is emitted when
the menu hides again.
< p > You can provide What's This? help for single menu items with
< a href = "tqmenudata.html#setWhatsThis" > setWhatsThis< / a > (). See < a href = "tqwhatsthis.html" > TQWhatsThis< / a > for general information about this
kind of lightweight online help.
< p > For ultimate flexibility, you can also add entire widgets as items
into a popup menu (for example, a color selector).
< p > A TQPopupMenu 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
that functionality for a certain menu, insert a tear-off handle
with < a href = "#insertTearOffHandle" > insertTearOffHandle< / a > (). When using tear-off menus, bear in
mind that the concept isn't typically used on Microsoft Windows so
users may not be familiar with it. Consider using a < a href = "tqtoolbar.html" > TQToolBar< / a >
instead. Tear-off menus cannot contain custom widgets; if the
original menu contains a custom widget item, this item is omitted.
< p > < a href = "menu-example.html" > menu/menu.cpp< / a > is an example of
< a href = "tqmenubar.html" > TQMenuBar< / a > and TQPopupMenu use.
< p >
< p > < img src = qpopmenu-m.png > < img src = qpopmenu-w.png >
< p > < p > See also < a href = "tqmenubar.html" > TQMenuBar< / a > , < a href = "guibooks.html#fowler" > GUI Design Handbook: Menu, Drop-Down and
Pop-Up< / a > , < a href = "application.html" > Main Window and Related Classes< / a > , and < a href = "basic.html" > Basic Widgets< / a > .
< hr > < h2 > Member Function Documentation< / h2 >
< h3 class = fn > < a name = "TQPopupMenu" > < / a > TQPopupMenu::TQPopupMenu ( < a href = "tqwidget.html" > TQWidget< / a > * parent = 0, const char * name = 0 )
< / h3 >
Constructs a popup menu called < em > name< / em > with parent < em > parent< / em > .
< p > 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 < a href = "tqobject.html" > TQObject< / a > ).
< h3 class = fn > < a name = "~TQPopupMenu" > < / a > TQPopupMenu::~TQPopupMenu ()
< / h3 >
Destroys the popup menu.
< h3 class = fn > void < a name = "aboutToHide" > < / a > TQPopupMenu::aboutToHide ()< tt > [signal]< / tt >
< / h3 >
< p > This signal is emitted just before the popup menu is hidden after
it has been displayed.
< p > < b > Warning:< / b > Do not open a widget in a slot connected to this signal.
< p > < p > See also < a href = "#aboutToShow" > aboutToShow< / a > (), < a href = "tqmenudata.html#setItemEnabled" > setItemEnabled< / a > (), < a href = "tqmenudata.html#setItemChecked" > setItemChecked< / a > (), < a href = "tqmenudata.html#insertItem" > insertItem< / a > (), and < a href = "tqmenudata.html#removeItem" > removeItem< / a > ().
< h3 class = fn > void < a name = "aboutToShow" > < / a > TQPopupMenu::aboutToShow ()< tt > [signal]< / tt >
< / h3 >
< p > This signal is emitted just before the popup menu is displayed.
You can connect it to any slot that sets up the menu contents
(e.g. to ensure that the right items are enabled).
< p > < p > See also < a href = "#aboutToHide" > aboutToHide< / a > (), < a href = "tqmenudata.html#setItemEnabled" > setItemEnabled< / a > (), < a href = "tqmenudata.html#setItemChecked" > setItemChecked< / a > (), < a href = "tqmenudata.html#insertItem" > insertItem< / a > (), and < a href = "tqmenudata.html#removeItem" > removeItem< / a > ().
< p > Example: < a href = "mdi-example.html#x2048" > mdi/application.cpp< / a > .
< h3 class = fn > < a href = "tqkeysequence.html" > TQKeySequence< / a > < a name = "accel" > < / a > TQMenuData::accel ( int id ) const
< / h3 >
Returns the accelerator key that has been defined for the menu
item < em > id< / em > , or 0 if it has no accelerator key or if there is no
such menu item.
< p > < p > See also < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), < a href = "tqaccel.html" > TQAccel< / a > , and < a href = "qnamespace-h.html" > ntqnamespace.h< / a > .
< h3 class = fn > void < a name = "activated" > < / a > TQPopupMenu::activated ( int id )< tt > [signal]< / tt >
< / h3 >
< p > This signal is emitted when a menu item is selected; < em > id< / em > is the
id of the selected item.
< p > Normally, you connect each menu item to a single slot using
< a href = "tqmenudata.html#insertItem" > TQMenuData::insertItem< / a > (), but sometimes you will want to connect
several items to a single slot (most often if the user selects
from an array). This signal is useful in such cases.
< p > < p > See also < a href = "#highlighted" > highlighted< / a > () and < a href = "tqmenudata.html#insertItem" > TQMenuData::insertItem< / a > ().
< p > Examples: < a href = "grapher-nsplugin-example.html#x2767" > grapher/grapher.cpp< / a > , < a href = "helpviewer-example.html#x1004" > helpviewer/helpwindow.cpp< / a > , < a href = "tqdir-example.html#x1835" > tqdir/tqdir.cpp< / a > , < a href = "qwerty-example.html#x386" > qwerty/qwerty.cpp< / a > , < a href = "scrollview-example.html#x642" > scrollview/scrollview.cpp< / a > , and < a href = "showimg-example.html#x1341" > showimg/showimg.cpp< / a > .
< h3 class = fn > void < a name = "changeItem" > < / a > TQMenuData::changeItem ( int id, const < a href = "tqstring.html" > TQString< / a > & text )
< / h3 >
Changes the text of the menu item < em > id< / em > to < em > text< / em > . If the item
has an icon, the icon remains unchanged.
< p > < p > See also < a href = "tqmenudata.html#text" > text< / a > ().
< h3 class = fn > void < a name = "changeItem-2" > < / a > TQMenuData::changeItem ( int id, const < a href = "tqpixmap.html" > TQPixmap< / a > & pixmap )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Changes the pixmap of the menu item < em > id< / em > to the pixmap < em > pixmap< / em > .
If the item has an icon, the icon is unchanged.
< p > < p > See also < a href = "tqmenudata.html#pixmap" > pixmap< / a > ().
< h3 class = fn > void < a name = "changeItem-3" > < / a > TQMenuData::changeItem ( int id, const < a href = "tqiconset.html" > TQIconSet< / a > & icon, const < a href = "tqstring.html" > TQString< / a > & text )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Changes the iconset and text of the menu item < em > id< / em > to the < em > icon< / em >
and < em > text< / em > respectively.
< p > < p > See also < a href = "tqmenudata.html#pixmap" > pixmap< / a > ().
< h3 class = fn > void < a name = "changeItem-4" > < / a > TQMenuData::changeItem ( int id, const < a href = "tqiconset.html" > TQIconSet< / a > & icon, const < a href = "tqpixmap.html" > TQPixmap< / a > & pixmap )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Changes the iconset and pixmap of the menu item < em > id< / em > to < em > icon< / em >
and < em > pixmap< / em > respectively.
< p > < p > See also < a href = "tqmenudata.html#pixmap" > pixmap< / a > ().
< h3 class = fn > void < a name = "clear" > < / a > TQMenuData::clear ()
< / h3 >
Removes all menu items.
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > () and < a href = "tqmenudata.html#removeItemAt" > removeItemAt< / a > ().
< p > Examples: < a href = "mdi-example.html#x2029" > mdi/application.cpp< / a > and < a href = "qwerty-example.html#x370" > qwerty/qwerty.cpp< / a > .
< h3 class = fn > int < a name = "columns" > < / a > TQPopupMenu::columns () const< tt > [protected]< / tt >
< / h3 >
If a popup 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).
< p > This functions returns the number of columns necessary.
< p > < p > See also < a href = "tqwidget.html#sizeHint-prop" > sizeHint< / a > .
< h3 class = fn > bool < a name = "connectItem" > < / a > TQMenuData::connectItem ( int id, const < a href = "tqobject.html" > TQObject< / a > * receiver, const char * member )
< / h3 >
Connects the menu item with identifier < em > id< / em > to < em > receiver< / em > 's < em > member< / em > slot or signal.
< p > The receiver's slot (or signal) is activated when the menu item is
activated.
< p > < p > See also < a href = "tqmenudata.html#disconnectItem" > disconnectItem< / a > () and < a href = "tqmenudata.html#setItemParameter" > setItemParameter< / a > ().
< p > Example: < a href = "menu-example.html#x1868" > menu/menu.cpp< / a > .
< h3 class = fn > bool < a name = "disconnectItem" > < / a > TQMenuData::disconnectItem ( int id, const < a href = "tqobject.html" > TQObject< / a > * receiver, const char * member )
< / h3 >
Disconnects the < em > receiver< / em > 's < em > member< / em > from the menu item with
identifier < em > id< / em > .
< p > All connections are removed when the menu data object is
destroyed.
< p > < p > See also < a href = "tqmenudata.html#connectItem" > connectItem< / a > () and < a href = "tqmenudata.html#setItemParameter" > setItemParameter< / a > ().
< h3 class = fn > void < a name = "drawContents" > < / a > TQPopupMenu::drawContents ( < a href = "tqpainter.html" > TQPainter< / a > * p )< tt > [virtual protected]< / tt >
< / h3 >
Draws all menu items using painter < em > p< / em > .
< p > Reimplemented from < a href = "tqframe.html#drawContents" > TQFrame< / a > .
< h3 class = fn > void < a name = "drawItem" > < / a > TQPopupMenu::drawItem ( < a href = "tqpainter.html" > TQPainter< / a > * p, int tab_, TQMenuItem * mi, bool act, int x, int y, int w, int h )< tt > [protected]< / tt >
< / h3 >
Draws menu item < em > mi< / em > in the area < em > x< / em > , < em > y< / em > , < em > w< / em > , < em > h< / em > , using
painter < em > p< / em > . The item is drawn active if < em > act< / em > is TRUE or drawn
inactive if < em > act< / em > is FALSE. The rightmost < em > tab_< / em > pixels are used
for accelerator text.
< p > < p > See also < a href = "tqstyle.html#drawControl" > TQStyle::drawControl< / a > ().
< h3 class = fn > int < a name = "exec" > < / a > TQPopupMenu::exec ()
< / h3 >
Executes this popup synchronously.
< p > This is equivalent to < tt > exec(mapToGlobal(TQPoint(0,0)))< / tt > . In most
situations you'll want to specify the position yourself, for
example at the current mouse position:
< pre >
< a href = "#exec" > exec< / a > (TQCursor::< a href = "tqcursor.html#pos" > pos< / a > ());
< / pre >
or aligned to a widget:
< pre >
< a href = "#exec" > exec< / a > (somewidget.mapToGlobal(TQPoint(0,0)));
< / pre >
< p > Examples: < a href = "fileiconview-example.html#x866" > fileiconview/tqfileiconview.cpp< / a > , < a href = "menu-example.html#x1878" > menu/menu.cpp< / a > , and < a href = "scribble-example.html#x923" > scribble/scribble.cpp< / a > .
< h3 class = fn > int < a name = "exec-2" > < / a > TQPopupMenu::exec ( const < a href = "tqpoint.html" > TQPoint< / a > & pos, int indexAtPoint = 0 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Executes this popup synchronously.
< p > Opens the popup menu so that the item number < em > indexAtPoint< / em > will
be at the specified < em > global< / em > position < em > pos< / em > . To translate a
widget's local coordinates into global coordinates, use
< a href = "tqwidget.html#mapToGlobal" > TQWidget::mapToGlobal< / a > ().
< p > The return code is the id of the selected item in either the popup
menu or one of its submenus, or -1 if no item is selected
(normally because the user pressed Esc).
< p > Note that all signals are emitted as usual. If you connect a menu
item to a slot and call the menu's < a href = "#exec" > exec< / a > (), you get the result both
via the signal-slot connection and in the return value of exec().
< p > Common usage is to position the popup at the current mouse
position:
< pre >
< a href = "#exec" > exec< / a > ( TQCursor::< a href = "tqcursor.html#pos" > pos< / a > () );
< / pre >
or aligned to a widget:
< pre >
< a href = "#exec" > exec< / a > ( somewidget.mapToGlobal(TQPoint(0, 0)) );
< / pre >
< p > When positioning a popup with exec() or < a href = "#popup" > popup< / a > (), bear in mind that
you cannot rely on the popup menu's current < a href = "tqwidget.html#size" > size< / a > (). For
performance reasons, the popup adapts its size only when
necessary. So in many cases, the size before and after the show is
different. Instead, use < a href = "tqwidget.html#sizeHint" > sizeHint< / a > (). It calculates the proper size
depending on the menu's current contents.
< p > < p > See also < a href = "#popup" > popup< / a > () and < a href = "tqwidget.html#sizeHint-prop" > sizeHint< / a > .
< h3 class = fn > void < a name = "highlighted" > < / a > TQPopupMenu::highlighted ( int id )< tt > [signal]< / tt >
< / h3 >
< p > This signal is emitted when a menu item is highlighted; < em > id< / em > is
the id of the highlighted item.
< p > < p > See also < a href = "#activated" > activated< / a > () and < a href = "tqmenudata.html#insertItem" > TQMenuData::insertItem< / a > ().
< h3 class = fn > < a href = "tqiconset.html" > TQIconSet< / a > * < a name = "iconSet" > < / a > TQMenuData::iconSet ( int id ) const
< / h3 >
Returns the icon set that has been set for menu item < em > id< / em > , or 0
if no icon set has been set.
< p > < p > See also < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#text" > text< / a > (), and < a href = "tqmenudata.html#pixmap" > pixmap< / a > ().
< h3 class = fn > int < a name = "idAt" > < / a > TQPopupMenu::idAt ( int index ) const
< / h3 >
< p > Returns the identifier of the menu item at position < em > index< / em > in
the internal list, or -1 if < em > index< / em > is out of range.
< p > < p > See also < a href = "tqmenudata.html#setId" > TQMenuData::setId< / a > () and < a href = "tqmenudata.html#indexOf" > TQMenuData::indexOf< / a > ().
< p > Example: < a href = "scrollview-example.html#x643" > scrollview/scrollview.cpp< / a > .
< h3 class = fn > int < a name = "idAt-2" > < / a > TQPopupMenu::idAt ( const < a href = "tqpoint.html" > TQPoint< / a > & pos ) const
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Returns the id of the item at < em > pos< / em > , or -1 if there is no item
there or if it is a separator.
< h3 class = fn > int < a name = "insertItem" > < / a > TQMenuData::insertItem ( const < a href = "tqstring.html" > TQString< / a > & text, const < a href = "tqobject.html" > TQObject< / a > * receiver, const char * member, const < a href = "tqkeysequence.html" > TQKeySequence< / a > & accel = 0, int id = -1, int index = -1 )
< / h3 >
The family of < a href = "tqmenudata.html#insertItem" > insertItem< / a > () functions inserts menu items into a
popup menu or a menu bar.
< p > 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 < a href = "tqcustommenuitem.html" > TQCustomMenuItem< / a > ) or
even widgets into popup menus.
< p > 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.
< p > The number of insert functions may look confusing, but they are
actually quite simple to use.
< p > This default version inserts a menu item with the text < em > text< / em > ,
the accelerator key < em > accel< / em > , an id and an optional index and
connects it to the slot < em > member< / em > in the object < em > receiver< / em > .
< p > Example:
< pre >
< a href = "tqmenubar.html" > TQMenuBar< / a > *mainMenu = new < a href = "tqmenubar.html" > TQMenuBar< / a > ;
TQPopupMenu *fileMenu = new TQPopupMenu;
fileMenu-> < a href = "tqmenudata.html#insertItem" > insertItem< / a > ( "New", myView, TQ_SLOT(newFile()), CTRL+Key_N );
fileMenu-> < a href = "tqmenudata.html#insertItem" > insertItem< / a > ( "Open", myView, TQ_SLOT(open()), CTRL+Key_O );
mainMenu-> < a href = "tqmenudata.html#insertItem" > insertItem< / a > ( "File", fileMenu );
< / pre >
< p > Not all insert functions take an object/slot parameter or an
accelerator key. Use < a href = "tqmenudata.html#connectItem" > connectItem< / a > () and < a href = "tqmenudata.html#setAccel" > setAccel< / a > () on those items.
< p > If you need to translate accelerators, use < a href = "tqobject.html#tr" > tr< / a > () with the text and
accelerator. (For translations use a string < a href = "tqkeysequence.html" > key
sequence< / a > .):
< pre >
fileMenu-> insertItem( < a href = "tqobject.html#tr" > tr< / a > ("Open"), myView, TQ_SLOT(open()),
< a href = "tqobject.html#tr" > tr< / a > ("Ctrl+O") );
< / pre >
< p > In the example above, pressing Ctrl+O or selecting "Open" from the
menu activates the myView->open() function.
< p > Some insert functions take a < a href = "tqiconset.html" > TQIconSet< / a > parameter to specify the
little menu item icon. Note that you can always pass a < a href = "tqpixmap.html" > TQPixmap< / a >
object instead.
< p > The < em > id< / em > specifies the identification number associated with the
menu item. Note that only positive values are valid, as a negative
value will make TQt select a unique id for the item.
< p > The < em > index< / em > specifies the position in the menu. The menu item is
appended at the end of the list if < em > index< / em > is negative.
< p > Note that keyboard accelerators in TQt are not application-global,
instead they are bound to a certain top-level window. For example,
accelerators in TQPopupMenu 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 < a href = "tqwidget.html#parentWidget" > parentWidget< / a > ()
chain. The menu will then install its accelerator object on that
top-level widget. For all other cases use an independent < a href = "tqaccel.html" > TQAccel< / a >
object.
< p > < b > Warning:< / b > Be careful when passing a literal 0 to < a href = "tqmenudata.html#insertItem" > insertItem< / a > ()
because some C++ compilers choose the wrong overloaded function.
Cast the 0 to what you mean, e.g. < tt > (TQObject*)0< / tt > .
< p > < b > Warning:< / b > 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 TQt
version.
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), < a href = "tqmenudata.html#connectItem" > connectItem< / a > (), < a href = "tqaccel.html" > TQAccel< / a > , and < a href = "qnamespace-h.html" > ntqnamespace.h< / a > .
< p > Examples: < a href = "addressbook-example.html#x569" > addressbook/mainwindow.cpp< / a > , < a href = "canvas-example.html#x2936" > canvas/canvas.cpp< / a > , < a href = "menu-example.html#x1869" > menu/menu.cpp< / a > , < a href = "qwerty-example.html#x371" > qwerty/qwerty.cpp< / a > , < a href = "scrollview-example.html#x634" > scrollview/scrollview.cpp< / a > , < a href = "showimg-example.html#x1327" > showimg/showimg.cpp< / a > , and < a href = "sound-example.html#x2810" > sound/sound.cpp< / a > .
< h3 class = fn > int < a name = "insertItem-2" > < / a > TQMenuData::insertItem ( const < a href = "tqiconset.html" > TQIconSet< / a > & icon, const < a href = "tqstring.html" > TQString< / a > & text, const < a href = "tqobject.html" > TQObject< / a > * receiver, const char * member, const < a href = "tqkeysequence.html" > TQKeySequence< / a > & accel = 0, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with icon < em > icon< / em > , text < em > text< / em > , accelerator
< em > accel< / em > , optional id < em > id< / em > , and optional < em > index< / em > position. The
menu item is connected it to the < em > receiver< / em > 's < em > member< / em > slot. The
icon will be displayed to the left of the text in the item.
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), < a href = "tqmenudata.html#connectItem" > connectItem< / a > (), < a href = "tqaccel.html" > TQAccel< / a > , and < a href = "qnamespace-h.html" > ntqnamespace.h< / a > .
< h3 class = fn > int < a name = "insertItem-3" > < / a > TQMenuData::insertItem ( const < a href = "tqpixmap.html" > TQPixmap< / a > & pixmap, const < a href = "tqobject.html" > TQObject< / a > * receiver, const char * member, const < a href = "tqkeysequence.html" > TQKeySequence< / a > & accel = 0, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with pixmap < em > pixmap< / em > , accelerator < em > accel< / em > ,
optional id < em > id< / em > , and optional < em > index< / em > position. The menu item
is connected it to the < em > receiver< / em > 's < em > member< / em > slot. The icon will
be displayed to the left of the text in the item.
< p > To look best when being highlighted as a menu item, the pixmap
should provide a mask (see < a href = "tqpixmap.html#mask" > TQPixmap::mask< / a > ()).
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), and < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< h3 class = fn > int < a name = "insertItem-4" > < / a > TQMenuData::insertItem ( const < a href = "tqiconset.html" > TQIconSet< / a > & icon, const < a href = "tqpixmap.html" > TQPixmap< / a > & pixmap, const < a href = "tqobject.html" > TQObject< / a > * receiver, const char * member, const < a href = "tqkeysequence.html" > TQKeySequence< / a > & accel = 0, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with icon < em > icon< / em > , pixmap < em > pixmap< / em > ,
accelerator < em > accel< / em > , optional id < em > id< / em > , and optional < em > index< / em >
position. The icon will be displayed to the left of the pixmap in
the item. The item is connected to the < em > member< / em > slot in the < em > receiver< / em > object.
< p > To look best when being highlighted as a menu item, the pixmap
should provide a mask (see < a href = "tqpixmap.html#mask" > TQPixmap::mask< / a > ()).
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), < a href = "tqmenudata.html#connectItem" > connectItem< / a > (), < a href = "tqaccel.html" > TQAccel< / a > , and < a href = "qnamespace-h.html" > ntqnamespace.h< / a > .
< h3 class = fn > int < a name = "insertItem-5" > < / a > TQMenuData::insertItem ( const < a href = "tqstring.html" > TQString< / a > & text, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with text < em > text< / em > , optional id < em > id< / em > , and
optional < em > index< / em > position.
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), and < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< h3 class = fn > int < a name = "insertItem-6" > < / a > TQMenuData::insertItem ( const < a href = "tqiconset.html" > TQIconSet< / a > & icon, const < a href = "tqstring.html" > TQString< / a > & text, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with icon < em > icon< / em > , text < em > text< / em > , optional id
< em > id< / em > , and optional < em > index< / em > position. The icon will be displayed
to the left of the text in the item.
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), and < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< h3 class = fn > int < a name = "insertItem-7" > < / a > TQMenuData::insertItem ( const < a href = "tqstring.html" > TQString< / a > & text, < a href = "tqpopupmenu.html" > TQPopupMenu< / a > * popup, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with text < em > text< / em > , submenu < em > popup< / em > , optional
id < em > id< / em > , and optional < em > index< / em > position.
< p > The < em > popup< / em > 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.
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), and < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< h3 class = fn > int < a name = "insertItem-8" > < / a > TQMenuData::insertItem ( const < a href = "tqiconset.html" > TQIconSet< / a > & icon, const < a href = "tqstring.html" > TQString< / a > & text, < a href = "tqpopupmenu.html" > TQPopupMenu< / a > * popup, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with icon < em > icon< / em > , text < em > text< / em > , submenu < em > popup< / em > , optional id < em > id< / em > , and optional < em > index< / em > position. The icon
will be displayed to the left of the text in the item.
< p > The < em > popup< / em > 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.
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), and < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< h3 class = fn > int < a name = "insertItem-9" > < / a > TQMenuData::insertItem ( const < a href = "tqpixmap.html" > TQPixmap< / a > & pixmap, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with pixmap < em > pixmap< / em > , optional id < em > id< / em > , and
optional < em > index< / em > position.
< p > To look best when being highlighted as a menu item, the pixmap
should provide a mask (see < a href = "tqpixmap.html#mask" > TQPixmap::mask< / a > ()).
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), and < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< h3 class = fn > int < a name = "insertItem-a" > < / a > TQMenuData::insertItem ( const < a href = "tqiconset.html" > TQIconSet< / a > & icon, const < a href = "tqpixmap.html" > TQPixmap< / a > & pixmap, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with icon < em > icon< / em > , pixmap < em > pixmap< / em > , optional
id < em > id< / em > , and optional < em > index< / em > position. The icon will be
displayed to the left of the pixmap in the item.
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), and < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< h3 class = fn > int < a name = "insertItem-b" > < / a > TQMenuData::insertItem ( const < a href = "tqpixmap.html" > TQPixmap< / a > & pixmap, < a href = "tqpopupmenu.html" > TQPopupMenu< / a > * popup, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with pixmap < em > pixmap< / em > , submenu < em > popup< / em > ,
optional id < em > id< / em > , and optional < em > index< / em > position.
< p > The < em > popup< / em > 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.
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), and < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< h3 class = fn > int < a name = "insertItem-c" > < / a > TQMenuData::insertItem ( const < a href = "tqiconset.html" > TQIconSet< / a > & icon, const < a href = "tqpixmap.html" > TQPixmap< / a > & pixmap, < a href = "tqpopupmenu.html" > TQPopupMenu< / a > * popup, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item with icon < em > icon< / em > , pixmap < em > pixmap< / em > submenu < em > popup< / em > , optional id < em > id< / em > , and optional < em > index< / em > position. The icon
will be displayed to the left of the pixmap in the item.
< p > The < em > popup< / em > 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.
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#setAccel" > setAccel< / a > (), and < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< h3 class = fn > int < a name = "insertItem-d" > < / a > TQMenuData::insertItem ( < a href = "tqwidget.html" > TQWidget< / a > * widget, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a menu item that consists of the widget < em > widget< / em > with
optional id < em > id< / em > , and optional < em > index< / em > position.
< p > Ownership of < em > widget< / em > is transferred to the popup menu or to the
menu bar.
< p > Theoretically, any widget can be inserted into a popup menu. In
practice, this only makes sense with certain widgets.
< p > If a widget is not focus-enabled (see
< a href = "tqwidget.html#isFocusEnabled" > TQWidget::isFocusEnabled< / a > ()), 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 < a href = "tqlabel.html" > TQLabel< / a > if
you need a popup menu with a title.
< p > 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 < tt > ArrowUp< / tt > and < tt > ArrowDown< / tt > 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 < a href = "tqlineedit.html" > TQLineEdit< / a > , 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
< a href = "tqwidget.html#focusNextPrevChild" > TQWidget::focusNextPrevChild< / a > (). Futhermore, if the embedded widget
closes the menu when the user made a selection, this can be done
safely by calling:
< pre >
if ( < a href = "tqwidget.html#isVisible" > isVisible< / a > () & &
< a href = "tqwidget.html#parentWidget" > parentWidget< / a > () & &
< a href = "tqwidget.html#parentWidget" > parentWidget< / a > ()-> inherits("TQPopupMenu") )
< a href = "tqwidget.html#parentWidget" > parentWidget< / a > ()-> close();
< / pre >
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > ().
< h3 class = fn > int < a name = "insertItem-e" > < / a > TQMenuData::insertItem ( const < a href = "tqiconset.html" > TQIconSet< / a > & icon, < a href = "tqcustommenuitem.html" > TQCustomMenuItem< / a > * custom, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a custom menu item < em > custom< / em > with an < em > icon< / em > and with
optional id < em > id< / em > , and optional < em > index< / em > position.
< p > This only works with popup menus. It is not supported for menu
bars. Ownership of < em > custom< / em > is transferred to the popup menu.
< p > If you want to connect a custom item to a slot, use < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#connectItem" > connectItem< / a > (), < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), and < a href = "tqcustommenuitem.html" > TQCustomMenuItem< / a > .
< h3 class = fn > int < a name = "insertItem-f" > < / a > TQMenuData::insertItem ( < a href = "tqcustommenuitem.html" > TQCustomMenuItem< / a > * custom, int id = -1, int index = -1 )
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Inserts a custom menu item < em > custom< / em > with optional id < em > id< / em > , and
optional < em > index< / em > position.
< p > This only works with popup menus. It is not supported for menu
bars. Ownership of < em > custom< / em > is transferred to the popup menu.
< p > If you want to connect a custom item to a slot, use < a href = "tqmenudata.html#connectItem" > connectItem< / a > ().
< p > Returns the allocated < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a > number (< em > id< / em > if < em > id< / em > >= 0).
< p > < p > See also < a href = "tqmenudata.html#connectItem" > connectItem< / a > (), < a href = "tqmenudata.html#removeItem" > removeItem< / a > (), and < a href = "tqcustommenuitem.html" > TQCustomMenuItem< / a > .
< h3 class = fn > int < a name = "insertSeparator" > < / a > TQMenuData::insertSeparator ( int index = -1 )
< / h3 >
Inserts a separator at position < em > index< / em > , and returns the < a href = "tqmenudata.html#menu-identifier" > menu identifier< / a >
number allocated to it. The separator becomes the last menu item if
< em > index< / em > is negative.
< p > In a popup menu a separator is rendered as a horizontal line. In a
< a href = "motif-extension.html#Motif" > Motif< / a > 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).
< p > Examples: < a href = "addressbook-example.html#x570" > addressbook/mainwindow.cpp< / a > , < a href = "menu-example.html#x1870" > menu/menu.cpp< / a > , < a href = "progress-example.html#x69" > progress/progress.cpp< / a > , < a href = "qwerty-example.html#x372" > qwerty/qwerty.cpp< / a > , < a href = "scrollview-example.html#x635" > scrollview/scrollview.cpp< / a > , < a href = "showimg-example.html#x1328" > showimg/showimg.cpp< / a > , and < a href = "sound-example.html#x2811" > sound/sound.cpp< / a > .
< h3 class = fn > int < a name = "insertTearOffHandle" > < / a > TQPopupMenu::insertTearOffHandle ( int id = -1, int index = -1 )
< / h3 >
Inserts a tear-off handle into the menu. A tear-off handle is a
special menu item that creates a copy of the menu when the menu is
selected. 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.
< p > The handle item is assigned the identifier < em > id< / em > or an
automatically generated identifier if < em > id< / em > is < 0. The generated
identifiers (negative integers) are guaranteed to be unique within
the entire application.
< p > The < em > index< / em > specifies the position in the menu. The tear-off
handle is appended at the end of the list if < em > index< / em > is negative.
< p > Example: < a href = "menu-example.html#x1879" > menu/menu.cpp< / a > .
< h3 class = fn > bool < a name = "isCheckable" > < / a > TQPopupMenu::isCheckable () const
< / h3 > < p > Returns TRUE if the display of check marks on menu items is enabled; otherwise returns FALSE.
See the < a href = "tqpopupmenu.html#checkable-prop" > "checkable"< / a > property for details.
< h3 class = fn > bool < a name = "isItemChecked" > < / a > TQMenuData::isItemChecked ( int id ) const
< / h3 >
Returns TRUE if the menu item with the id < em > id< / em > has been checked;
otherwise returns FALSE.
< p > < p > See also < a href = "tqmenudata.html#setItemChecked" > setItemChecked< / a > ().
< p > Examples: < a href = "canvas-example.html#x2938" > canvas/canvas.cpp< / a > , < a href = "progress-example.html#x70" > progress/progress.cpp< / a > , and < a href = "showimg-example.html#x1329" > showimg/showimg.cpp< / a > .
< h3 class = fn > bool < a name = "isItemEnabled" > < / a > TQMenuData::isItemEnabled ( int id ) const
< / h3 >
Returns TRUE if the item with identifier < em > id< / em > is enabled;
otherwise returns FALSE
< p > < p > See also < a href = "tqmenudata.html#setItemEnabled" > setItemEnabled< / a > () and < a href = "tqmenudata.html#isItemVisible" > isItemVisible< / a > ().
< h3 class = fn > bool < a name = "isItemVisible" > < / a > TQMenuData::isItemVisible ( int id ) const
< / h3 >
Returns TRUE if the menu item with the id < em > id< / em > is visible;
otherwise returns FALSE.
< p > < p > See also < a href = "tqmenudata.html#setItemVisible" > setItemVisible< / a > ().
< h3 class = fn > int < a name = "itemHeight" > < / a > TQPopupMenu::itemHeight ( int row ) const< tt > [protected]< / tt >
< / h3 >
Calculates the height in pixels of the item in row < em > row< / em > .
< h3 class = fn > int < a name = "itemHeight-2" > < / a > TQPopupMenu::itemHeight ( TQMenuItem * mi ) const< tt > [protected]< / tt >
< / h3 >
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
< p > Calculates the height in pixels of the menu item < em > mi< / em > .
< h3 class = fn > int < a name = "itemParameter" > < / a > TQMenuData::itemParameter ( int id ) const
< / h3 >
Returns the parameter of the activation signal of item < em > id< / em > .
< p > If no parameter has been specified for this item with
< a href = "tqmenudata.html#setItemParameter" > setItemParameter< / a > (), the value defaults to < em > id< / em > .
< p > < p > See also < a href = "tqmenudata.html#connectItem" > connectItem< / a > (), < a href = "tqmenudata.html#disconnectItem" > disconnectItem< / a > (), and < a href = "tqmenudata.html#setItemParameter" > setItemParameter< / a > ().
< h3 class = fn > < a href = "tqpixmap.html" > TQPixmap< / a > * < a name = "pixmap" > < / a > TQMenuData::pixmap ( int id ) const
< / h3 >
Returns the pixmap that has been set for menu item < em > id< / em > , or 0 if
no pixmap has been set.
< p > < p > See also < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#text" > text< / a > (), and < a href = "tqmenudata.html#iconSet" > iconSet< / a > ().
< h3 class = fn > void < a name = "popup" > < / a > TQPopupMenu::popup ( const < a href = "tqpoint.html" > TQPoint< / a > & pos, int indexAtPoint = -1 )
< / h3 >
Displays the popup menu so that the item number < em > indexAtPoint< / em >
will be at the specified < em > global< / em > position < em > pos< / em > . To translate a
widget's local coordinates into global coordinates, use
< a href = "tqwidget.html#mapToGlobal" > TQWidget::mapToGlobal< / a > ().
< p > When positioning a popup with < a href = "#exec" > exec< / a > () or < a href = "#popup" > popup< / a > (), bear in mind that
you cannot rely on the popup menu's current < a href = "tqwidget.html#size" > size< / a > (). For
performance reasons, the popup adapts its size only when
necessary, so in many cases, the size before and after the show is
different. Instead, use < a href = "tqwidget.html#sizeHint" > sizeHint< / a > (). It calculates the proper size
depending on the menu's current contents.
< p > Example: < a href = "listviews-example.html#x159" > listviews/listviews.cpp< / a > .
< h3 class = fn > void < a name = "removeItem" > < / a > TQMenuData::removeItem ( int id )
< / h3 >
< p > Removes the menu item that has the identifier < em > id< / em > .
< p > < p > See also < a href = "tqmenudata.html#removeItemAt" > removeItemAt< / a > () and < a href = "tqmenudata.html#clear" > clear< / a > ().
< p > Example: < a href = "canvas-chart-example.html#x2885" > chart/chartform.cpp< / a > .
< h3 class = fn > void < a name = "removeItemAt" > < / a > TQMenuData::removeItemAt ( int index )
< / h3 >
Removes the menu item at position < em > index< / em > .
< p > < p > See also < a href = "tqmenudata.html#removeItem" > removeItem< / a > () and < a href = "tqmenudata.html#clear" > clear< / a > ().
< h3 class = fn > void < a name = "setAccel" > < / a > TQMenuData::setAccel ( const < a href = "tqkeysequence.html" > TQKeySequence< / a > & key, int id )
< / h3 >
Sets the accelerator key for the menu item < em > id< / em > to < em > key< / em > .
< p > An accelerator key consists of a key code and a combination of the
modifiers < a href = "ntqt.html#Modifier-enum" > SHIFT< / a > , < a href = "ntqt.html#Modifier-enum" > CTRL< / a > , < a href = "ntqt.html#Modifier-enum" > ALT< / a > or < a href = "ntqt.html#Modifier-enum" > UNICODE_ACCEL< / a > (OR'ed or
added). The header file < a href = "qnamespace-h.html" > ntqnamespace.h< / a > contains a list of key
codes.
< p > Defining an accelerator key produces a text that is added to the
menu item; for instance, < a href = "ntqt.html#Modifier-enum" > CTRL< / a > + < a href = "ntqt.html#Key-enum" > Key_O< / a > produces "Ctrl+O". The
text is formatted differently for different platforms.
< p > Note that keyboard accelerators in TQt are not application-global,
instead they are bound to a certain top-level window. For example,
accelerators in TQPopupMenu 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 < a href = "tqwidget.html#parentWidget" > parentWidget< / a > ()
chain. The menu will then install its accelerator object on that
top-level widget. For all other cases use an independent < a href = "tqaccel.html" > TQAccel< / a >
object.
< p > Example:
< pre >
< a href = "tqmenubar.html" > TQMenuBar< / a > *mainMenu = new < a href = "tqmenubar.html" > TQMenuBar< / a > ;
TQPopupMenu *fileMenu = new TQPopupMenu; // file sub menu
fileMenu-> < a href = "tqmenudata.html#insertItem" > insertItem< / a > ( "Open Document", 67 ); // add "Open" item
fileMenu-> < a href = "tqmenudata.html#setAccel" > setAccel< / a > ( CTRL + Key_O, 67 ); // Ctrl+O to open
fileMenu-> < a href = "tqmenudata.html#insertItem" > insertItem< / a > ( "Quit", 69 ); // add "Quit" item
fileMenu-> < a href = "tqmenudata.html#setAccel" > setAccel< / a > ( CTRL + ALT + Key_Delete, 69 ); // add Alt+Del to quit
mainMenu-> < a href = "tqmenudata.html#insertItem" > insertItem< / a > ( "File", fileMenu ); // add the file menu
< / pre >
< p > If you need to translate accelerators, use < a href = "tqobject.html#tr" > tr< / a > () with a string:
< pre >
fileMenu-> setAccel( < a href = "tqobject.html#tr" > tr< / a > ("Ctrl+O"), 67 );
< / pre >
< p > You can also specify the accelerator in the < a href = "tqmenudata.html#insertItem" > insertItem< / a > () function.
You may prefer to use < a href = "tqaction.html" > TQAction< / a > to associate accelerators with menu
items.
< p > < p > See also < a href = "tqmenudata.html#accel" > accel< / a > (), < a href = "tqmenudata.html#insertItem" > insertItem< / a > (), < a href = "tqaccel.html" > TQAccel< / a > , and < a href = "tqaction.html" > TQAction< / a > .
< p > Example: < a href = "menu-example.html#x1871" > menu/menu.cpp< / a > .
< h3 class = fn > void < a name = "setActiveItem" > < / a > TQPopupMenu::setActiveItem ( int i )< tt > [virtual]< / tt >
< / h3 >
Sets the currently active item to index < em > i< / em > and repaints as necessary.
< h3 class = fn > void < a name = "setCheckable" > < / a > TQPopupMenu::setCheckable ( bool )< tt > [virtual]< / tt >
< / h3 > < p > Sets whether the display of check marks on menu items is enabled.
See the < a href = "tqpopupmenu.html#checkable-prop" > "checkable"< / a > property for details.
< h3 class = fn > void < a name = "setItemChecked" > < / a > TQMenuData::setItemChecked ( int id, bool check )
< / h3 >
If < em > check< / em > is TRUE, checks the menu item with id < em > id< / em > ; otherwise
unchecks the menu item with id < em > id< / em > . Calls
< a href = "#setCheckable" > TQPopupMenu::setCheckable< / a > ( TRUE ) if necessary.
< p > < p > See also < a href = "tqmenudata.html#isItemChecked" > isItemChecked< / a > ().
< p > Examples: < a href = "canvas-example.html#x2939" > canvas/canvas.cpp< / a > , < a href = "grapher-nsplugin-example.html#x2749" > grapher/grapher.cpp< / a > , < a href = "mdi-example.html#x2032" > mdi/application.cpp< / a > , < a href = "menu-example.html#x1872" > menu/menu.cpp< / a > , < a href = "progress-example.html#x71" > progress/progress.cpp< / a > , < a href = "scrollview-example.html#x636" > scrollview/scrollview.cpp< / a > , and < a href = "showimg-example.html#x1330" > showimg/showimg.cpp< / a > .
< h3 class = fn > void < a name = "setItemEnabled" > < / a > TQMenuData::setItemEnabled ( int id, bool enable )
< / h3 >
If < em > enable< / em > is TRUE, enables the menu item with identifier < em > id< / em > ;
otherwise disables the menu item with identifier < em > id< / em > .
< p > < p > See also < a href = "tqmenudata.html#isItemEnabled" > isItemEnabled< / a > ().
< p > Examples: < a href = "mdi-example.html#x2033" > mdi/application.cpp< / a > , < a href = "menu-example.html#x1873" > menu/menu.cpp< / a > , < a href = "progress-example.html#x72" > progress/progress.cpp< / a > , and < a href = "showimg-example.html#x1331" > showimg/showimg.cpp< / a > .
< h3 class = fn > bool < a name = "setItemParameter" > < / a > TQMenuData::setItemParameter ( int id, int param )
< / h3 >
Sets the parameter of the activation signal of item < em > id< / em > to < em > param< / em > .
< p > If any receiver takes an integer parameter, this value is passed.
< p > < p > See also < a href = "tqmenudata.html#connectItem" > connectItem< / a > (), < a href = "tqmenudata.html#disconnectItem" > disconnectItem< / a > (), and < a href = "tqmenudata.html#itemParameter" > itemParameter< / a > ().
< p > Example: < a href = "mdi-example.html#x2034" > mdi/application.cpp< / a > .
< h3 class = fn > void < a name = "setItemVisible" > < / a > TQMenuData::setItemVisible ( int id, bool visible )
< / h3 >
If < em > visible< / em > is TRUE, shows the menu item with id < em > id< / em > ; otherwise
hides the menu item with id < em > id< / em > .
< p > < p > See also < a href = "tqmenudata.html#isItemVisible" > isItemVisible< / a > () and < a href = "tqmenudata.html#isItemEnabled" > isItemEnabled< / a > ().
< h3 class = fn > void < a name = "setWhatsThis" > < / a > TQMenuData::setWhatsThis ( int id, const < a href = "tqstring.html" > TQString< / a > & text )
< / h3 >
Sets < em > text< / em > as What's This help for the menu item with identifier
< em > id< / em > .
< p > < p > See also < a href = "tqmenudata.html#whatsThis" > whatsThis< / a > ().
< p > Examples: < a href = "simple-application-example.html#x1554" > application/application.cpp< / a > , < a href = "helpsystem-example.html#x2689" > helpsystem/mainwindow.cpp< / a > , and < a href = "mdi-example.html#x2035" > mdi/application.cpp< / a > .
< h3 class = fn > < a href = "tqstring.html" > TQString< / a > < a name = "text" > < / a > TQMenuData::text ( int id ) const
< / h3 >
Returns the text that has been set for menu item < em > id< / em > , or
< a href = "tqstring.html#TQString-null" > TQString::null< / a > if no text has been set.
< p > < p > See also < a href = "tqmenudata.html#changeItem" > changeItem< / a > (), < a href = "tqmenudata.html#pixmap" > pixmap< / a > (), and < a href = "tqmenudata.html#iconSet" > iconSet< / a > ().
< p > Examples: < a href = "tqdir-example.html#x1831" > tqdir/tqdir.cpp< / a > and < a href = "showimg-example.html#x1332" > showimg/showimg.cpp< / a > .
< h3 class = fn > void < a name = "updateItem" > < / a > TQPopupMenu::updateItem ( int id )< tt > [virtual]< / tt >
< / h3 >
Updates the item with identity < em > id< / em > .
< p > Reimplemented from < a href = "tqmenudata.html#updateItem" > TQMenuData< / a > .
< h3 class = fn > < a href = "tqstring.html" > TQString< / a > < a name = "whatsThis" > < / a > TQMenuData::whatsThis ( int id ) const
< / h3 >
Returns the What's This help text for the item with identifier < em > id< / em > or < a href = "tqstring.html#TQString-null" > TQString::null< / a > if no text has yet been defined.
< p > < p > See also < a href = "tqmenudata.html#setWhatsThis" > setWhatsThis< / a > ().
< hr > < h2 > Property Documentation< / h2 >
< h3 class = fn > bool < a name = "checkable-prop" > < / a > checkable< / h3 >
< p > This property holds whether the display of check marks on menu items is enabled.
< p > When TRUE, the display of check marks on menu items is enabled.
Checking is always enabled when in Windows-style.
< p > < p > See also < a href = "tqmenudata.html#setItemChecked" > TQMenuData::setItemChecked< / a > ().
< p > Set this property's value with < a href = "#setCheckable" > setCheckable< / a > () and get this property's value with < a href = "#isCheckable" > isCheckable< / a > ().
<!-- eof -->
< hr > < p >
This file is part of the < a href = "index.html" > TQt toolkit< / a > .
Copyright © 1995-2007
< a href = "http://www.trolltech.com/" > Trolltech< / a > . All Rights Reserved.< p > < address > < hr > < div align = center >
< table width = 100% cellspacing = 0 border = 0 > < tr >
< td > Copyright © 2007
< a href = "troll.html" > Trolltech< / a > < td align = center > < a href = "trademarks.html" > Trademarks< / a >
< td align = right > < div align = right > TQt 3.3.8< / div >
< / table > < / div > < / address > < / body >
< / html >
