10478:de9106c55c3d | 10479:856476537696 |
---|---|
5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
6 </head> | 6 </head> |
7 <body> | 7 <body> |
8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.WebBrowser.AdBlock.AdBlockRule</h1> | 9 <h1>eric7.WebBrowser.AdBlock.AdBlockRule</h1> |
10 | |
11 <p> | 10 <p> |
12 Module implementing the AdBlock rule class. | 11 Module implementing the AdBlock rule class. |
13 </p> | 12 </p> |
13 | |
14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
15 | |
16 <table> | 15 <table> |
17 <tr><td>None</td></tr> | 16 <tr><td>None</td></tr> |
18 </table> | 17 </table> |
18 | |
19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
20 | |
21 <table> | 20 <table> |
22 | |
23 <tr> | 21 <tr> |
24 <td><a href="#AdBlockRule">AdBlockRule</a></td> | 22 <td><a href="#AdBlockRule">AdBlockRule</a></td> |
25 <td>Class implementing the AdBlock rule.</td> | 23 <td>Class implementing the AdBlock rule.</td> |
26 </tr> | 24 </tr> |
27 <tr> | 25 <tr> |
31 <tr> | 29 <tr> |
32 <td><a href="#AdBlockRuleType">AdBlockRuleType</a></td> | 30 <td><a href="#AdBlockRuleType">AdBlockRuleType</a></td> |
33 <td>Class implementing the rule type enum.</td> | 31 <td>Class implementing the rule type enum.</td> |
34 </tr> | 32 </tr> |
35 </table> | 33 </table> |
34 | |
36 <h3>Functions</h3> | 35 <h3>Functions</h3> |
37 | |
38 <table> | 36 <table> |
39 | |
40 <tr> | 37 <tr> |
41 <td><a href="#toSecondLevelDomain">toSecondLevelDomain</a></td> | 38 <td><a href="#toSecondLevelDomain">toSecondLevelDomain</a></td> |
42 <td>Module function to get a second level domain from the given URL.</td> | 39 <td>Module function to get a second level domain from the given URL.</td> |
43 </tr> | 40 </tr> |
44 </table> | 41 </table> |
42 | |
45 <hr /> | 43 <hr /> |
46 <hr /> | 44 <hr /> |
47 <a NAME="AdBlockRule" ID="AdBlockRule"></a> | 45 <a NAME="AdBlockRule" ID="AdBlockRule"></a> |
48 <h2>AdBlockRule</h2> | 46 <h2>AdBlockRule</h2> |
49 | |
50 <p> | 47 <p> |
51 Class implementing the AdBlock rule. | 48 Class implementing the AdBlock rule. |
52 </p> | 49 </p> |
50 | |
53 <h3>Derived from</h3> | 51 <h3>Derived from</h3> |
54 None | 52 None |
55 <h3>Class Attributes</h3> | 53 <h3>Class Attributes</h3> |
56 | |
57 <table> | 54 <table> |
58 <tr><td>None</td></tr> | 55 <tr><td>None</td></tr> |
59 </table> | 56 </table> |
57 | |
60 <h3>Class Methods</h3> | 58 <h3>Class Methods</h3> |
61 | |
62 <table> | 59 <table> |
63 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
64 </table> | 61 </table> |
62 | |
65 <h3>Methods</h3> | 63 <h3>Methods</h3> |
66 | |
67 <table> | 64 <table> |
68 | |
69 <tr> | 65 <tr> |
70 <td><a href="#AdBlockRule.__init__">AdBlockRule</a></td> | 66 <td><a href="#AdBlockRule.__init__">AdBlockRule</a></td> |
71 <td>Constructor</td> | 67 <td>Constructor</td> |
72 </tr> | 68 </tr> |
73 <tr> | 69 <tr> |
289 <tr> | 285 <tr> |
290 <td><a href="#AdBlockRule.urlMatch">urlMatch</a></td> | 286 <td><a href="#AdBlockRule.urlMatch">urlMatch</a></td> |
291 <td>Public method to check an URL against the rule.</td> | 287 <td>Public method to check an URL against the rule.</td> |
292 </tr> | 288 </tr> |
293 </table> | 289 </table> |
290 | |
294 <h3>Static Methods</h3> | 291 <h3>Static Methods</h3> |
295 | |
296 <table> | 292 <table> |
297 <tr><td>None</td></tr> | 293 <tr><td>None</td></tr> |
298 </table> | 294 </table> |
299 | 295 |
296 | |
300 <a NAME="AdBlockRule.__init__" ID="AdBlockRule.__init__"></a> | 297 <a NAME="AdBlockRule.__init__" ID="AdBlockRule.__init__"></a> |
301 <h4>AdBlockRule (Constructor)</h4> | 298 <h4>AdBlockRule (Constructor)</h4> |
302 <b>AdBlockRule</b>(<i>filterRule="", subscription=None</i>) | 299 <b>AdBlockRule</b>(<i>filterRule="", subscription=None</i>) |
303 | |
304 <p> | 300 <p> |
305 Constructor | 301 Constructor |
306 </p> | 302 </p> |
303 | |
307 <dl> | 304 <dl> |
308 | 305 |
309 <dt><i>filterRule</i> (str)</dt> | 306 <dt><i>filterRule</i> (str)</dt> |
310 <dd> | 307 <dd> |
311 filter string of the rule | 308 filter string of the rule |
316 </dd> | 313 </dd> |
317 </dl> | 314 </dl> |
318 <a NAME="AdBlockRule.__convertPatternToRegExp" ID="AdBlockRule.__convertPatternToRegExp"></a> | 315 <a NAME="AdBlockRule.__convertPatternToRegExp" ID="AdBlockRule.__convertPatternToRegExp"></a> |
319 <h4>AdBlockRule.__convertPatternToRegExp</h4> | 316 <h4>AdBlockRule.__convertPatternToRegExp</h4> |
320 <b>__convertPatternToRegExp</b>(<i>wildcardPattern</i>) | 317 <b>__convertPatternToRegExp</b>(<i>wildcardPattern</i>) |
321 | |
322 <p> | 318 <p> |
323 Private method to convert a wildcard pattern to a regular expression. | 319 Private method to convert a wildcard pattern to a regular expression. |
324 </p> | 320 </p> |
321 | |
325 <dl> | 322 <dl> |
326 | 323 |
327 <dt><i>wildcardPattern</i> (str)</dt> | 324 <dt><i>wildcardPattern</i> (str)</dt> |
328 <dd> | 325 <dd> |
329 string containing the wildcard pattern | 326 string containing the wildcard pattern |
342 </dd> | 339 </dd> |
343 </dl> | 340 </dl> |
344 <a NAME="AdBlockRule.__filterIsOnlyDomain" ID="AdBlockRule.__filterIsOnlyDomain"></a> | 341 <a NAME="AdBlockRule.__filterIsOnlyDomain" ID="AdBlockRule.__filterIsOnlyDomain"></a> |
345 <h4>AdBlockRule.__filterIsOnlyDomain</h4> | 342 <h4>AdBlockRule.__filterIsOnlyDomain</h4> |
346 <b>__filterIsOnlyDomain</b>(<i>filterString</i>) | 343 <b>__filterIsOnlyDomain</b>(<i>filterString</i>) |
347 | |
348 <p> | 344 <p> |
349 Private method to check, if the given filter is a domain only filter. | 345 Private method to check, if the given filter is a domain only filter. |
350 </p> | 346 </p> |
347 | |
351 <dl> | 348 <dl> |
352 | 349 |
353 <dt><i>filterString</i> (str)</dt> | 350 <dt><i>filterString</i> (str)</dt> |
354 <dd> | 351 <dd> |
355 filter string to be checked | 352 filter string to be checked |
368 </dd> | 365 </dd> |
369 </dl> | 366 </dl> |
370 <a NAME="AdBlockRule.__filterIsOnlyEndsMatch" ID="AdBlockRule.__filterIsOnlyEndsMatch"></a> | 367 <a NAME="AdBlockRule.__filterIsOnlyEndsMatch" ID="AdBlockRule.__filterIsOnlyEndsMatch"></a> |
371 <h4>AdBlockRule.__filterIsOnlyEndsMatch</h4> | 368 <h4>AdBlockRule.__filterIsOnlyEndsMatch</h4> |
372 <b>__filterIsOnlyEndsMatch</b>(<i>filterString</i>) | 369 <b>__filterIsOnlyEndsMatch</b>(<i>filterString</i>) |
373 | |
374 <p> | 370 <p> |
375 Private method to check, if the given filter is to match against the | 371 Private method to check, if the given filter is to match against the |
376 end of a string. | 372 end of a string. |
377 </p> | 373 </p> |
374 | |
378 <dl> | 375 <dl> |
379 | 376 |
380 <dt><i>filterString</i> (str)</dt> | 377 <dt><i>filterString</i> (str)</dt> |
381 <dd> | 378 <dd> |
382 filter string to be checked | 379 filter string to be checked |
395 </dd> | 392 </dd> |
396 </dl> | 393 </dl> |
397 <a NAME="AdBlockRule.__hasException" ID="AdBlockRule.__hasException"></a> | 394 <a NAME="AdBlockRule.__hasException" ID="AdBlockRule.__hasException"></a> |
398 <h4>AdBlockRule.__hasException</h4> | 395 <h4>AdBlockRule.__hasException</h4> |
399 <b>__hasException</b>(<i>opt</i>) | 396 <b>__hasException</b>(<i>opt</i>) |
400 | |
401 <p> | 397 <p> |
402 Private method to check, if the given option has been set as an | 398 Private method to check, if the given option has been set as an |
403 exception. | 399 exception. |
404 </p> | 400 </p> |
401 | |
405 <dl> | 402 <dl> |
406 | 403 |
407 <dt><i>opt</i> (AdBlockRuleOption)</dt> | 404 <dt><i>opt</i> (AdBlockRuleOption)</dt> |
408 <dd> | 405 <dd> |
409 option to check for | 406 option to check for |
422 </dd> | 419 </dd> |
423 </dl> | 420 </dl> |
424 <a NAME="AdBlockRule.__hasOption" ID="AdBlockRule.__hasOption"></a> | 421 <a NAME="AdBlockRule.__hasOption" ID="AdBlockRule.__hasOption"></a> |
425 <h4>AdBlockRule.__hasOption</h4> | 422 <h4>AdBlockRule.__hasOption</h4> |
426 <b>__hasOption</b>(<i>opt</i>) | 423 <b>__hasOption</b>(<i>opt</i>) |
427 | |
428 <p> | 424 <p> |
429 Private method to check, if the given option has been set. | 425 Private method to check, if the given option has been set. |
430 </p> | 426 </p> |
427 | |
431 <dl> | 428 <dl> |
432 | 429 |
433 <dt><i>opt</i> (AdBlockRuleOption)</dt> | 430 <dt><i>opt</i> (AdBlockRuleOption)</dt> |
434 <dd> | 431 <dd> |
435 option to check for | 432 option to check for |
448 </dd> | 445 </dd> |
449 </dl> | 446 </dl> |
450 <a NAME="AdBlockRule.__isMatchingDomain" ID="AdBlockRule.__isMatchingDomain"></a> | 447 <a NAME="AdBlockRule.__isMatchingDomain" ID="AdBlockRule.__isMatchingDomain"></a> |
451 <h4>AdBlockRule.__isMatchingDomain</h4> | 448 <h4>AdBlockRule.__isMatchingDomain</h4> |
452 <b>__isMatchingDomain</b>(<i>domain, filterString</i>) | 449 <b>__isMatchingDomain</b>(<i>domain, filterString</i>) |
453 | |
454 <p> | 450 <p> |
455 Private method to check, if a given domain matches the given filter | 451 Private method to check, if a given domain matches the given filter |
456 string. | 452 string. |
457 </p> | 453 </p> |
454 | |
458 <dl> | 455 <dl> |
459 | 456 |
460 <dt><i>domain</i> (str)</dt> | 457 <dt><i>domain</i> (str)</dt> |
461 <dd> | 458 <dd> |
462 domain to be checked | 459 domain to be checked |
479 </dd> | 476 </dd> |
480 </dl> | 477 </dl> |
481 <a NAME="AdBlockRule.__isMatchingRegExpStrings" ID="AdBlockRule.__isMatchingRegExpStrings"></a> | 478 <a NAME="AdBlockRule.__isMatchingRegExpStrings" ID="AdBlockRule.__isMatchingRegExpStrings"></a> |
482 <h4>AdBlockRule.__isMatchingRegExpStrings</h4> | 479 <h4>AdBlockRule.__isMatchingRegExpStrings</h4> |
483 <b>__isMatchingRegExpStrings</b>(<i>url</i>) | 480 <b>__isMatchingRegExpStrings</b>(<i>url</i>) |
484 | |
485 <p> | 481 <p> |
486 Private method to check the given URL against the fixed parts of | 482 Private method to check the given URL against the fixed parts of |
487 the regexp. | 483 the regexp. |
488 </p> | 484 </p> |
485 | |
489 <dl> | 486 <dl> |
490 | 487 |
491 <dt><i>url</i> (str)</dt> | 488 <dt><i>url</i> (str)</dt> |
492 <dd> | 489 <dd> |
493 URL to be checked | 490 URL to be checked |
506 </dd> | 503 </dd> |
507 </dl> | 504 </dl> |
508 <a NAME="AdBlockRule.__parseDomains" ID="AdBlockRule.__parseDomains"></a> | 505 <a NAME="AdBlockRule.__parseDomains" ID="AdBlockRule.__parseDomains"></a> |
509 <h4>AdBlockRule.__parseDomains</h4> | 506 <h4>AdBlockRule.__parseDomains</h4> |
510 <b>__parseDomains</b>(<i>domains, separator</i>) | 507 <b>__parseDomains</b>(<i>domains, separator</i>) |
511 | |
512 <p> | 508 <p> |
513 Private method to parse a string with a domain list. | 509 Private method to parse a string with a domain list. |
514 </p> | 510 </p> |
511 | |
515 <dl> | 512 <dl> |
516 | 513 |
517 <dt><i>domains</i> (str)</dt> | 514 <dt><i>domains</i> (str)</dt> |
518 <dd> | 515 <dd> |
519 list of domains | 516 list of domains |
524 </dd> | 521 </dd> |
525 </dl> | 522 </dl> |
526 <a NAME="AdBlockRule.__parseFilter" ID="AdBlockRule.__parseFilter"></a> | 523 <a NAME="AdBlockRule.__parseFilter" ID="AdBlockRule.__parseFilter"></a> |
527 <h4>AdBlockRule.__parseFilter</h4> | 524 <h4>AdBlockRule.__parseFilter</h4> |
528 <b>__parseFilter</b>(<i></i>) | 525 <b>__parseFilter</b>(<i></i>) |
529 | |
530 <p> | 526 <p> |
531 Private method to parse the filter pattern. | 527 Private method to parse the filter pattern. |
532 </p> | 528 </p> |
529 | |
533 <a NAME="AdBlockRule.__parseRegExpFilter" ID="AdBlockRule.__parseRegExpFilter"></a> | 530 <a NAME="AdBlockRule.__parseRegExpFilter" ID="AdBlockRule.__parseRegExpFilter"></a> |
534 <h4>AdBlockRule.__parseRegExpFilter</h4> | 531 <h4>AdBlockRule.__parseRegExpFilter</h4> |
535 <b>__parseRegExpFilter</b>(<i>filterString</i>) | 532 <b>__parseRegExpFilter</b>(<i>filterString</i>) |
536 | |
537 <p> | 533 <p> |
538 Private method to split the given regular expression into strings that | 534 Private method to split the given regular expression into strings that |
539 can be used with 'in'. | 535 can be used with 'in'. |
540 </p> | 536 </p> |
537 | |
541 <dl> | 538 <dl> |
542 | 539 |
543 <dt><i>filterString</i> (str)</dt> | 540 <dt><i>filterString</i> (str)</dt> |
544 <dd> | 541 <dd> |
545 regexp filter string to be parsed | 542 regexp filter string to be parsed |
558 </dd> | 555 </dd> |
559 </dl> | 556 </dl> |
560 <a NAME="AdBlockRule.__setException" ID="AdBlockRule.__setException"></a> | 557 <a NAME="AdBlockRule.__setException" ID="AdBlockRule.__setException"></a> |
561 <h4>AdBlockRule.__setException</h4> | 558 <h4>AdBlockRule.__setException</h4> |
562 <b>__setException</b>(<i>opt, on</i>) | 559 <b>__setException</b>(<i>opt, on</i>) |
563 | |
564 <p> | 560 <p> |
565 Private method to set the given option as an exception. | 561 Private method to set the given option as an exception. |
566 </p> | 562 </p> |
563 | |
567 <dl> | 564 <dl> |
568 | 565 |
569 <dt><i>opt</i> (AdBlockRuleOption)</dt> | 566 <dt><i>opt</i> (AdBlockRuleOption)</dt> |
570 <dd> | 567 <dd> |
571 option to be set | 568 option to be set |
576 </dd> | 573 </dd> |
577 </dl> | 574 </dl> |
578 <a NAME="AdBlockRule.__stringMatch" ID="AdBlockRule.__stringMatch"></a> | 575 <a NAME="AdBlockRule.__stringMatch" ID="AdBlockRule.__stringMatch"></a> |
579 <h4>AdBlockRule.__stringMatch</h4> | 576 <h4>AdBlockRule.__stringMatch</h4> |
580 <b>__stringMatch</b>(<i>domain, encodedUrl</i>) | 577 <b>__stringMatch</b>(<i>domain, encodedUrl</i>) |
581 | |
582 <p> | 578 <p> |
583 Private method to match a domain string. | 579 Private method to match a domain string. |
584 </p> | 580 </p> |
581 | |
585 <dl> | 582 <dl> |
586 | 583 |
587 <dt><i>domain</i> (str)</dt> | 584 <dt><i>domain</i> (str)</dt> |
588 <dd> | 585 <dd> |
589 domain to match | 586 domain to match |
606 </dd> | 603 </dd> |
607 </dl> | 604 </dl> |
608 <a NAME="AdBlockRule.addBlockedDomains" ID="AdBlockRule.addBlockedDomains"></a> | 605 <a NAME="AdBlockRule.addBlockedDomains" ID="AdBlockRule.addBlockedDomains"></a> |
609 <h4>AdBlockRule.addBlockedDomains</h4> | 606 <h4>AdBlockRule.addBlockedDomains</h4> |
610 <b>addBlockedDomains</b>(<i>domains</i>) | 607 <b>addBlockedDomains</b>(<i>domains</i>) |
611 | |
612 <p> | 608 <p> |
613 Public method to add to the list of blocked domains. | 609 Public method to add to the list of blocked domains. |
614 </p> | 610 </p> |
611 | |
615 <dl> | 612 <dl> |
616 | 613 |
617 <dt><i>domains</i> (str or list of str)</dt> | 614 <dt><i>domains</i> (str or list of str)</dt> |
618 <dd> | 615 <dd> |
619 list of domains to be added | 616 list of domains to be added |
620 </dd> | 617 </dd> |
621 </dl> | 618 </dl> |
622 <a NAME="AdBlockRule.allowedDomains" ID="AdBlockRule.allowedDomains"></a> | 619 <a NAME="AdBlockRule.allowedDomains" ID="AdBlockRule.allowedDomains"></a> |
623 <h4>AdBlockRule.allowedDomains</h4> | 620 <h4>AdBlockRule.allowedDomains</h4> |
624 <b>allowedDomains</b>(<i></i>) | 621 <b>allowedDomains</b>(<i></i>) |
625 | |
626 <p> | 622 <p> |
627 Public method to get a copy of the list of allowed domains. | 623 Public method to get a copy of the list of allowed domains. |
628 </p> | 624 </p> |
625 | |
629 <dl> | 626 <dl> |
630 <dt>Return:</dt> | 627 <dt>Return:</dt> |
631 <dd> | 628 <dd> |
632 list of allowed domains | 629 list of allowed domains |
633 </dd> | 630 </dd> |
639 </dd> | 636 </dd> |
640 </dl> | 637 </dl> |
641 <a NAME="AdBlockRule.blockedDomains" ID="AdBlockRule.blockedDomains"></a> | 638 <a NAME="AdBlockRule.blockedDomains" ID="AdBlockRule.blockedDomains"></a> |
642 <h4>AdBlockRule.blockedDomains</h4> | 639 <h4>AdBlockRule.blockedDomains</h4> |
643 <b>blockedDomains</b>(<i></i>) | 640 <b>blockedDomains</b>(<i></i>) |
644 | |
645 <p> | 641 <p> |
646 Public method to get a copy of the list of blocked domains. | 642 Public method to get a copy of the list of blocked domains. |
647 </p> | 643 </p> |
644 | |
648 <dl> | 645 <dl> |
649 <dt>Return:</dt> | 646 <dt>Return:</dt> |
650 <dd> | 647 <dd> |
651 list of blocked domains | 648 list of blocked domains |
652 </dd> | 649 </dd> |
658 </dd> | 655 </dd> |
659 </dl> | 656 </dl> |
660 <a NAME="AdBlockRule.caseSensitivity" ID="AdBlockRule.caseSensitivity"></a> | 657 <a NAME="AdBlockRule.caseSensitivity" ID="AdBlockRule.caseSensitivity"></a> |
661 <h4>AdBlockRule.caseSensitivity</h4> | 658 <h4>AdBlockRule.caseSensitivity</h4> |
662 <b>caseSensitivity</b>(<i></i>) | 659 <b>caseSensitivity</b>(<i></i>) |
663 | |
664 <p> | 660 <p> |
665 Public method to get the case sensitivity. | 661 Public method to get the case sensitivity. |
666 </p> | 662 </p> |
663 | |
667 <dl> | 664 <dl> |
668 <dt>Return:</dt> | 665 <dt>Return:</dt> |
669 <dd> | 666 <dd> |
670 case sensitivity | 667 case sensitivity |
671 </dd> | 668 </dd> |
677 </dd> | 674 </dd> |
678 </dl> | 675 </dl> |
679 <a NAME="AdBlockRule.copyFrom" ID="AdBlockRule.copyFrom"></a> | 676 <a NAME="AdBlockRule.copyFrom" ID="AdBlockRule.copyFrom"></a> |
680 <h4>AdBlockRule.copyFrom</h4> | 677 <h4>AdBlockRule.copyFrom</h4> |
681 <b>copyFrom</b>(<i>other</i>) | 678 <b>copyFrom</b>(<i>other</i>) |
682 | |
683 <p> | 679 <p> |
684 Public method to copy another AdBlock rule. | 680 Public method to copy another AdBlock rule. |
685 </p> | 681 </p> |
682 | |
686 <dl> | 683 <dl> |
687 | 684 |
688 <dt><i>other</i> (AdBlockRule)</dt> | 685 <dt><i>other</i> (AdBlockRule)</dt> |
689 <dd> | 686 <dd> |
690 reference to the AdBlock rule to copy from | 687 reference to the AdBlock rule to copy from |
691 </dd> | 688 </dd> |
692 </dl> | 689 </dl> |
693 <a NAME="AdBlockRule.cssSelector" ID="AdBlockRule.cssSelector"></a> | 690 <a NAME="AdBlockRule.cssSelector" ID="AdBlockRule.cssSelector"></a> |
694 <h4>AdBlockRule.cssSelector</h4> | 691 <h4>AdBlockRule.cssSelector</h4> |
695 <b>cssSelector</b>(<i></i>) | 692 <b>cssSelector</b>(<i></i>) |
696 | |
697 <p> | 693 <p> |
698 Public method to get the CSS selector of the rule. | 694 Public method to get the CSS selector of the rule. |
699 </p> | 695 </p> |
696 | |
700 <dl> | 697 <dl> |
701 <dt>Return:</dt> | 698 <dt>Return:</dt> |
702 <dd> | 699 <dd> |
703 CSS selector | 700 CSS selector |
704 </dd> | 701 </dd> |
710 </dd> | 707 </dd> |
711 </dl> | 708 </dl> |
712 <a NAME="AdBlockRule.filter" ID="AdBlockRule.filter"></a> | 709 <a NAME="AdBlockRule.filter" ID="AdBlockRule.filter"></a> |
713 <h4>AdBlockRule.filter</h4> | 710 <h4>AdBlockRule.filter</h4> |
714 <b>filter</b>(<i></i>) | 711 <b>filter</b>(<i></i>) |
715 | |
716 <p> | 712 <p> |
717 Public method to get the rule filter string. | 713 Public method to get the rule filter string. |
718 </p> | 714 </p> |
715 | |
719 <dl> | 716 <dl> |
720 <dt>Return:</dt> | 717 <dt>Return:</dt> |
721 <dd> | 718 <dd> |
722 rule filter string | 719 rule filter string |
723 </dd> | 720 </dd> |
729 </dd> | 726 </dd> |
730 </dl> | 727 </dl> |
731 <a NAME="AdBlockRule.getRegExpAndMatchers" ID="AdBlockRule.getRegExpAndMatchers"></a> | 728 <a NAME="AdBlockRule.getRegExpAndMatchers" ID="AdBlockRule.getRegExpAndMatchers"></a> |
732 <h4>AdBlockRule.getRegExpAndMatchers</h4> | 729 <h4>AdBlockRule.getRegExpAndMatchers</h4> |
733 <b>getRegExpAndMatchers</b>(<i></i>) | 730 <b>getRegExpAndMatchers</b>(<i></i>) |
734 | |
735 <p> | 731 <p> |
736 Public method to get the regular expression and associated string | 732 Public method to get the regular expression and associated string |
737 matchers. | 733 matchers. |
738 </p> | 734 </p> |
735 | |
739 <dl> | 736 <dl> |
740 <dt>Return:</dt> | 737 <dt>Return:</dt> |
741 <dd> | 738 <dd> |
742 tuple containing the regular expression and the list of | 739 tuple containing the regular expression and the list of |
743 string matchers | 740 string matchers |
750 </dd> | 747 </dd> |
751 </dl> | 748 </dl> |
752 <a NAME="AdBlockRule.isCSSRule" ID="AdBlockRule.isCSSRule"></a> | 749 <a NAME="AdBlockRule.isCSSRule" ID="AdBlockRule.isCSSRule"></a> |
753 <h4>AdBlockRule.isCSSRule</h4> | 750 <h4>AdBlockRule.isCSSRule</h4> |
754 <b>isCSSRule</b>(<i></i>) | 751 <b>isCSSRule</b>(<i></i>) |
755 | |
756 <p> | 752 <p> |
757 Public method to check, if the rule is a CSS rule. | 753 Public method to check, if the rule is a CSS rule. |
758 </p> | 754 </p> |
755 | |
759 <dl> | 756 <dl> |
760 <dt>Return:</dt> | 757 <dt>Return:</dt> |
761 <dd> | 758 <dd> |
762 flag indicating a CSS rule | 759 flag indicating a CSS rule |
763 </dd> | 760 </dd> |
769 </dd> | 766 </dd> |
770 </dl> | 767 </dl> |
771 <a NAME="AdBlockRule.isComment" ID="AdBlockRule.isComment"></a> | 768 <a NAME="AdBlockRule.isComment" ID="AdBlockRule.isComment"></a> |
772 <h4>AdBlockRule.isComment</h4> | 769 <h4>AdBlockRule.isComment</h4> |
773 <b>isComment</b>(<i></i>) | 770 <b>isComment</b>(<i></i>) |
774 | |
775 <p> | 771 <p> |
776 Public method to check, if this is a comment. | 772 Public method to check, if this is a comment. |
777 </p> | 773 </p> |
774 | |
778 <dl> | 775 <dl> |
779 <dt>Return:</dt> | 776 <dt>Return:</dt> |
780 <dd> | 777 <dd> |
781 flag indicating a comment | 778 flag indicating a comment |
782 </dd> | 779 </dd> |
788 </dd> | 785 </dd> |
789 </dl> | 786 </dl> |
790 <a NAME="AdBlockRule.isDocument" ID="AdBlockRule.isDocument"></a> | 787 <a NAME="AdBlockRule.isDocument" ID="AdBlockRule.isDocument"></a> |
791 <h4>AdBlockRule.isDocument</h4> | 788 <h4>AdBlockRule.isDocument</h4> |
792 <b>isDocument</b>(<i></i>) | 789 <b>isDocument</b>(<i></i>) |
793 | |
794 <p> | 790 <p> |
795 Public method to check, if this is a document rule. | 791 Public method to check, if this is a document rule. |
796 </p> | 792 </p> |
793 | |
797 <dl> | 794 <dl> |
798 <dt>Return:</dt> | 795 <dt>Return:</dt> |
799 <dd> | 796 <dd> |
800 flag indicating a document rule | 797 flag indicating a document rule |
801 </dd> | 798 </dd> |
807 </dd> | 804 </dd> |
808 </dl> | 805 </dl> |
809 <a NAME="AdBlockRule.isDomainRestricted" ID="AdBlockRule.isDomainRestricted"></a> | 806 <a NAME="AdBlockRule.isDomainRestricted" ID="AdBlockRule.isDomainRestricted"></a> |
810 <h4>AdBlockRule.isDomainRestricted</h4> | 807 <h4>AdBlockRule.isDomainRestricted</h4> |
811 <b>isDomainRestricted</b>(<i></i>) | 808 <b>isDomainRestricted</b>(<i></i>) |
812 | |
813 <p> | 809 <p> |
814 Public method to check, if this rule is restricted by domain. | 810 Public method to check, if this rule is restricted by domain. |
815 </p> | 811 </p> |
812 | |
816 <dl> | 813 <dl> |
817 <dt>Return:</dt> | 814 <dt>Return:</dt> |
818 <dd> | 815 <dd> |
819 flag indicating a domain restriction | 816 flag indicating a domain restriction |
820 </dd> | 817 </dd> |
826 </dd> | 823 </dd> |
827 </dl> | 824 </dl> |
828 <a NAME="AdBlockRule.isElementHiding" ID="AdBlockRule.isElementHiding"></a> | 825 <a NAME="AdBlockRule.isElementHiding" ID="AdBlockRule.isElementHiding"></a> |
829 <h4>AdBlockRule.isElementHiding</h4> | 826 <h4>AdBlockRule.isElementHiding</h4> |
830 <b>isElementHiding</b>(<i></i>) | 827 <b>isElementHiding</b>(<i></i>) |
831 | |
832 <p> | 828 <p> |
833 Public method to check, if this is an element hiding rule. | 829 Public method to check, if this is an element hiding rule. |
834 </p> | 830 </p> |
831 | |
835 <dl> | 832 <dl> |
836 <dt>Return:</dt> | 833 <dt>Return:</dt> |
837 <dd> | 834 <dd> |
838 flag indicating an element hiding rule | 835 flag indicating an element hiding rule |
839 </dd> | 836 </dd> |
845 </dd> | 842 </dd> |
846 </dl> | 843 </dl> |
847 <a NAME="AdBlockRule.isEnabled" ID="AdBlockRule.isEnabled"></a> | 844 <a NAME="AdBlockRule.isEnabled" ID="AdBlockRule.isEnabled"></a> |
848 <h4>AdBlockRule.isEnabled</h4> | 845 <h4>AdBlockRule.isEnabled</h4> |
849 <b>isEnabled</b>(<i></i>) | 846 <b>isEnabled</b>(<i></i>) |
850 | |
851 <p> | 847 <p> |
852 Public method to check, if the rule is enabled. | 848 Public method to check, if the rule is enabled. |
853 </p> | 849 </p> |
850 | |
854 <dl> | 851 <dl> |
855 <dt>Return:</dt> | 852 <dt>Return:</dt> |
856 <dd> | 853 <dd> |
857 flag indicating enabled state | 854 flag indicating enabled state |
858 </dd> | 855 </dd> |
864 </dd> | 861 </dd> |
865 </dl> | 862 </dl> |
866 <a NAME="AdBlockRule.isException" ID="AdBlockRule.isException"></a> | 863 <a NAME="AdBlockRule.isException" ID="AdBlockRule.isException"></a> |
867 <h4>AdBlockRule.isException</h4> | 864 <h4>AdBlockRule.isException</h4> |
868 <b>isException</b>(<i></i>) | 865 <b>isException</b>(<i></i>) |
869 | |
870 <p> | 866 <p> |
871 Public method to check, if the rule defines an exception. | 867 Public method to check, if the rule defines an exception. |
872 </p> | 868 </p> |
869 | |
873 <dl> | 870 <dl> |
874 <dt>Return:</dt> | 871 <dt>Return:</dt> |
875 <dd> | 872 <dd> |
876 flag indicating an exception | 873 flag indicating an exception |
877 </dd> | 874 </dd> |
883 </dd> | 880 </dd> |
884 </dl> | 881 </dl> |
885 <a NAME="AdBlockRule.isHeader" ID="AdBlockRule.isHeader"></a> | 882 <a NAME="AdBlockRule.isHeader" ID="AdBlockRule.isHeader"></a> |
886 <h4>AdBlockRule.isHeader</h4> | 883 <h4>AdBlockRule.isHeader</h4> |
887 <b>isHeader</b>(<i></i>) | 884 <b>isHeader</b>(<i></i>) |
888 | |
889 <p> | 885 <p> |
890 Public method to check, if this is a header. | 886 Public method to check, if this is a header. |
891 </p> | 887 </p> |
888 | |
892 <dl> | 889 <dl> |
893 <dt>Return:</dt> | 890 <dt>Return:</dt> |
894 <dd> | 891 <dd> |
895 flag indicating a header | 892 flag indicating a header |
896 </dd> | 893 </dd> |
902 </dd> | 899 </dd> |
903 </dl> | 900 </dl> |
904 <a NAME="AdBlockRule.isInternalDisabled" ID="AdBlockRule.isInternalDisabled"></a> | 901 <a NAME="AdBlockRule.isInternalDisabled" ID="AdBlockRule.isInternalDisabled"></a> |
905 <h4>AdBlockRule.isInternalDisabled</h4> | 902 <h4>AdBlockRule.isInternalDisabled</h4> |
906 <b>isInternalDisabled</b>(<i></i>) | 903 <b>isInternalDisabled</b>(<i></i>) |
907 | |
908 <p> | 904 <p> |
909 Public method to check, if this rule was disabled internally. | 905 Public method to check, if this rule was disabled internally. |
910 </p> | 906 </p> |
907 | |
911 <dl> | 908 <dl> |
912 <dt>Return:</dt> | 909 <dt>Return:</dt> |
913 <dd> | 910 <dd> |
914 flag indicating an internally disabled rule | 911 flag indicating an internally disabled rule |
915 </dd> | 912 </dd> |
921 </dd> | 918 </dd> |
922 </dl> | 919 </dl> |
923 <a NAME="AdBlockRule.isSlow" ID="AdBlockRule.isSlow"></a> | 920 <a NAME="AdBlockRule.isSlow" ID="AdBlockRule.isSlow"></a> |
924 <h4>AdBlockRule.isSlow</h4> | 921 <h4>AdBlockRule.isSlow</h4> |
925 <b>isSlow</b>(<i></i>) | 922 <b>isSlow</b>(<i></i>) |
926 | |
927 <p> | 923 <p> |
928 Public method to check, if this is a slow rule. | 924 Public method to check, if this is a slow rule. |
929 </p> | 925 </p> |
926 | |
930 <dl> | 927 <dl> |
931 <dt>Return:</dt> | 928 <dt>Return:</dt> |
932 <dd> | 929 <dd> |
933 flag indicating a slow rule | 930 flag indicating a slow rule |
934 </dd> | 931 </dd> |
940 </dd> | 937 </dd> |
941 </dl> | 938 </dl> |
942 <a NAME="AdBlockRule.matchDomain" ID="AdBlockRule.matchDomain"></a> | 939 <a NAME="AdBlockRule.matchDomain" ID="AdBlockRule.matchDomain"></a> |
943 <h4>AdBlockRule.matchDomain</h4> | 940 <h4>AdBlockRule.matchDomain</h4> |
944 <b>matchDomain</b>(<i>domain</i>) | 941 <b>matchDomain</b>(<i>domain</i>) |
945 | |
946 <p> | 942 <p> |
947 Public method to match a domain. | 943 Public method to match a domain. |
948 </p> | 944 </p> |
945 | |
949 <dl> | 946 <dl> |
950 | 947 |
951 <dt><i>domain</i> (str)</dt> | 948 <dt><i>domain</i> (str)</dt> |
952 <dd> | 949 <dd> |
953 domain name to check | 950 domain name to check |
966 </dd> | 963 </dd> |
967 </dl> | 964 </dl> |
968 <a NAME="AdBlockRule.matchFont" ID="AdBlockRule.matchFont"></a> | 965 <a NAME="AdBlockRule.matchFont" ID="AdBlockRule.matchFont"></a> |
969 <h4>AdBlockRule.matchFont</h4> | 966 <h4>AdBlockRule.matchFont</h4> |
970 <b>matchFont</b>(<i>req</i>) | 967 <b>matchFont</b>(<i>req</i>) |
971 | |
972 <p> | 968 <p> |
973 Public method to match a Font rule. | 969 Public method to match a Font rule. |
974 </p> | 970 </p> |
971 | |
975 <dl> | 972 <dl> |
976 | 973 |
977 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 974 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
978 <dd> | 975 <dd> |
979 request object to check | 976 request object to check |
992 </dd> | 989 </dd> |
993 </dl> | 990 </dl> |
994 <a NAME="AdBlockRule.matchImage" ID="AdBlockRule.matchImage"></a> | 991 <a NAME="AdBlockRule.matchImage" ID="AdBlockRule.matchImage"></a> |
995 <h4>AdBlockRule.matchImage</h4> | 992 <h4>AdBlockRule.matchImage</h4> |
996 <b>matchImage</b>(<i>req</i>) | 993 <b>matchImage</b>(<i>req</i>) |
997 | |
998 <p> | 994 <p> |
999 Public method to match an Image rule. | 995 Public method to match an Image rule. |
1000 </p> | 996 </p> |
997 | |
1001 <dl> | 998 <dl> |
1002 | 999 |
1003 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1000 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1004 <dd> | 1001 <dd> |
1005 request object to check | 1002 request object to check |
1018 </dd> | 1015 </dd> |
1019 </dl> | 1016 </dl> |
1020 <a NAME="AdBlockRule.matchMedia" ID="AdBlockRule.matchMedia"></a> | 1017 <a NAME="AdBlockRule.matchMedia" ID="AdBlockRule.matchMedia"></a> |
1021 <h4>AdBlockRule.matchMedia</h4> | 1018 <h4>AdBlockRule.matchMedia</h4> |
1022 <b>matchMedia</b>(<i>req</i>) | 1019 <b>matchMedia</b>(<i>req</i>) |
1023 | |
1024 <p> | 1020 <p> |
1025 Public method to match a Media rule. | 1021 Public method to match a Media rule. |
1026 </p> | 1022 </p> |
1023 | |
1027 <dl> | 1024 <dl> |
1028 | 1025 |
1029 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1026 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1030 <dd> | 1027 <dd> |
1031 request object to check | 1028 request object to check |
1044 </dd> | 1041 </dd> |
1045 </dl> | 1042 </dl> |
1046 <a NAME="AdBlockRule.matchObject" ID="AdBlockRule.matchObject"></a> | 1043 <a NAME="AdBlockRule.matchObject" ID="AdBlockRule.matchObject"></a> |
1047 <h4>AdBlockRule.matchObject</h4> | 1044 <h4>AdBlockRule.matchObject</h4> |
1048 <b>matchObject</b>(<i>req</i>) | 1045 <b>matchObject</b>(<i>req</i>) |
1049 | |
1050 <p> | 1046 <p> |
1051 Public method to match an object rule. | 1047 Public method to match an object rule. |
1052 </p> | 1048 </p> |
1049 | |
1053 <dl> | 1050 <dl> |
1054 | 1051 |
1055 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1052 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1056 <dd> | 1053 <dd> |
1057 request object to check | 1054 request object to check |
1070 </dd> | 1067 </dd> |
1071 </dl> | 1068 </dl> |
1072 <a NAME="AdBlockRule.matchObjectSubrequest" ID="AdBlockRule.matchObjectSubrequest"></a> | 1069 <a NAME="AdBlockRule.matchObjectSubrequest" ID="AdBlockRule.matchObjectSubrequest"></a> |
1073 <h4>AdBlockRule.matchObjectSubrequest</h4> | 1070 <h4>AdBlockRule.matchObjectSubrequest</h4> |
1074 <b>matchObjectSubrequest</b>(<i>req</i>) | 1071 <b>matchObjectSubrequest</b>(<i>req</i>) |
1075 | |
1076 <p> | 1072 <p> |
1077 Public method to match an Object Subrequest rule. | 1073 Public method to match an Object Subrequest rule. |
1078 </p> | 1074 </p> |
1075 | |
1079 <dl> | 1076 <dl> |
1080 | 1077 |
1081 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1078 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1082 <dd> | 1079 <dd> |
1083 request object to check | 1080 request object to check |
1096 </dd> | 1093 </dd> |
1097 </dl> | 1094 </dl> |
1098 <a NAME="AdBlockRule.matchOther" ID="AdBlockRule.matchOther"></a> | 1095 <a NAME="AdBlockRule.matchOther" ID="AdBlockRule.matchOther"></a> |
1099 <h4>AdBlockRule.matchOther</h4> | 1096 <h4>AdBlockRule.matchOther</h4> |
1100 <b>matchOther</b>(<i>req</i>) | 1097 <b>matchOther</b>(<i>req</i>) |
1101 | |
1102 <p> | 1098 <p> |
1103 Public method to match any other rule. | 1099 Public method to match any other rule. |
1104 </p> | 1100 </p> |
1101 | |
1105 <dl> | 1102 <dl> |
1106 | 1103 |
1107 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1104 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1108 <dd> | 1105 <dd> |
1109 request object to check | 1106 request object to check |
1122 </dd> | 1119 </dd> |
1123 </dl> | 1120 </dl> |
1124 <a NAME="AdBlockRule.matchPing" ID="AdBlockRule.matchPing"></a> | 1121 <a NAME="AdBlockRule.matchPing" ID="AdBlockRule.matchPing"></a> |
1125 <h4>AdBlockRule.matchPing</h4> | 1122 <h4>AdBlockRule.matchPing</h4> |
1126 <b>matchPing</b>(<i>req</i>) | 1123 <b>matchPing</b>(<i>req</i>) |
1127 | |
1128 <p> | 1124 <p> |
1129 Public method to match a Ping rule. | 1125 Public method to match a Ping rule. |
1130 </p> | 1126 </p> |
1127 | |
1131 <dl> | 1128 <dl> |
1132 | 1129 |
1133 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1130 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1134 <dd> | 1131 <dd> |
1135 request object to check | 1132 request object to check |
1148 </dd> | 1145 </dd> |
1149 </dl> | 1146 </dl> |
1150 <a NAME="AdBlockRule.matchScript" ID="AdBlockRule.matchScript"></a> | 1147 <a NAME="AdBlockRule.matchScript" ID="AdBlockRule.matchScript"></a> |
1151 <h4>AdBlockRule.matchScript</h4> | 1148 <h4>AdBlockRule.matchScript</h4> |
1152 <b>matchScript</b>(<i>req</i>) | 1149 <b>matchScript</b>(<i>req</i>) |
1153 | |
1154 <p> | 1150 <p> |
1155 Public method to match a Script rule. | 1151 Public method to match a Script rule. |
1156 </p> | 1152 </p> |
1153 | |
1157 <dl> | 1154 <dl> |
1158 | 1155 |
1159 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1156 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1160 <dd> | 1157 <dd> |
1161 request object to check | 1158 request object to check |
1174 </dd> | 1171 </dd> |
1175 </dl> | 1172 </dl> |
1176 <a NAME="AdBlockRule.matchString" ID="AdBlockRule.matchString"></a> | 1173 <a NAME="AdBlockRule.matchString" ID="AdBlockRule.matchString"></a> |
1177 <h4>AdBlockRule.matchString</h4> | 1174 <h4>AdBlockRule.matchString</h4> |
1178 <b>matchString</b>(<i></i>) | 1175 <b>matchString</b>(<i></i>) |
1179 | |
1180 <p> | 1176 <p> |
1181 Public method to get the match string. | 1177 Public method to get the match string. |
1182 </p> | 1178 </p> |
1179 | |
1183 <dl> | 1180 <dl> |
1184 <dt>Return:</dt> | 1181 <dt>Return:</dt> |
1185 <dd> | 1182 <dd> |
1186 match string | 1183 match string |
1187 </dd> | 1184 </dd> |
1193 </dd> | 1190 </dd> |
1194 </dl> | 1191 </dl> |
1195 <a NAME="AdBlockRule.matchStyleSheet" ID="AdBlockRule.matchStyleSheet"></a> | 1192 <a NAME="AdBlockRule.matchStyleSheet" ID="AdBlockRule.matchStyleSheet"></a> |
1196 <h4>AdBlockRule.matchStyleSheet</h4> | 1193 <h4>AdBlockRule.matchStyleSheet</h4> |
1197 <b>matchStyleSheet</b>(<i>req</i>) | 1194 <b>matchStyleSheet</b>(<i>req</i>) |
1198 | |
1199 <p> | 1195 <p> |
1200 Public method to match a StyleSheet rule. | 1196 Public method to match a StyleSheet rule. |
1201 </p> | 1197 </p> |
1198 | |
1202 <dl> | 1199 <dl> |
1203 | 1200 |
1204 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1201 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1205 <dd> | 1202 <dd> |
1206 request object to check | 1203 request object to check |
1219 </dd> | 1216 </dd> |
1220 </dl> | 1217 </dl> |
1221 <a NAME="AdBlockRule.matchSubdocument" ID="AdBlockRule.matchSubdocument"></a> | 1218 <a NAME="AdBlockRule.matchSubdocument" ID="AdBlockRule.matchSubdocument"></a> |
1222 <h4>AdBlockRule.matchSubdocument</h4> | 1219 <h4>AdBlockRule.matchSubdocument</h4> |
1223 <b>matchSubdocument</b>(<i>req</i>) | 1220 <b>matchSubdocument</b>(<i>req</i>) |
1224 | |
1225 <p> | 1221 <p> |
1226 Public method to match a sub-document rule. | 1222 Public method to match a sub-document rule. |
1227 </p> | 1223 </p> |
1224 | |
1228 <dl> | 1225 <dl> |
1229 | 1226 |
1230 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1227 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1231 <dd> | 1228 <dd> |
1232 request object to check | 1229 request object to check |
1245 </dd> | 1242 </dd> |
1246 </dl> | 1243 </dl> |
1247 <a NAME="AdBlockRule.matchThirdParty" ID="AdBlockRule.matchThirdParty"></a> | 1244 <a NAME="AdBlockRule.matchThirdParty" ID="AdBlockRule.matchThirdParty"></a> |
1248 <h4>AdBlockRule.matchThirdParty</h4> | 1245 <h4>AdBlockRule.matchThirdParty</h4> |
1249 <b>matchThirdParty</b>(<i>req</i>) | 1246 <b>matchThirdParty</b>(<i>req</i>) |
1250 | |
1251 <p> | 1247 <p> |
1252 Public method to match a third-party rule. | 1248 Public method to match a third-party rule. |
1253 </p> | 1249 </p> |
1250 | |
1254 <dl> | 1251 <dl> |
1255 | 1252 |
1256 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1253 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1257 <dd> | 1254 <dd> |
1258 request object to check | 1255 request object to check |
1271 </dd> | 1268 </dd> |
1272 </dl> | 1269 </dl> |
1273 <a NAME="AdBlockRule.matchXmlHttpRequest" ID="AdBlockRule.matchXmlHttpRequest"></a> | 1270 <a NAME="AdBlockRule.matchXmlHttpRequest" ID="AdBlockRule.matchXmlHttpRequest"></a> |
1274 <h4>AdBlockRule.matchXmlHttpRequest</h4> | 1271 <h4>AdBlockRule.matchXmlHttpRequest</h4> |
1275 <b>matchXmlHttpRequest</b>(<i>req</i>) | 1272 <b>matchXmlHttpRequest</b>(<i>req</i>) |
1276 | |
1277 <p> | 1273 <p> |
1278 Public method to match a XmlHttpRequest rule. | 1274 Public method to match a XmlHttpRequest rule. |
1279 </p> | 1275 </p> |
1276 | |
1280 <dl> | 1277 <dl> |
1281 | 1278 |
1282 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> | 1279 <dt><i>req</i> (QWebEngineUrlRequestInfo)</dt> |
1283 <dd> | 1280 <dd> |
1284 request object to check | 1281 request object to check |
1297 </dd> | 1294 </dd> |
1298 </dl> | 1295 </dl> |
1299 <a NAME="AdBlockRule.networkMatch" ID="AdBlockRule.networkMatch"></a> | 1296 <a NAME="AdBlockRule.networkMatch" ID="AdBlockRule.networkMatch"></a> |
1300 <h4>AdBlockRule.networkMatch</h4> | 1297 <h4>AdBlockRule.networkMatch</h4> |
1301 <b>networkMatch</b>(<i>request, domain, encodedUrl</i>) | 1298 <b>networkMatch</b>(<i>request, domain, encodedUrl</i>) |
1302 | |
1303 <p> | 1299 <p> |
1304 Public method to check the rule for a match. | 1300 Public method to check the rule for a match. |
1305 </p> | 1301 </p> |
1302 | |
1306 <dl> | 1303 <dl> |
1307 | 1304 |
1308 <dt><i>request</i> (QWebEngineUrlRequestInfo)</dt> | 1305 <dt><i>request</i> (QWebEngineUrlRequestInfo)</dt> |
1309 <dd> | 1306 <dd> |
1310 reference to the network request | 1307 reference to the network request |
1331 </dd> | 1328 </dd> |
1332 </dl> | 1329 </dl> |
1333 <a NAME="AdBlockRule.ruleExceptions" ID="AdBlockRule.ruleExceptions"></a> | 1330 <a NAME="AdBlockRule.ruleExceptions" ID="AdBlockRule.ruleExceptions"></a> |
1334 <h4>AdBlockRule.ruleExceptions</h4> | 1331 <h4>AdBlockRule.ruleExceptions</h4> |
1335 <b>ruleExceptions</b>(<i></i>) | 1332 <b>ruleExceptions</b>(<i></i>) |
1336 | |
1337 <p> | 1333 <p> |
1338 Public method to get the rule exceptions. | 1334 Public method to get the rule exceptions. |
1339 </p> | 1335 </p> |
1336 | |
1340 <dl> | 1337 <dl> |
1341 <dt>Return:</dt> | 1338 <dt>Return:</dt> |
1342 <dd> | 1339 <dd> |
1343 rule exceptions | 1340 rule exceptions |
1344 </dd> | 1341 </dd> |
1350 </dd> | 1347 </dd> |
1351 </dl> | 1348 </dl> |
1352 <a NAME="AdBlockRule.ruleOptions" ID="AdBlockRule.ruleOptions"></a> | 1349 <a NAME="AdBlockRule.ruleOptions" ID="AdBlockRule.ruleOptions"></a> |
1353 <h4>AdBlockRule.ruleOptions</h4> | 1350 <h4>AdBlockRule.ruleOptions</h4> |
1354 <b>ruleOptions</b>(<i></i>) | 1351 <b>ruleOptions</b>(<i></i>) |
1355 | |
1356 <p> | 1352 <p> |
1357 Public method to get the rule options. | 1353 Public method to get the rule options. |
1358 </p> | 1354 </p> |
1355 | |
1359 <dl> | 1356 <dl> |
1360 <dt>Return:</dt> | 1357 <dt>Return:</dt> |
1361 <dd> | 1358 <dd> |
1362 rule options | 1359 rule options |
1363 </dd> | 1360 </dd> |
1369 </dd> | 1366 </dd> |
1370 </dl> | 1367 </dl> |
1371 <a NAME="AdBlockRule.ruleType" ID="AdBlockRule.ruleType"></a> | 1368 <a NAME="AdBlockRule.ruleType" ID="AdBlockRule.ruleType"></a> |
1372 <h4>AdBlockRule.ruleType</h4> | 1369 <h4>AdBlockRule.ruleType</h4> |
1373 <b>ruleType</b>(<i></i>) | 1370 <b>ruleType</b>(<i></i>) |
1374 | |
1375 <p> | 1371 <p> |
1376 Public method to get the rule type. | 1372 Public method to get the rule type. |
1377 </p> | 1373 </p> |
1374 | |
1378 <dl> | 1375 <dl> |
1379 <dt>Return:</dt> | 1376 <dt>Return:</dt> |
1380 <dd> | 1377 <dd> |
1381 rule type | 1378 rule type |
1382 </dd> | 1379 </dd> |
1388 </dd> | 1385 </dd> |
1389 </dl> | 1386 </dl> |
1390 <a NAME="AdBlockRule.setEnabled" ID="AdBlockRule.setEnabled"></a> | 1387 <a NAME="AdBlockRule.setEnabled" ID="AdBlockRule.setEnabled"></a> |
1391 <h4>AdBlockRule.setEnabled</h4> | 1388 <h4>AdBlockRule.setEnabled</h4> |
1392 <b>setEnabled</b>(<i>enabled</i>) | 1389 <b>setEnabled</b>(<i>enabled</i>) |
1393 | |
1394 <p> | 1390 <p> |
1395 Public method to set the rule's enabled state. | 1391 Public method to set the rule's enabled state. |
1396 </p> | 1392 </p> |
1393 | |
1397 <dl> | 1394 <dl> |
1398 | 1395 |
1399 <dt><i>enabled</i> (bool)</dt> | 1396 <dt><i>enabled</i> (bool)</dt> |
1400 <dd> | 1397 <dd> |
1401 flag indicating the new enabled state | 1398 flag indicating the new enabled state |
1402 </dd> | 1399 </dd> |
1403 </dl> | 1400 </dl> |
1404 <a NAME="AdBlockRule.setException" ID="AdBlockRule.setException"></a> | 1401 <a NAME="AdBlockRule.setException" ID="AdBlockRule.setException"></a> |
1405 <h4>AdBlockRule.setException</h4> | 1402 <h4>AdBlockRule.setException</h4> |
1406 <b>setException</b>(<i>exception</i>) | 1403 <b>setException</b>(<i>exception</i>) |
1407 | |
1408 <p> | 1404 <p> |
1409 Public method to set the rule's exception flag. | 1405 Public method to set the rule's exception flag. |
1410 </p> | 1406 </p> |
1407 | |
1411 <dl> | 1408 <dl> |
1412 | 1409 |
1413 <dt><i>exception</i> (bool)</dt> | 1410 <dt><i>exception</i> (bool)</dt> |
1414 <dd> | 1411 <dd> |
1415 flag indicating an exception rule | 1412 flag indicating an exception rule |
1416 </dd> | 1413 </dd> |
1417 </dl> | 1414 </dl> |
1418 <a NAME="AdBlockRule.setFilter" ID="AdBlockRule.setFilter"></a> | 1415 <a NAME="AdBlockRule.setFilter" ID="AdBlockRule.setFilter"></a> |
1419 <h4>AdBlockRule.setFilter</h4> | 1416 <h4>AdBlockRule.setFilter</h4> |
1420 <b>setFilter</b>(<i>filterRule</i>) | 1417 <b>setFilter</b>(<i>filterRule</i>) |
1421 | |
1422 <p> | 1418 <p> |
1423 Public method to set the rule filter string. | 1419 Public method to set the rule filter string. |
1424 </p> | 1420 </p> |
1421 | |
1425 <dl> | 1422 <dl> |
1426 | 1423 |
1427 <dt><i>filterRule</i> (str)</dt> | 1424 <dt><i>filterRule</i> (str)</dt> |
1428 <dd> | 1425 <dd> |
1429 rule filter string | 1426 rule filter string |
1430 </dd> | 1427 </dd> |
1431 </dl> | 1428 </dl> |
1432 <a NAME="AdBlockRule.setOption" ID="AdBlockRule.setOption"></a> | 1429 <a NAME="AdBlockRule.setOption" ID="AdBlockRule.setOption"></a> |
1433 <h4>AdBlockRule.setOption</h4> | 1430 <h4>AdBlockRule.setOption</h4> |
1434 <b>setOption</b>(<i>opt</i>) | 1431 <b>setOption</b>(<i>opt</i>) |
1435 | |
1436 <p> | 1432 <p> |
1437 Public method to set the given option. | 1433 Public method to set the given option. |
1438 </p> | 1434 </p> |
1435 | |
1439 <dl> | 1436 <dl> |
1440 | 1437 |
1441 <dt><i>opt</i> (AdBlockRuleOption)</dt> | 1438 <dt><i>opt</i> (AdBlockRuleOption)</dt> |
1442 <dd> | 1439 <dd> |
1443 option to be set | 1440 option to be set |
1444 </dd> | 1441 </dd> |
1445 </dl> | 1442 </dl> |
1446 <a NAME="AdBlockRule.setSubscription" ID="AdBlockRule.setSubscription"></a> | 1443 <a NAME="AdBlockRule.setSubscription" ID="AdBlockRule.setSubscription"></a> |
1447 <h4>AdBlockRule.setSubscription</h4> | 1444 <h4>AdBlockRule.setSubscription</h4> |
1448 <b>setSubscription</b>(<i>subscription</i>) | 1445 <b>setSubscription</b>(<i>subscription</i>) |
1449 | |
1450 <p> | 1446 <p> |
1451 Public method to set the subscription this rule belongs to. | 1447 Public method to set the subscription this rule belongs to. |
1452 </p> | 1448 </p> |
1449 | |
1453 <dl> | 1450 <dl> |
1454 | 1451 |
1455 <dt><i>subscription</i> (AdBlockSubscription)</dt> | 1452 <dt><i>subscription</i> (AdBlockSubscription)</dt> |
1456 <dd> | 1453 <dd> |
1457 subscription of the rule | 1454 subscription of the rule |
1458 </dd> | 1455 </dd> |
1459 </dl> | 1456 </dl> |
1460 <a NAME="AdBlockRule.subscription" ID="AdBlockRule.subscription"></a> | 1457 <a NAME="AdBlockRule.subscription" ID="AdBlockRule.subscription"></a> |
1461 <h4>AdBlockRule.subscription</h4> | 1458 <h4>AdBlockRule.subscription</h4> |
1462 <b>subscription</b>(<i></i>) | 1459 <b>subscription</b>(<i></i>) |
1463 | |
1464 <p> | 1460 <p> |
1465 Public method to get the subscription this rule belongs to. | 1461 Public method to get the subscription this rule belongs to. |
1466 </p> | 1462 </p> |
1463 | |
1467 <dl> | 1464 <dl> |
1468 <dt>Return:</dt> | 1465 <dt>Return:</dt> |
1469 <dd> | 1466 <dd> |
1470 subscription of the rule | 1467 subscription of the rule |
1471 </dd> | 1468 </dd> |
1477 </dd> | 1474 </dd> |
1478 </dl> | 1475 </dl> |
1479 <a NAME="AdBlockRule.urlMatch" ID="AdBlockRule.urlMatch"></a> | 1476 <a NAME="AdBlockRule.urlMatch" ID="AdBlockRule.urlMatch"></a> |
1480 <h4>AdBlockRule.urlMatch</h4> | 1477 <h4>AdBlockRule.urlMatch</h4> |
1481 <b>urlMatch</b>(<i>url</i>) | 1478 <b>urlMatch</b>(<i>url</i>) |
1482 | |
1483 <p> | 1479 <p> |
1484 Public method to check an URL against the rule. | 1480 Public method to check an URL against the rule. |
1485 </p> | 1481 </p> |
1482 | |
1486 <dl> | 1483 <dl> |
1487 | 1484 |
1488 <dt><i>url</i> (QUrl)</dt> | 1485 <dt><i>url</i> (QUrl)</dt> |
1489 <dd> | 1486 <dd> |
1490 URL to check | 1487 URL to check |
1505 <div align="right"><a href="#top">Up</a></div> | 1502 <div align="right"><a href="#top">Up</a></div> |
1506 <hr /> | 1503 <hr /> |
1507 <hr /> | 1504 <hr /> |
1508 <a NAME="AdBlockRuleOption" ID="AdBlockRuleOption"></a> | 1505 <a NAME="AdBlockRuleOption" ID="AdBlockRuleOption"></a> |
1509 <h2>AdBlockRuleOption</h2> | 1506 <h2>AdBlockRuleOption</h2> |
1510 | |
1511 <p> | 1507 <p> |
1512 Class implementing the rule option enum. | 1508 Class implementing the rule option enum. |
1513 </p> | 1509 </p> |
1510 | |
1514 <h3>Derived from</h3> | 1511 <h3>Derived from</h3> |
1515 IntEnum | 1512 IntEnum |
1516 <h3>Class Attributes</h3> | 1513 <h3>Class Attributes</h3> |
1517 | |
1518 <table> | 1514 <table> |
1519 <tr><td>DocumentOption</td></tr><tr><td>DomainRestrictedOption</td></tr><tr><td>ElementHideOption</td></tr><tr><td>FontOption</td></tr><tr><td>ImageOption</td></tr><tr><td>MediaOption</td></tr><tr><td>NoOption</td></tr><tr><td>ObjectOption</td></tr><tr><td>ObjectSubrequestOption</td></tr><tr><td>OtherOption</td></tr><tr><td>PingOption</td></tr><tr><td>ScriptOption</td></tr><tr><td>StyleSheetOption</td></tr><tr><td>SubdocumentOption</td></tr><tr><td>ThirdPartyOption</td></tr><tr><td>XMLHttpRequestOption</td></tr> | 1515 <tr><td>DocumentOption</td></tr> |
1516 <tr><td>DomainRestrictedOption</td></tr> | |
1517 <tr><td>ElementHideOption</td></tr> | |
1518 <tr><td>FontOption</td></tr> | |
1519 <tr><td>ImageOption</td></tr> | |
1520 <tr><td>MediaOption</td></tr> | |
1521 <tr><td>NoOption</td></tr> | |
1522 <tr><td>ObjectOption</td></tr> | |
1523 <tr><td>ObjectSubrequestOption</td></tr> | |
1524 <tr><td>OtherOption</td></tr> | |
1525 <tr><td>PingOption</td></tr> | |
1526 <tr><td>ScriptOption</td></tr> | |
1527 <tr><td>StyleSheetOption</td></tr> | |
1528 <tr><td>SubdocumentOption</td></tr> | |
1529 <tr><td>ThirdPartyOption</td></tr> | |
1530 <tr><td>XMLHttpRequestOption</td></tr> | |
1520 </table> | 1531 </table> |
1532 | |
1521 <h3>Class Methods</h3> | 1533 <h3>Class Methods</h3> |
1522 | |
1523 <table> | 1534 <table> |
1524 <tr><td>None</td></tr> | 1535 <tr><td>None</td></tr> |
1525 </table> | 1536 </table> |
1537 | |
1526 <h3>Methods</h3> | 1538 <h3>Methods</h3> |
1527 | |
1528 <table> | 1539 <table> |
1529 <tr><td>None</td></tr> | 1540 <tr><td>None</td></tr> |
1530 </table> | 1541 </table> |
1542 | |
1531 <h3>Static Methods</h3> | 1543 <h3>Static Methods</h3> |
1532 | |
1533 <table> | 1544 <table> |
1534 <tr><td>None</td></tr> | 1545 <tr><td>None</td></tr> |
1535 </table> | 1546 </table> |
1547 | |
1536 | 1548 |
1537 <div align="right"><a href="#top">Up</a></div> | 1549 <div align="right"><a href="#top">Up</a></div> |
1538 <hr /> | 1550 <hr /> |
1539 <hr /> | 1551 <hr /> |
1540 <a NAME="AdBlockRuleType" ID="AdBlockRuleType"></a> | 1552 <a NAME="AdBlockRuleType" ID="AdBlockRuleType"></a> |
1541 <h2>AdBlockRuleType</h2> | 1553 <h2>AdBlockRuleType</h2> |
1542 | |
1543 <p> | 1554 <p> |
1544 Class implementing the rule type enum. | 1555 Class implementing the rule type enum. |
1545 </p> | 1556 </p> |
1557 | |
1546 <h3>Derived from</h3> | 1558 <h3>Derived from</h3> |
1547 IntEnum | 1559 IntEnum |
1548 <h3>Class Attributes</h3> | 1560 <h3>Class Attributes</h3> |
1549 | |
1550 <table> | 1561 <table> |
1551 <tr><td>CssRule</td></tr><tr><td>DomainMatchRule</td></tr><tr><td>Invalid</td></tr><tr><td>MatchAllUrlsRule</td></tr><tr><td>RegExpMatchRule</td></tr><tr><td>StringContainsMatchRule</td></tr><tr><td>StringEndsMatchRule</td></tr> | 1562 <tr><td>CssRule</td></tr> |
1563 <tr><td>DomainMatchRule</td></tr> | |
1564 <tr><td>Invalid</td></tr> | |
1565 <tr><td>MatchAllUrlsRule</td></tr> | |
1566 <tr><td>RegExpMatchRule</td></tr> | |
1567 <tr><td>StringContainsMatchRule</td></tr> | |
1568 <tr><td>StringEndsMatchRule</td></tr> | |
1552 </table> | 1569 </table> |
1570 | |
1553 <h3>Class Methods</h3> | 1571 <h3>Class Methods</h3> |
1554 | |
1555 <table> | 1572 <table> |
1556 <tr><td>None</td></tr> | 1573 <tr><td>None</td></tr> |
1557 </table> | 1574 </table> |
1575 | |
1558 <h3>Methods</h3> | 1576 <h3>Methods</h3> |
1559 | |
1560 <table> | 1577 <table> |
1561 <tr><td>None</td></tr> | 1578 <tr><td>None</td></tr> |
1562 </table> | 1579 </table> |
1580 | |
1563 <h3>Static Methods</h3> | 1581 <h3>Static Methods</h3> |
1564 | |
1565 <table> | 1582 <table> |
1566 <tr><td>None</td></tr> | 1583 <tr><td>None</td></tr> |
1567 </table> | 1584 </table> |
1585 | |
1568 | 1586 |
1569 <div align="right"><a href="#top">Up</a></div> | 1587 <div align="right"><a href="#top">Up</a></div> |
1570 <hr /> | 1588 <hr /> |
1571 <hr /> | 1589 <hr /> |
1572 <a NAME="toSecondLevelDomain" ID="toSecondLevelDomain"></a> | 1590 <a NAME="toSecondLevelDomain" ID="toSecondLevelDomain"></a> |
1573 <h2>toSecondLevelDomain</h2> | 1591 <h2>toSecondLevelDomain</h2> |
1574 <b>toSecondLevelDomain</b>(<i>url</i>) | 1592 <b>toSecondLevelDomain</b>(<i>url</i>) |
1575 | |
1576 <p> | 1593 <p> |
1577 Module function to get a second level domain from the given URL. | 1594 Module function to get a second level domain from the given URL. |
1578 </p> | 1595 </p> |
1596 | |
1579 <dl> | 1597 <dl> |
1580 | 1598 |
1581 <dt><i>url</i> (QUrl)</dt> | 1599 <dt><i>url</i> (QUrl)</dt> |
1582 <dd> | 1600 <dd> |
1583 URL to extract domain from | 1601 URL to extract domain from |