Documentation/Source/eric5.Helpviewer.SpeedDial.SpeedDial.html

changeset 1699
10706f6ad9d2
parent 1670
6fd889391d2c
child 1702
870ee0fa9007
equal deleted inserted replaced
1698:dba994e19891 1699:10706f6ad9d2
29 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
30 </table> 30 </table>
31 <h3>Classes</h3> 31 <h3>Classes</h3>
32 <table> 32 <table>
33 <tr> 33 <tr>
34 <td><a href="#Page">Page</a></td>
35 <td>Class to hold the data for a speed dial page.</td>
36 </tr><tr>
37 <td><a href="#SpeedDial">SpeedDial</a></td> 34 <td><a href="#SpeedDial">SpeedDial</a></td>
38 <td>Class implementing the speed dial.</td> 35 <td>Class implementing the speed dial.</td>
39 </tr> 36 </tr>
40 </table> 37 </table>
41 <h3>Functions</h3> 38 <h3>Functions</h3>
42 <table> 39 <table>
43 <tr><td>None</td></tr> 40 <tr><td>None</td></tr>
44 </table> 41 </table>
45 <hr /><hr />
46 <a NAME="Page" ID="Page"></a>
47 <h2>Page</h2>
48 <p>
49 Class to hold the data for a speed dial page.
50 </p>
51 <h3>Derived from</h3>
52 object
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62 <table>
63 <tr>
64 <td><a href="#Page.__init__">Page</a></td>
65 <td>Constructor</td>
66 </tr><tr>
67 <td><a href="#Page.__eq__">__eq__</a></td>
68 <td>Public method implementing the equality operator.</td>
69 </tr>
70 </table>
71 <h3>Static Methods</h3>
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <a NAME="Page.__init__" ID="Page.__init__"></a>
76 <h4>Page (Constructor)</h4>
77 <b>Page</b>(<i>url="", title="", broken=False</i>)
78 <p>
79 Constructor
80 </p><dl>
81 <dt><i>url</i></dt>
82 <dd>
83 URL of the page (string)
84 </dd><dt><i>title</i></dt>
85 <dd>
86 title of the page (string)
87 </dd>
88 </dl><a NAME="Page.__eq__" ID="Page.__eq__"></a>
89 <h4>Page.__eq__</h4>
90 <b>__eq__</b>(<i>other</i>)
91 <p>
92 Public method implementing the equality operator.
93 </p><dl>
94 <dt><i>other</i></dt>
95 <dd>
96 reference to the other page object (Page)
97 </dd>
98 </dl><dl>
99 <dt>Returns:</dt>
100 <dd>
101 flag indicating equality (boolean)
102 </dd>
103 </dl>
104 <div align="right"><a href="#top">Up</a></div>
105 <hr /><hr /> 42 <hr /><hr />
106 <a NAME="SpeedDial" ID="SpeedDial"></a> 43 <a NAME="SpeedDial" ID="SpeedDial"></a>
107 <h2>SpeedDial</h2> 44 <h2>SpeedDial</h2>
108 <p> 45 <p>
109 Class implementing the speed dial. 46 Class implementing the speed dial.
110 </p><h3>Signals</h3> 47 </p><h3>Signals</h3>
111 <dl> 48 <dl>
112 <dt>pagesChanged()</dt> 49 <dt>pagesChanged()</dt>
113 <dd> 50 <dd>
114 emitted after the list of pages changed 51 emitted after the list of pages changed
52 </dd><dt>speedDialSaved()</dt>
53 <dd>
54 emitted after the speed dial data was saved
115 </dd> 55 </dd>
116 </dl> 56 </dl>
117 <h3>Derived from</h3> 57 <h3>Derived from</h3>
118 QObject 58 QObject
119 <h3>Class Attributes</h3> 59 <h3>Class Attributes</h3>
131 <td>Constructor</td> 71 <td>Constructor</td>
132 </tr><tr> 72 </tr><tr>
133 <td><a href="#SpeedDial.__cleanFrames">__cleanFrames</a></td> 73 <td><a href="#SpeedDial.__cleanFrames">__cleanFrames</a></td>
134 <td>Private method to clean all frames.</td> 74 <td>Private method to clean all frames.</td>
135 </tr><tr> 75 </tr><tr>
136 <td><a href="#SpeedDial.__generateAllPages">__generateAllPages</a></td>
137 <td>Private method to generate s string with all pages managed by the speed dial.</td>
138 </tr><tr>
139 <td><a href="#SpeedDial.__imageFileName">__imageFileName</a></td> 76 <td><a href="#SpeedDial.__imageFileName">__imageFileName</a></td>
140 <td>Private method to generate the image file name for a URL.</td> 77 <td>Private method to generate the image file name for a URL.</td>
141 </tr><tr> 78 </tr><tr>
142 <td><a href="#SpeedDial.__initialize">__initialize</a></td> 79 <td><a href="#SpeedDial.__initialize">__initialize</a></td>
143 <td>Private method to initialize the speed dial.</td> 80 <td>Private method to initialize the speed dial.</td>
144 </tr><tr> 81 </tr><tr>
82 <td><a href="#SpeedDial.__load">__load</a></td>
83 <td>Private method to load the speed dial configuration.</td>
84 </tr><tr>
145 <td><a href="#SpeedDial.__pagesChanged">__pagesChanged</a></td> 85 <td><a href="#SpeedDial.__pagesChanged">__pagesChanged</a></td>
146 <td>Private slot to react on a change of the pages configuration.</td> 86 <td>Private slot to react on a change of the pages configuration.</td>
147 </tr><tr> 87 </tr><tr>
148 <td><a href="#SpeedDial.__thumbnailCreated">__thumbnailCreated</a></td> 88 <td><a href="#SpeedDial.__thumbnailCreated">__thumbnailCreated</a></td>
149 <td>Private slot to handle the creation of a thumbnail image.</td> 89 <td>Private slot to handle the creation of a thumbnail image.</td>
155 <td>Public method to add a web frame.</td> 95 <td>Public method to add a web frame.</td>
156 </tr><tr> 96 </tr><tr>
157 <td><a href="#SpeedDial.changed">changed</a></td> 97 <td><a href="#SpeedDial.changed">changed</a></td>
158 <td>Public slot to react on changed pages.</td> 98 <td>Public slot to react on changed pages.</td>
159 </tr><tr> 99 </tr><tr>
100 <td><a href="#SpeedDial.close">close</a></td>
101 <td>Public method to close the user agents manager.</td>
102 </tr><tr>
103 <td><a href="#SpeedDial.getFileName">getFileName</a></td>
104 <td>Public method to get the file name of the user agents file.</td>
105 </tr><tr>
160 <td><a href="#SpeedDial.initialScript">initialScript</a></td> 106 <td><a href="#SpeedDial.initialScript">initialScript</a></td>
161 <td>Public method to get the 'initial' JavaScript script.</td> 107 <td>Public method to get the 'initial' JavaScript script.</td>
162 </tr><tr> 108 </tr><tr>
163 <td><a href="#SpeedDial.loadThumbnail">loadThumbnail</a></td> 109 <td><a href="#SpeedDial.loadThumbnail">loadThumbnail</a></td>
164 <td>Public slot to load a thumbnail of the given URL.</td> 110 <td>Public slot to load a thumbnail of the given URL.</td>
172 <td><a href="#SpeedDial.removeImageForUrl">removeImageForUrl</a></td> 118 <td><a href="#SpeedDial.removeImageForUrl">removeImageForUrl</a></td>
173 <td>Public slot to remove the image for a URL.</td> 119 <td>Public slot to remove the image for a URL.</td>
174 </tr><tr> 120 </tr><tr>
175 <td><a href="#SpeedDial.removePage">removePage</a></td> 121 <td><a href="#SpeedDial.removePage">removePage</a></td>
176 <td>Public method to remove a page.</td> 122 <td>Public method to remove a page.</td>
123 </tr><tr>
124 <td><a href="#SpeedDial.save">save</a></td>
125 <td>Public method to save the speed dial configuration.</td>
177 </tr><tr> 126 </tr><tr>
178 <td><a href="#SpeedDial.sdSize">sdSize</a></td> 127 <td><a href="#SpeedDial.sdSize">sdSize</a></td>
179 <td>Public method to get the speed dial size.</td> 128 <td>Public method to get the speed dial size.</td>
180 </tr><tr> 129 </tr><tr>
181 <td><a href="#SpeedDial.setPagesInRow">setPagesInRow</a></td> 130 <td><a href="#SpeedDial.setPagesInRow">setPagesInRow</a></td>
213 </p><dl> 162 </p><dl>
214 <dt>Returns:</dt> 163 <dt>Returns:</dt>
215 <dd> 164 <dd>
216 list of speed dial frames (list of QWebFrame) 165 list of speed dial frames (list of QWebFrame)
217 </dd> 166 </dd>
218 </dl><a NAME="SpeedDial.__generateAllPages" ID="SpeedDial.__generateAllPages"></a>
219 <h4>SpeedDial.__generateAllPages</h4>
220 <b>__generateAllPages</b>(<i></i>)
221 <p>
222 Private method to generate s string with all pages managed by the speed dial.
223 </p><dl>
224 <dt>Returns:</dt>
225 <dd>
226 string with all pages (string)
227 </dd>
228 </dl><a NAME="SpeedDial.__imageFileName" ID="SpeedDial.__imageFileName"></a> 167 </dl><a NAME="SpeedDial.__imageFileName" ID="SpeedDial.__imageFileName"></a>
229 <h4>SpeedDial.__imageFileName</h4> 168 <h4>SpeedDial.__imageFileName</h4>
230 <b>__imageFileName</b>(<i>url</i>) 169 <b>__imageFileName</b>(<i>url</i>)
231 <p> 170 <p>
232 Private method to generate the image file name for a URL. 171 Private method to generate the image file name for a URL.
243 </dl><a NAME="SpeedDial.__initialize" ID="SpeedDial.__initialize"></a> 182 </dl><a NAME="SpeedDial.__initialize" ID="SpeedDial.__initialize"></a>
244 <h4>SpeedDial.__initialize</h4> 183 <h4>SpeedDial.__initialize</h4>
245 <b>__initialize</b>(<i></i>) 184 <b>__initialize</b>(<i></i>)
246 <p> 185 <p>
247 Private method to initialize the speed dial. 186 Private method to initialize the speed dial.
187 </p><a NAME="SpeedDial.__load" ID="SpeedDial.__load"></a>
188 <h4>SpeedDial.__load</h4>
189 <b>__load</b>(<i></i>)
190 <p>
191 Private method to load the speed dial configuration.
248 </p><a NAME="SpeedDial.__pagesChanged" ID="SpeedDial.__pagesChanged"></a> 192 </p><a NAME="SpeedDial.__pagesChanged" ID="SpeedDial.__pagesChanged"></a>
249 <h4>SpeedDial.__pagesChanged</h4> 193 <h4>SpeedDial.__pagesChanged</h4>
250 <b>__pagesChanged</b>(<i></i>) 194 <b>__pagesChanged</b>(<i></i>)
251 <p> 195 <p>
252 Private slot to react on a change of the pages configuration. 196 Private slot to react on a change of the pages configuration.
291 </p><dl> 235 </p><dl>
292 <dt><i>allPages</i></dt> 236 <dt><i>allPages</i></dt>
293 <dd> 237 <dd>
294 string giving all pages (string) 238 string giving all pages (string)
295 </dd> 239 </dd>
240 </dl><a NAME="SpeedDial.close" ID="SpeedDial.close"></a>
241 <h4>SpeedDial.close</h4>
242 <b>close</b>(<i></i>)
243 <p>
244 Public method to close the user agents manager.
245 </p><a NAME="SpeedDial.getFileName" ID="SpeedDial.getFileName"></a>
246 <h4>SpeedDial.getFileName</h4>
247 <b>getFileName</b>(<i></i>)
248 <p>
249 Public method to get the file name of the user agents file.
250 </p><dl>
251 <dt>Returns:</dt>
252 <dd>
253 name of the user agents file (string)
254 </dd>
296 </dl><a NAME="SpeedDial.initialScript" ID="SpeedDial.initialScript"></a> 255 </dl><a NAME="SpeedDial.initialScript" ID="SpeedDial.initialScript"></a>
297 <h4>SpeedDial.initialScript</h4> 256 <h4>SpeedDial.initialScript</h4>
298 <b>initialScript</b>(<i></i>) 257 <b>initialScript</b>(<i></i>)
299 <p> 258 <p>
300 Public method to get the 'initial' JavaScript script. 259 Public method to get the 'initial' JavaScript script.
360 </p><dl> 319 </p><dl>
361 <dt><i>url</i></dt> 320 <dt><i>url</i></dt>
362 <dd> 321 <dd>
363 URL of the page (QUrl) 322 URL of the page (QUrl)
364 </dd> 323 </dd>
365 </dl><a NAME="SpeedDial.sdSize" ID="SpeedDial.sdSize"></a> 324 </dl><a NAME="SpeedDial.save" ID="SpeedDial.save"></a>
325 <h4>SpeedDial.save</h4>
326 <b>save</b>(<i></i>)
327 <p>
328 Public method to save the speed dial configuration.
329 </p><a NAME="SpeedDial.sdSize" ID="SpeedDial.sdSize"></a>
366 <h4>SpeedDial.sdSize</h4> 330 <h4>SpeedDial.sdSize</h4>
367 <b>sdSize</b>(<i></i>) 331 <b>sdSize</b>(<i></i>)
368 <p> 332 <p>
369 Public method to get the speed dial size. 333 Public method to get the speed dial size.
370 </p><dl> 334 </p><dl>

eric ide

mercurial