KDECore
KGlobalAccel Class Reference
KGlobalAccel allows you to have global accelerators that are independent of the focused window. More...
#include <kglobalaccel.h>
Public Member Functions | |
const QString & | configGroup () const |
void | disableBlocking (bool disable) |
KAccelAction * | insert (const QString &sName, const QString &sLabel) |
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) |
bool | isEnabled () |
KGlobalAccel (QObject *pParent, const char *psName=0) | |
QString | label (const QString &sAction) const |
bool | readSettings (KConfigBase *pConfig=0) |
bool | remove (const QString &sAction) |
bool | setActionEnabled (const QString &sAction, bool bEnable) |
void | setConfigGroup (const QString &cg) |
void | setEnabled (bool bEnabled) |
bool | setShortcut (const QString &sAction, const KShortcut &shortcut) |
bool | setSlot (const QString &sAction, const QObject *pObjSlot, const char *psMethodSlot) |
const KShortcut & | shortcut (const QString &sAction) const |
void | suspend (bool s) |
bool | updateConnections () |
bool | writeSettings (KConfigBase *pConfig, bool bGlobal) const |
bool | writeSettings (KConfigBase *pConfig=0) const |
virtual | ~KGlobalAccel () |
Static Public Member Functions | |
static void | blockShortcuts (bool block) |
static bool | useFourModifierKeys () |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
KGlobalAccel allows you to have global accelerators that are independent of the focused window.Unlike KAccel it does not matter which window is currently active.
Definition at line 45 of file kglobalaccel.h.
Constructor & Destructor Documentation
KGlobalAccel::KGlobalAccel | ( | QObject * | pParent, | |
const char * | psName = 0 | |||
) |
Creates a new KGlobalAccel object with the given pParent and psName.
Definition at line 39 of file kglobalaccel.cpp.
KGlobalAccel::~KGlobalAccel | ( | ) | [virtual] |
Definition at line 46 of file kglobalaccel.cpp.
Member Function Documentation
void KGlobalAccel::blockShortcuts | ( | bool | block | ) | [static] |
const QString & KGlobalAccel::configGroup | ( | ) | const |
Returns the configuration group that is used to save the accelerators.
- Returns:
- the configuration group
- See also:
- KConfig
Definition at line 116 of file kglobalaccel.cpp.
void KGlobalAccel::disableBlocking | ( | bool | disable | ) |
KAccelAction * KGlobalAccel::insert | ( | const QString & | sName, | |
const QString & | sLabel | |||
) |
Use this to insert a label into the action list.
This will be displayed when the user configures shortcuts.
- Parameters:
-
sName of the of the action to insert sLabel a user-readable (i18n!) name for the action
- Returns:
- the KAccelAction of the action
Definition at line 88 of file kglobalaccel.cpp.
KAccelAction * KGlobalAccel::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 | |||
) |
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+CTRL+Key_Q, KKey::QtWIN+CTRL+Key_Q, this, SLOT(slotDoSomething()) ); *
- Parameters:
-
sAction The internal name of the action. sLabel An i18n'ized short description of the action displayed when using KKeyChooser to reconfigure the shortcuts. sWhatsThis An extended description of the action. cutDef3 The default 3 modifier scheme shortcut. cutDef4 The default 4 modifier scheme shortcut. pObjSlot Pointer to the slot object. psMethodSlot Pointer to the slot method. bConfigurable Allow the user to change this shortcut if set to 'true'. bEnabled The action will be activated by the shortcut if set to 'true'.
Definition at line 77 of file kglobalaccel.cpp.
bool KGlobalAccel::isEnabled | ( | ) |
Checks whether the accelerators are enabled.
- Returns:
- true if the KGlobalAccel is enabled
Definition at line 62 of file kglobalaccel.cpp.
Return the label (i18n'ized short description) associated with the action named by sAction
.
- Parameters:
-
sAction the name of the action
- Returns:
- the label
- Since:
- 3.3
Definition at line 106 of file kglobalaccel.cpp.
bool KGlobalAccel::readSettings | ( | KConfigBase * | pConfig = 0 |
) |
Read all shortcuts from pConfig
, or (if pConfig
is zero) from the application's configuration file KGlobal::config().
- Parameters:
-
pConfig the configuration file to read from, or 0 for the application configuration file
- Returns:
- true if successful, false otherwise
Definition at line 122 of file kglobalaccel.cpp.
Removes the accelerator action identified by the name.
Remember to also call updateConnections().
- Parameters:
-
sAction the name of the action to remove
- Since:
- 3.1
Definition at line 93 of file kglobalaccel.cpp.
void KGlobalAccel::setConfigGroup | ( | const QString & | cg | ) |
Sets the configuration group that is used to save the accelerators.
- Parameters:
-
cg the configuration group
- See also:
- KConfig
Definition at line 119 of file kglobalaccel.cpp.
void KGlobalAccel::setEnabled | ( | bool | bEnabled | ) |
Enables or disables the KGlobalAccel.
- Parameters:
-
bEnabled true if the KGlobalAccel should be enabled, false if it should be disabled.
Definition at line 65 of file kglobalaccel.cpp.
Set the shortcut to be associated with the action named by sAction
.
- Parameters:
-
sAction the name of the action shortcut the shortcut for the action
- Returns:
- true if successful, false otherwise
Definition at line 102 of file kglobalaccel.cpp.
bool KGlobalAccel::setSlot | ( | const QString & | sAction, | |
const QObject * | pObjSlot, | |||
const char * | psMethodSlot | |||
) |
Set the slot to be called when the shortcut of the action named by sAction
is pressed.
- Parameters:
-
sAction the name of the action pObjSlot the receiver of the signal psMethodSlot the slot to receive the signal
- Returns:
- true if successful, false otherwise
Definition at line 104 of file kglobalaccel.cpp.
Return the shortcut associated with the action named by sAction
.
- Parameters:
-
sAction the name of the action
- Returns:
- the shortcut. If the action does not exist a null shortcut will be returned.
Definition at line 96 of file kglobalaccel.cpp.
void KGlobalAccel::suspend | ( | bool | s | ) |
bool KGlobalAccel::updateConnections | ( | ) |
Updates the connections of the accelerations after changing them.
- Returns:
- true if successful, false otherwise
Definition at line 90 of file kglobalaccel.cpp.
bool KGlobalAccel::useFourModifierKeys | ( | ) | [static] |
For internal use only.
-- this a wrapper function to KAccelActions::useFourModifierKeys().
Definition at line 133 of file kglobalaccel.cpp.
void KGlobalAccel::virtual_hook | ( | int | id, | |
void * | data | |||
) | [protected, virtual] |
bool KGlobalAccel::writeSettings | ( | KConfigBase * | pConfig, | |
bool | bGlobal | |||
) | const |
Write the current shortcuts to pConfig
, or (if pConfig
is zero) to the application's configuration file.
Alternatively, if bGlobal is true, then write to kdeglobals.
- Parameters:
-
pConfig the configuration file to read from, or 0 for the application configuration file bGlobal if true write the configuration to the kde global settings
- Returns:
- true if successful, false otherwise
Definition at line 126 of file kglobalaccel.cpp.
bool KGlobalAccel::writeSettings | ( | KConfigBase * | pConfig = 0 |
) | const |
Write the current shortcuts to pConfig
, or (if pConfig
is zero) to the application's configuration file.
- Parameters:
-
pConfig the configuration file to read from, or 0 for the application configuration file
- Returns:
- true if successful, false otherwise
- Since:
- 3.1
Definition at line 124 of file kglobalaccel.cpp.
The documentation for this class was generated from the following files: