--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric6.WebBrowser.AdBlock.AdBlockMatcher.html Mon Dec 18 18:09:39 2017 +0100
@@ -0,0 +1,214 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric6.WebBrowser.AdBlock.AdBlockMatcher</title>
+<meta charset="UTF-8">
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<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 />
+<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>
+<td><a href="#AdBlockMatcher.adBlockDisabledForUrl">adBlockDisabledForUrl</a></td>
+<td>Public method to check, if AdBlock is disabled for the given URL.</td>
+</tr><tr>
+<td><a href="#AdBlockMatcher.clear">clear</a></td>
+<td>Public slot to clear the internal structures.</td>
+</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>
+<td><a href="#AdBlockMatcher.elementHidingRules">elementHidingRules</a></td>
+<td>Public method to get the element hiding rules.</td>
+</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>
+<td><a href="#AdBlockMatcher.match">match</a></td>
+<td>Public method to match a request.</td>
+</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>
+<dt><i>manager</i> (AdBlockManager)</dt>
+<dd>
+reference to the AdBlock manager object
+</dd>
+</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>
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+URL to check
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating disabled state
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</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>
+<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>
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+URL to check
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating disabled state
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</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>
+<dt>Returns:</dt>
+<dd>
+element hiding rules
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</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>
+<dt><i>domain</i> (str)</dt>
+<dd>
+domain name
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+element hiding rules
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</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>
+<dt><i>request</i> (QWebEngineUrlRequestInfo)</dt>
+<dd>
+URL request to be matched
+</dd><dt><i>urlDomain</i> (str)</dt>
+<dd>
+domain of the URL
+</dd><dt><i>urlString</i> (str)</dt>
+<dd>
+requested URL as a lowercase string
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the matched rule
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+AdBlockRule
+</dd>
+</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>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
