Mercurial Repositories > eric / file comparison

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

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

changeset 3673
e26d7d0c1088
child 3801
455a60f832d5
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
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.save">save</a></td>
127 <td>Public method to save the speed dial configuration.</td>
128 </tr><tr>
129 <td><a href="#SpeedDial.sdSize">sdSize</a></td>
130 <td>Public method to get the speed dial size.</td>
131 </tr><tr>
132 <td><a href="#SpeedDial.setPagesInRow">setPagesInRow</a></td>
133 <td>Public slot to set the number of pages per row.</td>
134 </tr><tr>
135 <td><a href="#SpeedDial.setSdSize">setSdSize</a></td>
136 <td>Public slot to set the size of the speed dial.</td>
137 </tr><tr>
138 <td><a href="#SpeedDial.urlForShortcut">urlForShortcut</a></td>
139 <td>Public method to get the URL for the given shortcut key.</td>
140 </tr><tr>
141 <td><a href="#SpeedDial.urlFromUserInput">urlFromUserInput</a></td>
142 <td>Public slot to get the URL from user input.</td>
143 </tr>
144 </table>
145 <h3>Static Methods</h3>
146 <table>
147 <tr><td>None</td></tr>
148 </table>
149 <a NAME="SpeedDial.__init__" ID="SpeedDial.__init__"></a>
150 <h4>SpeedDial (Constructor)</h4>
151 <b>SpeedDial</b>(<i>parent=None</i>)
152 <p>
153 Constructor
154 </p><dl>
155 <dt><i>parent</i></dt>
156 <dd>
157 reference to the parent object (QObject)
158 </dd>
159 </dl><a NAME="SpeedDial.__cleanFrames" ID="SpeedDial.__cleanFrames"></a>
160 <h4>SpeedDial.__cleanFrames</h4>
161 <b>__cleanFrames</b>(<i></i>)
162 <p>
163 Private method to clean all frames.
164 </p><dl>
165 <dt>Returns:</dt>
166 <dd>
167 list of speed dial frames (list of QWebFrame)
168 </dd>
169 </dl><a NAME="SpeedDial.__imageFileName" ID="SpeedDial.__imageFileName"></a>
170 <h4>SpeedDial.__imageFileName</h4>
171 <b>__imageFileName</b>(<i>url</i>)
172 <p>
173 Private method to generate the image file name for a URL.
174 </p><dl>
175 <dt><i>url</i></dt>
176 <dd>
177 URL to generate the file name from (string)
178 </dd>
179 </dl><dl>
180 <dt>Returns:</dt>
181 <dd>
182 name of the image file (string)
183 </dd>
184 </dl><a NAME="SpeedDial.__initialize" ID="SpeedDial.__initialize"></a>
185 <h4>SpeedDial.__initialize</h4>
186 <b>__initialize</b>(<i></i>)
187 <p>
188 Private method to initialize the speed dial.
189 </p><a NAME="SpeedDial.__load" ID="SpeedDial.__load"></a>
190 <h4>SpeedDial.__load</h4>
191 <b>__load</b>(<i></i>)
192 <p>
193 Private method to load the speed dial configuration.
194 </p><a NAME="SpeedDial.__pagesChanged" ID="SpeedDial.__pagesChanged"></a>
195 <h4>SpeedDial.__pagesChanged</h4>
196 <b>__pagesChanged</b>(<i></i>)
197 <p>
198 Private slot to react on a change of the pages configuration.
199 </p><a NAME="SpeedDial.__thumbnailCreated" ID="SpeedDial.__thumbnailCreated"></a>
200 <h4>SpeedDial.__thumbnailCreated</h4>
201 <b>__thumbnailCreated</b>(<i>image</i>)
202 <p>
203 Private slot to handle the creation of a thumbnail image.
204 </p><dl>
205 <dt><i>image</i></dt>
206 <dd>
207 thumbnail image (QPixmap)
208 </dd>
209 </dl><a NAME="SpeedDial.addPage" ID="SpeedDial.addPage"></a>
210 <h4>SpeedDial.addPage</h4>
211 <b>addPage</b>(<i>url, title</i>)
212 <p>
213 Public method to add a page for the given data.
214 </p><dl>
215 <dt><i>url</i></dt>
216 <dd>
217 URL of the page (QUrl)
218 </dd><dt><i>title</i></dt>
219 <dd>
220 title of the page (string)
221 </dd>
222 </dl><a NAME="SpeedDial.addWebFrame" ID="SpeedDial.addWebFrame"></a>
223 <h4>SpeedDial.addWebFrame</h4>
224 <b>addWebFrame</b>(<i>frame</i>)
225 <p>
226 Public method to add a web frame.
227 </p><dl>
228 <dt><i>frame</i></dt>
229 <dd>
230 reference to the frame to be added (QWebFrame)
231 </dd>
232 </dl><a NAME="SpeedDial.changed" ID="SpeedDial.changed"></a>
233 <h4>SpeedDial.changed</h4>
234 <b>changed</b>(<i>allPages</i>)
235 <p>
236 Public slot to react on changed pages.
237 </p><dl>
238 <dt><i>allPages</i></dt>
239 <dd>
240 string giving all pages (string)
241 </dd>
242 </dl><a NAME="SpeedDial.close" ID="SpeedDial.close"></a>
243 <h4>SpeedDial.close</h4>
244 <b>close</b>(<i></i>)
245 <p>
246 Public method to close the user agents manager.
247 </p><a NAME="SpeedDial.getFileName" ID="SpeedDial.getFileName"></a>
248 <h4>SpeedDial.getFileName</h4>
249 <b>getFileName</b>(<i></i>)
250 <p>
251 Public method to get the file name of the user agents file.
252 </p><dl>
253 <dt>Returns:</dt>
254 <dd>
255 name of the user agents file (string)
256 </dd>
257 </dl><a NAME="SpeedDial.initialScript" ID="SpeedDial.initialScript"></a>
258 <h4>SpeedDial.initialScript</h4>
259 <b>initialScript</b>(<i></i>)
260 <p>
261 Public method to get the 'initial' JavaScript script.
262 </p><dl>
263 <dt>Returns:</dt>
264 <dd>
265 initial JavaScript script (string)
266 </dd>
267 </dl><a NAME="SpeedDial.loadThumbnail" ID="SpeedDial.loadThumbnail"></a>
268 <h4>SpeedDial.loadThumbnail</h4>
269 <b>loadThumbnail</b>(<i>url, loadTitle=False</i>)
270 <p>
271 Public slot to load a thumbnail of the given URL.
272 </p><dl>
273 <dt><i>url</i></dt>
274 <dd>
275 URL of the thumbnail (string)
276 </dd><dt><i>loadTitle</i></dt>
277 <dd>
278 flag indicating to get the title for the thumbnail
279 from the site (boolean)
280 </dd>
281 </dl><a NAME="SpeedDial.pageForUrl" ID="SpeedDial.pageForUrl"></a>
282 <h4>SpeedDial.pageForUrl</h4>
283 <b>pageForUrl</b>(<i>url</i>)
284 <p>
285 Public method to get the page for the given URL.
286 </p><dl>
287 <dt><i>url</i></dt>
288 <dd>
289 URL to be searched for (QUrl)
290 </dd>
291 </dl><dl>
292 <dt>Returns:</dt>
293 <dd>
294 page for the URL (Page)
295 </dd>
296 </dl><a NAME="SpeedDial.pagesInRow" ID="SpeedDial.pagesInRow"></a>
297 <h4>SpeedDial.pagesInRow</h4>
298 <b>pagesInRow</b>(<i></i>)
299 <p>
300 Public method to get the number of dials per row.
301 </p><dl>
302 <dt>Returns:</dt>
303 <dd>
304 number of dials per row (integer)
305 </dd>
306 </dl><a NAME="SpeedDial.reload" ID="SpeedDial.reload"></a>
307 <h4>SpeedDial.reload</h4>
308 <b>reload</b>(<i></i>)
309 <p>
310 Public method to reload the speed dial data.
311 </p><a NAME="SpeedDial.removeImageForUrl" ID="SpeedDial.removeImageForUrl"></a>
312 <h4>SpeedDial.removeImageForUrl</h4>
313 <b>removeImageForUrl</b>(<i>url</i>)
314 <p>
315 Public slot to remove the image for a URL.
316 </p><dl>
317 <dt><i>url</i></dt>
318 <dd>
319 URL to remove the image for (string)
320 </dd>
321 </dl><a NAME="SpeedDial.removePage" ID="SpeedDial.removePage"></a>
322 <h4>SpeedDial.removePage</h4>
323 <b>removePage</b>(<i>url</i>)
324 <p>
325 Public method to remove a page.
326 </p><dl>
327 <dt><i>url</i></dt>
328 <dd>
329 URL of the page (QUrl)
330 </dd>
331 </dl><a NAME="SpeedDial.save" ID="SpeedDial.save"></a>
332 <h4>SpeedDial.save</h4>
333 <b>save</b>(<i></i>)
334 <p>
335 Public method to save the speed dial configuration.
336 </p><a NAME="SpeedDial.sdSize" ID="SpeedDial.sdSize"></a>
337 <h4>SpeedDial.sdSize</h4>
338 <b>sdSize</b>(<i></i>)
339 <p>
340 Public method to get the speed dial size.
341 </p><dl>
342 <dt>Returns:</dt>
343 <dd>
344 speed dial size (integer)
345 </dd>
346 </dl><a NAME="SpeedDial.setPagesInRow" ID="SpeedDial.setPagesInRow"></a>
347 <h4>SpeedDial.setPagesInRow</h4>
348 <b>setPagesInRow</b>(<i>count</i>)
349 <p>
350 Public slot to set the number of pages per row.
351 </p><dl>
352 <dt><i>count</i></dt>
353 <dd>
354 number of pages per row (integer)
355 </dd>
356 </dl><a NAME="SpeedDial.setSdSize" ID="SpeedDial.setSdSize"></a>
357 <h4>SpeedDial.setSdSize</h4>
358 <b>setSdSize</b>(<i>size</i>)
359 <p>
360 Public slot to set the size of the speed dial.
361 </p><dl>
362 <dt><i>size</i></dt>
363 <dd>
364 size of the speed dial (integer)
365 </dd>
366 </dl><a NAME="SpeedDial.urlForShortcut" ID="SpeedDial.urlForShortcut"></a>
367 <h4>SpeedDial.urlForShortcut</h4>
368 <b>urlForShortcut</b>(<i>key</i>)
369 <p>
370 Public method to get the URL for the given shortcut key.
371 </p><dl>
372 <dt><i>key</i></dt>
373 <dd>
374 shortcut key (integer)
375 </dd>
376 </dl><dl>
377 <dt>Returns:</dt>
378 <dd>
379 URL for the key (QUrl)
380 </dd>
381 </dl><a NAME="SpeedDial.urlFromUserInput" ID="SpeedDial.urlFromUserInput"></a>
382 <h4>SpeedDial.urlFromUserInput</h4>
383 <b>urlFromUserInput</b>(<i>url</i>)
384 <p>
385 Public slot to get the URL from user input.
386 </p><dl>
387 <dt><i>url</i></dt>
388 <dd>
389 URL entered by the user (string)
390 </dd>
391 </dl><dl>
392 <dt>Returns:</dt>
393 <dd>
394 sanitized URL (string)
395 </dd>
396 </dl>
397 <div align="right"><a href="#top">Up</a></div>
398 <hr />
399 </body></html>

Mercurial Repository: eric

eric ide

mercurial