Mercurial Repositories > eric / file comparison

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

eric7/Documentation/Source/eric7.Preferences.ConfigurationDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Preferences.ConfigurationDialog</h1>
24
25 <p>
26 Module implementing a dialog for the configuration of eric.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#ConfigurationDialog">ConfigurationDialog</a></td>
39 <td>Class for the dialog variant.</td>
40 </tr>
41 <tr>
42 <td><a href="#ConfigurationMode">ConfigurationMode</a></td>
43 <td>Class defining the various modes of the configuration widget.</td>
44 </tr>
45 <tr>
46 <td><a href="#ConfigurationPageItem">ConfigurationPageItem</a></td>
47 <td>Class implementing a QTreeWidgetItem holding the configuration page data.</td>
48 </tr>
49 <tr>
50 <td><a href="#ConfigurationWidget">ConfigurationWidget</a></td>
51 <td>Class implementing a dialog for the configuration of eric.</td>
52 </tr>
53 <tr>
54 <td><a href="#ConfigurationWindow">ConfigurationWindow</a></td>
55 <td>Main window class for the standalone dialog.</td>
56 </tr>
57 </table>
58 <h3>Functions</h3>
59
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <hr />
64 <hr />
65 <a NAME="ConfigurationDialog" ID="ConfigurationDialog"></a>
66 <h2>ConfigurationDialog</h2>
67
68 <p>
69 Class for the dialog variant.
70 </p>
71 <h3>Signals</h3>
72 <dl>
73
74 <dt>masterPasswordChanged(str, str)</dt>
75 <dd>
76 emitted after the master
77 password has been changed with the old and the new password
78 </dd>
79 <dt>preferencesChanged()</dt>
80 <dd>
81 emitted after settings have been changed
82 </dd>
83 </dl>
84 <h3>Derived from</h3>
85 QDialog
86 <h3>Class Attributes</h3>
87
88 <table>
89 <tr><td>None</td></tr>
90 </table>
91 <h3>Class Methods</h3>
92
93 <table>
94 <tr><td>None</td></tr>
95 </table>
96 <h3>Methods</h3>
97
98 <table>
99
100 <tr>
101 <td><a href="#ConfigurationDialog.__init__">ConfigurationDialog</a></td>
102 <td>Constructor</td>
103 </tr>
104 <tr>
105 <td><a href="#ConfigurationDialog.__masterPasswordChanged">__masterPasswordChanged</a></td>
106 <td>Private slot to handle the change of the master password.</td>
107 </tr>
108 <tr>
109 <td><a href="#ConfigurationDialog.__preferencesChanged">__preferencesChanged</a></td>
110 <td>Private slot to handle a change of the preferences.</td>
111 </tr>
112 <tr>
113 <td><a href="#ConfigurationDialog.accept">accept</a></td>
114 <td>Public method to accept the dialog.</td>
115 </tr>
116 <tr>
117 <td><a href="#ConfigurationDialog.getConfigurationPageName">getConfigurationPageName</a></td>
118 <td>Public method to get the page name of the current page.</td>
119 </tr>
120 <tr>
121 <td><a href="#ConfigurationDialog.getExpandedEntries">getExpandedEntries</a></td>
122 <td>Public method to get a list of expanded entries.</td>
123 </tr>
124 <tr>
125 <td><a href="#ConfigurationDialog.setPreferences">setPreferences</a></td>
126 <td>Public method called to store the selected values into the preferences storage.</td>
127 </tr>
128 <tr>
129 <td><a href="#ConfigurationDialog.showConfigurationPageByName">showConfigurationPageByName</a></td>
130 <td>Public slot to show a named configuration page.</td>
131 </tr>
132 </table>
133 <h3>Static Methods</h3>
134
135 <table>
136 <tr><td>None</td></tr>
137 </table>
138
139 <a NAME="ConfigurationDialog.__init__" ID="ConfigurationDialog.__init__"></a>
140 <h4>ConfigurationDialog (Constructor)</h4>
141 <b>ConfigurationDialog</b>(<i>parent=None, name=None, modal=False, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None</i>)
142
143 <p>
144 Constructor
145 </p>
146 <dl>
147
148 <dt><i>parent</i> (QWidget)</dt>
149 <dd>
150 reference to the parent widget
151 </dd>
152 <dt><i>name</i> (str)</dt>
153 <dd>
154 name of the dialog
155 </dd>
156 <dt><i>modal</i> (bool)</dt>
157 <dd>
158 flag indicating a modal dialog
159 </dd>
160 <dt><i>fromEric</i> (bool)</dt>
161 <dd>
162 flag indicating a dialog generation from within the
163 eric IDE
164 </dd>
165 <dt><i>displayMode</i> (ConfigurationMode)</dt>
166 <dd>
167 mode of the configuration dialog
168 </dd>
169 <dt><i>expandedEntries</i> (list of str)</dt>
170 <dd>
171 list of entries to be shown expanded
172 </dd>
173 </dl>
174 <a NAME="ConfigurationDialog.__masterPasswordChanged" ID="ConfigurationDialog.__masterPasswordChanged"></a>
175 <h4>ConfigurationDialog.__masterPasswordChanged</h4>
176 <b>__masterPasswordChanged</b>(<i>oldPassword, newPassword</i>)
177
178 <p>
179 Private slot to handle the change of the master password.
180 </p>
181 <dl>
182
183 <dt><i>oldPassword</i></dt>
184 <dd>
185 current master password (string)
186 </dd>
187 <dt><i>newPassword</i></dt>
188 <dd>
189 new master password (string)
190 </dd>
191 </dl>
192 <a NAME="ConfigurationDialog.__preferencesChanged" ID="ConfigurationDialog.__preferencesChanged"></a>
193 <h4>ConfigurationDialog.__preferencesChanged</h4>
194 <b>__preferencesChanged</b>(<i></i>)
195
196 <p>
197 Private slot to handle a change of the preferences.
198 </p>
199 <a NAME="ConfigurationDialog.accept" ID="ConfigurationDialog.accept"></a>
200 <h4>ConfigurationDialog.accept</h4>
201 <b>accept</b>(<i></i>)
202
203 <p>
204 Public method to accept the dialog.
205 </p>
206 <a NAME="ConfigurationDialog.getConfigurationPageName" ID="ConfigurationDialog.getConfigurationPageName"></a>
207 <h4>ConfigurationDialog.getConfigurationPageName</h4>
208 <b>getConfigurationPageName</b>(<i></i>)
209
210 <p>
211 Public method to get the page name of the current page.
212 </p>
213 <dl>
214 <dt>Return:</dt>
215 <dd>
216 page name of the current page (string)
217 </dd>
218 </dl>
219 <a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a>
220 <h4>ConfigurationDialog.getExpandedEntries</h4>
221 <b>getExpandedEntries</b>(<i></i>)
222
223 <p>
224 Public method to get a list of expanded entries.
225 </p>
226 <dl>
227 <dt>Return:</dt>
228 <dd>
229 list of expanded entries (list of string)
230 </dd>
231 </dl>
232 <a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a>
233 <h4>ConfigurationDialog.setPreferences</h4>
234 <b>setPreferences</b>(<i></i>)
235
236 <p>
237 Public method called to store the selected values into the preferences
238 storage.
239 </p>
240 <a NAME="ConfigurationDialog.showConfigurationPageByName" ID="ConfigurationDialog.showConfigurationPageByName"></a>
241 <h4>ConfigurationDialog.showConfigurationPageByName</h4>
242 <b>showConfigurationPageByName</b>(<i>pageName</i>)
243
244 <p>
245 Public slot to show a named configuration page.
246 </p>
247 <dl>
248
249 <dt><i>pageName</i></dt>
250 <dd>
251 name of the configuration page to show (string)
252 </dd>
253 </dl>
254 <div align="right"><a href="#top">Up</a></div>
255 <hr />
256 <hr />
257 <a NAME="ConfigurationMode" ID="ConfigurationMode"></a>
258 <h2>ConfigurationMode</h2>
259
260 <p>
261 Class defining the various modes of the configuration widget.
262 </p>
263 <h3>Derived from</h3>
264 enum.Enum
265 <h3>Class Attributes</h3>
266
267 <table>
268 <tr><td>DEFAULTMODE</td></tr><tr><td>HEXEDITORMODE</td></tr><tr><td>TRAYSTARTERMODE</td></tr><tr><td>WEBBROWSERMODE</td></tr>
269 </table>
270 <h3>Class Methods</h3>
271
272 <table>
273 <tr><td>None</td></tr>
274 </table>
275 <h3>Methods</h3>
276
277 <table>
278 <tr><td>None</td></tr>
279 </table>
280 <h3>Static Methods</h3>
281
282 <table>
283 <tr><td>None</td></tr>
284 </table>
285
286 <div align="right"><a href="#top">Up</a></div>
287 <hr />
288 <hr />
289 <a NAME="ConfigurationPageItem" ID="ConfigurationPageItem"></a>
290 <h2>ConfigurationPageItem</h2>
291
292 <p>
293 Class implementing a QTreeWidgetItem holding the configuration page data.
294 </p>
295 <h3>Derived from</h3>
296 QTreeWidgetItem
297 <h3>Class Attributes</h3>
298
299 <table>
300 <tr><td>None</td></tr>
301 </table>
302 <h3>Class Methods</h3>
303
304 <table>
305 <tr><td>None</td></tr>
306 </table>
307 <h3>Methods</h3>
308
309 <table>
310
311 <tr>
312 <td><a href="#ConfigurationPageItem.__init__">ConfigurationPageItem</a></td>
313 <td>Constructor</td>
314 </tr>
315 <tr>
316 <td><a href="#ConfigurationPageItem.getPageName">getPageName</a></td>
317 <td>Public method to get the name of the associated configuration page.</td>
318 </tr>
319 </table>
320 <h3>Static Methods</h3>
321
322 <table>
323 <tr><td>None</td></tr>
324 </table>
325
326 <a NAME="ConfigurationPageItem.__init__" ID="ConfigurationPageItem.__init__"></a>
327 <h4>ConfigurationPageItem (Constructor)</h4>
328 <b>ConfigurationPageItem</b>(<i>parent, text, pageName, iconFile</i>)
329
330 <p>
331 Constructor
332 </p>
333 <dl>
334
335 <dt><i>parent</i></dt>
336 <dd>
337 parent widget of the item (QTreeWidget or
338 QTreeWidgetItem)
339 </dd>
340 <dt><i>text</i></dt>
341 <dd>
342 text to be displayed (string)
343 </dd>
344 <dt><i>pageName</i></dt>
345 <dd>
346 name of the configuration page (string)
347 </dd>
348 <dt><i>iconFile</i></dt>
349 <dd>
350 file name of the icon to be shown (string)
351 </dd>
352 </dl>
353 <a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a>
354 <h4>ConfigurationPageItem.getPageName</h4>
355 <b>getPageName</b>(<i></i>)
356
357 <p>
358 Public method to get the name of the associated configuration page.
359 </p>
360 <dl>
361 <dt>Return:</dt>
362 <dd>
363 name of the configuration page (string)
364 </dd>
365 </dl>
366 <div align="right"><a href="#top">Up</a></div>
367 <hr />
368 <hr />
369 <a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a>
370 <h2>ConfigurationWidget</h2>
371
372 <p>
373 Class implementing a dialog for the configuration of eric.
374 </p>
375 <h3>Signals</h3>
376 <dl>
377
378 <dt>accepted()</dt>
379 <dd>
380 emitted to indicate acceptance of the changes
381 </dd>
382 <dt>masterPasswordChanged(str, str)</dt>
383 <dd>
384 emitted after the master
385 password has been changed with the old and the new password
386 </dd>
387 <dt>preferencesChanged()</dt>
388 <dd>
389 emitted after settings have been changed
390 </dd>
391 <dt>rejected()</dt>
392 <dd>
393 emitted to indicate rejection of the changes
394 </dd>
395 </dl>
396 <h3>Derived from</h3>
397 QWidget
398 <h3>Class Attributes</h3>
399
400 <table>
401 <tr><td>None</td></tr>
402 </table>
403 <h3>Class Methods</h3>
404
405 <table>
406 <tr><td>None</td></tr>
407 </table>
408 <h3>Methods</h3>
409
410 <table>
411
412 <tr>
413 <td><a href="#ConfigurationWidget.__init__">ConfigurationWidget</a></td>
414 <td>Constructor</td>
415 </tr>
416 <tr>
417 <td><a href="#ConfigurationWidget.__importConfigurationPage">__importConfigurationPage</a></td>
418 <td>Private method to import a configuration page module.</td>
419 </tr>
420 <tr>
421 <td><a href="#ConfigurationWidget.__initLexers">__initLexers</a></td>
422 <td>Private method to initialize the dictionary of preferences lexers.</td>
423 </tr>
424 <tr>
425 <td><a href="#ConfigurationWidget.__initPage">__initPage</a></td>
426 <td>Private method to initialize a configuration page.</td>
427 </tr>
428 <tr>
429 <td><a href="#ConfigurationWidget.__resizeConfigStack">__resizeConfigStack</a></td>
430 <td>Private method to resize the stack of configuration pages.</td>
431 </tr>
432 <tr>
433 <td><a href="#ConfigurationWidget.__searchChildItems">__searchChildItems</a></td>
434 <td>Private method to enable child items based on a search string.</td>
435 </tr>
436 <tr>
437 <td><a href="#ConfigurationWidget.__searchTextChanged">__searchTextChanged</a></td>
438 <td>Private slot to handle a change of the search text.</td>
439 </tr>
440 <tr>
441 <td><a href="#ConfigurationWidget.__setupUi">__setupUi</a></td>
442 <td>Private method to perform the general setup of the configuration widget.</td>
443 </tr>
444 <tr>
445 <td><a href="#ConfigurationWidget.__showConfigurationPage">__showConfigurationPage</a></td>
446 <td>Private slot to show a selected configuration page.</td>
447 </tr>
448 <tr>
449 <td><a href="#ConfigurationWidget.accept">accept</a></td>
450 <td>Public slot to accept the buttonBox accept signal.</td>
451 </tr>
452 <tr>
453 <td><a href="#ConfigurationWidget.calledFromEric">calledFromEric</a></td>
454 <td>Public method to check, if invoked from within eric.</td>
455 </tr>
456 <tr>
457 <td><a href="#ConfigurationWidget.getConfigurationPageName">getConfigurationPageName</a></td>
458 <td>Public method to get the page name of the current page.</td>
459 </tr>
460 <tr>
461 <td><a href="#ConfigurationWidget.getExpandedEntries">getExpandedEntries</a></td>
462 <td>Public method to get a list of expanded entries.</td>
463 </tr>
464 <tr>
465 <td><a href="#ConfigurationWidget.getLexers">getLexers</a></td>
466 <td>Public method to get a reference to the lexers dictionary.</td>
467 </tr>
468 <tr>
469 <td><a href="#ConfigurationWidget.getPage">getPage</a></td>
470 <td>Public method to get a reference to the named page.</td>
471 </tr>
472 <tr>
473 <td><a href="#ConfigurationWidget.isUsingWebEngine">isUsingWebEngine</a></td>
474 <td>Public method to get an indication, if QtWebEngine is being used.</td>
475 </tr>
476 <tr>
477 <td><a href="#ConfigurationWidget.on_applyButton_clicked">on_applyButton_clicked</a></td>
478 <td>Private slot called to apply the settings of the current page.</td>
479 </tr>
480 <tr>
481 <td><a href="#ConfigurationWidget.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
482 <td>Private slot called by a button of the button box clicked.</td>
483 </tr>
484 <tr>
485 <td><a href="#ConfigurationWidget.on_configList_itemCollapsed">on_configList_itemCollapsed</a></td>
486 <td>Private slot handling a list entry being collapsed.</td>
487 </tr>
488 <tr>
489 <td><a href="#ConfigurationWidget.on_configList_itemExpanded">on_configList_itemExpanded</a></td>
490 <td>Private slot handling a list entry being expanded.</td>
491 </tr>
492 <tr>
493 <td><a href="#ConfigurationWidget.on_resetButton_clicked">on_resetButton_clicked</a></td>
494 <td>Private slot called to reset the settings of the current page.</td>
495 </tr>
496 <tr>
497 <td><a href="#ConfigurationWidget.resizeEvent">resizeEvent</a></td>
498 <td>Protected method to handle the resizing of the widget.</td>
499 </tr>
500 <tr>
501 <td><a href="#ConfigurationWidget.setPreferences">setPreferences</a></td>
502 <td>Public method called to store the selected values into the preferences storage.</td>
503 </tr>
504 <tr>
505 <td><a href="#ConfigurationWidget.showConfigurationPageByName">showConfigurationPageByName</a></td>
506 <td>Public slot to show a named configuration page.</td>
507 </tr>
508 </table>
509 <h3>Static Methods</h3>
510
511 <table>
512 <tr><td>None</td></tr>
513 </table>
514
515 <a NAME="ConfigurationWidget.__init__" ID="ConfigurationWidget.__init__"></a>
516 <h4>ConfigurationWidget (Constructor)</h4>
517 <b>ConfigurationWidget</b>(<i>parent=None, fromEric=True, displayMode=ConfigurationMode.DEFAULTMODE, expandedEntries=None</i>)
518
519 <p>
520 Constructor
521 </p>
522 <dl>
523
524 <dt><i>parent</i> (QWidget)</dt>
525 <dd>
526 reference to the parent widget
527 </dd>
528 <dt><i>fromEric</i> (bool)</dt>
529 <dd>
530 flag indicating a dialog generation from within the
531 eric IDE
532 </dd>
533 <dt><i>displayMode</i> (ConfigurationMode)</dt>
534 <dd>
535 mode of the configuration dialog
536 </dd>
537 <dt><i>expandedEntries</i> (list of str)</dt>
538 <dd>
539 list of entries to be shown expanded
540 </dd>
541 </dl>
542 <a NAME="ConfigurationWidget.__importConfigurationPage" ID="ConfigurationWidget.__importConfigurationPage"></a>
543 <h4>ConfigurationWidget.__importConfigurationPage</h4>
544 <b>__importConfigurationPage</b>(<i>name</i>)
545
546 <p>
547 Private method to import a configuration page module.
548 </p>
549 <dl>
550
551 <dt><i>name</i></dt>
552 <dd>
553 name of the configuration page module (string)
554 </dd>
555 </dl>
556 <dl>
557 <dt>Return:</dt>
558 <dd>
559 reference to the configuration page module
560 </dd>
561 </dl>
562 <a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a>
563 <h4>ConfigurationWidget.__initLexers</h4>
564 <b>__initLexers</b>(<i></i>)
565
566 <p>
567 Private method to initialize the dictionary of preferences lexers.
568 </p>
569 <a NAME="ConfigurationWidget.__initPage" ID="ConfigurationWidget.__initPage"></a>
570 <h4>ConfigurationWidget.__initPage</h4>
571 <b>__initPage</b>(<i>pageData</i>)
572
573 <p>
574 Private method to initialize a configuration page.
575 </p>
576 <dl>
577
578 <dt><i>pageData</i></dt>
579 <dd>
580 data structure for the page to initialize
581 </dd>
582 </dl>
583 <dl>
584 <dt>Return:</dt>
585 <dd>
586 reference to the initialized page
587 </dd>
588 </dl>
589 <a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a>
590 <h4>ConfigurationWidget.__resizeConfigStack</h4>
591 <b>__resizeConfigStack</b>(<i></i>)
592
593 <p>
594 Private method to resize the stack of configuration pages.
595 </p>
596 <a NAME="ConfigurationWidget.__searchChildItems" ID="ConfigurationWidget.__searchChildItems"></a>
597 <h4>ConfigurationWidget.__searchChildItems</h4>
598 <b>__searchChildItems</b>(<i>parent, text</i>)
599
600 <p>
601 Private method to enable child items based on a search string.
602 </p>
603 <dl>
604
605 <dt><i>parent</i></dt>
606 <dd>
607 reference to the parent item (QTreeWidgetItem)
608 </dd>
609 <dt><i>text</i></dt>
610 <dd>
611 text to search for (string)
612 </dd>
613 </dl>
614 <dl>
615 <dt>Return:</dt>
616 <dd>
617 flag indicating an enabled child item (boolean)
618 </dd>
619 </dl>
620 <a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a>
621 <h4>ConfigurationWidget.__searchTextChanged</h4>
622 <b>__searchTextChanged</b>(<i>text</i>)
623
624 <p>
625 Private slot to handle a change of the search text.
626 </p>
627 <dl>
628
629 <dt><i>text</i></dt>
630 <dd>
631 text to search for (string)
632 </dd>
633 </dl>
634 <a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a>
635 <h4>ConfigurationWidget.__setupUi</h4>
636 <b>__setupUi</b>(<i></i>)
637
638 <p>
639 Private method to perform the general setup of the configuration
640 widget.
641 </p>
642 <a NAME="ConfigurationWidget.__showConfigurationPage" ID="ConfigurationWidget.__showConfigurationPage"></a>
643 <h4>ConfigurationWidget.__showConfigurationPage</h4>
644 <b>__showConfigurationPage</b>(<i>itm, column</i>)
645
646 <p>
647 Private slot to show a selected configuration page.
648 </p>
649 <dl>
650
651 <dt><i>itm</i></dt>
652 <dd>
653 reference to the selected item (QTreeWidgetItem)
654 </dd>
655 <dt><i>column</i></dt>
656 <dd>
657 column that was selected (integer) (ignored)
658 </dd>
659 </dl>
660 <a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a>
661 <h4>ConfigurationWidget.accept</h4>
662 <b>accept</b>(<i></i>)
663
664 <p>
665 Public slot to accept the buttonBox accept signal.
666 </p>
667 <a NAME="ConfigurationWidget.calledFromEric" ID="ConfigurationWidget.calledFromEric"></a>
668 <h4>ConfigurationWidget.calledFromEric</h4>
669 <b>calledFromEric</b>(<i></i>)
670
671 <p>
672 Public method to check, if invoked from within eric.
673 </p>
674 <dl>
675 <dt>Return:</dt>
676 <dd>
677 flag indicating invocation from within eric (boolean)
678 </dd>
679 </dl>
680 <a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a>
681 <h4>ConfigurationWidget.getConfigurationPageName</h4>
682 <b>getConfigurationPageName</b>(<i></i>)
683
684 <p>
685 Public method to get the page name of the current page.
686 </p>
687 <dl>
688 <dt>Return:</dt>
689 <dd>
690 page name of the current page (string)
691 </dd>
692 </dl>
693 <a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a>
694 <h4>ConfigurationWidget.getExpandedEntries</h4>
695 <b>getExpandedEntries</b>(<i></i>)
696
697 <p>
698 Public method to get a list of expanded entries.
699 </p>
700 <dl>
701 <dt>Return:</dt>
702 <dd>
703 list of expanded entries (list of string)
704 </dd>
705 </dl>
706 <a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a>
707 <h4>ConfigurationWidget.getLexers</h4>
708 <b>getLexers</b>(<i></i>)
709
710 <p>
711 Public method to get a reference to the lexers dictionary.
712 </p>
713 <dl>
714 <dt>Return:</dt>
715 <dd>
716 reference to the lexers dictionary
717 </dd>
718 </dl>
719 <a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a>
720 <h4>ConfigurationWidget.getPage</h4>
721 <b>getPage</b>(<i>pageName</i>)
722
723 <p>
724 Public method to get a reference to the named page.
725 </p>
726 <dl>
727
728 <dt><i>pageName</i></dt>
729 <dd>
730 name of the configuration page (string)
731 </dd>
732 </dl>
733 <dl>
734 <dt>Return:</dt>
735 <dd>
736 reference to the page or None, indicating page was
737 not loaded yet
738 </dd>
739 </dl>
740 <a NAME="ConfigurationWidget.isUsingWebEngine" ID="ConfigurationWidget.isUsingWebEngine"></a>
741 <h4>ConfigurationWidget.isUsingWebEngine</h4>
742 <b>isUsingWebEngine</b>(<i></i>)
743
744 <p>
745 Public method to get an indication, if QtWebEngine is being used.
746 </p>
747 <dl>
748 <dt>Return:</dt>
749 <dd>
750 flag indicating the use of QtWebEngine
751 </dd>
752 </dl>
753 <dl>
754 <dt>Return Type:</dt>
755 <dd>
756 bool
757 </dd>
758 </dl>
759 <a NAME="ConfigurationWidget.on_applyButton_clicked" ID="ConfigurationWidget.on_applyButton_clicked"></a>
760 <h4>ConfigurationWidget.on_applyButton_clicked</h4>
761 <b>on_applyButton_clicked</b>(<i></i>)
762
763 <p>
764 Private slot called to apply the settings of the current page.
765 </p>
766 <a NAME="ConfigurationWidget.on_buttonBox_clicked" ID="ConfigurationWidget.on_buttonBox_clicked"></a>
767 <h4>ConfigurationWidget.on_buttonBox_clicked</h4>
768 <b>on_buttonBox_clicked</b>(<i>button</i>)
769
770 <p>
771 Private slot called by a button of the button box clicked.
772 </p>
773 <dl>
774
775 <dt><i>button</i></dt>
776 <dd>
777 button that was clicked (QAbstractButton)
778 </dd>
779 </dl>
780 <a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a>
781 <h4>ConfigurationWidget.on_configList_itemCollapsed</h4>
782 <b>on_configList_itemCollapsed</b>(<i>item</i>)
783
784 <p>
785 Private slot handling a list entry being collapsed.
786 </p>
787 <dl>
788
789 <dt><i>item</i></dt>
790 <dd>
791 reference to the collapsed item (QTreeWidgetItem)
792 </dd>
793 </dl>
794 <a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a>
795 <h4>ConfigurationWidget.on_configList_itemExpanded</h4>
796 <b>on_configList_itemExpanded</b>(<i>item</i>)
797
798 <p>
799 Private slot handling a list entry being expanded.
800 </p>
801 <dl>
802
803 <dt><i>item</i></dt>
804 <dd>
805 reference to the expanded item (QTreeWidgetItem)
806 </dd>
807 </dl>
808 <a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a>
809 <h4>ConfigurationWidget.on_resetButton_clicked</h4>
810 <b>on_resetButton_clicked</b>(<i></i>)
811
812 <p>
813 Private slot called to reset the settings of the current page.
814 </p>
815 <a NAME="ConfigurationWidget.resizeEvent" ID="ConfigurationWidget.resizeEvent"></a>
816 <h4>ConfigurationWidget.resizeEvent</h4>
817 <b>resizeEvent</b>(<i>evt</i>)
818
819 <p>
820 Protected method to handle the resizing of the widget.
821 </p>
822 <dl>
823
824 <dt><i>evt</i> (QResizeEvent)</dt>
825 <dd>
826 reference to the event object
827 </dd>
828 </dl>
829 <a NAME="ConfigurationWidget.setPreferences" ID="ConfigurationWidget.setPreferences"></a>
830 <h4>ConfigurationWidget.setPreferences</h4>
831 <b>setPreferences</b>(<i></i>)
832
833 <p>
834 Public method called to store the selected values into the preferences
835 storage.
836 </p>
837 <a NAME="ConfigurationWidget.showConfigurationPageByName" ID="ConfigurationWidget.showConfigurationPageByName"></a>
838 <h4>ConfigurationWidget.showConfigurationPageByName</h4>
839 <b>showConfigurationPageByName</b>(<i>pageName, setCurrent=True</i>)
840
841 <p>
842 Public slot to show a named configuration page.
843 </p>
844 <dl>
845
846 <dt><i>pageName</i></dt>
847 <dd>
848 name of the configuration page to show (string)
849 </dd>
850 <dt><i>setCurrent</i></dt>
851 <dd>
852 flag indicating to set the current item (boolean)
853 </dd>
854 </dl>
855 <div align="right"><a href="#top">Up</a></div>
856 <hr />
857 <hr />
858 <a NAME="ConfigurationWindow" ID="ConfigurationWindow"></a>
859 <h2>ConfigurationWindow</h2>
860
861 <p>
862 Main window class for the standalone dialog.
863 </p>
864 <h3>Derived from</h3>
865 EricMainWindow
866 <h3>Class Attributes</h3>
867
868 <table>
869 <tr><td>None</td></tr>
870 </table>
871 <h3>Class Methods</h3>
872
873 <table>
874 <tr><td>None</td></tr>
875 </table>
876 <h3>Methods</h3>
877
878 <table>
879
880 <tr>
881 <td><a href="#ConfigurationWindow.__init__">ConfigurationWindow</a></td>
882 <td>Constructor</td>
883 </tr>
884 <tr>
885 <td><a href="#ConfigurationWindow.accept">accept</a></td>
886 <td>Public slot called by the Ok button.</td>
887 </tr>
888 <tr>
889 <td><a href="#ConfigurationWindow.showConfigurationPageByName">showConfigurationPageByName</a></td>
890 <td>Public slot to show a named configuration page.</td>
891 </tr>
892 </table>
893 <h3>Static Methods</h3>
894
895 <table>
896 <tr><td>None</td></tr>
897 </table>
898
899 <a NAME="ConfigurationWindow.__init__" ID="ConfigurationWindow.__init__"></a>
900 <h4>ConfigurationWindow (Constructor)</h4>
901 <b>ConfigurationWindow</b>(<i>parent=None</i>)
902
903 <p>
904 Constructor
905 </p>
906 <dl>
907
908 <dt><i>parent</i></dt>
909 <dd>
910 reference to the parent widget (QWidget)
911 </dd>
912 </dl>
913 <a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a>
914 <h4>ConfigurationWindow.accept</h4>
915 <b>accept</b>(<i></i>)
916
917 <p>
918 Public slot called by the Ok button.
919 </p>
920 <a NAME="ConfigurationWindow.showConfigurationPageByName" ID="ConfigurationWindow.showConfigurationPageByName"></a>
921 <h4>ConfigurationWindow.showConfigurationPageByName</h4>
922 <b>showConfigurationPageByName</b>(<i>pageName</i>)
923
924 <p>
925 Public slot to show a named configuration page.
926 </p>
927 <dl>
928
929 <dt><i>pageName</i></dt>
930 <dd>
931 name of the configuration page to show (string)
932 </dd>
933 </dl>
934 <div align="right"><a href="#top">Up</a></div>
935 <hr />
936 </body></html>

Mercurial Repository: eric

eric ide

mercurial