Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Preferences.ConfigurationDialog.html

eric6/Documentation/Source/eric6.Preferences.ConfigurationDialog.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
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>HexEditorMode</td></tr><tr><td>TrayStarterMode</td></tr><tr><td>WebBrowserMode</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.getExpandedEntries">getExpandedEntries</a></td>
95 <td>Public method to get a list of expanded entries.</td>
96 </tr><tr>
97 <td><a href="#ConfigurationDialog.setPreferences">setPreferences</a></td>
98 <td>Public method called to store the selected values into the preferences storage.</td>
99 </tr><tr>
100 <td><a href="#ConfigurationDialog.showConfigurationPageByName">showConfigurationPageByName</a></td>
101 <td>Public slot to show a named configuration page.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105 <table>
106 <tr><td>None</td></tr>
107 </table>
108 <a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a>
109 <h4>ConfigurationDialog (Constructor)</h4>
110 <b>ConfigurationDialog</b>(<i>parent=None, name=None, modal=False, fromEric=True, displayMode=ConfigurationWidget.DefaultMode, expandedEntries=None</i>)
111 <p>
112 Constructor
113 </p><dl>
114 <dt><i>parent</i></dt>
115 <dd>
116 The parent widget of this dialog. (QWidget)
117 </dd><dt><i>name</i></dt>
118 <dd>
119 The name of this dialog. string
120 </dd><dt><i>modal</i></dt>
121 <dd>
122 Flag indicating a modal dialog. (boolean)
123 </dd><dt><i>fromEric=</i></dt>
124 <dd>
125 flag indicating a dialog generation from within the
126 eric6 ide (boolean)
127 </dd><dt><i>displayMode=</i></dt>
128 <dd>
129 mode of the configuration dialog
130 (DefaultMode, HelpBrowserMode, TrayStarterMode, HexEditorMode,
131 WebBrowserMode)
132 </dd><dt><i>expandedEntries=</i></dt>
133 <dd>
134 list of entries to be shown expanded
135 (list of strings)
136 </dd>
137 </dl><a NAME="ConfigurationDialog.__masterPasswordChanged" ID="ConfigurationDialog.__masterPasswordChanged"></a>
138 <h4>ConfigurationDialog.__masterPasswordChanged</h4>
139 <b>__masterPasswordChanged</b>(<i>oldPassword, newPassword</i>)
140 <p>
141 Private slot to handle the change of the master password.
142 </p><dl>
143 <dt><i>oldPassword</i></dt>
144 <dd>
145 current master password (string)
146 </dd><dt><i>newPassword</i></dt>
147 <dd>
148 new master password (string)
149 </dd>
150 </dl><a NAME="ConfigurationDialog.__preferencesChanged" ID="ConfigurationDialog.__preferencesChanged"></a>
151 <h4>ConfigurationDialog.__preferencesChanged</h4>
152 <b>__preferencesChanged</b>(<i></i>)
153 <p>
154 Private slot to handle a change of the preferences.
155 </p><a NAME="ConfigurationDialog.accept" ID="ConfigurationDialog.accept"></a>
156 <h4>ConfigurationDialog.accept</h4>
157 <b>accept</b>(<i></i>)
158 <p>
159 Public method to accept the dialog.
160 </p><a NAME="ConfigurationDialog.getConfigurationPageName" ID="ConfigurationDialog.getConfigurationPageName"></a>
161 <h4>ConfigurationDialog.getConfigurationPageName</h4>
162 <b>getConfigurationPageName</b>(<i></i>)
163 <p>
164 Public method to get the page name of the current page.
165 </p><dl>
166 <dt>Returns:</dt>
167 <dd>
168 page name of the current page (string)
169 </dd>
170 </dl><a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a>
171 <h4>ConfigurationDialog.getExpandedEntries</h4>
172 <b>getExpandedEntries</b>(<i></i>)
173 <p>
174 Public method to get a list of expanded entries.
175 </p><dl>
176 <dt>Returns:</dt>
177 <dd>
178 list of expanded entries (list of string)
179 </dd>
180 </dl><a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a>
181 <h4>ConfigurationDialog.setPreferences</h4>
182 <b>setPreferences</b>(<i></i>)
183 <p>
184 Public method called to store the selected values into the preferences
185 storage.
186 </p><a NAME="ConfigurationDialog.showConfigurationPageByName" ID="ConfigurationDialog.showConfigurationPageByName"></a>
187 <h4>ConfigurationDialog.showConfigurationPageByName</h4>
188 <b>showConfigurationPageByName</b>(<i>pageName</i>)
189 <p>
190 Public slot to show a named configuration page.
191 </p><dl>
192 <dt><i>pageName</i></dt>
193 <dd>
194 name of the configuration page to show (string)
195 </dd>
196 </dl>
197 <div align="right"><a href="#top">Up</a></div>
198 <hr /><hr />
199 <a NAME="ConfigurationPageItem" ID="ConfigurationPageItem"></a>
200 <h2>ConfigurationPageItem</h2>
201 <p>
202 Class implementing a QTreeWidgetItem holding the configuration page data.
203 </p>
204 <h3>Derived from</h3>
205 QTreeWidgetItem
206 <h3>Class Attributes</h3>
207 <table>
208 <tr><td>None</td></tr>
209 </table>
210 <h3>Class Methods</h3>
211 <table>
212 <tr><td>None</td></tr>
213 </table>
214 <h3>Methods</h3>
215 <table>
216 <tr>
217 <td><a href="#ConfigurationPageItem.__init__">ConfigurationPageItem</a></td>
218 <td>Constructor</td>
219 </tr><tr>
220 <td><a href="#ConfigurationPageItem.getPageName">getPageName</a></td>
221 <td>Public method to get the name of the associated configuration page.</td>
222 </tr>
223 </table>
224 <h3>Static Methods</h3>
225 <table>
226 <tr><td>None</td></tr>
227 </table>
228 <a NAME="ConfigurationPageItem.__init__" ID="ConfigurationPageItem.__init__"></a>
229 <h4>ConfigurationPageItem (Constructor)</h4>
230 <b>ConfigurationPageItem</b>(<i>parent, text, pageName, iconFile</i>)
231 <p>
232 Constructor
233 </p><dl>
234 <dt><i>parent</i></dt>
235 <dd>
236 parent widget of the item (QTreeWidget or
237 QTreeWidgetItem)
238 </dd><dt><i>text</i></dt>
239 <dd>
240 text to be displayed (string)
241 </dd><dt><i>pageName</i></dt>
242 <dd>
243 name of the configuration page (string)
244 </dd><dt><i>iconFile</i></dt>
245 <dd>
246 file name of the icon to be shown (string)
247 </dd>
248 </dl><a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a>
249 <h4>ConfigurationPageItem.getPageName</h4>
250 <b>getPageName</b>(<i></i>)
251 <p>
252 Public method to get the name of the associated configuration page.
253 </p><dl>
254 <dt>Returns:</dt>
255 <dd>
256 name of the configuration page (string)
257 </dd>
258 </dl>
259 <div align="right"><a href="#top">Up</a></div>
260 <hr /><hr />
261 <a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a>
262 <h2>ConfigurationWidget</h2>
263 <p>
264 Class implementing a dialog for the configuration of eric6.
265 </p><h3>Signals</h3>
266 <dl>
267 <dt>accepted()</dt>
268 <dd>
269 emitted to indicate acceptance of the changes
270 </dd><dt>masterPasswordChanged(str, str)</dt>
271 <dd>
272 emitted after the master
273 password has been changed with the old and the new password
274 </dd><dt>preferencesChanged()</dt>
275 <dd>
276 emitted after settings have been changed
277 </dd><dt>rejected()</dt>
278 <dd>
279 emitted to indicate rejection of the changes
280 </dd>
281 </dl>
282 <h3>Derived from</h3>
283 QWidget
284 <h3>Class Attributes</h3>
285 <table>
286 <tr><td>DefaultMode</td></tr><tr><td>HelpBrowserMode</td></tr><tr><td>HexEditorMode</td></tr><tr><td>TrayStarterMode</td></tr><tr><td>WebBrowserMode</td></tr>
287 </table>
288 <h3>Class Methods</h3>
289 <table>
290 <tr><td>None</td></tr>
291 </table>
292 <h3>Methods</h3>
293 <table>
294 <tr>
295 <td><a href="#ConfigurationWidget.__init__">ConfigurationWidget</a></td>
296 <td>Constructor</td>
297 </tr><tr>
298 <td><a href="#ConfigurationWidget.__importConfigurationPage">__importConfigurationPage</a></td>
299 <td>Private method to import a configuration page module.</td>
300 </tr><tr>
301 <td><a href="#ConfigurationWidget.__initLexers">__initLexers</a></td>
302 <td>Private method to initialize the dictionary of preferences lexers.</td>
303 </tr><tr>
304 <td><a href="#ConfigurationWidget.__initPage">__initPage</a></td>
305 <td>Private method to initialize a configuration page.</td>
306 </tr><tr>
307 <td><a href="#ConfigurationWidget.__searchChildItems">__searchChildItems</a></td>
308 <td>Private method to enable child items based on a search string.</td>
309 </tr><tr>
310 <td><a href="#ConfigurationWidget.__searchTextChanged">__searchTextChanged</a></td>
311 <td>Private slot to handle a change of the search text.</td>
312 </tr><tr>
313 <td><a href="#ConfigurationWidget.__setupUi">__setupUi</a></td>
314 <td>Private method to perform the general setup of the configuration widget.</td>
315 </tr><tr>
316 <td><a href="#ConfigurationWidget.__showConfigurationPage">__showConfigurationPage</a></td>
317 <td>Private slot to show a selected configuration page.</td>
318 </tr><tr>
319 <td><a href="#ConfigurationWidget.accept">accept</a></td>
320 <td>Public slot to accept the buttonBox accept signal.</td>
321 </tr><tr>
322 <td><a href="#ConfigurationWidget.calledFromEric">calledFromEric</a></td>
323 <td>Public method to check, if invoked from within eric.</td>
324 </tr><tr>
325 <td><a href="#ConfigurationWidget.getConfigurationPageName">getConfigurationPageName</a></td>
326 <td>Public method to get the page name of the current page.</td>
327 </tr><tr>
328 <td><a href="#ConfigurationWidget.getExpandedEntries">getExpandedEntries</a></td>
329 <td>Public method to get a list of expanded entries.</td>
330 </tr><tr>
331 <td><a href="#ConfigurationWidget.getLexers">getLexers</a></td>
332 <td>Public method to get a reference to the lexers dictionary.</td>
333 </tr><tr>
334 <td><a href="#ConfigurationWidget.getPage">getPage</a></td>
335 <td>Public method to get a reference to the named page.</td>
336 </tr><tr>
337 <td><a href="#ConfigurationWidget.isUsingWebEngine">isUsingWebEngine</a></td>
338 <td>Public method to get an indication, if QtWebEngine is being used.</td>
339 </tr><tr>
340 <td><a href="#ConfigurationWidget.on_applyButton_clicked">on_applyButton_clicked</a></td>
341 <td>Private slot called to apply the settings of the current page.</td>
342 </tr><tr>
343 <td><a href="#ConfigurationWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
344 <td>Private slot called by a button of the button box clicked.</td>
345 </tr><tr>
346 <td><a href="#ConfigurationWidget.on_configList_itemCollapsed">on_configList_itemCollapsed</a></td>
347 <td>Private slot handling a list entry being collapsed.</td>
348 </tr><tr>
349 <td><a href="#ConfigurationWidget.on_configList_itemExpanded">on_configList_itemExpanded</a></td>
350 <td>Private slot handling a list entry being expanded.</td>
351 </tr><tr>
352 <td><a href="#ConfigurationWidget.on_resetButton_clicked">on_resetButton_clicked</a></td>
353 <td>Private slot called to reset the settings of the current page.</td>
354 </tr><tr>
355 <td><a href="#ConfigurationWidget.setPreferences">setPreferences</a></td>
356 <td>Public method called to store the selected values into the preferences storage.</td>
357 </tr><tr>
358 <td><a href="#ConfigurationWidget.showConfigurationPageByName">showConfigurationPageByName</a></td>
359 <td>Public slot to show a named configuration page.</td>
360 </tr>
361 </table>
362 <h3>Static Methods</h3>
363 <table>
364 <tr><td>None</td></tr>
365 </table>
366 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a>
367 <h4>ConfigurationWidget (Constructor)</h4>
368 <b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=DefaultMode, expandedEntries=None</i>)
369 <p>
370 Constructor
371 </p><dl>
372 <dt><i>parent</i></dt>
373 <dd>
374 The parent widget of this dialog. (QWidget)
375 </dd><dt><i>fromEric=</i></dt>
376 <dd>
377 flag indicating a dialog generation from within the
378 eric6 ide (boolean)
379 </dd><dt><i>displayMode=</i></dt>
380 <dd>
381 mode of the configuration dialog
382 (DefaultMode, HelpBrowserMode, TrayStarterMode, HexEditorMode,
383 WebBrowserMode)
384 </dd><dt><i>expandedEntries=</i></dt>
385 <dd>
386 list of entries to be shown expanded
387 (list of strings)
388 </dd>
389 </dl><dl>
390 <dt>Raises <b>RuntimeError</b>:</dt>
391 <dd>
392 raised to indicate an invalid dialog mode
393 </dd>
394 </dl><a NAME="ConfigurationWidget.__importConfigurationPage" ID="ConfigurationWidget.__importConfigurationPage"></a>
395 <h4>ConfigurationWidget.__importConfigurationPage</h4>
396 <b>__importConfigurationPage</b>(<i>name</i>)
397 <p>
398 Private method to import a configuration page module.
399 </p><dl>
400 <dt><i>name</i></dt>
401 <dd>
402 name of the configuration page module (string)
403 </dd>
404 </dl><dl>
405 <dt>Returns:</dt>
406 <dd>
407 reference to the configuration page module
408 </dd>
409 </dl><a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a>
410 <h4>ConfigurationWidget.__initLexers</h4>
411 <b>__initLexers</b>(<i></i>)
412 <p>
413 Private method to initialize the dictionary of preferences lexers.
414 </p><a NAME="ConfigurationWidget.__initPage" ID="ConfigurationWidget.__initPage"></a>
415 <h4>ConfigurationWidget.__initPage</h4>
416 <b>__initPage</b>(<i>pageData</i>)
417 <p>
418 Private method to initialize a configuration page.
419 </p><dl>
420 <dt><i>pageData</i></dt>
421 <dd>
422 data structure for the page to initialize
423 </dd>
424 </dl><dl>
425 <dt>Returns:</dt>
426 <dd>
427 reference to the initialized page
428 </dd>
429 </dl><a NAME="ConfigurationWidget.__searchChildItems" ID="ConfigurationWidget.__searchChildItems"></a>
430 <h4>ConfigurationWidget.__searchChildItems</h4>
431 <b>__searchChildItems</b>(<i>parent, text</i>)
432 <p>
433 Private method to enable child items based on a search string.
434 </p><dl>
435 <dt><i>parent</i></dt>
436 <dd>
437 reference to the parent item (QTreeWidgetItem)
438 </dd><dt><i>text</i></dt>
439 <dd>
440 text to search for (string)
441 </dd>
442 </dl><dl>
443 <dt>Returns:</dt>
444 <dd>
445 flag indicating an enabled child item (boolean)
446 </dd>
447 </dl><a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a>
448 <h4>ConfigurationWidget.__searchTextChanged</h4>
449 <b>__searchTextChanged</b>(<i>text</i>)
450 <p>
451 Private slot to handle a change of the search text.
452 </p><dl>
453 <dt><i>text</i></dt>
454 <dd>
455 text to search for (string)
456 </dd>
457 </dl><a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a>
458 <h4>ConfigurationWidget.__setupUi</h4>
459 <b>__setupUi</b>(<i></i>)
460 <p>
461 Private method to perform the general setup of the configuration
462 widget.
463 </p><a NAME="ConfigurationWidget.__showConfigurationPage" ID="ConfigurationWidget.__showConfigurationPage"></a>
464 <h4>ConfigurationWidget.__showConfigurationPage</h4>
465 <b>__showConfigurationPage</b>(<i>itm, column</i>)
466 <p>
467 Private slot to show a selected configuration page.
468 </p><dl>
469 <dt><i>itm</i></dt>
470 <dd>
471 reference to the selected item (QTreeWidgetItem)
472 </dd><dt><i>column</i></dt>
473 <dd>
474 column that was selected (integer) (ignored)
475 </dd>
476 </dl><a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a>
477 <h4>ConfigurationWidget.accept</h4>
478 <b>accept</b>(<i></i>)
479 <p>
480 Public slot to accept the buttonBox accept signal.
481 </p><a NAME="ConfigurationWidget.calledFromEric" ID="ConfigurationWidget.calledFromEric"></a>
482 <h4>ConfigurationWidget.calledFromEric</h4>
483 <b>calledFromEric</b>(<i></i>)
484 <p>
485 Public method to check, if invoked from within eric.
486 </p><dl>
487 <dt>Returns:</dt>
488 <dd>
489 flag indicating invocation from within eric (boolean)
490 </dd>
491 </dl><a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a>
492 <h4>ConfigurationWidget.getConfigurationPageName</h4>
493 <b>getConfigurationPageName</b>(<i></i>)
494 <p>
495 Public method to get the page name of the current page.
496 </p><dl>
497 <dt>Returns:</dt>
498 <dd>
499 page name of the current page (string)
500 </dd>
501 </dl><a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a>
502 <h4>ConfigurationWidget.getExpandedEntries</h4>
503 <b>getExpandedEntries</b>(<i></i>)
504 <p>
505 Public method to get a list of expanded entries.
506 </p><dl>
507 <dt>Returns:</dt>
508 <dd>
509 list of expanded entries (list of string)
510 </dd>
511 </dl><a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a>
512 <h4>ConfigurationWidget.getLexers</h4>
513 <b>getLexers</b>(<i></i>)
514 <p>
515 Public method to get a reference to the lexers dictionary.
516 </p><dl>
517 <dt>Returns:</dt>
518 <dd>
519 reference to the lexers dictionary
520 </dd>
521 </dl><a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a>
522 <h4>ConfigurationWidget.getPage</h4>
523 <b>getPage</b>(<i>pageName</i>)
524 <p>
525 Public method to get a reference to the named page.
526 </p><dl>
527 <dt><i>pageName</i></dt>
528 <dd>
529 name of the configuration page (string)
530 </dd>
531 </dl><dl>
532 <dt>Returns:</dt>
533 <dd>
534 reference to the page or None, indicating page was
535 not loaded yet
536 </dd>
537 </dl><a NAME="ConfigurationWidget.isUsingWebEngine" ID="ConfigurationWidget.isUsingWebEngine"></a>
538 <h4>ConfigurationWidget.isUsingWebEngine</h4>
539 <b>isUsingWebEngine</b>(<i></i>)
540 <p>
541 Public method to get an indication, if QtWebEngine is being used.
542 </p><dl>
543 <dt>Returns:</dt>
544 <dd>
545 flag indicating the use of QtWebEngine
546 </dd>
547 </dl><dl>
548 <dt>Return Type:</dt>
549 <dd>
550 bool
551 </dd>
552 </dl><a NAME="ConfigurationWidget.on_applyButton_clicked" ID="ConfigurationWidget.on_applyButton_clicked"></a>
553 <h4>ConfigurationWidget.on_applyButton_clicked</h4>
554 <b>on_applyButton_clicked</b>(<i></i>)
555 <p>
556 Private slot called to apply the settings of the current page.
557 </p><a NAME="ConfigurationWidget.on_buttonBox_clicked" ID="ConfigurationWidget.on_buttonBox_clicked"></a>
558 <h4>ConfigurationWidget.on_buttonBox_clicked</h4>
559 <b>on_buttonBox_clicked</b>(<i>button</i>)
560 <p>
561 Private slot called by a button of the button box clicked.
562 </p><dl>
563 <dt><i>button</i></dt>
564 <dd>
565 button that was clicked (QAbstractButton)
566 </dd>
567 </dl><a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a>
568 <h4>ConfigurationWidget.on_configList_itemCollapsed</h4>
569 <b>on_configList_itemCollapsed</b>(<i>item</i>)
570 <p>
571 Private slot handling a list entry being collapsed.
572 </p><dl>
573 <dt><i>item</i></dt>
574 <dd>
575 reference to the collapsed item (QTreeWidgetItem)
576 </dd>
577 </dl><a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a>
578 <h4>ConfigurationWidget.on_configList_itemExpanded</h4>
579 <b>on_configList_itemExpanded</b>(<i>item</i>)
580 <p>
581 Private slot handling a list entry being expanded.
582 </p><dl>
583 <dt><i>item</i></dt>
584 <dd>
585 reference to the expanded item (QTreeWidgetItem)
586 </dd>
587 </dl><a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a>
588 <h4>ConfigurationWidget.on_resetButton_clicked</h4>
589 <b>on_resetButton_clicked</b>(<i></i>)
590 <p>
591 Private slot called to reset the settings of the current page.
592 </p><a NAME="ConfigurationWidget.setPreferences" ID="ConfigurationWidget.setPreferences"></a>
593 <h4>ConfigurationWidget.setPreferences</h4>
594 <b>setPreferences</b>(<i></i>)
595 <p>
596 Public method called to store the selected values into the preferences
597 storage.
598 </p><a NAME="ConfigurationWidget.showConfigurationPageByName" ID="ConfigurationWidget.showConfigurationPageByName"></a>
599 <h4>ConfigurationWidget.showConfigurationPageByName</h4>
600 <b>showConfigurationPageByName</b>(<i>pageName, setCurrent=True</i>)
601 <p>
602 Public slot to show a named configuration page.
603 </p><dl>
604 <dt><i>pageName</i></dt>
605 <dd>
606 name of the configuration page to show (string)
607 </dd><dt><i>setCurrent</i></dt>
608 <dd>
609 flag indicating to set the current item (boolean)
610 </dd>
611 </dl>
612 <div align="right"><a href="#top">Up</a></div>
613 <hr /><hr />
614 <a NAME="ConfigurationWindow" ID="ConfigurationWindow"></a>
615 <h2>ConfigurationWindow</h2>
616 <p>
617 Main window class for the standalone dialog.
618 </p>
619 <h3>Derived from</h3>
620 E5MainWindow
621 <h3>Class Attributes</h3>
622 <table>
623 <tr><td>None</td></tr>
624 </table>
625 <h3>Class Methods</h3>
626 <table>
627 <tr><td>None</td></tr>
628 </table>
629 <h3>Methods</h3>
630 <table>
631 <tr>
632 <td><a href="#ConfigurationWindow.__init__">ConfigurationWindow</a></td>
633 <td>Constructor</td>
634 </tr><tr>
635 <td><a href="#ConfigurationWindow.accept">accept</a></td>
636 <td>Public slot called by the Ok button.</td>
637 </tr><tr>
638 <td><a href="#ConfigurationWindow.showConfigurationPageByName">showConfigurationPageByName</a></td>
639 <td>Public slot to show a named configuration page.</td>
640 </tr>
641 </table>
642 <h3>Static Methods</h3>
643 <table>
644 <tr><td>None</td></tr>
645 </table>
646 <a NAME="ConfigurationWindow.__init__" ID="ConfigurationWindow.__init__"></a>
647 <h4>ConfigurationWindow (Constructor)</h4>
648 <b>ConfigurationWindow</b>(<i>parent=None</i>)
649 <p>
650 Constructor
651 </p><dl>
652 <dt><i>parent</i></dt>
653 <dd>
654 reference to the parent widget (QWidget)
655 </dd>
656 </dl><a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a>
657 <h4>ConfigurationWindow.accept</h4>
658 <b>accept</b>(<i></i>)
659 <p>
660 Public slot called by the Ok button.
661 </p><a NAME="ConfigurationWindow.showConfigurationPageByName" ID="ConfigurationWindow.showConfigurationPageByName"></a>
662 <h4>ConfigurationWindow.showConfigurationPageByName</h4>
663 <b>showConfigurationPageByName</b>(<i>pageName</i>)
664 <p>
665 Public slot to show a named configuration page.
666 </p><dl>
667 <dt><i>pageName</i></dt>
668 <dd>
669 name of the configuration page to show (string)
670 </dd>
671 </dl>
672 <div align="right"><a href="#top">Up</a></div>
673 <hr />
674 </body></html>

Mercurial Repository: eric

eric ide

mercurial