--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.WebBrowser.StatusBar.StatusBarIcon.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,194 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.WebBrowser.StatusBar.StatusBarIcon</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.WebBrowser.StatusBar.StatusBarIcon</h1> + +<p> +Module implementing the status bar icon base class. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#StatusBarIcon">StatusBarIcon</a></td> +<td>Class implementing common methods for all status bar icons.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="StatusBarIcon" ID="StatusBarIcon"></a> +<h2>StatusBarIcon</h2> + +<p> + Class implementing common methods for all status bar icons. +</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="#StatusBarIcon.__init__">StatusBarIcon</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#StatusBarIcon._currentPage">_currentPage</a></td> +<td>Protected method to get a reference to the current page.</td> +</tr> +<tr> +<td><a href="#StatusBarIcon._currentPageSettings">_currentPageSettings</a></td> +<td>Protected method to get a reference to the web settings of the current page.</td> +</tr> +<tr> +<td><a href="#StatusBarIcon._setCurrentPageWebAttribute">_setCurrentPageWebAttribute</a></td> +<td>Protected method to set a web attribute on the current page.</td> +</tr> +<tr> +<td><a href="#StatusBarIcon._testCurrentPageWebAttribute">_testCurrentPageWebAttribute</a></td> +<td>Protected method to test a web attribute on the current page.</td> +</tr> +<tr> +<td><a href="#StatusBarIcon.preferencesChanged">preferencesChanged</a></td> +<td>Public method to handle changes of the settings.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="StatusBarIcon.__init__" ID="StatusBarIcon.__init__"></a> +<h4>StatusBarIcon (Constructor)</h4> +<b>StatusBarIcon</b>(<i>window</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>window</i> (WebBrowserWindow)</dt> +<dd> +reference to the web browser window +</dd> +</dl> +<a NAME="StatusBarIcon._currentPage" ID="StatusBarIcon._currentPage"></a> +<h4>StatusBarIcon._currentPage</h4> +<b>_currentPage</b>(<i></i>) + +<p> + Protected method to get a reference to the current page. +</p> +<dl> +<dt>Return:</dt> +<dd> +reference to the current page +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +WebBrowserPage +</dd> +</dl> +<a NAME="StatusBarIcon._currentPageSettings" ID="StatusBarIcon._currentPageSettings"></a> +<h4>StatusBarIcon._currentPageSettings</h4> +<b>_currentPageSettings</b>(<i></i>) + +<p> + Protected method to get a reference to the web settings of the + current page. +</p> +<dl> +<dt>Return:</dt> +<dd> +reference to the web settings object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QWebEngineSettings +</dd> +</dl> +<a NAME="StatusBarIcon._setCurrentPageWebAttribute" ID="StatusBarIcon._setCurrentPageWebAttribute"></a> +<h4>StatusBarIcon._setCurrentPageWebAttribute</h4> +<b>_setCurrentPageWebAttribute</b>(<i>attr, val</i>) + +<p> + Protected method to set a web attribute on the current page. +</p> +<dl> + +<dt><i>attr</i> (QWebEngineSettings.WebAttribute)</dt> +<dd> +attribute to sett +</dd> +<dt><i>val</i> (bool)</dt> +<dd> +value to be set +</dd> +</dl> +<a NAME="StatusBarIcon._testCurrentPageWebAttribute" ID="StatusBarIcon._testCurrentPageWebAttribute"></a> +<h4>StatusBarIcon._testCurrentPageWebAttribute</h4> +<b>_testCurrentPageWebAttribute</b>(<i>attr</i>) + +<p> + Protected method to test a web attribute on the current page. +</p> +<dl> + +<dt><i>attr</i> (QWebEngineSettings.WebAttribute)</dt> +<dd> +attribute to test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the attribute is set +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="StatusBarIcon.preferencesChanged" ID="StatusBarIcon.preferencesChanged"></a> +<h4>StatusBarIcon.preferencesChanged</h4> +<b>preferencesChanged</b>(<i></i>) + +<p> + Public method to handle changes of the settings. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file