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
|
<?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.AccessManager</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>AccessManager Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
Inherits: <br />
Namespace: <a href="../kio/KIO.html">KIO</a><br />
<h2>Detailed Description</h2>
<p>A KDE implementation of QNetworkAccessManager.
</p>
<p>
Use this class instead of QNetworkAccessManager if you want to integrate
with KDE's KIO and KCookieJar modules for network operations and cookie
handling respectively.
</p>
<p>
Here is a simple example that shows how to set the QtWebKit module to use KDE's
KIO for its network operations:
<pre class="fragment">
QWebView *view = new QWebView(this);
KIO.Integration.AccessManager *manager = new KIO.Integration.AccessManager(view);
view->page()->setNetworkAccessManager(manager);
</pre>
</p>
<p>
To access member functions in the cookiejar class at a later point in your
code simply downcast the pointer returned by QWebPage.networkAccessManager
as follows:
<pre class="fragment">
KIO.Integration.AccessManager *manager = qobject_cast<KIO.Integration.AccessManager*>(view->page()->accessManager());
</pre>
</p>
<p>
Please note that this class is in the KIO namespace for backward compatablity.
You should use KIO.Integration.AccessManager to access this class in your
code.
</p>
<p>
<b>IMPORTANT</b>This class is not a replacement for the standard KDE API.
It should ONLY be used to provide KDE integration in applications that
cannot use the standard KDE API directly.
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Urs Wolfer <uwolfer @kde.org> </dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Dawit Alemayehu <adawit @kde.org> </dd></dl>
</p>
<p>
<dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use the KIO.Integration.AccessManager typedef to access this class instead.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
</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="#Attribute">Attribute</a> </td><td class="memItemRight" valign="bottom">{ MetaData, KioError }</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="#AccessManager">__init__</a> (self, QObject parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#cookieJarWindowid">cookieJarWindowid</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QNetworkReply </td><td class="memItemRight" valign="bottom"><a class="el" href="#createRequest">createRequest</a> (self, Operation op, QNetworkRequest req, QIODevice outgoingData=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isExternalContentAllowed">isExternalContentAllowed</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KIO.MetaData.html">KIO.MetaData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#requestMetaData">requestMetaData</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KIO.MetaData.html">KIO.MetaData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#sessionMetaData">sessionMetaData</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCookieJarWindowId">setCookieJarWindowId</a> (self, int id)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setEmitReadyReadOnMetaDataChange">setEmitReadyReadOnMetaDataChange</a> (self, bool a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setExternalContentAllowed">setExternalContentAllowed</a> (self, bool allowed)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setWindow">setWindow</a> (self, QWidget widget)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget </td><td class="memItemRight" valign="bottom"><a class="el" href="#window">window</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#putReplyOnHold">putReplyOnHold</a> (QNetworkReply reply)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="AccessManager"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QObject </td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor
</p></div></div><a class="anchor" name="cookieJarWindowid"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int cookieJarWindowid</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 cookiejar's window id.
</p>
<p>
This is a convenience function that returns the window id associated
with the cookiejar. Note that this function will return a 0 if the
cookiejar is not of type KIO.Integration.CookieJar or a window id
has not yet been set.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KIO.Integration.CookieJar.windowId.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use KIO.Integration.CookieJar.windowId
</dd></dl>
</p></div></div><a class="anchor" name="createRequest"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QNetworkReply createRequest</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">Operation </td>
<td class="paramname"><em>op</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QNetworkRequest </td>
<td class="paramname"><em>req</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QIODevice </td>
<td class="paramname"><em>outgoingData=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Reimplemented for internal reasons, the API is not affected.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> QNetworkAccessManager.createRequest
</dd></dl> <dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="isExternalContentAllowed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isExternalContentAllowed</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 true if external content is going to be fetched.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setExternalContentAllowed
</dd></dl>
</p></div></div><a class="anchor" name="requestMetaData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KIO.MetaData.html">KIO.MetaData</a> requestMetaData</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 a reference to the temporary meta data container.
</p>
<p>
See kdelibs/kio/DESIGN.metadata for list of supported KIO meta data.
</p>
<p>
Use this function when you want to set per request KIO meta data that
will be removed after it has been sent once.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="sessionMetaData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KIO.MetaData.html">KIO.MetaData</a> sessionMetaData</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 a reference to the persistent meta data container.
</p>
<p>
See kdelibs/kio/DESIGN.metadata for list of supported KIO meta data.
</p>
<p>
Use this function when you want to set per session KIO meta data that
will be sent with every request.
</p>
<p>
Unlike <b>requestMetaData,</b> the meta data values set using the reference
returned by this function will not be deleted and will be sent with every
request.
</p>
<p>
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="setCookieJarWindowId"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCookieJarWindowId</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>id</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 cookiejar's window id to <b>id.</b>
</p>
<p>
This is a convenience function that allows you to set the cookiejar's
window id. Note that this function does nothing unless the cookiejar in
use is of type KIO.Integration.CookieJar.
</p>
<p>
By default the cookiejar's window id is set to false. Make sure you call
this function and set the window id to its proper value when create an
instance of this object. Otherwise, the KDE cookiejar will not be able
to properly manage session based cookies.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KIO.Integration.CookieJar.setWindowId.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl> <dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd> Use setWindow
</dd></dl>
</p></div></div><a class="anchor" name="setEmitReadyReadOnMetaDataChange"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setEmitReadyReadOnMetaDataChange</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>a0</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 network reply object to emit readyRead when it receives meta data.
</p>
<p>
Meta data is any information that is not the actual content itself, e.g.
HTTP response headers of the HTTP protocol. You should only call this
function, when an application does not connect to a reply object's
metaDataChanged signal.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> QNetworkReply.metaDataChanged
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7
</dd></dl>
</p></div></div><a class="anchor" name="setExternalContentAllowed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setExternalContentAllowed</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>allowed</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set <b>allowed</b> to false if you don't want any external content to be fetched.
By default external content is fetched.
</p></div></div><a class="anchor" name="setWindow"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setWindow</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>widget</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the window associated with this network access manager.
</p>
<p>
Note that <b>widget</b> will be used as a parent for dialogs in KIO as well
as the cookie jar. If <b>widget</b> is not a window, this function will
invoke QWidget.window() to obtain the window for the given widget.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KIO.Integration.CookieJar.setWindow.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7
</dd></dl>
</p></div></div><a class="anchor" name="window"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QWidget window</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 window associated with this network access manager.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setWindow
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.7
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="putReplyOnHold"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> putReplyOnHold</td>
<td>(</td>
<td class="paramtype">QNetworkReply </td>
<td class="paramname"><em>reply</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Puts the ioslave associated with the given <b>reply</b> on hold.
</p>
<p>
This function is intended to make possible the implementation of
the special case mentioned in KIO.get's documentation within the
KIO-QNAM integration.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KIO.get.
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.6
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Attribute"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Attribute</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>MetaData</em> = QNetworkRequest::User</td><td><tr><td valign="top"><em>KioError</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>
|
