diff options
Diffstat (limited to 'doc/man/man3/tqaccel.3qt')
| -rw-r--r-- | doc/man/man3/tqaccel.3qt | 86 |
1 files changed, 43 insertions, 43 deletions
diff --git a/doc/man/man3/tqaccel.3qt b/doc/man/man3/tqaccel.3qt index d6ed18ca..07070788 100644 --- a/doc/man/man3/tqaccel.3qt +++ b/doc/man/man3/tqaccel.3qt @@ -1,5 +1,5 @@ '\" t -.TH QAccel 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQAccel 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,22 +7,22 @@ .ad l .nh .SH NAME -QAccel \- Handles keyboard accelerator and shortcut keys +TQAccel \- Handles keyboard accelerator and shortcut keys .SH SYNOPSIS -\fC#include <ntqaccel.h>\fR +\fC#include <tqaccel.h>\fR .PP Inherits TQObject. .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQAccel\fR ( TQWidget * parent, const char * name = 0 )" +.BI "\fBTQAccel\fR ( TQWidget * parent, const char * name = 0 )" .br .ti -1c -.BI "\fBQAccel\fR ( TQWidget * watch, TQObject * parent, const char * name = 0 )" +.BI "\fBTQAccel\fR ( TQWidget * watch, TQObject * parent, const char * name = 0 )" .br .ti -1c -.BI "\fB~QAccel\fR ()" +.BI "\fB~TQAccel\fR ()" .br .ti -1c .BI "bool \fBisEnabled\fR () const" @@ -98,7 +98,7 @@ Inherits TQObject. .br .in -1c .SH DESCRIPTION -The QAccel class handles keyboard accelerator and shortcut keys. +The TQAccel class handles keyboard accelerator and shortcut keys. .PP A keyboard accelerator triggers an action when a certain key combination is pressed. The accelerator handles all keyboard activity for all the children of one top-level widget, so it is not affected by the keyboard focus. .PP @@ -114,7 +114,7 @@ In most cases, you will not need to use this class directly. Use the TQAction cl .br .fi .PP -A QAccel contains a list of accelerator items that can be manipulated using insertItem(), removeItem(), clear(), key() and findKey(). +A TQAccel contains a list of accelerator items that can be manipulated using insertItem(), removeItem(), clear(), key() and findKey(). .PP Each accelerator item consists of an identifier and a QKeySequence. A single key sequence consists of a keyboard code combined with modifiers (SHIFT, CTRL, ALT or UNICODE_ACCEL). For example, \fCCTRL + Key_P\fR could be a shortcut for printing a document. The key codes are listed in ntqnamespace.h. As an alternative, use UNICODE_ACCEL with the unicode code point of the character. For example, \fCUNICODE_ACCEL + 'A'\fR gives the same accelerator as Key_A. .PP @@ -122,7 +122,7 @@ When an accelerator key is pressed, the accelerator sends out the signal activat .PP The activated() signal is \fInot\fR emitted when two or more accelerators match the same key. Instead, the first matching accelerator sends out the activatedAmbiguously() signal. By pressing the key multiple times, users can navigate between all matching accelerators. Some standard controls like TQPushButton and TQCheckBox connect the activatedAmbiguously() signal to the harmless setFocus() slot, whereas activated() is connected to a slot invoking the button's action. Most controls, like TQLabel and TQTabBar, treat activated() and activatedAmbiguously() as equivalent. .PP -Use setEnabled() to enable or disable all the items in an accelerator, or setItemEnabled() to enable or disable individual items. An item is active only when both the QAccel and the item itself are enabled. +Use setEnabled() to enable or disable all the items in an accelerator, or setItemEnabled() to enable or disable individual items. An item is active only when both the TQAccel and the item itself are enabled. .PP The function setWhatsThis() specifies a help text that appears when the user presses an accelerator key in What's This mode. .PP @@ -141,7 +141,7 @@ Example: .PP .nf .br - QAccel *a = new QAccel( myWindow ); // create accels for myWindow + TQAccel *a = new TQAccel( myWindow ); // create accels for myWindow .br a->connectItem( a->insertItem(Key_P+CTRL), // adds Ctrl+P accelerator .br @@ -153,25 +153,25 @@ Example: .PP See also QKeyEvent, TQWidget::keyPressEvent(), TQMenuData::setAccel(), TQButton::accel, TQLabel::setBuddy(), QKeySequence, GUI Design Handbook: Keyboard Shortcuts, and Miscellaneous Classes. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QAccel::QAccel ( TQWidget * parent, const char * name = 0 )" -Constructs a QAccel object called \fIname\fR, with parent \fIparent\fR. The accelerator operates on \fIparent\fR. -.SH "QAccel::QAccel ( TQWidget * watch, TQObject * parent, const char * name = 0 )" -Constructs a QAccel object called \fIname\fR, that operates on \fIwatch\fR, and is a child of \fIparent\fR. +.SH "TQAccel::TQAccel ( TQWidget * parent, const char * name = 0 )" +Constructs a TQAccel object called \fIname\fR, with parent \fIparent\fR. The accelerator operates on \fIparent\fR. +.SH "TQAccel::TQAccel ( TQWidget * watch, TQObject * parent, const char * name = 0 )" +Constructs a TQAccel object called \fIname\fR, that operates on \fIwatch\fR, and is a child of \fIparent\fR. .PP This constructor is not needed for normal application programming. -.SH "QAccel::~QAccel ()" +.SH "TQAccel::~TQAccel ()" Destroys the accelerator object and frees all allocated resources. -.SH "void QAccel::activated ( int id )\fC [signal]\fR" +.SH "void TQAccel::activated ( int id )\fC [signal]\fR" This signal is emitted when an accelerator key is pressed. \fIid\fR is a number that identifies this particular accelerator item. .PP See also activatedAmbiguously(). -.SH "void QAccel::activatedAmbiguously ( int id )\fC [signal]\fR" +.SH "void TQAccel::activatedAmbiguously ( int id )\fC [signal]\fR" This signal is emitted when an accelerator key is pressed. \fIid\fR is a number that identifies this particular accelerator item. .PP See also activated(). -.SH "void QAccel::clear ()" +.SH "void TQAccel::clear ()" Removes all accelerator items. -.SH "bool QAccel::connectItem ( int id, const TQObject * receiver, const char * member )" +.SH "bool TQAccel::connectItem ( int id, const TQObject * receiver, const char * member )" Connects the accelerator item \fIid\fR to the slot \fImember\fR of \fIreceiver\fR. .PP .nf @@ -187,19 +187,19 @@ Normally accelerators are connected to slots which then receive the \fCactivated See also disconnectItem(). .PP Example: t14/gamebrd.cpp. -.SH "uint QAccel::count () const" +.SH "uint TQAccel::count () const" Returns the number of accelerator items in this accelerator. -.SH "bool QAccel::disconnectItem ( int id, const TQObject * receiver, const char * member )" +.SH "bool TQAccel::disconnectItem ( int id, const TQObject * receiver, const char * member )" Disconnects an accelerator item with id \fIid\fR from the function called \fImember\fR in the \fIreceiver\fR object. .PP See also connectItem(). -.SH "bool QAccel::eventFilter ( TQObject *, TQEvent * )\fC [virtual protected]\fR" +.SH "bool TQAccel::eventFilter ( TQObject *, TQEvent * )\fC [virtual protected]\fR" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. serves no purpose anymore .PP Reimplemented from TQObject. -.SH "int QAccel::findKey ( const QKeySequence & key ) const" +.SH "int TQAccel::findKey ( const QKeySequence & key ) const" Returns the identifier of the accelerator item with the key code \fIkey\fR, or -1 if the item cannot be found. -.SH "int QAccel::insertItem ( const QKeySequence & key, int id = -1 )" +.SH "int TQAccel::insertItem ( const QKeySequence & key, int id = -1 )" Inserts an accelerator item and returns the item's identifier. .PP \fIkey\fR is a key code and an optional combination of SHIFT, CTRL and ALT. \fIid\fR is the accelerator item id. @@ -208,7 +208,7 @@ If \fIid\fR is negative, then the item will be assigned a unique negative identi .PP .nf .br - QAccel *a = new QAccel( myWindow ); // create accels for myWindow + TQAccel *a = new TQAccel( myWindow ); // create accels for myWindow .br a->insertItem( CTRL + Key_P, 200 ); // Ctrl+P, e.g. to print document .br @@ -223,39 +223,39 @@ If \fIid\fR is negative, then the item will be assigned a unique negative identi .fi .PP Example: t14/gamebrd.cpp. -.SH "bool QAccel::isEnabled () const" +.SH "bool TQAccel::isEnabled () const" Returns TRUE if the accelerator is enabled; otherwise returns FALSE. .PP See also setEnabled() and isItemEnabled(). -.SH "bool QAccel::isItemEnabled ( int id ) const" +.SH "bool TQAccel::isItemEnabled ( int id ) const" Returns TRUE if the accelerator item with the identifier \fIid\fR is enabled. Returns FALSE if the item is disabled or cannot be found. .PP See also setItemEnabled() and isEnabled(). -.SH "QKeySequence QAccel::key ( int id )" +.SH "QKeySequence TQAccel::key ( int id )" Returns the key sequence of the accelerator item with identifier \fIid\fR, or an invalid key sequence (0) if the id cannot be found. -.SH "TQString QAccel::keyToString ( QKeySequence k )\fC [static]\fR" +.SH "TQString TQAccel::keyToString ( QKeySequence k )\fC [static]\fR" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP -Creates an accelerator string for the key \fIk\fR. For instance CTRL+Key_O gives "Ctrl+O". The "Ctrl" etc. are translated (using TQObject::tr()) in the "QAccel" context. +Creates an accelerator string for the key \fIk\fR. For instance CTRL+Key_O gives "Ctrl+O". The "Ctrl" etc. are translated (using TQObject::tr()) in the "TQAccel" context. .PP The function is superfluous. Cast the QKeySequence \fIk\fR to a TQString for the same effect. -.SH "void QAccel::removeItem ( int id )" +.SH "void TQAccel::removeItem ( int id )" Removes the accelerator item with the identifier \fIid\fR. -.SH "void QAccel::repairEventFilter ()" +.SH "void TQAccel::repairEventFilter ()" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. serves no purpose anymore -.SH "void QAccel::setEnabled ( bool enable )" +.SH "void TQAccel::setEnabled ( bool enable )" Enables the accelerator if \fIenable\fR is TRUE, or disables it if \fIenable\fR is FALSE. .PP -Individual keys can also be enabled or disabled using setItemEnabled(). To work, a key must be an enabled item in an enabled QAccel. +Individual keys can also be enabled or disabled using setItemEnabled(). To work, a key must be an enabled item in an enabled TQAccel. .PP See also isEnabled() and setItemEnabled(). -.SH "void QAccel::setItemEnabled ( int id, bool enable )" +.SH "void TQAccel::setItemEnabled ( int id, bool enable )" Enables the accelerator item with the identifier \fIid\fR if \fIenable\fR is TRUE, and disables item \fIid\fR if \fIenable\fR is FALSE. .PP -To work, an item must be enabled and be in an enabled QAccel. +To work, an item must be enabled and be in an enabled TQAccel. .PP See also isItemEnabled() and isEnabled(). -.SH "void QAccel::setWhatsThis ( int id, const TQString & text )" +.SH "void TQAccel::setWhatsThis ( int id, const TQString & text )" Sets a What's This help text for the accelerator item \fIid\fR to \fItext\fR. .PP The text will be shown when the application is in What's This mode and the user hits the accelerator key. @@ -263,16 +263,16 @@ The text will be shown when the application is in What's This mode and the user To set What's This help on a menu item (with or without an accelerator key), use TQMenuData::setWhatsThis(). .PP See also whatsThis(), TQWhatsThis::inWhatsThisMode(), TQMenuData::setWhatsThis(), and TQAction::whatsThis. -.SH "QKeySequence QAccel::shortcutKey ( const TQString & str )\fC [static]\fR" +.SH "QKeySequence TQAccel::shortcutKey ( const TQString & str )\fC [static]\fR" Returns the shortcut key sequence for \fIstr\fR, or an invalid key sequence (0) if \fIstr\fR has no shortcut sequence. .PP For example, shortcutKey("E&xit") returns ALT+Key_X, shortcutKey("&Quit") returns ALT+Key_Q and shortcutKey("Quit") returns 0. (In code that does not inherit the TQt namespace class, you must write e.g. TQt::ALT+TQt::Key_Q.) .PP We provide a list of common accelerators in English. At the time of writing, Microsoft and Open Group do not appear to have issued equivalent recommendations for other languages. -.SH "QKeySequence QAccel::stringToKey ( const TQString & s )\fC [static]\fR" +.SH "QKeySequence TQAccel::stringToKey ( const TQString & s )\fC [static]\fR" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP -Returns an accelerator code for the string \fIs\fR. For example" Ctrl+O" gives CTRL+UNICODE_ACCEL+'O'. The strings "Ctrl"," Shift", "Alt" are recognized, as well as their translated equivalents in the "QAccel" context (using TQObject::tr()). Returns 0 if \fIs\fR is not recognized. +Returns an accelerator code for the string \fIs\fR. For example" Ctrl+O" gives CTRL+UNICODE_ACCEL+'O'. The strings "Ctrl"," Shift", "Alt" are recognized, as well as their translated equivalents in the "TQAccel" context (using TQObject::tr()). Returns 0 if \fIs\fR is not recognized. .PP This function is typically used with tr(), so that accelerator keys can be replaced in translations: .PP @@ -282,7 +282,7 @@ This function is typically used with tr(), so that accelerator keys can be repla .br file->insertItem( p1, tr("&Open..."), this, TQ_SLOT(open()), .br - QAccel::stringToKey(tr("Ctrl+O", "File|Open")) ); + TQAccel::stringToKey(tr("Ctrl+O", "File|Open")) ); .br .fi .PP @@ -293,13 +293,13 @@ The function is superfluous. Construct a QKeySequence from the string \fIs\fR fo See also TQObject::tr() and Internationalization with Qt. .PP Example: i18n/mywidget.cpp. -.SH "TQString QAccel::whatsThis ( int id ) const" +.SH "TQString TQAccel::whatsThis ( int id ) const" Returns the What's This help text for the specified item \fIid\fR or TQString::null if no text has been specified. .PP See also setWhatsThis(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqaccel.html +.BR http://doc.trolltech.com/tqaccel.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |