KAccel Class Reference
#include <kaccel.h>
Inheritance diagram for KAccel:

Detailed Description
Handle shortcuts.Configurable shortcut support for widgets.Allow a user to configure shortcuts through application configuration files or through the KKeyChooser GUI.
A KAccel contains a list of accelerator actions.
For example, CTRL+Key_P could be a shortcut for printing a document. The key codes are listed in qnamespace.h. "Print" could be the action name for printing. The action name identifies the shortcut in configuration files and the KKeyChooser GUI.
A KAccel object handles key events sent to its parent widget and to all children of this parent widget. The most recently created KAccel object has precedence over any KAccel objects created before it. When a shortcut pressed, KAccel calls the slot to which it has been connected. If you want to set global accelerators, independent of the window which has the focus, use KGlobalAccel.
Reconfiguration of a given shortcut can be prevented by specifying that an accelerator item is not configurable when it is inserted. A special group of non-configurable key bindings are known as the standard accelerators.
The standard accelerators appear repeatedly in applications for standard document actions such as printing and saving. A convenience method is available to insert and connect these accelerators which are configurable on a desktop-wide basis.
It is possible for a user to choose to have no key associated with an action.
The translated first argument for insertItem() is used only in the configuration dialog.
KAccel* pAccel = new KAccel( this ); // Insert an action "Scroll Up" which is associated with the "Up" key: pAccel->insert( "Scroll Up", i18n("Scroll up"), i18n("Scroll up the current document by one line."), Qt::Key_Up, this, SLOT(slotScrollUp()) ); // Insert an standard acclerator action. pAccel->insert( KStdAccel::Print, this, SLOT(slotPrint()) ); // Update the shortcuts by read any user-defined settings from the // application's config file. pAccel->readSettings();
Definition at line 93 of file kaccel.h.
Signals | |
void | keycodeChanged () |
Public Member Functions | |
KAccel (QWidget *pParent, const char *psName=0) | |
KAccel (QWidget *watch, QObject *parent, const char *psName=0) | |
KAccelActions & | actions () |
const KAccelActions & | actions () const |
bool | isEnabled () |
void | setEnabled (bool bEnabled) |
bool | setAutoUpdate (bool bAuto) |
KAccelAction * | insert (const QString &sAction, const QString &sLabel, const QString &sWhatsThis, const KShortcut &cutDef, const QObject *pObjSlot, const char *psMethodSlot, bool bConfigurable=true, bool bEnabled=true) |
KAccelAction * | insert (const QString &sAction, const QString &sLabel, const QString &sWhatsThis, const KShortcut &cutDef3, const KShortcut &cutDef4, const QObject *pObjSlot, const char *psMethodSlot, bool bConfigurable=true, bool bEnabled=true) |
KAccelAction * | insert (const char *psAction, const KShortcut &cutDef, const QObject *pObjSlot, const char *psMethodSlot, bool bConfigurable=true, bool bEnabled=true) |
KAccelAction * | insert (KStdAccel::StdAccel id, const QObject *pObjSlot, const char *psMethodSlot, bool bConfigurable=true, bool bEnabled=true) |
bool | remove (const QString &sAction) |
bool | updateConnections () |
const KShortcut & | shortcut (const QString &sAction) const |
bool | setShortcut (const QString &sAction, const KShortcut &shortcut) |
bool | setSlot (const QString &sAction, const QObject *pObjSlot, const char *psMethodSlot) |
bool | setEnabled (const QString &sAction, bool bEnabled) |
const QString & | configGroup () const |
void | setConfigGroup (const QString &name) |
bool | readSettings (KConfigBase *pConfig=0) |
bool | writeSettings (KConfigBase *pConfig=0) const |
void | emitKeycodeChanged () |
bool | insertItem (const QString &sLabel, const QString &sAction, const char *psKey, int nIDMenu=0, QPopupMenu *pMenu=0, bool bConfigurable=true) KDE_DEPRECATED |
bool | insertItem (const QString &sLabel, const QString &sAction, int key, int nIDMenu=0, QPopupMenu *pMenu=0, bool bConfigurable=true) KDE_DEPRECATED |
bool | insertStdItem (KStdAccel::StdAccel id, const QString &descr=QString::null) KDE_DEPRECATED |
bool | connectItem (const QString &sAction, const QObject *pObjSlot, const char *psMethodSlot, bool bActivate=true) KDE_DEPRECATED |
KDE_DEPRECATED bool | connectItem (KStdAccel::StdAccel accel, const QObject *pObjSlot, const char *psMethodSlot) |
bool | removeItem (const QString &sAction) KDE_DEPRECATED |
bool | setItemEnabled (const QString &sAction, bool bEnable) KDE_DEPRECATED |
void | changeMenuAccel (QPopupMenu *menu, int id, const QString &action) KDE_DEPRECATED |
void | changeMenuAccel (QPopupMenu *menu, int id, KStdAccel::StdAccel accel) KDE_DEPRECATED |
int | currentKey (const QString &action) const KDE_DEPRECATED |
QString | findKey (int key) const KDE_DEPRECATED |
Static Public Member Functions | |
static int | stringToKey (const QString &) KDE_DEPRECATED |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Friends | |
class | KAccelPrivate |
Constructor & Destructor Documentation
|
Creates a new KAccel that watches
Definition at line 417 of file kaccel.cpp. |
|
Creates a new KAccel that watches
Definition at line 424 of file kaccel.cpp. |
Member Function Documentation
|
Definition at line 631 of file kaccel.cpp. |
|
Definition at line 604 of file kaccel.cpp. |
|
Returns the configuration group of the settings.
Definition at line 524 of file kaccel.cpp. |
|
|
|
Definition at line 587 of file kaccel.cpp. |
|
Retrieve the key code of the accelerator item with the action name Definition at line 641 of file kaccel.cpp. |
|
Emits the keycodeChanged() signal.
Definition at line 539 of file kaccel.cpp. |
|
Return the name of the accelerator item with the keycode Definition at line 649 of file kaccel.cpp. |
|
Similar to the first insert() method, but with the action name, short description, help text, and default shortcuts all set according to one of the standard accelerators.
Definition at line 477 of file kaccel.cpp. |
|
This is an overloaded function provided for convenience. The advantage of this is when you want to use the same text for the name of the action as for the user-visible label. Usage: insert( i18n("Do Something"), ALT+Key_D, this, SLOT(slotDoSomething()) );
Definition at line 467 of file kaccel.cpp. |
|
Same as first insert(), but with separate shortcuts defined for 3- and 4- modifier defaults.
Definition at line 456 of file kaccel.cpp. |
|
Create an accelerator action. Usage: insert( "Do Something", i18n("Do Something"), i18n("This action allows you to do something really great with this program to " "the currently open document."), ALT+Key_D, this, SLOT(slotDoSomething()) ); *
Definition at line 445 of file kaccel.cpp. |
|
Definition at line 562 of file kaccel.cpp. |
|
Definition at line 550 of file kaccel.cpp. |
|
Definition at line 576 of file kaccel.cpp. |
|
Checks whether the KAccel is active.
Definition at line 441 of file kaccel.cpp. |
|
Emitted when one of the key codes has changed.
|
|
Read all shortcuts from The group in which the configuration is stored can be set with setConfigGroup().
Definition at line 530 of file kaccel.cpp. |
|
Removes the accelerator action identified by the name. Remember to also call updateConnections().
Definition at line 495 of file kaccel.cpp. |
|
Definition at line 598 of file kaccel.cpp. |
|
Enable auto-update of connections. This means that the signals are automatically disconnected when you disable an action, and re-enabled when you enable it. By default auto update is turned on. If you disable auto-update, you need to call updateConnections() after changing actions.
Definition at line 443 of file kaccel.cpp. |
|
Returns the configuration group of the settings.
Definition at line 527 of file kaccel.cpp. |
|
Enable or disable the action named by
Definition at line 509 of file kaccel.cpp. |
|
Enables or disables the KAccel.
Definition at line 442 of file kaccel.cpp. |
|
Definition at line 601 of file kaccel.cpp. |
|
Set the shortcut to be associated with the action named by
Definition at line 512 of file kaccel.cpp. |
|
Set the slot to be called when the shortcut of the action named by
Definition at line 506 of file kaccel.cpp. |
|
Return the shortcut associated with the action named by
Definition at line 500 of file kaccel.cpp. |
|
Definition at line 636 of file kaccel.cpp. |
|
Updates the connections of the accelerations after changing them. This is only necessary if you have disabled auto updates which are on by default.
Definition at line 497 of file kaccel.cpp. |
|
Write the current shortcuts to
Definition at line 536 of file kaccel.cpp. |
The documentation for this class was generated from the following files: