|
Eneboo - Documentación para desarrolladores
|
|
Eneboo - Documentación para desarrolladores
|
The QAccel class handles keyboard accelerator and shortcut keys. Más...
#include <qaccel.h>
The QAccel class handles keyboard accelerator and shortcut keys.
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.
In most cases, you will not need to use this class directly. Use the QAction class to create actions with accelerators that can be used in both menus and toolbars. If you're only interested in menus use QMenuData::insertItem() or QMenuData::setAccel() to make accelerators for operations that are also available on menus. Many widgets automatically generate accelerators, such as QButton, QGroupBox, QLabel (with QLabel::setBuddy()), QMenuBar and QTabBar. Example:
QPushButton p( "&Exit", parent ); // automatic shortcut ALT+Key_E QPopupMenu *fileMenu = new fileMenu( parent ); fileMenu->insertItem( "Undo", parent, SLOT(undo()), CTRL+Key_Z );
A QAccel contains a list of accelerator items that can be manipulated using insertItem(), removeItem(), clear(), key() and findKey().
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, {CTRL + Key_P} could be a shortcut for printing a document. The key codes are listed in qnamespace.h. As an alternative, use UNICODE_ACCEL with the unicode code point of the character. For example, {UNICODE_ACCEL + 'A'} gives the same accelerator as Key_A.
When an accelerator key is pressed, the accelerator sends out the signal activated() with a number that identifies this particular accelerator item. Accelerator items can also be individually connected, so that two different keys will activate two different slots (see connectItem() and disconnectItem()).
The activated() signal is not 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 QPushButton and QCheckBox connect the activatedAmbiguously() signal to the harmless setFocus() slot, whereas activated() is connected to a slot invoking the button's action. Most controls, like QLabel and QTabBar, treat activated() and activatedAmbiguously() as equivalent.
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.
The function setWhatsThis() specifies a help text that appears when the user presses an accelerator key in What's This mode.
The accelerator will be deleted when parent is deleted, and will consume relevant key events until then.
Please note that the accelerator
accelerator->insertItem( QKeySequence("M") );
can be triggered with both the 'M' key, and with Shift+M, unless a second accelerator is defined for the Shift+M combination.
Example:
QAccel *a = new QAccel( myWindow ); // create accels for myWindow a->connectItem( a->insertItem(Key_P+CTRL), // adds Ctrl+P accelerator myWindow, // connected to myWindow's SLOT(printDoc()) ); // printDoc() slot
| QAccel::QAccel | ( | QWidget * | parent, |
| const char * | name = 0 |
||
| ) |
Constructs a QAccel object called name, with parent parent. The accelerator operates on parent.
Constructs a QAccel object called name, that operates on watch, and is a child of parent.
This constructor is not needed for normal application programming.
| QAccel::~QAccel | ( | ) |
Destroys the accelerator object and frees all allocated resources.
| QAccel::QAccel | ( | QWidget * | parent, |
| const char * | name = 0 |
||
| ) |
| QAccel::~QAccel | ( | ) |
| void QAccel::activated | ( | int | id | ) | [signal] |
This signal is emitted when an accelerator key is pressed. id is a number that identifies this particular accelerator item.
| void QAccel::activated | ( | int | id | ) | [signal] |
| void QAccel::activatedAmbiguously | ( | int | id | ) | [signal] |
This signal is emitted when an accelerator key is pressed. id is a number that identifies this particular accelerator item.
| void QAccel::activatedAmbiguously | ( | int | id | ) | [signal] |
| void QAccel::clear | ( | void | ) |
Removes all accelerator items.
| void QAccel::clear | ( | ) |
Connects the accelerator item id to the slot member of receiver.
a->connectItem( 201, mainView, SLOT(quit()) );
Of course, you can also send a signal as member.
Normally accelerators are connected to slots which then receive the activated(int id) signal with the id of the accelerator item that was activated. If you choose to connect a specific accelerator item using this function, the activated() signal is emitted if the associated key sequence is pressed but no activated(int id) signal is emitted.
| uint QAccel::count | ( | ) | const |
| uint QAccel::count | ( | ) | const |
Returns the number of accelerator items in this accelerator.
Disconnects an accelerator item with id id from the function called member in the receiver object.
Filters events if this object has been installed as an event filter for the watched object.
In your reimplementation of this function, if you want to filter the event e, out, i.e. stop it being handled further, return TRUE; otherwise return FALSE.
Example:
class MyMainWindow : public QMainWindow { public: MyMainWindow( QWidget *parent = 0, const char *name = 0 ); protected: bool eventFilter( QObject *obj, QEvent *ev ); private: QTextEdit *textEdit; }; MyMainWindow::MyMainWindow( QWidget *parent, const char *name ) : QMainWindow( parent, name ) { textEdit = new QTextEdit( this ); setCentralWidget( textEdit ); textEdit->installEventFilter( this ); } bool MyMainWindow::eventFilter( QObject *obj, QEvent *ev ) { if ( obj == textEdit ) { if ( e->type() == QEvent::KeyPress ) { QKeyEvent *k = (QKeyEvent*)ev; qDebug( "Ate key press %d", k->key() ); return TRUE; } else { return FALSE; } } else { // pass the event on to the parent class return QMainWindow::eventFilter( obj, ev ); } }
Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.
Reimplementado de QObject.
serves no purpose anymore
Reimplementado de QObject.
| int QAccel::findKey | ( | const QKeySequence & | key | ) | const |
Returns the identifier of the accelerator item with the key code key, or -1 if the item cannot be found.
| int QAccel::findKey | ( | const QKeySequence & | key | ) | const |
| bool QAccel::ignoreWhatsThis | ( | ) | const |
| bool QAccel::ignoreWhatsThis | ( | ) | const |
| int QAccel::insertItem | ( | const QKeySequence & | key, |
| int | id = -1 |
||
| ) |
Inserts an accelerator item and returns the item's identifier.
key is a key code and an optional combination of SHIFT, CTRL and ALT. id is the accelerator item id.
If id is negative, then the item will be assigned a unique negative identifier less than -1.
QAccel *a = new QAccel( myWindow ); // create accels for myWindow a->insertItem( CTRL + Key_P, 200 ); // Ctrl+P, e.g. to print document a->insertItem( ALT + Key_X, 201 ); // Alt+X, e.g. to quit a->insertItem( UNICODE_ACCEL + 'q', 202 ); // Unicode 'q', e.g. to quit a->insertItem( Key_D ); // gets a unique negative id < -1 a->insertItem( CTRL + SHIFT + Key_P ); // gets a unique negative id < -1
| int QAccel::insertItem | ( | const QKeySequence & | key, |
| int | id = -1 |
||
| ) |
| bool QAccel::isEnabled | ( | ) | const |
Returns TRUE if the accelerator is enabled; otherwise returns FALSE.
| bool QAccel::isEnabled | ( | ) | const |
Returns TRUE if the accelerator item with the identifier id is enabled. Returns FALSE if the item is disabled or cannot be found.
| QKeySequence QAccel::key | ( | int | id | ) |
Returns the key sequence of the accelerator item with identifier id, or an invalid key sequence (0) if the id cannot be found.
| QKeySequence QAccel::key | ( | int | id | ) |
| QString QAccel::keyToString | ( | QKeySequence | k | ) | [static] |
Creates an accelerator string for the key k. For instance CTRL+Key_O gives "Ctrl+O". The "Ctrl" etc. are translated (using QObject::tr()) in the "QAccel" context.
The function is superfluous. Cast the QKeySequence k to a QString for the same effect.
| static QString QAccel::keyToString | ( | QKeySequence | k | ) | [static] |
| void QAccel::removeItem | ( | int | id | ) |
Removes the accelerator item with the identifier id.
| void QAccel::removeItem | ( | int | id | ) |
| void QAccel::repairEventFilter | ( | ) |
| void QAccel::repairEventFilter | ( | ) |
serves no purpose anymore
| void QAccel::setEnabled | ( | bool | enable | ) |
Enables the accelerator if enable is TRUE, or disables it if enable is FALSE.
Individual keys can also be enabled or disabled using setItemEnabled(). To work, a key must be an enabled item in an enabled QAccel.
| void QAccel::setEnabled | ( | bool | ) |
| void QAccel::setIgnoreWhatsThis | ( | bool | b | ) |
| void QAccel::setIgnoreWhatsThis | ( | bool | ) |
Enables the accelerator item with the identifier id if enable is TRUE, and disables item id if enable is FALSE.
To work, an item must be enabled and be in an enabled QAccel.
Sets a What's This help text for the accelerator item id to text.
The text will be shown when the application is in What's This mode and the user hits the accelerator key.
To set What's This help on a menu item (with or without an accelerator key), use QMenuData::setWhatsThis().
| static QKeySequence QAccel::shortcutKey | ( | const QString & | ) | [static] |
| QKeySequence QAccel::shortcutKey | ( | const QString & | str | ) | [static] |
Returns the shortcut key sequence for str, or an invalid key sequence (0) if str has no shortcut sequence.
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 Qt namespace class, you must write e.g. Qt::ALT+Qt::Key_Q.)
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.
| static QKeySequence QAccel::stringToKey | ( | const QString & | ) | [static] |
| QKeySequence QAccel::stringToKey | ( | const QString & | s | ) | [static] |
Returns an accelerator code for the string s. 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 QObject::tr()). Returns 0 if s is not recognized.
This function is typically used with tr (), so that accelerator keys can be replaced in translations:
QPopupMenu *file = new QPopupMenu( this ); file->insertItem( p1, tr("&Open..."), this, SLOT(open()), QAccel::stringToKey(tr("Ctrl+O", "File|Open")) );
Notice the "File|Open" translator comment. It is by no means necessary, but it provides some context for the human translator.
The function is superfluous. Construct a QKeySequence from the string s for the same effect.
Returns the What's This help text for the specified item id or QString::null if no text has been specified.
QAccelManager [friend] |
QAccelPrivate [friend] |
1.7.4
