Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.CookieJar.CookieJar.html
Documentation/Source/eric5.Helpviewer.CookieJar.CookieJar.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.CookieJar.CookieJar</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Helpviewer.CookieJar.CookieJar</h1> | |
| 12 <p> | |
| 13 Module implementing a QNetworkCookieJar subclass with various accept policies. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#CookieJar">CookieJar</a></td> | |
| 23 <td>Class implementing a QNetworkCookieJar subclass with various accept policies.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="CookieJar" ID="CookieJar"></a> | |
| 32 <h2>CookieJar</h2> | |
| 33 <p> | |
| 34 Class implementing a QNetworkCookieJar subclass with various accept policies. | |
| 35 </p><h4>Signals</h4> | |
| 36 <dl> | |
| 37 <dt>cookiesChanged()</dt> | |
| 38 <dd> | |
| 39 emitted after the cookies have been changed | |
| 40 </dd> | |
| 41 </dl> | |
| 42 <h3>Derived from</h3> | |
| 43 QNetworkCookieJar | |
| 44 <h3>Class Attributes</h3> | |
| 45 <table> | |
| 46 <tr><td>AcceptAlways</td></tr><tr><td>AcceptNever</td></tr><tr><td>AcceptOnlyFromSitesNavigatedTo</td></tr><tr><td>Allow</td></tr><tr><td>AllowForSession</td></tr><tr><td>Block</td></tr><tr><td>JAR_VERSION</td></tr><tr><td>KeepUntilExit</td></tr><tr><td>KeepUntilExpire</td></tr><tr><td>KeepUntilTimeLimit</td></tr> | |
| 47 </table> | |
| 48 <h3>Methods</h3> | |
| 49 <table> | |
| 50 <tr> | |
| 51 <td><a href="#CookieJar.__init__">CookieJar</a></td> | |
| 52 <td>Constructor</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#CookieJar.__applyRules">__applyRules</a></td> | |
| 55 <td>Private method to apply the cookie rules.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#CookieJar.__isOnDomainList">__isOnDomainList</a></td> | |
| 58 <td>Private method to check, if either the rule matches the domain exactly or the domain ends with ".rule".</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#CookieJar.__purgeOldCookies">__purgeOldCookies</a></td> | |
| 61 <td>Private method to purge old cookies</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#CookieJar.acceptPolicy">acceptPolicy</a></td> | |
| 64 <td>Public method to get the accept policy.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#CookieJar.allowForSessionCookies">allowForSessionCookies</a></td> | |
| 67 <td>Public method to return the allowed session cookies.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#CookieJar.allowedCookies">allowedCookies</a></td> | |
| 70 <td>Public method to return the allowed cookies.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#CookieJar.blockedCookies">blockedCookies</a></td> | |
| 73 <td>Public method to return the blocked cookies.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#CookieJar.clear">clear</a></td> | |
| 76 <td>Public method to clear all cookies.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#CookieJar.close">close</a></td> | |
| 79 <td>Public slot to close the cookie jar.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#CookieJar.cookies">cookies</a></td> | |
| 82 <td>Public method to get the cookies of the cookie jar.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#CookieJar.cookiesForUrl">cookiesForUrl</a></td> | |
| 85 <td>Public method to get the cookies for a URL.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#CookieJar.filterTrackingCookies">filterTrackingCookies</a></td> | |
| 88 <td>Public method to get the filter tracking cookies flag.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#CookieJar.keepPolicy">keepPolicy</a></td> | |
| 91 <td>Private method to get the keep policy.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#CookieJar.load">load</a></td> | |
| 94 <td>Public method to load the cookies.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#CookieJar.loadCookies">loadCookies</a></td> | |
| 97 <td>Public method to restore the saved cookies.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#CookieJar.save">save</a></td> | |
| 100 <td>Public method to save the cookies.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#CookieJar.saveCookies">saveCookies</a></td> | |
| 103 <td>Public method to save the cookies.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#CookieJar.setAcceptPolicy">setAcceptPolicy</a></td> | |
| 106 <td>Public method to set the accept policy.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#CookieJar.setAllowForSessionCookies">setAllowForSessionCookies</a></td> | |
| 109 <td>Public method to set the list of allowed session cookies.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#CookieJar.setAllowedCookies">setAllowedCookies</a></td> | |
| 112 <td>Public method to set the list of allowed cookies.</td> | |
| 113 </tr><tr> | |
| 114 <td><a href="#CookieJar.setBlockedCookies">setBlockedCookies</a></td> | |
| 115 <td>Public method to set the list of blocked cookies.</td> | |
| 116 </tr><tr> | |
| 117 <td><a href="#CookieJar.setCookies">setCookies</a></td> | |
| 118 <td>Public method to set all cookies.</td> | |
| 119 </tr><tr> | |
| 120 <td><a href="#CookieJar.setCookiesFromUrl">setCookiesFromUrl</a></td> | |
| 121 <td>Public method to set cookies for a URL.</td> | |
| 122 </tr><tr> | |
| 123 <td><a href="#CookieJar.setFilterTrackingCookies">setFilterTrackingCookies</a></td> | |
| 124 <td>Public method to set the filter tracking cookies flag.</td> | |
| 125 </tr><tr> | |
| 126 <td><a href="#CookieJar.setKeepPolicy">setKeepPolicy</a></td> | |
| 127 <td>Public method to set the keep policy.</td> | |
| 128 </tr> | |
| 129 </table> | |
| 130 <a NAME="CookieJar.__init__" ID="CookieJar.__init__"></a> | |
| 131 <h4>CookieJar (Constructor)</h4> | |
| 132 <b>CookieJar</b>(<i>parent = None</i>) | |
| 133 <p> | |
| 134 Constructor | |
| 135 </p><dl> | |
| 136 <dt><i>parent</i></dt> | |
| 137 <dd> | |
| 138 reference to the parent object (QObject) | |
| 139 </dd> | |
| 140 </dl><a NAME="CookieJar.__applyRules" ID="CookieJar.__applyRules"></a> | |
| 141 <h4>CookieJar.__applyRules</h4> | |
| 142 <b>__applyRules</b>(<i></i>) | |
| 143 <p> | |
| 144 Private method to apply the cookie rules. | |
| 145 </p><a NAME="CookieJar.__isOnDomainList" ID="CookieJar.__isOnDomainList"></a> | |
| 146 <h4>CookieJar.__isOnDomainList</h4> | |
| 147 <b>__isOnDomainList</b>(<i>rules, domain</i>) | |
| 148 <p> | |
| 149 Private method to check, if either the rule matches the domain exactly | |
| 150 or the domain ends with ".rule". | |
| 151 </p><dl> | |
| 152 <dt><i>rules</i></dt> | |
| 153 <dd> | |
| 154 list of rules (list of strings) | |
| 155 </dd><dt><i>domain</i></dt> | |
| 156 <dd> | |
| 157 domain name to check (string) | |
| 158 </dd> | |
| 159 </dl><dl> | |
| 160 <dt>Returns:</dt> | |
| 161 <dd> | |
| 162 flag indicating a match (boolean) | |
| 163 </dd> | |
| 164 </dl><a NAME="CookieJar.__purgeOldCookies" ID="CookieJar.__purgeOldCookies"></a> | |
| 165 <h4>CookieJar.__purgeOldCookies</h4> | |
| 166 <b>__purgeOldCookies</b>(<i></i>) | |
| 167 <p> | |
| 168 Private method to purge old cookies | |
| 169 </p><a NAME="CookieJar.acceptPolicy" ID="CookieJar.acceptPolicy"></a> | |
| 170 <h4>CookieJar.acceptPolicy</h4> | |
| 171 <b>acceptPolicy</b>(<i></i>) | |
| 172 <p> | |
| 173 Public method to get the accept policy. | |
| 174 </p><dl> | |
| 175 <dt>Returns:</dt> | |
| 176 <dd> | |
| 177 current accept policy | |
| 178 </dd> | |
| 179 </dl><a NAME="CookieJar.allowForSessionCookies" ID="CookieJar.allowForSessionCookies"></a> | |
| 180 <h4>CookieJar.allowForSessionCookies</h4> | |
| 181 <b>allowForSessionCookies</b>(<i></i>) | |
| 182 <p> | |
| 183 Public method to return the allowed session cookies. | |
| 184 </p><dl> | |
| 185 <dt>Returns:</dt> | |
| 186 <dd> | |
| 187 list of allowed session cookies (list of strings) | |
| 188 </dd> | |
| 189 </dl><a NAME="CookieJar.allowedCookies" ID="CookieJar.allowedCookies"></a> | |
| 190 <h4>CookieJar.allowedCookies</h4> | |
| 191 <b>allowedCookies</b>(<i></i>) | |
| 192 <p> | |
| 193 Public method to return the allowed cookies. | |
| 194 </p><dl> | |
| 195 <dt>Returns:</dt> | |
| 196 <dd> | |
| 197 list of allowed cookies (list of strings) | |
| 198 </dd> | |
| 199 </dl><a NAME="CookieJar.blockedCookies" ID="CookieJar.blockedCookies"></a> | |
| 200 <h4>CookieJar.blockedCookies</h4> | |
| 201 <b>blockedCookies</b>(<i></i>) | |
| 202 <p> | |
| 203 Public method to return the blocked cookies. | |
| 204 </p><dl> | |
| 205 <dt>Returns:</dt> | |
| 206 <dd> | |
| 207 list of blocked cookies (list of strings) | |
| 208 </dd> | |
| 209 </dl><a NAME="CookieJar.clear" ID="CookieJar.clear"></a> | |
| 210 <h4>CookieJar.clear</h4> | |
| 211 <b>clear</b>(<i></i>) | |
| 212 <p> | |
| 213 Public method to clear all cookies. | |
| 214 </p><a NAME="CookieJar.close" ID="CookieJar.close"></a> | |
| 215 <h4>CookieJar.close</h4> | |
| 216 <b>close</b>(<i></i>) | |
| 217 <p> | |
| 218 Public slot to close the cookie jar. | |
| 219 </p><a NAME="CookieJar.cookies" ID="CookieJar.cookies"></a> | |
| 220 <h4>CookieJar.cookies</h4> | |
| 221 <b>cookies</b>(<i></i>) | |
| 222 <p> | |
| 223 Public method to get the cookies of the cookie jar. | |
| 224 </p><dl> | |
| 225 <dt>Returns:</dt> | |
| 226 <dd> | |
| 227 list of all cookies (list of QNetworkCookie) | |
| 228 </dd> | |
| 229 </dl><a NAME="CookieJar.cookiesForUrl" ID="CookieJar.cookiesForUrl"></a> | |
| 230 <h4>CookieJar.cookiesForUrl</h4> | |
| 231 <b>cookiesForUrl</b>(<i>url</i>) | |
| 232 <p> | |
| 233 Public method to get the cookies for a URL. | |
| 234 </p><dl> | |
| 235 <dt><i>url</i></dt> | |
| 236 <dd> | |
| 237 URL to get cookies for (QUrl) | |
| 238 </dd> | |
| 239 </dl><dl> | |
| 240 <dt>Returns:</dt> | |
| 241 <dd> | |
| 242 list of cookies (list of QNetworkCookie) | |
| 243 </dd> | |
| 244 </dl><a NAME="CookieJar.filterTrackingCookies" ID="CookieJar.filterTrackingCookies"></a> | |
| 245 <h4>CookieJar.filterTrackingCookies</h4> | |
| 246 <b>filterTrackingCookies</b>(<i></i>) | |
| 247 <p> | |
| 248 Public method to get the filter tracking cookies flag. | |
| 249 </p><dl> | |
| 250 <dt>Returns:</dt> | |
| 251 <dd> | |
| 252 filter tracking cookies flag (boolean) | |
| 253 </dd> | |
| 254 </dl><a NAME="CookieJar.keepPolicy" ID="CookieJar.keepPolicy"></a> | |
| 255 <h4>CookieJar.keepPolicy</h4> | |
| 256 <b>keepPolicy</b>(<i></i>) | |
| 257 <p> | |
| 258 Private method to get the keep policy. | |
| 259 </p><a NAME="CookieJar.load" ID="CookieJar.load"></a> | |
| 260 <h4>CookieJar.load</h4> | |
| 261 <b>load</b>(<i></i>) | |
| 262 <p> | |
| 263 Public method to load the cookies. | |
| 264 </p><a NAME="CookieJar.loadCookies" ID="CookieJar.loadCookies"></a> | |
| 265 <h4>CookieJar.loadCookies</h4> | |
| 266 <b>loadCookies</b>(<i>cookies</i>) | |
| 267 <p> | |
| 268 Public method to restore the saved cookies. | |
| 269 </p><dl> | |
| 270 <dt><i>cookies</i></dt> | |
| 271 <dd> | |
| 272 byte array containing the saved cookies (QByteArray) | |
| 273 </dd> | |
| 274 </dl><dl> | |
| 275 <dt>Returns:</dt> | |
| 276 <dd> | |
| 277 list of cookies | |
| 278 </dd> | |
| 279 </dl><a NAME="CookieJar.save" ID="CookieJar.save"></a> | |
| 280 <h4>CookieJar.save</h4> | |
| 281 <b>save</b>(<i></i>) | |
| 282 <p> | |
| 283 Public method to save the cookies. | |
| 284 </p><a NAME="CookieJar.saveCookies" ID="CookieJar.saveCookies"></a> | |
| 285 <h4>CookieJar.saveCookies</h4> | |
| 286 <b>saveCookies</b>(<i>cookiesList</i>) | |
| 287 <p> | |
| 288 Public method to save the cookies. | |
| 289 </p><dl> | |
| 290 <dt><i>cookiesList</i></dt> | |
| 291 <dd> | |
| 292 list of cookies to be saved | |
| 293 </dd> | |
| 294 </dl><dl> | |
| 295 <dt>Returns:</dt> | |
| 296 <dd> | |
| 297 saved cookies as a byte array (QByteArray) | |
| 298 </dd> | |
| 299 </dl><a NAME="CookieJar.setAcceptPolicy" ID="CookieJar.setAcceptPolicy"></a> | |
| 300 <h4>CookieJar.setAcceptPolicy</h4> | |
| 301 <b>setAcceptPolicy</b>(<i>policy</i>) | |
| 302 <p> | |
| 303 Public method to set the accept policy. | |
| 304 </p><dl> | |
| 305 <dt><i>policy</i></dt> | |
| 306 <dd> | |
| 307 accept policy to be set | |
| 308 </dd> | |
| 309 </dl><a NAME="CookieJar.setAllowForSessionCookies" ID="CookieJar.setAllowForSessionCookies"></a> | |
| 310 <h4>CookieJar.setAllowForSessionCookies</h4> | |
| 311 <b>setAllowForSessionCookies</b>(<i>list_</i>) | |
| 312 <p> | |
| 313 Public method to set the list of allowed session cookies. | |
| 314 </p><dl> | |
| 315 <dt><i>list_</i></dt> | |
| 316 <dd> | |
| 317 list of allowed session cookies (list of strings) | |
| 318 </dd> | |
| 319 </dl><a NAME="CookieJar.setAllowedCookies" ID="CookieJar.setAllowedCookies"></a> | |
| 320 <h4>CookieJar.setAllowedCookies</h4> | |
| 321 <b>setAllowedCookies</b>(<i>list_</i>) | |
| 322 <p> | |
| 323 Public method to set the list of allowed cookies. | |
| 324 </p><dl> | |
| 325 <dt><i>list_</i></dt> | |
| 326 <dd> | |
| 327 list of allowed cookies (list of strings) | |
| 328 </dd> | |
| 329 </dl><a NAME="CookieJar.setBlockedCookies" ID="CookieJar.setBlockedCookies"></a> | |
| 330 <h4>CookieJar.setBlockedCookies</h4> | |
| 331 <b>setBlockedCookies</b>(<i>list_</i>) | |
| 332 <p> | |
| 333 Public method to set the list of blocked cookies. | |
| 334 </p><dl> | |
| 335 <dt><i>list_</i></dt> | |
| 336 <dd> | |
| 337 list of blocked cookies (list of strings) | |
| 338 </dd> | |
| 339 </dl><a NAME="CookieJar.setCookies" ID="CookieJar.setCookies"></a> | |
| 340 <h4>CookieJar.setCookies</h4> | |
| 341 <b>setCookies</b>(<i>cookies</i>) | |
| 342 <p> | |
| 343 Public method to set all cookies. | |
| 344 </p><dl> | |
| 345 <dt><i>cookies</i></dt> | |
| 346 <dd> | |
| 347 list of cookies to be set (list of QNetworkCookie) | |
| 348 </dd> | |
| 349 </dl><a NAME="CookieJar.setCookiesFromUrl" ID="CookieJar.setCookiesFromUrl"></a> | |
| 350 <h4>CookieJar.setCookiesFromUrl</h4> | |
| 351 <b>setCookiesFromUrl</b>(<i>cookieList, url</i>) | |
| 352 <p> | |
| 353 Public method to set cookies for a URL. | |
| 354 </p><dl> | |
| 355 <dt><i>cookieList</i></dt> | |
| 356 <dd> | |
| 357 list of cookies to set (list of QNetworkCookie) | |
| 358 </dd><dt><i>url</i></dt> | |
| 359 <dd> | |
| 360 url to set cookies for (QUrl) | |
| 361 </dd> | |
| 362 </dl><dl> | |
| 363 <dt>Returns:</dt> | |
| 364 <dd> | |
| 365 flag indicating cookies were set (boolean) | |
| 366 </dd> | |
| 367 </dl><a NAME="CookieJar.setFilterTrackingCookies" ID="CookieJar.setFilterTrackingCookies"></a> | |
| 368 <h4>CookieJar.setFilterTrackingCookies</h4> | |
| 369 <b>setFilterTrackingCookies</b>(<i>filterTrackingCookies</i>) | |
| 370 <p> | |
| 371 Public method to set the filter tracking cookies flag. | |
| 372 </p><dl> | |
| 373 <dt><i>filterTrackingCookies</i></dt> | |
| 374 <dd> | |
| 375 filter tracking cookies flag (boolean) | |
| 376 </dd> | |
| 377 </dl><a NAME="CookieJar.setKeepPolicy" ID="CookieJar.setKeepPolicy"></a> | |
| 378 <h4>CookieJar.setKeepPolicy</h4> | |
| 379 <b>setKeepPolicy</b>(<i>policy</i>) | |
| 380 <p> | |
| 381 Public method to set the keep policy. | |
| 382 </p><dl> | |
| 383 <dt><i>policy</i></dt> | |
| 384 <dd> | |
| 385 keep policy to be set | |
| 386 </dd> | |
| 387 </dl> | |
| 388 <div align="right"><a href="#top">Up</a></div> | |
| 389 <hr /> | |
| 390 </body></html> |
