diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.Helpviewer.AdBlock.AdBlockRule.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.Helpviewer.AdBlock.AdBlockRule.html Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,225 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.Helpviewer.AdBlock.AdBlockRule</title>
+<style>
+body {
+ background:white;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.Helpviewer.AdBlock.AdBlockRule</h1>
+<p>
+Module implementing the AdBlock rule class.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#AdBlockRule">AdBlockRule</a></td>
+<td>Class implementing the AdBlock rule.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="AdBlockRule" ID="AdBlockRule"></a>
+<h2>AdBlockRule</h2>
+<p>
+ Class implementing the AdBlock rule.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#AdBlockRule.__init__">AdBlockRule</a></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>
+</tr><tr>
+<td><a href="#AdBlockRule.filter">filter</a></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>
+</tr><tr>
+<td><a href="#AdBlockRule.isEnabled">isEnabled</a></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>
+</tr><tr>
+<td><a href="#AdBlockRule.networkMatch">networkMatch</a></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>
+</tr><tr>
+<td><a href="#AdBlockRule.setEnabled">setEnabled</a></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>
+</tr><tr>
+<td><a href="#AdBlockRule.setFilter">setFilter</a></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>
+</tr>
+</table>
+<a NAME="AdBlockRule.__init__" ID="AdBlockRule.__init__"></a>
+<h4>AdBlockRule (Constructor)</h4>
+<b>AdBlockRule</b>(<i>filter = ""</i>)
+<p>
+ 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.
+</p><dl>
+<dt><i>wildcardPattern</i></dt>
+<dd>
+string containing the wildcard pattern (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+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.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+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.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+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.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+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.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+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.
+</p><dl>
+<dt><i>encodedUrl</i></dt>
+<dd>
+string encoded URL to be checked (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+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.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+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.
+</p><dl>
+<dt><i>enabled</i></dt>
+<dd>
+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.
+</p><dl>
+<dt><i>exception</i></dt>
+<dd>
+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.
+</p><dl>
+<dt><i>filter</i></dt>
+<dd>
+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.
+</p><dl>
+<dt><i>pattern</i></dt>
+<dd>
+string containing the pattern (string)
+</dd><dt><i>isRegExp</i></dt>
+<dd>
+flag indicating a reg exp pattern (boolean)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
