diff options
Diffstat (limited to 'doc/man/man3/tqpopupmenu.3qt')
| -rw-r--r-- | doc/man/man3/tqpopupmenu.3qt | 194 |
1 files changed, 97 insertions, 97 deletions
diff --git a/doc/man/man3/tqpopupmenu.3qt b/doc/man/man3/tqpopupmenu.3qt index 82a6acab..f6c5bb47 100644 --- a/doc/man/man3/tqpopupmenu.3qt +++ b/doc/man/man3/tqpopupmenu.3qt @@ -1,5 +1,5 @@ '\" t -.TH QPopupMenu 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQPopupMenu 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,19 +7,19 @@ .ad l .nh .SH NAME -QPopupMenu \- Popup menu widget +TQPopupMenu \- Popup menu widget .SH SYNOPSIS -\fC#include <ntqpopupmenu.h>\fR +\fC#include <tqpopupmenu.h>\fR .PP -Inherits QFrame and QMenuData. +Inherits QFrame and TQMenuData. .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQPopupMenu\fR ( TQWidget * parent = 0, const char * name = 0 )" +.BI "\fBTQPopupMenu\fR ( TQWidget * parent = 0, const char * name = 0 )" .br .ti -1c -.BI "\fB~QPopupMenu\fR ()" +.BI "\fB~TQPopupMenu\fR ()" .br .ti -1c .BI "void \fBpopup\fR ( const QPoint & pos, int indexAtPoint = -1 )" @@ -88,10 +88,10 @@ Inherits QFrame and QMenuData. .BI "int \fBinsertItem\fR ( const TQIconSet & icon, const TQString & text, int id = -1, int index = -1 )" .br .ti -1c -.BI "int \fBinsertItem\fR ( const TQString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.BI "int \fBinsertItem\fR ( const TQString & text, TQPopupMenu * popup, int id = -1, int index = -1 )" .br .ti -1c -.BI "int \fBinsertItem\fR ( const TQIconSet & icon, const TQString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.BI "int \fBinsertItem\fR ( const TQIconSet & icon, const TQString & text, TQPopupMenu * popup, int id = -1, int index = -1 )" .br .ti -1c .BI "int \fBinsertItem\fR ( const QPixmap & pixmap, int id = -1, int index = -1 )" @@ -100,10 +100,10 @@ Inherits QFrame and QMenuData. .BI "int \fBinsertItem\fR ( const TQIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" .br .ti -1c -.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.BI "int \fBinsertItem\fR ( const QPixmap & pixmap, TQPopupMenu * popup, int id = -1, int index = -1 )" .br .ti -1c -.BI "int \fBinsertItem\fR ( const TQIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.BI "int \fBinsertItem\fR ( const TQIconSet & icon, const QPixmap & pixmap, TQPopupMenu * popup, int id = -1, int index = -1 )" .br .ti -1c .BI "int \fBinsertItem\fR ( TQWidget * widget, int id = -1, int index = -1 )" @@ -202,10 +202,10 @@ Inherits QFrame and QMenuData. .BI "int \fBitemHeight\fR ( int row ) const" .br .ti -1c -.BI "int \fBitemHeight\fR ( QMenuItem * mi ) const" +.BI "int \fBitemHeight\fR ( TQMenuItem * mi ) const" .br .ti -1c -.BI "void \fBdrawItem\fR ( QPainter * p, int tab_, QMenuItem * mi, bool act, int x, int y, int w, int h )" +.BI "void \fBdrawItem\fR ( QPainter * p, int tab_, TQMenuItem * mi, bool act, int x, int y, int w, int h )" .br .ti -1c .BI "virtual void \fBdrawContents\fR ( QPainter * p )" @@ -215,15 +215,15 @@ Inherits QFrame and QMenuData. .br .in -1c .SH DESCRIPTION -The QPopupMenu class provides a popup menu widget. +The TQPopupMenu class provides a popup menu widget. .PP -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 QMenuBar::insertItem() to insert a popup menu into a menu bar. Show a context menu either asynchronously with popup() or synchronously with exec(). +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 TQMenuBar::insertItem() to insert a popup menu into a menu bar. Show a context menu either asynchronously with popup() or synchronously with exec(). .PP Technically, a popup menu consists of a list of menu items. You add items with insertItem(). An item is either a string, a pixmap or a custom item that provides its own drawing function (see QCustomMenuItem). In addition, items can have an optional icon drawn on the very left side and an accelerator key such as" Ctrl+X". .PP -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 insertSeparator(). For submenus, you pass a pointer to a QPopupMenu in your call to insertItem(). All other items are considered action items. +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 insertSeparator(). For submenus, you pass a pointer to a TQPopupMenu in your call to insertItem(). All other items are considered action items. .PP -When inserting action items you usually specify a receiver and a slot. The receiver will be notifed whenever the item is selected. In addition, QPopupMenu provides two signals, activated() and highlighted(), 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 setItemParameter() to associate a unique value with each item. +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, activated() and highlighted(), 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 setItemParameter() to associate a unique value with each item. .PP You clear a popup menu with clear() and remove single items with removeItem() or removeItemAt(). .PP @@ -235,9 +235,9 @@ You can provide What's This? help for single menu items with setWhatsThis(). See .PP For ultimate flexibility, you can also add entire widgets as items into a popup menu (for example, a color selector). .PP -A QPopupMenu 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 insertTearOffHandle(). 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 QToolBar instead. Tear-off menus cannot contain custom widgets; if the original menu contains a custom widget item, this item is omitted. +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 insertTearOffHandle(). 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 TQToolBar instead. Tear-off menus cannot contain custom widgets; if the original menu contains a custom widget item, this item is omitted. .PP -menu/menu.cpp is an example of QMenuBar and QPopupMenu use. +menu/menu.cpp is an example of TQMenuBar and TQPopupMenu use. .PP .ce 1 .B "[Image Omitted]" @@ -246,75 +246,75 @@ menu/menu.cpp is an example of QMenuBar and QPopupMenu use. .ce 1 .B "[Image Omitted]" .PP -See also QMenuBar, GUI Design Handbook: Menu, Drop-Down and Pop-Up, Main Window and Related Classes, and Basic Widgets. +See also TQMenuBar, GUI Design Handbook: Menu, Drop-Down and Pop-Up, Main Window and Related Classes, and Basic Widgets. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QPopupMenu::QPopupMenu ( TQWidget * parent = 0, const char * name = 0 )" +.SH "TQPopupMenu::TQPopupMenu ( TQWidget * parent = 0, const char * name = 0 )" Constructs a popup menu called \fIname\fR with parent \fIparent\fR. .PP 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 TQObject). -.SH "QPopupMenu::~QPopupMenu ()" +.SH "TQPopupMenu::~TQPopupMenu ()" Destroys the popup menu. -.SH "void QPopupMenu::aboutToHide ()\fC [signal]\fR" +.SH "void TQPopupMenu::aboutToHide ()\fC [signal]\fR" This signal is emitted just before the popup menu is hidden after it has been displayed. .PP \fBWarning:\fR Do not open a widget in a slot connected to this signal. .PP See also aboutToShow(), setItemEnabled(), setItemChecked(), insertItem(), and removeItem(). -.SH "void QPopupMenu::aboutToShow ()\fC [signal]\fR" +.SH "void TQPopupMenu::aboutToShow ()\fC [signal]\fR" 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). .PP See also aboutToHide(), setItemEnabled(), setItemChecked(), insertItem(), and removeItem(). .PP Example: mdi/application.cpp. -.SH "QKeySequence QMenuData::accel ( int id ) const" +.SH "QKeySequence TQMenuData::accel ( int id ) const" Returns the accelerator key that has been defined for the menu item \fIid\fR, or 0 if it has no accelerator key or if there is no such menu item. .PP See also setAccel(), QAccel, and ntqnamespace.h. -.SH "void QPopupMenu::activated ( int id )\fC [signal]\fR" +.SH "void TQPopupMenu::activated ( int id )\fC [signal]\fR" This signal is emitted when a menu item is selected; \fIid\fR is the id of the selected item. .PP -Normally, you connect each menu item to a single slot using QMenuData::insertItem(), 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. +Normally, you connect each menu item to a single slot using TQMenuData::insertItem(), 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. .PP -See also highlighted() and QMenuData::insertItem(). +See also highlighted() and TQMenuData::insertItem(). .PP Examples: .)l grapher/grapher.cpp, helpviewer/helpwindow.cpp, qdir/qdir.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, and showimg/showimg.cpp. -.SH "void QMenuData::changeItem ( int id, const TQString & text )" +.SH "void TQMenuData::changeItem ( int id, const TQString & text )" Changes the text of the menu item \fIid\fR to \fItext\fR. If the item has an icon, the icon remains unchanged. .PP See also text(). -.SH "void QMenuData::changeItem ( int id, const QPixmap & pixmap )" +.SH "void TQMenuData::changeItem ( int id, const QPixmap & pixmap )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Changes the pixmap of the menu item \fIid\fR to the pixmap \fIpixmap\fR. If the item has an icon, the icon is unchanged. .PP See also pixmap(). -.SH "void QMenuData::changeItem ( int id, const TQIconSet & icon, const TQString & text )" +.SH "void TQMenuData::changeItem ( int id, const TQIconSet & icon, const TQString & text )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Changes the iconset and text of the menu item \fIid\fR to the \fIicon\fR and \fItext\fR respectively. .PP See also pixmap(). -.SH "void QMenuData::changeItem ( int id, const TQIconSet & icon, const QPixmap & pixmap )" +.SH "void TQMenuData::changeItem ( int id, const TQIconSet & icon, const QPixmap & pixmap )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Changes the iconset and pixmap of the menu item \fIid\fR to \fIicon\fR and \fIpixmap\fR respectively. .PP See also pixmap(). -.SH "void QMenuData::clear ()" +.SH "void TQMenuData::clear ()" Removes all menu items. .PP See also removeItem() and removeItemAt(). .PP Examples: .)l mdi/application.cpp and qwerty/qwerty.cpp. -.SH "int QPopupMenu::columns () const\fC [protected]\fR" +.SH "int TQPopupMenu::columns () const\fC [protected]\fR" 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). .PP This functions returns the number of columns necessary. .PP See also sizeHint. -.SH "bool QMenuData::connectItem ( int id, const TQObject * receiver, const char * member )" +.SH "bool TQMenuData::connectItem ( int id, const TQObject * receiver, const char * member )" Connects the menu item with identifier \fIid\fR to \fIreceiver\fR's \fImember\fR slot or signal. .PP The receiver's slot (or signal) is activated when the menu item is activated. @@ -322,21 +322,21 @@ The receiver's slot (or signal) is activated when the menu item is activated. See also disconnectItem() and setItemParameter(). .PP Example: menu/menu.cpp. -.SH "bool QMenuData::disconnectItem ( int id, const TQObject * receiver, const char * member )" +.SH "bool TQMenuData::disconnectItem ( int id, const TQObject * receiver, const char * member )" Disconnects the \fIreceiver\fR's \fImember\fR from the menu item with identifier \fIid\fR. .PP All connections are removed when the menu data object is destroyed. .PP See also connectItem() and setItemParameter(). -.SH "void QPopupMenu::drawContents ( QPainter * p )\fC [virtual protected]\fR" +.SH "void TQPopupMenu::drawContents ( QPainter * p )\fC [virtual protected]\fR" Draws all menu items using painter \fIp\fR. .PP Reimplemented from QFrame. -.SH "void QPopupMenu::drawItem ( QPainter * p, int tab_, QMenuItem * mi, bool act, int x, int y, int w, int h )\fC [protected]\fR" +.SH "void TQPopupMenu::drawItem ( QPainter * p, int tab_, TQMenuItem * mi, bool act, int x, int y, int w, int h )\fC [protected]\fR" Draws menu item \fImi\fR in the area \fIx\fR, \fIy\fR, \fIw\fR, \fIh\fR, using painter \fIp\fR. The item is drawn active if \fIact\fR is TRUE or drawn inactive if \fIact\fR is FALSE. The rightmost \fItab_\fR pixels are used for accelerator text. .PP See also TQStyle::drawControl(). -.SH "int QPopupMenu::exec ()" +.SH "int TQPopupMenu::exec ()" Executes this popup synchronously. .PP This is equivalent to \fCexec(mapToGlobal(QPoint(0,0)))\fR. In most situations you'll want to specify the position yourself, for example at the current mouse position: @@ -356,7 +356,7 @@ or aligned to a widget: .PP Examples: .)l fileiconview/qfileiconview.cpp, menu/menu.cpp, and scribble/scribble.cpp. -.SH "int QPopupMenu::exec ( const QPoint & pos, int indexAtPoint = 0 )" +.SH "int TQPopupMenu::exec ( const QPoint & pos, int indexAtPoint = 0 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Executes this popup synchronously. @@ -385,25 +385,25 @@ or aligned to a widget: When positioning a popup with exec() or popup(), bear in mind that you cannot rely on the popup menu's current size(). 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 sizeHint(). It calculates the proper size depending on the menu's current contents. .PP See also popup() and sizeHint. -.SH "void QPopupMenu::highlighted ( int id )\fC [signal]\fR" +.SH "void TQPopupMenu::highlighted ( int id )\fC [signal]\fR" This signal is emitted when a menu item is highlighted; \fIid\fR is the id of the highlighted item. .PP -See also activated() and QMenuData::insertItem(). -.SH "TQIconSet * QMenuData::iconSet ( int id ) const" +See also activated() and TQMenuData::insertItem(). +.SH "TQIconSet * TQMenuData::iconSet ( int id ) const" Returns the icon set that has been set for menu item \fIid\fR, or 0 if no icon set has been set. .PP See also changeItem(), text(), and pixmap(). -.SH "int QPopupMenu::idAt ( int index ) const" +.SH "int TQPopupMenu::idAt ( int index ) const" Returns the identifier of the menu item at position \fIindex\fR in the internal list, or -1 if \fIindex\fR is out of range. .PP -See also QMenuData::setId() and QMenuData::indexOf(). +See also TQMenuData::setId() and TQMenuData::indexOf(). .PP Example: scrollview/scrollview.cpp. -.SH "int QPopupMenu::idAt ( const QPoint & pos ) const" +.SH "int TQPopupMenu::idAt ( const QPoint & pos ) const" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Returns the id of the item at \fIpos\fR, or -1 if there is no item there or if it is a separator. -.SH "int QMenuData::insertItem ( const TQString & text, const TQObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQString & text, const TQObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" The family of insertItem() functions inserts menu items into a popup menu or a menu bar. .PP A menu item is usually either a text string or a pixmap, both with an optional icon or keyboard accelerator. For special cases it is also possible to insert custom items (see QCustomMenuItem) or even widgets into popup menus. @@ -418,9 +418,9 @@ Example: .PP .nf .br - QMenuBar *mainMenu = new QMenuBar; + TQMenuBar *mainMenu = new TQMenuBar; .br - QPopupMenu *fileMenu = new QPopupMenu; + TQPopupMenu *fileMenu = new TQPopupMenu; .br fileMenu->insertItem( "New", myView, TQ_SLOT(newFile()), CTRL+Key_N ); .br @@ -450,7 +450,7 @@ The \fIid\fR specifies the identification number associated with the menu item. .PP The \fIindex\fR specifies the position in the menu. The menu item is appended at the end of the list if \fIindex\fR is negative. .PP -Note that keyboard accelerators in TQt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. +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 parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. .PP \fBWarning:\fR Be careful when passing a literal 0 to insertItem() because some C++ compilers choose the wrong overloaded function. Cast the 0 to what you mean, e.g. \fC(TQObject*)0\fR. .PP @@ -462,7 +462,7 @@ See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqn .PP Examples: .)l addressbook/mainwindow.cpp, canvas/canvas.cpp, menu/menu.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. -.SH "int QMenuData::insertItem ( const TQIconSet & icon, const TQString & text, const TQObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQIconSet & icon, const TQString & text, const TQObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with icon \fIicon\fR, text \fItext\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. @@ -470,7 +470,7 @@ Inserts a menu item with icon \fIicon\fR, text \fItext\fR, accelerator \fIaccel\ Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, const TQObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const QPixmap & pixmap, const TQObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The menu item is connected it to the \fIreceiver\fR's \fImember\fR slot. The icon will be displayed to the left of the text in the item. @@ -480,7 +480,7 @@ To look best when being highlighted as a menu item, the pixmap should provide a Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const TQIconSet & icon, const QPixmap & pixmap, const TQObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQIconSet & icon, const QPixmap & pixmap, const TQObject * receiver, const char * member, const QKeySequence & accel = 0, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, accelerator \fIaccel\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. The item is connected to the \fImember\fR slot in the \fIreceiver\fR object. @@ -490,7 +490,7 @@ To look best when being highlighted as a menu item, the pixmap should provide a Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), connectItem(), QAccel, and ntqnamespace.h. -.SH "int QMenuData::insertItem ( const TQString & text, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQString & text, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. @@ -498,7 +498,7 @@ Inserts a menu item with text \fItext\fR, optional id \fIid\fR, and optional \fI Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const TQIconSet & icon, const TQString & text, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQIconSet & icon, const TQString & text, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with icon \fIicon\fR, text \fItext\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. @@ -506,7 +506,7 @@ Inserts a menu item with icon \fIicon\fR, text \fItext\fR, optional id \fIid\fR, Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const TQString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQString & text, TQPopupMenu * popup, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. @@ -516,7 +516,7 @@ The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const TQIconSet & icon, const TQString & text, QPopupMenu * popup, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQIconSet & icon, const TQString & text, TQPopupMenu * popup, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with icon \fIicon\fR, text \fItext\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the text in the item. @@ -526,7 +526,7 @@ The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const QPixmap & pixmap, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. @@ -536,7 +536,7 @@ To look best when being highlighted as a menu item, the pixmap should provide a Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const TQIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQIconSet & icon, const QPixmap & pixmap, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. @@ -544,7 +544,7 @@ Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR, optional id \fIid Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const QPixmap & pixmap, TQPopupMenu * popup, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with pixmap \fIpixmap\fR, submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. @@ -554,7 +554,7 @@ The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( const TQIconSet & icon, const QPixmap & pixmap, QPopupMenu * popup, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQIconSet & icon, const QPixmap & pixmap, TQPopupMenu * popup, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item with icon \fIicon\fR, pixmap \fIpixmap\fR submenu \fIpopup\fR, optional id \fIid\fR, and optional \fIindex\fR position. The icon will be displayed to the left of the pixmap in the item. @@ -564,7 +564,7 @@ The \fIpopup\fR must be deleted by the programmer or by its parent widget. It is Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(), changeItem(), setAccel(), and connectItem(). -.SH "int QMenuData::insertItem ( TQWidget * widget, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( TQWidget * widget, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a menu item that consists of the widget \fIwidget\fR with optional id \fIid\fR, and optional \fIindex\fR position. @@ -583,7 +583,7 @@ If the widget is focus-enabled it will get focus when the user traverses the pop .br parentWidget() && .br - parentWidget()->inherits("QPopupMenu") ) + parentWidget()->inherits("TQPopupMenu") ) .br parentWidget()->close(); .br @@ -592,7 +592,7 @@ If the widget is focus-enabled it will get focus when the user traverses the pop Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also removeItem(). -.SH "int QMenuData::insertItem ( const TQIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( const TQIconSet & icon, QCustomMenuItem * custom, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a custom menu item \fIcustom\fR with an \fIicon\fR and with optional id \fIid\fR, and optional \fIindex\fR position. @@ -604,7 +604,7 @@ If you want to connect a custom item to a slot, use connectItem(). Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also connectItem(), removeItem(), and QCustomMenuItem. -.SH "int QMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )" +.SH "int TQMenuData::insertItem ( QCustomMenuItem * custom, int id = -1, int index = -1 )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts a custom menu item \fIcustom\fR with optional id \fIid\fR, and optional \fIindex\fR position. @@ -616,14 +616,14 @@ If you want to connect a custom item to a slot, use connectItem(). Returns the allocated menu identifier number (\fIid\fR if \fIid\fR >= 0). .PP See also connectItem(), removeItem(), and QCustomMenuItem. -.SH "int QMenuData::insertSeparator ( int index = -1 )" +.SH "int TQMenuData::insertSeparator ( int index = -1 )" Inserts a separator at position \fIindex\fR, and returns the menu identifier number allocated to it. The separator becomes the last menu item if \fIindex\fR is negative. .PP In a popup menu a separator is rendered as a horizontal line. In a Motif menu bar a separator is spacing, so the rest of the items (normally just "Help") are drawn right-justified. In a Windows menu bar separators are ignored (to comply with the Windows style guidelines). .PP Examples: .)l addressbook/mainwindow.cpp, menu/menu.cpp, progress/progress.cpp, qwerty/qwerty.cpp, scrollview/scrollview.cpp, showimg/showimg.cpp, and sound/sound.cpp. -.SH "int QPopupMenu::insertTearOffHandle ( int id = -1, int index = -1 )" +.SH "int TQPopupMenu::insertTearOffHandle ( int id = -1, int index = -1 )" 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. .PP The handle item is assigned the identifier \fIid\fR or an automatically generated identifier if \fIid\fR is < 0. The generated identifiers (negative integers) are guaranteed to be unique within the entire application. @@ -631,71 +631,71 @@ The handle item is assigned the identifier \fIid\fR or an automatically generate The \fIindex\fR specifies the position in the menu. The tear-off handle is appended at the end of the list if \fIindex\fR is negative. .PP Example: menu/menu.cpp. -.SH "bool QPopupMenu::isCheckable () const" +.SH "bool TQPopupMenu::isCheckable () const" Returns TRUE if the display of check marks on menu items is enabled; otherwise returns FALSE. See the "checkable" property for details. -.SH "bool QMenuData::isItemChecked ( int id ) const" +.SH "bool TQMenuData::isItemChecked ( int id ) const" Returns TRUE if the menu item with the id \fIid\fR has been checked; otherwise returns FALSE. .PP See also setItemChecked(). .PP Examples: .)l canvas/canvas.cpp, progress/progress.cpp, and showimg/showimg.cpp. -.SH "bool QMenuData::isItemEnabled ( int id ) const" +.SH "bool TQMenuData::isItemEnabled ( int id ) const" Returns TRUE if the item with identifier \fIid\fR is enabled; otherwise returns FALSE .PP See also setItemEnabled() and isItemVisible(). -.SH "bool QMenuData::isItemVisible ( int id ) const" +.SH "bool TQMenuData::isItemVisible ( int id ) const" Returns TRUE if the menu item with the id \fIid\fR is visible; otherwise returns FALSE. .PP See also setItemVisible(). -.SH "int QPopupMenu::itemHeight ( int row ) const\fC [protected]\fR" +.SH "int TQPopupMenu::itemHeight ( int row ) const\fC [protected]\fR" Calculates the height in pixels of the item in row \fIrow\fR. -.SH "int QPopupMenu::itemHeight ( QMenuItem * mi ) const\fC [protected]\fR" +.SH "int TQPopupMenu::itemHeight ( TQMenuItem * mi ) const\fC [protected]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Calculates the height in pixels of the menu item \fImi\fR. -.SH "int QMenuData::itemParameter ( int id ) const" +.SH "int TQMenuData::itemParameter ( int id ) const" Returns the parameter of the activation signal of item \fIid\fR. .PP If no parameter has been specified for this item with setItemParameter(), the value defaults to \fIid\fR. .PP See also connectItem(), disconnectItem(), and setItemParameter(). -.SH "QPixmap * QMenuData::pixmap ( int id ) const" +.SH "QPixmap * TQMenuData::pixmap ( int id ) const" Returns the pixmap that has been set for menu item \fIid\fR, or 0 if no pixmap has been set. .PP See also changeItem(), text(), and iconSet(). -.SH "void QPopupMenu::popup ( const QPoint & pos, int indexAtPoint = -1 )" +.SH "void TQPopupMenu::popup ( const QPoint & pos, int indexAtPoint = -1 )" Displays the popup menu so that the item number \fIindexAtPoint\fR will be at the specified \fIglobal\fR position \fIpos\fR. To translate a widget's local coordinates into global coordinates, use TQWidget::mapToGlobal(). .PP When positioning a popup with exec() or popup(), bear in mind that you cannot rely on the popup menu's current size(). 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 sizeHint(). It calculates the proper size depending on the menu's current contents. .PP Example: listviews/listviews.cpp. -.SH "void QMenuData::removeItem ( int id )" +.SH "void TQMenuData::removeItem ( int id )" Removes the menu item that has the identifier \fIid\fR. .PP See also removeItemAt() and clear(). .PP Example: chart/chartform.cpp. -.SH "void QMenuData::removeItemAt ( int index )" +.SH "void TQMenuData::removeItemAt ( int index )" Removes the menu item at position \fIindex\fR. .PP See also removeItem() and clear(). -.SH "void QMenuData::setAccel ( const QKeySequence & key, int id )" +.SH "void TQMenuData::setAccel ( const QKeySequence & key, int id )" Sets the accelerator key for the menu item \fIid\fR to \fIkey\fR. .PP 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 ntqnamespace.h contains a list of key codes. .PP Defining an accelerator key produces a text that is added to the menu item; for instance, CTRL + Key_O produces "Ctrl+O". The text is formatted differently for different platforms. .PP -Note that keyboard accelerators in TQt are not application-global, instead they are bound to a certain top-level window. For example, accelerators in QPopupMenu items only work for menus that are associated with a certain window. This is true for popup menus that live in a menu bar since their accelerators will then be installed in the menu bar itself. This also applies to stand-alone popup menus that have a top-level widget in their parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. +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 parentWidget() chain. The menu will then install its accelerator object on that top-level widget. For all other cases use an independent QAccel object. .PP Example: .PP .nf .br - QMenuBar *mainMenu = new QMenuBar; + TQMenuBar *mainMenu = new TQMenuBar; .br - QPopupMenu *fileMenu = new QPopupMenu; // file sub menu + TQPopupMenu *fileMenu = new TQPopupMenu; // file sub menu .br fileMenu->insertItem( "Open Document", 67 ); // add "Open" item .br @@ -717,30 +717,30 @@ If you need to translate accelerators, use tr() with a string: .br .fi .PP -You can also specify the accelerator in the insertItem() function. You may prefer to use QAction to associate accelerators with menu items. +You can also specify the accelerator in the insertItem() function. You may prefer to use TQAction to associate accelerators with menu items. .PP -See also accel(), insertItem(), QAccel, and QAction. +See also accel(), insertItem(), QAccel, and TQAction. .PP Example: menu/menu.cpp. -.SH "void QPopupMenu::setActiveItem ( int i )\fC [virtual]\fR" +.SH "void TQPopupMenu::setActiveItem ( int i )\fC [virtual]\fR" Sets the currently active item to index \fIi\fR and repaints as necessary. -.SH "void QPopupMenu::setCheckable ( bool )\fC [virtual]\fR" +.SH "void TQPopupMenu::setCheckable ( bool )\fC [virtual]\fR" Sets whether the display of check marks on menu items is enabled. See the "checkable" property for details. -.SH "void QMenuData::setItemChecked ( int id, bool check )" -If \fIcheck\fR is TRUE, checks the menu item with id \fIid\fR; otherwise unchecks the menu item with id \fIid\fR. Calls QPopupMenu::setCheckable( TRUE ) if necessary. +.SH "void TQMenuData::setItemChecked ( int id, bool check )" +If \fIcheck\fR is TRUE, checks the menu item with id \fIid\fR; otherwise unchecks the menu item with id \fIid\fR. Calls TQPopupMenu::setCheckable( TRUE ) if necessary. .PP See also isItemChecked(). .PP Examples: .)l canvas/canvas.cpp, grapher/grapher.cpp, mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, scrollview/scrollview.cpp, and showimg/showimg.cpp. -.SH "void QMenuData::setItemEnabled ( int id, bool enable )" +.SH "void TQMenuData::setItemEnabled ( int id, bool enable )" If \fIenable\fR is TRUE, enables the menu item with identifier \fIid\fR; otherwise disables the menu item with identifier \fIid\fR. .PP See also isItemEnabled(). .PP Examples: .)l mdi/application.cpp, menu/menu.cpp, progress/progress.cpp, and showimg/showimg.cpp. -.SH "bool QMenuData::setItemParameter ( int id, int param )" +.SH "bool TQMenuData::setItemParameter ( int id, int param )" Sets the parameter of the activation signal of item \fIid\fR to \fIparam\fR. .PP If any receiver takes an integer parameter, this value is passed. @@ -748,29 +748,29 @@ If any receiver takes an integer parameter, this value is passed. See also connectItem(), disconnectItem(), and itemParameter(). .PP Example: mdi/application.cpp. -.SH "void QMenuData::setItemVisible ( int id, bool visible )" +.SH "void TQMenuData::setItemVisible ( int id, bool visible )" If \fIvisible\fR is TRUE, shows the menu item with id \fIid\fR; otherwise hides the menu item with id \fIid\fR. .PP See also isItemVisible() and isItemEnabled(). -.SH "void QMenuData::setWhatsThis ( int id, const TQString & text )" +.SH "void TQMenuData::setWhatsThis ( int id, const TQString & text )" Sets \fItext\fR as What's This help for the menu item with identifier \fIid\fR. .PP See also whatsThis(). .PP Examples: .)l application/application.cpp, helpsystem/mainwindow.cpp, and mdi/application.cpp. -.SH "TQString QMenuData::text ( int id ) const" +.SH "TQString TQMenuData::text ( int id ) const" Returns the text that has been set for menu item \fIid\fR, or TQString::null if no text has been set. .PP See also changeItem(), pixmap(), and iconSet(). .PP Examples: .)l qdir/qdir.cpp and showimg/showimg.cpp. -.SH "void QPopupMenu::updateItem ( int id )\fC [virtual]\fR" +.SH "void TQPopupMenu::updateItem ( int id )\fC [virtual]\fR" Updates the item with identity \fIid\fR. .PP -Reimplemented from QMenuData. -.SH "TQString QMenuData::whatsThis ( int id ) const" +Reimplemented from TQMenuData. +.SH "TQString TQMenuData::whatsThis ( int id ) const" Returns the What's This help text for the item with identifier \fIid\fR or TQString::null if no text has yet been defined. .PP See also setWhatsThis(). @@ -780,12 +780,12 @@ This property holds whether the display of check marks on menu items is enabled. .PP When TRUE, the display of check marks on menu items is enabled. Checking is always enabled when in Windows-style. .PP -See also QMenuData::setItemChecked(). +See also TQMenuData::setItemChecked(). .PP Set this property's value with setCheckable() and get this property's value with isCheckable(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqpopupmenu.html +.BR http://doc.trolltech.com/tqpopupmenu.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |