diff -r 2fed7bc4ad83 -r d8c45fe8a1b9 Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockPage.html --- a/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockPage.html Thu Jul 26 18:38:15 2012 +0200 +++ b/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockPage.html Sat Jul 28 11:23:12 2012 +0200 @@ -33,6 +33,9 @@ <tr> <td><a href="#AdBlockPage">AdBlockPage</a></td> <td>Class to apply AdBlock rules to a web page.</td> +</tr><tr> +<td><a href="#AdBlockedPageEntry">AdBlockedPageEntry</a></td> +<td>Class implementing a data structure for web page rules.</td> </tr> </table> <h3>Functions</h3> @@ -58,42 +61,96 @@ <h3>Methods</h3> <table> <tr> -<td><a href="#AdBlockPage.__checkRule">__checkRule</a></td> -<td>Private method to check, if a rule applies to the given web page and host.</td> -</tr><tr> -<td><a href="#AdBlockPage.applyRulesToPage">applyRulesToPage</a></td> -<td>Public method to applay AdBlock rules to a web page.</td> +<td><a href="#AdBlockPage.hideBlockedPageEntries">hideBlockedPageEntries</a></td> +<td>Public method to apply AdBlock rules to a web page.</td> </tr> </table> <h3>Static Methods</h3> <table> <tr><td>None</td></tr> </table> -<a NAME="AdBlockPage.__checkRule" ID="AdBlockPage.__checkRule"></a> -<h4>AdBlockPage.__checkRule</h4> -<b>__checkRule</b>(<i>rule, page, host</i>) +<a NAME="AdBlockPage.hideBlockedPageEntries" ID="AdBlockPage.hideBlockedPageEntries"></a> +<h4>AdBlockPage.hideBlockedPageEntries</h4> +<b>hideBlockedPageEntries</b>(<i>page</i>) +<p> + Public method to apply AdBlock rules to a web page. +</p><dl> +<dt><i>page</i></dt> +<dd> +reference to the web page (HelpWebPage) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="AdBlockedPageEntry" ID="AdBlockedPageEntry"></a> +<h2>AdBlockedPageEntry</h2> <p> - Private method to check, if a rule applies to the given web page and host. + Class implementing a data structure for web page rules. +</p> +<h3>Derived from</h3> +object +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#AdBlockedPageEntry.__init__">AdBlockedPageEntry</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#AdBlockedPageEntry.__eq__">__eq__</a></td> +<td>Special method to test equality.</td> +</tr><tr> +<td><a href="#AdBlockedPageEntry.urlString">urlString</a></td> +<td>Public method to get the URL as a string.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="AdBlockedPageEntry.__init__" ID="AdBlockedPageEntry.__init__"></a> +<h4>AdBlockedPageEntry (Constructor)</h4> +<b>AdBlockedPageEntry</b>(<i>rule, url</i>) +<p> + Constructor </p><dl> <dt><i>rule</i></dt> <dd> -reference to the rule to check (AdBlockRule) -</dd><dt><i>page</i></dt> +AdBlock rule to add (AdBlockRule) +</dd><dt><i>url</i></dt> <dd> -reference to the web page (QWebPage) -</dd><dt><i>host</i></dt> +URL that matched the rule (QUrl) +</dd> +</dl><a NAME="AdBlockedPageEntry.__eq__" ID="AdBlockedPageEntry.__eq__"></a> +<h4>AdBlockedPageEntry.__eq__</h4> +<b>__eq__</b>(<i>other</i>) +<p> + Special method to test equality. +</p><dl> +<dt><i>other</i></dt> <dd> -host name (string) +reference to the other entry (AdBlockedPageEntry) </dd> -</dl><a NAME="AdBlockPage.applyRulesToPage" ID="AdBlockPage.applyRulesToPage"></a> -<h4>AdBlockPage.applyRulesToPage</h4> -<b>applyRulesToPage</b>(<i>page</i>) +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating equality (boolean) +</dd> +</dl><a NAME="AdBlockedPageEntry.urlString" ID="AdBlockedPageEntry.urlString"></a> +<h4>AdBlockedPageEntry.urlString</h4> +<b>urlString</b>(<i></i>) <p> - Public method to applay AdBlock rules to a web page. + Public method to get the URL as a string. </p><dl> -<dt><i>page</i></dt> +<dt>Returns:</dt> <dd> -reference to the web page (QWebPage) +URL as a string (string) </dd> </dl> <div align="right"><a href="#top">Up</a></div>