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

branch
eric7
changeset 10428
a071d4065202
parent 10132
66c11ab8fefd
child 10479
856476537696
equal deleted inserted replaced
10427:3733e2b23cf7 10428:a071d4065202
198 Public method to get the page name of the current page. 198 Public method to get the page name of the current page.
199 </p> 199 </p>
200 <dl> 200 <dl>
201 <dt>Return:</dt> 201 <dt>Return:</dt>
202 <dd> 202 <dd>
203 page name of the current page (string) 203 page name of the current page
204 </dd>
205 </dl>
206 <dl>
207 <dt>Return Type:</dt>
208 <dd>
209 str
204 </dd> 210 </dd>
205 </dl> 211 </dl>
206 <a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a> 212 <a NAME="ConfigurationDialog.getExpandedEntries" ID="ConfigurationDialog.getExpandedEntries"></a>
207 <h4>ConfigurationDialog.getExpandedEntries</h4> 213 <h4>ConfigurationDialog.getExpandedEntries</h4>
208 <b>getExpandedEntries</b>(<i></i>) 214 <b>getExpandedEntries</b>(<i></i>)
211 Public method to get a list of expanded entries. 217 Public method to get a list of expanded entries.
212 </p> 218 </p>
213 <dl> 219 <dl>
214 <dt>Return:</dt> 220 <dt>Return:</dt>
215 <dd> 221 <dd>
216 list of expanded entries (list of string) 222 list of expanded entries
223 </dd>
224 </dl>
225 <dl>
226 <dt>Return Type:</dt>
227 <dd>
228 list of str
217 </dd> 229 </dd>
218 </dl> 230 </dl>
219 <a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a> 231 <a NAME="ConfigurationDialog.setPreferences" ID="ConfigurationDialog.setPreferences"></a>
220 <h4>ConfigurationDialog.setPreferences</h4> 232 <h4>ConfigurationDialog.setPreferences</h4>
221 <b>setPreferences</b>(<i></i>) 233 <b>setPreferences</b>(<i></i>)
231 <p> 243 <p>
232 Public slot to show a named configuration page. 244 Public slot to show a named configuration page.
233 </p> 245 </p>
234 <dl> 246 <dl>
235 247
236 <dt><i>pageName</i></dt> 248 <dt><i>pageName</i> (str)</dt>
237 <dd> 249 <dd>
238 name of the configuration page to show (string) 250 name of the configuration page to show
239 </dd> 251 </dd>
240 </dl> 252 </dl>
241 <div align="right"><a href="#top">Up</a></div> 253 <div align="right"><a href="#top">Up</a></div>
242 <hr /> 254 <hr />
243 <hr /> 255 <hr />
317 <p> 329 <p>
318 Constructor 330 Constructor
319 </p> 331 </p>
320 <dl> 332 <dl>
321 333
322 <dt><i>parent</i></dt> 334 <dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt>
323 <dd> 335 <dd>
324 parent widget of the item (QTreeWidget or 336 parent widget of the item
325 QTreeWidgetItem) 337 </dd>
326 </dd> 338 <dt><i>text</i> (str)</dt>
327 <dt><i>text</i></dt> 339 <dd>
328 <dd> 340 text to be displayed
329 text to be displayed (string) 341 </dd>
330 </dd> 342 <dt><i>pageName</i> (str)</dt>
331 <dt><i>pageName</i></dt> 343 <dd>
332 <dd> 344 name of the configuration page
333 name of the configuration page (string) 345 </dd>
334 </dd> 346 <dt><i>iconFile</i> (str)</dt>
335 <dt><i>iconFile</i></dt> 347 <dd>
336 <dd> 348 file name of the icon to be shown
337 file name of the icon to be shown (string)
338 </dd> 349 </dd>
339 </dl> 350 </dl>
340 <a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a> 351 <a NAME="ConfigurationPageItem.getPageName" ID="ConfigurationPageItem.getPageName"></a>
341 <h4>ConfigurationPageItem.getPageName</h4> 352 <h4>ConfigurationPageItem.getPageName</h4>
342 <b>getPageName</b>(<i></i>) 353 <b>getPageName</b>(<i></i>)
345 Public method to get the name of the associated configuration page. 356 Public method to get the name of the associated configuration page.
346 </p> 357 </p>
347 <dl> 358 <dl>
348 <dt>Return:</dt> 359 <dt>Return:</dt>
349 <dd> 360 <dd>
350 name of the configuration page (string) 361 name of the configuration page
362 </dd>
363 </dl>
364 <dl>
365 <dt>Return Type:</dt>
366 <dd>
367 str
351 </dd> 368 </dd>
352 </dl> 369 </dl>
353 <div align="right"><a href="#top">Up</a></div> 370 <div align="right"><a href="#top">Up</a></div>
354 <hr /> 371 <hr />
355 <hr /> 372 <hr />
538 <p> 555 <p>
539 Private method to import a configuration page module. 556 Private method to import a configuration page module.
540 </p> 557 </p>
541 <dl> 558 <dl>
542 559
543 <dt><i>name</i></dt> 560 <dt><i>name</i> (str)</dt>
544 <dd> 561 <dd>
545 name of the configuration page module (string) 562 name of the configuration page module
546 </dd> 563 </dd>
547 </dl> 564 </dl>
548 <dl> 565 <dl>
549 <dt>Return:</dt> 566 <dt>Return:</dt>
550 <dd> 567 <dd>
551 reference to the configuration page module 568 reference to the configuration page module
569 </dd>
570 </dl>
571 <dl>
572 <dt>Return Type:</dt>
573 <dd>
574 Module
552 </dd> 575 </dd>
553 </dl> 576 </dl>
554 <a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a> 577 <a NAME="ConfigurationWidget.__initLexers" ID="ConfigurationWidget.__initLexers"></a>
555 <h4>ConfigurationWidget.__initLexers</h4> 578 <h4>ConfigurationWidget.__initLexers</h4>
556 <b>__initLexers</b>(<i></i>) 579 <b>__initLexers</b>(<i></i>)
565 <p> 588 <p>
566 Private method to initialize a configuration page. 589 Private method to initialize a configuration page.
567 </p> 590 </p>
568 <dl> 591 <dl>
569 592
570 <dt><i>pageData</i></dt> 593 <dt><i>pageData</i> (list)</dt>
571 <dd> 594 <dd>
572 data structure for the page to initialize 595 data structure for the page to initialize
573 </dd> 596 </dd>
574 </dl> 597 </dl>
575 <dl> 598 <dl>
576 <dt>Return:</dt> 599 <dt>Return:</dt>
577 <dd> 600 <dd>
578 reference to the initialized page 601 reference to the initialized page
602 </dd>
603 </dl>
604 <dl>
605 <dt>Return Type:</dt>
606 <dd>
607 ConfigurationPageBase
579 </dd> 608 </dd>
580 </dl> 609 </dl>
581 <a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a> 610 <a NAME="ConfigurationWidget.__resizeConfigStack" ID="ConfigurationWidget.__resizeConfigStack"></a>
582 <h4>ConfigurationWidget.__resizeConfigStack</h4> 611 <h4>ConfigurationWidget.__resizeConfigStack</h4>
583 <b>__resizeConfigStack</b>(<i></i>) 612 <b>__resizeConfigStack</b>(<i></i>)
592 <p> 621 <p>
593 Private method to enable child items based on a search string. 622 Private method to enable child items based on a search string.
594 </p> 623 </p>
595 <dl> 624 <dl>
596 625
597 <dt><i>parent</i></dt> 626 <dt><i>parent</i> (QTreeWidgetItem)</dt>
598 <dd> 627 <dd>
599 reference to the parent item (QTreeWidgetItem) 628 reference to the parent item
600 </dd> 629 </dd>
601 <dt><i>text</i></dt> 630 <dt><i>text</i> (str)</dt>
602 <dd> 631 <dd>
603 text to search for (string) 632 text to search for
604 </dd> 633 </dd>
605 </dl> 634 </dl>
606 <dl> 635 <dl>
607 <dt>Return:</dt> 636 <dt>Return:</dt>
608 <dd> 637 <dd>
609 flag indicating an enabled child item (boolean) 638 flag indicating an enabled child item
639 </dd>
640 </dl>
641 <dl>
642 <dt>Return Type:</dt>
643 <dd>
644 bool
610 </dd> 645 </dd>
611 </dl> 646 </dl>
612 <a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a> 647 <a NAME="ConfigurationWidget.__searchTextChanged" ID="ConfigurationWidget.__searchTextChanged"></a>
613 <h4>ConfigurationWidget.__searchTextChanged</h4> 648 <h4>ConfigurationWidget.__searchTextChanged</h4>
614 <b>__searchTextChanged</b>(<i>text</i>) 649 <b>__searchTextChanged</b>(<i>text</i>)
616 <p> 651 <p>
617 Private slot to handle a change of the search text. 652 Private slot to handle a change of the search text.
618 </p> 653 </p>
619 <dl> 654 <dl>
620 655
621 <dt><i>text</i></dt> 656 <dt><i>text</i> (str)</dt>
622 <dd> 657 <dd>
623 text to search for (string) 658 text to search for
624 </dd> 659 </dd>
625 </dl> 660 </dl>
626 <a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a> 661 <a NAME="ConfigurationWidget.__setupUi" ID="ConfigurationWidget.__setupUi"></a>
627 <h4>ConfigurationWidget.__setupUi</h4> 662 <h4>ConfigurationWidget.__setupUi</h4>
628 <b>__setupUi</b>(<i>withApply=True</i>) 663 <b>__setupUi</b>(<i>withApply=True</i>)
645 <p> 680 <p>
646 Private slot to show a selected configuration page. 681 Private slot to show a selected configuration page.
647 </p> 682 </p>
648 <dl> 683 <dl>
649 684
650 <dt><i>itm</i></dt> 685 <dt><i>itm</i> (QTreeWidgetItem)</dt>
651 <dd> 686 <dd>
652 reference to the selected item (QTreeWidgetItem) 687 reference to the selected item
653 </dd> 688 </dd>
654 </dl> 689 </dl>
655 <a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a> 690 <a NAME="ConfigurationWidget.accept" ID="ConfigurationWidget.accept"></a>
656 <h4>ConfigurationWidget.accept</h4> 691 <h4>ConfigurationWidget.accept</h4>
657 <b>accept</b>(<i></i>) 692 <b>accept</b>(<i></i>)
667 Public method to check, if invoked from within eric. 702 Public method to check, if invoked from within eric.
668 </p> 703 </p>
669 <dl> 704 <dl>
670 <dt>Return:</dt> 705 <dt>Return:</dt>
671 <dd> 706 <dd>
672 flag indicating invocation from within eric (boolean) 707 flag indicating invocation from within eric
708 </dd>
709 </dl>
710 <dl>
711 <dt>Return Type:</dt>
712 <dd>
713 bool
673 </dd> 714 </dd>
674 </dl> 715 </dl>
675 <a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a> 716 <a NAME="ConfigurationWidget.getConfigurationPageName" ID="ConfigurationWidget.getConfigurationPageName"></a>
676 <h4>ConfigurationWidget.getConfigurationPageName</h4> 717 <h4>ConfigurationWidget.getConfigurationPageName</h4>
677 <b>getConfigurationPageName</b>(<i></i>) 718 <b>getConfigurationPageName</b>(<i></i>)
680 Public method to get the page name of the current page. 721 Public method to get the page name of the current page.
681 </p> 722 </p>
682 <dl> 723 <dl>
683 <dt>Return:</dt> 724 <dt>Return:</dt>
684 <dd> 725 <dd>
685 page name of the current page (string) 726 page name of the current page
727 </dd>
728 </dl>
729 <dl>
730 <dt>Return Type:</dt>
731 <dd>
732 str
686 </dd> 733 </dd>
687 </dl> 734 </dl>
688 <a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a> 735 <a NAME="ConfigurationWidget.getExpandedEntries" ID="ConfigurationWidget.getExpandedEntries"></a>
689 <h4>ConfigurationWidget.getExpandedEntries</h4> 736 <h4>ConfigurationWidget.getExpandedEntries</h4>
690 <b>getExpandedEntries</b>(<i></i>) 737 <b>getExpandedEntries</b>(<i></i>)
693 Public method to get a list of expanded entries. 740 Public method to get a list of expanded entries.
694 </p> 741 </p>
695 <dl> 742 <dl>
696 <dt>Return:</dt> 743 <dt>Return:</dt>
697 <dd> 744 <dd>
698 list of expanded entries (list of string) 745 list of expanded entries
746 </dd>
747 </dl>
748 <dl>
749 <dt>Return Type:</dt>
750 <dd>
751 list of str
699 </dd> 752 </dd>
700 </dl> 753 </dl>
701 <a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a> 754 <a NAME="ConfigurationWidget.getLexers" ID="ConfigurationWidget.getLexers"></a>
702 <h4>ConfigurationWidget.getLexers</h4> 755 <h4>ConfigurationWidget.getLexers</h4>
703 <b>getLexers</b>(<i></i>) 756 <b>getLexers</b>(<i></i>)
709 <dt>Return:</dt> 762 <dt>Return:</dt>
710 <dd> 763 <dd>
711 reference to the lexers dictionary 764 reference to the lexers dictionary
712 </dd> 765 </dd>
713 </dl> 766 </dl>
767 <dl>
768 <dt>Return Type:</dt>
769 <dd>
770 dict
771 </dd>
772 </dl>
714 <a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a> 773 <a NAME="ConfigurationWidget.getPage" ID="ConfigurationWidget.getPage"></a>
715 <h4>ConfigurationWidget.getPage</h4> 774 <h4>ConfigurationWidget.getPage</h4>
716 <b>getPage</b>(<i>pageName</i>) 775 <b>getPage</b>(<i>pageName</i>)
717 776
718 <p> 777 <p>
719 Public method to get a reference to the named page. 778 Public method to get a reference to the named page.
720 </p> 779 </p>
721 <dl> 780 <dl>
722 781
723 <dt><i>pageName</i></dt> 782 <dt><i>pageName</i> (str)</dt>
724 <dd> 783 <dd>
725 name of the configuration page (string) 784 name of the configuration page
726 </dd> 785 </dd>
727 </dl> 786 </dl>
728 <dl> 787 <dl>
729 <dt>Return:</dt> 788 <dt>Return:</dt>
730 <dd> 789 <dd>
731 reference to the page or None, indicating page was 790 reference to the page or None, indicating page was
732 not loaded yet 791 not loaded yet
792 </dd>
793 </dl>
794 <dl>
795 <dt>Return Type:</dt>
796 <dd>
797 ConfigurationPageBase
733 </dd> 798 </dd>
734 </dl> 799 </dl>
735 <a NAME="ConfigurationWidget.isUsingWebEngine" ID="ConfigurationWidget.isUsingWebEngine"></a> 800 <a NAME="ConfigurationWidget.isUsingWebEngine" ID="ConfigurationWidget.isUsingWebEngine"></a>
736 <h4>ConfigurationWidget.isUsingWebEngine</h4> 801 <h4>ConfigurationWidget.isUsingWebEngine</h4>
737 <b>isUsingWebEngine</b>(<i></i>) 802 <b>isUsingWebEngine</b>(<i></i>)
765 <p> 830 <p>
766 Private slot called by a button of the button box clicked. 831 Private slot called by a button of the button box clicked.
767 </p> 832 </p>
768 <dl> 833 <dl>
769 834
770 <dt><i>button</i></dt> 835 <dt><i>button</i> (QAbstractButton)</dt>
771 <dd> 836 <dd>
772 button that was clicked (QAbstractButton) 837 button that was clicked
773 </dd> 838 </dd>
774 </dl> 839 </dl>
775 <a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a> 840 <a NAME="ConfigurationWidget.on_configList_itemCollapsed" ID="ConfigurationWidget.on_configList_itemCollapsed"></a>
776 <h4>ConfigurationWidget.on_configList_itemCollapsed</h4> 841 <h4>ConfigurationWidget.on_configList_itemCollapsed</h4>
777 <b>on_configList_itemCollapsed</b>(<i>item</i>) 842 <b>on_configList_itemCollapsed</b>(<i>item</i>)
779 <p> 844 <p>
780 Private slot handling a list entry being collapsed. 845 Private slot handling a list entry being collapsed.
781 </p> 846 </p>
782 <dl> 847 <dl>
783 848
784 <dt><i>item</i></dt> 849 <dt><i>item</i> (QTreeWidgetItem)</dt>
785 <dd> 850 <dd>
786 reference to the collapsed item (QTreeWidgetItem) 851 reference to the collapsed item
787 </dd> 852 </dd>
788 </dl> 853 </dl>
789 <a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a> 854 <a NAME="ConfigurationWidget.on_configList_itemExpanded" ID="ConfigurationWidget.on_configList_itemExpanded"></a>
790 <h4>ConfigurationWidget.on_configList_itemExpanded</h4> 855 <h4>ConfigurationWidget.on_configList_itemExpanded</h4>
791 <b>on_configList_itemExpanded</b>(<i>item</i>) 856 <b>on_configList_itemExpanded</b>(<i>item</i>)
793 <p> 858 <p>
794 Private slot handling a list entry being expanded. 859 Private slot handling a list entry being expanded.
795 </p> 860 </p>
796 <dl> 861 <dl>
797 862
798 <dt><i>item</i></dt> 863 <dt><i>item</i> (QTreeWidgetItem)</dt>
799 <dd> 864 <dd>
800 reference to the expanded item (QTreeWidgetItem) 865 reference to the expanded item
801 </dd> 866 </dd>
802 </dl> 867 </dl>
803 <a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a> 868 <a NAME="ConfigurationWidget.on_resetButton_clicked" ID="ConfigurationWidget.on_resetButton_clicked"></a>
804 <h4>ConfigurationWidget.on_resetButton_clicked</h4> 869 <h4>ConfigurationWidget.on_resetButton_clicked</h4>
805 <b>on_resetButton_clicked</b>(<i></i>) 870 <b>on_resetButton_clicked</b>(<i></i>)
836 <p> 901 <p>
837 Public slot to show a named configuration page. 902 Public slot to show a named configuration page.
838 </p> 903 </p>
839 <dl> 904 <dl>
840 905
841 <dt><i>pageName</i></dt> 906 <dt><i>pageName</i> (str)</dt>
842 <dd> 907 <dd>
843 name of the configuration page to show (string) 908 name of the configuration page to show
844 </dd> 909 </dd>
845 <dt><i>setCurrent</i></dt> 910 <dt><i>setCurrent</i> (bool)</dt>
846 <dd> 911 <dd>
847 flag indicating to set the current item (boolean) 912 flag indicating to set the current item
848 </dd> 913 </dd>
849 </dl> 914 </dl>
850 <div align="right"><a href="#top">Up</a></div> 915 <div align="right"><a href="#top">Up</a></div>
851 <hr /> 916 <hr />
852 <hr /> 917 <hr />
898 <p> 963 <p>
899 Constructor 964 Constructor
900 </p> 965 </p>
901 <dl> 966 <dl>
902 967
903 <dt><i>parent</i></dt> 968 <dt><i>parent</i> (QWidget)</dt>
904 <dd> 969 <dd>
905 reference to the parent widget (QWidget) 970 reference to the parent widget
906 </dd> 971 </dd>
907 </dl> 972 </dl>
908 <a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a> 973 <a NAME="ConfigurationWindow.accept" ID="ConfigurationWindow.accept"></a>
909 <h4>ConfigurationWindow.accept</h4> 974 <h4>ConfigurationWindow.accept</h4>
910 <b>accept</b>(<i></i>) 975 <b>accept</b>(<i></i>)
919 <p> 984 <p>
920 Public slot to show a named configuration page. 985 Public slot to show a named configuration page.
921 </p> 986 </p>
922 <dl> 987 <dl>
923 988
924 <dt><i>pageName</i></dt> 989 <dt><i>pageName</i> (str)</dt>
925 <dd> 990 <dd>
926 name of the configuration page to show (string) 991 name of the configuration page to show
927 </dd> 992 </dd>
928 </dl> 993 </dl>
929 <div align="right"><a href="#top">Up</a></div> 994 <div align="right"><a href="#top">Up</a></div>
930 <hr /> 995 <hr />
931 </body></html> 996 </body></html>

eric ide

mercurial