Mercurial Repositories > eric / file diff

diff: Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockSubscription.html

Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockSubscription.html

changeset 6028
859f6894eed9
parent 4918
71caf42a13d8
child 6123
39cd368143db
--- a/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockSubscription.html	Thu Dec 14 19:25:34 2017 +0100
+++ b/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockSubscription.html	Mon Dec 18 18:09:39 2017 +0100
@@ -54,6 +54,10 @@
 </dd><dt>rulesChanged()</dt>
 <dd>
 emitted after the subscription's rules have changed
+</dd><dt>rulesEnabledChanged()</dt>
+<dd>
+emitted after a rule enabled state was
+        changed
 </dd>
 </dl>
 <h3>Derived from</h3>
@@ -78,18 +82,12 @@
 <td><a href="#AdBlockSubscription.__parseUrl">__parseUrl</a></td>
 <td>Private method to parse the AdBlock URL for the subscription.</td>
 </tr><tr>
-<td><a href="#AdBlockSubscription.__populateCache">__populateCache</a></td>
-<td>Private method to populate the various rule caches.</td>
-</tr><tr>
 <td><a href="#AdBlockSubscription.__rulesDownloaded">__rulesDownloaded</a></td>
 <td>Private slot to deal with the downloaded rules.</td>
 </tr><tr>
 <td><a href="#AdBlockSubscription.__validateCheckSum">__validateCheckSum</a></td>
 <td>Private method to check the subscription file's checksum.</td>
 </tr><tr>
-<td><a href="#AdBlockSubscription.adBlockDisabledForUrl">adBlockDisabledForUrl</a></td>
-<td>Public method to check, if AdBlock is disabled for the given URL.</td>
-</tr><tr>
 <td><a href="#AdBlockSubscription.addRule">addRule</a></td>
 <td>Public method to add a rule.</td>
 </tr><tr>
@@ -105,15 +103,6 @@
 <td><a href="#AdBlockSubscription.checkForUpdate">checkForUpdate</a></td>
 <td>Public method to check for an update.</td>
 </tr><tr>
-<td><a href="#AdBlockSubscription.elemHideDisabledForUrl">elemHideDisabledForUrl</a></td>
-<td>Public method to check, if element hiding is disabled for the given URL.</td>
-</tr><tr>
-<td><a href="#AdBlockSubscription.elementHidingRules">elementHidingRules</a></td>
-<td>Public method to get the element hiding rules.</td>
-</tr><tr>
-<td><a href="#AdBlockSubscription.elementHidingRulesForDomain">elementHidingRulesForDomain</a></td>
-<td>Public method to get the element hiding rules for the given domain.</td>
-</tr><tr>
 <td><a href="#AdBlockSubscription.isEnabled">isEnabled</a></td>
 <td>Public method to check, if the subscription is enabled.</td>
 </tr><tr>
@@ -123,9 +112,6 @@
 <td><a href="#AdBlockSubscription.location">location</a></td>
 <td>Public method to get the subscription location.</td>
 </tr><tr>
-<td><a href="#AdBlockSubscription.match">match</a></td>
-<td>Public method to check the subscription for a matching rule.</td>
-</tr><tr>
 <td><a href="#AdBlockSubscription.removeRule">removeRule</a></td>
 <td>Public method to remove a rule given the offset.</td>
 </tr><tr>
@@ -200,16 +186,11 @@
 <p>
         Private method to parse the AdBlock URL for the subscription.
 </p><dl>
-<dt><i>url</i></dt>
+<dt><i>url</i> (QUrl)</dt>
 <dd>
-AdBlock URL for the subscription (QUrl)
+AdBlock URL for the subscription
 </dd>
-</dl><a NAME="AdBlockSubscription.__populateCache" ID="AdBlockSubscription.__populateCache"></a>
-<h4>AdBlockSubscription.__populateCache</h4>
-<b>__populateCache</b>(<i></i>)
-<p>
-        Private method to populate the various rule caches.
-</p><a NAME="AdBlockSubscription.__rulesDownloaded" ID="AdBlockSubscription.__rulesDownloaded"></a>
+</dl><a NAME="AdBlockSubscription.__rulesDownloaded" ID="AdBlockSubscription.__rulesDownloaded"></a>
 <h4>AdBlockSubscription.__rulesDownloaded</h4>
 <b>__rulesDownloaded</b>(<i></i>)
 <p>
@@ -220,32 +201,22 @@
 <p>
         Private method to check the subscription file's checksum.
 </p><dl>
-<dt><i>fileName</i></dt>
+<dt><i>fileName</i> (str)</dt>
 <dd>
-name of the file containing the subscription (string)
+name of the file containing the subscription
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating a valid file (boolean). A file is considered
+flag indicating a valid file. A file is considered
             valid, if the checksum is OK, the file does not contain a
             checksum (i.e. cannot be checked) or we are using the limited
             EasyList (because we fiddled with the original).
 </dd>
-</dl><a NAME="AdBlockSubscription.adBlockDisabledForUrl" ID="AdBlockSubscription.adBlockDisabledForUrl"></a>
-<h4>AdBlockSubscription.adBlockDisabledForUrl</h4>
-<b>adBlockDisabledForUrl</b>(<i>url</i>)
-<p>
-        Public method to check, if AdBlock is disabled for the given URL.
-</p><dl>
-<dt><i>url</i></dt>
+</dl><dl>
+<dt>Return Type:</dt>
 <dd>
-URL to check (QUrl)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating disabled state (boolean)
+bool
 </dd>
 </dl><a NAME="AdBlockSubscription.addRule" ID="AdBlockSubscription.addRule"></a>
 <h4>AdBlockSubscription.addRule</h4>
@@ -253,14 +224,19 @@
 <p>
         Public method to add a rule.
 </p><dl>
-<dt><i>rule</i></dt>
+<dt><i>rule</i> (AdBlockRule)</dt>
 <dd>
-reference to the rule to add (AdBlockRule)
+reference to the rule to add
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-offset of the rule (integer)
+offset of the rule
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl><a NAME="AdBlockSubscription.allRules" ID="AdBlockSubscription.allRules"></a>
 <h4>AdBlockSubscription.allRules</h4>
@@ -270,7 +246,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-list of rules (list of AdBlockRule)
+list of rules
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of AdBlockRule
 </dd>
 </dl><a NAME="AdBlockSubscription.canBeRemoved" ID="AdBlockSubscription.canBeRemoved"></a>
 <h4>AdBlockSubscription.canBeRemoved</h4>
@@ -280,7 +261,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating removal is allowed (boolean)
+flag indicating removal is allowed
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="AdBlockSubscription.canEditRules" ID="AdBlockSubscription.canEditRules"></a>
 <h4>AdBlockSubscription.canEditRules</h4>
@@ -290,55 +276,19 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating rules may be edited (boolean)
+flag indicating rules may be edited
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="AdBlockSubscription.checkForUpdate" ID="AdBlockSubscription.checkForUpdate"></a>
 <h4>AdBlockSubscription.checkForUpdate</h4>
 <b>checkForUpdate</b>(<i></i>)
 <p>
         Public method to check for an update.
