File: KKeySequenceWidget.html

package info (click to toggle)
pykde4 4%3A4.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 30,864 kB
  • ctags: 18,431
  • sloc: python: 2,063; cpp: 327; makefile: 52; sh: 5
file content (696 lines) | stat: -rw-r--r-- 25,753 bytes parent folder | download | duplicates (2)
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">

<head>
  <title>KKeySequenceWidget</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
  <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
  <div id="header_top">
    <div>
      <div>
        <img alt ="" src="../common/top-kde.jpg"/>
        KDE 4.9 PyKDE API Reference
      </div>
    </div>
  </div>
  <div id="header_bottom">
    <div id="location">
      <ul>
        <li>KDE's Python API</li>
      </ul>
    </div>

    <div id="menu">
      <ul>
        <li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
    </div>
  </div>
</div>

<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer">&nbsp;</div>

<h1>KKeySequenceWidget Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QWidget &#x2192; QObject<br />


<h2>Detailed Description</h2>

<p>A widget to input a QKeySequence.
</p>
<p>
This widget lets the user choose a QKeySequence, which is usually used as a
shortcut key. The recording is initiated by calling captureKeySequence() or
the user clicking into the widget.
</p>
<p>
The widgets provides support for conflict handling. See
setCheckForConflictsAgainst() for more information.
</p>
<p>
<div align="center"><img src="../images/kkeysequencewidget.png" /><p><strong> "KDE Key Sequence Widget" </strong></p></div>
</p>
<p>

