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

branch
maintenance
changeset 8043
0acf98cd089a
parent 7989
a21d673a8f99
child 8215
fc5d68a6889e
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
21 <body> 21 <body>
22 <a NAME="top" ID="top"></a> 22 <a NAME="top" ID="top"></a>
23 <h1>eric6.Preferences.ConfigurationDialog</h1> 23 <h1>eric6.Preferences.ConfigurationDialog</h1>
24 24
25 <p> 25 <p>
26 Module implementing a dialog for the configuration of eric6. 26 Module implementing a dialog for the configuration of eric.
27 </p> 27 </p>
28 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29 29
30 <table> 30 <table>
31 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
42 <td><a href="#ConfigurationPageItem">ConfigurationPageItem</a></td> 42 <td><a href="#ConfigurationPageItem">ConfigurationPageItem</a></td>
43 <td>Class implementing a QTreeWidgetItem holding the configuration page data.</td> 43 <td>Class implementing a QTreeWidgetItem holding the configuration page data.</td>
44 </tr> 44 </tr>
45 <tr> 45 <tr>
46 <td><a href="#ConfigurationWidget">ConfigurationWidget</a></td> 46 <td><a href="#ConfigurationWidget">ConfigurationWidget</a></td>
47 <td>Class implementing a dialog for the configuration of eric6.</td> 47 <td>Class implementing a dialog for the configuration of eric.</td>
48 </tr> 48 </tr>
49 <tr> 49 <tr>
50 <td><a href="#ConfigurationWindow">ConfigurationWindow</a></td> 50 <td><a href="#ConfigurationWindow">ConfigurationWindow</a></td>
51 <td>Main window class for the standalone dialog.</td> 51 <td>Main window class for the standalone dialog.</td>
52 </tr> 52 </tr>
151 </dd> 151 </dd>
152 <dt><i>modal</i></dt> 152 <dt><i>modal</i></dt>
153 <dd> 153 <dd>
154 Flag indicating a modal dialog. (boolean) 154 Flag indicating a modal dialog. (boolean)
155 </dd> 155 </dd>
156 <dt><i>fromEric=</i></dt> 156 <dt><i>fromEric</i></dt>
157 <dd> 157 <dd>
158 flag indicating a dialog generation from within the 158 flag indicating a dialog generation from within the
159 eric6 ide (boolean) 159 eric ide (boolean)
160 </dd> 160 </dd>
161 <dt><i>displayMode=</i></dt> 161 <dt><i>displayMode</i></dt>
162 <dd> 162 <dd>
163 mode of the configuration dialog 163 mode of the configuration dialog
164 (DefaultMode, HelpBrowserMode, TrayStarterMode, HexEditorMode, 164 (DefaultMode, HelpBrowserMode, TrayStarterMode, HexEditorMode,
165 WebBrowserMode) 165 WebBrowserMode)
166 </dd> 166 </dd>
167 <dt><i>expandedEntries=</i></dt> 167 <dt><i>expandedEntries</i></dt>
168 <dd> 168 <dd>
169 list of entries to be shown expanded 169 list of entries to be shown expanded
170 (list of strings) 170 (list of strings)
171 </dd> 171 </dd>
172 </dl> 172 </dl>
208 208
209 <p> 209 <p>
210 Public method to get the page name of the current page. 210 Public method to get the page name of the current page.
211 </p> 211 </p>
212 <dl> 212 <dl>
213 <dt>Returns:</dt> 213 <dt>Return:</dt>
214 <dd> 214 <dd>
215 page name of the current page (string) 215 page name of the current page (string)
216 </dd> 216 </dd>
217 </dl> 217 </dl>
218 <a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a> 218 <a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a>
221 221
222 <p> 222 <p>
223 Public method to get a list of expanded entries. 223 Public method to get a list of expanded entries.
224 </p> 224 </p>
225 <dl> 225 <dl>
226 <dt>Returns:</dt> 226 <dt>Return:</dt>
227 <dd> 227 <dd>
228 list of expanded entries (list of string) 228 list of expanded entries (list of string)
229 </dd> 229 </dd>
230 </dl> 230 </dl>
231 <a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a> 231 <a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a>
323 323
324 <p> 324 <p>
325 Public method to get the name of the associated configuration page. 325 Public method to get the name of the associated configuration page.
326 </p> 326 </p>
327 <dl> 327 <dl>
328 <dt>Returns:</dt> 328 <dt>Return:</dt>
329 <dd> 329 <dd>
330 name of the configuration page (string) 330 name of the configuration page (string)
331 </dd> 331 </dd>
332 </dl> 332 </dl>
333 <div align="right"><a href="#top">Up</a></div> 333 <div align="right"><a href="#top">Up</a></div>
335 <hr /> 335 <hr />
336 <a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a> 336 <a NAME="ConfigurationWidget" ID="ConfigurationWidget"></a>
337 <h2>ConfigurationWidget</h2> 337 <h2>ConfigurationWidget</h2>
338 338
339 <p> 339 <p>
340 Class implementing a dialog for the configuration of eric6. 340 Class implementing a dialog for the configuration of eric.
341 </p> 341 </p>
342 <h3>Signals</h3> 342 <h3>Signals</h3>
343 <dl> 343 <dl>
344 344
345 <dt>accepted()</dt> 345 <dt>accepted()</dt>
490 490
491 <dt><i>parent</i></dt> 491 <dt><i>parent</i></dt>
492 <dd> 492 <dd>
493 The parent widget of this dialog. (QWidget) 493 The parent widget of this dialog. (QWidget)
494 </dd> 494 </dd>
495 <dt><i>fromEric=</i></dt> 495 <dt><i>fromEric</i></dt>
496 <dd> 496 <dd>
497 flag indicating a dialog generation from within the 497 flag indicating a dialog generation from within the
498 eric6 ide (boolean) 498 eric ide (boolean)
499 </dd> 499 </dd>
500 <dt><i>displayMode=</i></dt> 500 <dt><i>displayMode</i></dt>
501 <dd> 501 <dd>
502 mode of the configuration dialog 502 mode of the configuration dialog
503 (DefaultMode, HelpBrowserMode, TrayStarterMode, HexEditorMode, 503 (DefaultMode, HelpBrowserMode, TrayStarterMode, HexEditorMode,
504 WebBrowserMode) 504 WebBrowserMode)
505 </dd> 505 </dd>
506 <dt><i>expandedEntries=</i></dt> 506 <dt><i>expandedEntries</i></dt>
507 <dd> 507 <dd>
508 list of entries to be shown expanded 508 list of entries to be shown expanded
509 (list of strings) 509 (list of strings)
510 </dd> 510 </dd>
511 </dl> 511 </dl>
529 <dd> 529 <dd>
530 name of the configuration page module (string) 530 name of the configuration page module (string)
531 </dd> 531 </dd>
532 </dl> 532 </dl>
533 <dl> 533 <dl>
534 <dt>Returns:</dt> 534 <dt>Return:</dt>
535 <dd> 535 <dd>
536 reference to the configuration page module 536 reference to the configuration page module
537 </dd> 537 </dd>
538 </dl> 538 </dl>
539 <a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a> 539 <a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a>
556 <dd> 556 <dd>
557 data structure for the page to initialize 557 data structure for the page to initialize
558 </dd> 558 </dd>
559 </dl> 559 </dl>
560 <dl> 560 <dl>
561 <dt>Returns:</dt> 561 <dt>Return:</dt>
562 <dd> 562 <dd>
563 reference to the initialized page 563 reference to the initialized page
564 </dd> 564 </dd>
565 </dl> 565 </dl>
566 <a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a> 566 <a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a>
587 <dd> 587 <dd>
588 text to search for (string) 588 text to search for (string)
589 </dd> 589 </dd>
590 </dl> 590 </dl>
591 <dl> 591 <dl>
592 <dt>Returns:</dt> 592 <dt>Return:</dt>
593 <dd> 593 <dd>
594 flag indicating an enabled child item (boolean) 594 flag indicating an enabled child item (boolean)
595 </dd> 595 </dd>
596 </dl> 596 </dl>
597 <a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a> 597 <a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a>
647 647
648 <p> 648 <p>
649 Public method to check, if invoked from within eric. 649 Public method to check, if invoked from within eric.
650 </p> 650 </p>
651 <dl> 651 <dl>
652 <dt>Returns:</dt> 652 <dt>Return:</dt>
653 <dd> 653 <dd>
654 flag indicating invocation from within eric (boolean) 654 flag indicating invocation from within eric (boolean)
655 </dd> 655 </dd>
656 </dl> 656 </dl>
657 <a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a> 657 <a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a>
660 660
661 <p> 661 <p>
662 Public method to get the page name of the current page. 662 Public method to get the page name of the current page.
663 </p> 663 </p>
664 <dl> 664 <dl>
665 <dt>Returns:</dt> 665 <dt>Return:</dt>
666 <dd> 666 <dd>
667 page name of the current page (string) 667 page name of the current page (string)
668 </dd> 668 </dd>
669 </dl> 669 </dl>
670 <a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a> 670 <a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a>
673 673
674 <p> 674 <p>
675 Public method to get a list of expanded entries. 675 Public method to get a list of expanded entries.
676 </p> 676 </p>
677 <dl> 677 <dl>
678 <dt>Returns:</dt> 678 <dt>Return:</dt>
679 <dd> 679 <dd>
680 list of expanded entries (list of string) 680 list of expanded entries (list of string)
681 </dd> 681 </dd>
682 </dl> 682 </dl>
683 <a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a> 683 <a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a>
686 686
687 <p> 687 <p>
688 Public method to get a reference to the lexers dictionary. 688 Public method to get a reference to the lexers dictionary.
689 </p> 689 </p>
690 <dl> 690 <dl>
691 <dt>Returns:</dt> 691 <dt>Return:</dt>
692 <dd> 692 <dd>
693 reference to the lexers dictionary 693 reference to the lexers dictionary
694 </dd> 694 </dd>
695 </dl> 695 </dl>
696 <a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a> 696 <a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a>
706 <dd> 706 <dd>
707 name of the configuration page (string) 707 name of the configuration page (string)
708 </dd> 708 </dd>
709 </dl> 709 </dl>
710 <dl> 710 <dl>
711 <dt>Returns:</dt> 711 <dt>Return:</dt>
712 <dd> 712 <dd>
713 reference to the page or None, indicating page was 713 reference to the page or None, indicating page was
714 not loaded yet 714 not loaded yet
715 </dd> 715 </dd>
716 </dl> 716 </dl>
720 720
721 <p> 721 <p>
722 Public method to get an indication, if QtWebEngine is being used. 722 Public method to get an indication, if QtWebEngine is being used.
723 </p> 723 </p>
724 <dl> 724 <dl>
725 <dt>Returns:</dt> 725 <dt>Return:</dt>
726 <dd> 726 <dd>
727 flag indicating the use of QtWebEngine 727 flag indicating the use of QtWebEngine
728 </dd> 728 </dd>
729 </dl> 729 </dl>
730 <dl> 730 <dl>

eric ide

mercurial