Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockSubscription.html

changeset 1970
02cf3bac079b
parent 1960
d8c45fe8a1b9
child 1971
a68d78702c98
equal deleted inserted replaced
1969:5522b3266c8b 1970:02cf3bac079b
89 <td>Public method to add a rule.</td> 89 <td>Public method to add a rule.</td>
90 </tr><tr> 90 </tr><tr>
91 <td><a href="#AdBlockSubscription.allRules">allRules</a></td> 91 <td><a href="#AdBlockSubscription.allRules">allRules</a></td>
92 <td>Public method to get the list of rules.</td> 92 <td>Public method to get the list of rules.</td>
93 </tr><tr> 93 </tr><tr>
94 <td><a href="#AdBlockSubscription.canBeRemoved">canBeRemoved</a></td>
95 <td>Public method to check, if the subscription can be removed.</td>
96 </tr><tr>
97 <td><a href="#AdBlockSubscription.canEditRules">canEditRules</a></td>
98 <td>Public method to check, if rules can be edited.</td>
99 </tr><tr>
94 <td><a href="#AdBlockSubscription.checkForUpdate">checkForUpdate</a></td> 100 <td><a href="#AdBlockSubscription.checkForUpdate">checkForUpdate</a></td>
95 <td>Public method to check for an update.</td> 101 <td>Public method to check for an update.</td>
96 </tr><tr> 102 </tr><tr>
97 <td><a href="#AdBlockSubscription.elemHideDisabledForUrl">elemHideDisabledForUrl</a></td> 103 <td><a href="#AdBlockSubscription.elemHideDisabledForUrl">elemHideDisabledForUrl</a></td>
98 <td>Public method to check, if element hiding is disabled for the given URL.</td> 104 <td>Public method to check, if element hiding is disabled for the given URL.</td>
119 <td>Public method to remove a rule given the offset.</td> 125 <td>Public method to remove a rule given the offset.</td>
120 </tr><tr> 126 </tr><tr>
121 <td><a href="#AdBlockSubscription.replaceRule">replaceRule</a></td> 127 <td><a href="#AdBlockSubscription.replaceRule">replaceRule</a></td>
122 <td>Public method to replace a rule given the offset.</td> 128 <td>Public method to replace a rule given the offset.</td>
123 </tr><tr> 129 </tr><tr>
130 <td><a href="#AdBlockSubscription.requiresLocation">requiresLocation</a></td>
131 <td>Public method to get the location of a required subscription.</td>
132 </tr><tr>
133 <td><a href="#AdBlockSubscription.rule">rule</a></td>
134 <td>Public method to get a specific rule.</td>
135 </tr><tr>
124 <td><a href="#AdBlockSubscription.rulesFileName">rulesFileName</a></td> 136 <td><a href="#AdBlockSubscription.rulesFileName">rulesFileName</a></td>
125 <td>Public method to get the name of the rules file.</td> 137 <td>Public method to get the name of the rules file.</td>
126 </tr><tr> 138 </tr><tr>
127 <td><a href="#AdBlockSubscription.saveRules">saveRules</a></td> 139 <td><a href="#AdBlockSubscription.saveRules">saveRules</a></td>
128 <td>Public method to save the subscription rules.</td> 140 <td>Public method to save the subscription rules.</td>
130 <td><a href="#AdBlockSubscription.setEnabled">setEnabled</a></td> 142 <td><a href="#AdBlockSubscription.setEnabled">setEnabled</a></td>
131 <td>Public method to set the enabled status.</td> 143 <td>Public method to set the enabled status.</td>
132 </tr><tr> 144 </tr><tr>
133 <td><a href="#AdBlockSubscription.setLocation">setLocation</a></td> 145 <td><a href="#AdBlockSubscription.setLocation">setLocation</a></td>
134 <td>Public method to set the subscription location.</td> 146 <td>Public method to set the subscription location.</td>
147 </tr><tr>
148 <td><a href="#AdBlockSubscription.setRuleEnabled">setRuleEnabled</a></td>
149 <td>Public method to enable a specific rule.</td>
135 </tr><tr> 150 </tr><tr>
136 <td><a href="#AdBlockSubscription.setTitle">setTitle</a></td> 151 <td><a href="#AdBlockSubscription.setTitle">setTitle</a></td>
137 <td>Public method to set the subscription title.</td> 152 <td>Public method to set the subscription title.</td>
138 </tr><tr> 153 </tr><tr>
139 <td><a href="#AdBlockSubscription.title">title</a></td> 154 <td><a href="#AdBlockSubscription.title">title</a></td>
150 <table> 165 <table>
151 <tr><td>None</td></tr> 166 <tr><td>None</td></tr>
152 </table> 167 </table>
153 <a NAME="AdBlockSubscription.__init__" ID="AdBlockSubscription.__init__"></a> 168 <a NAME="AdBlockSubscription.__init__" ID="AdBlockSubscription.__init__"></a>
154 <h4>AdBlockSubscription (Constructor)</h4> 169 <h4>AdBlockSubscription (Constructor)</h4>
155 <b>AdBlockSubscription</b>(<i>url, parent=None, default=False</i>) 170 <b>AdBlockSubscription</b>(<i>url, custom, parent=None, default=False</i>)
156 <p> 171 <p>
157 Constructor 172 Constructor
158 </p><dl> 173 </p><dl>
159 <dt><i>url</i></dt> 174 <dt><i>url</i></dt>
160 <dd> 175 <dd>
161 AdBlock URL for the subscription (QUrl) 176 AdBlock URL for the subscription (QUrl)
177 </dd><dt><i>custom</i></dt>
178 <dd>
179 flag indicating a custom subscription (boolean)
162 </dd><dt><i>parent</i></dt> 180 </dd><dt><i>parent</i></dt>
163 <dd> 181 <dd>
164 reference to the parent object (QObject) 182 reference to the parent object (QObject)
165 </dd><dt><i>default</i></dt> 183 </dd><dt><i>default</i></dt>
166 <dd> 184 <dd>
167 flag indicating a default subscription (Boolean) 185 flag indicating a default subscription (boolean)
168 </dd> 186 </dd>
169 </dl><a NAME="AdBlockSubscription.__loadRules" ID="AdBlockSubscription.__loadRules"></a> 187 </dl><a NAME="AdBlockSubscription.__loadRules" ID="AdBlockSubscription.__loadRules"></a>
170 <h4>AdBlockSubscription.__loadRules</h4> 188 <h4>AdBlockSubscription.__loadRules</h4>
171 <b>__loadRules</b>(<i></i>) 189 <b>__loadRules</b>(<i></i>)
172 <p> 190 <p>
214 </p><dl> 232 </p><dl>
215 <dt><i>rule</i></dt> 233 <dt><i>rule</i></dt>
216 <dd> 234 <dd>
217 reference to the rule to add (AdBlockRule) 235 reference to the rule to add (AdBlockRule)
218 </dd> 236 </dd>
237 </dl><dl>
238 <dt>Returns:</dt>
239 <dd>
240 offset of the rule (integer)
241 </dd>
219 </dl><a NAME="AdBlockSubscription.allRules" ID="AdBlockSubscription.allRules"></a> 242 </dl><a NAME="AdBlockSubscription.allRules" ID="AdBlockSubscription.allRules"></a>
220 <h4>AdBlockSubscription.allRules</h4> 243 <h4>AdBlockSubscription.allRules</h4>
221 <b>allRules</b>(<i></i>) 244 <b>allRules</b>(<i></i>)
222 <p> 245 <p>
223 Public method to get the list of rules. 246 Public method to get the list of rules.
224 </p><dl> 247 </p><dl>
225 <dt>Returns:</dt> 248 <dt>Returns:</dt>
226 <dd> 249 <dd>
227 list of rules (list of AdBlockRule) 250 list of rules (list of AdBlockRule)
251 </dd>
252 </dl><a NAME="AdBlockSubscription.canBeRemoved" ID="AdBlockSubscription.canBeRemoved"></a>
253 <h4>AdBlockSubscription.canBeRemoved</h4>
254 <b>canBeRemoved</b>(<i></i>)
255 <p>
256 Public method to check, if the subscription can be removed.
257 </p><dl>
258 <dt>Returns:</dt>
259 <dd>
260 flag indicating removal is allowed (boolean)
261 </dd>
262 </dl><a NAME="AdBlockSubscription.canEditRules" ID="AdBlockSubscription.canEditRules"></a>
263 <h4>AdBlockSubscription.canEditRules</h4>
264 <b>canEditRules</b>(<i></i>)
265 <p>
266 Public method to check, if rules can be edited.
267 </p><dl>
268 <dt>Returns:</dt>
269 <dd>
270 flag indicating rules may be edited (boolean)
228 </dd> 271 </dd>
229 </dl><a NAME="AdBlockSubscription.checkForUpdate" ID="AdBlockSubscription.checkForUpdate"></a> 272 </dl><a NAME="AdBlockSubscription.checkForUpdate" ID="AdBlockSubscription.checkForUpdate"></a>
230 <h4>AdBlockSubscription.checkForUpdate</h4> 273 <h4>AdBlockSubscription.checkForUpdate</h4>
231 <b>checkForUpdate</b>(<i></i>) 274 <b>checkForUpdate</b>(<i></i>)
232 <p> 275 <p>
343 reference to the rule to set (AdBlockRule) 386 reference to the rule to set (AdBlockRule)
344 </dd><dt><i>offset</i></dt> 387 </dd><dt><i>offset</i></dt>
345 <dd> 388 <dd>
346 offset of the rule to remove (integer) 389 offset of the rule to remove (integer)
347 </dd> 390 </dd>
391 </dl><dl>
392 <dt>Returns:</dt>
393 <dd>
394 requested rule (AdBlockRule)
395 </dd>
396 </dl><a NAME="AdBlockSubscription.requiresLocation" ID="AdBlockSubscription.requiresLocation"></a>
397 <h4>AdBlockSubscription.requiresLocation</h4>
398 <b>requiresLocation</b>(<i></i>)
399 <p>
400 Public method to get the location of a required subscription.
401 </p><dl>
402 <dt>Returns:</dt>
403 <dd>
404 location of a required subscription (string)
405 </dd>
406 </dl><a NAME="AdBlockSubscription.rule" ID="AdBlockSubscription.rule"></a>
407 <h4>AdBlockSubscription.rule</h4>
408 <b>rule</b>(<i>offset</i>)
409 <p>
410 Public method to get a specific rule.
411 </p><dl>
412 <dt><i>offset</i></dt>
413 <dd>
414 offset of the rule (integer)
415 </dd>
416 </dl><dl>
417 <dt>Returns:</dt>
418 <dd>
419 requested rule (AdBlockRule)
420 </dd>
348 </dl><a NAME="AdBlockSubscription.rulesFileName" ID="AdBlockSubscription.rulesFileName"></a> 421 </dl><a NAME="AdBlockSubscription.rulesFileName" ID="AdBlockSubscription.rulesFileName"></a>
349 <h4>AdBlockSubscription.rulesFileName</h4> 422 <h4>AdBlockSubscription.rulesFileName</h4>
350 <b>rulesFileName</b>(<i></i>) 423 <b>rulesFileName</b>(<i></i>)
351 <p> 424 <p>
352 Public method to get the name of the rules file. 425 Public method to get the name of the rules file.
378 </p><dl> 451 </p><dl>
379 <dt><i>url</i></dt> 452 <dt><i>url</i></dt>
380 <dd> 453 <dd>
381 URL of the subscription location (QUrl) 454 URL of the subscription location (QUrl)
382 </dd> 455 </dd>
456 </dl><a NAME="AdBlockSubscription.setRuleEnabled" ID="AdBlockSubscription.setRuleEnabled"></a>
457 <h4>AdBlockSubscription.setRuleEnabled</h4>
458 <b>setRuleEnabled</b>(<i>offset, enabled</i>)
459 <p>
460 Public method to enable a specific rule.
461 </p><dl>
462 <dt><i>offset</i></dt>
463 <dd>
464 offset of the rule (integer)
465 </dd><dt><i>enabled</i></dt>
466 <dd>
467 new enabled state (boolean)
468 </dd>
469 </dl><dl>
470 <dt>Returns:</dt>
471 <dd>
472 reference to the changed rule (AdBlockRule)
473 </dd>
383 </dl><a NAME="AdBlockSubscription.setTitle" ID="AdBlockSubscription.setTitle"></a> 474 </dl><a NAME="AdBlockSubscription.setTitle" ID="AdBlockSubscription.setTitle"></a>
384 <h4>AdBlockSubscription.setTitle</h4> 475 <h4>AdBlockSubscription.setTitle</h4>
385 <b>setTitle</b>(<i>title</i>) 476 <b>setTitle</b>(<i>title</i>)
386 <p> 477 <p>
387 Public method to set the subscription title. 478 Public method to set the subscription title.

eric ide

mercurial