Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.Tools.WebIconProvider.html
eric6/Documentation/Source/eric6.WebBrowser.Tools.WebIconProvider.html
- changeset 6942
- 2602857055c5
- parent 5727
- c8842a8d1167
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.WebBrowser.Tools.WebIconProvider</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.Tools.WebIconProvider</h1> | |
| 23 <p> | |
| 24 Module containing a web site icon storage object. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>_WebIconProvider</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#WebIconProvider">WebIconProvider</a></td> | |
| 34 <td>Class implementing a web site icon storage.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr> | |
| 40 <td><a href="#instance">instance</a></td> | |
| 41 <td>Global function to get a reference to the web icon provider and create it, if it hasn't been yet.</td> | |
| 42 </tr> | |
| 43 </table> | |
| 44 <hr /><hr /> | |
| 45 <a NAME="WebIconProvider" ID="WebIconProvider"></a> | |
| 46 <h2>WebIconProvider</h2> | |
| 47 <p> | |
| 48 Class implementing a web site icon storage. | |
| 49 </p><h3>Signals</h3> | |
| 50 <dl> | |
| 51 <dt>changed()</dt> | |
| 52 <dd> | |
| 53 emitted to indicate a change of the icons database | |
| 54 </dd> | |
| 55 </dl> | |
| 56 <h3>Derived from</h3> | |
| 57 QObject | |
| 58 <h3>Class Attributes</h3> | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Methods</h3> | |
| 67 <table> | |
| 68 <tr> | |
| 69 <td><a href="#WebIconProvider.__init__">WebIconProvider</a></td> | |
| 70 <td>Constructor</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#WebIconProvider.__urlToString">__urlToString</a></td> | |
| 73 <td>Private method to convert an URL to a string.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#WebIconProvider.clear">clear</a></td> | |
| 76 <td>Public method to clear the icons cache.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#WebIconProvider.close">close</a></td> | |
| 79 <td>Public method to close the web icon provider.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#WebIconProvider.iconDatabasePath">iconDatabasePath</a></td> | |
| 82 <td>Public method o get the path for the web site icons store.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#WebIconProvider.iconForUrl">iconForUrl</a></td> | |
| 85 <td>Public method to get an icon for an URL.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#WebIconProvider.load">load</a></td> | |
| 88 <td>Public method to load the bookmarks.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#WebIconProvider.save">save</a></td> | |
| 91 <td>Public method to save the zoom values.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#WebIconProvider.saveIcon">saveIcon</a></td> | |
| 94 <td>Public method to save a web site icon.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#WebIconProvider.setIconDatabasePath">setIconDatabasePath</a></td> | |
| 97 <td>Public method to set the path for the web site icons store.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#WebIconProvider.showWebIconDialog">showWebIconDialog</a></td> | |
| 100 <td>Public method to show a dialog to manage the Favicons.</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 <h3>Static Methods</h3> | |
| 104 <table> | |
| 105 <tr><td>None</td></tr> | |
| 106 </table> | |
| 107 <a NAME="WebIconProvider.__init__" ID="WebIconProvider.__init__"></a> | |
| 108 <h4>WebIconProvider (Constructor)</h4> | |
| 109 <b>WebIconProvider</b>(<i>parent=None</i>) | |
| 110 <p> | |
| 111 Constructor | |
| 112 </p><dl> | |
| 113 <dt><i>parent</i></dt> | |
| 114 <dd> | |
| 115 reference to the parent object (QObject) | |
| 116 </dd> | |
| 117 </dl><a NAME="WebIconProvider.__urlToString" ID="WebIconProvider.__urlToString"></a> | |
| 118 <h4>WebIconProvider.__urlToString</h4> | |
| 119 <b>__urlToString</b>(<i>url</i>) | |
| 120 <p> | |
| 121 Private method to convert an URL to a string. | |
| 122 </p><dl> | |
| 123 <dt><i>url</i> (QUrl)</dt> | |
| 124 <dd> | |
| 125 URL to be converted | |
| 126 </dd> | |
| 127 </dl><dl> | |
| 128 <dt>Returns:</dt> | |
| 129 <dd> | |
| 130 string representation of the URL | |
| 131 </dd> | |
| 132 </dl><dl> | |
| 133 <dt>Return Type:</dt> | |
| 134 <dd> | |
| 135 str | |
| 136 </dd> | |
| 137 </dl><a NAME="WebIconProvider.clear" ID="WebIconProvider.clear"></a> | |
| 138 <h4>WebIconProvider.clear</h4> | |
| 139 <b>clear</b>(<i></i>) | |
| 140 <p> | |
| 141 Public method to clear the icons cache. | |
| 142 </p><a NAME="WebIconProvider.close" ID="WebIconProvider.close"></a> | |
| 143 <h4>WebIconProvider.close</h4> | |
| 144 <b>close</b>(<i></i>) | |
| 145 <p> | |
| 146 Public method to close the web icon provider. | |
| 147 </p><a NAME="WebIconProvider.iconDatabasePath" ID="WebIconProvider.iconDatabasePath"></a> | |
| 148 <h4>WebIconProvider.iconDatabasePath</h4> | |
| 149 <b>iconDatabasePath</b>(<i></i>) | |
| 150 <p> | |
| 151 Public method o get the path for the web site icons store. | |
| 152 </p><dl> | |
| 153 <dt>Returns:</dt> | |
| 154 <dd> | |
| 155 path to store the icons file to | |
| 156 </dd> | |
| 157 </dl><dl> | |
| 158 <dt>Return Type:</dt> | |
| 159 <dd> | |
| 160 str | |
| 161 </dd> | |
| 162 </dl><a NAME="WebIconProvider.iconForUrl" ID="WebIconProvider.iconForUrl"></a> | |
| 163 <h4>WebIconProvider.iconForUrl</h4> | |
| 164 <b>iconForUrl</b>(<i>url</i>) | |
| 165 <p> | |
| 166 Public method to get an icon for an URL. | |
| 167 </p><dl> | |
| 168 <dt><i>url</i> (QUrl)</dt> | |
| 169 <dd> | |
| 170 URL to get icon for | |
| 171 </dd> | |
| 172 </dl><dl> | |
| 173 <dt>Returns:</dt> | |
| 174 <dd> | |
| 175 icon for the URL | |
| 176 </dd> | |
| 177 </dl><dl> | |
| 178 <dt>Return Type:</dt> | |
| 179 <dd> | |
| 180 QIcon | |
| 181 </dd> | |
| 182 </dl><a NAME="WebIconProvider.load" ID="WebIconProvider.load"></a> | |
| 183 <h4>WebIconProvider.load</h4> | |
| 184 <b>load</b>(<i></i>) | |
| 185 <p> | |
| 186 Public method to load the bookmarks. | |
| 187 </p><a NAME="WebIconProvider.save" ID="WebIconProvider.save"></a> | |
| 188 <h4>WebIconProvider.save</h4> | |
| 189 <b>save</b>(<i></i>) | |
| 190 <p> | |
| 191 Public method to save the zoom values. | |
| 192 </p><a NAME="WebIconProvider.saveIcon" ID="WebIconProvider.saveIcon"></a> | |
| 193 <h4>WebIconProvider.saveIcon</h4> | |
| 194 <b>saveIcon</b>(<i>view</i>) | |
| 195 <p> | |
| 196 Public method to save a web site icon. | |
| 197 </p><dl> | |
| 198 <dt><i>view</i> (WebBrowserView)</dt> | |
| 199 <dd> | |
| 200 reference to the view object | |
| 201 </dd> | |
| 202 </dl><a NAME="WebIconProvider.setIconDatabasePath" ID="WebIconProvider.setIconDatabasePath"></a> | |
| 203 <h4>WebIconProvider.setIconDatabasePath</h4> | |
| 204 <b>setIconDatabasePath</b>(<i>path</i>) | |
| 205 <p> | |
| 206 Public method to set the path for the web site icons store. | |
| 207 </p><dl> | |
| 208 <dt><i>path</i> (str)</dt> | |
| 209 <dd> | |
| 210 path to store the icons file to | |
| 211 </dd> | |
| 212 </dl><a NAME="WebIconProvider.showWebIconDialog" ID="WebIconProvider.showWebIconDialog"></a> | |
| 213 <h4>WebIconProvider.showWebIconDialog</h4> | |
| 214 <b>showWebIconDialog</b>(<i></i>) | |
| 215 <p> | |
| 216 Public method to show a dialog to manage the Favicons. | |
| 217 </p> | |
| 218 <div align="right"><a href="#top">Up</a></div> | |
| 219 <hr /><hr /> | |
| 220 <a NAME="instance" ID="instance"></a> | |
| 221 <h2>instance</h2> | |
| 222 <b>instance</b>(<i></i>) | |
| 223 <p> | |
| 224 Global function to get a reference to the web icon provider and create it, | |
| 225 if it hasn't been yet. | |
| 226 </p><dl> | |
| 227 <dt>Returns:</dt> | |
| 228 <dd> | |
| 229 reference to the web icon provider object | |
| 230 </dd> | |
| 231 </dl><dl> | |
| 232 <dt>Return Type:</dt> | |
| 233 <dd> | |
| 234 WebIconProvider | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <div align="right"><a href="#top">Up</a></div> | |
| 238 <hr /> | |
| 239 </body></html> |
