diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockMatcher.html --- a/eric6/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockMatcher.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockMatcher.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,194 +18,252 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.AdBlock.AdBlockMatcher</h1> + <p> Module implementing the AdBlock matcher. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#AdBlockMatcher">AdBlockMatcher</a></td> <td>Class implementing the AdBlock matcher.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="AdBlockMatcher" ID="AdBlockMatcher"></a> <h2>AdBlockMatcher</h2> + <p> Class implementing the AdBlock matcher. </p> <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="#AdBlockMatcher.__init__">AdBlockMatcher</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockMatcher.adBlockDisabledForUrl">adBlockDisabledForUrl</a></td> <td>Public method to check, if AdBlock is disabled for the given URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockMatcher.clear">clear</a></td> <td>Public slot to clear the internal structures.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockMatcher.elemHideDisabledForUrl">elemHideDisabledForUrl</a></td> <td>Public method to check, if element hiding is disabled for the given URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockMatcher.elementHidingRules">elementHidingRules</a></td> <td>Public method to get the element hiding rules.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockMatcher.elementHidingRulesForDomain">elementHidingRulesForDomain</a></td> <td>Public method to get the element hiding rules for the given domain.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockMatcher.match">match</a></td> <td>Public method to match a request.</td> -</tr><tr> +</tr> +<tr> <td><a href="#AdBlockMatcher.update">update</a></td> <td>Public slot to update the internal state.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="AdBlockMatcher.__init__" ID="AdBlockMatcher.__init__"></a> <h4>AdBlockMatcher (Constructor)</h4> <b>AdBlockMatcher</b>(<i>manager</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>manager</i> (AdBlockManager)</dt> <dd> reference to the AdBlock manager object </dd> -</dl><a NAME="AdBlockMatcher.adBlockDisabledForUrl" ID="AdBlockMatcher.adBlockDisabledForUrl"></a> +</dl> +<a NAME="AdBlockMatcher.adBlockDisabledForUrl" ID="AdBlockMatcher.adBlockDisabledForUrl"></a> <h4>AdBlockMatcher.adBlockDisabledForUrl</h4> <b>adBlockDisabledForUrl</b>(<i>url</i>) + <p> Public method to check, if AdBlock is disabled for the given URL. -</p><dl> +</p> +<dl> + <dt><i>url</i> (QUrl)</dt> <dd> URL to check </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating disabled state </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="AdBlockMatcher.clear" ID="AdBlockMatcher.clear"></a> +</dl> +<a NAME="AdBlockMatcher.clear" ID="AdBlockMatcher.clear"></a> <h4>AdBlockMatcher.clear</h4> <b>clear</b>(<i></i>) + <p> Public slot to clear the internal structures. -</p><a NAME="AdBlockMatcher.elemHideDisabledForUrl" ID="AdBlockMatcher.elemHideDisabledForUrl"></a> +</p> +<a NAME="AdBlockMatcher.elemHideDisabledForUrl" ID="AdBlockMatcher.elemHideDisabledForUrl"></a> <h4>AdBlockMatcher.elemHideDisabledForUrl</h4> <b>elemHideDisabledForUrl</b>(<i>url</i>) + <p> Public method to check, if element hiding is disabled for the given URL. -</p><dl> +</p> +<dl> + <dt><i>url</i> (QUrl)</dt> <dd> URL to check </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating disabled state </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="AdBlockMatcher.elementHidingRules" ID="AdBlockMatcher.elementHidingRules"></a> +</dl> +<a NAME="AdBlockMatcher.elementHidingRules" ID="AdBlockMatcher.elementHidingRules"></a> <h4>AdBlockMatcher.elementHidingRules</h4> <b>elementHidingRules</b>(<i></i>) + <p> Public method to get the element hiding rules. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> element hiding rules </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="AdBlockMatcher.elementHidingRulesForDomain" ID="AdBlockMatcher.elementHidingRulesForDomain"></a> +</dl> +<a NAME="AdBlockMatcher.elementHidingRulesForDomain" ID="AdBlockMatcher.elementHidingRulesForDomain"></a> <h4>AdBlockMatcher.elementHidingRulesForDomain</h4> <b>elementHidingRulesForDomain</b>(<i>domain</i>) + <p> Public method to get the element hiding rules for the given domain. -</p><dl> +</p> +<dl> + <dt><i>domain</i> (str)</dt> <dd> domain name </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> element hiding rules </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="AdBlockMatcher.match" ID="AdBlockMatcher.match"></a> +</dl> +<a NAME="AdBlockMatcher.match" ID="AdBlockMatcher.match"></a> <h4>AdBlockMatcher.match</h4> <b>match</b>(<i>request, urlDomain, urlString</i>) + <p> Public method to match a request. -</p><dl> +</p> +<dl> + <dt><i>request</i> (QWebEngineUrlRequestInfo)</dt> <dd> URL request to be matched -</dd><dt><i>urlDomain</i> (str)</dt> +</dd> +<dt><i>urlDomain</i> (str)</dt> <dd> domain of the URL -</dd><dt><i>urlString</i> (str)</dt> +</dd> +<dt><i>urlString</i> (str)</dt> <dd> requested URL as a lowercase string </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the matched rule </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> AdBlockRule </dd> -</dl><a NAME="AdBlockMatcher.update" ID="AdBlockMatcher.update"></a> +</dl> +<a NAME="AdBlockMatcher.update" ID="AdBlockMatcher.update"></a> <h4>AdBlockMatcher.update</h4> <b>update</b>(<i></i>) + <p> Public slot to update the internal state. </p>