Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockManager.html

changeset 6028
859f6894eed9
parent 5727
c8842a8d1167
equal deleted inserted replaced
6027:d056a536670e 6028:859f6894eed9
43 <h2>AdBlockManager</h2> 43 <h2>AdBlockManager</h2>
44 <p> 44 <p>
45 Class implementing the AdBlock manager. 45 Class implementing the AdBlock manager.
46 </p><h3>Signals</h3> 46 </p><h3>Signals</h3>
47 <dl> 47 <dl>
48 <dt>requiredSubscriptionLoaded(subscription)</dt> 48 <dt>enabledChanged(enabled)</dt>
49 <dd>
50 emitted to indicate a change of the
51 enabled state
52 </dd><dt>requiredSubscriptionLoaded(subscription)</dt>
49 <dd> 53 <dd>
50 emitted to indicate 54 emitted to indicate
51 loading of a required subscription is finished (AdBlockSubscription) 55 loading of a required subscription is finished (AdBlockSubscription)
52 </dd><dt>rulesChanged()</dt> 56 </dd><dt>rulesChanged()</dt>
53 <dd> 57 <dd>
68 <table> 72 <table>
69 <tr> 73 <tr>
70 <td><a href="#AdBlockManager.__init__">AdBlockManager</a></td> 74 <td><a href="#AdBlockManager.__init__">AdBlockManager</a></td>
71 <td>Constructor</td> 75 <td>Constructor</td>
72 </tr><tr> 76 </tr><tr>
73 <td><a href="#AdBlockManager.__canRunOnScheme">__canRunOnScheme</a></td> 77 <td><a href="#AdBlockManager.__canBeBlocked">__canBeBlocked</a></td>
74 <td>Private method to check, if AdBlock can be performed on the scheme.</td> 78 <td>Private method to check, if the given URL could be blocked (i.e.</td>
75 </tr><tr> 79 </tr><tr>
76 <td><a href="#AdBlockManager.__customSubscriptionLocation">__customSubscriptionLocation</a></td> 80 <td><a href="#AdBlockManager.__customSubscriptionLocation">__customSubscriptionLocation</a></td>
77 <td>Private method to generate the path for custom subscriptions.</td> 81 <td>Private method to generate the path for custom subscriptions.</td>
78 </tr><tr> 82 </tr><tr>
79 <td><a href="#AdBlockManager.__customSubscriptionUrl">__customSubscriptionUrl</a></td> 83 <td><a href="#AdBlockManager.__customSubscriptionUrl">__customSubscriptionUrl</a></td>
83 <td>Private method to load the set of subscriptions.</td> 87 <td>Private method to load the set of subscriptions.</td>
84 </tr><tr> 88 </tr><tr>
85 <td><a href="#AdBlockManager.__rulesChanged">__rulesChanged</a></td> 89 <td><a href="#AdBlockManager.__rulesChanged">__rulesChanged</a></td>
86 <td>Private slot handling a change of the AdBlock rules.</td> 90 <td>Private slot handling a change of the AdBlock rules.</td>
87 </tr><tr> 91 </tr><tr>
92 <td><a href="#AdBlockManager.__updateMatcher">__updateMatcher</a></td>
93 <td>Private slot to update the adblock matcher.</td>
94 </tr><tr>
88 <td><a href="#AdBlockManager.addException">addException</a></td> 95 <td><a href="#AdBlockManager.addException">addException</a></td>
89 <td>Public method to add an exception.</td> 96 <td>Public method to add an exception.</td>
90 </tr><tr> 97 </tr><tr>
91 <td><a href="#AdBlockManager.addSubscription">addSubscription</a></td> 98 <td><a href="#AdBlockManager.addSubscription">addSubscription</a></td>
92 <td>Public method to add an AdBlock subscription.</td> 99 <td>Public method to add an AdBlock subscription.</td>
94 <td><a href="#AdBlockManager.addSubscriptionFromUrl">addSubscriptionFromUrl</a></td> 101 <td><a href="#AdBlockManager.addSubscriptionFromUrl">addSubscriptionFromUrl</a></td>
95 <td>Public method to ad an AdBlock subscription given the abp URL.</td> 102 <td>Public method to ad an AdBlock subscription given the abp URL.</td>
96 </tr><tr> 103 </tr><tr>
97 <td><a href="#AdBlockManager.block">block</a></td> 104 <td><a href="#AdBlockManager.block">block</a></td>
98 <td>Public method to check, if a request should be blocked.</td> 105 <td>Public method to check, if a request should be blocked.</td>
106 </tr><tr>
107 <td><a href="#AdBlockManager.canRunOnScheme">canRunOnScheme</a></td>
108 <td>Public method to check, if AdBlock can be performed on the scheme.</td>
99 </tr><tr> 109 </tr><tr>
100 <td><a href="#AdBlockManager.close">close</a></td> 110 <td><a href="#AdBlockManager.close">close</a></td>
101 <td>Public method to close the open search engines manager.</td> 111 <td>Public method to close the open search engines manager.</td>
102 </tr><tr> 112 </tr><tr>
103 <td><a href="#AdBlockManager.customRules">customRules</a></td> 113 <td><a href="#AdBlockManager.customRules">customRules</a></td>
178 <h4>AdBlockManager (Constructor)</h4> 188 <h4>AdBlockManager (Constructor)</h4>
179 <b>AdBlockManager</b>(<i>parent=None</i>) 189 <b>AdBlockManager</b>(<i>parent=None</i>)
180 <p> 190 <p>
181 Constructor 191 Constructor
182 </p><dl> 192 </p><dl>
183 <dt><i>parent</i></dt> 193 <dt><i>parent</i> (QObject)</dt>
184 <dd> 194 <dd>
185 reference to the parent object (QObject) 195 reference to the parent object
186 </dd> 196 </dd>
187 </dl><a NAME="AdBlockManager.__canRunOnScheme" ID="AdBlockManager.__canRunOnScheme"></a> 197 </dl><a NAME="AdBlockManager.__canBeBlocked" ID="AdBlockManager.__canBeBlocked"></a>
188 <h4>AdBlockManager.__canRunOnScheme</h4> 198 <h4>AdBlockManager.__canBeBlocked</h4>
189 <b>__canRunOnScheme</b>(<i>scheme</i>) 199 <b>__canBeBlocked</b>(<i>url</i>)
190 <p> 200 <p>
191 Private method to check, if AdBlock can be performed on the scheme. 201 Private method to check, if the given URL could be blocked (i.e. is
192 </p><dl> 202 not whitelisted).
193 <dt><i>scheme</i></dt> 203 </p><dl>
194 <dd> 204 <dt><i>url</i> (QUrl)</dt>
195 scheme to check (string) 205 <dd>
196 </dd> 206 URL to be checked
197 </dl><dl> 207 </dd>
198 <dt>Returns:</dt> 208 </dl><dl>
199 <dd> 209 <dt>Returns:</dt>
200 flag indicating, that AdBlock can be performed (boolean) 210 <dd>
211 flag indicating that the given URL can be blocked
212 </dd>
213 </dl><dl>
214 <dt>Return Type:</dt>
215 <dd>
216 bool
201 </dd> 217 </dd>
202 </dl><a NAME="AdBlockManager.__customSubscriptionLocation" ID="AdBlockManager.__customSubscriptionLocation"></a> 218 </dl><a NAME="AdBlockManager.__customSubscriptionLocation" ID="AdBlockManager.__customSubscriptionLocation"></a>
203 <h4>AdBlockManager.__customSubscriptionLocation</h4> 219 <h4>AdBlockManager.__customSubscriptionLocation</h4>
204 <b>__customSubscriptionLocation</b>(<i></i>) 220 <b>__customSubscriptionLocation</b>(<i></i>)
205 <p> 221 <p>
206 Private method to generate the path for custom subscriptions. 222 Private method to generate the path for custom subscriptions.
207 </p><dl> 223 </p><dl>
208 <dt>Returns:</dt> 224 <dt>Returns:</dt>
209 <dd> 225 <dd>
210 URL for custom subscriptions (QUrl) 226 URL for custom subscriptions
227 </dd>
228 </dl><dl>
229 <dt>Return Type:</dt>
230 <dd>
231 QUrl
211 </dd> 232 </dd>
212 </dl><a NAME="AdBlockManager.__customSubscriptionUrl" ID="AdBlockManager.__customSubscriptionUrl"></a> 233 </dl><a NAME="AdBlockManager.__customSubscriptionUrl" ID="AdBlockManager.__customSubscriptionUrl"></a>
213 <h4>AdBlockManager.__customSubscriptionUrl</h4> 234 <h4>AdBlockManager.__customSubscriptionUrl</h4>
214 <b>__customSubscriptionUrl</b>(<i></i>) 235 <b>__customSubscriptionUrl</b>(<i></i>)
215 <p> 236 <p>
216 Private method to generate the URL for custom subscriptions. 237 Private method to generate the URL for custom subscriptions.
217 </p><dl> 238 </p><dl>
218 <dt>Returns:</dt> 239 <dt>Returns:</dt>
219 <dd> 240 <dd>
220 URL for custom subscriptions (QUrl) 241 URL for custom subscriptions
242 </dd>
243 </dl><dl>
244 <dt>Return Type:</dt>
245 <dd>
246 QUrl
221 </dd> 247 </dd>
222 </dl><a NAME="AdBlockManager.__loadSubscriptions" ID="AdBlockManager.__loadSubscriptions"></a> 248 </dl><a NAME="AdBlockManager.__loadSubscriptions" ID="AdBlockManager.__loadSubscriptions"></a>
223 <h4>AdBlockManager.__loadSubscriptions</h4> 249 <h4>AdBlockManager.__loadSubscriptions</h4>
224 <b>__loadSubscriptions</b>(<i></i>) 250 <b>__loadSubscriptions</b>(<i></i>)
225 <p> 251 <p>
227 </p><a NAME="AdBlockManager.__rulesChanged" ID="AdBlockManager.__rulesChanged"></a> 253 </p><a NAME="AdBlockManager.__rulesChanged" ID="AdBlockManager.__rulesChanged"></a>
228 <h4>AdBlockManager.__rulesChanged</h4> 254 <h4>AdBlockManager.__rulesChanged</h4>
229 <b>__rulesChanged</b>(<i></i>) 255 <b>__rulesChanged</b>(<i></i>)
230 <p> 256 <p>
231 Private slot handling a change of the AdBlock rules. 257 Private slot handling a change of the AdBlock rules.
258 </p><a NAME="AdBlockManager.__updateMatcher" ID="AdBlockManager.__updateMatcher"></a>
259 <h4>AdBlockManager.__updateMatcher</h4>
260 <b>__updateMatcher</b>(<i></i>)
261 <p>
262 Private slot to update the adblock matcher.
232 </p><a NAME="AdBlockManager.addException" ID="AdBlockManager.addException"></a> 263 </p><a NAME="AdBlockManager.addException" ID="AdBlockManager.addException"></a>
233 <h4>AdBlockManager.addException</h4> 264 <h4>AdBlockManager.addException</h4>
234 <b>addException</b>(<i>host</i>) 265 <b>addException</b>(<i>host</i>)
235 <p> 266 <p>
236 Public method to add an exception. 267 Public method to add an exception.
237 </p><dl> 268 </p><dl>
238 <dt><i>host</i></dt> 269 <dt><i>host</i> (str)</dt>
239 <dd> 270 <dd>
240 to be excepted (string) 271 to be excepted
241 </dd> 272 </dd>
242 </dl><a NAME="AdBlockManager.addSubscription" ID="AdBlockManager.addSubscription"></a> 273 </dl><a NAME="AdBlockManager.addSubscription" ID="AdBlockManager.addSubscription"></a>
243 <h4>AdBlockManager.addSubscription</h4> 274 <h4>AdBlockManager.addSubscription</h4>
244 <b>addSubscription</b>(<i>subscription</i>) 275 <b>addSubscription</b>(<i>subscription</i>)
245 <p> 276 <p>
246 Public method to add an AdBlock subscription. 277 Public method to add an AdBlock subscription.
247 </p><dl> 278 </p><dl>
248 <dt><i>subscription</i></dt> 279 <dt><i>subscription</i> (AdBlockSubscription)</dt>
249 <dd> 280 <dd>
250 AdBlock subscription to be added 281 AdBlock subscription to be added
251 (AdBlockSubscription)
252 </dd> 282 </dd>
253 </dl><a NAME="AdBlockManager.addSubscriptionFromUrl" ID="AdBlockManager.addSubscriptionFromUrl"></a> 283 </dl><a NAME="AdBlockManager.addSubscriptionFromUrl" ID="AdBlockManager.addSubscriptionFromUrl"></a>
254 <h4>AdBlockManager.addSubscriptionFromUrl</h4> 284 <h4>AdBlockManager.addSubscriptionFromUrl</h4>
255 <b>addSubscriptionFromUrl</b>(<i>url</i>) 285 <b>addSubscriptionFromUrl</b>(<i>url</i>)
256 <p> 286 <p>
276 <p> 306 <p>
277 Public method to check, if a request should be blocked. 307 Public method to check, if a request should be blocked.
278 </p><dl> 308 </p><dl>
279 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt> 309 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
280 <dd> 310 <dd>
281 request info aobject 311 request info object
282 </dd> 312 </dd>
283 </dl><dl> 313 </dl><dl>
284 <dt>Returns:</dt> 314 <dt>Returns:</dt>
285 <dd> 315 <dd>
286 flag indicating to block the request 316 flag indicating to block the request
317 </dd>
318 </dl><dl>
319 <dt>Return Type:</dt>
320 <dd>
321 bool
322 </dd>
323 </dl><a NAME="AdBlockManager.canRunOnScheme" ID="AdBlockManager.canRunOnScheme"></a>
324 <h4>AdBlockManager.canRunOnScheme</h4>
325 <b>canRunOnScheme</b>(<i>scheme</i>)
326 <p>
327 Public method to check, if AdBlock can be performed on the scheme.
328 </p><dl>
329 <dt><i>scheme</i> (str)</dt>
330 <dd>
331 scheme to check
332 </dd>
333 </dl><dl>
334 <dt>Returns:</dt>
335 <dd>
336 flag indicating, that AdBlock can be performed
287 </dd> 337 </dd>
288 </dl><dl> 338 </dl><dl>
289 <dt>Return Type:</dt> 339 <dt>Return Type:</dt>
290 <dd> 340 <dd>
291 bool 341 bool
301 <p> 351 <p>
302 Public method to get a subscription for custom rules. 352 Public method to get a subscription for custom rules.
303 </p><dl> 353 </p><dl>
304 <dt>Returns:</dt> 354 <dt>Returns:</dt>
305 <dd> 355 <dd>
306 subscription object for custom rules (AdBlockSubscription) 356 subscription object for custom rules
357 </dd>
358 </dl><dl>
359 <dt>Return Type:</dt>
360 <dd>
361 AdBlockSubscription
307 </dd> 362 </dd>
308 </dl><a NAME="AdBlockManager.elementHidingRules" ID="AdBlockManager.elementHidingRules"></a> 363 </dl><a NAME="AdBlockManager.elementHidingRules" ID="AdBlockManager.elementHidingRules"></a>
309 <h4>AdBlockManager.elementHidingRules</h4> 364 <h4>AdBlockManager.elementHidingRules</h4>
310 <b>elementHidingRules</b>(<i>url</i>) 365 <b>elementHidingRules</b>(<i>url</i>)
311 <p> 366 <p>
312 Public method to get the element hiding rules. 367 Public method to get the element hiding rules.
313 </p><p> 368 </p><p>
314 369
315 </p><dl> 370 </p><dl>
316 <dt><i>url</i></dt> 371 <dt><i>url</i> (QUrl)</dt>
317 <dd> 372 <dd>
318 URL to get hiding rules for (QUrl) 373 URL to get hiding rules for
319 </dd> 374 </dd>
320 </dl><dl> 375 </dl><dl>
321 <dt>Returns:</dt> 376 <dt>Returns:</dt>
322 <dd> 377 <dd>
323 element hiding rules (string) 378 element hiding rules
379 </dd>
380 </dl><dl>
381 <dt>Return Type:</dt>
382 <dd>
383 str
324 </dd> 384 </dd>
325 </dl><a NAME="AdBlockManager.elementHidingRulesForDomain" ID="AdBlockManager.elementHidingRulesForDomain"></a> 385 </dl><a NAME="AdBlockManager.elementHidingRulesForDomain" ID="AdBlockManager.elementHidingRulesForDomain"></a>
326 <h4>AdBlockManager.elementHidingRulesForDomain</h4> 386 <h4>AdBlockManager.elementHidingRulesForDomain</h4>
327 <b>elementHidingRulesForDomain</b>(<i>url</i>) 387 <b>elementHidingRulesForDomain</b>(<i>url</i>)
328 <p> 388 <p>
329 Public method to get the element hiding rules for a domain. 389 Public method to get the element hiding rules for a domain.
330 </p><dl> 390 </p><dl>
331 <dt><i>url</i></dt> 391 <dt><i>url</i> (QUrl)</dt>
332 <dd> 392 <dd>
333 URL to get hiding rules for (QUrl) 393 URL to get hiding rules for
334 </dd> 394 </dd>
335 </dl><dl> 395 </dl><dl>
336 <dt>Returns:</dt> 396 <dt>Returns:</dt>
337 <dd> 397 <dd>
338 element hiding rules (string) 398 element hiding rules
399 </dd>
400 </dl><dl>
401 <dt>Return Type:</dt>
402 <dd>
403 str
339 </dd> 404 </dd>
340 </dl><a NAME="AdBlockManager.exceptions" ID="AdBlockManager.exceptions"></a> 405 </dl><a NAME="AdBlockManager.exceptions" ID="AdBlockManager.exceptions"></a>
341 <h4>AdBlockManager.exceptions</h4> 406 <h4>AdBlockManager.exceptions</h4>
342 <b>exceptions</b>(<i></i>) 407 <b>exceptions</b>(<i></i>)
343 <p> 408 <p>
344 Public method to get a list of excepted hosts. 409 Public method to get a list of excepted hosts.
345 </p><dl> 410 </p><dl>
346 <dt>Returns:</dt> 411 <dt>Returns:</dt>
347 <dd> 412 <dd>
348 list of excepted hosts (list of string) 413 list of excepted hosts
414 </dd>
415 </dl><dl>
416 <dt>Return Type:</dt>
417 <dd>
418 list of str
349 </dd> 419 </dd>
350 </dl><a NAME="AdBlockManager.getDefaultSubscriptionUrl" ID="AdBlockManager.getDefaultSubscriptionUrl"></a> 420 </dl><a NAME="AdBlockManager.getDefaultSubscriptionUrl" ID="AdBlockManager.getDefaultSubscriptionUrl"></a>
351 <h4>AdBlockManager.getDefaultSubscriptionUrl</h4> 421 <h4>AdBlockManager.getDefaultSubscriptionUrl</h4>
352 <b>getDefaultSubscriptionUrl</b>(<i></i>) 422 <b>getDefaultSubscriptionUrl</b>(<i></i>)
353 <p> 423 <p>
367 <b>getRequiresSubscriptions</b>(<i>subscription</i>) 437 <b>getRequiresSubscriptions</b>(<i>subscription</i>)
368 <p> 438 <p>
369 Public method to get a list of subscriptions, that require the given 439 Public method to get a list of subscriptions, that require the given
370 one. 440 one.
371 </p><dl> 441 </p><dl>
372 <dt><i>subscription</i></dt> 442 <dt><i>subscription</i> (AdBlockSubscription)</dt>
373 <dd> 443 <dd>
374 subscription to check for (AdBlockSubscription) 444 subscription to check for
375 </dd> 445 </dd>
376 </dl><dl> 446 </dl><dl>
377 <dt>Returns:</dt> 447 <dt>Returns:</dt>
378 <dd> 448 <dd>
379 list of subscription requiring the given one (list of 449 list of subscription requiring the given one
380 AdBlockSubscription) 450 </dd>
451 </dl><dl>
452 <dt>Return Type:</dt>
453 <dd>
454 list of AdBlockSubscription
381 </dd> 455 </dd>
382 </dl><a NAME="AdBlockManager.isEnabled" ID="AdBlockManager.isEnabled"></a> 456 </dl><a NAME="AdBlockManager.isEnabled" ID="AdBlockManager.isEnabled"></a>
383 <h4>AdBlockManager.isEnabled</h4> 457 <h4>AdBlockManager.isEnabled</h4>
384 <b>isEnabled</b>(<i></i>) 458 <b>isEnabled</b>(<i></i>)
385 <p> 459 <p>
386 Public method to check, if blocking ads is enabled. 460 Public method to check, if blocking ads is enabled.
387 </p><dl> 461 </p><dl>
388 <dt>Returns:</dt> 462 <dt>Returns:</dt>
389 <dd> 463 <dd>
390 flag indicating the enabled state (boolean) 464 flag indicating the enabled state
465 </dd>
466 </dl><dl>
467 <dt>Return Type:</dt>
468 <dd>
469 bool
391 </dd> 470 </dd>
392 </dl><a NAME="AdBlockManager.isHostExcepted" ID="AdBlockManager.isHostExcepted"></a> 471 </dl><a NAME="AdBlockManager.isHostExcepted" ID="AdBlockManager.isHostExcepted"></a>
393 <h4>AdBlockManager.isHostExcepted</h4> 472 <h4>AdBlockManager.isHostExcepted</h4>
394 <b>isHostExcepted</b>(<i>host</i>) 473 <b>isHostExcepted</b>(<i>host</i>)
395 <p> 474 <p>
396 Public slot to check, if a host is excepted. 475 Public slot to check, if a host is excepted.
397 </p><dl> 476 </p><dl>
398 <dt><i>host</i></dt> 477 <dt><i>host</i> (str)</dt>
399 <dd> 478 <dd>
400 host to check (string) 479 host to check
401 </dd> 480 </dd>
402 </dl><dl> 481 </dl><dl>
403 <dt>Returns:</dt> 482 <dt>Returns:</dt>
404 <dd> 483 <dd>
405 flag indicating an exception (boolean) 484 flag indicating an exception
485 </dd>
486 </dl><dl>
487 <dt>Return Type:</dt>
488 <dd>
489 bool
406 </dd> 490 </dd>
407 </dl><a NAME="AdBlockManager.load" ID="AdBlockManager.load"></a> 491 </dl><a NAME="AdBlockManager.load" ID="AdBlockManager.load"></a>
408 <h4>AdBlockManager.load</h4> 492 <h4>AdBlockManager.load</h4>
409 <b>load</b>(<i></i>) 493 <b>load</b>(<i></i>)
410 <p> 494 <p>
413 <h4>AdBlockManager.loadRequiredSubscription</h4> 497 <h4>AdBlockManager.loadRequiredSubscription</h4>
414 <b>loadRequiredSubscription</b>(<i>location, title</i>) 498 <b>loadRequiredSubscription</b>(<i>location, title</i>)
415 <p> 499 <p>
416 Public method to load a subscription required by another one. 500 Public method to load a subscription required by another one.
417 </p><dl> 501 </p><dl>
418 <dt><i>location</i></dt> 502 <dt><i>location</i> (str)</dt>
419 <dd> 503 <dd>
420 location of the required subscription (string) 504 location of the required subscription
421 </dd><dt><i>title</i></dt> 505 </dd><dt><i>title</i> (str)</dt>
422 <dd> 506 <dd>
423 title of the required subscription (string) 507 title of the required subscription
424 </dd> 508 </dd>
425 </dl><a NAME="AdBlockManager.page" ID="AdBlockManager.page"></a> 509 </dl><a NAME="AdBlockManager.page" ID="AdBlockManager.page"></a>
426 <h4>AdBlockManager.page</h4> 510 <h4>AdBlockManager.page</h4>
427 <b>page</b>(<i></i>) 511 <b>page</b>(<i></i>)
428 <p> 512 <p>
429 Public method to get a reference to the page block object. 513 Public method to get a reference to the page block object.
430 </p><dl> 514 </p><dl>
431 <dt>Returns:</dt> 515 <dt>Returns:</dt>
432 <dd> 516 <dd>
433 reference to the page block object (AdBlockPage) 517 reference to the page block object
518 </dd>
519 </dl><dl>
520 <dt>Return Type:</dt>
521 <dd>
522 AdBlockPage
434 </dd> 523 </dd>
435 </dl><a NAME="AdBlockManager.removeException" ID="AdBlockManager.removeException"></a> 524 </dl><a NAME="AdBlockManager.removeException" ID="AdBlockManager.removeException"></a>
436 <h4>AdBlockManager.removeException</h4> 525 <h4>AdBlockManager.removeException</h4>
437 <b>removeException</b>(<i>host</i>) 526 <b>removeException</b>(<i>host</i>)
438 <p> 527 <p>
439 Public method to remove an exception. 528 Public method to remove an exception.
440 </p><dl> 529 </p><dl>
441 <dt><i>host</i></dt> 530 <dt><i>host</i> (str)</dt>
442 <dd> 531 <dd>
443 to be removed from the list of exceptions (string) 532 to be removed from the list of exceptions
444 </dd> 533 </dd>
445 </dl><a NAME="AdBlockManager.removeSubscription" ID="AdBlockManager.removeSubscription"></a> 534 </dl><a NAME="AdBlockManager.removeSubscription" ID="AdBlockManager.removeSubscription"></a>
446 <h4>AdBlockManager.removeSubscription</h4> 535 <h4>AdBlockManager.removeSubscription</h4>
447 <b>removeSubscription</b>(<i>subscription, emitSignal=True</i>) 536 <b>removeSubscription</b>(<i>subscription, emitSignal=True</i>)
448 <p> 537 <p>
449 Public method to remove an AdBlock subscription. 538 Public method to remove an AdBlock subscription.
450 </p><dl> 539 </p><dl>
451 <dt><i>subscription</i></dt> 540 <dt><i>subscription</i> (AdBlockSubscription)</dt>
452 <dd> 541 <dd>
453 AdBlock subscription to be removed 542 AdBlock subscription to be removed
454 (AdBlockSubscription) 543 </dd><dt><i>emitSignal</i> (bool)</dt>
455 </dd><dt><i>emitSignal</i></dt> 544 <dd>
456 <dd> 545 flag indicating to send a signal
457 flag indicating to send a signal (boolean)
458 </dd> 546 </dd>
459 </dl><a NAME="AdBlockManager.save" ID="AdBlockManager.save"></a> 547 </dl><a NAME="AdBlockManager.save" ID="AdBlockManager.save"></a>
460 <h4>AdBlockManager.save</h4> 548 <h4>AdBlockManager.save</h4>
461 <b>save</b>(<i></i>) 549 <b>save</b>(<i></i>)
462 <p> 550 <p>
465 <h4>AdBlockManager.setEnabled</h4> 553 <h4>AdBlockManager.setEnabled</h4>
466 <b>setEnabled</b>(<i>enabled</i>) 554 <b>setEnabled</b>(<i>enabled</i>)
467 <p> 555 <p>
468 Public slot to set the enabled state. 556 Public slot to set the enabled state.
469 </p><dl> 557 </p><dl>
470 <dt><i>enabled</i></dt> 558 <dt><i>enabled</i> (bool)</dt>
471 <dd> 559 <dd>
472 flag indicating the enabled state (boolean) 560 flag indicating the enabled state
473 </dd> 561 </dd>
474 </dl><a NAME="AdBlockManager.setExceptions" ID="AdBlockManager.setExceptions"></a> 562 </dl><a NAME="AdBlockManager.setExceptions" ID="AdBlockManager.setExceptions"></a>
475 <h4>AdBlockManager.setExceptions</h4> 563 <h4>AdBlockManager.setExceptions</h4>
476 <b>setExceptions</b>(<i>hosts</i>) 564 <b>setExceptions</b>(<i>hosts</i>)
477 <p> 565 <p>
478 Public method to set the list of excepted hosts. 566 Public method to set the list of excepted hosts.
479 </p><dl> 567 </p><dl>
480 <dt><i>hosts</i></dt> 568 <dt><i>hosts</i> (list of str)</dt>
481 <dd> 569 <dd>
482 list of excepted hosts (list of string) 570 list of excepted hosts
483 </dd> 571 </dd>
484 </dl><a NAME="AdBlockManager.setUseLimitedEasyList" ID="AdBlockManager.setUseLimitedEasyList"></a> 572 </dl><a NAME="AdBlockManager.setUseLimitedEasyList" ID="AdBlockManager.setUseLimitedEasyList"></a>
485 <h4>AdBlockManager.setUseLimitedEasyList</h4> 573 <h4>AdBlockManager.setUseLimitedEasyList</h4>
486 <b>setUseLimitedEasyList</b>(<i>limited</i>) 574 <b>setUseLimitedEasyList</b>(<i>limited</i>)
487 <p> 575 <p>
497 <p> 585 <p>
498 Public slot to show the AdBlock subscription management dialog. 586 Public slot to show the AdBlock subscription management dialog.
499 </p><dl> 587 </p><dl>
500 <dt>Returns:</dt> 588 <dt>Returns:</dt>
501 <dd> 589 <dd>
502 reference to the dialog (AdBlockDialog) 590 reference to the dialog
591 </dd>
592 </dl><dl>
593 <dt>Return Type:</dt>
594 <dd>
595 AdBlockDialog
503 </dd> 596 </dd>
504 </dl><a NAME="AdBlockManager.showExceptionsDialog" ID="AdBlockManager.showExceptionsDialog"></a> 597 </dl><a NAME="AdBlockManager.showExceptionsDialog" ID="AdBlockManager.showExceptionsDialog"></a>
505 <h4>AdBlockManager.showExceptionsDialog</h4> 598 <h4>AdBlockManager.showExceptionsDialog</h4>
506 <b>showExceptionsDialog</b>(<i></i>) 599 <b>showExceptionsDialog</b>(<i></i>)
507 <p> 600 <p>
508 Public method to show the AdBlock Exceptions dialog. 601 Public method to show the AdBlock Exceptions dialog.
509 </p><dl> 602 </p><dl>
510 <dt>Returns:</dt> 603 <dt>Returns:</dt>
511 <dd> 604 <dd>
512 reference to the exceptions dialog (AdBlockExceptionsDialog) 605 reference to the exceptions dialog
606 </dd>
607 </dl><dl>
608 <dt>Return Type:</dt>
609 <dd>
610 AdBlockExceptionsDialog
513 </dd> 611 </dd>
514 </dl><a NAME="AdBlockManager.subscription" ID="AdBlockManager.subscription"></a> 612 </dl><a NAME="AdBlockManager.subscription" ID="AdBlockManager.subscription"></a>
515 <h4>AdBlockManager.subscription</h4> 613 <h4>AdBlockManager.subscription</h4>
516 <b>subscription</b>(<i>location</i>) 614 <b>subscription</b>(<i>location</i>)
517 <p> 615 <p>
518 Public method to get a subscription based on its location. 616 Public method to get a subscription based on its location.
519 </p><dl> 617 </p><dl>
520 <dt><i>location</i></dt> 618 <dt><i>location</i> (str)</dt>
521 <dd> 619 <dd>
522 location of the subscription to search for (string) 620 location of the subscription to search for
523 </dd> 621 </dd>
524 </dl><dl> 622 </dl><dl>
525 <dt>Returns:</dt> 623 <dt>Returns:</dt>
526 <dd> 624 <dd>
527 subscription or None (AdBlockSubscription) 625 subscription or None
626 </dd>
627 </dl><dl>
628 <dt>Return Type:</dt>
629 <dd>
630 AdBlockSubscription
528 </dd> 631 </dd>
529 </dl><a NAME="AdBlockManager.subscriptions" ID="AdBlockManager.subscriptions"></a> 632 </dl><a NAME="AdBlockManager.subscriptions" ID="AdBlockManager.subscriptions"></a>
530 <h4>AdBlockManager.subscriptions</h4> 633 <h4>AdBlockManager.subscriptions</h4>
531 <b>subscriptions</b>(<i></i>) 634 <b>subscriptions</b>(<i></i>)
532 <p> 635 <p>
533 Public method to get all subscriptions. 636 Public method to get all subscriptions.
534 </p><dl> 637 </p><dl>
535 <dt>Returns:</dt> 638 <dt>Returns:</dt>
536 <dd> 639 <dd>
537 list of subscriptions (list of AdBlockSubscription) 640 list of subscriptions
641 </dd>
642 </dl><dl>
643 <dt>Return Type:</dt>
644 <dd>
645 list of AdBlockSubscription
538 </dd> 646 </dd>
539 </dl><a NAME="AdBlockManager.updateAllSubscriptions" ID="AdBlockManager.updateAllSubscriptions"></a> 647 </dl><a NAME="AdBlockManager.updateAllSubscriptions" ID="AdBlockManager.updateAllSubscriptions"></a>
540 <h4>AdBlockManager.updateAllSubscriptions</h4> 648 <h4>AdBlockManager.updateAllSubscriptions</h4>
541 <b>updateAllSubscriptions</b>(<i></i>) 649 <b>updateAllSubscriptions</b>(<i></i>)
542 <p> 650 <p>

eric ide

mercurial