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 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.Tools.WebIconProvider</h1> 9 <h1>eric7.WebBrowser.Tools.WebIconProvider</h1>
10
11 <p> 10 <p>
12 Module containing a web site icon storage object. 11 Module containing a web site icon storage object.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>_WebIconProvider</td></tr> 16 <tr><td>_WebIconProvider</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#WebIconProvider">WebIconProvider</a></td> 22 <td><a href="#WebIconProvider">WebIconProvider</a></td>
25 <td>Class implementing a web site icon storage.</td> 23 <td>Class implementing a web site icon storage.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table>
31
32 <tr> 29 <tr>
33 <td><a href="#instance">instance</a></td> 30 <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> 31 <td>Global function to get a reference to the web icon provider and create it, if it hasn't been yet.</td>
35 </tr> 32 </tr>
36 </table> 33 </table>
34
37 <hr /> 35 <hr />
38 <hr /> 36 <hr />
39 <a NAME="WebIconProvider" ID="WebIconProvider"></a> 37 <a NAME="WebIconProvider" ID="WebIconProvider"></a>
40 <h2>WebIconProvider</h2> 38 <h2>WebIconProvider</h2>
41
42 <p> 39 <p>
43 Class implementing a web site icon storage. 40 Class implementing a web site icon storage.
44 </p> 41 </p>
42
45 <h3>Signals</h3> 43 <h3>Signals</h3>
46 <dl> 44 <dl>
47 45
48 <dt>changed()</dt> 46 <dt>changed()</dt>
49 <dd> 47 <dd>
51 </dd> 49 </dd>
52 </dl> 50 </dl>
53 <h3>Derived from</h3> 51 <h3>Derived from</h3>
54 QObject 52 QObject
55 <h3>Class Attributes</h3> 53 <h3>Class Attributes</h3>
56
57 <table> 54 <table>
58 <tr><td>None</td></tr> 55 <tr><td>None</td></tr>
59 </table> 56 </table>
57
60 <h3>Class Methods</h3> 58 <h3>Class Methods</h3>
61
62 <table> 59 <table>
63 <tr><td>None</td></tr> 60 <tr><td>None</td></tr>
64 </table> 61 </table>
62
65 <h3>Methods</h3> 63 <h3>Methods</h3>
66 64 <table>
67 <table>
68
69 <tr> 65 <tr>
70 <td><a href="#WebIconProvider.__init__">WebIconProvider</a></td> 66 <td><a href="#WebIconProvider.__init__">WebIconProvider</a></td>
71 <td>Constructor</td> 67 <td>Constructor</td>
72 </tr> 68 </tr>
73 <tr> 69 <tr>
109 <tr> 105 <tr>
110 <td><a href="#WebIconProvider.showWebIconDialog">showWebIconDialog</a></td> 106 <td><a href="#WebIconProvider.showWebIconDialog">showWebIconDialog</a></td>
111 <td>Public method to show a dialog to manage the Favicons.</td> 107 <td>Public method to show a dialog to manage the Favicons.</td>
112 </tr> 108 </tr>
113 </table> 109 </table>
110
114 <h3>Static Methods</h3> 111 <h3>Static Methods</h3>
115
116 <table> 112 <table>
117 <tr><td>None</td></tr> 113 <tr><td>None</td></tr>
118 </table> 114 </table>
115
119 116
120 <a NAME="WebIconProvider.__init__" ID="WebIconProvider.__init__"></a> 117 <a NAME="WebIconProvider.__init__" ID="WebIconProvider.__init__"></a>
121 <h4>WebIconProvider (Constructor)</h4> 118 <h4>WebIconProvider (Constructor)</h4>
122 <b>WebIconProvider</b>(<i>parent=None</i>) 119 <b>WebIconProvider</b>(<i>parent=None</i>)
123
124 <p> 120 <p>
125 Constructor 121 Constructor
126 </p> 122 </p>
123
127 <dl> 124 <dl>
128 125
129 <dt><i>parent</i> (QObject)</dt> 126 <dt><i>parent</i> (QObject)</dt>
130 <dd> 127 <dd>
131 reference to the parent object 128 reference to the parent object
132 </dd> 129 </dd>
133 </dl> 130 </dl>
134 <a NAME="WebIconProvider.__urlToString" ID="WebIconProvider.__urlToString"></a> 131 <a NAME="WebIconProvider.__urlToString" ID="WebIconProvider.__urlToString"></a>
135 <h4>WebIconProvider.__urlToString</h4> 132 <h4>WebIconProvider.__urlToString</h4>
136 <b>__urlToString</b>(<i>url</i>) 133 <b>__urlToString</b>(<i>url</i>)
137
138 <p> 134 <p>
139 Private method to convert an URL to a string. 135 Private method to convert an URL to a string.
140 </p> 136 </p>
137
141 <dl> 138 <dl>
142 139
143 <dt><i>url</i> (QUrl)</dt> 140 <dt><i>url</i> (QUrl)</dt>
144 <dd> 141 <dd>
145 URL to be converted 142 URL to be converted
158 </dd> 155 </dd>
159 </dl> 156 </dl>
160 <a NAME="WebIconProvider.clear" ID="WebIconProvider.clear"></a> 157 <a NAME="WebIconProvider.clear" ID="WebIconProvider.clear"></a>
161 <h4>WebIconProvider.clear</h4> 158 <h4>WebIconProvider.clear</h4>
162 <b>clear</b>(<i></i>) 159 <b>clear</b>(<i></i>)
163
164 <p> 160 <p>
165 Public method to clear the icons cache. 161 Public method to clear the icons cache.
166 </p> 162 </p>
163
167 <a NAME="WebIconProvider.close" ID="WebIconProvider.close"></a> 164 <a NAME="WebIconProvider.close" ID="WebIconProvider.close"></a>
168 <h4>WebIconProvider.close</h4> 165 <h4>WebIconProvider.close</h4>
169 <b>close</b>(<i></i>) 166 <b>close</b>(<i></i>)
170
171 <p> 167 <p>
172 Public method to close the web icon provider. 168 Public method to close the web icon provider.
173 </p> 169 </p>
170
174 <a NAME="WebIconProvider.iconDatabasePath" ID="WebIconProvider.iconDatabasePath"></a> 171 <a NAME="WebIconProvider.iconDatabasePath" ID="WebIconProvider.iconDatabasePath"></a>
175 <h4>WebIconProvider.iconDatabasePath</h4> 172 <h4>WebIconProvider.iconDatabasePath</h4>
176 <b>iconDatabasePath</b>(<i></i>) 173 <b>iconDatabasePath</b>(<i></i>)
177
178 <p> 174 <p>
179 Public method o get the path for the web site icons store. 175 Public method o get the path for the web site icons store.
180 </p> 176 </p>
177
181 <dl> 178 <dl>
182 <dt>Return:</dt> 179 <dt>Return:</dt>
183 <dd> 180 <dd>
184 path to store the icons file to 181 path to store the icons file to
185 </dd> 182 </dd>
191 </dd> 188 </dd>
192 </dl> 189 </dl>
193 <a NAME="WebIconProvider.iconForUrl" ID="WebIconProvider.iconForUrl"></a> 190 <a NAME="WebIconProvider.iconForUrl" ID="WebIconProvider.iconForUrl"></a>
194 <h4>WebIconProvider.iconForUrl</h4> 191 <h4>WebIconProvider.iconForUrl</h4>
195 <b>iconForUrl</b>(<i>url</i>) 192 <b>iconForUrl</b>(<i>url</i>)
196
197 <p> 193 <p>
198 Public method to get an icon for an URL. 194 Public method to get an icon for an URL.
199 </p> 195 </p>
196
200 <dl> 197 <dl>
201 198
202 <dt><i>url</i> (QUrl)</dt> 199 <dt><i>url</i> (QUrl)</dt>
203 <dd> 200 <dd>
204 URL to get icon for 201 URL to get icon for
217 </dd> 214 </dd>
218 </dl> 215 </dl>
219 <a NAME="WebIconProvider.load" ID="WebIconProvider.load"></a> 216 <a NAME="WebIconProvider.load" ID="WebIconProvider.load"></a>
220 <h4>WebIconProvider.load</h4> 217 <h4>WebIconProvider.load</h4>
221 <b>load</b>(<i></i>) 218 <b>load</b>(<i></i>)
222
223 <p> 219 <p>
224 Public method to load the web site icons. 220 Public method to load the web site icons.
225 </p> 221 </p>
222
226 <a NAME="WebIconProvider.save" ID="WebIconProvider.save"></a> 223 <a NAME="WebIconProvider.save" ID="WebIconProvider.save"></a>
227 <h4>WebIconProvider.save</h4> 224 <h4>WebIconProvider.save</h4>
228 <b>save</b>(<i></i>) 225 <b>save</b>(<i></i>)
229
230 <p> 226 <p>
231 Public method to save the web site icons. 227 Public method to save the web site icons.
232 </p> 228 </p>
229
233 <a NAME="WebIconProvider.saveIcon" ID="WebIconProvider.saveIcon"></a> 230 <a NAME="WebIconProvider.saveIcon" ID="WebIconProvider.saveIcon"></a>
234 <h4>WebIconProvider.saveIcon</h4> 231 <h4>WebIconProvider.saveIcon</h4>
235 <b>saveIcon</b>(<i>view</i>) 232 <b>saveIcon</b>(<i>view</i>)
236
237 <p> 233 <p>
238 Public method to save a web site icon. 234 Public method to save a web site icon.
239 </p> 235 </p>
236
240 <dl> 237 <dl>
241 238
242 <dt><i>view</i> (WebBrowserView)</dt> 239 <dt><i>view</i> (WebBrowserView)</dt>
243 <dd> 240 <dd>
244 reference to the view object 241 reference to the view object
245 </dd> 242 </dd>
246 </dl> 243 </dl>
247 <a NAME="WebIconProvider.setIconDatabasePath" ID="WebIconProvider.setIconDatabasePath"></a> 244 <a NAME="WebIconProvider.setIconDatabasePath" ID="WebIconProvider.setIconDatabasePath"></a>
248 <h4>WebIconProvider.setIconDatabasePath</h4> 245 <h4>WebIconProvider.setIconDatabasePath</h4>
249 <b>setIconDatabasePath</b>(<i>path</i>) 246 <b>setIconDatabasePath</b>(<i>path</i>)
250
251 <p> 247 <p>
252 Public method to set the path for the web site icons store. 248 Public method to set the path for the web site icons store.
253 </p> 249 </p>
250
254 <dl> 251 <dl>
255 252
256 <dt><i>path</i> (str)</dt> 253 <dt><i>path</i> (str)</dt>
257 <dd> 254 <dd>
258 path to store the icons file to 255 path to store the icons file to
259 </dd> 256 </dd>
260 </dl> 257 </dl>
261 <a NAME="WebIconProvider.showWebIconDialog" ID="WebIconProvider.showWebIconDialog"></a> 258 <a NAME="WebIconProvider.showWebIconDialog" ID="WebIconProvider.showWebIconDialog"></a>
262 <h4>WebIconProvider.showWebIconDialog</h4> 259 <h4>WebIconProvider.showWebIconDialog</h4>
263 <b>showWebIconDialog</b>(<i>parent=None</i>) 260 <b>showWebIconDialog</b>(<i>parent=None</i>)
264
265 <p> 261 <p>
266 Public method to show a dialog to manage the Favicons. 262 Public method to show a dialog to manage the Favicons.
267 </p> 263 </p>
264
268 <dl> 265 <dl>
269 266
270 <dt><i>parent</i> (QWidget)</dt> 267 <dt><i>parent</i> (QWidget)</dt>
271 <dd> 268 <dd>
272 reference to the parent widget 269 reference to the parent widget
276 <hr /> 273 <hr />
277 <hr /> 274 <hr />
278 <a NAME="instance" ID="instance"></a> 275 <a NAME="instance" ID="instance"></a>
279 <h2>instance</h2> 276 <h2>instance</h2>
280 <b>instance</b>(<i></i>) 277 <b>instance</b>(<i></i>)
281
282 <p> 278 <p>
283 Global function to get a reference to the web icon provider and create it, 279 Global function to get a reference to the web icon provider and create it,
284 if it hasn't been yet. 280 if it hasn't been yet.
285 </p> 281 </p>
282
286 <dl> 283 <dl>
287 <dt>Return:</dt> 284 <dt>Return:</dt>
288 <dd> 285 <dd>
289 reference to the web icon provider object 286 reference to the web icon provider object
290 </dd> 287 </dd>

Mercurial Repository: eric

eric ide

mercurial