1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
/* This file is part of the KDE libraries
Copyright (C) 2001,2002 Ellis Whitehead <ellis@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _KGLOBALACCEL_H_
#define _KGLOBALACCEL_H_
#include <qobject.h>
#include <kshortcut.h>
class QPopupMenu;
class QWidget;
class KAccelAction;
class KAccelActions;
class KConfigBase;
class KGlobalAccelPrivate;
/**
* 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.
*
* @see KAccel
* @see KAccelShortcutList
* @see KKeyChooser
* @see KKeyDialog
* @short Configurable global shortcut support
*/
class KDECORE_EXPORT KGlobalAccel : public QObject
{
Q_OBJECT
public:
/**
* Creates a new KGlobalAccel object with the given pParent and
* psName.
* @param pParent the parent of the QObject
* @param psName the name of the QObject
*/
KGlobalAccel( QObject* pParent, const char* psName = 0 );
virtual ~KGlobalAccel();
/**
* Checks whether the accelerators are enabled.
* @return true if the KGlobalAccel is enabled
*/
bool isEnabled();
/**
* Enables or disables the KGlobalAccel
* @param bEnabled true if the KGlobalAccel should be enabled, false if it
* should be disabled.
*/
void setEnabled( bool bEnabled );
/**
* Create an accelerator action.
*
* Usage:
*\code
* 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()) );
*\endcode
*
* @param sAction The internal name of the action.
* @param sLabel An i18n'ized short description of the action displayed when
* using KKeyChooser to reconfigure the shortcuts.
* @param sWhatsThis An extended description of the action.
* @param cutDef3 The default 3 modifier scheme shortcut.
* @param cutDef4 The default 4 modifier scheme shortcut.
* @param pObjSlot Pointer to the slot object.
* @param psMethodSlot Pointer to the slot method.
* @param bConfigurable Allow the user to change this shortcut if set to 'true'.
* @param bEnabled The action will be activated by the shortcut if set to '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 );
/**
* Removes the accelerator action identified by the name.
* Remember to also call updateConnections().
* @param sAction the name of the action to remove
* @since 3.1
*/
bool remove( const QString& sAction );
/**
* Use this to insert a label into the action list. This will be
* displayed when the user configures shortcuts.
* @param sName of the of the action to insert
* @param sLabel a user-readable (i18n!) name for the action
* @return the KAccelAction of the action
*/
KAccelAction* insert( const QString& sName, const QString& sLabel );
/**
* Updates the connections of the accelerations after changing them.
* @return true if successful, false otherwise
*/
bool updateConnections();
/**
* Return the shortcut associated with the action named by @p sAction.
* @param sAction the name of the action
* @return the shortcut. If the action does not exist a null shortcut will be returned.
*/
const KShortcut& shortcut( const QString& sAction ) const;
/**
* Set the shortcut to be associated with the action named by @p sAction.
* @param sAction the name of the action
* @param shortcut the shortcut for the action
* @return true if successful, false otherwise
*/
bool setShortcut( const QString& sAction, const KShortcut &shortcut );
/**
* Set the slot to be called when the shortcut of the action named
* by @p sAction is pressed.
* @param sAction the name of the action
* @param pObjSlot the receiver of the signal
* @param psMethodSlot the slot to receive the signal
* @return true if successful, false otherwise
*/
bool setSlot( const QString& sAction, const QObject* pObjSlot, const char* psMethodSlot );
/**
* Enables or disables action @p sAction.
* @since 3.4
*/
bool setActionEnabled( const QString& sAction, bool bEnable );
/**
* Return the label (i18n'ized short description) associated with the action named by @p sAction.
* @param sAction the name of the action
* @return the label
* @since 3.3
*/
QString label( const QString& sAction ) const;
/**
* Returns the configuration group that is used to save the accelerators.
* @return the configuration group
* @see KConfig
*/
const QString& configGroup() const;
/**
* Sets the configuration group that is used to save the accelerators.
* @param cg the configuration group
* @see KConfig
*/
void setConfigGroup( const QString &cg );
/**
* Read all shortcuts from @p pConfig, or (if @p pConfig
* is zero) from the application's configuration file
* KGlobal::config().
* @param pConfig the configuration file to read from, or 0 for the application
* configuration file
* @return true if successful, false otherwise
*/
bool readSettings( KConfigBase* pConfig = 0 );
/**
* Write the current shortcuts to @p pConfig,
* or (if @p pConfig is zero) to the application's
* configuration file.
* @param pConfig the configuration file to read from, or 0 for the application
* configuration file
* @return true if successful, false otherwise
* @since 3.1
*/
bool writeSettings( KConfigBase* pConfig = 0 ) const;
// BCI: merge these two writeSettings methods in KDE 4.0
/**
* Write the current shortcuts to @p pConfig,
* or (if @p pConfig is zero) to the application's
* configuration file. Alternatively, if bGlobal is true, then write
* to kdeglobals.
* @param pConfig the configuration file to read from, or 0 for the application
* configuration file
* @param bGlobal if true write the configuration to the kde global settings
* @return true if successful, false otherwise
*/
bool writeSettings( KConfigBase* pConfig, bool bGlobal ) const;
/**
* @internal -- this a wrapper function to
* KAccelActions::useFourModifierKeys().
*/
static bool useFourModifierKeys();
/**
* @internal
*/
static void blockShortcuts( bool block );
/**
* @internal
*/
void disableBlocking( bool disable );
/**
* @internal
*/
// like setEnabled(), but doesn't ungrab (see in KGlobalAccelPrivate)
void suspend( bool s );
private:
KAccelActions& actions();
const KAccelActions& actions() const;
friend class KGlobalAccelPrivate;
friend class KAccelShortcutList;
protected:
/** \internal */
virtual void virtual_hook( int id, void* data );
private:
class KGlobalAccelPrivate* d;
};
#endif // _KGLOBALACCEL_H_
|
