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

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- 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>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#65;&#100;&#66;&#108;&#111;&#99;&#107; &#114;&#117;&#108;&#101; &#99;&#108;&#97;&#115;&#115;.
+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>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#65;&#100;&#66;&#108;&#111;&#99;&#107; &#114;&#117;&#108;&#101;.</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>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#65;&#100;&#66;&#108;&#111;&#99;&#107; &#114;&#117;&#108;&#101;.
+    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>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#AdBlockRule.__convertPatternToRegExp">__convertPatternToRegExp</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#111;&#110;v&#101;&#114;&#116; &#97; w&#105;&#108;&#100;&#99;&#97;&#114;&#100; &#112;&#97;&#116;&#116;&#101;&#114;&#110; &#116;&#111; &#97; &#114;&#101;&#103;&#117;&#108;&#97;&#114; &#101;x&#112;&#114;&#101;&#115;&#115;&#105;&#111;&#110;.</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>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#102;&#105;&#108;&#116;&#101;&#114; &#115;&#116;&#114;&#105;&#110;&#103;.</td>
+<td>Public method to get the rule filter string.</td>
 </tr><tr>
 <td><a href="#AdBlockRule.isCSSRule">isCSSRule</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#105;&#115; &#97; &#67;&#83;&#83; &#114;&#117;&#108;&#101;.</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>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#105;&#115; &#101;&#110;&#97;&#98;&#108;&#101;&#100;.</td>
+<td>Public method to check, if the rule is enabled.</td>
 </tr><tr>
 <td><a href="#AdBlockRule.isException">isException</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#115; &#97;&#110; &#101;x&#99;&#101;&#112;&#116;&#105;&#111;&#110;.</td>
+<td>Public method to check, if the rule defines an exception.</td>
 </tr><tr>
 <td><a href="#AdBlockRule.networkMatch">networkMatch</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#102;&#111;&#114; &#97; &#109;&#97;&#116;&#99;&#104;.</td>
+<td>Public method to check the rule for a match.</td>
 </tr><tr>
 <td><a href="#AdBlockRule.regExpPattern">regExpPattern</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#114;&#101;&#103;&#101;x&#112; &#112;&#97;&#116;&#116;&#101;&#114;&#110; &#111;&#102; &#116;&#104;&#101; &#114;&#117;&#108;&#101;.</td>
+<td>Public method to get the regexp pattern of the rule.</td>
 </tr><tr>
 <td><a href="#AdBlockRule.setEnabled">setEnabled</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101;'&#115; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101;.</td>
+<td>Public method to set the rule's enabled state.</td>
 </tr><tr>
 <td><a href="#AdBlockRule.setException">setException</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101;'&#115; &#101;x&#99;&#101;&#112;&#116;&#105;&#111;&#110; &#102;&#108;&#97;&#103;.</td>
+<td>Public method to set the rule's exception flag.</td>
 </tr><tr>
 <td><a href="#AdBlockRule.setFilter">setFilter</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#102;&#105;&#108;&#116;&#101;&#114; &#115;&#116;&#114;&#105;&#110;&#103;.</td>
