Mercurial Repositories > eric / file diff

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

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

changeset 6028
859f6894eed9
parent 5727
c8842a8d1167
--- a/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockManager.html	Thu Dec 14 19:25:34 2017 +0100
+++ b/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockManager.html	Mon Dec 18 18:09:39 2017 +0100
@@ -45,7 +45,11 @@
     Class implementing the AdBlock manager.
 </p><h3>Signals</h3>
 <dl>
-<dt>requiredSubscriptionLoaded(subscription)</dt>
+<dt>enabledChanged(enabled)</dt>
+<dd>
+emitted to indicate a change of the
+        enabled state
+</dd><dt>requiredSubscriptionLoaded(subscription)</dt>
 <dd>
 emitted to indicate
         loading of a required subscription is finished (AdBlockSubscription)
@@ -70,8 +74,8 @@
 <td><a href="#AdBlockManager.__init__">AdBlockManager</a></td>
 <td>Constructor</td>
 </tr><tr>
-<td><a href="#AdBlockManager.__canRunOnScheme">__canRunOnScheme</a></td>
-<td>Private method to check, if AdBlock can be performed on the scheme.</td>
+<td><a href="#AdBlockManager.__canBeBlocked">__canBeBlocked</a></td>
+<td>Private method to check, if the given URL could be blocked (i.e.</td>
 </tr><tr>
 <td><a href="#AdBlockManager.__customSubscriptionLocation">__customSubscriptionLocation</a></td>
 <td>Private method to generate the path for custom subscriptions.</td>
@@ -85,6 +89,9 @@
 <td><a href="#AdBlockManager.__rulesChanged">__rulesChanged</a></td>
 <td>Private slot handling a change of the AdBlock rules.</td>
 </tr><tr>
+<td><a href="#AdBlockManager.__updateMatcher">__updateMatcher</a></td>
+<td>Private slot to update the adblock matcher.</td>
+</tr><tr>
 <td><a href="#AdBlockManager.addException">addException</a></td>
 <td>Public method to add an exception.</td>
 </tr><tr>
@@ -97,6 +104,9 @@
 <td><a href="#AdBlockManager.block">block</a></td>
 <td>Public method to check, if a request should be blocked.</td>
 </tr><tr>
+<td><a href="#AdBlockManager.canRunOnScheme">canRunOnScheme</a></td>
+<td>Public method to check, if AdBlock can be performed on the scheme.</td>
+</tr><tr>
 <td><a href="#AdBlockManager.close">close</a></td>
 <td>Public method to close the open search engines manager.</td>
 </tr><tr>
@@ -180,24 +190,30 @@
 <p>
         Constructor
 </p><dl>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QObject)</dt>
 <dd>
-reference to the parent object (QObject)
+reference to the parent object
 </dd>
-</dl><a NAME="AdBlockManager.__canRunOnScheme" ID="AdBlockManager.__canRunOnScheme"></a>
-<h4>AdBlockManager.__canRunOnScheme</h4>
-<b>__canRunOnScheme</b>(<i>scheme</i>)
+</dl><a NAME="AdBlockManager.__canBeBlocked" ID="AdBlockManager.__canBeBlocked"></a>
+<h4>AdBlockManager.__canBeBlocked</h4>
+<b>__canBeBlocked</b>(<i>url</i>)
 <p>
-        Private method to check, if AdBlock can be performed on the scheme.
+        Private method to check, if the given URL could be blocked (i.e. is
+        not whitelisted).
 </p><dl>
-<dt><i>scheme</i></dt>
+<dt><i>url</i> (QUrl)</dt>
 <dd>
-scheme to check (string)
+URL to be checked
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating, that AdBlock can be performed (boolean)
+flag indicating that the given URL can be blocked
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="AdBlockManager.__customSubscriptionLocation" ID="AdBlockManager.__customSubscriptionLocation"></a>
 <h4>AdBlockManager.__customSubscriptionLocation</h4>
@@ -207,7 +223,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-URL for custom subscriptions (QUrl)
+URL for custom subscriptions
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QUrl
 </dd>
 </dl><a NAME="AdBlockManager.__customSubscriptionUrl" ID="AdBlockManager.__customSubscriptionUrl"></a>
 <h4>AdBlockManager.__customSubscriptionUrl</h4>
@@ -217,7 +238,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-URL for custom subscriptions (QUrl)
+URL for custom subscriptions
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+QUrl
 </dd>
 </dl><a NAME="AdBlockManager.__loadSubscriptions" ID="AdBlockManager.__loadSubscriptions"></a>
 <h4>AdBlockManager.__loadSubscriptions</h4>
