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
|
<?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>KJob</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.7 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>KJob Class Reference</h1>
<code>from PyKDE4.kdecore import *</code>
<p>
Inherits: QObject<br />
<h2>Detailed Description</h2>
<p>The base class for all jobs.
For all jobs created in an application, the code looks like
</p>
<p>
<pre class="fragment">
void SomeClass.methodWithAsynchronousJobCall()
{
KJob * job = someoperation( some parameters );
connect( job, SIGNAL( result( KJob * ) ),
this, SLOT( handleResult( KJob * ) ) );
job->start();
}
</pre>
(other connects, specific to the job)
</p>
<p>
And handleResult is usually at least:
</p>
<p>
<pre class="fragment">
void SomeClass.handleResult( KJob *job )
{
if ( job->error() )
doSomething();
}
</pre>
</p>
<p>
With the synchronous interface the code looks like
</p>
<p>
<pre class="fragment">
void SomeClass.methodWithSynchronousJobCall()
{
KJob *job = someoperation( some parameters );
if ( !job->exec() )
{
// An error occurred
}
else
{
// Do something
}
}
</pre>
</p>
<p>
@note: KJob and its subclasses is meant to be used
in a fire-and-forget way. It's deleting itself when
it has finished using deleteLater() so the job
instance disappears after the next event loop run.
</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="#obj1247217772"><anonymous></a> </td><td class="memItemRight" valign="bottom">{ NoError, KilledJobError, UserDefinedError }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Capability">Capability</a> </td><td class="memItemRight" valign="bottom">{ NoCapabilities, Killable, Suspendable }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#KillVerbosity">KillVerbosity</a> </td><td class="memItemRight" valign="bottom">{ Quietly, EmitResult }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Unit">Unit</a> </td><td class="memItemRight" valign="bottom">{ Bytes, Files, Directories }</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="#description">description</a> (<a href="../kdecore/KJob.html">KJob</a> job, QString title, (QString,QString) field1=qMakePair(QString(),QString()), (QString,QString) field2=qMakePair(QString(),QString()))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#infoMessage">infoMessage</a> (<a href="../kdecore/KJob.html">KJob</a> job, QString plain, QString rich=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#result">result</a> (<a href="../kdecore/KJob.html">KJob</a> job)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#warning">warning</a> (<a href="../kdecore/KJob.html">KJob</a> job, QString plain, QString rich=QString())</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="#KJob">__init__</a> (self, QObject parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KJob.html">KJob.Capabilities</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#capabilities">capabilities</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#doKill">doKill</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#doResume">doResume</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#doSuspend">doSuspend</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#emitPercent">emitPercent</a> (self, long processedAmount, long totalAmount)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#emitResult">emitResult</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#emitSpeed">emitSpeed</a> (self, long speed)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#error">error</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#errorString">errorString</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#errorText">errorText</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#exec">exec_</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isAutoDelete">isAutoDelete</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isSuspended">isSuspended</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#kill">kill</a> (self, <a href="../kdecore/KJob.html#KillVerbosity">KJob.KillVerbosity</a> verbosity=KJob.Quietly)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#percent">percent</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#processedAmount">processedAmount</a> (self, <a href="../kdecore/KJob.html#Unit">KJob.Unit</a> unit)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#resume">resume</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setAutoDelete">setAutoDelete</a> (self, bool autodelete)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCapabilities">setCapabilities</a> (self, <a href="../kdecore/KJob.html">KJob.Capabilities</a> capabilities)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setError">setError</a> (self, int errorCode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setErrorText">setErrorText</a> (self, QString errorText)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPercent">setPercent</a> (self, long percentage)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setProcessedAmount">setProcessedAmount</a> (self, <a href="../kdecore/KJob.html#Unit">KJob.Unit</a> unit, long amount)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTotalAmount">setTotalAmount</a> (self, <a href="../kdecore/KJob.html#Unit">KJob.Unit</a> unit, long amount)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setUiDelegate">setUiDelegate</a> (self, <a href="../kdecore/KJobUiDelegate.html">KJobUiDelegate</a> delegate)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#start">start</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#suspend">suspend</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#totalAmount">totalAmount</a> (self, <a href="../kdecore/KJob.html#Unit">KJob.Unit</a> unit)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KJobUiDelegate.html">KJobUiDelegate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#uiDelegate">uiDelegate</a> (self)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="description"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> description</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td>
<td class="paramname"><em>job</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>title</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">(QString,QString) </td>
<td class="paramname"><em>field1=qMakePair(QString(),QString())</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">(QString,QString) </td>
<td class="paramname"><em>field2=qMakePair(QString(),QString())</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted to display general description of this job. A description has
a title and two optional fields which can be used to complete the
description.
</p>
<p>
Examples of titles are "Copying", "Creating resource", etc.
The fields of the description can be "Source" with an URL, and,
"Destination" with an URL for a "Copying" description.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>job</em> </td><td> the job that emitted this signal
<tr><td></td><td valign="top"><em>title</em> </td><td> the general description of the job
<tr><td></td><td valign="top"><em>field1</em> </td><td> first field (localized name and value)
<tr><td></td><td valign="top"><em>field2</em> </td><td> second field (localized name and value)
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("description(KJob*, const QString&, const QPair<QString,QString>&, const QPair<QString,QString>&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="infoMessage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> infoMessage</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td>
<td class="paramname"><em>job</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>plain</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>rich=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted to display state information about this job.
Examples of message are "Resolving host", "Connecting to host...", etc.
</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>job</em> </td><td> the job that emitted this signal
<tr><td></td><td valign="top"><em>plain</em> </td><td> the info message
<tr><td></td><td valign="top"><em>rich</em> </td><td> the rich text version of the message, or QString() is none is available
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("infoMessage(KJob*, const QString&, const QString&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="result"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> result</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td>
<td class="paramname"><em>job</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 job is finished (except when killed with KJob.Quietly).
</p>
<p>
Use error to know if the job was finished with error.
</p>
<p>
This is a private signal, it can't be emitted directly by subclasses of
KJob, use emitResult() instead.
</p>
<p>
Please connect to this signal instead of finished.
</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>job</em> </td><td> the job that emitted this signal
</td></tr>
</table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> kill
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("result(KJob*)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="warning"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> warning</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KJob.html">KJob</a> </td>
<td class="paramname"><em>job</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>plain</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>rich=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Emitted to display a warning about this job.
</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>job</em> </td><td> the job that emitted this signal
<tr><td></td><td valign="top"><em>plain</em> </td><td> the warning message
<tr><td></td><td valign="top"><em>rich</em> </td><td> the rich text version of the message, or QString() is none is available
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("warning(KJob*, const QString&, const QString&)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KJob"></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></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a new KJob object.
</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>parent</em> </td><td> the parent QObject
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="capabilities"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KJob.html">KJob.Capabilities</a> capabilities</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 capabilities of this job.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the capabilities that this job supports
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setCapabilities()
</dd></dl>
</p></div></div><a class="anchor" name="doKill"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool doKill</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>Aborts this job quietly.
This simply kills the job, no error reporting or job deletion should be involved.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the operation is supported and succeeded, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="doResume"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool doResume</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>Resumes this job.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the operation is supported and succeeded, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="doSuspend"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool doSuspend</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>Suspends this job.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the operation is supported and succeeded, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="emitPercent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> emitPercent</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">long </td>
<td class="paramname"><em>processedAmount</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>totalAmount</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Utility function for inherited jobs.
Emits the percent signal if bigger than previous value,
after calculating it from the parameters.
</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>processedAmount</em> </td><td> the processed amount
<tr><td></td><td valign="top"><em>totalAmount</em> </td><td> the total amount
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> percent()
</dd></dl>
</p></div></div><a class="anchor" name="emitResult"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> emitResult</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>Utility function to emit the result signal, and suicide this job.
It first notifies the observers to hide the progress for this job using
the finished() signal.
</p>
<p>
@note: Deletes this job using deleteLater().
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> result()
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> finished()
</dd></dl>
</p></div></div><a class="anchor" name="emitSpeed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> emitSpeed</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">long </td>
<td class="paramname"><em>speed</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Utility function for inherited jobs.
Emits the speed signal and starts the timer for removing that info
</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>speed</em> </td><td> the speed in bytes/s
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="error"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int error</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 error code, if there has been an error.
Only call this method from the slot connected to result().
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the error code for this job, 0 if no error.
</dd></dl>
</p></div></div><a class="anchor" name="errorString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString errorString</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>Converts an error code and a non-i18n error message into an
error message in the current language. The low level (non-i18n)
error message (usually a url) is put into the translated error
message using %1.
</p>
<p>
Example for errid == ERR_CANNOT_OPEN_FOR_READING:
<pre class="fragment">
i18n( "Could not read\n%1" , errorText() );
</pre>
Only call if error is not 0.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the error message and if there is no error, a message
telling the user that the app is broken, so check with
error() whether there is an error
</dd></dl>
</p></div></div><a class="anchor" name="errorText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString errorText</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 error text if there has been an error.
Only call if error is not 0.
This is really internal, better use errorString.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a string to help understand the error, usually the url
related to the error. Only valid if error() is not 0.
</dd></dl>
</p></div></div><a class="anchor" name="exec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool exec_</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>Executes the job synchronously.
</p>
<p>
This will start a nested QEventLoop internally. Nested event loop can be dangerous and
can have unintended side effects, you should avoid calling exec() whenever you can and use the
asynchronous interface of KJob instead.
</p>
<p>
Should you indeed call this method, you need to make sure that all callers are reentrant,
so that events delivered by the inner event loop don't cause non-reentrant functions to be
called, which usually wreaks havoc.
</p>
<p>
Note that the event loop started by this method does not process user input events, which means
your user interface will effectivly be blocked. Other events like paint or network events are
still being processed. The advantage of not processing user input events is that the chance of
accidental reentrancy is greatly reduced. Still you should avoid calling this function.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the job has been executed without error, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="isAutoDelete"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isAutoDelete</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 whether this job automatically deletes itself once
the job is finished.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> whether the job is deleted automatically after
finishing.
</dd></dl>
</p></div></div><a class="anchor" name="isSuspended"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isSuspended</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 if the job was suspended with the suspend() call.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> if the job was suspended
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> suspend() resume()
</dd></dl>
</p></div></div><a class="anchor" name="kill"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool kill</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="../kdecore/KJob.html#KillVerbosity">KJob.KillVerbosity</a> </td>
<td class="paramname"><em>verbosity=KJob.Quietly</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Aborts this job.
This kills and deletes the job.
</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>verbosity</em> </td><td> if equals to EmitResult, Job will emit signal result
and ask uiserver to close the progress window.
<b>verbosity</b> is set to EmitResult for subjobs. Whether applications
should call with Quietly or EmitResult depends on whether they rely
on result being emitted or not. Please notice that if <b>verbosity</b> is
set to Quietly, signal result will NOT be emitted.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the operation is supported and succeeded, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="percent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long percent</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>Progress signal showing the overall progress of the job
This is valid for any kind of job, and allows using a
a progress bar very easily. (see KProgressBar).
Note that this signal is not emitted for finished jobs.
</p>
<p>
This is a private signal, it can't be emitted directly by subclasses of
KJob, use emitPercent(), setPercent() setTotalAmount() or
setProcessedAmount() instead.
</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>job</em> </td><td> the job that emitted this signal
<tr><td></td><td valign="top"><em>percent</em> </td><td> the percentage
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="processedAmount"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long processedAmount</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="../kdecore/KJob.html#Unit">KJob.Unit</a> </td>
<td class="paramname"><em>unit</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Regularly emitted to show the progress of this job by giving the current amount.
The unit of this amount is sent too. It can be emitted several times if the job
manages several different units.
</p>
<p>
This is a private signal, it can't be emitted directly by subclasses of
KJob, use setProcessedAmount() instead.
</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>job</em> </td><td> the job that emitted this signal
<tr><td></td><td valign="top"><em>unit</em> </td><td> the unit of the processed amount
<tr><td></td><td valign="top"><em>amount</em> </td><td> the processed amount
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="resume"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool resume</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>Resumes this job.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the operation is supported and succeeded, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="setAutoDelete"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setAutoDelete</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>autodelete</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 auto-delete property of the job. If <b>autodelete</b> is
set to false the job will not delete itself once it is finished.
</p>
<p>
The default for any KJob is to automatically delete itself.
</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>autodelete</em> </td><td> set to false to disable automatic deletion
of the job.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setCapabilities"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCapabilities</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="../kdecore/KJob.html">KJob.Capabilities</a> </td>
<td class="paramname"><em>capabilities</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 capabilities for this job.
</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>capabilities</em> </td><td> are the capabilities supported by this job
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> capabilities()
</dd></dl>
</p></div></div><a class="anchor" name="setError"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setError</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">int </td>
<td class="paramname"><em>errorCode</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 error code. It should be called when an error
is encountered in the job, just before calling emitResult().
</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>errorCode</em> </td><td> the error code
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> emitResult()
</dd></dl>
</p></div></div><a class="anchor" name="setErrorText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setErrorText</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>errorText</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 error text. It should be called when an error
is encountered in the job, just before calling emitResult().
</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>errorText</em> </td><td> the error text
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> emitResult()
</dd></dl>
</p></div></div><a class="anchor" name="setPercent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPercent</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">long </td>
<td class="paramname"><em>percentage</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 overall progress of the job. The percent() signal
is emitted if the value changed.
</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>percentage</em> </td><td> the new overall progress
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setProcessedAmount"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setProcessedAmount</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="../kdecore/KJob.html#Unit">KJob.Unit</a> </td>
<td class="paramname"><em>unit</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>amount</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 processed size. The processedAmount() and percent() signals
are emitted if the values changed. The percent() signal is emitted
only for the progress unit.
</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>unit</em> </td><td> the unit of the new processed amount
<tr><td></td><td valign="top"><em>amount</em> </td><td> the new processed amount
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setTotalAmount"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setTotalAmount</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="../kdecore/KJob.html#Unit">KJob.Unit</a> </td>
<td class="paramname"><em>unit</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>amount</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 total size. The totalSize() and percent() signals
are emitted if the values changed. The percent() signal is emitted
only for the progress unit.
</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>unit</em> </td><td> the unit of the new total amount
<tr><td></td><td valign="top"><em>amount</em> </td><td> the new total amount
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setUiDelegate"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setUiDelegate</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="../kdecore/KJobUiDelegate.html">KJobUiDelegate</a> </td>
<td class="paramname"><em>delegate</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Attach a UI delegate to this job.
</p>
<p>
If the job had another UI delegate, it's automatically deleted. Once
attached to the job, the UI delegate will be deleted with the job.
</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>delegate</em> </td><td> the new UI delegate to use
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> KJobUiDelegate
</dd></dl>
</p></div></div><a class="anchor" name="start"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> start</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Starts the job asynchronously. When the job is finished,
result() is emitted.
</p>
<p>
Warning: Never implement any synchronous workload in this method. This method
should just trigger the job startup, not do any work itself. It is expected to
be non-blocking.
</p>
<p>
This is the method all subclasses need to implement.
It should setup and trigger the workload of the job. It should not do any
work itself. This includes all signals and terminating the job, e.g. by
emitResult(). The workload, which could be another method of the
subclass, is to be triggered using the event loop, e.g. by code like:
<pre class="fragment">
void ExampleJob.start()
{
QTimer.singleShot( 0, this, SLOT( doWork() ) );
}
</pre>
</p></div></div><a class="anchor" name="suspend"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool suspend</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>Suspends this job.
The job should be kept in a state in which it is possible to resume it.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the operation is supported and succeeded, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="totalAmount"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long totalAmount</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="../kdecore/KJob.html#Unit">KJob.Unit</a> </td>
<td class="paramname"><em>unit</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 we know the amount the job will have to process. The unit of this
amount is sent too. It can be emitted several times if the job manages several
different units.
</p>
<p>
This is a private signal, it can't be emitted directly by subclasses of
KJob, use setTotalAmount() instead.
</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>job</em> </td><td> the job that emitted this signal
<tr><td></td><td valign="top"><em>unit</em> </td><td> the unit of the total amount
<tr><td></td><td valign="top"><em>amount</em> </td><td> the total amount
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="uiDelegate"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KJobUiDelegate.html">KJobUiDelegate</a> uiDelegate</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>Retrieves the delegate attached to this job.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the delegate attached to this job, or 0 if there's no such delegate
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="obj1247217772"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">anonymous</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>NoError</em> </td><td><tr><td valign="top"><em>KilledJobError</em> </td><td><tr><td valign="top"><em>UserDefinedError</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="Capability"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Capability</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>NoCapabilities</em> = 0x0000</td><td><tr><td valign="top"><em>Killable</em> = 0x0001</td><td><tr><td valign="top"><em>Suspendable</em> = 0x0002</td><td></table>
</dl>
</div></div><p><a class="anchor" name="KillVerbosity"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">KillVerbosity</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>Quietly</em> </td><td><tr><td valign="top"><em>EmitResult</em> </td><td></table>
</dl>
</div></div><p><a class="anchor" name="Unit"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Unit</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>Bytes</em> </td><td><tr><td valign="top"><em>Files</em> </td><td><tr><td valign="top"><em>Directories</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>
|