+<td>Public method to set the rule filter string.</td>
 </tr><tr>
 <td><a href="#AdBlockRule.setPattern">setPattern</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#112;&#97;&#116;&#116;&#101;&#114;&#110;.</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>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><a NAME="AdBlockRule.__convertPatternToRegExp" ID="AdBlockRule.__convertPatternToRegExp"></a>
 <h4>AdBlockRule.__convertPatternToRegExp</h4>
 <b>__convertPatternToRegExp</b>(<i>wildcardPattern</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#111;&#110;v&#101;&#114;&#116; &#97; w&#105;&#108;&#100;&#99;&#97;&#114;&#100; &#112;&#97;&#116;&#116;&#101;&#114;&#110; &#116;&#111; &#97; &#114;&#101;&#103;&#117;&#108;&#97;&#114; &#101;x&#112;&#114;&#101;&#115;&#115;&#105;&#111;&#110;.
+        Private method to convert a wildcard pattern to a regular expression.
 </p><dl>
 <dt><i>wildcardPattern</i></dt>
 <dd>
-&#115;&#116;&#114;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; w&#105;&#108;&#100;&#99;&#97;&#114;&#100; &#112;&#97;&#116;&#116;&#101;&#114;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+string containing the wildcard pattern (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#116;&#114;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#97; &#114;&#101;&#103;&#117;&#108;&#97;&#114; &#101;x&#112;&#114;&#101;&#115;&#115;&#105;&#111;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#102;&#105;&#108;&#116;&#101;&#114; &#115;&#116;&#114;&#105;&#110;&#103;.
+        Public method to get the rule filter string.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#117;&#108;&#101; &#102;&#105;&#108;&#116;&#101;&#114; &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;)
+rule filter string (string)
 </dd>
 </dl><a NAME="AdBlockRule.isCSSRule" ID="AdBlockRule.isCSSRule"></a>
 <h4>AdBlockRule.isCSSRule</h4>
 <b>isCSSRule</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#105;&#115; &#97; &#67;&#83;&#83; &#114;&#117;&#108;&#101;.
+        Public method to check, if the rule is a CSS rule.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#67;&#83;&#83; &#114;&#117;&#108;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#105;&#115; &#101;&#110;&#97;&#98;&#108;&#101;&#100;.
+        Public method to check, if the rule is enabled.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107;, &#105;&#102; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#100;&#101;&#102;&#105;&#110;&#101;&#115; &#97;&#110; &#101;x&#99;&#101;&#112;&#116;&#105;&#111;&#110;.
+        Public method to check, if the rule defines an exception.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97;&#110; &#101;x&#99;&#101;&#112;&#116;&#105;&#111;&#110; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#99;&#104;&#101;&#99;&#107; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#102;&#111;&#114; &#97; &#109;&#97;&#116;&#99;&#104;.
+        Public method to check the rule for a match.
 </p><dl>
 <dt><i>encodedUrl</i></dt>
 <dd>
-&#115;&#116;&#114;&#105;&#110;&#103; &#101;&#110;&#99;&#111;&#100;&#101;&#100; &#85;&#82;&#76; &#116;&#111; &#98;&#101; &#99;&#104;&#101;&#99;&#107;&#101;&#100; (&#115;&#116;&#114;&#105;&#110;&#103;)
+string encoded URL to be checked (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#109;&#97;&#116;&#99;&#104; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#114;&#101;&#103;&#101;x&#112; &#112;&#97;&#116;&#116;&#101;&#114;&#110; &#111;&#102; &#116;&#104;&#101; &#114;&#117;&#108;&#101;.
+        Public method to get the regexp pattern of the rule.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#101;&#103;&#101;x&#112; &#112;&#97;&#116;&#116;&#101;&#114;&#110; (&#81;&#82;&#101;&#103;&#69;x&#112;)
+regexp pattern (QRegExp)
 </dd>
 </dl><a NAME="AdBlockRule.setEnabled" ID="AdBlockRule.setEnabled"></a>
 <h4>AdBlockRule.setEnabled</h4>
 <b>setEnabled</b>(<i>enabled</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101;'&#115; &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101;.
+        Public method to set the rule's enabled state.
 </p><dl>
 <dt><i>enabled</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#110;&#101;w &#101;&#110;&#97;&#98;&#108;&#101;&#100; &#115;&#116;&#97;&#116;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101;'&#115; &#101;x&#99;&#101;&#112;&#116;&#105;&#111;&#110; &#102;&#108;&#97;&#103;.
+        Public method to set the rule's exception flag.
 </p><dl>
 <dt><i>exception</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97;&#110; &#101;x&#99;&#101;&#112;&#116;&#105;&#111;&#110; &#114;&#117;&#108;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#102;&#105;&#108;&#116;&#101;&#114; &#115;&#116;&#114;&#105;&#110;&#103;.
+        Public method to set the rule filter string.
 </p><dl>
 <dt><i>filter</i></dt>
 <dd>
-&#114;&#117;&#108;&#101; &#102;&#105;&#108;&#116;&#101;&#114; &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;)
+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>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#101;&#116; &#116;&#104;&#101; &#114;&#117;&#108;&#101; &#112;&#97;&#116;&#116;&#101;&#114;&#110;.
+        Public method to set the rule pattern.
 </p><dl>
 <dt><i>pattern</i></dt>
 <dd>
-&#115;&#116;&#114;&#105;&#110;&#103; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#112;&#97;&#116;&#116;&#101;&#114;&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+string containing the pattern (string)
 </dd><dt><i>isRegExp</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#114;&#101;&#103; &#101;x&#112; &#112;&#97;&#116;&#116;&#101;&#114;&#110; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating a reg exp pattern (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial