--- a/src/eric7/Documentation/Source/eric7.WebBrowser.AdBlock.AdBlockSubscription.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.AdBlock.AdBlockSubscription.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.AdBlock.AdBlockSubscription</h1>
-
<p>
Module implementing the AdBlock subscription class.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#AdBlockSubscription">AdBlockSubscription</a></td>
<td>Class implementing the AdBlock subscription.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="AdBlockSubscription" ID="AdBlockSubscription"></a>
<h2>AdBlockSubscription</h2>
-
<p>
Class implementing the AdBlock subscription.
</p>
+
<h3>Signals</h3>
<dl>
@@ -62,19 +61,17 @@
<h3>Derived from</h3>
QObject
<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="#AdBlockSubscription.__init__">AdBlockSubscription</a></td>
<td>Constructor</td>
@@ -180,19 +177,20 @@
<td>Public method to generate the URL for this subscription.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="AdBlockSubscription.__init__" ID="AdBlockSubscription.__init__"></a>
<h4>AdBlockSubscription (Constructor)</h4>
<b>AdBlockSubscription</b>(<i>url, custom, parent=None, default=False</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -215,17 +213,17 @@
<a NAME="AdBlockSubscription.__loadRules" ID="AdBlockSubscription.__loadRules"></a>
<h4>AdBlockSubscription.__loadRules</h4>
<b>__loadRules</b>(<i></i>)
-
<p>
Private method to load the rules of the subscription.
</p>
+
<a NAME="AdBlockSubscription.__parseUrl" ID="AdBlockSubscription.__parseUrl"></a>
<h4>AdBlockSubscription.__parseUrl</h4>
<b>__parseUrl</b>(<i>url</i>)
-
<p>
Private method to parse the AdBlock URL for the subscription.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -236,10 +234,10 @@
<a NAME="AdBlockSubscription.__rulesDownloaded" ID="AdBlockSubscription.__rulesDownloaded"></a>
<h4>AdBlockSubscription.__rulesDownloaded</h4>
<b>__rulesDownloaded</b>(<i>reply</i>)
-
<p>
Private slot to deal with the downloaded rules.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -250,10 +248,10 @@
<a NAME="AdBlockSubscription.__validateCheckSum" ID="AdBlockSubscription.__validateCheckSum"></a>
<h4>AdBlockSubscription.__validateCheckSum</h4>
<b>__validateCheckSum</b>(<i>fileName</i>)
-
<p>
Private method to check the subscription file's checksum.
</p>
+
<dl>
<dt><i>fileName</i> (str)</dt>
@@ -279,10 +277,10 @@
<a NAME="AdBlockSubscription.addRule" ID="AdBlockSubscription.addRule"></a>
<h4>AdBlockSubscription.addRule</h4>
<b>addRule</b>(<i>rule</i>)
-
<p>
Public method to add a rule.
</p>
+
<dl>
<dt><i>rule</i> (AdBlockRule)</dt>
@@ -305,10 +303,10 @@
<a NAME="AdBlockSubscription.allRules" ID="AdBlockSubscription.allRules"></a>
<h4>AdBlockSubscription.allRules</h4>
<b>allRules</b>(<i></i>)
-
<p>
Public method to get the list of rules.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -324,10 +322,10 @@
<a NAME="AdBlockSubscription.canBeRemoved" ID="AdBlockSubscription.canBeRemoved"></a>
<h4>AdBlockSubscription.canBeRemoved</h4>
<b>canBeRemoved</b>(<i></i>)
-
<p>
Public method to check, if the subscription can be removed.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -343,10 +341,10 @@
<a NAME="AdBlockSubscription.canEditRules" ID="AdBlockSubscription.canEditRules"></a>
<h4>AdBlockSubscription.canEditRules</h4>
<b>canEditRules</b>(<i></i>)
-
<p>
Public method to check, if rules can be edited.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -362,17 +360,17 @@
<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.isEnabled" ID="AdBlockSubscription.isEnabled"></a>
<h4>AdBlockSubscription.isEnabled</h4>
<b>isEnabled</b>(<i></i>)
-
<p>
Public method to check, if the subscription is enabled.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -388,10 +386,10 @@
<a NAME="AdBlockSubscription.lastUpdate" ID="AdBlockSubscription.lastUpdate"></a>
<h4>AdBlockSubscription.lastUpdate</h4>
<b>lastUpdate</b>(<i></i>)
-
<p>
Public method to get the date and time of the last update.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -407,10 +405,10 @@
<a NAME="AdBlockSubscription.location" ID="AdBlockSubscription.location"></a>
<h4>AdBlockSubscription.location</h4>
<b>location</b>(<i></i>)
-
<p>
Public method to get the subscription location.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -426,10 +424,10 @@
<a NAME="AdBlockSubscription.removeRule" ID="AdBlockSubscription.removeRule"></a>
<h4>AdBlockSubscription.removeRule</h4>
<b>removeRule</b>(<i>offset</i>)
-
<p>
Public method to remove a rule given the offset.
</p>
+
<dl>
<dt><i>offset</i> (int)</dt>
@@ -440,10 +438,10 @@
<a NAME="AdBlockSubscription.replaceRule" ID="AdBlockSubscription.replaceRule"></a>
<h4>AdBlockSubscription.replaceRule</h4>
<b>replaceRule</b>(<i>rule, offset</i>)
-
<p>
Public method to replace a rule given the offset.
</p>
+
<dl>
<dt><i>rule</i> (AdBlockRule)</dt>
@@ -470,10 +468,10 @@
<a NAME="AdBlockSubscription.requiresLocation" ID="AdBlockSubscription.requiresLocation"></a>
<h4>AdBlockSubscription.requiresLocation</h4>
<b>requiresLocation</b>(<i></i>)
-
<p>
Public method to get the location of a required subscription.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -489,10 +487,10 @@
<a NAME="AdBlockSubscription.rule" ID="AdBlockSubscription.rule"></a>
<h4>AdBlockSubscription.rule</h4>
<b>rule</b>(<i>offset</i>)
-
<p>
Public method to get a specific rule.
</p>
+
<dl>
<dt><i>offset</i> (int)</dt>
@@ -515,10 +513,10 @@
<a NAME="AdBlockSubscription.rulesFileName" ID="AdBlockSubscription.rulesFileName"></a>
<h4>AdBlockSubscription.rulesFileName</h4>
<b>rulesFileName</b>(<i></i>)
-
<p>
Public method to get the name of the rules file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -534,17 +532,17 @@
<a NAME="AdBlockSubscription.saveRules" ID="AdBlockSubscription.saveRules"></a>
<h4>AdBlockSubscription.saveRules</h4>
<b>saveRules</b>(<i></i>)
-
<p>
Public method to save the subscription rules.
</p>
+
<a NAME="AdBlockSubscription.setEnabled" ID="AdBlockSubscription.setEnabled"></a>
<h4>AdBlockSubscription.setEnabled</h4>
<b>setEnabled</b>(<i>enabled</i>)
-
<p>
Public method to set the enabled status.
</p>
+
<dl>
<dt><i>enabled</i> (bool)</dt>
@@ -555,10 +553,10 @@
<a NAME="AdBlockSubscription.setLocation" ID="AdBlockSubscription.setLocation"></a>
<h4>AdBlockSubscription.setLocation</h4>
<b>setLocation</b>(<i>url</i>)
-
<p>
Public method to set the subscription location.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -569,10 +567,10 @@
<a NAME="AdBlockSubscription.setRuleEnabled" ID="AdBlockSubscription.setRuleEnabled"></a>
<h4>AdBlockSubscription.setRuleEnabled</h4>
<b>setRuleEnabled</b>(<i>offset, enabled</i>)
-
<p>
Public method to enable a specific rule.
</p>
+
<dl>
<dt><i>offset</i> (int)</dt>
@@ -599,10 +597,10 @@
<a NAME="AdBlockSubscription.setTitle" ID="AdBlockSubscription.setTitle"></a>
<h4>AdBlockSubscription.setTitle</h4>
<b>setTitle</b>(<i>title</i>)
-
<p>
Public method to set the subscription title.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -613,10 +611,10 @@
<a NAME="AdBlockSubscription.title" ID="AdBlockSubscription.title"></a>
<h4>AdBlockSubscription.title</h4>
<b>title</b>(<i></i>)
-
<p>
Public method to get the subscription title.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -632,17 +630,17 @@
<a NAME="AdBlockSubscription.updateNow" ID="AdBlockSubscription.updateNow"></a>
<h4>AdBlockSubscription.updateNow</h4>
<b>updateNow</b>(<i></i>)
-
<p>
Public method to update the subscription immediately.
</p>
+
<a NAME="AdBlockSubscription.url" ID="AdBlockSubscription.url"></a>
<h4>AdBlockSubscription.url</h4>
<b>url</b>(<i></i>)
-
<p>
Public method to generate the URL for this subscription.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -657,4 +655,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
