Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.WebBrowser.Tools.WebIconProvider.html
Documentation/Source/eric6.WebBrowser.Tools.WebIconProvider.html
- changeset 4918
- 71caf42a13d8
- child 4971
- 0f21662c0d2d
equal
deleted
inserted
replaced
| 4917:682750cc7bd5 | 4918:71caf42a13d8 |
|---|---|
| 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> | |
| 50 <h3>Derived from</h3> | |
| 51 QObject | |
| 52 <h3>Class Attributes</h3> | |
| 53 <table> | |
| 54 <tr><td>None</td></tr> | |
| 55 </table> | |
| 56 <h3>Class Methods</h3> | |
| 57 <table> | |
| 58 <tr><td>None</td></tr> | |
| 59 </table> | |
| 60 <h3>Methods</h3> | |
| 61 <table> | |
| 62 <tr> | |
| 63 <td><a href="#WebIconProvider.__init__">WebIconProvider</a></td> | |
| 64 <td>Constructor</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#WebIconProvider.__urlToString">__urlToString</a></td> | |
| 67 <td>Private method to convert an URL to a string.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#WebIconProvider.clear">clear</a></td> | |
| 70 <td>Public method to clear the icons cache.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#WebIconProvider.close">close</a></td> | |
| 73 <td>Public method to close the web icon provider.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#WebIconProvider.iconDatabasePath">iconDatabasePath</a></td> | |
| 76 <td>Public method o get the path for the web site icons store.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#WebIconProvider.iconForUrl">iconForUrl</a></td> | |
| 79 <td>Public method to get an icon for an URL.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#WebIconProvider.load">load</a></td> | |
| 82 <td>Public method to load the bookmarks.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#WebIconProvider.save">save</a></td> | |
| 85 <td>Public method to save the zoom values.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#WebIconProvider.saveIcon">saveIcon</a></td> | |
| 88 <td>Public method to save a web site icon.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#WebIconProvider.setIconDatabasePath">setIconDatabasePath</a></td> | |
| 91 <td>Public method to set the path for the web site icons store.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#WebIconProvider.showWebIconDialog">showWebIconDialog</a></td> | |
| 94 <td>Public method to show a dialog to manage the Favicons.</td> | |
| 95 </tr> | |
| 96 </table> | |
| 97 <h3>Static Methods</h3> | |
| 98 <table> | |
| 99 <tr><td>None</td></tr> | |
| 100 </table> | |
| 101 <a NAME="WebIconProvider.__init__" ID="WebIconProvider.__init__"></a> | |
| 102 <h4>WebIconProvider (Constructor)</h4> | |
| 103 <b>WebIconProvider</b>(<i>parent=None</i>) | |
| 104 <p> | |
| 105 Constructor | |
| 106 </p><dl> | |
| 107 <dt><i>parent</i></dt> | |
| 108 <dd> | |
| 109 reference to the parent object (QObject) | |
| 110 </dd> | |
| 111 </dl><a NAME="WebIconProvider.__urlToString" ID="WebIconProvider.__urlToString"></a> | |
| 112 <h4>WebIconProvider.__urlToString</h4> | |
| 113 <b>__urlToString</b>(<i>url</i>) | |
| 114 <p> | |
| 115 Private method to convert an URL to a string. | |
| 116 </p><dl> | |
| 117 <dt><i>url</i> (QUrl)</dt> | |
| 118 <dd> | |
| 119 URL to be converted | |
| 120 </dd> | |
| 121 </dl><dl> | |
| 122 <dt>Returns:</dt> | |
| 123 <dd> | |
| 124 string representation of the URL | |
| 125 </dd> | |
| 126 </dl><dl> | |
| 127 <dt>Return Type:</dt> | |
| 128 <dd> | |
| 129 str | |
| 130 </dd> | |
| 131 </dl><a NAME="WebIconProvider.clear" ID="WebIconProvider.clear"></a> | |
| 132 <h4>WebIconProvider.clear</h4> | |
| 133 <b>clear</b>(<i></i>) | |
| 134 <p> | |
| 135 Public method to clear the icons cache. | |
| 136 </p><a NAME="WebIconProvider.close" ID="WebIconProvider.close"></a> | |
| 137 <h4>WebIconProvider.close</h4> | |
| 138 <b>close</b>(<i></i>) | |
| 139 <p> | |
| 140 Public method to close the web icon provider. | |
| 141 </p><a NAME="WebIconProvider.iconDatabasePath" ID="WebIconProvider.iconDatabasePath"></a> | |
| 142 <h4>WebIconProvider.iconDatabasePath</h4> | |
| 143 <b>iconDatabasePath</b>(<i></i>) | |
| 144 <p> | |
| 145 Public method o get the path for the web site icons store. | |
| 146 </p><dl> | |
| 147 <dt>Returns:</dt> | |
| 148 <dd> | |
| 149 path to store the icons file to | |
| 150 </dd> | |
| 151 </dl><dl> | |
| 152 <dt>Return Type:</dt> | |
| 153 <dd> | |
| 154 str | |
| 155 </dd> | |
| 156 </dl><a NAME="WebIconProvider.iconForUrl" ID="WebIconProvider.iconForUrl"></a> | |
| 157 <h4>WebIconProvider.iconForUrl</h4> | |
| 158 <b>iconForUrl</b>(<i>url</i>) | |
| 159 <p> | |
| 160 Public method to get an icon for an URL. | |
| 161 </p><dl> | |
| 162 <dt><i>url</i> (QUrl)</dt> | |
| 163 <dd> | |
| 164 URL to get icon for | |
| 165 </dd> | |
| 166 </dl><dl> | |
| 167 <dt>Returns:</dt> | |
| 168 <dd> | |
| 169 icon for the URL | |
| 170 </dd> | |
| 171 </dl><dl> | |
| 172 <dt>Return Type:</dt> | |
| 173 <dd> | |
| 174 QIcon | |
| 175 </dd> | |
| 176 </dl><a NAME="WebIconProvider.load" ID="WebIconProvider.load"></a> | |
| 177 <h4>WebIconProvider.load</h4> | |
| 178 <b>load</b>(<i></i>) | |
| 179 <p> | |
| 180 Public method to load the bookmarks. | |
| 181 </p><a NAME="WebIconProvider.save" ID="WebIconProvider.save"></a> | |
| 182 <h4>WebIconProvider.save</h4> | |
| 183 <b>save</b>(<i></i>) | |
| 184 <p> | |
| 185 Public method to save the zoom values. | |
| 186 </p><a NAME="WebIconProvider.saveIcon" ID="WebIconProvider.saveIcon"></a> | |
| 187 <h4>WebIconProvider.saveIcon</h4> | |
| 188 <b>saveIcon</b>(<i>view</i>) | |
| 189 <p> | |
| 190 Public method to save a web site icon. | |
| 191 </p><dl> | |
| 192 <dt><i>view</i> (WebBrowserView)</dt> | |
| 193 <dd> | |
| 194 reference to the view object | |
| 195 </dd> | |
| 196 </dl><a NAME="WebIconProvider.setIconDatabasePath" ID="WebIconProvider.setIconDatabasePath"></a> | |
| 197 <h4>WebIconProvider.setIconDatabasePath</h4> | |
| 198 <b>setIconDatabasePath</b>(<i>path</i>) | |
| 199 <p> | |
| 200 Public method to set the path for the web site icons store. | |
| 201 </p><dl> | |
| 202 <dt><i>path</i> (str)</dt> | |
| 203 <dd> | |
| 204 path to store the icons file to | |
| 205 </dd> | |
| 206 </dl><a NAME="WebIconProvider.showWebIconDialog" ID="WebIconProvider.showWebIconDialog"></a> | |
| 207 <h4>WebIconProvider.showWebIconDialog</h4> | |
| 208 <b>showWebIconDialog</b>(<i></i>) | |
| 209 <p> | |
| 210 Public method to show a dialog to manage the Favicons. | |
| 211 </p> | |
| 212 <div align="right"><a href="#top">Up</a></div> | |
| 213 <hr /><hr /> | |
| 214 <a NAME="instance" ID="instance"></a> | |
| 215 <h2>instance</h2> | |
| 216 <b>instance</b>(<i></i>) | |
| 217 <p> | |
| 218 Global function to get a reference to the web icon provider and create it, | |
| 219 if it hasn't been yet. | |
| 220 </p><dl> | |
| 221 <dt>Returns:</dt> | |
| 222 <dd> | |
| 223 reference to the web icon provider object | |
| 224 </dd> | |
| 225 </dl><dl> | |
| 226 <dt>Return Type:</dt> | |
| 227 <dd> | |
| 228 WebIconProvider | |
| 229 </dd> | |
| 230 </dl> | |
| 231 <div align="right"><a href="#top">Up</a></div> | |
| 232 <hr /> | |
| 233 </body></html> |
