--- a/eric6/Documentation/Source/eric6.WebBrowser.ZoomManager.ZoomManager.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.ZoomManager.ZoomManager.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,36 +18,47 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.ZoomManager.ZoomManager</h1> + <p> Module implementing a manager for site specific zoom level settings. </p> <h3>Global Attributes</h3> + <table> <tr><td>_ZoomManager</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#ZoomManager">ZoomManager</a></td> <td>Class implementing a manager for site specific zoom level settings.</td> </tr> </table> <h3>Functions</h3> + <table> + <tr> <td><a href="#instance">instance</a></td> <td>Global function to get a reference to the zoom manager and create it, if it hasn't been yet.</td> </tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="ZoomManager" ID="ZoomManager"></a> <h2>ZoomManager</h2> + <p> Class implementing a manager for site specific zoom level settings. -</p><h3>Signals</h3> +</p> +<h3>Signals</h3> <dl> + <dt>changed()</dt> <dd> emitted to indicate a change of the zoom level @@ -56,217 +67,285 @@ <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="#ZoomManager.__init__">ZoomManager</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.__keyFromUrl">__keyFromUrl</a></td> <td>Private method to generate a DB key for an URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.allSiteNames">allSiteNames</a></td> <td>Public method to get a list of all site names.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.clear">clear</a></td> <td>Public method to clear the saved zoom values.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.close">close</a></td> <td>Public method to close the zoom manager.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.load">load</a></td> <td>Public method to load the bookmarks.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.removeZoomValue">removeZoomValue</a></td> <td>Public method to remove a zoom value entry.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.save">save</a></td> <td>Public method to save the zoom values.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.setZoomValue">setZoomValue</a></td> <td>Public method to record the zoom value for the given URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.siteInfo">siteInfo</a></td> <td>Public method to get the zoom value for the site.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.sitesCount">sitesCount</a></td> <td>Public method to get the number of available sites.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ZoomManager.zoomValue">zoomValue</a></td> <td>Public method to get the zoom value for an URL.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="ZoomManager.__init__" ID="ZoomManager.__init__"></a> <h4>ZoomManager (Constructor)</h4> <b>ZoomManager</b>(<i>parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>parent</i></dt> <dd> reference to the parent object (QObject) </dd> -</dl><a NAME="ZoomManager.__keyFromUrl" ID="ZoomManager.__keyFromUrl"></a> +</dl> +<a NAME="ZoomManager.__keyFromUrl" ID="ZoomManager.__keyFromUrl"></a> <h4>ZoomManager.__keyFromUrl</h4> <b>__keyFromUrl</b>(<i>url</i>) + <p> Private method to generate a DB key for an URL. -</p><dl> +</p> +<dl> + <dt><i>url</i> (QUrl)</dt> <dd> URL to generate a key for </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> key for the given URL </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="ZoomManager.allSiteNames" ID="ZoomManager.allSiteNames"></a> +</dl> +<a NAME="ZoomManager.allSiteNames" ID="ZoomManager.allSiteNames"></a> <h4>ZoomManager.allSiteNames</h4> <b>allSiteNames</b>(<i></i>) + <p> Public method to get a list of all site names. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> sorted list of all site names </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> list of str </dd> -</dl><a NAME="ZoomManager.clear" ID="ZoomManager.clear"></a> +</dl> +<a NAME="ZoomManager.clear" ID="ZoomManager.clear"></a> <h4>ZoomManager.clear</h4> <b>clear</b>(<i></i>) + <p> Public method to clear the saved zoom values. -</p><a NAME="ZoomManager.close" ID="ZoomManager.close"></a> +</p> +<a NAME="ZoomManager.close" ID="ZoomManager.close"></a> <h4>ZoomManager.close</h4> <b>close</b>(<i></i>) + <p> Public method to close the zoom manager. -</p><a NAME="ZoomManager.load" ID="ZoomManager.load"></a> +</p> +<a NAME="ZoomManager.load" ID="ZoomManager.load"></a> <h4>ZoomManager.load</h4> <b>load</b>(<i></i>) + <p> Public method to load the bookmarks. -</p><a NAME="ZoomManager.removeZoomValue" ID="ZoomManager.removeZoomValue"></a> +</p> +<a NAME="ZoomManager.removeZoomValue" ID="ZoomManager.removeZoomValue"></a> <h4>ZoomManager.removeZoomValue</h4> <b>removeZoomValue</b>(<i>site</i>) + <p> Public method to remove a zoom value entry. -</p><dl> +</p> +<dl> + <dt><i>site</i> (str)</dt> <dd> web site name </dd> -</dl><a NAME="ZoomManager.save" ID="ZoomManager.save"></a> +</dl> +<a NAME="ZoomManager.save" ID="ZoomManager.save"></a> <h4>ZoomManager.save</h4> <b>save</b>(<i></i>) + <p> Public method to save the zoom values. -</p><a NAME="ZoomManager.setZoomValue" ID="ZoomManager.setZoomValue"></a> +</p> +<a NAME="ZoomManager.setZoomValue" ID="ZoomManager.setZoomValue"></a> <h4>ZoomManager.setZoomValue</h4> <b>setZoomValue</b>(<i>url, zoomValue</i>) + <p> Public method to record the zoom value for the given URL. -</p><p> +</p> +<p> Note: Only zoom values not equal 100% are recorded. -</p><dl> +</p> +<dl> + <dt><i>url</i> (QUrl)</dt> <dd> URL of the page to remember the zoom value for -</dd><dt><i>zoomValue</i> (int)</dt> +</dd> +<dt><i>zoomValue</i> (int)</dt> <dd> zoom value for the URL </dd> -</dl><a NAME="ZoomManager.siteInfo" ID="ZoomManager.siteInfo"></a> +</dl> +<a NAME="ZoomManager.siteInfo" ID="ZoomManager.siteInfo"></a> <h4>ZoomManager.siteInfo</h4> <b>siteInfo</b>(<i>site</i>) + <p> Public method to get the zoom value for the site. -</p><dl> +</p> +<dl> + <dt><i>site</i> (str)</dt> <dd> web site name </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> zoom value for the site </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> int </dd> -</dl><a NAME="ZoomManager.sitesCount" ID="ZoomManager.sitesCount"></a> +</dl> +<a NAME="ZoomManager.sitesCount" ID="ZoomManager.sitesCount"></a> <h4>ZoomManager.sitesCount</h4> <b>sitesCount</b>(<i></i>) + <p> Public method to get the number of available sites. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> number of sites </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> int </dd> -</dl><a NAME="ZoomManager.zoomValue" ID="ZoomManager.zoomValue"></a> +</dl> +<a NAME="ZoomManager.zoomValue" ID="ZoomManager.zoomValue"></a> <h4>ZoomManager.zoomValue</h4> <b>zoomValue</b>(<i>url</i>) + <p> Public method to get the zoom value for an URL. -</p><dl> +</p> +<dl> + <dt><i>url</i> (QUrl)</dt> <dd> URL of the page to get the zoom value for </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> zoomValue zoom value for the URL </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> int </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<hr /> +<hr /> <a NAME="instance" ID="instance"></a> <h2>instance</h2> <b>instance</b>(<i></i>) + <p> Global function to get a reference to the zoom manager and create it, if it hasn't been yet. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> reference to the zoom manager object </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> ZoomManager