Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial