|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.WebBrowser.AdBlock.AdBlockManager</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.WebBrowser.AdBlock.AdBlockManager</h1> |
|
23 <p> |
|
24 Module implementing the AdBlock manager. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#AdBlockManager">AdBlockManager</a></td> |
|
34 <td>Class implementing the AdBlock manager.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="AdBlockManager" ID="AdBlockManager"></a> |
|
43 <h2>AdBlockManager</h2> |
|
44 <p> |
|
45 Class implementing the AdBlock manager. |
|
46 </p><h3>Signals</h3> |
|
47 <dl> |
|
48 <dt>enabledChanged(enabled)</dt> |
|
49 <dd> |
|
50 emitted to indicate a change of the |
|
51 enabled state |
|
52 </dd><dt>requiredSubscriptionLoaded(subscription)</dt> |
|
53 <dd> |
|
54 emitted to indicate |
|
55 loading of a required subscription is finished (AdBlockSubscription) |
|
56 </dd><dt>rulesChanged()</dt> |
|
57 <dd> |
|
58 emitted after some rule has changed |
|
59 </dd> |
|
60 </dl> |
|
61 <h3>Derived from</h3> |
|
62 QObject |
|
63 <h3>Class Attributes</h3> |
|
64 <table> |
|
65 <tr><td>None</td></tr> |
|
66 </table> |
|
67 <h3>Class Methods</h3> |
|
68 <table> |
|
69 <tr><td>None</td></tr> |
|
70 </table> |
|
71 <h3>Methods</h3> |
|
72 <table> |
|
73 <tr> |
|
74 <td><a href="#AdBlockManager.__init__">AdBlockManager</a></td> |
|
75 <td>Constructor</td> |
|
76 </tr><tr> |
|
77 <td><a href="#AdBlockManager.__canBeBlocked">__canBeBlocked</a></td> |
|
78 <td>Private method to check, if the given URL could be blocked (i.e.</td> |
|
79 </tr><tr> |
|
80 <td><a href="#AdBlockManager.__customSubscriptionLocation">__customSubscriptionLocation</a></td> |
|
81 <td>Private method to generate the path for custom subscriptions.</td> |
|
82 </tr><tr> |
|
83 <td><a href="#AdBlockManager.__customSubscriptionUrl">__customSubscriptionUrl</a></td> |
|
84 <td>Private method to generate the URL for custom subscriptions.</td> |
|
85 </tr><tr> |
|
86 <td><a href="#AdBlockManager.__loadSubscriptions">__loadSubscriptions</a></td> |
|
87 <td>Private method to load the set of subscriptions.</td> |
|
88 </tr><tr> |
|
89 <td><a href="#AdBlockManager.__rulesChanged">__rulesChanged</a></td> |
|
90 <td>Private slot handling a change of the AdBlock rules.</td> |
|
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> |
|
95 <td><a href="#AdBlockManager.addException">addException</a></td> |
|
96 <td>Public method to add an exception.</td> |
|
97 </tr><tr> |
|
98 <td><a href="#AdBlockManager.addSubscription">addSubscription</a></td> |
|
99 <td>Public method to add an AdBlock subscription.</td> |
|
100 </tr><tr> |
|
101 <td><a href="#AdBlockManager.addSubscriptionFromUrl">addSubscriptionFromUrl</a></td> |
|
102 <td>Public method to ad an AdBlock subscription given the abp URL.</td> |
|
103 </tr><tr> |
|
104 <td><a href="#AdBlockManager.block">block</a></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> |
|
109 </tr><tr> |
|
110 <td><a href="#AdBlockManager.close">close</a></td> |
|
111 <td>Public method to close the open search engines manager.</td> |
|
112 </tr><tr> |
|
113 <td><a href="#AdBlockManager.customRules">customRules</a></td> |
|
114 <td>Public method to get a subscription for custom rules.</td> |
|
115 </tr><tr> |
|
116 <td><a href="#AdBlockManager.elementHidingRules">elementHidingRules</a></td> |
|
117 <td>Public method to get the element hiding rules.</td> |
|
118 </tr><tr> |
|
119 <td><a href="#AdBlockManager.elementHidingRulesForDomain">elementHidingRulesForDomain</a></td> |
|
120 <td>Public method to get the element hiding rules for a domain.</td> |
|
121 </tr><tr> |
|
122 <td><a href="#AdBlockManager.exceptions">exceptions</a></td> |
|
123 <td>Public method to get a list of excepted hosts.</td> |
|
124 </tr><tr> |
|
125 <td><a href="#AdBlockManager.getDefaultSubscriptionUrl">getDefaultSubscriptionUrl</a></td> |
|
126 <td>Public method to get the default subscription URL.</td> |
|
127 </tr><tr> |
|
128 <td><a href="#AdBlockManager.getRequiresSubscriptions">getRequiresSubscriptions</a></td> |
|
129 <td>Public method to get a list of subscriptions, that require the given one.</td> |
|
130 </tr><tr> |
|
131 <td><a href="#AdBlockManager.isEnabled">isEnabled</a></td> |
|
132 <td>Public method to check, if blocking ads is enabled.</td> |
|
133 </tr><tr> |
|
134 <td><a href="#AdBlockManager.isHostExcepted">isHostExcepted</a></td> |
|
135 <td>Public slot to check, if a host is excepted.</td> |
|
136 </tr><tr> |
|
137 <td><a href="#AdBlockManager.load">load</a></td> |
|
138 <td>Public method to load the AdBlock subscriptions.</td> |
|
139 </tr><tr> |
|
140 <td><a href="#AdBlockManager.loadRequiredSubscription">loadRequiredSubscription</a></td> |
|
141 <td>Public method to load a subscription required by another one.</td> |
|
142 </tr><tr> |
|
143 <td><a href="#AdBlockManager.page">page</a></td> |
|
144 <td>Public method to get a reference to the page block object.</td> |
|
145 </tr><tr> |
|
146 <td><a href="#AdBlockManager.removeException">removeException</a></td> |
|
147 <td>Public method to remove an exception.</td> |
|
148 </tr><tr> |
|
149 <td><a href="#AdBlockManager.removeSubscription">removeSubscription</a></td> |
|
150 <td>Public method to remove an AdBlock subscription.</td> |
|
151 </tr><tr> |
|
152 <td><a href="#AdBlockManager.save">save</a></td> |
|
153 <td>Public method to save the AdBlock subscriptions.</td> |
|
154 </tr><tr> |
|
155 <td><a href="#AdBlockManager.setEnabled">setEnabled</a></td> |
|
156 <td>Public slot to set the enabled state.</td> |
|
157 </tr><tr> |
|
158 <td><a href="#AdBlockManager.setExceptions">setExceptions</a></td> |
|
159 <td>Public method to set the list of excepted hosts.</td> |
|
160 </tr><tr> |
|
161 <td><a href="#AdBlockManager.setUseLimitedEasyList">setUseLimitedEasyList</a></td> |
|
162 <td>Public method to set the limited EasyList flag.</td> |
|
163 </tr><tr> |
|
164 <td><a href="#AdBlockManager.showDialog">showDialog</a></td> |
|
165 <td>Public slot to show the AdBlock subscription management dialog.</td> |
|
166 </tr><tr> |
|
167 <td><a href="#AdBlockManager.showExceptionsDialog">showExceptionsDialog</a></td> |
|
168 <td>Public method to show the AdBlock Exceptions dialog.</td> |
|
169 </tr><tr> |
|
170 <td><a href="#AdBlockManager.subscription">subscription</a></td> |
|
171 <td>Public method to get a subscription based on its location.</td> |
|
172 </tr><tr> |
|
173 <td><a href="#AdBlockManager.subscriptions">subscriptions</a></td> |
|
174 <td>Public method to get all subscriptions.</td> |
|
175 </tr><tr> |
|
176 <td><a href="#AdBlockManager.updateAllSubscriptions">updateAllSubscriptions</a></td> |
|
177 <td>Public method to update all subscriptions.</td> |
|
178 </tr><tr> |
|
179 <td><a href="#AdBlockManager.useLimitedEasyList">useLimitedEasyList</a></td> |
|
180 <td>Public method to test, if limited EasyList rules shall be used.</td> |
|
181 </tr> |
|
182 </table> |
|
183 <h3>Static Methods</h3> |
|
184 <table> |
|
185 <tr><td>None</td></tr> |
|
186 </table> |
|
187 <a NAME="AdBlockManager.__init__" ID="AdBlockManager.__init__"></a> |
|
188 <h4>AdBlockManager (Constructor)</h4> |
|
189 <b>AdBlockManager</b>(<i>parent=None</i>) |
|
190 <p> |
|
191 Constructor |
|
192 </p><dl> |
|
193 <dt><i>parent</i> (QObject)</dt> |
|
194 <dd> |
|
195 reference to the parent object |
|
196 </dd> |
|
197 </dl><a NAME="AdBlockManager.__canBeBlocked" ID="AdBlockManager.__canBeBlocked"></a> |
|
198 <h4>AdBlockManager.__canBeBlocked</h4> |
|
199 <b>__canBeBlocked</b>(<i>url</i>) |
|
200 <p> |
|
201 Private method to check, if the given URL could be blocked (i.e. is |
|
202 not whitelisted). |
|
203 </p><dl> |
|
204 <dt><i>url</i> (QUrl)</dt> |
|
205 <dd> |
|
206 URL to be checked |
|
207 </dd> |
|
208 </dl><dl> |
|
209 <dt>Returns:</dt> |
|
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 |
|
217 </dd> |
|
218 </dl><a NAME="AdBlockManager.__customSubscriptionLocation" ID="AdBlockManager.__customSubscriptionLocation"></a> |
|
219 <h4>AdBlockManager.__customSubscriptionLocation</h4> |
|
220 <b>__customSubscriptionLocation</b>(<i></i>) |
|
221 <p> |
|
222 Private method to generate the path for custom subscriptions. |
|
223 </p><dl> |
|
224 <dt>Returns:</dt> |
|
225 <dd> |
|
226 URL for custom subscriptions |
|
227 </dd> |
|
228 </dl><dl> |
|
229 <dt>Return Type:</dt> |
|
230 <dd> |
|
231 QUrl |
|
232 </dd> |
|
233 </dl><a NAME="AdBlockManager.__customSubscriptionUrl" ID="AdBlockManager.__customSubscriptionUrl"></a> |
|
234 <h4>AdBlockManager.__customSubscriptionUrl</h4> |
|
235 <b>__customSubscriptionUrl</b>(<i></i>) |
|
236 <p> |
|
237 Private method to generate the URL for custom subscriptions. |
|
238 </p><dl> |
|
239 <dt>Returns:</dt> |
|
240 <dd> |
|
241 URL for custom subscriptions |
|
242 </dd> |
|
243 </dl><dl> |
|
244 <dt>Return Type:</dt> |
|
245 <dd> |
|
246 QUrl |
|
247 </dd> |
|
248 </dl><a NAME="AdBlockManager.__loadSubscriptions" ID="AdBlockManager.__loadSubscriptions"></a> |
|
249 <h4>AdBlockManager.__loadSubscriptions</h4> |
|
250 <b>__loadSubscriptions</b>(<i></i>) |
|
251 <p> |
|
252 Private method to load the set of subscriptions. |
|
253 </p><a NAME="AdBlockManager.__rulesChanged" ID="AdBlockManager.__rulesChanged"></a> |
|
254 <h4>AdBlockManager.__rulesChanged</h4> |
|
255 <b>__rulesChanged</b>(<i></i>) |
|
256 <p> |
|
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. |
|
263 </p><a NAME="AdBlockManager.addException" ID="AdBlockManager.addException"></a> |
|
264 <h4>AdBlockManager.addException</h4> |
|
265 <b>addException</b>(<i>host</i>) |
|
266 <p> |
|
267 Public method to add an exception. |
|
268 </p><dl> |
|
269 <dt><i>host</i> (str)</dt> |
|
270 <dd> |
|
271 to be excepted |
|
272 </dd> |
|
273 </dl><a NAME="AdBlockManager.addSubscription" ID="AdBlockManager.addSubscription"></a> |
|
274 <h4>AdBlockManager.addSubscription</h4> |
|
275 <b>addSubscription</b>(<i>subscription</i>) |
|
276 <p> |
|
277 Public method to add an AdBlock subscription. |
|
278 </p><dl> |
|
279 <dt><i>subscription</i> (AdBlockSubscription)</dt> |
|
280 <dd> |
|
281 AdBlock subscription to be added |
|
282 </dd> |
|
283 </dl><a NAME="AdBlockManager.addSubscriptionFromUrl" ID="AdBlockManager.addSubscriptionFromUrl"></a> |
|
284 <h4>AdBlockManager.addSubscriptionFromUrl</h4> |
|
285 <b>addSubscriptionFromUrl</b>(<i>url</i>) |
|
286 <p> |
|
287 Public method to ad an AdBlock subscription given the abp URL. |
|
288 </p><dl> |
|
289 <dt><i>url</i> (QUrl)</dt> |
|
290 <dd> |
|
291 URL to subscribe an AdBlock subscription |
|
292 </dd> |
|
293 </dl><dl> |
|
294 <dt>Returns:</dt> |
|
295 <dd> |
|
296 flag indicating success |
|
297 </dd> |
|
298 </dl><dl> |
|
299 <dt>Return Type:</dt> |
|
300 <dd> |
|
301 bool |
|
302 </dd> |
|
303 </dl><a NAME="AdBlockManager.block" ID="AdBlockManager.block"></a> |
|
304 <h4>AdBlockManager.block</h4> |
|
305 <b>block</b>(<i>info</i>) |
|
306 <p> |
|
307 Public method to check, if a request should be blocked. |
|
308 </p><dl> |
|
309 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt> |
|
310 <dd> |
|
311 request info object |
|
312 </dd> |
|
313 </dl><dl> |
|
314 <dt>Returns:</dt> |
|
315 <dd> |
|
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 |
|
337 </dd> |
|
338 </dl><dl> |
|
339 <dt>Return Type:</dt> |
|
340 <dd> |
|
341 bool |
|
342 </dd> |
|
343 </dl><a NAME="AdBlockManager.close" ID="AdBlockManager.close"></a> |
|
344 <h4>AdBlockManager.close</h4> |
|
345 <b>close</b>(<i></i>) |
|
346 <p> |
|
347 Public method to close the open search engines manager. |
|
348 </p><a NAME="AdBlockManager.customRules" ID="AdBlockManager.customRules"></a> |
|
349 <h4>AdBlockManager.customRules</h4> |
|
350 <b>customRules</b>(<i></i>) |
|
351 <p> |
|
352 Public method to get a subscription for custom rules. |
|
353 </p><dl> |
|
354 <dt>Returns:</dt> |
|
355 <dd> |
|
356 subscription object for custom rules |
|
357 </dd> |
|
358 </dl><dl> |
|
359 <dt>Return Type:</dt> |
|
360 <dd> |
|
361 AdBlockSubscription |
|
362 </dd> |
|
363 </dl><a NAME="AdBlockManager.elementHidingRules" ID="AdBlockManager.elementHidingRules"></a> |
|
364 <h4>AdBlockManager.elementHidingRules</h4> |
|
365 <b>elementHidingRules</b>(<i>url</i>) |
|
366 <p> |
|
367 Public method to get the element hiding rules. |
|
368 </p><p> |
|
369 |
|
370 </p><dl> |
|
371 <dt><i>url</i> (QUrl)</dt> |
|
372 <dd> |
|
373 URL to get hiding rules for |
|
374 </dd> |
|
375 </dl><dl> |
|
376 <dt>Returns:</dt> |
|
377 <dd> |
|
378 element hiding rules |
|
379 </dd> |
|
380 </dl><dl> |
|
381 <dt>Return Type:</dt> |
|
382 <dd> |
|
383 str |
|
384 </dd> |
|
385 </dl><a NAME="AdBlockManager.elementHidingRulesForDomain" ID="AdBlockManager.elementHidingRulesForDomain"></a> |
|
386 <h4>AdBlockManager.elementHidingRulesForDomain</h4> |
|
387 <b>elementHidingRulesForDomain</b>(<i>url</i>) |
|
388 <p> |
|
389 Public method to get the element hiding rules for a domain. |
|
390 </p><dl> |
|
391 <dt><i>url</i> (QUrl)</dt> |
|
392 <dd> |
|
393 URL to get hiding rules for |
|
394 </dd> |
|
395 </dl><dl> |
|
396 <dt>Returns:</dt> |
|
397 <dd> |
|
398 element hiding rules |
|
399 </dd> |
|
400 </dl><dl> |
|
401 <dt>Return Type:</dt> |
|
402 <dd> |
|
403 str |
|
404 </dd> |
|
405 </dl><a NAME="AdBlockManager.exceptions" ID="AdBlockManager.exceptions"></a> |
|
406 <h4>AdBlockManager.exceptions</h4> |
|
407 <b>exceptions</b>(<i></i>) |
|
408 <p> |
|
409 Public method to get a list of excepted hosts. |
|
410 </p><dl> |
|
411 <dt>Returns:</dt> |
|
412 <dd> |
|
413 list of excepted hosts |
|
414 </dd> |
|
415 </dl><dl> |
|
416 <dt>Return Type:</dt> |
|
417 <dd> |
|
418 list of str |
|
419 </dd> |
|
420 </dl><a NAME="AdBlockManager.getDefaultSubscriptionUrl" ID="AdBlockManager.getDefaultSubscriptionUrl"></a> |
|
421 <h4>AdBlockManager.getDefaultSubscriptionUrl</h4> |
|
422 <b>getDefaultSubscriptionUrl</b>(<i></i>) |
|
423 <p> |
|
424 Public method to get the default subscription URL. |
|
425 </p><dl> |
|
426 <dt>Returns:</dt> |
|
427 <dd> |
|
428 default subscription URL |
|
429 </dd> |
|
430 </dl><dl> |
|
431 <dt>Return Type:</dt> |
|
432 <dd> |
|
433 str |
|
434 </dd> |
|
435 </dl><a NAME="AdBlockManager.getRequiresSubscriptions" ID="AdBlockManager.getRequiresSubscriptions"></a> |
|
436 <h4>AdBlockManager.getRequiresSubscriptions</h4> |
|
437 <b>getRequiresSubscriptions</b>(<i>subscription</i>) |
|
438 <p> |
|
439 Public method to get a list of subscriptions, that require the given |
|
440 one. |
|
441 </p><dl> |
|
442 <dt><i>subscription</i> (AdBlockSubscription)</dt> |
|
443 <dd> |
|
444 subscription to check for |
|
445 </dd> |
|
446 </dl><dl> |
|
447 <dt>Returns:</dt> |
|
448 <dd> |
|
449 list of subscription requiring the given one |
|
450 </dd> |
|
451 </dl><dl> |
|
452 <dt>Return Type:</dt> |
|
453 <dd> |
|
454 list of AdBlockSubscription |
|
455 </dd> |
|
456 </dl><a NAME="AdBlockManager.isEnabled" ID="AdBlockManager.isEnabled"></a> |
|
457 <h4>AdBlockManager.isEnabled</h4> |
|
458 <b>isEnabled</b>(<i></i>) |
|
459 <p> |
|
460 Public method to check, if blocking ads is enabled. |
|
461 </p><dl> |
|
462 <dt>Returns:</dt> |
|
463 <dd> |
|
464 flag indicating the enabled state |
|
465 </dd> |
|
466 </dl><dl> |
|
467 <dt>Return Type:</dt> |
|
468 <dd> |
|
469 bool |
|
470 </dd> |
|
471 </dl><a NAME="AdBlockManager.isHostExcepted" ID="AdBlockManager.isHostExcepted"></a> |
|
472 <h4>AdBlockManager.isHostExcepted</h4> |
|
473 <b>isHostExcepted</b>(<i>host</i>) |
|
474 <p> |
|
475 Public slot to check, if a host is excepted. |
|
476 </p><dl> |
|
477 <dt><i>host</i> (str)</dt> |
|
478 <dd> |
|
479 host to check |
|
480 </dd> |
|
481 </dl><dl> |
|
482 <dt>Returns:</dt> |
|
483 <dd> |
|
484 flag indicating an exception |
|
485 </dd> |
|
486 </dl><dl> |
|
487 <dt>Return Type:</dt> |
|
488 <dd> |
|
489 bool |
|
490 </dd> |
|
491 </dl><a NAME="AdBlockManager.load" ID="AdBlockManager.load"></a> |
|
492 <h4>AdBlockManager.load</h4> |
|
493 <b>load</b>(<i></i>) |
|
494 <p> |
|
495 Public method to load the AdBlock subscriptions. |
|
496 </p><a NAME="AdBlockManager.loadRequiredSubscription" ID="AdBlockManager.loadRequiredSubscription"></a> |
|
497 <h4>AdBlockManager.loadRequiredSubscription</h4> |
|
498 <b>loadRequiredSubscription</b>(<i>location, title</i>) |
|
499 <p> |
|
500 Public method to load a subscription required by another one. |
|
501 </p><dl> |
|
502 <dt><i>location</i> (str)</dt> |
|
503 <dd> |
|
504 location of the required subscription |
|
505 </dd><dt><i>title</i> (str)</dt> |
|
506 <dd> |
|
507 title of the required subscription |
|
508 </dd> |
|
509 </dl><a NAME="AdBlockManager.page" ID="AdBlockManager.page"></a> |
|
510 <h4>AdBlockManager.page</h4> |
|
511 <b>page</b>(<i></i>) |
|
512 <p> |
|
513 Public method to get a reference to the page block object. |
|
514 </p><dl> |
|
515 <dt>Returns:</dt> |
|
516 <dd> |
|
517 reference to the page block object |
|
518 </dd> |
|
519 </dl><dl> |
|
520 <dt>Return Type:</dt> |
|
521 <dd> |
|
522 AdBlockPage |
|
523 </dd> |
|
524 </dl><a NAME="AdBlockManager.removeException" ID="AdBlockManager.removeException"></a> |
|
525 <h4>AdBlockManager.removeException</h4> |
|
526 <b>removeException</b>(<i>host</i>) |
|
527 <p> |
|
528 Public method to remove an exception. |
|
529 </p><dl> |
|
530 <dt><i>host</i> (str)</dt> |
|
531 <dd> |
|
532 to be removed from the list of exceptions |
|
533 </dd> |
|
534 </dl><a NAME="AdBlockManager.removeSubscription" ID="AdBlockManager.removeSubscription"></a> |
|
535 <h4>AdBlockManager.removeSubscription</h4> |
|
536 <b>removeSubscription</b>(<i>subscription, emitSignal=True</i>) |
|
537 <p> |
|
538 Public method to remove an AdBlock subscription. |
|
539 </p><dl> |
|
540 <dt><i>subscription</i> (AdBlockSubscription)</dt> |
|
541 <dd> |
|
542 AdBlock subscription to be removed |
|
543 </dd><dt><i>emitSignal</i> (bool)</dt> |
|
544 <dd> |
|
545 flag indicating to send a signal |
|
546 </dd> |
|
547 </dl><a NAME="AdBlockManager.save" ID="AdBlockManager.save"></a> |
|
548 <h4>AdBlockManager.save</h4> |
|
549 <b>save</b>(<i></i>) |
|
550 <p> |
|
551 Public method to save the AdBlock subscriptions. |
|
552 </p><a NAME="AdBlockManager.setEnabled" ID="AdBlockManager.setEnabled"></a> |
|
553 <h4>AdBlockManager.setEnabled</h4> |
|
554 <b>setEnabled</b>(<i>enabled</i>) |
|
555 <p> |
|
556 Public slot to set the enabled state. |
|
557 </p><dl> |
|
558 <dt><i>enabled</i> (bool)</dt> |
|
559 <dd> |
|
560 flag indicating the enabled state |
|
561 </dd> |
|
562 </dl><a NAME="AdBlockManager.setExceptions" ID="AdBlockManager.setExceptions"></a> |
|
563 <h4>AdBlockManager.setExceptions</h4> |
|
564 <b>setExceptions</b>(<i>hosts</i>) |
|
565 <p> |
|
566 Public method to set the list of excepted hosts. |
|
567 </p><dl> |
|
568 <dt><i>hosts</i> (list of str)</dt> |
|
569 <dd> |
|
570 list of excepted hosts |
|
571 </dd> |
|
572 </dl><a NAME="AdBlockManager.setUseLimitedEasyList" ID="AdBlockManager.setUseLimitedEasyList"></a> |
|
573 <h4>AdBlockManager.setUseLimitedEasyList</h4> |
|
574 <b>setUseLimitedEasyList</b>(<i>limited</i>) |
|
575 <p> |
|
576 Public method to set the limited EasyList flag. |
|
577 </p><dl> |
|
578 <dt><i>limited</i> (bool)</dt> |
|
579 <dd> |
|
580 flag indicating to use limited EasyList |
|
581 </dd> |
|
582 </dl><a NAME="AdBlockManager.showDialog" ID="AdBlockManager.showDialog"></a> |
|
583 <h4>AdBlockManager.showDialog</h4> |
|
584 <b>showDialog</b>(<i></i>) |
|
585 <p> |
|
586 Public slot to show the AdBlock subscription management dialog. |
|
587 </p><dl> |
|
588 <dt>Returns:</dt> |
|
589 <dd> |
|
590 reference to the dialog |
|
591 </dd> |
|
592 </dl><dl> |
|
593 <dt>Return Type:</dt> |
|
594 <dd> |
|
595 AdBlockDialog |
|
596 </dd> |
|
597 </dl><a NAME="AdBlockManager.showExceptionsDialog" ID="AdBlockManager.showExceptionsDialog"></a> |
|
598 <h4>AdBlockManager.showExceptionsDialog</h4> |
|
599 <b>showExceptionsDialog</b>(<i></i>) |
|
600 <p> |
|
601 Public method to show the AdBlock Exceptions dialog. |
|
602 </p><dl> |
|
603 <dt>Returns:</dt> |
|
604 <dd> |
|
605 reference to the exceptions dialog |
|
606 </dd> |
|
607 </dl><dl> |
|
608 <dt>Return Type:</dt> |
|
609 <dd> |
|
610 AdBlockExceptionsDialog |
|
611 </dd> |
|
612 </dl><a NAME="AdBlockManager.subscription" ID="AdBlockManager.subscription"></a> |
|
613 <h4>AdBlockManager.subscription</h4> |
|
614 <b>subscription</b>(<i>location</i>) |
|
615 <p> |
|
616 Public method to get a subscription based on its location. |
|
617 </p><dl> |
|
618 <dt><i>location</i> (str)</dt> |
|
619 <dd> |
|
620 location of the subscription to search for |
|
621 </dd> |
|
622 </dl><dl> |
|
623 <dt>Returns:</dt> |
|
624 <dd> |
|
625 subscription or None |
|
626 </dd> |
|
627 </dl><dl> |
|
628 <dt>Return Type:</dt> |
|
629 <dd> |
|
630 AdBlockSubscription |
|
631 </dd> |
|
632 </dl><a NAME="AdBlockManager.subscriptions" ID="AdBlockManager.subscriptions"></a> |
|
633 <h4>AdBlockManager.subscriptions</h4> |
|
634 <b>subscriptions</b>(<i></i>) |
|
635 <p> |
|
636 Public method to get all subscriptions. |
|
637 </p><dl> |
|
638 <dt>Returns:</dt> |
|
639 <dd> |
|
640 list of subscriptions |
|
641 </dd> |
|
642 </dl><dl> |
|
643 <dt>Return Type:</dt> |
|
644 <dd> |
|
645 list of AdBlockSubscription |
|
646 </dd> |
|
647 </dl><a NAME="AdBlockManager.updateAllSubscriptions" ID="AdBlockManager.updateAllSubscriptions"></a> |
|
648 <h4>AdBlockManager.updateAllSubscriptions</h4> |
|
649 <b>updateAllSubscriptions</b>(<i></i>) |
|
650 <p> |
|
651 Public method to update all subscriptions. |
|
652 </p><a NAME="AdBlockManager.useLimitedEasyList" ID="AdBlockManager.useLimitedEasyList"></a> |
|
653 <h4>AdBlockManager.useLimitedEasyList</h4> |
|
654 <b>useLimitedEasyList</b>(<i></i>) |
|
655 <p> |
|
656 Public method to test, if limited EasyList rules shall be used. |
|
657 </p><dl> |
|
658 <dt>Returns:</dt> |
|
659 <dd> |
|
660 flag indicating limited EasyList rules |
|
661 </dd> |
|
662 </dl><dl> |
|
663 <dt>Return Type:</dt> |
|
664 <dd> |
|
665 bool |
|
666 </dd> |
|
667 </dl> |
|
668 <div align="right"><a href="#top">Up</a></div> |
|
669 <hr /> |
|
670 </body></html> |