Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial