--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.WebBrowser.AdBlock.AdBlockIcon.html Mon May 24 11:19:57 2021 +0200 @@ -0,0 +1,262 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.WebBrowser.AdBlock.AdBlockIcon</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>eric7.WebBrowser.AdBlock.AdBlockIcon</h1> + +<p> +Module implementing the AdBlock icon for the main window status bar. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#AdBlockIcon">AdBlockIcon</a></td> +<td>Class implementing the AdBlock icon for the main window status bar.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="AdBlockIcon" ID="AdBlockIcon"></a> +<h2>AdBlockIcon</h2> + +<p> + Class implementing the AdBlock icon for the main window status bar. +</p> +<h3>Derived from</h3> +EricClickableLabel +<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="#AdBlockIcon.__init__">AdBlockIcon</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#AdBlockIcon.__aboutToShowMenu">__aboutToShowMenu</a></td> +<td>Private slot to show the context menu.</td> +</tr> +<tr> +<td><a href="#AdBlockIcon.__enableAdBlock">__enableAdBlock</a></td> +<td>Private slot to enable or disable AdBlock.</td> +</tr> +<tr> +<td><a href="#AdBlockIcon.__isCurrentHostExcepted">__isCurrentHostExcepted</a></td> +<td>Private method to check, if the host of the current browser is excepted.</td> +</tr> +<tr> +<td><a href="#AdBlockIcon.__setException">__setException</a></td> +<td>Private slot to add or remove the current host from the list of exceptions.</td> +</tr> +<tr> +<td><a href="#AdBlockIcon.__showMenu">__showMenu</a></td> +<td>Private slot to show the context menu.</td> +</tr> +<tr> +<td><a href="#AdBlockIcon.currentChanged">currentChanged</a></td> +<td>Public slot to handle a change of the current browser tab.</td> +</tr> +<tr> +<td><a href="#AdBlockIcon.menu">menu</a></td> +<td>Public method to get a reference to the menu.</td> +</tr> +<tr> +<td><a href="#AdBlockIcon.setEnabled">setEnabled</a></td> +<td>Public slot to set the enabled state.</td> +</tr> +<tr> +<td><a href="#AdBlockIcon.sourceChanged">sourceChanged</a></td> +<td>Public slot to handle URL changes.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="AdBlockIcon.__init__" ID="AdBlockIcon.__init__"></a> +<h4>AdBlockIcon (Constructor)</h4> +<b>AdBlockIcon</b>(<i>parent</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (WebBrowserWindow)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="AdBlockIcon.__aboutToShowMenu" ID="AdBlockIcon.__aboutToShowMenu"></a> +<h4>AdBlockIcon.__aboutToShowMenu</h4> +<b>__aboutToShowMenu</b>(<i></i>) + +<p> + Private slot to show the context menu. +</p> +<a NAME="AdBlockIcon.__enableAdBlock" ID="AdBlockIcon.__enableAdBlock"></a> +<h4>AdBlockIcon.__enableAdBlock</h4> +<b>__enableAdBlock</b>(<i>enable</i>) + +<p> + Private slot to enable or disable AdBlock. +</p> +<dl> + +<dt><i>enable</i> (bool)</dt> +<dd> +flag indicating the desired enable state +</dd> +</dl> +<a NAME="AdBlockIcon.__isCurrentHostExcepted" ID="AdBlockIcon.__isCurrentHostExcepted"></a> +<h4>AdBlockIcon.__isCurrentHostExcepted</h4> +<b>__isCurrentHostExcepted</b>(<i></i>) + +<p> + Private method to check, if the host of the current browser is + excepted. +</p> +<dl> +<dt>Return:</dt> +<dd> +flag indicating an exception +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="AdBlockIcon.__setException" ID="AdBlockIcon.__setException"></a> +<h4>AdBlockIcon.__setException</h4> +<b>__setException</b>(<i>enable</i>) + +<p> + Private slot to add or remove the current host from the list of + exceptions. +</p> +<dl> + +<dt><i>enable</i> (bool)</dt> +<dd> +flag indicating to set or remove an exception +</dd> +</dl> +<a NAME="AdBlockIcon.__showMenu" ID="AdBlockIcon.__showMenu"></a> +<h4>AdBlockIcon.__showMenu</h4> +<b>__showMenu</b>(<i>pos</i>) + +<p> + Private slot to show the context menu. +</p> +<dl> + +<dt><i>pos</i> (QPoint)</dt> +<dd> +position the context menu should be shown +</dd> +</dl> +<a NAME="AdBlockIcon.currentChanged" ID="AdBlockIcon.currentChanged"></a> +<h4>AdBlockIcon.currentChanged</h4> +<b>currentChanged</b>(<i></i>) + +<p> + Public slot to handle a change of the current browser tab. +</p> +<a NAME="AdBlockIcon.menu" ID="AdBlockIcon.menu"></a> +<h4>AdBlockIcon.menu</h4> +<b>menu</b>(<i></i>) + +<p> + Public method to get a reference to the menu. +</p> +<dl> +<dt>Return:</dt> +<dd> +reference to the menu +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QMenu +</dd> +</dl> +<a NAME="AdBlockIcon.setEnabled" ID="AdBlockIcon.setEnabled"></a> +<h4>AdBlockIcon.setEnabled</h4> +<b>setEnabled</b>(<i>enabled</i>) + +<p> + Public slot to set the enabled state. +</p> +<dl> + +<dt><i>enabled</i> (bool)</dt> +<dd> +enabled state +</dd> +</dl> +<a NAME="AdBlockIcon.sourceChanged" ID="AdBlockIcon.sourceChanged"></a> +<h4>AdBlockIcon.sourceChanged</h4> +<b>sourceChanged</b>(<i>browser, url</i>) + +<p> + Public slot to handle URL changes. +</p> +<dl> + +<dt><i>browser</i> (WebBrowserView)</dt> +<dd> +reference to the browser +</dd> +<dt><i>url</i> (QUrl)</dt> +<dd> +new URL +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file