Mercurial Repositories > eric / file diff

diff: eric7/Documentation/Source/eric7.WebBrowser.Tools.WebIconProvider.html

eric7/Documentation/Source/eric7.WebBrowser.Tools.WebIconProvider.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eric7/Documentation/Source/eric7.WebBrowser.Tools.WebIconProvider.html	Mon May 24 11:19:57 2021 +0200
@@ -0,0 +1,307 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.WebBrowser.Tools.WebIconProvider</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.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 />
+<a NAME="WebIconProvider" ID="WebIconProvider"></a>
+<h2>WebIconProvider</h2>
+
+<p>
+    Class implementing a web site icon storage.
+</p>
+<h3>Signals</h3>
+<dl>
+
+<dt>changed()</dt>
+<dd>
+emitted to indicate a change of the icons database
+</dd>
+</dl>
+<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>
+<td><a href="#WebIconProvider.__urlToString">__urlToString</a></td>
+<td>Private method to convert an URL to a string.</td>
+</tr>
+<tr>
+<td><a href="#WebIconProvider.clear">clear</a></td>
+<td>Public method to clear the icons cache.</td>
+</tr>
+<tr>
+<td><a href="#WebIconProvider.close">close</a></td>
+<td>Public method to close the web icon provider.</td>
+</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>
+<td><a href="#WebIconProvider.iconForUrl">iconForUrl</a></td>
+<td>Public method to get an icon for an URL.</td>
+</tr>
+<tr>
+<td><a href="#WebIconProvider.load">load</a></td>
+<td>Public method to load the web site icons.</td>
+</tr>
+<tr>
+<td><a href="#WebIconProvider.save">save</a></td>
+<td>Public method to save the web site icons.</td>
+</tr>
+<tr>
+<td><a href="#WebIconProvider.saveIcon">saveIcon</a></td>
+<td>Public method to save a web site icon.</td>
+</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>
+<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>
+
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent object (QObject)
+</dd>
+</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>
+
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+URL to be converted
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+string representation of the URL
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</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>
+<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>
+<h4>WebIconProvider.iconDatabasePath</h4>
+<b>iconDatabasePath</b>(<i></i>)
+
+<p>
+        Public method o get the path for the web site icons store.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+path to store the icons file to
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</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>
+
+<dt><i>url</i> (QUrl)</dt>
+<dd>
+URL to get icon for
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+icon for the URL
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QIcon
+</dd>
+</dl>
+<a NAME="WebIconProvider.load" ID="WebIconProvider.load"></a>
+<h4>WebIconProvider.load</h4>
+<b>load</b>(<i></i>)
+
+<p>
+        Public method to load the web site icons.
+</p>
+<a NAME="WebIconProvider.save" ID="WebIconProvider.save"></a>
+<h4>WebIconProvider.save</h4>
+<b>save</b>(<i></i>)
+
+<p>
+        Public method to save the web site icons.
+</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>
+
+<dt><i>view</i> (WebBrowserView)</dt>
+<dd>
+reference to the view object
+</dd>
+</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>
+
+<dt><i>path</i> (str)</dt>
+<dd>
+path to store the icons file to
+</dd>
+</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 />
+<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>
+<dt>Return:</dt>
+<dd>
+reference to the web icon provider object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+WebIconProvider
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

Mercurial Repository: eric

eric ide

mercurial