|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Preferences.ConfigurationDialog</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.Preferences.ConfigurationDialog</h1> |
|
23 <p> |
|
24 Module implementing a dialog for the configuration of eric6. |
|
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="#ConfigurationDialog">ConfigurationDialog</a></td> |
|
34 <td>Class for the dialog variant.</td> |
|
35 </tr><tr> |
|
36 <td><a href="#ConfigurationPageItem">ConfigurationPageItem</a></td> |
|
37 <td>Class implementing a QTreeWidgetItem holding the configuration page data.</td> |
|
38 </tr><tr> |
|
39 <td><a href="#ConfigurationWidget">ConfigurationWidget</a></td> |
|
40 <td>Class implementing a dialog for the configuration of eric6.</td> |
|
41 </tr><tr> |
|
42 <td><a href="#ConfigurationWindow">ConfigurationWindow</a></td> |
|
43 <td>Main window class for the standalone dialog.</td> |
|
44 </tr> |
|
45 </table> |
|
46 <h3>Functions</h3> |
|
47 <table> |
|
48 <tr><td>None</td></tr> |
|
49 </table> |
|
50 <hr /><hr /> |
|
51 <a NAME="ConfigurationDialog" ID="ConfigurationDialog"></a> |
|
52 <h2>ConfigurationDialog</h2> |
|
53 <p> |
|
54 Class for the dialog variant. |
|
55 </p><h3>Signals</h3> |
|
56 <dl> |
|
57 <dt>masterPasswordChanged(str, str)</dt> |
|
58 <dd> |
|
59 emitted after the master |
|
60 password has been changed with the old and the new password |
|
61 </dd><dt>preferencesChanged()</dt> |
|
62 <dd> |
|
63 emitted after settings have been changed |
|
64 </dd> |
|
65 </dl> |
|
66 <h3>Derived from</h3> |
|
67 QDialog |
|
68 <h3>Class Attributes</h3> |
|
69 <table> |
|
70 <tr><td>DefaultMode</td></tr><tr><td>HelpBrowserMode</td></tr><tr><td>TrayStarterMode</td></tr> |
|
71 </table> |
|
72 <h3>Class Methods</h3> |
|
73 <table> |
|
74 <tr><td>None</td></tr> |
|
75 </table> |
|
76 <h3>Methods</h3> |
|
77 <table> |
|
78 <tr> |
|
79 <td><a href="#ConfigurationDialog.__init__">ConfigurationDialog</a></td> |
|
80 <td>Constructor</td> |
|
81 </tr><tr> |
|
82 <td><a href="#ConfigurationDialog.__masterPasswordChanged">__masterPasswordChanged</a></td> |
|
83 <td>Private slot to handle the change of the master password.</td> |
|
84 </tr><tr> |
|
85 <td><a href="#ConfigurationDialog.__preferencesChanged">__preferencesChanged</a></td> |
|
86 <td>Private slot to handle a change of the preferences.</td> |
|
87 </tr><tr> |
|
88 <td><a href="#ConfigurationDialog.accept">accept</a></td> |
|
89 <td>Public method to accept the dialog.</td> |
|
90 </tr><tr> |
|
91 <td><a href="#ConfigurationDialog.getConfigurationPageName">getConfigurationPageName</a></td> |
|
92 <td>Public method to get the page name of the current page.</td> |
|
93 </tr><tr> |
|
94 <td><a href="#ConfigurationDialog.setPreferences">setPreferences</a></td> |
|
95 <td>Public method called to store the selected values into the preferences storage.</td> |
|
96 </tr><tr> |
|
97 <td><a href="#ConfigurationDialog.showConfigurationPageByName">showConfigurationPageByName</a></td> |
|
98 <td>Public slot to show a named configuration page.</td> |
|
99 </tr> |
|
100 </table> |
|
101 <h3>Static Methods</h3> |
|
102 <table> |
|
103 <tr><td>None</td></tr> |
|
104 </table> |
|
105 <a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a> |
|
106 <h4>ConfigurationDialog (Constructor)</h4> |
|
107 <b>ConfigurationDialog</b>(<i>parent=None, name=None, modal=False, fromEric=True, displayMode=ConfigurationWidget.DefaultMode</i>) |
|
108 <p> |
|
109 Constructor |
|
110 </p><dl> |
|
111 <dt><i>parent</i></dt> |
|
112 <dd> |
|
113 The parent widget of this dialog. (QWidget) |
|
114 </dd><dt><i>name</i></dt> |
|
115 <dd> |
|
116 The name of this dialog. string |
|
117 </dd><dt><i>modal</i></dt> |
|
118 <dd> |
|
119 Flag indicating a modal dialog. (boolean) |
|
120 </dd><dt><i>fromEric=</i></dt> |
|
121 <dd> |
|
122 flag indicating a dialog generation from within the |
|
123 eric6 ide (boolean) |
|
124 </dd><dt><i>displayMode=</i></dt> |
|
125 <dd> |
|
126 mode of the configuration dialog |
|
127 (DefaultMode, HelpBrowserMode, TrayStarterMode) |
|
128 </dd> |
|
129 </dl><a NAME="ConfigurationDialog.__masterPasswordChanged" ID="ConfigurationDialog.__masterPasswordChanged"></a> |
|
130 <h4>ConfigurationDialog.__masterPasswordChanged</h4> |
|
131 <b>__masterPasswordChanged</b>(<i>oldPassword, newPassword</i>) |
|
132 <p> |
|
133 Private slot to handle the change of the master password. |
|
134 </p><dl> |
|
135 <dt><i>oldPassword</i></dt> |
|
136 <dd> |
|
137 current master password (string) |
|
138 </dd><dt><i>newPassword</i></dt> |
|
139 <dd> |
|
140 new master password (string) |
|
141 </dd> |
|
142 </dl><a NAME="ConfigurationDialog.__preferencesChanged" ID="ConfigurationDialog.__preferencesChanged"></a> |
|
143 <h4>ConfigurationDialog.__preferencesChanged</h4> |
|
144 <b>__preferencesChanged</b>(<i></i>) |
|
145 <p> |
|
146 Private slot to handle a change of the preferences. |
|
147 </p><a NAME="ConfigurationDialog.accept" ID="ConfigurationDialog.accept"></a> |
|
148 <h4>ConfigurationDialog.accept</h4> |
|
149 <b>accept</b>(<i></i>) |
|
150 <p> |
|
151 Public method to accept the dialog. |
|
152 </p><a NAME="ConfigurationDialog.getConfigurationPageName" ID="ConfigurationDialog.getConfigurationPageName"></a> |
|
153 <h4>ConfigurationDialog.getConfigurationPageName</h4> |
|
154 <b>getConfigurationPageName</b>(<i></i>) |
|
155 <p> |
|
156 Public method to get the page name of the current page. |
|
157 </p><dl> |
|
158 <dt>Returns:</dt> |
|
159 <dd> |
|
160 page name of the current page (string) |
|
161 </dd> |
|
162 </dl><a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a> |
|
163 <h4>ConfigurationDialog.setPreferences</h4> |
|
164 <b>setPreferences</b>(<i></i>) |
|
165 <p> |
|
166 Public method called to store the selected values into the preferences |
|
167 storage. |
|
168 </p><a NAME="ConfigurationDialog.showConfigurationPageByName" ID="ConfigurationDialog.showConfigurationPageByName"></a> |
|
169 <h4>ConfigurationDialog.showConfigurationPageByName</h4> |
|
170 <b>showConfigurationPageByName</b>(<i>pageName</i>) |
|
171 <p> |
|
172 Public slot to show a named configuration page. |
|
173 </p><dl> |
|
174 <dt><i>pageName</i></dt> |
|
175 <dd> |
|
176 name of the configuration page to show (string) |
|
177 </dd> |
|
178 </dl> |
|
179 <div align="right"><a href="#top">Up</a></div> |
|
180 <hr /><hr /> |
|
181 <a NAME="ConfigurationPageItem" ID="ConfigurationPageItem"></a> |
|
182 <h2>ConfigurationPageItem</h2> |
|
183 <p> |
|
184 Class implementing a QTreeWidgetItem holding the configuration page data. |
|
185 </p> |
|
186 <h3>Derived from</h3> |
|
187 QTreeWidgetItem |
|
188 <h3>Class Attributes</h3> |
|
189 <table> |
|
190 <tr><td>None</td></tr> |
|
191 </table> |
|
192 <h3>Class Methods</h3> |
|
193 <table> |
|
194 <tr><td>None</td></tr> |
|
195 </table> |
|
196 <h3>Methods</h3> |
|
197 <table> |
|
198 <tr> |
|
199 <td><a href="#ConfigurationPageItem.__init__">ConfigurationPageItem</a></td> |
|
200 <td>Constructor</td> |
|
201 </tr><tr> |
|
202 <td><a href="#ConfigurationPageItem.getPageName">getPageName</a></td> |
|
203 <td>Public method to get the name of the associated configuration page.</td> |
|
204 </tr> |
|
205 </table> |
|
206 <h3>Static Methods</h3> |
|
207 <table> |
|
208 <tr><td>None</td></tr> |
|
209 </table> |
|
210 <a NAME="ConfigurationPageItem.__init__" ID="ConfigurationPageItem.__init__"></a> |
|
211 <h4>ConfigurationPageItem (Constructor)</h4> |
|
212 <b>ConfigurationPageItem</b>(<i>parent, text, pageName, iconFile</i>) |
|
213 <p> |
|
214 Constructor |
|
215 </p><dl> |
|
216 <dt><i>parent</i></dt> |
|
217 <dd> |
|
218 parent widget of the item (QTreeWidget or |
|
219 QTreeWidgetItem) |
|
220 </dd><dt><i>text</i></dt> |
|
221 <dd> |
|
222 text to be displayed (string) |
|
223 </dd><dt><i>pageName</i></dt> |
|
224 <dd> |
|
225 name of the configuration page (string) |
|
226 </dd><dt><i>iconFile</i></dt> |
|
227 <dd> |
|
228 file name of the icon to be shown (string) |
|
229 </dd> |
|
230 </dl><a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a> |
|
231 <h4>ConfigurationPageItem.getPageName</h4> |
|
232 <b>getPageName</b>(<i></i>) |
|
233 <p> |
|
234 Public method to get the name of the associated configuration page. |
|
235 </p><dl> |
|
236 <dt>Returns:</dt> |
|
237 <dd> |
|
238 name of the configuration page (string) |
|
239 </dd> |
|
240 </dl> |
|
241 <div align="right"><a href="#top">Up</a></div> |
|
242 <hr /><hr /> |
|
243 <a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a> |
|
244 <h2>ConfigurationWidget</h2> |
|
245 <p> |
|
246 Class implementing a dialog for the configuration of eric6. |
|
247 </p><h3>Signals</h3> |
|
248 <dl> |
|
249 <dt>accepted()</dt> |
|
250 <dd> |
|
251 emitted to indicate acceptance of the changes |
|
252 </dd><dt>masterPasswordChanged(str, str)</dt> |
|
253 <dd> |
|
254 emitted after the master |
|
255 password has been changed with the old and the new password |
|
256 </dd><dt>preferencesChanged()</dt> |
|
257 <dd> |
|
258 emitted after settings have been changed |
|
259 </dd><dt>rejected()</dt> |
|
260 <dd> |
|
261 emitted to indicate rejection of the changes |
|
262 </dd> |
|
263 </dl> |
|
264 <h3>Derived from</h3> |
|
265 QWidget |
|
266 <h3>Class Attributes</h3> |
|
267 <table> |
|
268 <tr><td>DefaultMode</td></tr><tr><td>HelpBrowserMode</td></tr><tr><td>TrayStarterMode</td></tr> |
|
269 </table> |
|
270 <h3>Class Methods</h3> |
|
271 <table> |
|
272 <tr><td>None</td></tr> |
|
273 </table> |
|
274 <h3>Methods</h3> |
|
275 <table> |
|
276 <tr> |
|
277 <td><a href="#ConfigurationWidget.__init__">ConfigurationWidget</a></td> |
|
278 <td>Constructor</td> |
|
279 </tr><tr> |
|
280 <td><a href="#ConfigurationWidget.__filterChildItems">__filterChildItems</a></td> |
|
281 <td>Private method to filter child items based on a filter string.</td> |
|
282 </tr><tr> |
|
283 <td><a href="#ConfigurationWidget.__filterTextChanged">__filterTextChanged</a></td> |
|
284 <td>Private slot to handle a change of the filter.</td> |
|
285 </tr><tr> |
|
286 <td><a href="#ConfigurationWidget.__importConfigurationPage">__importConfigurationPage</a></td> |
|
287 <td>Private method to import a configuration page module.</td> |
|
288 </tr><tr> |
|
289 <td><a href="#ConfigurationWidget.__initLexers">__initLexers</a></td> |
|
290 <td>Private method to initialize the dictionary of preferences lexers.</td> |
|
291 </tr><tr> |
|
292 <td><a href="#ConfigurationWidget.__initPage">__initPage</a></td> |
|
293 <td>Private method to initialize a configuration page.</td> |
|
294 </tr><tr> |
|
295 <td><a href="#ConfigurationWidget.__setupUi">__setupUi</a></td> |
|
296 <td>Private method to perform the general setup of the configuration widget.</td> |
|
297 </tr><tr> |
|
298 <td><a href="#ConfigurationWidget.__showConfigurationPage">__showConfigurationPage</a></td> |
|
299 <td>Private slot to show a selected configuration page.</td> |
|
300 </tr><tr> |
|
301 <td><a href="#ConfigurationWidget.accept">accept</a></td> |
|
302 <td>Public slot to accept the buttonBox accept signal.</td> |
|
303 </tr><tr> |
|
304 <td><a href="#ConfigurationWidget.calledFromEric">calledFromEric</a></td> |
|
305 <td>Public method to check, if invoked from within eric.</td> |
|
306 </tr><tr> |
|
307 <td><a href="#ConfigurationWidget.getConfigurationPageName">getConfigurationPageName</a></td> |
|
308 <td>Public method to get the page name of the current page.</td> |
|
309 </tr><tr> |
|
310 <td><a href="#ConfigurationWidget.getLexers">getLexers</a></td> |
|
311 <td>Public method to get a reference to the lexers dictionary.</td> |
|
312 </tr><tr> |
|
313 <td><a href="#ConfigurationWidget.getPage">getPage</a></td> |
|
314 <td>Public method to get a reference to the named page.</td> |
|
315 </tr><tr> |
|
316 <td><a href="#ConfigurationWidget.on_applyButton_clicked">on_applyButton_clicked</a></td> |
|
317 <td>Private slot called to apply the settings of the current page.</td> |
|
318 </tr><tr> |
|
319 <td><a href="#ConfigurationWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
320 <td>Private slot called by a button of the button box clicked.</td> |
|
321 </tr><tr> |
|
322 <td><a href="#ConfigurationWidget.on_resetButton_clicked">on_resetButton_clicked</a></td> |
|
323 <td>Private slot called to reset the settings of the current page.</td> |
|
324 </tr><tr> |
|
325 <td><a href="#ConfigurationWidget.setPreferences">setPreferences</a></td> |
|
326 <td>Public method called to store the selected values into the preferences storage.</td> |
|
327 </tr><tr> |
|
328 <td><a href="#ConfigurationWidget.showConfigurationPageByName">showConfigurationPageByName</a></td> |
|
329 <td>Public slot to show a named configuration page.</td> |
|
330 </tr> |
|
331 </table> |
|
332 <h3>Static Methods</h3> |
|
333 <table> |
|
334 <tr><td>None</td></tr> |
|
335 </table> |
|
336 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a> |
|
337 <h4>ConfigurationWidget (Constructor)</h4> |
|
338 <b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=DefaultMode</i>) |
|
339 <p> |
|
340 Constructor |
|
341 </p><dl> |
|
342 <dt><i>parent</i></dt> |
|
343 <dd> |
|
344 The parent widget of this dialog. (QWidget) |
|
345 </dd><dt><i>fromEric=</i></dt> |
|
346 <dd> |
|
347 flag indicating a dialog generation from within the |
|
348 eric6 ide (boolean) |
|
349 </dd><dt><i>displayMode=</i></dt> |
|
350 <dd> |
|
351 mode of the configuration dialog |
|
352 (DefaultMode, HelpBrowserMode, TrayStarterMode) |
|
353 </dd> |
|
354 </dl><dl> |
|
355 <dt>Raises <b>RuntimeError</b>:</dt> |
|
356 <dd> |
|
357 raised to indicate an invalid dialog mode |
|
358 </dd> |
|
359 </dl><a NAME="ConfigurationWidget.__filterChildItems" ID="ConfigurationWidget.__filterChildItems"></a> |
|
360 <h4>ConfigurationWidget.__filterChildItems</h4> |
|
361 <b>__filterChildItems</b>(<i>parent, filter</i>) |
|
362 <p> |
|
363 Private method to filter child items based on a filter string. |
|
364 </p><dl> |
|
365 <dt><i>parent</i></dt> |
|
366 <dd> |
|
367 reference to the parent item (QTreeWidgetItem) |
|
368 </dd><dt><i>filter</i></dt> |
|
369 <dd> |
|
370 filter string (string) |
|
371 </dd> |
|
372 </dl><dl> |
|
373 <dt>Returns:</dt> |
|
374 <dd> |
|
375 flag indicating a visible child item (boolean) |
|
376 </dd> |
|
377 </dl><a NAME="ConfigurationWidget.__filterTextChanged" ID="ConfigurationWidget.__filterTextChanged"></a> |
|
378 <h4>ConfigurationWidget.__filterTextChanged</h4> |
|
379 <b>__filterTextChanged</b>(<i>filter</i>) |
|
380 <p> |
|
381 Private slot to handle a change of the filter. |
|
382 </p><dl> |
|
383 <dt><i>filter</i></dt> |
|
384 <dd> |
|
385 text of the filter line edit (string) |
|
386 </dd> |
|
387 </dl><a NAME="ConfigurationWidget.__importConfigurationPage" ID="ConfigurationWidget.__importConfigurationPage"></a> |
|
388 <h4>ConfigurationWidget.__importConfigurationPage</h4> |
|
389 <b>__importConfigurationPage</b>(<i>name</i>) |
|
390 <p> |
|
391 Private method to import a configuration page module. |
|
392 </p><dl> |
|
393 <dt><i>name</i></dt> |
|
394 <dd> |
|
395 name of the configuration page module (string) |
|
396 </dd> |
|
397 </dl><dl> |
|
398 <dt>Returns:</dt> |
|
399 <dd> |
|
400 reference to the configuration page module |
|
401 </dd> |
|
402 </dl><a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a> |
|
403 <h4>ConfigurationWidget.__initLexers</h4> |
|
404 <b>__initLexers</b>(<i></i>) |
|
405 <p> |
|
406 Private method to initialize the dictionary of preferences lexers. |
|
407 </p><a NAME="ConfigurationWidget.__initPage" ID="ConfigurationWidget.__initPage"></a> |
|
408 <h4>ConfigurationWidget.__initPage</h4> |
|
409 <b>__initPage</b>(<i>pageData</i>) |
|
410 <p> |
|
411 Private method to initialize a configuration page. |
|
412 </p><dl> |
|
413 <dt><i>pageData</i></dt> |
|
414 <dd> |
|
415 data structure for the page to initialize |
|
416 </dd> |
|
417 </dl><dl> |
|
418 <dt>Returns:</dt> |
|
419 <dd> |
|
420 reference to the initialized page |
|
421 </dd> |
|
422 </dl><a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a> |
|
423 <h4>ConfigurationWidget.__setupUi</h4> |
|
424 <b>__setupUi</b>(<i></i>) |
|
425 <p> |
|
426 Private method to perform the general setup of the configuration |
|
427 widget. |
|
428 </p><a NAME="ConfigurationWidget.__showConfigurationPage" ID="ConfigurationWidget.__showConfigurationPage"></a> |
|
429 <h4>ConfigurationWidget.__showConfigurationPage</h4> |
|
430 <b>__showConfigurationPage</b>(<i>itm, column</i>) |
|
431 <p> |
|
432 Private slot to show a selected configuration page. |
|
433 </p><dl> |
|
434 <dt><i>itm</i></dt> |
|
435 <dd> |
|
436 reference to the selected item (QTreeWidgetItem) |
|
437 </dd><dt><i>column</i></dt> |
|
438 <dd> |
|
439 column that was selected (integer) (ignored) |
|
440 </dd> |
|
441 </dl><a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a> |
|
442 <h4>ConfigurationWidget.accept</h4> |
|
443 <b>accept</b>(<i></i>) |
|
444 <p> |
|
445 Public slot to accept the buttonBox accept signal. |
|
446 </p><a NAME="ConfigurationWidget.calledFromEric" ID="ConfigurationWidget.calledFromEric"></a> |
|
447 <h4>ConfigurationWidget.calledFromEric</h4> |
|
448 <b>calledFromEric</b>(<i></i>) |
|
449 <p> |
|
450 Public method to check, if invoked from within eric. |
|
451 </p><dl> |
|
452 <dt>Returns:</dt> |
|
453 <dd> |
|
454 flag indicating invocation from within eric (boolean) |
|
455 </dd> |
|
456 </dl><a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a> |
|
457 <h4>ConfigurationWidget.getConfigurationPageName</h4> |
|
458 <b>getConfigurationPageName</b>(<i></i>) |
|
459 <p> |
|
460 Public method to get the page name of the current page. |
|
461 </p><dl> |
|
462 <dt>Returns:</dt> |
|
463 <dd> |
|
464 page name of the current page (string) |
|
465 </dd> |
|
466 </dl><a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a> |
|
467 <h4>ConfigurationWidget.getLexers</h4> |
|
468 <b>getLexers</b>(<i></i>) |
|
469 <p> |
|
470 Public method to get a reference to the lexers dictionary. |
|
471 </p><dl> |
|
472 <dt>Returns:</dt> |
|
473 <dd> |
|
474 reference to the lexers dictionary |
|
475 </dd> |
|
476 </dl><a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a> |
|
477 <h4>ConfigurationWidget.getPage</h4> |
|
478 <b>getPage</b>(<i>pageName</i>) |
|
479 <p> |
|
480 Public method to get a reference to the named page. |
|
481 </p><dl> |
|
482 <dt><i>pageName</i></dt> |
|
483 <dd> |
|
484 name of the configuration page (string) |
|
485 </dd> |
|
486 </dl><dl> |
|
487 <dt>Returns:</dt> |
|
488 <dd> |
|
489 reference to the page or None, indicating page was |
|
490 not loaded yet |
|
491 </dd> |
|
492 </dl><a NAME="ConfigurationWidget.on_applyButton_clicked" ID="ConfigurationWidget.on_applyButton_clicked"></a> |
|
493 <h4>ConfigurationWidget.on_applyButton_clicked</h4> |
|
494 <b>on_applyButton_clicked</b>(<i></i>) |
|
495 <p> |
|
496 Private slot called to apply the settings of the current page. |
|
497 </p><a NAME="ConfigurationWidget.on_buttonBox_clicked" ID="ConfigurationWidget.on_buttonBox_clicked"></a> |
|
498 <h4>ConfigurationWidget.on_buttonBox_clicked</h4> |
|
499 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
500 <p> |
|
501 Private slot called by a button of the button box clicked. |
|
502 </p><dl> |
|
503 <dt><i>button</i></dt> |
|
504 <dd> |
|
505 button that was clicked (QAbstractButton) |
|
506 </dd> |
|
507 </dl><a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a> |
|
508 <h4>ConfigurationWidget.on_resetButton_clicked</h4> |
|
509 <b>on_resetButton_clicked</b>(<i></i>) |
|
510 <p> |
|
511 Private slot called to reset the settings of the current page. |
|
512 </p><a NAME="ConfigurationWidget.setPreferences" ID="ConfigurationWidget.setPreferences"></a> |
|
513 <h4>ConfigurationWidget.setPreferences</h4> |
|
514 <b>setPreferences</b>(<i></i>) |
|
515 <p> |
|
516 Public method called to store the selected values into the preferences |
|
517 storage. |
|
518 </p><a NAME="ConfigurationWidget.showConfigurationPageByName" ID="ConfigurationWidget.showConfigurationPageByName"></a> |
|
519 <h4>ConfigurationWidget.showConfigurationPageByName</h4> |
|
520 <b>showConfigurationPageByName</b>(<i>pageName, setCurrent=True</i>) |
|
521 <p> |
|
522 Public slot to show a named configuration page. |
|
523 </p><dl> |
|
524 <dt><i>pageName</i></dt> |
|
525 <dd> |
|
526 name of the configuration page to show (string) |
|
527 </dd><dt><i>setCurrent</i></dt> |
|
528 <dd> |
|
529 flag indicating to set the current item (boolean) |
|
530 </dd> |
|
531 </dl> |
|
532 <div align="right"><a href="#top">Up</a></div> |
|
533 <hr /><hr /> |
|
534 <a NAME="ConfigurationWindow" ID="ConfigurationWindow"></a> |
|
535 <h2>ConfigurationWindow</h2> |
|
536 <p> |
|
537 Main window class for the standalone dialog. |
|
538 </p> |
|
539 <h3>Derived from</h3> |
|
540 E5MainWindow |
|
541 <h3>Class Attributes</h3> |
|
542 <table> |
|
543 <tr><td>None</td></tr> |
|
544 </table> |
|
545 <h3>Class Methods</h3> |
|
546 <table> |
|
547 <tr><td>None</td></tr> |
|
548 </table> |
|
549 <h3>Methods</h3> |
|
550 <table> |
|
551 <tr> |
|
552 <td><a href="#ConfigurationWindow.__init__">ConfigurationWindow</a></td> |
|
553 <td>Constructor</td> |
|
554 </tr><tr> |
|
555 <td><a href="#ConfigurationWindow.accept">accept</a></td> |
|
556 <td>Public slot called by the Ok button.</td> |
|
557 </tr><tr> |
|
558 <td><a href="#ConfigurationWindow.showConfigurationPageByName">showConfigurationPageByName</a></td> |
|
559 <td>Public slot to show a named configuration page.</td> |
|
560 </tr> |
|
561 </table> |
|
562 <h3>Static Methods</h3> |
|
563 <table> |
|
564 <tr><td>None</td></tr> |
|
565 </table> |
|
566 <a NAME="ConfigurationWindow.__init__" ID="ConfigurationWindow.__init__"></a> |
|
567 <h4>ConfigurationWindow (Constructor)</h4> |
|
568 <b>ConfigurationWindow</b>(<i>parent=None</i>) |
|
569 <p> |
|
570 Constructor |
|
571 </p><dl> |
|
572 <dt><i>parent</i></dt> |
|
573 <dd> |
|
574 reference to the parent widget (QWidget) |
|
575 </dd> |
|
576 </dl><a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a> |
|
577 <h4>ConfigurationWindow.accept</h4> |
|
578 <b>accept</b>(<i></i>) |
|
579 <p> |
|
580 Public slot called by the Ok button. |
|
581 </p><a NAME="ConfigurationWindow.showConfigurationPageByName" ID="ConfigurationWindow.showConfigurationPageByName"></a> |
|
582 <h4>ConfigurationWindow.showConfigurationPageByName</h4> |
|
583 <b>showConfigurationPageByName</b>(<i>pageName</i>) |
|
584 <p> |
|
585 Public slot to show a named configuration page. |
|
586 </p><dl> |
|
587 <dt><i>pageName</i></dt> |
|
588 <dd> |
|
589 name of the configuration page to show (string) |
|
590 </dd> |
|
591 </dl> |
|
592 <div align="right"><a href="#top">Up</a></div> |
|
593 <hr /> |
|
594 </body></html> |