-</p><a NAME="AdBlockSubscription.elemHideDisabledForUrl" ID="AdBlockSubscription.elemHideDisabledForUrl"></a>
-<h4>AdBlockSubscription.elemHideDisabledForUrl</h4>
-<b>elemHideDisabledForUrl</b>(<i>url</i>)
-<p>
-        Public method to check, if element hiding is disabled for the given
-        URL.
-</p><dl>
-<dt><i>url</i></dt>
-<dd>
-URL to check (QUrl)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-flag indicating disabled state (boolean)
-</dd>
-</dl><a NAME="AdBlockSubscription.elementHidingRules" ID="AdBlockSubscription.elementHidingRules"></a>
-<h4>AdBlockSubscription.elementHidingRules</h4>
-<b>elementHidingRules</b>(<i></i>)
-<p>
-        Public method to get the element hiding rules.
-</p><dl>
-<dt>Returns:</dt>
-<dd>
-element hiding rules (string)
-</dd>
-</dl><a NAME="AdBlockSubscription.elementHidingRulesForDomain" ID="AdBlockSubscription.elementHidingRulesForDomain"></a>
-<h4>AdBlockSubscription.elementHidingRulesForDomain</h4>
-<b>elementHidingRulesForDomain</b>(<i>domain</i>)
-<p>
-        Public method to get the element hiding rules for the given domain.
-</p><dl>
-<dt><i>domain</i></dt>
-<dd>
-domain name (string)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-element hiding rules (string)
-</dd>
-</dl><a NAME="AdBlockSubscription.isEnabled" ID="AdBlockSubscription.isEnabled"></a>
+</p><a NAME="AdBlockSubscription.isEnabled" ID="AdBlockSubscription.isEnabled"></a>
 <h4>AdBlockSubscription.isEnabled</h4>
 <b>isEnabled</b>(<i></i>)
 <p>
@@ -346,7 +296,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating the enabled status (boolean)
+flag indicating the enabled status
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="AdBlockSubscription.lastUpdate" ID="AdBlockSubscription.lastUpdate"></a>
 <h4>AdBlockSubscription.lastUpdate</h4>
@@ -356,7 +311,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-date and time of the last update (QDateTime)
+date and time of the last update
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QDateTime
 </dd>
 </dl><a NAME="AdBlockSubscription.location" ID="AdBlockSubscription.location"></a>
 <h4>AdBlockSubscription.location</h4>
@@ -366,28 +326,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-URL of the subscription location (QUrl)
-</dd>
-</dl><a NAME="AdBlockSubscription.match" ID="AdBlockSubscription.match"></a>
-<h4>AdBlockSubscription.match</h4>
-<b>match</b>(<i>req, urlDomain, urlString</i>)
-<p>
-        Public method to check the subscription for a matching rule.
-</p><dl>
-<dt><i>req</i></dt>
-<dd>
-reference to the network request (QWebEngineUrlRequestInfo)
-</dd><dt><i>urlDomain</i></dt>
-<dd>
-domain of the URL (string)
-</dd><dt><i>urlString</i></dt>
-<dd>
-URL (string)
+URL of the subscription location
 </dd>
 </dl><dl>
-<dt>Returns:</dt>
+<dt>Return Type:</dt>
 <dd>
-reference to the rule object or None (AdBlockRule)
+QUrl
 </dd>
 </dl><a NAME="AdBlockSubscription.removeRule" ID="AdBlockSubscription.removeRule"></a>
 <h4>AdBlockSubscription.removeRule</h4>
@@ -395,9 +339,9 @@
 <p>
         Public method to remove a rule given the offset.
 </p><dl>
-<dt><i>offset</i></dt>
+<dt><i>offset</i> (int)</dt>
 <dd>
-offset of the rule to remove (integer)
+offset of the rule to remove
 </dd>
 </dl><a NAME="AdBlockSubscription.replaceRule" ID="AdBlockSubscription.replaceRule"></a>
 <h4>AdBlockSubscription.replaceRule</h4>
@@ -405,17 +349,22 @@
 <p>
         Public method to replace a rule given the offset.
 </p><dl>
-<dt><i>rule</i></dt>
+<dt><i>rule</i> (AdBlockRule)</dt>
 <dd>
-reference to the rule to set (AdBlockRule)
-</dd><dt><i>offset</i></dt>
+reference to the rule to set
+</dd><dt><i>offset</i> (int)</dt>
 <dd>
