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
|
<?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>KProtocolInfo</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>KProtocolInfo Class Reference</h1>
<code>from PyKDE4.kdecore import *</code>
<p>
Inherits: <a href="../kdecore/KSycocaEntry.html">KSycocaEntry</a><br />
<h2>Detailed Description</h2>
<p>\class KProtocolInfo kprotocolinfo.h <KProtocolInfo>
</p>
<p>
Information about I/O (Internet, etc.) protocols supported by KDE.
</p>
<p>
This class is useful if you want to know which protocols
KDE supports. In addition you can find out lots of information
about a certain protocol. A KProtocolInfo instance represents a
single protocol. Most of the functionality is provided by the static
methods that scan the *.protocol files of all installed kioslaves to get
this information.
</p>
<p>
*.protocol files are installed in the "services" resource.
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Torben Weis <weis@kde.org> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#FileNameUsedForCopying">FileNameUsedForCopying</a> </td><td class="memItemRight" valign="bottom">{ Name, FromUrl, DisplayName }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Type">Type</a> </td><td class="memItemRight" valign="bottom">{ T_STREAM, T_FILESYSTEM, T_NONE, T_ERROR }</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="#KProtocolInfo">__init__</a> (self, QDataStream _str, int offset)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KProtocolInfo">__init__</a> (self, QString path)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KProtocolInfo">__init__</a> (self, <a href="../kdecore/KProtocolInfo.html">KProtocolInfo</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#archiveMimeTypes">archiveMimeTypes</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#canDeleteRecursive">canDeleteRecursive</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#canRenameFromFile">canRenameFromFile</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#canRenameToFile">canRenameToFile</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#defaultMimeType">defaultMimeType</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KProtocolInfo.html#FileNameUsedForCopying">KProtocolInfo.FileNameUsedForCopying</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fileNameUsedForCopying">fileNameUsedForCopying</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#supportsListing">supportsListing</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#capabilities">capabilities</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#config">config</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#determineMimetypeFromExtension">determineMimetypeFromExtension</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#docPath">docPath</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#exec">exec_</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[<a href="../kdecore/KProtocolInfo.ExtraField.html">KProtocolInfo.ExtraField</a>] </td><td class="memItemRight" valign="bottom"><a class="el" href="#extraFields">extraFields</a> (<a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#icon">icon</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isFilterProtocol">isFilterProtocol</a> (<a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isFilterProtocol">isFilterProtocol</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isHelperProtocol">isHelperProtocol</a> (<a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isHelperProtocol">isHelperProtocol</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isKnownProtocol">isKnownProtocol</a> (<a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isKnownProtocol">isKnownProtocol</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#maxSlaves">maxSlaves</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#maxSlavesPerHost">maxSlavesPerHost</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#protocolClass">protocolClass</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#protocols">protocols</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#proxiedBy">proxiedBy</a> (QString protocol)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#showFilePreview">showFilePreview</a> (QString protocol)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KProtocolInfo"></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">QDataStream </td>
<td class="paramname"><em>_str</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>offset</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd> construct a KProtocolInfo from a stream
</dd></dl>
</p></div></div><a class="anchor" name="KProtocolInfo"></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">QString </td>
<td class="paramname"><em>path</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Read a protocol description file
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>path</em> </td><td> the path of the description file
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KProtocolInfo"></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"><a href="../kdecore/KProtocolInfo.html">KProtocolInfo</a> </td>
<td class="paramname"><em>other</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="archiveMimeTypes"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList archiveMimeTypes</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="canDeleteRecursive"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool canDeleteRecursive</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="canRenameFromFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool canRenameFromFile</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="canRenameToFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool canRenameToFile</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="defaultMimeType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString defaultMimeType</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="fileNameUsedForCopying"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KProtocolInfo.html#FileNameUsedForCopying">KProtocolInfo.FileNameUsedForCopying</a> fileNameUsedForCopying</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="supportsListing"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool supportsListing</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="capabilities"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList capabilities</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the list of capabilities provided by the kioslave implementing
this protocol.
</p>
<p>
This corresponds to the "Capabilities=" field in the protocol description file.
</p>
<p>
The capability names are not defined globally, they are up to each
slave implementation. For example when adding support for a new
special command for mounting, one would add the string "Mount" to the
capabilities list, and applications could check for that string
before sending a special() command that would otherwise do nothing
on older kioslave implementations.
</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>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the list of capabilities.
</dd></dl>
</p></div></div><a class="anchor" name="config"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString config</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the name of the config file associated with the
specified protocol. This is useful if two similar protocols
need to share a single config file, e.g. http and https.
</p>
<p>
This corresponds to the "config=" field in the protocol description file.
The default is the protocol name, see name()
</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>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the config file, or an empty string if unknown
</dd></dl>
</p></div></div><a class="anchor" name="determineMimetypeFromExtension"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool determineMimetypeFromExtension</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns whether mimetypes can be determined based on extension for this
protocol. For some protocols, e.g. http, the filename extension in the URL
can not be trusted to truly reflect the file type.
</p>
<p>
This corresponds to the "determineMimetypeFromExtension=" field in the protocol description file.
Valid values for this field are "true" (default) or "false".
</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>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the mime types can be determined by extension
</dd></dl>
</p></div></div><a class="anchor" name="docPath"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString docPath</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the documentation path for the specified protocol.
</p>
<p>
This corresponds to the "X-DocPath=" or "DocPath=" field in the protocol description file.
</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>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the docpath of the protocol, or an empty string if unknown
</dd></dl>
</p></div></div><a class="anchor" name="exec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString exec_</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the library / executable to open for the protocol <b>protocol</b>
Example : "kio_ftp", meaning either the executable "kio_ftp" or
the library "kio_ftp.la" (recommended), whichever is available.
</p>
<p>
This corresponds to the "exec=" field in the protocol description file.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the executable of library to open, or QString() for
unsupported protocols
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KUrl.protocol()
</dd></dl>
</p></div></div><a class="anchor" name="extraFields"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[<a href="../kdecore/KProtocolInfo.ExtraField.html">KProtocolInfo.ExtraField</a>] extraFields</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Definition of extra fields in the UDS entries, returned by a listDir operation.
</p>
<p>
This corresponds to the "ExtraNames=" and "ExtraTypes=" fields in the protocol description file.
Those two lists should be separated with ',' in the protocol description file.
See ExtraField for details about names and types
</p></div></div><a class="anchor" name="icon"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString icon</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the name of the icon, associated with the specified protocol.
</p>
<p>
This corresponds to the "Icon=" field in the protocol description file.
</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>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the icon of the protocol, or an empty string if unknown
</dd></dl>
</p></div></div><a class="anchor" name="isFilterProtocol"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isFilterProtocol</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Same as above except you can supply just the protocol instead of
the whole URL.
</p></div></div><a class="anchor" name="isFilterProtocol"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isFilterProtocol</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Same as above except you can supply just the protocol instead of
the whole URL.
</p></div></div><a class="anchor" name="isHelperProtocol"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isHelperProtocol</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Same as above except you can supply just the protocol instead of
the whole URL.
</p></div></div><a class="anchor" name="isHelperProtocol"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isHelperProtocol</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Same as above except you can supply just the protocol instead of
the whole URL.
</p></div></div><a class="anchor" name="isKnownProtocol"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isKnownProtocol</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Same as above except you can supply just the protocol instead of
the whole URL.
</p></div></div><a class="anchor" name="isKnownProtocol"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isKnownProtocol</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Same as above except you can supply just the protocol instead of
the whole URL.
</p></div></div><a class="anchor" name="maxSlaves"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int maxSlaves</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the soft limit on the number of slaves for this protocol.
This limits the number of slaves used for a single operation, note
that multiple operations may result in a number of instances that
exceeds this soft limit.
</p>
<p>
This corresponds to the "maxInstances=" field in the protocol description file.
The default is 1.
</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>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the maximum number of slaves, or 1 if unknown
</dd></dl>
</p></div></div><a class="anchor" name="maxSlavesPerHost"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int maxSlavesPerHost</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the limit on the number of slaves for this protocol per host.
</p>
<p>
This corresponds to the "maxInstancesPerHost=" field in the protocol description file.
The default is 0 which means there is no per host limit.
</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>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the maximum number of slaves, or 1 if unknown
</dd></dl> </p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="protocolClass"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString protocolClass</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the protocol class for the specified protocol.
</p>
<p>
This corresponds to the "Class=" field in the protocol description file.
</p>
<p>
The following classes are defined:
<li> ":internet" for common internet protocols </li>
<li> ":local" for protocols that access local resources </li>
</p>
<p>
Protocol classes always start with a ':' so that they can not be confused with
the protocols themselves.
</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>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the class of the protocol, or an empty string if unknown
</dd></dl>
</p></div></div><a class="anchor" name="protocols"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList protocols</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns list of all known protocols.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> a list of all known protocols
</dd></dl>
</p></div></div><a class="anchor" name="proxiedBy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString proxiedBy</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns the name of the protocol through which the request
will be routed if proxy support is enabled.
</p>
<p>
A good example of this is the ftp protocol for which proxy
support is commonly handled by the http protocol.
</p>
<p>
This corresponds to the "ProxiedBy=" in the protocol description file.
</p></div></div><a class="anchor" name="showFilePreview"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool showFilePreview</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>protocol</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns whether file previews should be shown for the specified protocol.
</p>
<p>
This corresponds to the "ShowPreviews=" field in the protocol description file.
</p>
<p>
By default previews are shown if protocolClass is :local.
</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>protocol</em> </td><td> the protocol to check
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true if previews should be shown by default, false otherwise
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="FileNameUsedForCopying"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">FileNameUsedForCopying</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"></table>
</dl>
</div></div><p><a class="anchor" name="Type"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Type</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Describes the type of a protocol.
For instance ftp:// appears as a filesystem with folders and files,
while bzip2:// appears as a single file (a stream of data),
and telnet:// doesn't output anything.
<dl class="see" compact><dt><b>See also:</b></dt><dd> outputType
</dd></dl>
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>String</em> = QVariant::String</td><td><tr><td valign="top"><em>DateTime</em> = QVariant::DateTime</td><td><tr><td valign="top"><em>Invalid</em> = QVariant::Invalid</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>
|
