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
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
|
<?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>Plasma.AbstractRunner</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"> </div>
<h1>AbstractRunner Class Reference</h1>
<code>from PyKDE4.plasma import *</code>
<p>
Inherits: QObject<br />
Namespace: <a href="../plasma/Plasma.html">Plasma</a><br />
<h2>Detailed Description</h2>
<p>AbstractRunner plasma/abstractrunner.h <Plasma/AbstractRunner>
</p>
<p>
An abstract base class for Plasma Runner plugins.
</p>
<p>
Be aware that runners have to be thread-safe. This is due to the fact that
each runner is executed in its own thread for each new term. Thus, a runner
may be executed more than once at the same time. See match() for details.
To let krunner expose a global shortcut for the single runner query mode, the runner
must set the "X-Plasma-AdvertiseSingleRunnerMode" key to true in the .desktop file
and set a default syntax. See setDefaultSyntax() for details.
</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="#Priority">Priority</a> </td><td class="memItemRight" valign="bottom">{ LowestPriority, LowPriority, NormalPriority, HighPriority, HighestPriority }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Speed">Speed</a> </td><td class="memItemRight" valign="bottom">{ SlowSpeed, NormalSpeed }</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#matchingSuspended">matchingSuspended</a> (bool suspended)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#prepare">prepare</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#teardown">teardown</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#AbstractRunner">__init__</a> (self, QObject parent=0, QString path=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#AbstractRunner">__init__</a> (self, QObject parent, [QVariant] args)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#AbstractRunner">__init__</a> (self, KSharedPtr<KService> service, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QAction </td><td class="memItemRight" valign="bottom"><a class="el" href="#action">action</a> (self, QString id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">{QString:QAction} </td><td class="memItemRight" valign="bottom"><a class="el" href="#actions">actions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QAction] </td><td class="memItemRight" valign="bottom"><a class="el" href="#actionsForMatch">actionsForMatch</a> (self, <a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> match)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QAction </td><td class="memItemRight" valign="bottom"><a class="el" href="#addAction">addAction</a> (self, QString id, QIcon icon, QString text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addAction">addAction</a> (self, QString id, QAction action)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addSyntax">addSyntax</a> (self, <a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a> syntax)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#clearActions">clearActions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#config">config</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#createRunOptions">createRunOptions</a> (self, QWidget widget)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.DataEngine.html">Plasma.DataEngine</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dataEngine">dataEngine</a> (self, QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#defaultSyntax">defaultSyntax</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#description">description</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasRunOptions">hasRunOptions</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QIcon </td><td class="memItemRight" valign="bottom"><a class="el" href="#icon">icon</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#id">id</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext.Types</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ignoredTypes">ignoredTypes</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#init">init</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isMatchingSuspended">isMatchingSuspended</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#match">match</a> (self, <a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext</a> context)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QMimeData </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimeDataForMatch">mimeDataForMatch</a> (self, <a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> match)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#name">name</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.Package.html">Plasma.Package</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#package">package</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#performMatch">performMatch</a> (self, <a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext</a> context)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.AbstractRunner.html#Priority">Plasma.AbstractRunner.Priority</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#priority">priority</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reloadConfiguration">reloadConfiguration</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeAction">removeAction</a> (self, QString id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#run">run</a> (self, <a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext</a> context, <a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> match)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[KSharedPtr<KService>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#serviceQuery">serviceQuery</a> (self, QString serviceType, QString constraint=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDefaultSyntax">setDefaultSyntax</a> (self, <a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a> syntax)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setHasRunOptions">setHasRunOptions</a> (self, bool hasRunOptions)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setIgnoredTypes">setIgnoredTypes</a> (self, <a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext.Types</a> types)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPriority">setPriority</a> (self, <a href="../plasma/Plasma.AbstractRunner.html#Priority">Plasma.AbstractRunner.Priority</a> newPriority)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSpeed">setSpeed</a> (self, <a href="../plasma/Plasma.AbstractRunner.html#Speed">Plasma.AbstractRunner.Speed</a> newSpeed)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSyntaxes">setSyntaxes</a> (self, [<a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a>] syns)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../plasma/Plasma.AbstractRunner.html#Speed">Plasma.AbstractRunner.Speed</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#speed">speed</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#suspendMatching">suspendMatching</a> (self, bool suspend)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#syntaxes">syntaxes</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QMutex </td><td class="memItemRight" valign="bottom"><a class="el" href="#bigLock">bigLock</a> ()</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="matchingSuspended"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> matchingSuspended</td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>suspended</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted when the runner enters or exits match suspension
<dl class="see" compact><dt><b>See also:</b></dt><dd> matchingSuspended
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("matchingSuspended(bool)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="prepare"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> prepare</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This signal is emitted when matching is about to commence, giving runners
an opportunity to prepare themselves, e.g. loading data sets or preparing
IPC or network connections. This method should be fast so as not to cause
slow downs. Things that take longer or which should be loaded once and
remain extant for the lifespan of the AbstractRunner should be done in init().
<dl class="see" compact><dt><b>See also:</b></dt><dd> init()
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("prepare()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="teardown"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> teardown</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>This signal is emitted when a session of matches is complete, giving runners
the opportunity to tear down anything set up as a result of the prepare()
method.
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("teardown()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="AbstractRunner"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </td>
<td class="paramname"><em>parent=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>path=QString()</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="AbstractRunner"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[QVariant] </td>
<td class="paramname"><em>args</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="AbstractRunner"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">KSharedPtr<KService> </td>
<td class="paramname"><em>service</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </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"></div></div><a class="anchor" name="action"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QAction action</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>id</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the action associated with the id
</p></div></div><a class="anchor" name="actions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">{QString:QAction} actions</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns all registered actions
</p></div></div><a class="anchor" name="actionsForMatch"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[QAction] actionsForMatch</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> </td>
<td class="paramname"><em>match</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>A given match can have more than action that can be performed on it.
For example, a song match returned by a music player runner can be queued,
added to the playlist, or played.
</p>
<p>
Call this method to add actions that can be performed by the runner.
Actions must first be added to the runner's action registry.
Note: execution of correct action is left up to the runner.
</p></div></div><a class="anchor" name="addAction"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QAction addAction</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QIcon </td>
<td class="paramname"><em>icon</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Adds an action to the runner's action registry.
</p>
<p>
The QAction must be created within the GUI thread;
do not create it within the match method of AbstractRunner.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>id</em> </td><td> A unique identifier string
<tr><td></td><td valign="top"><em>action</em> </td><td> The QAction to be stored
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="addAction"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addAction</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QAction </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>Adds an action to the runner's action registry.
</p>
<p>
The QAction must be created within the GUI thread;
do not create it within the match method of AbstractRunner.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>id</em> </td><td> A unique identifier string
<tr><td></td><td valign="top"><em>action</em> </td><td> The QAction to be stored
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="addSyntax"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> addSyntax</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a> </td>
<td class="paramname"><em>syntax</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Adds a registered syntax that this runner understands. This is used to
display to the user what this runner can understand and how it can be
used.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>syntax</em> </td><td> the syntax to register
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="clearActions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> clearActions</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Clears the action registry.
The action pool deletes the actions.
</p></div></div><a class="anchor" name="config"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Provides access to the runner's configuration object.
</p></div></div><a class="anchor" name="createRunOptions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> createRunOptions</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>If hasRunOptions() returns true, this method may be called to get
a widget displaying the options the user can interact with to modify
the behaviour of what happens when a given match is selected.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>widget</em> </td><td> the parent of the options widgets.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="dataEngine"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.DataEngine.html">Plasma.DataEngine</a> dataEngine</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>name</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Loads the given DataEngine
</p>
<p>
Tries to load the data engine given by <b>name.</b> Each engine is
only loaded once, and that instance is re-used on all subsequent
requests.
</p>
<p>
If the data engine was not found, an invalid data engine is returned
(see DataEngine.isValid()).
</p>
<p>
Note that you should <em>not</em> delete the returned engine.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> Name of the data engine to load
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> pointer to the data engine if it was loaded,
or an invalid data engine if the requested engine
could not be loaded
</dd></dl> </p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="defaultSyntax"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a> defaultSyntax</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the default syntax for the runner or 0 if no default syntax has been defined
</dd></dl> </p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="description"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString description</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the description of this Runner
</dd></dl>
</p></div></div><a class="anchor" name="hasRunOptions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasRunOptions</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>If the runner has options that the user can interact with to modify
what happens when run or one of the actions created in match
is called, the runner should return true
</p></div></div><a class="anchor" name="icon"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QIcon icon</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the icon for this Runner
</dd></dl>
</p></div></div><a class="anchor" name="id"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString id</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> an id string for the Runner
</dd></dl>
</p></div></div><a class="anchor" name="ignoredTypes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext.Types</a> ignoredTypes</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the OR'ed value of all the Information types (as defined in RunnerContext.Type)
this runner is not interested in.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> OR'ed value of black listed types
</dd></dl>
</p></div></div><a class="anchor" name="init"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> init</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Reimplement this slot to run any initialization routines on first load.
By default, it calls reloadConfiguration(); for scripted Runners this
method also sets up the ScriptEngine.
</p></div></div><a class="anchor" name="isMatchingSuspended"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isMatchingSuspended</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the runner is currently busy with non-interuptable work, signaling that
new threads should not be created for it at this time
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><a class="anchor" name="match"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> match</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext</a> </td>
<td class="paramname"><em>context</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This is the main query method. It should trigger creation of
QueryMatch instances through RunnerContext.addMatch and
RunnerContext.addMatches. It is called internally by performMatch().
</p>
<p>
If the runner can run precisely the requested term (RunnerContext.query()),
it should create an exact match by setting the type to RunnerContext.ExactMatch.
The first runner that creates a QueryMatch will be the
default runner. Other runner's matches will be suggested in the
interface. Non-exact matches should be offered via RunnerContext.PossibleMatch.
</p>
<p>
The match will be activated via run() if the user selects it.
</p>
<p>
Each runner is executed in its own thread. Whenever the user input changes this
method is called again. Thus, it needs to be thread-safe. Also, all matches need
to be reported once this method returns. Asynchronous runners therefore need
to make use of a local event loop to wait for all matches.
</p>
<p>
It is recommended to use local status data in async runners. The simplest way is
to have a separate class doing all the work like so:
</p>
<p>
<pre class="fragment">
void MyFancyAsyncRunner.match( RunnerContext& context )
{
QEventLoop loop;
MyAsyncWorker worker( context );
connect( &worker, SIGNAL(finished()),
&loop, SLOT(quit()) );
worker.work();
loop.exec();
}
</pre>
</p>
<p>
Here MyAsyncWorker creates all the matches and calls RunnerContext.addMatch
in some internal slot. It emits the finished() signal once done which will
quit the loop and make the match() method return. The local status is kept
entirely in MyAsyncWorker which makes match() trivially thread-safe.
</p>
<p>
If a particular match supports multiple actions, set up the corresponding
actions in the actionsForMatch method. Do not call any of the action methods
within this method!
</p>
<p>
Execution of the correct action should be handled in the run method.
@caution This method needs to be thread-safe since KRunner will simply
start a new thread for each new term.
</p>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> Returning from this method means to end execution of the runner.
</dd></dl> </p>
<p>
@sa run(), RunnerContext.addMatch, RunnerContext.addMatches, QueryMatch
</p></div></div><a class="anchor" name="mimeDataForMatch"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QMimeData mimeDataForMatch</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> </td>
<td class="paramname"><em>match</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Reimplement this slot if you want your runner
to support serialization and drag and drop
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.5
</dd></dl>
</p></div></div><a class="anchor" name="name"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString name</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the user visible engine name for the Runner
</dd></dl>
</p></div></div><a class="anchor" name="package"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.Package.html">Plasma.Package</a> package</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Accessor for the associated Package object if any.
</p>
<p>
Note that the returned pointer is only valid for the lifetime of
the runner.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the Package object, or 0 if none
</dd></dl>
</p></div></div><a class="anchor" name="performMatch"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> performMatch</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext</a> </td>
<td class="paramname"><em>context</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Triggers a call to match. This will call match() internally.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>context</em> </td><td> the search context used in executing this match.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="priority"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.AbstractRunner.html#Priority">Plasma.AbstractRunner.Priority</a> priority</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The priority of the runner.
<dl class="see" compact><dt><b>See also:</b></dt><dd> setPriority
</dd></dl>
</p></div></div><a class="anchor" name="reloadConfiguration"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> reloadConfiguration</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Signal runner to reload its configuration.
</p></div></div><a class="anchor" name="removeAction"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> removeAction</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>id</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Removes the action from the action registry.
AbstractRunner deletes the action once removed.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>id</em> </td><td> The id of the action to be removed
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="run"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> run</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext</a> </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.QueryMatch.html">Plasma.QueryMatch</a> </td>
<td class="paramname"><em>match</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Called whenever an exact or possible match associated with this
runner is triggered.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>context</em> </td><td> The context in which the match is triggered, i.e. for which
the match was created.
<tr><td></td><td valign="top"><em>match</em> </td><td> The actual match to run/execute.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="serviceQuery"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[KSharedPtr<KService>] serviceQuery</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>serviceType</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>constraint=QString()</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>
A blocking method to do queries of installed Services which can provide
a measure of safety for runners running their own threads. This should
be used instead of calling KServiceTypeTrader.query(..) directly.
</dd></dl> </p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>serviceType</em> </td><td> a service type like "Plasma/Applet" or "KFilePlugin"
<tr><td></td><td valign="top"><em>constraint</em> </td><td> a constraint to limit the choices returned.
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KServiceTypeTrader.query(const QString&, const QString&)
</dd></dl> </p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a list of services that satisfy the query.
</dd></dl>
</p></div></div><a class="anchor" name="setDefaultSyntax"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setDefaultSyntax</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a> </td>
<td class="paramname"><em>syntax</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set <b>syntax</b> as the default syntax for the runner; the default syntax will be
substituted to the empty query in single runner mode. This is also used to
display to the user what this runner can understand and how it can be
used.
The default syntax is automatically added to the list of registered syntaxes, there
is no need to add it using addSyntax.
Note that there can be only one default syntax; if called more than once, the last
call will determine the default syntax.
A default syntax (even trivial) is required to advertise single runner mode
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>syntax</em> </td><td> the syntax to register and to set as default
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="setHasRunOptions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setHasRunOptions</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>hasRunOptions</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets whether or not the runner has options for matches
</p></div></div><a class="anchor" name="setIgnoredTypes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setIgnoredTypes</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.RunnerContext.html">Plasma.RunnerContext.Types</a> </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>Sets the types this runner will ignore
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>types</em> </td><td> OR'ed listed of ignored types
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setPriority"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPriority</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.AbstractRunner.html#Priority">Plasma.AbstractRunner.Priority</a> </td>
<td class="paramname"><em>newPriority</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the priority of the runner. Lower priority runners are executed
only after higher priority runners.
</p></div></div><a class="anchor" name="setSpeed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSpeed</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../plasma/Plasma.AbstractRunner.html#Speed">Plasma.AbstractRunner.Speed</a> </td>
<td class="paramname"><em>newSpeed</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the nominal speed of the runner. Only slow runners need
to call this within their constructor because the default
speed is NormalSpeed. Runners that use DBUS should call
this within their constructors.
</p></div></div><a class="anchor" name="setSyntaxes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSyntaxes</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">[<a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a>] </td>
<td class="paramname"><em>syns</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the list of syntaxes; passing in an empty list effectively clears
the syntaxes.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>the</em> </td><td> syntaxes to register for this runner
</td></tr> </table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><a class="anchor" name="speed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../plasma/Plasma.AbstractRunner.html#Speed">Plasma.AbstractRunner.Speed</a> speed</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The nominal speed of the runner.
<dl class="see" compact><dt><b>See also:</b></dt><dd> setSpeed
</dd></dl>
</p></div></div><a class="anchor" name="suspendMatching"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> suspendMatching</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>suspend</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets whether or not the runner is available for match requests. Useful to
prevent more thread spawning when the thread is in a busy state.
</p></div></div><a class="anchor" name="syntaxes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../plasma/Plasma.RunnerSyntax.html">Plasma.RunnerSyntax</a>] syntaxes</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the syntaxes the runner has registered that it accepts and understands
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="bigLock"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QMutex bigLock</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Access to a shared lock that all runners (and code that manages/interacts with them)
can share to protect access to non-thread-safe shared code or data.
Access of KSycoca records, for instance, is one place this lock should be used.
</p>
<p>
Common usage:
</p>
<p>
{
QMutexLocker lock(bigLock());
.. do something that isn't thread safe ..
}
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Priority"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Priority</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Specifies a priority for the runner
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>LowestPriority</em> = 0</td><td><tr><td valign="top"><em>LowPriority</em> </td><td><tr><td valign="top"><em>NormalPriority</em> </td><td><tr><td valign="top"><em>HighPriority</em> </td><td><tr><td valign="top"><em>HighestPriority</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="Speed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Speed</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Specifies a nominal speed for the runner
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>SlowSpeed</em> </td><td><tr><td valign="top"><em>NormalSpeed</em> </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="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</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>
|