-offset of the rule to remove (integer)
+offset of the rule to remove
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-requested rule (AdBlockRule)
+requested rule
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+AdBlockRule
 </dd>
 </dl><a NAME="AdBlockSubscription.requiresLocation" ID="AdBlockSubscription.requiresLocation"></a>
 <h4>AdBlockSubscription.requiresLocation</h4>
@@ -425,7 +374,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-location of a required subscription (string)
+location of a required subscription
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl><a NAME="AdBlockSubscription.rule" ID="AdBlockSubscription.rule"></a>
 <h4>AdBlockSubscription.rule</h4>
@@ -433,14 +387,19 @@
 <p>
         Public method to get a specific rule.
 </p><dl>
-<dt><i>offset</i></dt>
+<dt><i>offset</i> (int)</dt>
 <dd>
-offset of the rule (integer)
+offset of the rule
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-requested rule (AdBlockRule)
+requested rule
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+AdBlockRule
 </dd>
 </dl><a NAME="AdBlockSubscription.rulesFileName" ID="AdBlockSubscription.rulesFileName"></a>
 <h4>AdBlockSubscription.rulesFileName</h4>
@@ -450,7 +409,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-name of the rules file (string)
+name of the rules file
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl><a NAME="AdBlockSubscription.saveRules" ID="AdBlockSubscription.saveRules"></a>
 <h4>AdBlockSubscription.saveRules</h4>
@@ -463,9 +427,9 @@
 <p>
         Public method to set the enabled status.
 </p><dl>
-<dt><i>enabled</i></dt>
+<dt><i>enabled</i> (bool)</dt>
 <dd>
-flag indicating the enabled status (boolean)
+flag indicating the enabled status
 </dd>
 </dl><a NAME="AdBlockSubscription.setLocation" ID="AdBlockSubscription.setLocation"></a>
 <h4>AdBlockSubscription.setLocation</h4>
@@ -473,9 +437,9 @@
 <p>
         Public method to set the subscription location.
 </p><dl>
-<dt><i>url</i></dt>
+<dt><i>url</i> (QUrl)</dt>
 <dd>
-URL of the subscription location (QUrl)
+URL of the subscription location
 </dd>
 </dl><a NAME="AdBlockSubscription.setRuleEnabled" ID="AdBlockSubscription.setRuleEnabled"></a>
 <h4>AdBlockSubscription.setRuleEnabled</h4>
@@ -483,17 +447,22 @@
 <p>
         Public method to enable a specific rule.
 </p><dl>
-<dt><i>offset</i></dt>
+<dt><i>offset</i> (int)</dt>
 <dd>
-offset of the rule (integer)
-</dd><dt><i>enabled</i></dt>
+offset of the rule
+</dd><dt><i>enabled</i> (bool)</dt>
 <dd>
-new enabled state (boolean)
+new enabled state
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-reference to the changed rule (AdBlockRule)
+reference to the changed rule
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+AdBlockRule
 </dd>
 </dl><a NAME="AdBlockSubscription.setTitle" ID="AdBlockSubscription.setTitle"></a>
 <h4>AdBlockSubscription.setTitle</h4>
@@ -501,9 +470,9 @@
 <p>
         Public method to set the subscription title.
 </p><dl>
-<dt><i>title</i></dt>
+<dt><i>title</i> (str)</dt>
 <dd>
-subscription title (string)
+subscription title
 </dd>
 </dl><a NAME="AdBlockSubscription.title" ID="AdBlockSubscription.title"></a>
 <h4>AdBlockSubscription.title</h4>
@@ -513,7 +482,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-subscription title (string)
+subscription title
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+string
 </dd>
 </dl><a NAME="AdBlockSubscription.updateNow" ID="AdBlockSubscription.updateNow"></a>
 <h4>AdBlockSubscription.updateNow</h4>
@@ -528,7 +502,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-AdBlock URL for the subscription (QUrl)
+AdBlock URL for the subscription
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QUrl
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial