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
|
<?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>KIO.NetAccess</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>NetAccess Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
Inherits: QObject<br />
Namespace: <a href="../kio/KIO.html">KIO</a><br />
<h2>Detailed Description</h2>
<p>Net Transparency.
</p>
<p>
NetAccess allows you to do simple file operation (load, save,
copy, delete...) without working with KIO.Job directly.
Whereas a KIO.Job is asynchronous, meaning that the
developer has to connect slots for it, KIO.NetAccess provides
synchronous downloads and uploads, as well as temporary file
creation and removal. The functions appear to be blocking,
but the Qt event loop continues running while the operations
are handled. More precisely, the GUI will still repaint, but no user
interaction will be possible. If you can, please use async KIO jobs instead!
See the documentation of KJob.exec() for more about the dangers of NetAccess.
</p>
<p>
This class isn't meant to be used as a class but only as a simple
namespace for static functions, though an instance of the class
is built for internal purposes. TODO KDE5: turn into namespace,
and make the qobject class private.
</p>
<p>
Port to kio done by David Faure, faure@kde.org
</p>
<p>
Provides a blocking interface to KIO file operations.
</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="#StatSide">StatSide</a> </td><td class="memItemRight" valign="bottom">{ SourceSide, DestinationSide }</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="#leaveModality">leaveModality</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="#NetAccess">__init__</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#copy">copy</a> (<a href="../kdecore/KUrl.html">KUrl</a> src, <a href="../kdecore/KUrl.html">KUrl</a> target, QWidget window=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#del">del_</a> (<a href="../kdecore/KUrl.html">KUrl</a> url, QWidget window)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#dircopy">dircopy</a> (<a href="../kdecore/KUrl.html">KUrl</a> src, <a href="../kdecore/KUrl.html">KUrl</a> target, QWidget window)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#dircopy">dircopy</a> (<a href="../kdecore/KUrl.List.html">KUrl.List</a> src, <a href="../kdecore/KUrl.html">KUrl</a> target, QWidget window=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#download">download</a> (<a href="../kdecore/KUrl.html">KUrl</a> src, QString target, QWidget window)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#exists">exists</a> (<a href="../kdecore/KUrl.html">KUrl</a> url, bool source, QWidget window)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#exists">exists</a> (<a href="../kdecore/KUrl.html">KUrl</a> url, <a href="../kio/KIO.NetAccess.html#StatSide">KIO.NetAccess.StatSide</a> statSide, QWidget window)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#file_copy">file_copy</a> (<a href="../kdecore/KUrl.html">KUrl</a> src, <a href="../kdecore/KUrl.html">KUrl</a> target, QWidget window=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#fish_execute">fish_execute</a> (<a href="../kdecore/KUrl.html">KUrl</a> url, QString command, QWidget window)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#lastError">lastError</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#lastErrorString">lastErrorString</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimetype">mimetype</a> (<a href="../kdecore/KUrl.html">KUrl</a> url, QWidget window)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#mkdir">mkdir</a> (<a href="../kdecore/KUrl.html">KUrl</a> url, QWidget window, int permissions=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KUrl.html">KUrl</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mostLocalUrl">mostLocalUrl</a> (<a href="../kdecore/KUrl.html">KUrl</a> url, QWidget window)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#move">move</a> (<a href="../kdecore/KUrl.html">KUrl</a> src, <a href="../kdecore/KUrl.html">KUrl</a> target, QWidget window=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#move">move</a> (<a href="../kdecore/KUrl.List.html">KUrl.List</a> src, <a href="../kdecore/KUrl.html">KUrl</a> target, QWidget window=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#removeTempFile">removeTempFile</a> (QString name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#stat">stat</a> (<a href="../kdecore/KUrl.html">KUrl</a> url, <a href="../kio/KIO.UDSEntry.html">KIO.UDSEntry</a> entry, QWidget window)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#synchronousRun">synchronousRun</a> (<a href="../kio/KIO.Job.html">KIO.Job</a> job, QWidget window, QByteArray data=0, <a href="../kdecore/KUrl.html">KUrl</a> finalURL=0, {QString:QString} metaData=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#upload">upload</a> (QString src, <a href="../kdecore/KUrl.html">KUrl</a> target, QWidget window)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="leaveModality"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> leaveModality</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("leaveModality()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="NetAccess"></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>Private constructor
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="copy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool copy</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window=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="del"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool del_</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Deletes a file or a directory in a synchronous way.
</p>
<p>
This is a convenience function for KIO.del
(it saves creating a slot and testing for the job result).
</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>url</em> </td><td> The file or directory to delete.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, false on failure.
</dd></dl>
</p></div></div><a class="anchor" name="dircopy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool dircopy</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Overloaded method, which takes a list of source URLs
</p></div></div><a class="anchor" name="dircopy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool dircopy</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.List.html">KUrl.List</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Overloaded method, which takes a list of source URLs
</p></div></div><a class="anchor" name="download"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool download</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Downloads a file from an arbitrary URL (@p src) to a
temporary file on the local filesystem (@p target).
</p>
<p>
If the argument
for <b>target</b> is an empty string, download will generate a
unique temporary filename in /tmp. Since <b>target</b> is a reference
to QString you can access this filename easily. Download will
return true if the download was successful, otherwise false.
</p>
<p>
Special case:
If the URL is of kind file:, then no downloading is
processed but the full filename is returned in <b>target.</b>
That means you <b>have</b> to take care about the <b>target</b> argument.
(This is very easy to do, please see the example below.)
</p>
<p>
Download is synchronous. That means you can use it like this:
(assuming your application has a loadFile() function)
</p>
<p>
<pre class="fragment">
QString tmpFile;
if( KIO.NetAccess.download(url, tmpFile, window)) {
loadFile(tmpFile);
KIO.NetAccess.removeTempFile(tmpFile);
} else {
KMessageBox.error(this, KIO.NetAccess.lastErrorString());
}
</pre>
</p>
<p>
Of course, your user interface will still process exposure/repaint
events during the download.
</p>
<p>
If the download fails, lastError() and lastErrorString() will be set.
</p>
<p>
If the url is always remote, then you could also just write the more usual way:
<pre class="fragment">
KTemporaryFile tmpFile;
if (tmpFile.open()) {
KIO.Job* getJob = KIO.file_copy(url, KUrl(tmpFile.fileName()), -1, KIO.Overwrite | KIO.HideProgressInfo);
getJob->ui()->setWindow(window);
if (KIO.NetAccess.synchronousRun(getJob, 0)) {
loadFile(tmpFile.fileName());
} else {
getJob->ui()->showErrorMessage();
}
}
</pre>
</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>src</em> </td><td> URL Reference to the file to download.
<tr><td></td><td valign="top"><em>target</em> </td><td> String containing the final local location of the
file. If you insert an empty string, it will
return a location in a temporary spot. <B>Note:</B>
you are responsible for the removal of this file when
you are finished reading it using removeTempFile.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, false for failure. Use lastErrorString() to
get the reason it failed.
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> lastErrorString()
</dd></dl>
</p></div></div><a class="anchor" name="exists"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool exists</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>source</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Tests whether a URL exists.
</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>url</em> </td><td> the URL we are testing
<tr><td></td><td valign="top"><em>statSide</em> </td><td> determines if we want to read or write.
IMPORTANT: see documentation for KIO.stat for more details about this.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the URL exists and we can do the operation specified by
</dd></dl> <b>source,</b> false otherwise
</p></div></div><a class="anchor" name="exists"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool exists</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.NetAccess.html#StatSide">KIO.NetAccess.StatSide</a> </td>
<td class="paramname"><em>statSide</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Tests whether a URL exists.
</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>url</em> </td><td> the URL we are testing
<tr><td></td><td valign="top"><em>statSide</em> </td><td> determines if we want to read or write.
IMPORTANT: see documentation for KIO.stat for more details about this.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the URL exists and we can do the operation specified by
</dd></dl> <b>source,</b> false otherwise
</p></div></div><a class="anchor" name="file_copy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool file_copy</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Alternative to upload for copying over the network.
Overwrite is false, so this will fail if <b>target</b> exists.
</p>
<p>
This one takes two URLs and is a direct equivalent of KIO.file_copy.
</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>src</em> </td><td> URL Referencing the file to upload.
<tr><td></td><td valign="top"><em>target</em> </td><td> URL containing the final location of the file.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be cached
only for a short duration after which the user will again be
prompted for passwords as needed.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, false for failure
</dd></dl>
</p></div></div><a class="anchor" name="fish_execute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString fish_execute</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Executes a remote process via the fish ioslave in a synchronous way.
</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>url</em> </td><td> The remote machine where the command should be executed.
e.g. fish://someuser\@somehost:sshport/
some special cases exist.
fish://someuser\@localhost/
will use su instead of ssh to connect and execute the command.
fish://someuser\@localhost:port/
will use ssh to connect and execute the command.
<tr><td></td><td valign="top"><em>command</em> </td><td> The command to be executed.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The resulting output of the <b>command</b> that is executed.
</dd></dl>
</p></div></div><a class="anchor" name="lastError"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int lastError</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the error code for the last job, in case it failed.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the last error code
</dd></dl>
</p></div></div><a class="anchor" name="lastErrorString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString lastErrorString</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the error string for the last job, in case it failed.
Note that this is already translated.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the last error string, or QString()
</dd></dl>
</p></div></div><a class="anchor" name="mimetype"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString mimetype</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Determines the mimetype of a given URL.
</p>
<p>
This is a convenience function for KIO.mimetype. You
should call this only when really necessary.
KMimeType.findByUrl can determine extension a lot faster, but
less reliably for remote files. Only when findByUrl() returns
unknown (application/octet-stream) then this one should 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>url</em> </td><td> The URL whose mimetype we are interested in.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The mimetype name.
</dd></dl>
</p></div></div><a class="anchor" name="mkdir"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool mkdir</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>permissions=-1</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 directory in a synchronous way.
</p>
<p>
This is a convenience function for <b>KIO.mkdir</b>
(it saves creating a slot and testing for the job result).
</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>url</em> </td><td> The directory to create.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
<tr><td></td><td valign="top"><em>permissions</em> </td><td> directory permissions.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, false on failure.
</dd></dl>
</p></div></div><a class="anchor" name="mostLocalUrl"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KUrl.html">KUrl</a> mostLocalUrl</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Tries to map a local URL for the given URL.
</p>
<p>
This is a convenience function for KIO.stat + parsing the
resulting UDSEntry.
</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>url</em> </td><td> The URL we are testing.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a local URL corresponding to the same resource than the
original URL, or the original URL if no local URL can be mapped
</dd></dl>
</p></div></div><a class="anchor" name="move"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool move</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Full-fledged equivalent of KIO.move.
Moves or renames a list of files or directories.
<dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> use KIO.move and then KIO.NetAccess.synchronousRun (or job->exec())
</dd></dl>
</p></div></div><a class="anchor" name="move"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool move</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.List.html">KUrl.List</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Full-fledged equivalent of KIO.move.
Moves or renames a list of files or directories.
<dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> use KIO.move and then KIO.NetAccess.synchronousRun (or job->exec())
</dd></dl>
</p></div></div><a class="anchor" name="removeTempFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> removeTempFile</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>Removes the specified file if and only if it was created
by KIO.NetAccess as a temporary file for a former download.
</p>
<p>
Note: This means that if you created your temporary with KTempFile,
use KTempFile.unlink() or KTempFile.setAutoDelete() to have
it 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>name</em> </td><td> Path to temporary file to remove. May not be
empty.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="stat"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool stat</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.UDSEntry.html">KIO.UDSEntry</a> </td>
<td class="paramname"><em>entry</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Tests whether a URL exists and return information on it.
</p>
<p>
This is a convenience function for KIO.stat
(it saves creating a slot and testing for the job result).
</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>url</em> </td><td> The URL we are testing.
<tr><td></td><td valign="top"><em>entry</em> </td><td> The result of the stat. Iterate over the list
of atoms to get hold of name, type, size, etc., or use KFileItem.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, false for failure
</dd></dl>
</p></div></div><a class="anchor" name="synchronousRun"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool synchronousRun</td>
<td>(</td>
<td class="paramtype"><a href="../kio/KIO.Job.html">KIO.Job</a> </td>
<td class="paramname"><em>job</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QByteArray </td>
<td class="paramname"><em>data=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>finalURL=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">{QString:QString} </td>
<td class="paramname"><em>metaData=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This function executes a job in a synchronous way.
If a job fetches some data, pass a QByteArray pointer as data parameter to this function
and after the function returns it will contain all the data fetched by this job.
</p>
<p>
<pre class="fragment">
KIO.Job *job = KIO.get( url );
QMap<QString, QString> metaData;
metaData.insert( "PropagateHttpHeader", "true" );
if ( NetAccess.synchronousRun( job, 0, &data, &url, &metaData ) ) {
QString responseHeaders = metaData[ "HTTP-Headers" ];
kDebug()<<"Response header = "<< responseHeaders;
}
</pre>
</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> job which the function will run. Note that after this function
finishes running, job is deleted and you can't access it anymore!
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be
cached only for a short duration after which the user will
again be prompted for passwords as needed.
<tr><td></td><td valign="top"><em>data</em> </td><td> if passed and relevant to this job then it will contain the data
that was fetched by the job
<tr><td></td><td valign="top"><em>finalURL</em> </td><td> if passed will contain the final url of this job (it might differ
from the one it was created with if there was a redirection)
<tr><td></td><td valign="top"><em>metaData</em> </td><td> you can pass a pointer to the map with meta data you wish to
set on the job. After the job finishes this map will hold all the
meta data from the job.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, false on failure.
</dd></dl>
</p></div></div><a class="anchor" name="upload"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool upload</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>window</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Uploads file <b>src</b> to URL <b>target.</b>
</p>
<p>
Both must be specified, unlike download.
Note that this is assumed to be used for saving a file over
the network, so overwriting is set to true. This is not the
case with copy.
</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>src</em> </td><td> URL Referencing the file to upload.
<tr><td></td><td valign="top"><em>target</em> </td><td> URL containing the final location of the file.
<tr><td></td><td valign="top"><em>window</em> </td><td> main window associated with this job. This is used to
automatically cache and discard authentication information
as needed. If NULL, authentication information will be cached
only for a short duration after which the user will again be
prompted for passwords as needed.
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if successful, false for failure
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="StatSide"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">StatSide</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>SourceSide</em> </td><td><tr><td valign="top"><em>DestinationSide</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>
|
