Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockRule.html
Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockRule.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.AdBlock.AdBlockRule</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Helpviewer.AdBlock.AdBlockRule</h1> | |
| 12 <p> | |
| 13 Module implementing the AdBlock rule class. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#AdBlockRule">AdBlockRule</a></td> | |
| 23 <td>Class implementing the AdBlock rule.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="AdBlockRule" ID="AdBlockRule"></a> | |
| 32 <h2>AdBlockRule</h2> | |
| 33 <p> | |
| 34 Class implementing the AdBlock rule. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 object | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#AdBlockRule.__init__">AdBlockRule</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#AdBlockRule.__convertPatternToRegExp">__convertPatternToRegExp</a></td> | |
| 49 <td>Private method to convert a wildcard pattern to a regular expression.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#AdBlockRule.filter">filter</a></td> | |
| 52 <td>Public method to get the rule filter string.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#AdBlockRule.isCSSRule">isCSSRule</a></td> | |
| 55 <td>Public method to check, if the rule is a CSS rule.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#AdBlockRule.isEnabled">isEnabled</a></td> | |
| 58 <td>Public method to check, if the rule is enabled.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#AdBlockRule.isException">isException</a></td> | |
| 61 <td>Public method to check, if the rule defines an exception.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#AdBlockRule.networkMatch">networkMatch</a></td> | |
| 64 <td>Public method to check the rule for a match.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#AdBlockRule.regExpPattern">regExpPattern</a></td> | |
| 67 <td>Public method to get the regexp pattern of the rule.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#AdBlockRule.setEnabled">setEnabled</a></td> | |
| 70 <td>Public method to set the rule's enabled state.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#AdBlockRule.setException">setException</a></td> | |
| 73 <td>Public method to set the rule's exception flag.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#AdBlockRule.setFilter">setFilter</a></td> | |
| 76 <td>Public method to set the rule filter string.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#AdBlockRule.setPattern">setPattern</a></td> | |
| 79 <td>Public method to set the rule pattern.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <a NAME="AdBlockRule.__init__" ID="AdBlockRule.__init__"></a> | |
| 83 <h4>AdBlockRule (Constructor)</h4> | |
| 84 <b>AdBlockRule</b>(<i>filter = ""</i>) | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p><a NAME="AdBlockRule.__convertPatternToRegExp" ID="AdBlockRule.__convertPatternToRegExp"></a> | |
| 88 <h4>AdBlockRule.__convertPatternToRegExp</h4> | |
| 89 <b>__convertPatternToRegExp</b>(<i>wildcardPattern</i>) | |
| 90 <p> | |
| 91 Private method to convert a wildcard pattern to a regular expression. | |
| 92 </p><dl> | |
| 93 <dt><i>wildcardPattern</i></dt> | |
| 94 <dd> | |
| 95 string containing the wildcard pattern (string) | |
| 96 </dd> | |
| 97 </dl><dl> | |
| 98 <dt>Returns:</dt> | |
| 99 <dd> | |
| 100 string containing a regular expression (string) | |
| 101 </dd> | |
| 102 </dl><a NAME="AdBlockRule.filter" ID="AdBlockRule.filter"></a> | |
| 103 <h4>AdBlockRule.filter</h4> | |
| 104 <b>filter</b>(<i></i>) | |
| 105 <p> | |
| 106 Public method to get the rule filter string. | |
| 107 </p><dl> | |
| 108 <dt>Returns:</dt> | |
| 109 <dd> | |
| 110 rule filter string (string) | |
| 111 </dd> | |
| 112 </dl><a NAME="AdBlockRule.isCSSRule" ID="AdBlockRule.isCSSRule"></a> | |
| 113 <h4>AdBlockRule.isCSSRule</h4> | |
| 114 <b>isCSSRule</b>(<i></i>) | |
| 115 <p> | |
| 116 Public method to check, if the rule is a CSS rule. | |
| 117 </p><dl> | |
| 118 <dt>Returns:</dt> | |
| 119 <dd> | |
| 120 flag indicating a CSS rule (boolean) | |
| 121 </dd> | |
| 122 </dl><a NAME="AdBlockRule.isEnabled" ID="AdBlockRule.isEnabled"></a> | |
| 123 <h4>AdBlockRule.isEnabled</h4> | |
| 124 <b>isEnabled</b>(<i></i>) | |
| 125 <p> | |
| 126 Public method to check, if the rule is enabled. | |
| 127 </p><dl> | |
| 128 <dt>Returns:</dt> | |
| 129 <dd> | |
| 130 flag indicating enabled state (boolean) | |
| 131 </dd> | |
| 132 </dl><a NAME="AdBlockRule.isException" ID="AdBlockRule.isException"></a> | |
| 133 <h4>AdBlockRule.isException</h4> | |
| 134 <b>isException</b>(<i></i>) | |
| 135 <p> | |
| 136 Public method to check, if the rule defines an exception. | |
| 137 </p><dl> | |
| 138 <dt>Returns:</dt> | |
| 139 <dd> | |
| 140 flag indicating an exception (boolean) | |
| 141 </dd> | |
| 142 </dl><a NAME="AdBlockRule.networkMatch" ID="AdBlockRule.networkMatch"></a> | |
| 143 <h4>AdBlockRule.networkMatch</h4> | |
| 144 <b>networkMatch</b>(<i>encodedUrl</i>) | |
| 145 <p> | |
| 146 Public method to check the rule for a match. | |
| 147 </p><dl> | |
| 148 <dt><i>encodedUrl</i></dt> | |
| 149 <dd> | |
| 150 string encoded URL to be checked (string) | |
| 151 </dd> | |
| 152 </dl><dl> | |
| 153 <dt>Returns:</dt> | |
| 154 <dd> | |
| 155 flag indicating a match (boolean) | |
| 156 </dd> | |
| 157 </dl><a NAME="AdBlockRule.regExpPattern" ID="AdBlockRule.regExpPattern"></a> | |
| 158 <h4>AdBlockRule.regExpPattern</h4> | |
| 159 <b>regExpPattern</b>(<i></i>) | |
| 160 <p> | |
| 161 Public method to get the regexp pattern of the rule. | |
| 162 </p><dl> | |
| 163 <dt>Returns:</dt> | |
| 164 <dd> | |
| 165 regexp pattern (QRegExp) | |
| 166 </dd> | |
| 167 </dl><a NAME="AdBlockRule.setEnabled" ID="AdBlockRule.setEnabled"></a> | |
| 168 <h4>AdBlockRule.setEnabled</h4> | |
| 169 <b>setEnabled</b>(<i>enabled</i>) | |
| 170 <p> | |
| 171 Public method to set the rule's enabled state. | |
| 172 </p><dl> | |
| 173 <dt><i>enabled</i></dt> | |
| 174 <dd> | |
| 175 flag indicating the new enabled state (boolean) | |
| 176 </dd> | |
| 177 </dl><a NAME="AdBlockRule.setException" ID="AdBlockRule.setException"></a> | |
| 178 <h4>AdBlockRule.setException</h4> | |
| 179 <b>setException</b>(<i>exception</i>) | |
| 180 <p> | |
| 181 Public method to set the rule's exception flag. | |
| 182 </p><dl> | |
| 183 <dt><i>exception</i></dt> | |
| 184 <dd> | |
| 185 flag indicating an exception rule (boolean) | |
| 186 </dd> | |
| 187 </dl><a NAME="AdBlockRule.setFilter" ID="AdBlockRule.setFilter"></a> | |
| 188 <h4>AdBlockRule.setFilter</h4> | |
| 189 <b>setFilter</b>(<i>filter</i>) | |
| 190 <p> | |
| 191 Public method to set the rule filter string. | |
| 192 </p><dl> | |
| 193 <dt><i>filter</i></dt> | |
| 194 <dd> | |
| 195 rule filter string (string) | |
| 196 </dd> | |
| 197 </dl><a NAME="AdBlockRule.setPattern" ID="AdBlockRule.setPattern"></a> | |
| 198 <h4>AdBlockRule.setPattern</h4> | |
| 199 <b>setPattern</b>(<i>pattern, isRegExp</i>) | |
| 200 <p> | |
| 201 Public method to set the rule pattern. | |
| 202 </p><dl> | |
| 203 <dt><i>pattern</i></dt> | |
| 204 <dd> | |
| 205 string containing the pattern (string) | |
| 206 </dd><dt><i>isRegExp</i></dt> | |
| 207 <dd> | |
| 208 flag indicating a reg exp pattern (boolean) | |
| 209 </dd> | |
| 210 </dl> | |
| 211 <div align="right"><a href="#top">Up</a></div> | |
| 212 <hr /> | |
| 213 </body></html> |
