--- a/eric6/Documentation/Source/eric6.WebBrowser.Tools.WebIconProvider.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.Tools.WebIconProvider.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.Tools.WebIconProvider</h1> + <p> Module containing a web site icon storage object. </p> <h3>Global Attributes</h3> + <table> <tr><td>_WebIconProvider</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#WebIconProvider">WebIconProvider</a></td> <td>Class implementing a web site icon storage.</td> </tr> </table> <h3>Functions</h3> + <table> + <tr> <td><a href="#instance">instance</a></td> <td>Global function to get a reference to the web icon provider and create it, if it hasn't been yet.</td> </tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="WebIconProvider" ID="WebIconProvider"></a> <h2>WebIconProvider</h2> + <p> Class implementing a web site icon storage. -</p><h3>Signals</h3> +</p> +<h3>Signals</h3> <dl> + <dt>changed()</dt> <dd> emitted to indicate a change of the icons database @@ -56,179 +67,236 @@ <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="#WebIconProvider.__init__">WebIconProvider</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.__urlToString">__urlToString</a></td> <td>Private method to convert an URL to a string.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.clear">clear</a></td> <td>Public method to clear the icons cache.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.close">close</a></td> <td>Public method to close the web icon provider.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.iconDatabasePath">iconDatabasePath</a></td> <td>Public method o get the path for the web site icons store.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.iconForUrl">iconForUrl</a></td> <td>Public method to get an icon for an URL.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.load">load</a></td> <td>Public method to load the bookmarks.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.save">save</a></td> <td>Public method to save the zoom values.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.saveIcon">saveIcon</a></td> <td>Public method to save a web site icon.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.setIconDatabasePath">setIconDatabasePath</a></td> <td>Public method to set the path for the web site icons store.</td> -</tr><tr> +</tr> +<tr> <td><a href="#WebIconProvider.showWebIconDialog">showWebIconDialog</a></td> <td>Public method to show a dialog to manage the Favicons.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="WebIconProvider.__init__" ID="WebIconProvider.__init__"></a> <h4>WebIconProvider (Constructor)</h4> <b>WebIconProvider</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="WebIconProvider.__urlToString" ID="WebIconProvider.__urlToString"></a> +</dl> +<a NAME="WebIconProvider.__urlToString" ID="WebIconProvider.__urlToString"></a> <h4>WebIconProvider.__urlToString</h4> <b>__urlToString</b>(<i>url</i>) + <p> Private method to convert an URL to a string. -</p><dl> +</p> +<dl> + <dt><i>url</i> (QUrl)</dt> <dd> URL to be converted </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> string representation of the URL </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="WebIconProvider.clear" ID="WebIconProvider.clear"></a> +</dl> +<a NAME="WebIconProvider.clear" ID="WebIconProvider.clear"></a> <h4>WebIconProvider.clear</h4> <b>clear</b>(<i></i>) + <p> Public method to clear the icons cache. -</p><a NAME="WebIconProvider.close" ID="WebIconProvider.close"></a> +</p> +<a NAME="WebIconProvider.close" ID="WebIconProvider.close"></a> <h4>WebIconProvider.close</h4> <b>close</b>(<i></i>) + <p> Public method to close the web icon provider. -</p><a NAME="WebIconProvider.iconDatabasePath" ID="WebIconProvider.iconDatabasePath"></a> +</p> +<a NAME="WebIconProvider.iconDatabasePath" ID="WebIconProvider.iconDatabasePath"></a> <h4>WebIconProvider.iconDatabasePath</h4> <b>iconDatabasePath</b>(<i></i>) + <p> Public method o get the path for the web site icons store. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> path to store the icons file to </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> str </dd> -</dl><a NAME="WebIconProvider.iconForUrl" ID="WebIconProvider.iconForUrl"></a> +</dl> +<a NAME="WebIconProvider.iconForUrl" ID="WebIconProvider.iconForUrl"></a> <h4>WebIconProvider.iconForUrl</h4> <b>iconForUrl</b>(<i>url</i>) + <p> Public method to get an icon for an URL. -</p><dl> +</p> +<dl> + <dt><i>url</i> (QUrl)</dt> <dd> URL to get icon for </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> icon for the URL </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> QIcon </dd> -</dl><a NAME="WebIconProvider.load" ID="WebIconProvider.load"></a> +</dl> +<a NAME="WebIconProvider.load" ID="WebIconProvider.load"></a> <h4>WebIconProvider.load</h4> <b>load</b>(<i></i>) + <p> Public method to load the bookmarks. -</p><a NAME="WebIconProvider.save" ID="WebIconProvider.save"></a> +</p> +<a NAME="WebIconProvider.save" ID="WebIconProvider.save"></a> <h4>WebIconProvider.save</h4> <b>save</b>(<i></i>) + <p> Public method to save the zoom values. -</p><a NAME="WebIconProvider.saveIcon" ID="WebIconProvider.saveIcon"></a> +</p> +<a NAME="WebIconProvider.saveIcon" ID="WebIconProvider.saveIcon"></a> <h4>WebIconProvider.saveIcon</h4> <b>saveIcon</b>(<i>view</i>) + <p> Public method to save a web site icon. -</p><dl> +</p> +<dl> + <dt><i>view</i> (WebBrowserView)</dt> <dd> reference to the view object </dd> -</dl><a NAME="WebIconProvider.setIconDatabasePath" ID="WebIconProvider.setIconDatabasePath"></a> +</dl> +<a NAME="WebIconProvider.setIconDatabasePath" ID="WebIconProvider.setIconDatabasePath"></a> <h4>WebIconProvider.setIconDatabasePath</h4> <b>setIconDatabasePath</b>(<i>path</i>) + <p> Public method to set the path for the web site icons store. -</p><dl> +</p> +<dl> + <dt><i>path</i> (str)</dt> <dd> path to store the icons file to </dd> -</dl><a NAME="WebIconProvider.showWebIconDialog" ID="WebIconProvider.showWebIconDialog"></a> +</dl> +<a NAME="WebIconProvider.showWebIconDialog" ID="WebIconProvider.showWebIconDialog"></a> <h4>WebIconProvider.showWebIconDialog</h4> <b>showWebIconDialog</b>(<i></i>) + <p> Public method to show a dialog to manage the Favicons. </p> <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 web icon provider and create it, if it hasn't been yet. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> reference to the web icon provider object </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> WebIconProvider