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

branch
maintenance
changeset 6050
25a4ddb25ca4
parent 6028
859f6894eed9
child 6123
39cd368143db
equal deleted inserted replaced
6005:6914826302ae 6050:25a4ddb25ca4
52 <dd> 52 <dd>
53 emitted after the enabled state was changed 53 emitted after the enabled state was changed
54 </dd><dt>rulesChanged()</dt> 54 </dd><dt>rulesChanged()</dt>
55 <dd> 55 <dd>
56 emitted after the subscription's rules have changed 56 emitted after the subscription's rules have changed
57 </dd><dt>rulesEnabledChanged()</dt>
58 <dd>
59 emitted after a rule enabled state was
60 changed
57 </dd> 61 </dd>
58 </dl> 62 </dl>
59 <h3>Derived from</h3> 63 <h3>Derived from</h3>
60 QObject 64 QObject
61 <h3>Class Attributes</h3> 65 <h3>Class Attributes</h3>
76 <td>Private method to load the rules of the subscription.</td> 80 <td>Private method to load the rules of the subscription.</td>
77 </tr><tr> 81 </tr><tr>
78 <td><a href="#AdBlockSubscription.__parseUrl">__parseUrl</a></td> 82 <td><a href="#AdBlockSubscription.__parseUrl">__parseUrl</a></td>
79 <td>Private method to parse the AdBlock URL for the subscription.</td> 83 <td>Private method to parse the AdBlock URL for the subscription.</td>
80 </tr><tr> 84 </tr><tr>
81 <td><a href="#AdBlockSubscription.__populateCache">__populateCache</a></td>
82 <td>Private method to populate the various rule caches.</td>
83 </tr><tr>
84 <td><a href="#AdBlockSubscription.__rulesDownloaded">__rulesDownloaded</a></td> 85 <td><a href="#AdBlockSubscription.__rulesDownloaded">__rulesDownloaded</a></td>
85 <td>Private slot to deal with the downloaded rules.</td> 86 <td>Private slot to deal with the downloaded rules.</td>
86 </tr><tr> 87 </tr><tr>
87 <td><a href="#AdBlockSubscription.__validateCheckSum">__validateCheckSum</a></td> 88 <td><a href="#AdBlockSubscription.__validateCheckSum">__validateCheckSum</a></td>
88 <td>Private method to check the subscription file's checksum.</td> 89 <td>Private method to check the subscription file's checksum.</td>
89 </tr><tr> 90 </tr><tr>
90 <td><a href="#AdBlockSubscription.adBlockDisabledForUrl">adBlockDisabledForUrl</a></td>
91 <td>Public method to check, if AdBlock is disabled for the given URL.</td>
92 </tr><tr>
93 <td><a href="#AdBlockSubscription.addRule">addRule</a></td> 91 <td><a href="#AdBlockSubscription.addRule">addRule</a></td>
94 <td>Public method to add a rule.</td> 92 <td>Public method to add a rule.</td>
95 </tr><tr> 93 </tr><tr>
96 <td><a href="#AdBlockSubscription.allRules">allRules</a></td> 94 <td><a href="#AdBlockSubscription.allRules">allRules</a></td>
97 <td>Public method to get the list of rules.</td> 95 <td>Public method to get the list of rules.</td>
103 <td>Public method to check, if rules can be edited.</td> 101 <td>Public method to check, if rules can be edited.</td>
104 </tr><tr> 102 </tr><tr>
105 <td><a href="#AdBlockSubscription.checkForUpdate">checkForUpdate</a></td> 103 <td><a href="#AdBlockSubscription.checkForUpdate">checkForUpdate</a></td>
106 <td>Public method to check for an update.</td> 104 <td>Public method to check for an update.</td>
107 </tr><tr> 105 </tr><tr>
108 <td><a href="#AdBlockSubscription.elemHideDisabledForUrl">elemHideDisabledForUrl</a></td>
109 <td>Public method to check, if element hiding is disabled for the given URL.</td>
110 </tr><tr>
111 <td><a href="#AdBlockSubscription.elementHidingRules">elementHidingRules</a></td>
112 <td>Public method to get the element hiding rules.</td>
113 </tr><tr>
114 <td><a href="#AdBlockSubscription.elementHidingRulesForDomain">elementHidingRulesForDomain</a></td>
115 <td>Public method to get the element hiding rules for the given domain.</td>
116 </tr><tr>
117 <td><a href="#AdBlockSubscription.isEnabled">isEnabled</a></td> 106 <td><a href="#AdBlockSubscription.isEnabled">isEnabled</a></td>
118 <td>Public method to check, if the subscription is enabled.</td> 107 <td>Public method to check, if the subscription is enabled.</td>
119 </tr><tr> 108 </tr><tr>
120 <td><a href="#AdBlockSubscription.lastUpdate">lastUpdate</a></td> 109 <td><a href="#AdBlockSubscription.lastUpdate">lastUpdate</a></td>
121 <td>Public method to get the date and time of the last update.</td> 110 <td>Public method to get the date and time of the last update.</td>
122 </tr><tr> 111 </tr><tr>
123 <td><a href="#AdBlockSubscription.location">location</a></td> 112 <td><a href="#AdBlockSubscription.location">location</a></td>
124 <td>Public method to get the subscription location.</td> 113 <td>Public method to get the subscription location.</td>
125 </tr><tr>
126 <td><a href="#AdBlockSubscription.match">match</a></td>
127 <td>Public method to check the subscription for a matching rule.</td>
128 </tr><tr> 114 </tr><tr>
129 <td><a href="#AdBlockSubscription.removeRule">removeRule</a></td> 115 <td><a href="#AdBlockSubscription.removeRule">removeRule</a></td>
130 <td>Public method to remove a rule given the offset.</td> 116 <td>Public method to remove a rule given the offset.</td>
131 </tr><tr> 117 </tr><tr>
132 <td><a href="#AdBlockSubscription.replaceRule">replaceRule</a></td> 118 <td><a href="#AdBlockSubscription.replaceRule">replaceRule</a></td>
198 <h4>AdBlockSubscription.__parseUrl</h4> 184 <h4>AdBlockSubscription.__parseUrl</h4>
199 <b>__parseUrl</b>(<i>url</i>) 185 <b>__parseUrl</b>(<i>url</i>)
200 <p> 186 <p>
201 Private method to parse the AdBlock URL for the subscription. 187 Private method to parse the AdBlock URL for the subscription.
202 </p><dl> 188 </p><dl>
203 <dt><i>url</i></dt> 189 <dt><i>url</i> (QUrl)</dt>
204 <dd> 190 <dd>
205 AdBlock URL for the subscription (QUrl) 191 AdBlock URL for the subscription
206 </dd> 192 </dd>
207 </dl><a NAME="AdBlockSubscription.__populateCache" ID="AdBlockSubscription.__populateCache"></a> 193 </dl><a NAME="AdBlockSubscription.__rulesDownloaded" ID="AdBlockSubscription.__rulesDownloaded"></a>
208 <h4>AdBlockSubscription.__populateCache</h4>
209 <b>__populateCache</b>(<i></i>)
210 <p>
211 Private method to populate the various rule caches.
212 </p><a NAME="AdBlockSubscription.__rulesDownloaded" ID="AdBlockSubscription.__rulesDownloaded"></a>
213 <h4>AdBlockSubscription.__rulesDownloaded</h4> 194 <h4>AdBlockSubscription.__rulesDownloaded</h4>
214 <b>__rulesDownloaded</b>(<i></i>) 195 <b>__rulesDownloaded</b>(<i></i>)
215 <p> 196 <p>
216 Private slot to deal with the downloaded rules. 197 Private slot to deal with the downloaded rules.
217 </p><a NAME="AdBlockSubscription.__validateCheckSum" ID="AdBlockSubscription.__validateCheckSum"></a> 198 </p><a NAME="AdBlockSubscription.__validateCheckSum" ID="AdBlockSubscription.__validateCheckSum"></a>
218 <h4>AdBlockSubscription.__validateCheckSum</h4> 199 <h4>AdBlockSubscription.__validateCheckSum</h4>
219 <b>__validateCheckSum</b>(<i>fileName</i>) 200 <b>__validateCheckSum</b>(<i>fileName</i>)
220 <p> 201 <p>
221 Private method to check the subscription file's checksum. 202 Private method to check the subscription file's checksum.
222 </p><dl> 203 </p><dl>
223 <dt><i>fileName</i></dt> 204 <dt><i>fileName</i> (str)</dt>
224 <dd> 205 <dd>
225 name of the file containing the subscription (string) 206 name of the file containing the subscription
226 </dd> 207 </dd>
227 </dl><dl> 208 </dl><dl>
228 <dt>Returns:</dt> 209 <dt>Returns:</dt>
229 <dd> 210 <dd>
230 flag indicating a valid file (boolean). A file is considered 211 flag indicating a valid file. A file is considered
231 valid, if the checksum is OK, the file does not contain a 212 valid, if the checksum is OK, the file does not contain a
232 checksum (i.e. cannot be checked) or we are using the limited 213 checksum (i.e. cannot be checked) or we are using the limited
233 EasyList (because we fiddled with the original). 214 EasyList (because we fiddled with the original).
234 </dd> 215 </dd>
235 </dl><a NAME="AdBlockSubscription.adBlockDisabledForUrl" ID="AdBlockSubscription.adBlockDisabledForUrl"></a> 216 </dl><dl>
236 <h4>AdBlockSubscription.adBlockDisabledForUrl</h4> 217 <dt>Return Type:</dt>
237 <b>adBlockDisabledForUrl</b>(<i>url</i>) 218 <dd>
238 <p> 219 bool
239 Public method to check, if AdBlock is disabled for the given URL.
240 </p><dl>
241 <dt><i>url</i></dt>
242 <dd>
243 URL to check (QUrl)
244 </dd>
245 </dl><dl>
246 <dt>Returns:</dt>
247 <dd>
248 flag indicating disabled state (boolean)
249 </dd> 220 </dd>
250 </dl><a NAME="AdBlockSubscription.addRule" ID="AdBlockSubscription.addRule"></a> 221 </dl><a NAME="AdBlockSubscription.addRule" ID="AdBlockSubscription.addRule"></a>
251 <h4>AdBlockSubscription.addRule</h4> 222 <h4>AdBlockSubscription.addRule</h4>
252 <b>addRule</b>(<i>rule</i>) 223 <b>addRule</b>(<i>rule</i>)
253 <p> 224 <p>
254 Public method to add a rule. 225 Public method to add a rule.
255 </p><dl> 226 </p><dl>
256 <dt><i>rule</i></dt> 227 <dt><i>rule</i> (AdBlockRule)</dt>
257 <dd> 228 <dd>
258 reference to the rule to add (AdBlockRule) 229 reference to the rule to add
259 </dd> 230 </dd>
260 </dl><dl> 231 </dl><dl>
261 <dt>Returns:</dt> 232 <dt>Returns:</dt>
262 <dd> 233 <dd>
263 offset of the rule (integer) 234 offset of the rule
235 </dd>
236 </dl><dl>
237 <dt>Return Type:</dt>
238 <dd>
239 int
264 </dd> 240 </dd>
265 </dl><a NAME="AdBlockSubscription.allRules" ID="AdBlockSubscription.allRules"></a> 241 </dl><a NAME="AdBlockSubscription.allRules" ID="AdBlockSubscription.allRules"></a>
266 <h4>AdBlockSubscription.allRules</h4> 242 <h4>AdBlockSubscription.allRules</h4>
267 <b>allRules</b>(<i></i>) 243 <b>allRules</b>(<i></i>)
268 <p> 244 <p>
269 Public method to get the list of rules. 245 Public method to get the list of rules.
270 </p><dl> 246 </p><dl>
271 <dt>Returns:</dt> 247 <dt>Returns:</dt>
272 <dd> 248 <dd>
273 list of rules (list of AdBlockRule) 249 list of rules
250 </dd>
251 </dl><dl>
252 <dt>Return Type:</dt>
253 <dd>
254 list of AdBlockRule
274 </dd> 255 </dd>
275 </dl><a NAME="AdBlockSubscription.canBeRemoved" ID="AdBlockSubscription.canBeRemoved"></a> 256 </dl><a NAME="AdBlockSubscription.canBeRemoved" ID="AdBlockSubscription.canBeRemoved"></a>
276 <h4>AdBlockSubscription.canBeRemoved</h4> 257 <h4>AdBlockSubscription.canBeRemoved</h4>
277 <b>canBeRemoved</b>(<i></i>) 258 <b>canBeRemoved</b>(<i></i>)
278 <p> 259 <p>
279 Public method to check, if the subscription can be removed. 260 Public method to check, if the subscription can be removed.
280 </p><dl> 261 </p><dl>
281 <dt>Returns:</dt> 262 <dt>Returns:</dt>
282 <dd> 263 <dd>
283 flag indicating removal is allowed (boolean) 264 flag indicating removal is allowed
265 </dd>
266 </dl><dl>
267 <dt>Return Type:</dt>
268 <dd>
269 bool
284 </dd> 270 </dd>
285 </dl><a NAME="AdBlockSubscription.canEditRules" ID="AdBlockSubscription.canEditRules"></a> 271 </dl><a NAME="AdBlockSubscription.canEditRules" ID="AdBlockSubscription.canEditRules"></a>
286 <h4>AdBlockSubscription.canEditRules</h4> 272 <h4>AdBlockSubscription.canEditRules</h4>
287 <b>canEditRules</b>(<i></i>) 273 <b>canEditRules</b>(<i></i>)
288 <p> 274 <p>
289 Public method to check, if rules can be edited. 275 Public method to check, if rules can be edited.
290 </p><dl> 276 </p><dl>
291 <dt>Returns:</dt> 277 <dt>Returns:</dt>
292 <dd> 278 <dd>
293 flag indicating rules may be edited (boolean) 279 flag indicating rules may be edited
280 </dd>
281 </dl><dl>
282 <dt>Return Type:</dt>
283 <dd>
284 bool
294 </dd> 285 </dd>
295 </dl><a NAME="AdBlockSubscription.checkForUpdate" ID="AdBlockSubscription.checkForUpdate"></a> 286 </dl><a NAME="AdBlockSubscription.checkForUpdate" ID="AdBlockSubscription.checkForUpdate"></a>
296 <h4>AdBlockSubscription.checkForUpdate</h4> 287 <h4>AdBlockSubscription.checkForUpdate</h4>
297 <b>checkForUpdate</b>(<i></i>) 288 <b>checkForUpdate</b>(<i></i>)
298 <p> 289 <p>
299 Public method to check for an update. 290 Public method to check for an update.
300 </p><a NAME="AdBlockSubscription.elemHideDisabledForUrl" ID="AdBlockSubscription.elemHideDisabledForUrl"></a> 291 </p><a NAME="AdBlockSubscription.isEnabled" ID="AdBlockSubscription.isEnabled"></a>
301 <h4>AdBlockSubscription.elemHideDisabledForUrl</h4>
302 <b>elemHideDisabledForUrl</b>(<i>url</i>)
303 <p>
304 Public method to check, if element hiding is disabled for the given
305 URL.
306 </p><dl>
307 <dt><i>url</i></dt>
308 <dd>
309 URL to check (QUrl)
310 </dd>
311 </dl><dl>
312 <dt>Returns:</dt>
313 <dd>
314 flag indicating disabled state (boolean)
315 </dd>
316 </dl><a NAME="AdBlockSubscription.elementHidingRules" ID="AdBlockSubscription.elementHidingRules"></a>
317 <h4>AdBlockSubscription.elementHidingRules</h4>
318 <b>elementHidingRules</b>(<i></i>)
319 <p>
320 Public method to get the element hiding rules.
321 </p><dl>
322 <dt>Returns:</dt>
323 <dd>
324 element hiding rules (string)
325 </dd>
326 </dl><a NAME="AdBlockSubscription.elementHidingRulesForDomain" ID="AdBlockSubscription.elementHidingRulesForDomain"></a>
327 <h4>AdBlockSubscription.elementHidingRulesForDomain</h4>
328 <b>elementHidingRulesForDomain</b>(<i>domain</i>)
329 <p>
330 Public method to get the element hiding rules for the given domain.
331 </p><dl>
332 <dt><i>domain</i></dt>
333 <dd>
334 domain name (string)
335 </dd>
336 </dl><dl>
337 <dt>Returns:</dt>
338 <dd>
339 element hiding rules (string)
340 </dd>
341 </dl><a NAME="AdBlockSubscription.isEnabled" ID="AdBlockSubscription.isEnabled"></a>
342 <h4>AdBlockSubscription.isEnabled</h4> 292 <h4>AdBlockSubscription.isEnabled</h4>
343 <b>isEnabled</b>(<i></i>) 293 <b>isEnabled</b>(<i></i>)
344 <p> 294 <p>
345 Public method to check, if the subscription is enabled. 295 Public method to check, if the subscription is enabled.
346 </p><dl> 296 </p><dl>
347 <dt>Returns:</dt> 297 <dt>Returns:</dt>
348 <dd> 298 <dd>
349 flag indicating the enabled status (boolean) 299 flag indicating the enabled status
300 </dd>
301 </dl><dl>
302 <dt>Return Type:</dt>
303 <dd>
304 bool
350 </dd> 305 </dd>
351 </dl><a NAME="AdBlockSubscription.lastUpdate" ID="AdBlockSubscription.lastUpdate"></a> 306 </dl><a NAME="AdBlockSubscription.lastUpdate" ID="AdBlockSubscription.lastUpdate"></a>
352 <h4>AdBlockSubscription.lastUpdate</h4> 307 <h4>AdBlockSubscription.lastUpdate</h4>
353 <b>lastUpdate</b>(<i></i>) 308 <b>lastUpdate</b>(<i></i>)
354 <p> 309 <p>
355 Public method to get the date and time of the last update. 310 Public method to get the date and time of the last update.
356 </p><dl> 311 </p><dl>
357 <dt>Returns:</dt> 312 <dt>Returns:</dt>
358 <dd> 313 <dd>
359 date and time of the last update (QDateTime) 314 date and time of the last update
315 </dd>
316 </dl><dl>
317 <dt>Return Type:</dt>
318 <dd>
319 QDateTime
360 </dd> 320 </dd>
361 </dl><a NAME="AdBlockSubscription.location" ID="AdBlockSubscription.location"></a> 321 </dl><a NAME="AdBlockSubscription.location" ID="AdBlockSubscription.location"></a>
362 <h4>AdBlockSubscription.location</h4> 322 <h4>AdBlockSubscription.location</h4>
363 <b>location</b>(<i></i>) 323 <b>location</b>(<i></i>)
364 <p> 324 <p>
365 Public method to get the subscription location. 325 Public method to get the subscription location.
366 </p><dl> 326 </p><dl>
367 <dt>Returns:</dt> 327 <dt>Returns:</dt>
368 <dd> 328 <dd>
369 URL of the subscription location (QUrl) 329 URL of the subscription location
370 </dd> 330 </dd>
371 </dl><a NAME="AdBlockSubscription.match" ID="AdBlockSubscription.match"></a> 331 </dl><dl>
372 <h4>AdBlockSubscription.match</h4> 332 <dt>Return Type:</dt>
373 <b>match</b>(<i>req, urlDomain, urlString</i>) 333 <dd>
374 <p> 334 QUrl
375 Public method to check the subscription for a matching rule.
376 </p><dl>
377 <dt><i>req</i></dt>
378 <dd>
379 reference to the network request (QWebEngineUrlRequestInfo)
380 </dd><dt><i>urlDomain</i></dt>
381 <dd>
382 domain of the URL (string)
383 </dd><dt><i>urlString</i></dt>
384 <dd>
385 URL (string)
386 </dd>
387 </dl><dl>
388 <dt>Returns:</dt>
389 <dd>
390 reference to the rule object or None (AdBlockRule)
391 </dd> 335 </dd>
392 </dl><a NAME="AdBlockSubscription.removeRule" ID="AdBlockSubscription.removeRule"></a> 336 </dl><a NAME="AdBlockSubscription.removeRule" ID="AdBlockSubscription.removeRule"></a>
393 <h4>AdBlockSubscription.removeRule</h4> 337 <h4>AdBlockSubscription.removeRule</h4>
394 <b>removeRule</b>(<i>offset</i>) 338 <b>removeRule</b>(<i>offset</i>)
395 <p> 339 <p>
396 Public method to remove a rule given the offset. 340 Public method to remove a rule given the offset.
397 </p><dl> 341 </p><dl>
398 <dt><i>offset</i></dt> 342 <dt><i>offset</i> (int)</dt>
399 <dd> 343 <dd>
400 offset of the rule to remove (integer) 344 offset of the rule to remove
401 </dd> 345 </dd>
402 </dl><a NAME="AdBlockSubscription.replaceRule" ID="AdBlockSubscription.replaceRule"></a> 346 </dl><a NAME="AdBlockSubscription.replaceRule" ID="AdBlockSubscription.replaceRule"></a>
403 <h4>AdBlockSubscription.replaceRule</h4> 347 <h4>AdBlockSubscription.replaceRule</h4>
404 <b>replaceRule</b>(<i>rule, offset</i>) 348 <b>replaceRule</b>(<i>rule, offset</i>)
405 <p> 349 <p>
406 Public method to replace a rule given the offset. 350 Public method to replace a rule given the offset.
407 </p><dl> 351 </p><dl>
408 <dt><i>rule</i></dt> 352 <dt><i>rule</i> (AdBlockRule)</dt>
409 <dd> 353 <dd>
410 reference to the rule to set (AdBlockRule) 354 reference to the rule to set
411 </dd><dt><i>offset</i></dt> 355 </dd><dt><i>offset</i> (int)</dt>
412 <dd> 356 <dd>
413 offset of the rule to remove (integer) 357 offset of the rule to remove
414 </dd> 358 </dd>
415 </dl><dl> 359 </dl><dl>
416 <dt>Returns:</dt> 360 <dt>Returns:</dt>
417 <dd> 361 <dd>
418 requested rule (AdBlockRule) 362 requested rule
363 </dd>
364 </dl><dl>
365 <dt>Return Type:</dt>
366 <dd>
367 AdBlockRule
419 </dd> 368 </dd>
420 </dl><a NAME="AdBlockSubscription.requiresLocation" ID="AdBlockSubscription.requiresLocation"></a> 369 </dl><a NAME="AdBlockSubscription.requiresLocation" ID="AdBlockSubscription.requiresLocation"></a>
421 <h4>AdBlockSubscription.requiresLocation</h4> 370 <h4>AdBlockSubscription.requiresLocation</h4>
422 <b>requiresLocation</b>(<i></i>) 371 <b>requiresLocation</b>(<i></i>)
423 <p> 372 <p>
424 Public method to get the location of a required subscription. 373 Public method to get the location of a required subscription.
425 </p><dl> 374 </p><dl>
426 <dt>Returns:</dt> 375 <dt>Returns:</dt>
427 <dd> 376 <dd>
428 location of a required subscription (string) 377 location of a required subscription
378 </dd>
379 </dl><dl>
380 <dt>Return Type:</dt>
381 <dd>
382 str
429 </dd> 383 </dd>
430 </dl><a NAME="AdBlockSubscription.rule" ID="AdBlockSubscription.rule"></a> 384 </dl><a NAME="AdBlockSubscription.rule" ID="AdBlockSubscription.rule"></a>
431 <h4>AdBlockSubscription.rule</h4> 385 <h4>AdBlockSubscription.rule</h4>
432 <b>rule</b>(<i>offset</i>) 386 <b>rule</b>(<i>offset</i>)
433 <p> 387 <p>
434 Public method to get a specific rule. 388 Public method to get a specific rule.
435 </p><dl> 389 </p><dl>
436 <dt><i>offset</i></dt> 390 <dt><i>offset</i> (int)</dt>
437 <dd> 391 <dd>
438 offset of the rule (integer) 392 offset of the rule
439 </dd> 393 </dd>
440 </dl><dl> 394 </dl><dl>
441 <dt>Returns:</dt> 395 <dt>Returns:</dt>
442 <dd> 396 <dd>
443 requested rule (AdBlockRule) 397 requested rule
398 </dd>
399 </dl><dl>
400 <dt>Return Type:</dt>
401 <dd>
402 AdBlockRule
444 </dd> 403 </dd>
445 </dl><a NAME="AdBlockSubscription.rulesFileName" ID="AdBlockSubscription.rulesFileName"></a> 404 </dl><a NAME="AdBlockSubscription.rulesFileName" ID="AdBlockSubscription.rulesFileName"></a>
446 <h4>AdBlockSubscription.rulesFileName</h4> 405 <h4>AdBlockSubscription.rulesFileName</h4>
447 <b>rulesFileName</b>(<i></i>) 406 <b>rulesFileName</b>(<i></i>)
448 <p> 407 <p>
449 Public method to get the name of the rules file. 408 Public method to get the name of the rules file.
450 </p><dl> 409 </p><dl>
451 <dt>Returns:</dt> 410 <dt>Returns:</dt>
452 <dd> 411 <dd>
453 name of the rules file (string) 412 name of the rules file
413 </dd>
414 </dl><dl>
415 <dt>Return Type:</dt>
416 <dd>
417 str
454 </dd> 418 </dd>
455 </dl><a NAME="AdBlockSubscription.saveRules" ID="AdBlockSubscription.saveRules"></a> 419 </dl><a NAME="AdBlockSubscription.saveRules" ID="AdBlockSubscription.saveRules"></a>
456 <h4>AdBlockSubscription.saveRules</h4> 420 <h4>AdBlockSubscription.saveRules</h4>
457 <b>saveRules</b>(<i></i>) 421 <b>saveRules</b>(<i></i>)
458 <p> 422 <p>
461 <h4>AdBlockSubscription.setEnabled</h4> 425 <h4>AdBlockSubscription.setEnabled</h4>
462 <b>setEnabled</b>(<i>enabled</i>) 426 <b>setEnabled</b>(<i>enabled</i>)
463 <p> 427 <p>
464 Public method to set the enabled status. 428 Public method to set the enabled status.
465 </p><dl> 429 </p><dl>
466 <dt><i>enabled</i></dt> 430 <dt><i>enabled</i> (bool)</dt>
467 <dd> 431 <dd>
468 flag indicating the enabled status (boolean) 432 flag indicating the enabled status
469 </dd> 433 </dd>
470 </dl><a NAME="AdBlockSubscription.setLocation" ID="AdBlockSubscription.setLocation"></a> 434 </dl><a NAME="AdBlockSubscription.setLocation" ID="AdBlockSubscription.setLocation"></a>
471 <h4>AdBlockSubscription.setLocation</h4> 435 <h4>AdBlockSubscription.setLocation</h4>
472 <b>setLocation</b>(<i>url</i>) 436 <b>setLocation</b>(<i>url</i>)
473 <p> 437 <p>
474 Public method to set the subscription location. 438 Public method to set the subscription location.
475 </p><dl> 439 </p><dl>
476 <dt><i>url</i></dt> 440 <dt><i>url</i> (QUrl)</dt>
477 <dd> 441 <dd>
478 URL of the subscription location (QUrl) 442 URL of the subscription location
479 </dd> 443 </dd>
480 </dl><a NAME="AdBlockSubscription.setRuleEnabled" ID="AdBlockSubscription.setRuleEnabled"></a> 444 </dl><a NAME="AdBlockSubscription.setRuleEnabled" ID="AdBlockSubscription.setRuleEnabled"></a>
481 <h4>AdBlockSubscription.setRuleEnabled</h4> 445 <h4>AdBlockSubscription.setRuleEnabled</h4>
482 <b>setRuleEnabled</b>(<i>offset, enabled</i>) 446 <b>setRuleEnabled</b>(<i>offset, enabled</i>)
483 <p> 447 <p>
484 Public method to enable a specific rule. 448 Public method to enable a specific rule.
485 </p><dl> 449 </p><dl>
486 <dt><i>offset</i></dt> 450 <dt><i>offset</i> (int)</dt>
487 <dd> 451 <dd>
488 offset of the rule (integer) 452 offset of the rule
489 </dd><dt><i>enabled</i></dt> 453 </dd><dt><i>enabled</i> (bool)</dt>
490 <dd> 454 <dd>
491 new enabled state (boolean) 455 new enabled state
492 </dd> 456 </dd>
493 </dl><dl> 457 </dl><dl>
494 <dt>Returns:</dt> 458 <dt>Returns:</dt>
495 <dd> 459 <dd>
496 reference to the changed rule (AdBlockRule) 460 reference to the changed rule
461 </dd>
462 </dl><dl>
463 <dt>Return Type:</dt>
464 <dd>
465 AdBlockRule
497 </dd> 466 </dd>
498 </dl><a NAME="AdBlockSubscription.setTitle" ID="AdBlockSubscription.setTitle"></a> 467 </dl><a NAME="AdBlockSubscription.setTitle" ID="AdBlockSubscription.setTitle"></a>
499 <h4>AdBlockSubscription.setTitle</h4> 468 <h4>AdBlockSubscription.setTitle</h4>
500 <b>setTitle</b>(<i>title</i>) 469 <b>setTitle</b>(<i>title</i>)
501 <p> 470 <p>
502 Public method to set the subscription title. 471 Public method to set the subscription title.
503 </p><dl> 472 </p><dl>
504 <dt><i>title</i></dt> 473 <dt><i>title</i> (str)</dt>
505 <dd> 474 <dd>
506 subscription title (string) 475 subscription title
507 </dd> 476 </dd>
508 </dl><a NAME="AdBlockSubscription.title" ID="AdBlockSubscription.title"></a> 477 </dl><a NAME="AdBlockSubscription.title" ID="AdBlockSubscription.title"></a>
509 <h4>AdBlockSubscription.title</h4> 478 <h4>AdBlockSubscription.title</h4>
510 <b>title</b>(<i></i>) 479 <b>title</b>(<i></i>)
511 <p> 480 <p>
512 Public method to get the subscription title. 481 Public method to get the subscription title.
513 </p><dl> 482 </p><dl>
514 <dt>Returns:</dt> 483 <dt>Returns:</dt>
515 <dd> 484 <dd>
516 subscription title (string) 485 subscription title
486 </dd>
487 </dl><dl>
488 <dt>Return Type:</dt>
489 <dd>
490 string
517 </dd> 491 </dd>
518 </dl><a NAME="AdBlockSubscription.updateNow" ID="AdBlockSubscription.updateNow"></a> 492 </dl><a NAME="AdBlockSubscription.updateNow" ID="AdBlockSubscription.updateNow"></a>
519 <h4>AdBlockSubscription.updateNow</h4> 493 <h4>AdBlockSubscription.updateNow</h4>
520 <b>updateNow</b>(<i></i>) 494 <b>updateNow</b>(<i></i>)
521 <p> 495 <p>
526 <p> 500 <p>
527 Public method to generate the URL for this subscription. 501 Public method to generate the URL for this subscription.
528 </p><dl> 502 </p><dl>
529 <dt>Returns:</dt> 503 <dt>Returns:</dt>
530 <dd> 504 <dd>
531 AdBlock URL for the subscription (QUrl) 505 AdBlock URL for the subscription
506 </dd>
507 </dl><dl>
508 <dt>Return Type:</dt>
509 <dd>
510 QUrl
532 </dd> 511 </dd>
533 </dl> 512 </dl>
534 <div align="right"><a href="#top">Up</a></div> 513 <div align="right"><a href="#top">Up</a></div>
535 <hr /> 514 <hr />
536 </body></html> 515 </body></html>

eric ide

mercurial