Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.PluginManager.PluginManager.html
eric6/Documentation/Source/eric6.PluginManager.PluginManager.html
- changeset 7989
- a21d673a8f99
- parent 7900
- 72b88fb20261
- child 8293
- cad568796748
equal
deleted
inserted
replaced
| 7988:c4c17121eff8 | 7989:a21d673a8f99 |
|---|---|
| 346 <dd> | 346 <dd> |
| 347 reference to the module to be activated | 347 reference to the module to be activated |
| 348 </dd> | 348 </dd> |
| 349 </dl> | 349 </dl> |
| 350 <dl> | 350 <dl> |
| 351 <dt>Returns:</dt> | 351 <dt>Return:</dt> |
| 352 <dd> | 352 <dd> |
| 353 flag indicating, if the module satisfies all requirements | 353 flag indicating, if the module satisfies all requirements |
| 354 for being activated (boolean) | 354 for being activated (boolean) |
| 355 </dd> | 355 </dd> |
| 356 </dl> | 356 </dl> |
| 380 <dd> | 380 <dd> |
| 381 reference to the module to be deactivated | 381 reference to the module to be deactivated |
| 382 </dd> | 382 </dd> |
| 383 </dl> | 383 </dl> |
| 384 <dl> | 384 <dl> |
| 385 <dt>Returns:</dt> | 385 <dt>Return:</dt> |
| 386 <dd> | 386 <dd> |
| 387 flag indicating, if the module satisfies all requirements | 387 flag indicating, if the module satisfies all requirements |
| 388 for being deactivated (boolean) | 388 for being deactivated (boolean) |
| 389 </dd> | 389 </dd> |
| 390 </dl> | 390 </dl> |
| 423 <dd> | 423 <dd> |
| 424 module to extract short info from | 424 module to extract short info from |
| 425 </dd> | 425 </dd> |
| 426 </dl> | 426 </dl> |
| 427 <dl> | 427 <dl> |
| 428 <dt>Returns:</dt> | 428 <dt>Return:</dt> |
| 429 <dd> | 429 <dd> |
| 430 dictionay containing plug-in data | 430 dictionay containing plug-in data |
| 431 </dd> | 431 </dd> |
| 432 </dl> | 432 </dl> |
| 433 <dl> | 433 <dl> |
| 474 </p> | 474 </p> |
| 475 <p> | 475 <p> |
| 476 If the plugin folders don't exist, they are created (if possible). | 476 If the plugin folders don't exist, they are created (if possible). |
| 477 </p> | 477 </p> |
| 478 <dl> | 478 <dl> |
| 479 <dt>Returns:</dt> | 479 <dt>Return:</dt> |
| 480 <dd> | 480 <dd> |
| 481 tuple of a flag indicating existence of any of the plugin | 481 tuple of a flag indicating existence of any of the plugin |
| 482 directories (boolean) and a message (string) | 482 directories (boolean) and a message (string) |
| 483 </dd> | 483 </dd> |
| 484 </dl> | 484 </dl> |
| 488 | 488 |
| 489 <p> | 489 <p> |
| 490 Private method to check, if there are plugins available. | 490 Private method to check, if there are plugins available. |
| 491 </p> | 491 </p> |
| 492 <dl> | 492 <dl> |
| 493 <dt>Returns:</dt> | 493 <dt>Return:</dt> |
| 494 <dd> | 494 <dd> |
| 495 flag indicating the availability of plugins (boolean) | 495 flag indicating the availability of plugins (boolean) |
| 496 </dd> | 496 </dd> |
| 497 </dl> | 497 </dl> |
| 498 <a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a> | 498 <a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a> |
| 531 flag indicating activation of an | 531 flag indicating activation of an |
| 532 on demand plugin (boolean) | 532 on demand plugin (boolean) |
| 533 </dd> | 533 </dd> |
| 534 </dl> | 534 </dl> |
| 535 <dl> | 535 <dl> |
| 536 <dt>Returns:</dt> | 536 <dt>Return:</dt> |
| 537 <dd> | 537 <dd> |
| 538 reference to the initialized plugin object | 538 reference to the initialized plugin object |
| 539 </dd> | 539 </dd> |
| 540 </dl> | 540 </dl> |
| 541 <dl> | 541 <dl> |
| 675 <dd> | 675 <dd> |
| 676 language of the requested API files (string) | 676 language of the requested API files (string) |
| 677 </dd> | 677 </dd> |
| 678 </dl> | 678 </dl> |
| 679 <dl> | 679 <dl> |
| 680 <dt>Returns:</dt> | 680 <dt>Return:</dt> |
| 681 <dd> | 681 <dd> |
| 682 list of API filenames (list of string) | 682 list of API filenames (list of string) |
| 683 </dd> | 683 </dd> |
| 684 </dl> | 684 </dl> |
| 685 <a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a> | 685 <a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a> |
| 715 <dd>This will be used by the configuration dialog and must always | 715 <dd>This will be used by the configuration dialog and must always |
| 716 be None</dd> | 716 be None</dd> |
| 717 </dl> | 717 </dl> |
| 718 </p> | 718 </p> |
| 719 <dl> | 719 <dl> |
| 720 <dt>Returns:</dt> | 720 <dt>Return:</dt> |
| 721 <dd> | 721 <dd> |
| 722 plug-in configuration data | 722 plug-in configuration data |
| 723 </dd> | 723 </dd> |
| 724 </dl> | 724 </dl> |
| 725 <a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> | 725 <a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> |
| 735 <dd> | 735 <dd> |
| 736 name of the module to get detailed infos about (string) | 736 name of the module to get detailed infos about (string) |
| 737 </dd> | 737 </dd> |
| 738 </dl> | 738 </dl> |
| 739 <dl> | 739 <dl> |
| 740 <dt>Returns:</dt> | 740 <dt>Return:</dt> |
| 741 <dd> | 741 <dd> |
| 742 details of the plugin as a dictionary | 742 details of the plugin as a dictionary |
| 743 </dd> | 743 </dd> |
| 744 </dl> | 744 </dl> |
| 745 <a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a> | 745 <a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a> |
| 755 <dd> | 755 <dd> |
| 756 key of the plug-in directory (string) | 756 key of the plug-in directory (string) |
| 757 </dd> | 757 </dd> |
| 758 </dl> | 758 </dl> |
| 759 <dl> | 759 <dl> |
| 760 <dt>Returns:</dt> | 760 <dt>Return:</dt> |
| 761 <dd> | 761 <dd> |
| 762 path of the requested plugin directory (string) | 762 path of the requested plugin directory (string) |
| 763 </dd> | 763 </dd> |
| 764 </dl> | 764 </dl> |
| 765 <a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a> | 765 <a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a> |
| 776 <dd> | 776 <dd> |
| 777 type of the plugins (string) | 777 type of the plugins (string) |
| 778 </dd> | 778 </dd> |
| 779 </dl> | 779 </dl> |
| 780 <dl> | 780 <dl> |
| 781 <dt>Returns:</dt> | 781 <dt>Return:</dt> |
| 782 <dd> | 782 <dd> |
| 783 dictionary with name as key and display string as value | 783 dictionary with name as key and display string as value |
| 784 (dictionary of string) | 784 (dictionary of string) |
| 785 </dd> | 785 </dd> |
| 786 </dl> | 786 </dl> |
| 791 <p> | 791 <p> |
| 792 Public method to get data to display information about a plugins | 792 Public method to get data to display information about a plugins |
| 793 external tool. | 793 external tool. |
| 794 </p> | 794 </p> |
| 795 <dl> | 795 <dl> |
| 796 <dt>Returns:</dt> | 796 <dt>Return:</dt> |
| 797 <dd> | 797 <dd> |
| 798 list of dictionaries containing the data. Each dictionary must | 798 list of dictionaries containing the data. Each dictionary must |
| 799 either contain data for the determination or the data to be | 799 either contain data for the determination or the data to be |
| 800 displayed.<br /> | 800 displayed.<br /> |
| 801 A dictionary of the first form must have the following entries: | 801 A dictionary of the first form must have the following entries: |
| 831 | 831 |
| 832 <p> | 832 <p> |
| 833 Public method to get infos about all loaded plug-ins. | 833 Public method to get infos about all loaded plug-ins. |
| 834 </p> | 834 </p> |
| 835 <dl> | 835 <dl> |
| 836 <dt>Returns:</dt> | 836 <dt>Return:</dt> |
| 837 <dd> | 837 <dd> |
| 838 list of dictionaries with keys "module_name", "plugin_name", | 838 list of dictionaries with keys "module_name", "plugin_name", |
| 839 "version", "auto_activate", "active", "short_desc", "error" | 839 "version", "auto_activate", "active", "short_desc", "error" |
| 840 </dd> | 840 </dd> |
| 841 </dl> | 841 </dl> |
| 860 <dd> | 860 <dd> |
| 861 name of the path to search (string) | 861 name of the path to search (string) |
| 862 </dd> | 862 </dd> |
| 863 </dl> | 863 </dl> |
| 864 <dl> | 864 <dl> |
| 865 <dt>Returns:</dt> | 865 <dt>Return:</dt> |
| 866 <dd> | 866 <dd> |
| 867 list of plugin module names (list of string) | 867 list of plugin module names (list of string) |
| 868 </dd> | 868 </dd> |
| 869 </dl> | 869 </dl> |
| 870 <a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a> | 870 <a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a> |
| 890 flag indicating, that the plugin may be active | 890 flag indicating, that the plugin may be active |
| 891 already (boolean) | 891 already (boolean) |
| 892 </dd> | 892 </dd> |
| 893 </dl> | 893 </dl> |
| 894 <dl> | 894 <dl> |
| 895 <dt>Returns:</dt> | 895 <dt>Return:</dt> |
| 896 <dd> | 896 <dd> |
| 897 reference to the initialized plugin object | 897 reference to the initialized plugin object |
| 898 </dd> | 898 </dd> |
| 899 </dl> | 899 </dl> |
| 900 <a NAME="PluginManager.getPluginPreviewPixmap" ID="PluginManager.getPluginPreviewPixmap"></a> | 900 <a NAME="PluginManager.getPluginPreviewPixmap" ID="PluginManager.getPluginPreviewPixmap"></a> |
| 914 <dd> | 914 <dd> |
| 915 name of the plugin type (string) | 915 name of the plugin type (string) |
| 916 </dd> | 916 </dd> |
| 917 </dl> | 917 </dl> |
| 918 <dl> | 918 <dl> |
| 919 <dt>Returns:</dt> | 919 <dt>Return:</dt> |
| 920 <dd> | 920 <dd> |
| 921 preview pixmap (QPixmap) | 921 preview pixmap (QPixmap) |
| 922 </dd> | 922 </dd> |
| 923 </dl> | 923 </dl> |
| 924 <a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a> | 924 <a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a> |
| 928 <p> | 928 <p> |
| 929 Public method to get the list of QtHelp documentation files provided | 929 Public method to get the list of QtHelp documentation files provided |
| 930 by a plug-in. | 930 by a plug-in. |
| 931 </p> | 931 </p> |
| 932 <dl> | 932 <dl> |
| 933 <dt>Returns:</dt> | 933 <dt>Return:</dt> |
| 934 <dd> | 934 <dd> |
| 935 dictionary with documentation type as key and list of files | 935 dictionary with documentation type as key and list of files |
| 936 as value | 936 as value |
| 937 </dd> | 937 </dd> |
| 938 </dl> | 938 </dl> |
| 953 Plugins supporting this functionality must support the module function | 953 Plugins supporting this functionality must support the module function |
| 954 getVcsSystemIndicator returning a dictionary with indicator as key and | 954 getVcsSystemIndicator returning a dictionary with indicator as key and |
| 955 a tuple with the vcs name (string) and vcs display string (string). | 955 a tuple with the vcs name (string) and vcs display string (string). |
| 956 </p> | 956 </p> |
| 957 <dl> | 957 <dl> |
| 958 <dt>Returns:</dt> | 958 <dt>Return:</dt> |
| 959 <dd> | 959 <dd> |
| 960 dictionary with indicator as key and a list of tuples as | 960 dictionary with indicator as key and a list of tuples as |
| 961 values. Each tuple contains the vcs name (string) and vcs display | 961 values. Each tuple contains the vcs name (string) and vcs display |
| 962 string (string). | 962 string (string). |
| 963 </dd> | 963 </dd> |
| 1025 <dd> | 1025 <dd> |
| 1026 name of the plugin to check for (string) | 1026 name of the plugin to check for (string) |
| 1027 </dd> | 1027 </dd> |
| 1028 </dl> | 1028 </dl> |
| 1029 <dl> | 1029 <dl> |
| 1030 <dt>Returns:</dt> | 1030 <dt>Return:</dt> |
| 1031 <dd> | 1031 <dd> |
| 1032 flag indicating, if the plugin is active (boolean) | 1032 flag indicating, if the plugin is active (boolean) |
| 1033 </dd> | 1033 </dd> |
| 1034 </dl> | 1034 </dl> |
| 1035 <a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a> | 1035 <a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a> |
| 1045 <dd> | 1045 <dd> |
| 1046 name of the plugin to check for (string) | 1046 name of the plugin to check for (string) |
| 1047 </dd> | 1047 </dd> |
| 1048 </dl> | 1048 </dl> |
| 1049 <dl> | 1049 <dl> |
| 1050 <dt>Returns:</dt> | 1050 <dt>Return:</dt> |
| 1051 <dd> | 1051 <dd> |
| 1052 flag indicating, if the plugin is loaded (boolean) | 1052 flag indicating, if the plugin is loaded (boolean) |
| 1053 </dd> | 1053 </dd> |
| 1054 </dl> | 1054 </dl> |
| 1055 <a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a> | 1055 <a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a> |
| 1068 <dd> | 1068 <dd> |
| 1069 name of the file to be checked (string) | 1069 name of the file to be checked (string) |
| 1070 </dd> | 1070 </dd> |
| 1071 </dl> | 1071 </dl> |
| 1072 <dl> | 1072 <dl> |
| 1073 <dt>Returns:</dt> | 1073 <dt>Return:</dt> |
| 1074 <dd> | 1074 <dd> |
| 1075 flag indicating a valid plugin name (boolean) | 1075 flag indicating a valid plugin name (boolean) |
| 1076 </dd> | 1076 </dd> |
| 1077 </dl> | 1077 </dl> |
| 1078 <a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a> | 1078 <a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a> |
| 1155 <dd> | 1155 <dd> |
| 1156 list of intenal packages (list of string) | 1156 list of intenal packages (list of string) |
| 1157 </dd> | 1157 </dd> |
| 1158 </dl> | 1158 </dl> |
| 1159 <dl> | 1159 <dl> |
| 1160 <dt>Returns:</dt> | 1160 <dt>Return:</dt> |
| 1161 <dd> | 1161 <dd> |
| 1162 flag indicating the plugin module was found in sys.modules | 1162 flag indicating the plugin module was found in sys.modules |
| 1163 (boolean) | 1163 (boolean) |
| 1164 </dd> | 1164 </dd> |
| 1165 </dl> | 1165 </dl> |
| 1176 <dd> | 1176 <dd> |
| 1177 name of the module to be unloaded (string) | 1177 name of the module to be unloaded (string) |
| 1178 </dd> | 1178 </dd> |
| 1179 </dl> | 1179 </dl> |
| 1180 <dl> | 1180 <dl> |
| 1181 <dt>Returns:</dt> | 1181 <dt>Return:</dt> |
| 1182 <dd> | 1182 <dd> |
| 1183 flag indicating success (boolean) | 1183 flag indicating success (boolean) |
| 1184 </dd> | 1184 </dd> |
| 1185 </dl> | 1185 </dl> |
| 1186 <div align="right"><a href="#top">Up</a></div> | 1186 <div align="right"><a href="#top">Up</a></div> |