@@ -229,15 +255,20 @@
 <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></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-to be excepted (string)
+to be excepted
 </dd>
 </dl><a NAME="AdBlockManager.addSubscription" ID="AdBlockManager.addSubscription"></a>
 <h4>AdBlockManager.addSubscription</h4>
@@ -245,10 +276,9 @@
 <p>
         Public method to add an AdBlock subscription.
 </p><dl>
-<dt><i>subscription</i></dt>
+<dt><i>subscription</i> (AdBlockSubscription)</dt>
 <dd>
 AdBlock subscription to be added
-            (AdBlockSubscription)
 </dd>
 </dl><a NAME="AdBlockManager.addSubscriptionFromUrl" ID="AdBlockManager.addSubscriptionFromUrl"></a>
 <h4>AdBlockManager.addSubscriptionFromUrl</h4>
@@ -278,7 +308,7 @@
 </p><dl>
 <dt><i>info</i> (QWebEngineUrlRequestInfo)</dt>
 <dd>
-request info aobject
+request info object
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
@@ -290,6 +320,26 @@
 <dd>
 bool
 </dd>
+</dl><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>
+<dd>
+scheme to check
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating, that AdBlock can be performed
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
 </dl><a NAME="AdBlockManager.close" ID="AdBlockManager.close"></a>
 <h4>AdBlockManager.close</h4>
 <b>close</b>(<i></i>)
@@ -303,7 +353,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-subscription object for custom rules (AdBlockSubscription)
+subscription object for custom rules
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+AdBlockSubscription
 </dd>
 </dl><a NAME="AdBlockManager.elementHidingRules" ID="AdBlockManager.elementHidingRules"></a>
 <h4>AdBlockManager.elementHidingRules</h4>
@@ -313,14 +368,19 @@
 </p><p>
 
 </p><dl>
-<dt><i>url</i></dt>
+<dt><i>url</i> (QUrl)</dt>
 <dd>
-URL to get hiding rules for (QUrl)
+URL to get hiding rules for
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-element hiding rules (string)
+element hiding rules
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl><a NAME="AdBlockManager.elementHidingRulesForDomain" ID="AdBlockManager.elementHidingRulesForDomain"></a>
 <h4>AdBlockManager.elementHidingRulesForDomain</h4>
@@ -328,14 +388,19 @@
 <p>
         Public method to get the element hiding rules for a domain.
 </p><dl>
-<dt><i>url</i></dt>
+<dt><i>url</i> (QUrl)</dt>
 <dd>
-URL to get hiding rules for (QUrl)
+URL to get hiding rules for
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-element hiding rules (string)
+element hiding rules
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl><a NAME="AdBlockManager.exceptions" ID="AdBlockManager.exceptions"></a>
 <h4>AdBlockManager.exceptions</h4>
@@ -345,7 +410,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-list of excepted hosts (list of string)
+list of excepted hosts
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl><a NAME="AdBlockManager.getDefaultSubscriptionUrl" ID="AdBlockManager.getDefaultSubscriptionUrl"></a>
 <h4>AdBlockManager.getDefaultSubscriptionUrl</h4>
@@ -369,15 +439,19 @@
         Public method to get a list of subscriptions, that require the given
         one.
 </p><dl>
-<dt><i>subscription</i></dt>
+<dt><i>subscription</i> (AdBlockSubscription)</dt>
 <dd>
-subscription to check for (AdBlockSubscription)
+subscription to check for
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-list of subscription requiring the given one (list of
-            AdBlockSubscription)
+list of subscription requiring the given one
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of AdBlockSubscription
 </dd>
 </dl><a NAME="AdBlockManager.isEnabled" ID="AdBlockManager.isEnabled"></a>
 <h4>AdBlockManager.isEnabled</h4>
@@ -387,7 +461,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating the enabled state (boolean)
+flag indicating the enabled state
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="AdBlockManager.isHostExcepted" ID="AdBlockManager.isHostExcepted"></a>
 <h4>AdBlockManager.isHostExcepted</h4>
@@ -395,14 +474,19 @@
 <p>
         Public slot to check, if a host is excepted.
 </p><dl>
-<dt><i>host</i></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-host to check (string)
+host to check
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-flag indicating an exception (boolean)
+flag indicating an exception
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl><a NAME="AdBlockManager.load" ID="AdBlockManager.load"></a>
 <h4>AdBlockManager.load</h4>
@@ -415,12 +499,12 @@
 <p>
         Public method to load a subscription required by another one.
 </p><dl>
