--- a/src/eric7/Documentation/Source/eric7.WebBrowser.AdBlock.AdBlockManager.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.AdBlock.AdBlockManager.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.AdBlock.AdBlockManager</h1>
-
<p>
Module implementing the AdBlock manager.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#AdBlockManager">AdBlockManager</a></td>
<td>Class implementing the AdBlock manager.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="AdBlockManager" ID="AdBlockManager"></a>
<h2>AdBlockManager</h2>
-
<p>
Class implementing the AdBlock manager.
</p>
+
<h3>Signals</h3>
<dl>
@@ -59,19 +58,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="#AdBlockManager.__init__">AdBlockManager</a></td>
<td>Constructor</td>
@@ -217,19 +214,20 @@
<td>Public method to test, if limited EasyList rules shall be used.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="AdBlockManager.__init__" ID="AdBlockManager.__init__"></a>
<h4>AdBlockManager (Constructor)</h4>
<b>AdBlockManager</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -240,11 +238,11 @@
<a NAME="AdBlockManager.__canBeBlocked" ID="AdBlockManager.__canBeBlocked"></a>
<h4>AdBlockManager.__canBeBlocked</h4>
<b>__canBeBlocked</b>(<i>url</i>)
-
<p>
Private method to check, if the given URL could be blocked (i.e. is
not whitelisted).
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -267,10 +265,10 @@
<a NAME="AdBlockManager.__customSubscriptionLocation" ID="AdBlockManager.__customSubscriptionLocation"></a>
<h4>AdBlockManager.__customSubscriptionLocation</h4>
<b>__customSubscriptionLocation</b>(<i></i>)
-
<p>
Private method to generate the path for custom subscriptions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -286,10 +284,10 @@
<a NAME="AdBlockManager.__customSubscriptionUrl" ID="AdBlockManager.__customSubscriptionUrl"></a>
<h4>AdBlockManager.__customSubscriptionUrl</h4>
<b>__customSubscriptionUrl</b>(<i></i>)
-
<p>
Private method to generate the URL for custom subscriptions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -305,31 +303,31 @@
<a NAME="AdBlockManager.__loadSubscriptions" ID="AdBlockManager.__loadSubscriptions"></a>
<h4>AdBlockManager.__loadSubscriptions</h4>
<b>__loadSubscriptions</b>(<i></i>)
-
<p>
Private method to load the set of subscriptions.
</p>
+
<a NAME="AdBlockManager.__rulesChanged" ID="AdBlockManager.__rulesChanged"></a>
<h4>AdBlockManager.__rulesChanged</h4>
<b>__rulesChanged</b>(<i></i>)
-
<p>
Private slot handling a change of the AdBlock rules.
</p>
+
<a NAME="AdBlockManager.__updateMatcher" ID="AdBlockManager.__updateMatcher"></a>
<h4>AdBlockManager.__updateMatcher</h4>
<b>__updateMatcher</b>(<i></i>)
-
<p>
Private slot to update the adblock matcher.
</p>
+
<a NAME="AdBlockManager.addException" ID="AdBlockManager.addException"></a>
<h4>AdBlockManager.addException</h4>
<b>addException</b>(<i>host</i>)
-
<p>
Public method to add an exception.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -340,10 +338,10 @@
<a NAME="AdBlockManager.addSubscription" ID="AdBlockManager.addSubscription"></a>
<h4>AdBlockManager.addSubscription</h4>
<b>addSubscription</b>(<i>subscription</i>)
-
<p>
Public method to add an AdBlock subscription.
</p>
+
<dl>
<dt><i>subscription</i> (AdBlockSubscription)</dt>
@@ -354,10 +352,10 @@
<a NAME="AdBlockManager.addSubscriptionFromUrl" ID="AdBlockManager.addSubscriptionFromUrl"></a>
<h4>AdBlockManager.addSubscriptionFromUrl</h4>
<b>addSubscriptionFromUrl</b>(<i>url</i>)
-
<p>
Public method to ad an AdBlock subscription given the abp URL.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -380,10 +378,10 @@
<a NAME="AdBlockManager.block" ID="AdBlockManager.block"></a>
<h4>AdBlockManager.block</h4>
<b>block</b>(<i>info</i>)
-
<p>
Public method to check, if a request should be blocked.
</p>
+
<dl>
<dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
@@ -406,10 +404,10 @@
<a NAME="AdBlockManager.canRunOnScheme" ID="AdBlockManager.canRunOnScheme"></a>
<h4>AdBlockManager.canRunOnScheme</h4>
<b>canRunOnScheme</b>(<i>scheme</i>)
-
<p>
Public method to check, if AdBlock can be performed on the scheme.
</p>
+
<dl>
<dt><i>scheme</i> (str)</dt>
@@ -432,17 +430,17 @@
<a NAME="AdBlockManager.close" ID="AdBlockManager.close"></a>
<h4>AdBlockManager.close</h4>
<b>close</b>(<i></i>)
-
<p>
Public method to close the open search engines manager.
</p>
+
<a NAME="AdBlockManager.customRules" ID="AdBlockManager.customRules"></a>
<h4>AdBlockManager.customRules</h4>
<b>customRules</b>(<i></i>)
-
<p>
Public method to get a subscription for custom rules.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -458,13 +456,13 @@
<a NAME="AdBlockManager.elementHidingRules" ID="AdBlockManager.elementHidingRules"></a>
<h4>AdBlockManager.elementHidingRules</h4>
<b>elementHidingRules</b>(<i>url</i>)
-
<p>
Public method to get the element hiding rules.
</p>
<p>
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -487,10 +485,10 @@
<a NAME="AdBlockManager.elementHidingRulesForDomain" ID="AdBlockManager.elementHidingRulesForDomain"></a>
<h4>AdBlockManager.elementHidingRulesForDomain</h4>
<b>elementHidingRulesForDomain</b>(<i>url</i>)
-
<p>
Public method to get the element hiding rules for a domain.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -513,10 +511,10 @@
<a NAME="AdBlockManager.exceptions" ID="AdBlockManager.exceptions"></a>
<h4>AdBlockManager.exceptions</h4>
<b>exceptions</b>(<i></i>)
-
<p>
Public method to get a list of excepted hosts.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -532,10 +530,10 @@
<a NAME="AdBlockManager.getDefaultSubscriptionUrl" ID="AdBlockManager.getDefaultSubscriptionUrl"></a>
<h4>AdBlockManager.getDefaultSubscriptionUrl</h4>
<b>getDefaultSubscriptionUrl</b>(<i></i>)
-
<p>
Public method to get the default subscription URL.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -551,11 +549,11 @@
<a NAME="AdBlockManager.getRequiresSubscriptions" ID="AdBlockManager.getRequiresSubscriptions"></a>
<h4>AdBlockManager.getRequiresSubscriptions</h4>
<b>getRequiresSubscriptions</b>(<i>subscription</i>)
-
<p>
Public method to get a list of subscriptions, that require the given
one.
</p>
+
<dl>
<dt><i>subscription</i> (AdBlockSubscription)</dt>
@@ -578,10 +576,10 @@
<a NAME="AdBlockManager.isEnabled" ID="AdBlockManager.isEnabled"></a>
<h4>AdBlockManager.isEnabled</h4>
<b>isEnabled</b>(<i></i>)
-
<p>
Public method to check, if blocking ads is enabled.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -597,10 +595,10 @@
<a NAME="AdBlockManager.isHostExcepted" ID="AdBlockManager.isHostExcepted"></a>
<h4>AdBlockManager.isHostExcepted</h4>
<b>isHostExcepted</b>(<i>host</i>)
-
<p>
Public slot to check, if a host is excepted.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -623,17 +621,17 @@
<a NAME="AdBlockManager.load" ID="AdBlockManager.load"></a>
<h4>AdBlockManager.load</h4>
<b>load</b>(<i></i>)
-
<p>
Public method to load the AdBlock subscriptions.
</p>
+
<a NAME="AdBlockManager.loadRequiredSubscription" ID="AdBlockManager.loadRequiredSubscription"></a>
<h4>AdBlockManager.loadRequiredSubscription</h4>
<b>loadRequiredSubscription</b>(<i>location, title</i>)
-
<p>
Public method to load a subscription required by another one.
</p>
+
<dl>
<dt><i>location</i> (str)</dt>
@@ -648,10 +646,10 @@
<a NAME="AdBlockManager.page" ID="AdBlockManager.page"></a>
<h4>AdBlockManager.page</h4>
<b>page</b>(<i></i>)
-
<p>
Public method to get a reference to the page block object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -667,10 +665,10 @@
<a NAME="AdBlockManager.removeException" ID="AdBlockManager.removeException"></a>
<h4>AdBlockManager.removeException</h4>
<b>removeException</b>(<i>host</i>)
-
<p>
Public method to remove an exception.
</p>
+
<dl>
<dt><i>host</i> (str)</dt>
@@ -681,10 +679,10 @@
<a NAME="AdBlockManager.removeSubscription" ID="AdBlockManager.removeSubscription"></a>
<h4>AdBlockManager.removeSubscription</h4>
<b>removeSubscription</b>(<i>subscription, emitSignal=True</i>)
-
<p>
Public method to remove an AdBlock subscription.
</p>
+
<dl>
<dt><i>subscription</i> (AdBlockSubscription)</dt>
@@ -699,17 +697,17 @@
<a NAME="AdBlockManager.save" ID="AdBlockManager.save"></a>
<h4>AdBlockManager.save</h4>
<b>save</b>(<i></i>)
-
<p>
Public method to save the AdBlock subscriptions.
</p>
+
<a NAME="AdBlockManager.setEnabled" ID="AdBlockManager.setEnabled"></a>
<h4>AdBlockManager.setEnabled</h4>
<b>setEnabled</b>(<i>enabled</i>)
-
<p>
Public slot to set the enabled state.
</p>
+
<dl>
<dt><i>enabled</i> (bool)</dt>
@@ -720,10 +718,10 @@
<a NAME="AdBlockManager.setExceptions" ID="AdBlockManager.setExceptions"></a>
<h4>AdBlockManager.setExceptions</h4>
<b>setExceptions</b>(<i>hosts</i>)
-
<p>
Public method to set the list of excepted hosts.
</p>
+
<dl>
<dt><i>hosts</i> (list of str)</dt>
@@ -734,10 +732,10 @@
<a NAME="AdBlockManager.setUseLimitedEasyList" ID="AdBlockManager.setUseLimitedEasyList"></a>
<h4>AdBlockManager.setUseLimitedEasyList</h4>
<b>setUseLimitedEasyList</b>(<i>limited</i>)
-
<p>
Public method to set the limited EasyList flag.
</p>
+
<dl>
<dt><i>limited</i> (bool)</dt>
@@ -748,10 +746,10 @@
<a NAME="AdBlockManager.showDialog" ID="AdBlockManager.showDialog"></a>
<h4>AdBlockManager.showDialog</h4>
<b>showDialog</b>(<i>parent=None</i>)
-
<p>
Public slot to show the AdBlock subscription management dialog.
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -774,10 +772,10 @@
<a NAME="AdBlockManager.showExceptionsDialog" ID="AdBlockManager.showExceptionsDialog"></a>
<h4>AdBlockManager.showExceptionsDialog</h4>
<b>showExceptionsDialog</b>(<i></i>)
-
<p>
Public method to show the AdBlock Exceptions dialog.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -793,10 +791,10 @@
<a NAME="AdBlockManager.subscription" ID="AdBlockManager.subscription"></a>
<h4>AdBlockManager.subscription</h4>
<b>subscription</b>(<i>location</i>)
-
<p>
Public method to get a subscription based on its location.
</p>
+
<dl>
<dt><i>location</i> (str)</dt>
@@ -819,10 +817,10 @@
<a NAME="AdBlockManager.subscriptions" ID="AdBlockManager.subscriptions"></a>
<h4>AdBlockManager.subscriptions</h4>
<b>subscriptions</b>(<i></i>)
-
<p>
Public method to get all subscriptions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -838,17 +836,17 @@
<a NAME="AdBlockManager.updateAllSubscriptions" ID="AdBlockManager.updateAllSubscriptions"></a>
<h4>AdBlockManager.updateAllSubscriptions</h4>
<b>updateAllSubscriptions</b>(<i></i>)
-
<p>
Public method to update all subscriptions.
</p>
+
<a NAME="AdBlockManager.useLimitedEasyList" ID="AdBlockManager.useLimitedEasyList"></a>
<h4>AdBlockManager.useLimitedEasyList</h4>
<b>useLimitedEasyList</b>(<i></i>)
-
<p>
Public method to test, if limited EasyList rules shall be used.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -863,4 +861,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
