Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Tools.WebIconProvider.html
src/eric7/Documentation/Source/eric7.WebBrowser.Tools.WebIconProvider.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9503
- ae9232bf4854
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.WebBrowser.Tools.WebIconProvider</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.WebBrowser.Tools.WebIconProvider</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module containing a web site icon storage object. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>_WebIconProvider</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#WebIconProvider">WebIconProvider</a></td> | |
| 25 <td>Class implementing a web site icon storage.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#instance">instance</a></td> | |
| 34 <td>Global function to get a reference to the web icon provider and create it, if it hasn't been yet.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="WebIconProvider" ID="WebIconProvider"></a> | |
| 40 <h2>WebIconProvider</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a web site icon storage. | |
| 44 </p> | |
| 45 <h3>Signals</h3> | |
| 46 <dl> | |
| 47 | |
| 48 <dt>changed()</dt> | |
| 49 <dd> | |
| 50 emitted to indicate a change of the icons database | |
| 51 </dd> | |
| 52 </dl> | |
| 53 <h3>Derived from</h3> | |
| 54 QObject | |
| 55 <h3>Class Attributes</h3> | |
| 56 | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Class Methods</h3> | |
| 61 | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 <h3>Methods</h3> | |
| 66 | |
| 67 <table> | |
| 68 | |
| 69 <tr> | |
| 70 <td><a href="#WebIconProvider.__init__">WebIconProvider</a></td> | |
| 71 <td>Constructor</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#WebIconProvider.__urlToString">__urlToString</a></td> | |
| 75 <td>Private method to convert an URL to a string.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#WebIconProvider.clear">clear</a></td> | |
| 79 <td>Public method to clear the icons cache.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#WebIconProvider.close">close</a></td> | |
| 83 <td>Public method to close the web icon provider.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#WebIconProvider.iconDatabasePath">iconDatabasePath</a></td> | |
| 87 <td>Public method o get the path for the web site icons store.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#WebIconProvider.iconForUrl">iconForUrl</a></td> | |
| 91 <td>Public method to get an icon for an URL.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#WebIconProvider.load">load</a></td> | |
| 95 <td>Public method to load the web site icons.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#WebIconProvider.save">save</a></td> | |
| 99 <td>Public method to save the web site icons.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#WebIconProvider.saveIcon">saveIcon</a></td> | |
| 103 <td>Public method to save a web site icon.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#WebIconProvider.setIconDatabasePath">setIconDatabasePath</a></td> | |
| 107 <td>Public method to set the path for the web site icons store.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#WebIconProvider.showWebIconDialog">showWebIconDialog</a></td> | |
| 111 <td>Public method to show a dialog to manage the Favicons.</td> | |
| 112 </tr> | |
| 113 </table> | |
| 114 <h3>Static Methods</h3> | |
| 115 | |
| 116 <table> | |
| 117 <tr><td>None</td></tr> | |
| 118 </table> | |
| 119 | |
| 120 <a NAME="WebIconProvider.__init__" ID="WebIconProvider.__init__"></a> | |
| 121 <h4>WebIconProvider (Constructor)</h4> | |
| 122 <b>WebIconProvider</b>(<i>parent=None</i>) | |
| 123 | |
| 124 <p> | |
| 125 Constructor | |
| 126 </p> | |
| 127 <dl> | |
| 128 | |
| 129 <dt><i>parent</i></dt> | |
| 130 <dd> | |
| 131 reference to the parent object (QObject) | |
| 132 </dd> | |
| 133 </dl> | |
| 134 <a NAME="WebIconProvider.__urlToString" ID="WebIconProvider.__urlToString"></a> | |
| 135 <h4>WebIconProvider.__urlToString</h4> | |
| 136 <b>__urlToString</b>(<i>url</i>) | |
| 137 | |
| 138 <p> | |
| 139 Private method to convert an URL to a string. | |
| 140 </p> | |
| 141 <dl> | |
| 142 | |
| 143 <dt><i>url</i> (QUrl)</dt> | |
| 144 <dd> | |
| 145 URL to be converted | |
| 146 </dd> | |
| 147 </dl> | |
| 148 <dl> | |
| 149 <dt>Return:</dt> | |
| 150 <dd> | |
| 151 string representation of the URL | |
| 152 </dd> | |
| 153 </dl> | |
| 154 <dl> | |
| 155 <dt>Return Type:</dt> | |
| 156 <dd> | |
| 157 str | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <a NAME="WebIconProvider.clear" ID="WebIconProvider.clear"></a> | |
| 161 <h4>WebIconProvider.clear</h4> | |
| 162 <b>clear</b>(<i></i>) | |
| 163 | |
| 164 <p> | |
| 165 Public method to clear the icons cache. | |
| 166 </p> | |
| 167 <a NAME="WebIconProvider.close" ID="WebIconProvider.close"></a> | |
| 168 <h4>WebIconProvider.close</h4> | |
| 169 <b>close</b>(<i></i>) | |
| 170 | |
| 171 <p> | |
| 172 Public method to close the web icon provider. | |
| 173 </p> | |
| 174 <a NAME="WebIconProvider.iconDatabasePath" ID="WebIconProvider.iconDatabasePath"></a> | |
| 175 <h4>WebIconProvider.iconDatabasePath</h4> | |
| 176 <b>iconDatabasePath</b>(<i></i>) | |
| 177 | |
| 178 <p> | |
| 179 Public method o get the path for the web site icons store. | |
| 180 </p> | |
| 181 <dl> | |
| 182 <dt>Return:</dt> | |
| 183 <dd> | |
| 184 path to store the icons file to | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <dl> | |
| 188 <dt>Return Type:</dt> | |
| 189 <dd> | |
| 190 str | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <a NAME="WebIconProvider.iconForUrl" ID="WebIconProvider.iconForUrl"></a> | |
| 194 <h4>WebIconProvider.iconForUrl</h4> | |
| 195 <b>iconForUrl</b>(<i>url</i>) | |
| 196 | |
| 197 <p> | |
| 198 Public method to get an icon for an URL. | |
| 199 </p> | |
| 200 <dl> | |
| 201 | |
| 202 <dt><i>url</i> (QUrl)</dt> | |
| 203 <dd> | |
| 204 URL to get icon for | |
| 205 </dd> | |
| 206 </dl> | |
| 207 <dl> | |
| 208 <dt>Return:</dt> | |
| 209 <dd> | |
| 210 icon for the URL | |
| 211 </dd> | |
| 212 </dl> | |
| 213 <dl> | |
| 214 <dt>Return Type:</dt> | |
| 215 <dd> | |
| 216 QIcon | |
| 217 </dd> | |
| 218 </dl> | |
| 219 <a NAME="WebIconProvider.load" ID="WebIconProvider.load"></a> | |
| 220 <h4>WebIconProvider.load</h4> | |
| 221 <b>load</b>(<i></i>) | |
| 222 | |
| 223 <p> | |
| 224 Public method to load the web site icons. | |
| 225 </p> | |
| 226 <a NAME="WebIconProvider.save" ID="WebIconProvider.save"></a> | |
| 227 <h4>WebIconProvider.save</h4> | |
| 228 <b>save</b>(<i></i>) | |
| 229 | |
| 230 <p> | |
| 231 Public method to save the web site icons. | |
| 232 </p> | |
| 233 <a NAME="WebIconProvider.saveIcon" ID="WebIconProvider.saveIcon"></a> | |
| 234 <h4>WebIconProvider.saveIcon</h4> | |
| 235 <b>saveIcon</b>(<i>view</i>) | |
| 236 | |
| 237 <p> | |
| 238 Public method to save a web site icon. | |
| 239 </p> | |
| 240 <dl> | |
| 241 | |
| 242 <dt><i>view</i> (WebBrowserView)</dt> | |
| 243 <dd> | |
| 244 reference to the view object | |
| 245 </dd> | |
| 246 </dl> | |
| 247 <a NAME="WebIconProvider.setIconDatabasePath" ID="WebIconProvider.setIconDatabasePath"></a> | |
| 248 <h4>WebIconProvider.setIconDatabasePath</h4> | |
| 249 <b>setIconDatabasePath</b>(<i>path</i>) | |
| 250 | |
| 251 <p> | |
| 252 Public method to set the path for the web site icons store. | |
| 253 </p> | |
| 254 <dl> | |
| 255 | |
| 256 <dt><i>path</i> (str)</dt> | |
| 257 <dd> | |
| 258 path to store the icons file to | |
| 259 </dd> | |
| 260 </dl> | |
| 261 <a NAME="WebIconProvider.showWebIconDialog" ID="WebIconProvider.showWebIconDialog"></a> | |
| 262 <h4>WebIconProvider.showWebIconDialog</h4> | |
| 263 <b>showWebIconDialog</b>(<i></i>) | |
| 264 | |
| 265 <p> | |
| 266 Public method to show a dialog to manage the Favicons. | |
| 267 </p> | |
| 268 <div align="right"><a href="#top">Up</a></div> | |
| 269 <hr /> | |
| 270 <hr /> | |
| 271 <a NAME="instance" ID="instance"></a> | |
| 272 <h2>instance</h2> | |
| 273 <b>instance</b>(<i></i>) | |
| 274 | |
| 275 <p> | |
| 276 Global function to get a reference to the web icon provider and create it, | |
| 277 if it hasn't been yet. | |
| 278 </p> | |
| 279 <dl> | |
| 280 <dt>Return:</dt> | |
| 281 <dd> | |
| 282 reference to the web icon provider object | |
| 283 </dd> | |
| 284 </dl> | |
| 285 <dl> | |
| 286 <dt>Return Type:</dt> | |
| 287 <dd> | |
| 288 WebIconProvider | |
| 289 </dd> | |
| 290 </dl> | |
| 291 <div align="right"><a href="#top">Up</a></div> | |
| 292 <hr /> | |
| 293 </body></html> |
