--- a/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockRule.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockRule.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Helpviewer.AdBlock.AdBlockRule</h1> <p> -Module implementing the AdBlock rule class. +Module implementing the AdBlock rule class. </p> <h3>Global Attributes</h3> <table> @@ -32,7 +32,7 @@ <table> <tr> <td><a href="#AdBlockRule">AdBlockRule</a></td> -<td>Class implementing the AdBlock rule.</td> +<td>Class implementing the AdBlock rule.</td> </tr> </table> <h3>Functions</h3> @@ -43,7 +43,7 @@ <a NAME="AdBlockRule" ID="AdBlockRule"></a> <h2>AdBlockRule</h2> <p> - Class implementing the AdBlock rule. + Class implementing the AdBlock rule. </p> <h3>Derived from</h3> object @@ -55,169 +55,169 @@ <table> <tr> <td><a href="#AdBlockRule.__init__">AdBlockRule</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#AdBlockRule.__convertPatternToRegExp">__convertPatternToRegExp</a></td> -<td>Private method to convert a wildcard pattern to a regular expression.</td> +<td>Private method to convert a wildcard pattern to a regular expression.</td> </tr><tr> <td><a href="#AdBlockRule.filter">filter</a></td> -<td>Public method to get the rule filter string.</td> +<td>Public method to get the rule filter string.</td> </tr><tr> <td><a href="#AdBlockRule.isCSSRule">isCSSRule</a></td> -<td>Public method to check, if the rule is a CSS rule.</td> +<td>Public method to check, if the rule is a CSS rule.</td> </tr><tr> <td><a href="#AdBlockRule.isEnabled">isEnabled</a></td> -<td>Public method to check, if the rule is enabled.</td> +<td>Public method to check, if the rule is enabled.</td> </tr><tr> <td><a href="#AdBlockRule.isException">isException</a></td> -<td>Public method to check, if the rule defines an exception.</td> +<td>Public method to check, if the rule defines an exception.</td> </tr><tr> <td><a href="#AdBlockRule.networkMatch">networkMatch</a></td> -<td>Public method to check the rule for a match.</td> +<td>Public method to check the rule for a match.</td> </tr><tr> <td><a href="#AdBlockRule.regExpPattern">regExpPattern</a></td> -<td>Public method to get the regexp pattern of the rule.</td> +<td>Public method to get the regexp pattern of the rule.</td> </tr><tr> <td><a href="#AdBlockRule.setEnabled">setEnabled</a></td> -<td>Public method to set the rule's enabled state.</td> +<td>Public method to set the rule's enabled state.</td> </tr><tr> <td><a href="#AdBlockRule.setException">setException</a></td> -<td>Public method to set the rule's exception flag.</td> +<td>Public method to set the rule's exception flag.</td> </tr><tr> <td><a href="#AdBlockRule.setFilter">setFilter</a></td> -<td>Public method to set the rule filter string.</td> +<td>Public method to set the rule filter string.</td> </tr><tr> <td><a href="#AdBlockRule.setPattern">setPattern</a></td> -<td>Public method to set the rule pattern.</td> +<td>Public method to set the rule pattern.</td> </tr> </table> <a NAME="AdBlockRule.__init__" ID="AdBlockRule.__init__"></a> <h4>AdBlockRule (Constructor)</h4> <b>AdBlockRule</b>(<i>filter = ""</i>) <p> - Constructor + Constructor </p><a NAME="AdBlockRule.__convertPatternToRegExp" ID="AdBlockRule.__convertPatternToRegExp"></a> <h4>AdBlockRule.__convertPatternToRegExp</h4> <b>__convertPatternToRegExp</b>(<i>wildcardPattern</i>) <p> - Private method to convert a wildcard pattern to a regular expression. + Private method to convert a wildcard pattern to a regular expression. </p><dl> <dt><i>wildcardPattern</i></dt> <dd> -string containing the wildcard pattern (string) +string containing the wildcard pattern (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> -string containing a regular expression (string) +string containing a regular expression (string) </dd> </dl><a NAME="AdBlockRule.filter" ID="AdBlockRule.filter"></a> <h4>AdBlockRule.filter</h4> <b>filter</b>(<i></i>) <p> - Public method to get the rule filter string. + Public method to get the rule filter string. </p><dl> <dt>Returns:</dt> <dd> -rule filter string (string) +rule filter string (string) </dd> </dl><a NAME="AdBlockRule.isCSSRule" ID="AdBlockRule.isCSSRule"></a> <h4>AdBlockRule.isCSSRule</h4> <b>isCSSRule</b>(<i></i>) <p> - Public method to check, if the rule is a CSS rule. + Public method to check, if the rule is a CSS rule. </p><dl> <dt>Returns:</dt> <dd> -flag indicating a CSS rule (boolean) +flag indicating a CSS rule (boolean) </dd> </dl><a NAME="AdBlockRule.isEnabled" ID="AdBlockRule.isEnabled"></a> <h4>AdBlockRule.isEnabled</h4> <b>isEnabled</b>(<i></i>) <p> - Public method to check, if the rule is enabled. + Public method to check, if the rule is enabled. </p><dl> <dt>Returns:</dt> <dd> -flag indicating enabled state (boolean) +flag indicating enabled state (boolean) </dd> </dl><a NAME="AdBlockRule.isException" ID="AdBlockRule.isException"></a> <h4>AdBlockRule.isException</h4> <b>isException</b>(<i></i>) <p> - Public method to check, if the rule defines an exception. + Public method to check, if the rule defines an exception. </p><dl> <dt>Returns:</dt> <dd> -flag indicating an exception (boolean) +flag indicating an exception (boolean) </dd> </dl><a NAME="AdBlockRule.networkMatch" ID="AdBlockRule.networkMatch"></a> <h4>AdBlockRule.networkMatch</h4> <b>networkMatch</b>(<i>encodedUrl</i>) <p> - Public method to check the rule for a match. + Public method to check the rule for a match. </p><dl> <dt><i>encodedUrl</i></dt> <dd> -string encoded URL to be checked (string) +string encoded URL to be checked (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> -flag indicating a match (boolean) +flag indicating a match (boolean) </dd> </dl><a NAME="AdBlockRule.regExpPattern" ID="AdBlockRule.regExpPattern"></a> <h4>AdBlockRule.regExpPattern</h4> <b>regExpPattern</b>(<i></i>) <p> - Public method to get the regexp pattern of the rule. + Public method to get the regexp pattern of the rule. </p><dl> <dt>Returns:</dt> <dd> -regexp pattern (QRegExp) +regexp pattern (QRegExp) </dd> </dl><a NAME="AdBlockRule.setEnabled" ID="AdBlockRule.setEnabled"></a> <h4>AdBlockRule.setEnabled</h4> <b>setEnabled</b>(<i>enabled</i>) <p> - Public method to set the rule's enabled state. + Public method to set the rule's enabled state. </p><dl> <dt><i>enabled</i></dt> <dd> -flag indicating the new enabled state (boolean) +flag indicating the new enabled state (boolean) </dd> </dl><a NAME="AdBlockRule.setException" ID="AdBlockRule.setException"></a> <h4>AdBlockRule.setException</h4> <b>setException</b>(<i>exception</i>) <p> - Public method to set the rule's exception flag. + Public method to set the rule's exception flag. </p><dl> <dt><i>exception</i></dt> <dd> -flag indicating an exception rule (boolean) +flag indicating an exception rule (boolean) </dd> </dl><a NAME="AdBlockRule.setFilter" ID="AdBlockRule.setFilter"></a> <h4>AdBlockRule.setFilter</h4> <b>setFilter</b>(<i>filter</i>) <p> - Public method to set the rule filter string. + Public method to set the rule filter string. </p><dl> <dt><i>filter</i></dt> <dd> -rule filter string (string) +rule filter string (string) </dd> </dl><a NAME="AdBlockRule.setPattern" ID="AdBlockRule.setPattern"></a> <h4>AdBlockRule.setPattern</h4> <b>setPattern</b>(<i>pattern, isRegExp</i>) <p> - Public method to set the rule pattern. + Public method to set the rule pattern. </p><dl> <dt><i>pattern</i></dt> <dd> -string containing the pattern (string) +string containing the pattern (string) </dd><dt><i>isRegExp</i></dt> <dd> -flag indicating a reg exp pattern (boolean) +flag indicating a reg exp pattern (boolean) </dd> </dl> <div align="right"><a href="#top">Up</a></div>