Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Helpviewer.SpeedDial.SpeedDial.html

eric6/Documentation/Source/eric6.Helpviewer.SpeedDial.SpeedDial.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.SpeedDial.SpeedDial</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.Helpviewer.SpeedDial.SpeedDial</h1>
23 <p>
24 Module implementing the speed dial.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#SpeedDial">SpeedDial</a></td>
34 <td>Class implementing the speed dial.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="SpeedDial" ID="SpeedDial"></a>
43 <h2>SpeedDial</h2>
44 <p>
45 Class implementing the speed dial.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>pagesChanged()</dt>
49 <dd>
50 emitted after the list of pages changed
51 </dd><dt>speedDialSaved()</dt>
52 <dd>
53 emitted after the speed dial data was saved
54 </dd>
55 </dl>
56 <h3>Derived from</h3>
57 QObject
58 <h3>Class Attributes</h3>
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Methods</h3>
67 <table>
68 <tr>
69 <td><a href="#SpeedDial.__init__">SpeedDial</a></td>
70 <td>Constructor</td>
71 </tr><tr>
72 <td><a href="#SpeedDial.__cleanFrames">__cleanFrames</a></td>
73 <td>Private method to clean all frames.</td>
74 </tr><tr>
75 <td><a href="#SpeedDial.__imageFileName">__imageFileName</a></td>
76 <td>Private method to generate the image file name for a URL.</td>
77 </tr><tr>
78 <td><a href="#SpeedDial.__initialize">__initialize</a></td>
79 <td>Private method to initialize the speed dial.</td>
80 </tr><tr>
81 <td><a href="#SpeedDial.__load">__load</a></td>
82 <td>Private method to load the speed dial configuration.</td>
83 </tr><tr>
84 <td><a href="#SpeedDial.__pagesChanged">__pagesChanged</a></td>
85 <td>Private slot to react on a change of the pages configuration.</td>
86 </tr><tr>
87 <td><a href="#SpeedDial.__thumbnailCreated">__thumbnailCreated</a></td>
88 <td>Private slot to handle the creation of a thumbnail image.</td>
89 </tr><tr>
90 <td><a href="#SpeedDial.addPage">addPage</a></td>
91 <td>Public method to add a page for the given data.</td>
92 </tr><tr>
93 <td><a href="#SpeedDial.addWebFrame">addWebFrame</a></td>
94 <td>Public method to add a web frame.</td>
95 </tr><tr>
96 <td><a href="#SpeedDial.changed">changed</a></td>
97 <td>Public slot to react on changed pages.</td>
98 </tr><tr>
99 <td><a href="#SpeedDial.close">close</a></td>
100 <td>Public method to close the user agents manager.</td>
101 </tr><tr>
102 <td><a href="#SpeedDial.getFileName">getFileName</a></td>
103 <td>Public method to get the file name of the user agents file.</td>
104 </tr><tr>
105 <td><a href="#SpeedDial.initialScript">initialScript</a></td>
106 <td>Public method to get the 'initial' JavaScript script.</td>
107 </tr><tr>
108 <td><a href="#SpeedDial.loadThumbnail">loadThumbnail</a></td>
109 <td>Public slot to load a thumbnail of the given URL.</td>
110 </tr><tr>
111 <td><a href="#SpeedDial.pageForUrl">pageForUrl</a></td>
112 <td>Public method to get the page for the given URL.</td>
113 </tr><tr>
114 <td><a href="#SpeedDial.pagesInRow">pagesInRow</a></td>
115 <td>Public method to get the number of dials per row.</td>
116 </tr><tr>
117 <td><a href="#SpeedDial.reload">reload</a></td>
118 <td>Public method to reload the speed dial data.</td>
119 </tr><tr>
120 <td><a href="#SpeedDial.removeImageForUrl">removeImageForUrl</a></td>
121 <td>Public slot to remove the image for a URL.</td>
122 </tr><tr>
123 <td><a href="#SpeedDial.removePage">removePage</a></td>
124 <td>Public method to remove a page.</td>
125 </tr><tr>
126 <td><a href="#SpeedDial.resetDials">resetDials</a></td>
127 <td>Public method to reset the speed dials to the default values.</td>
128 </tr><tr>
129 <td><a href="#SpeedDial.save">save</a></td>
130 <td>Public method to save the speed dial configuration.</td>
131 </tr><tr>
132 <td><a href="#SpeedDial.sdSize">sdSize</a></td>
133 <td>Public method to get the speed dial size.</td>
134 </tr><tr>
135 <td><a href="#SpeedDial.setPagesInRow">setPagesInRow</a></td>
136 <td>Public slot to set the number of pages per row.</td>
137 </tr><tr>
138 <td><a href="#SpeedDial.setSdSize">setSdSize</a></td>
139 <td>Public slot to set the size of the speed dial.</td>
140 </tr><tr>
141 <td><a href="#SpeedDial.unescapeTitle">unescapeTitle</a></td>
142 <td>Public slot to unescape the titel string.</td>
143 </tr><tr>
144 <td><a href="#SpeedDial.urlForShortcut">urlForShortcut</a></td>
145 <td>Public method to get the URL for the given shortcut key.</td>
146 </tr><tr>
147 <td><a href="#SpeedDial.urlFromUserInput">urlFromUserInput</a></td>
148 <td>Public slot to get the URL from user input.</td>
149 </tr>
150 </table>
151 <h3>Static Methods</h3>
152 <table>
153 <tr><td>None</td></tr>
154 </table>
155 <a NAME="SpeedDial.__init__" ID="SpeedDial.__init__"></a>
156 <h4>SpeedDial (Constructor)</h4>
157 <b>SpeedDial</b>(<i>parent=None</i>)
158 <p>
159 Constructor
160 </p><dl>
161 <dt><i>parent</i></dt>
162 <dd>
163 reference to the parent object (QObject)
164 </dd>
165 </dl><a NAME="SpeedDial.__cleanFrames" ID="SpeedDial.__cleanFrames"></a>
166 <h4>SpeedDial.__cleanFrames</h4>
167 <b>__cleanFrames</b>(<i></i>)
168 <p>
169 Private method to clean all frames.
170 </p><dl>
171 <dt>Returns:</dt>
172 <dd>
173 list of speed dial frames (list of QWebFrame)
174 </dd>
175 </dl><a NAME="SpeedDial.__imageFileName" ID="SpeedDial.__imageFileName"></a>
176 <h4>SpeedDial.__imageFileName</h4>
177 <b>__imageFileName</b>(<i>url</i>)
178 <p>
179 Private method to generate the image file name for a URL.
180 </p><dl>
181 <dt><i>url</i></dt>
182 <dd>
183 URL to generate the file name from (string)
184 </dd>
185 </dl><dl>
186 <dt>Returns:</dt>
187 <dd>
188 name of the image file (string)
189 </dd>
190 </dl><a NAME="SpeedDial.__initialize" ID="SpeedDial.__initialize"></a>
191 <h4>SpeedDial.__initialize</h4>
192 <b>__initialize</b>(<i></i>)
193 <p>
194 Private method to initialize the speed dial.
195 </p><a NAME="SpeedDial.__load" ID="SpeedDial.__load"></a>
196 <h4>SpeedDial.__load</h4>
197 <b>__load</b>(<i></i>)
198 <p>
199 Private method to load the speed dial configuration.
200 </p><a NAME="SpeedDial.__pagesChanged" ID="SpeedDial.__pagesChanged"></a>
201 <h4>SpeedDial.__pagesChanged</h4>
202 <b>__pagesChanged</b>(<i></i>)
203 <p>
204 Private slot to react on a change of the pages configuration.
205 </p><a NAME="SpeedDial.__thumbnailCreated" ID="SpeedDial.__thumbnailCreated"></a>
206 <h4>SpeedDial.__thumbnailCreated</h4>
207 <b>__thumbnailCreated</b>(<i>image, thumbnailer</i>)
208 <p>
209 Private slot to handle the creation of a thumbnail image.
210 </p><dl>
211 <dt><i>image</i> (QPixmap)</dt>
212 <dd>
213 thumbnail image
214 </dd><dt><i>thumbnailer</i> (PageThumbnailer)</dt>
215 <dd>
216 reference to the page thumbnailer
217 </dd>
218 </dl><a NAME="SpeedDial.addPage" ID="SpeedDial.addPage"></a>
219 <h4>SpeedDial.addPage</h4>
220 <b>addPage</b>(<i>url, title</i>)
221 <p>
222 Public method to add a page for the given data.
223 </p><dl>
224 <dt><i>url</i></dt>
225 <dd>
226 URL of the page (QUrl)
227 </dd><dt><i>title</i></dt>
228 <dd>
229 title of the page (string)
230 </dd>
231 </dl><a NAME="SpeedDial.addWebFrame" ID="SpeedDial.addWebFrame"></a>
232 <h4>SpeedDial.addWebFrame</h4>
233 <b>addWebFrame</b>(<i>frame</i>)
234 <p>
235 Public method to add a web frame.
236 </p><dl>
237 <dt><i>frame</i></dt>
238 <dd>
239 reference to the frame to be added (QWebFrame)
240 </dd>
241 </dl><a NAME="SpeedDial.changed" ID="SpeedDial.changed"></a>
242 <h4>SpeedDial.changed</h4>
243 <b>changed</b>(<i>allPages</i>)
244 <p>
245 Public slot to react on changed pages.
246 </p><dl>
247 <dt><i>allPages</i></dt>
248 <dd>
249 string giving all pages (string)
250 </dd>
251 </dl><a NAME="SpeedDial.close" ID="SpeedDial.close"></a>
252 <h4>SpeedDial.close</h4>
253 <b>close</b>(<i></i>)
254 <p>
255 Public method to close the user agents manager.
256 </p><a NAME="SpeedDial.getFileName" ID="SpeedDial.getFileName"></a>
257 <h4>SpeedDial.getFileName</h4>
258 <b>getFileName</b>(<i></i>)
259 <p>
260 Public method to get the file name of the user agents file.
261 </p><dl>
262 <dt>Returns:</dt>
263 <dd>
264 name of the user agents file (string)
265 </dd>
266 </dl><a NAME="SpeedDial.initialScript" ID="SpeedDial.initialScript"></a>
267 <h4>SpeedDial.initialScript</h4>
268 <b>initialScript</b>(<i></i>)
269 <p>
270 Public method to get the 'initial' JavaScript script.
271 </p><dl>
272 <dt>Returns:</dt>
273 <dd>
274 initial JavaScript script (string)
275 </dd>
276 </dl><a NAME="SpeedDial.loadThumbnail" ID="SpeedDial.loadThumbnail"></a>
277 <h4>SpeedDial.loadThumbnail</h4>
278 <b>loadThumbnail</b>(<i>url, loadTitle=False</i>)
279 <p>
280 Public slot to load a thumbnail of the given URL.
281 </p><dl>
282 <dt><i>url</i></dt>
283 <dd>
284 URL of the thumbnail (string)
285 </dd><dt><i>loadTitle</i></dt>
286 <dd>
287 flag indicating to get the title for the thumbnail
288 from the site (boolean)
289 </dd>
290 </dl><a NAME="SpeedDial.pageForUrl" ID="SpeedDial.pageForUrl"></a>
291 <h4>SpeedDial.pageForUrl</h4>
292 <b>pageForUrl</b>(<i>url</i>)
293 <p>
294 Public method to get the page for the given URL.
295 </p><dl>
296 <dt><i>url</i></dt>
297 <dd>
298 URL to be searched for (QUrl)
299 </dd>
300 </dl><dl>
301 <dt>Returns:</dt>
302 <dd>
303 page for the URL (Page)
304 </dd>
305 </dl><a NAME="SpeedDial.pagesInRow" ID="SpeedDial.pagesInRow"></a>
306 <h4>SpeedDial.pagesInRow</h4>
307 <b>pagesInRow</b>(<i></i>)
308 <p>
309 Public method to get the number of dials per row.
310 </p><dl>
311 <dt>Returns:</dt>
312 <dd>
313 number of dials per row (integer)
314 </dd>
315 </dl><a NAME="SpeedDial.reload" ID="SpeedDial.reload"></a>
316 <h4>SpeedDial.reload</h4>
317 <b>reload</b>(<i></i>)
318 <p>
319 Public method to reload the speed dial data.
320 </p><a NAME="SpeedDial.removeImageForUrl" ID="SpeedDial.removeImageForUrl"></a>
321 <h4>SpeedDial.removeImageForUrl</h4>
322 <b>removeImageForUrl</b>(<i>url</i>)
323 <p>
324 Public slot to remove the image for a URL.
325 </p><dl>
326 <dt><i>url</i></dt>
327 <dd>
328 URL to remove the image for (string)
329 </dd>
330 </dl><a NAME="SpeedDial.removePage" ID="SpeedDial.removePage"></a>
331 <h4>SpeedDial.removePage</h4>
332 <b>removePage</b>(<i>url</i>)
333 <p>
334 Public method to remove a page.
335 </p><dl>
336 <dt><i>url</i></dt>
337 <dd>
338 URL of the page (QUrl)
339 </dd>
340 </dl><a NAME="SpeedDial.resetDials" ID="SpeedDial.resetDials"></a>
341 <h4>SpeedDial.resetDials</h4>
342 <b>resetDials</b>(<i></i>)
343 <p>
344 Public method to reset the speed dials to the default values.
345 </p><a NAME="SpeedDial.save" ID="SpeedDial.save"></a>
346 <h4>SpeedDial.save</h4>
347 <b>save</b>(<i></i>)
348 <p>
349 Public method to save the speed dial configuration.
350 </p><a NAME="SpeedDial.sdSize" ID="SpeedDial.sdSize"></a>
351 <h4>SpeedDial.sdSize</h4>
352 <b>sdSize</b>(<i></i>)
353 <p>
354 Public method to get the speed dial size.
355 </p><dl>
356 <dt>Returns:</dt>
357 <dd>
358 speed dial size (integer)
359 </dd>
360 </dl><a NAME="SpeedDial.setPagesInRow" ID="SpeedDial.setPagesInRow"></a>
361 <h4>SpeedDial.setPagesInRow</h4>
362 <b>setPagesInRow</b>(<i>count</i>)
363 <p>
364 Public slot to set the number of pages per row.
365 </p><dl>
366 <dt><i>count</i></dt>
367 <dd>
368 number of pages per row (integer)
369 </dd>
370 </dl><a NAME="SpeedDial.setSdSize" ID="SpeedDial.setSdSize"></a>
371 <h4>SpeedDial.setSdSize</h4>
372 <b>setSdSize</b>(<i>size</i>)
373 <p>
374 Public slot to set the size of the speed dial.
375 </p><dl>
376 <dt><i>size</i></dt>
377 <dd>
378 size of the speed dial (integer)
379 </dd>
380 </dl><a NAME="SpeedDial.unescapeTitle" ID="SpeedDial.unescapeTitle"></a>
381 <h4>SpeedDial.unescapeTitle</h4>
382 <b>unescapeTitle</b>(<i>title</i>)
383 <p>
384 Public slot to unescape the titel string.
385 </p><dl>
386 <dt><i>title</i></dt>
387 <dd>
388 escaped title (string)
389 </dd>
390 </dl><dl>
391 <dt>Returns:</dt>
392 <dd>
393 un-escaped title (string)
394 </dd>
395 </dl><a NAME="SpeedDial.urlForShortcut" ID="SpeedDial.urlForShortcut"></a>
396 <h4>SpeedDial.urlForShortcut</h4>
397 <b>urlForShortcut</b>(<i>key</i>)
398 <p>
399 Public method to get the URL for the given shortcut key.
400 </p><dl>
401 <dt><i>key</i></dt>
402 <dd>
403 shortcut key (integer)
404 </dd>
405 </dl><dl>
406 <dt>Returns:</dt>
407 <dd>
408 URL for the key (QUrl)
409 </dd>
410 </dl><a NAME="SpeedDial.urlFromUserInput" ID="SpeedDial.urlFromUserInput"></a>
411 <h4>SpeedDial.urlFromUserInput</h4>
412 <b>urlFromUserInput</b>(<i>url</i>)
413 <p>
414 Public slot to get the URL from user input.
415 </p><dl>
416 <dt><i>url</i></dt>
417 <dd>
418 URL entered by the user (string)
419 </dd>
420 </dl><dl>
421 <dt>Returns:</dt>
422 <dd>
423 sanitized URL (string)
424 </dd>
425 </dl>
426 <div align="right"><a href="#top">Up</a></div>
427 <hr />
428 </body></html>

Mercurial Repository: eric

eric ide

mercurial