-<dt><i>location</i></dt>
+<dt><i>location</i> (str)</dt>
 <dd>
-location of the required subscription (string)
-</dd><dt><i>title</i></dt>
+location of the required subscription
+</dd><dt><i>title</i> (str)</dt>
 <dd>
-title of the required subscription (string)
+title of the required subscription
 </dd>
 </dl><a NAME="AdBlockManager.page" ID="AdBlockManager.page"></a>
 <h4>AdBlockManager.page</h4>
@@ -430,7 +514,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-reference to the page block object (AdBlockPage)
+reference to the page block object
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+AdBlockPage
 </dd>
 </dl><a NAME="AdBlockManager.removeException" ID="AdBlockManager.removeException"></a>
 <h4>AdBlockManager.removeException</h4>
@@ -438,9 +527,9 @@
 <p>
         Public method to remove an exception.
 </p><dl>
-<dt><i>host</i></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-to be removed from the list of exceptions (string)
+to be removed from the list of exceptions
 </dd>
 </dl><a NAME="AdBlockManager.removeSubscription" ID="AdBlockManager.removeSubscription"></a>
 <h4>AdBlockManager.removeSubscription</h4>
@@ -448,13 +537,12 @@
 <p>
         Public method to remove an AdBlock subscription.
 </p><dl>
-<dt><i>subscription</i></dt>
+<dt><i>subscription</i> (AdBlockSubscription)</dt>
 <dd>
 AdBlock subscription to be removed
-            (AdBlockSubscription)
-</dd><dt><i>emitSignal</i></dt>
+</dd><dt><i>emitSignal</i> (bool)</dt>
 <dd>
-flag indicating to send a signal (boolean)
+flag indicating to send a signal
 </dd>
 </dl><a NAME="AdBlockManager.save" ID="AdBlockManager.save"></a>
 <h4>AdBlockManager.save</h4>
@@ -467,9 +555,9 @@
 <p>
         Public slot to set the enabled state.
 </p><dl>
-<dt><i>enabled</i></dt>
+<dt><i>enabled</i> (bool)</dt>
 <dd>
-flag indicating the enabled state (boolean)
+flag indicating the enabled state
 </dd>
 </dl><a NAME="AdBlockManager.setExceptions" ID="AdBlockManager.setExceptions"></a>
 <h4>AdBlockManager.setExceptions</h4>
@@ -477,9 +565,9 @@
 <p>
         Public method to set the list of excepted hosts.
 </p><dl>
-<dt><i>hosts</i></dt>
+<dt><i>hosts</i> (list of str)</dt>
 <dd>
-list of excepted hosts (list of string)
+list of excepted hosts
 </dd>
 </dl><a NAME="AdBlockManager.setUseLimitedEasyList" ID="AdBlockManager.setUseLimitedEasyList"></a>
 <h4>AdBlockManager.setUseLimitedEasyList</h4>
@@ -499,7 +587,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-reference to the dialog (AdBlockDialog)
+reference to the dialog
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+AdBlockDialog
 </dd>
 </dl><a NAME="AdBlockManager.showExceptionsDialog" ID="AdBlockManager.showExceptionsDialog"></a>
 <h4>AdBlockManager.showExceptionsDialog</h4>
@@ -509,7 +602,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-reference to the exceptions dialog (AdBlockExceptionsDialog)
+reference to the exceptions dialog
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+AdBlockExceptionsDialog
 </dd>
 </dl><a NAME="AdBlockManager.subscription" ID="AdBlockManager.subscription"></a>
 <h4>AdBlockManager.subscription</h4>
@@ -517,14 +615,19 @@
 <p>
         Public method to get a subscription based on its location.
 </p><dl>
-<dt><i>location</i></dt>
+<dt><i>location</i> (str)</dt>
 <dd>
-location of the subscription to search for (string)
+location of the subscription to search for
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-subscription or None (AdBlockSubscription)
+subscription or None
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+AdBlockSubscription
 </dd>
 </dl><a NAME="AdBlockManager.subscriptions" ID="AdBlockManager.subscriptions"></a>
 <h4>AdBlockManager.subscriptions</h4>
@@ -534,7 +637,12 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-list of subscriptions (list of AdBlockSubscription)
+list of subscriptions
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of AdBlockSubscription
 </dd>
 </dl><a NAME="AdBlockManager.updateAllSubscriptions" ID="AdBlockManager.updateAllSubscriptions"></a>
 <h4>AdBlockManager.updateAllSubscriptions</h4>

Mercurial Repository: eric

eric ide

mercurial