<dl class="author" compact><dt><b>Author:</b></dt><dd> Mark Donohoe &lt;donohoe@kde.org&gt; </dd></dl>
<dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#ShortcutType">ShortcutType</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;None, LocalShortcuts, StandardShortcuts, GlobalShortcuts&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Validation">Validation</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;Validate, NoValidate&nbsp;}</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#keySequenceChanged">keySequenceChanged</a> (QKeySequence seq)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#stealShortcut">stealShortcut</a> (QKeySequence seq, <a href="../kdeui/KAction.html">KAction</a> action)</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KKeySequenceWidget">__init__</a> (self, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KKeySequenceWidget">__init__</a> (self, <a href="../kdeui/KKeySequenceWidget.html">KKeySequenceWidget</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#applyStealShortcut">applyStealShortcut</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#captureKeySequence">captureKeySequence</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KKeySequenceWidget.html">KKeySequenceWidget.ShortcutTypes</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#checkForConflictsAgainst">checkForConflictsAgainst</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#clearKeySequence">clearKeySequence</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#isKeySequenceAvailable">isKeySequenceAvailable</a> (self, QKeySequence seq)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#isModifierlessAllowed">isModifierlessAllowed</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QKeySequence&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#keySequence">keySequence</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#multiKeyShortcutsAllowed">multiKeyShortcutsAllowed</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setCheckActionCollections">setCheckActionCollections</a> (self, [<a href="../kdeui/KActionCollection.html">KActionCollection</a>] actionCollections)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setCheckActionList">setCheckActionList</a> (self, [QAction] checkList)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setCheckForConflictsAgainst">setCheckForConflictsAgainst</a> (self, <a href="../kdeui/KKeySequenceWidget.html">KKeySequenceWidget.ShortcutTypes</a> types)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setClearButtonShown">setClearButtonShown</a> (self, bool show)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setComponentName">setComponentName</a> (self, QString componentName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setKeySequence">setKeySequence</a> (self, QKeySequence seq, <a href="../kdeui/KKeySequenceWidget.html#Validation">KKeySequenceWidget.Validation</a> val=KKeySequenceWidget.NoValidate)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setModifierlessAllowed">setModifierlessAllowed</a> (self, bool allow)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setMultiKeyShortcutsAllowed">setMultiKeyShortcutsAllowed</a> (self, bool a0)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="keySequenceChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> keySequenceChanged</td>
<td>(</td>
<td class="paramtype">QKeySequence&nbsp;</td>
<td class="paramname"><em>seq</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This signal is emitted when the current key sequence has changed, be it by user
input or programmatically.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("keySequenceChanged(const QKeySequence&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="stealShortcut"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> stealShortcut</td>
<td>(</td>
<td class="paramtype">QKeySequence&nbsp;</td>
<td class="paramname"><em>seq</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KAction.html">KAction</a>&nbsp;</td>
<td class="paramname"><em>action</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This signal is emitted after the user agreed to steal a shortcut from
an action. This is only done for local shortcuts. So you can be sure \a
action is one of the actions you provided with setCheckActionList() or
setCheckActionCollections().
</p>
<p>
If you listen to that signal and don't call applyStealShortcut() you
are supposed to steal the shortcut and save this change.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("stealShortcut(const QKeySequence&, KAction*)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KKeySequenceWidget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget&nbsp;</td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor.
</p></div></div><a class="anchor" name="KKeySequenceWidget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KKeySequenceWidget.html">KKeySequenceWidget</a>&nbsp;</td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="applyStealShortcut"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> applyStealShortcut</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Actually remove the shortcut that the user wanted to steal, from the
action that was using it. This only applies to actions provided to us
by setCheckActionCollections() and setCheckActionList().
</p>
<p>
Global and Standard Shortcuts have to be stolen immediately when the
user gives his consent (technical reasons). That means those changes
will be active even if you never call applyStealShortcut().
</p>
<p>
To be called before you apply your changes. No local shortcuts are
stolen until this function is called.
</p></div></div><a class="anchor" name="captureKeySequence"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> captureKeySequence</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Capture a shortcut from the keyboard. This call will only return once a key sequence
has been captured or input was aborted.
If a key sequence was input, keySequenceChanged() will be emitted.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setModifierlessAllowed()
</dd></dl>
</p></div></div><a class="anchor" name="checkForConflictsAgainst"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KKeySequenceWidget.html">KKeySequenceWidget.ShortcutTypes</a> checkForConflictsAgainst</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The shortcut types we check for conflicts.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setCheckForConflictsAgainst()
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2
</dd></dl>
</p></div></div><a class="anchor" name="clearKeySequence"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearKeySequence</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Clear the key sequence.
</p></div></div><a class="anchor" name="isKeySequenceAvailable"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isKeySequenceAvailable</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QKeySequence&nbsp;</td>
<td class="paramname"><em>seq</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Checks whether the key sequence <b>seq</b> is available to grab.
</p>
<p>
The sequence is checked under the same rules as if it has been typed by
the user. This method is useful if you get key sequences from another
input source and want to check if it is save to set them.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2
</dd></dl>
</p></div></div><a class="anchor" name="isModifierlessAllowed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isModifierlessAllowed</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="see" compact><dt><b>See also:</b></dt><dd> setModifierlessAllowed()
</dd></dl>
</p></div></div><a class="anchor" name="keySequence"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QKeySequence keySequence</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Return the currently selected key sequence.
</p></div></div><a class="anchor" name="multiKeyShortcutsAllowed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool multiKeyShortcutsAllowed</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="setCheckActionCollections"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCheckActionCollections</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[<a href="../kdeui/KActionCollection.html">KActionCollection</a>]&nbsp;</td>
<td class="paramname"><em>actionCollections</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set a list of action collections to check against for conflictuous shortcut.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setCheckForConflictsAgainst()
</dd></dl> </p>
<p>
If a KAction with a conflicting shortcut is found inside this list and
its shortcut can be configured (KAction.isShortcutConfigurable()
returns true) the user will be prompted whether to steal the shortcut
from this action.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.1
</dd></dl>
</p></div></div><a class="anchor" name="setCheckActionList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCheckActionList</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[QAction]&nbsp;</td>
<td class="paramname"><em>checkList</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> since 4.1
use setCheckActionCollections so that KKeySequenceWidget knows
in which action collection to call the writeSettings method after stealing
a shortcut from an action.
</dd></dl>
</p></div></div><a class="anchor" name="setCheckForConflictsAgainst"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCheckForConflictsAgainst</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KKeySequenceWidget.html">KKeySequenceWidget.ShortcutTypes</a>&nbsp;</td>
<td class="paramname"><em>types</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Configure if the widget should check for conflicts with existing
shortcuts.
</p>
<p>
When capturing a key sequence for local shortcuts you should check
against GlobalShortcuts and your other local shortcuts. This is the
default.
</p>
<p>
You have to provide the local actions to check against with
setCheckActionCollections().
</p>
<p>
When capturing a key sequence for a global shortcut you should
check against StandardShortcuts, GlobalShortcuts and your local
shortcuts.
</p>
<p>
There are two ways to react to a user agreeing to steal a shortcut:
</p>
<p>
1. Listen to the stealShortcut() signal and steal the shortcuts
manually. It's your responsibility to save that change later when
you think it is appropriate.
</p>
<p>
2. Call applyStealShortcut and KKeySequenceWidget will steal the
shortcut. This will save the actionCollections the shortcut is part
of so make sure it doesn't inadvertly save some unwanted changes
too. Read its documentation for some limitation when handling
global shortcuts.
</p>
<p>
If you want to do the conflict checking yourself here are some code
snippets for global ...
</p>
<p>
<pre class="fragment">
 QStringList conflicting = KGlobalAccel.findActionNameSystemwide(keySequence);
 if (!conflicting.isEmpty()) {
     // Inform and ask the user about the conflict and reassigning
     // the keys sequence
     if (!KGlobalAccel.promptStealShortcutSystemwide(q, conflicting, keySequence)) {
         return true;
     }
     KGlobalAccel.stealShortcutSystemwide(keySequence);
 }
</pre>
</p>
<p>
... and standard shortcuts
</p>
<p>
<pre class="fragment">
 KStandardShortcut.StandardShortcut ssc = KStandardShortcut.find(keySequence);
 if (ssc != KStandardShortcut.AccelNone) {
     // We have a conflict
 }
</pre>
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2
</dd></dl>
</p></div></div><a class="anchor" name="setClearButtonShown"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setClearButtonShown</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>show</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set whether a small button to set an empty key sequence should be displayed next to the
main input widget. The default is to show the clear button.
</p></div></div><a class="anchor" name="setComponentName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setComponentName</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>componentName</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>If the component using this widget supports shortcuts contexts, it has
to set its component name so we can check conflicts correctly.
</p></div></div><a class="anchor" name="setKeySequence"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setKeySequence</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QKeySequence&nbsp;</td>
<td class="paramname"><em>seq</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KKeySequenceWidget.html#Validation">KKeySequenceWidget.Validation</a>&nbsp;</td>
<td class="paramname"><em>val=KKeySequenceWidget.NoValidate</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the key sequence.
</p>
<p>
If <b>val</b> == Validate, and the call is actually changing the key sequence,
conflictuous shortcut will be checked.
</p></div></div><a class="anchor" name="setModifierlessAllowed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setModifierlessAllowed</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>allow</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This only applies to user input, not to setShortcut().
Set whether to accept "plain" keys without modifiers (like Ctrl, Alt, Meta).
Plain keys by our definition include letter and symbol keys and
text editing keys (Return, Space, Tab, Backspace, Delete).
"Special" keys like F1, Cursor keys, Insert, PageDown will always work.
</p></div></div><a class="anchor" name="setMultiKeyShortcutsAllowed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setMultiKeyShortcutsAllowed</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>a0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Allow multikey shortcuts?
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="ShortcutType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ShortcutType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Configuration
</p>
<p>
Configuration options for the widget.
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>None</em>&nbsp;=&nbsp;0x00</td><td><tr><td valign="top"><em>LocalShortcuts</em>&nbsp;=&nbsp;0x01</td><td><tr><td valign="top"><em>StandardShortcuts</em>&nbsp;=&nbsp;0x02</td><td><tr><td valign="top"><em>GlobalShortcuts</em>&nbsp;=&nbsp;0x03</td><td></table>
</dl>
</div></div><p><a class="anchor" name="Validation"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Validation</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Validate</em>&nbsp;=&nbsp;0</td><td><tr><td valign="top"><em>NoValidate</em>&nbsp;=&nbsp;1</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>

<div id="left">

<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>

<a name="cp-menu" /><div class="menutitle"><div>
  <h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>

</div>

</div>
  <div class="clearer"/>
</div>

<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
        <a href="http://www.kde.org/contact/impressum.php">Legal</a>
    </div></div>
</body>
</html>