src/eric7/Documentation/Source/eric7.PluginManager.PluginManager.html

branch
eric7
changeset 11231
c7240fb719c7
parent 11215
d07c71a34adf
equal deleted inserted replaced
11230:8a15b05eeee3 11231:c7240fb719c7
43 <dt>allPlugginsActivated()</dt> 43 <dt>allPlugginsActivated()</dt>
44 <dd> 44 <dd>
45 emitted at startup after all plugins have 45 emitted at startup after all plugins have
46 been activated 46 been activated
47 </dd> 47 </dd>
48 <dt>allTypedPlugginsActivated(pluginType)</dt>
49 <dd>
50 emitted at startup after all
51 plugins of the type have been activated
52 </dd>
48 <dt>pluginAboutToBeActivated(modulName, pluginObject)</dt> 53 <dt>pluginAboutToBeActivated(modulName, pluginObject)</dt>
49 <dd> 54 <dd>
50 emitted just 55 emitted just
51 before a plugin is activated 56 before a plugin is activated
52 </dd> 57 </dd>
144 <tr> 149 <tr>
145 <td><a href="#PluginManager.activatePlugins">activatePlugins</a></td> 150 <td><a href="#PluginManager.activatePlugins">activatePlugins</a></td>
146 <td>Public method to activate all plugins having the "autoactivate" attribute set to True.</td> 151 <td>Public method to activate all plugins having the "autoactivate" attribute set to True.</td>
147 </tr> 152 </tr>
148 <tr> 153 <tr>
154 <td><a href="#PluginManager.activateTypedPlugins">activateTypedPlugins</a></td>
155 <td>Public method to activate all plugins having the "autoactivate" attribute set to True and being of the given plugin type.</td>
156 </tr>
157 <tr>
149 <td><a href="#PluginManager.checkPluginEntry">checkPluginEntry</a></td> 158 <td><a href="#PluginManager.checkPluginEntry">checkPluginEntry</a></td>
150 <td>Public method to check a plug-in's data for an update.</td> 159 <td>Public method to check a plug-in's data for an update.</td>
151 </tr> 160 </tr>
152 <tr> 161 <tr>
153 <td><a href="#PluginManager.checkPluginUpdatesAvailable">checkPluginUpdatesAvailable</a></td> 162 <td><a href="#PluginManager.checkPluginUpdatesAvailable">checkPluginUpdatesAvailable</a></td>
568 <p> 577 <p>
569 Public method to activate all plugins having the "autoactivate" 578 Public method to activate all plugins having the "autoactivate"
570 attribute set to True. 579 attribute set to True.
571 </p> 580 </p>
572 581
582 <a NAME="PluginManager.activateTypedPlugins" ID="PluginManager.activateTypedPlugins"></a>
583 <h4>PluginManager.activateTypedPlugins</h4>
584 <b>activateTypedPlugins</b>(<i>pluginType</i>)
585 <p>
586 Public method to activate all plugins having the "autoactivate" attribute
587 set to True and being of the given plugin type.
588 </p>
589
590 <dl>
591
592 <dt><i>pluginType</i> (str)</dt>
593 <dd>
594 plugin type
595 </dd>
596 </dl>
573 <a NAME="PluginManager.checkPluginEntry" ID="PluginManager.checkPluginEntry"></a> 597 <a NAME="PluginManager.checkPluginEntry" ID="PluginManager.checkPluginEntry"></a>
574 <h4>PluginManager.checkPluginEntry</h4> 598 <h4>PluginManager.checkPluginEntry</h4>
575 <b>checkPluginEntry</b>(<i>_name, _short, _description, url, _author, version, filename, _status, _category, </i>) 599 <b>checkPluginEntry</b>(<i>_name, _short, _description, url, _author, version, filename, _status, _category, </i>)
576 <p> 600 <p>
577 Public method to check a plug-in's data for an update. 601 Public method to check a plug-in's data for an update.
623 Public method to check the availability of updates of plug-ins. 647 Public method to check the availability of updates of plug-ins.
624 </p> 648 </p>
625 649
626 <a NAME="PluginManager.clearPluginsPrivateData" ID="PluginManager.clearPluginsPrivateData"></a> 650 <a NAME="PluginManager.clearPluginsPrivateData" ID="PluginManager.clearPluginsPrivateData"></a>
627 <h4>PluginManager.clearPluginsPrivateData</h4> 651 <h4>PluginManager.clearPluginsPrivateData</h4>
628 <b>clearPluginsPrivateData</b>(<i>type_</i>) 652 <b>clearPluginsPrivateData</b>(<i>pluginType</i>)
629 <p> 653 <p>
630 Public method to clear the private data of plug-ins of a specified 654 Public method to clear the private data of plug-ins of a specified
631 type. 655 type.
632 </p> 656 </p>
633 <p> 657 <p>
635 'clearPrivateData()' (and may have the module level attribute 'pluginType'). 659 'clearPrivateData()' (and may have the module level attribute 'pluginType').
636 </p> 660 </p>
637 661
638 <dl> 662 <dl>
639 663
640 <dt><i>type_</i> (str)</dt> 664 <dt><i>pluginType</i> (str)</dt>
641 <dd> 665 <dd>
642 type of the plugin to clear private data for 666 type of the plugin to clear private data for
643 </dd> 667 </dd>
644 </dl> 668 </dl>
645 <a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a> 669 <a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a>
814 str 838 str
815 </dd> 839 </dd>
816 </dl> 840 </dl>
817 <a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a> 841 <a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a>
818 <h4>PluginManager.getPluginDisplayStrings</h4> 842 <h4>PluginManager.getPluginDisplayStrings</h4>
819 <b>getPluginDisplayStrings</b>(<i>type_</i>) 843 <b>getPluginDisplayStrings</b>(<i>pluginType</i>)
820 <p> 844 <p>
821 Public method to get the display strings of all plugins of a specific 845 Public method to get the display strings of all plugins of a specific
822 type. 846 type.
823 </p> 847 </p>
824 848
825 <dl> 849 <dl>
826 850
827 <dt><i>type_</i> (str)</dt> 851 <dt><i>pluginType</i> (str)</dt>
828 <dd> 852 <dd>
829 type of the plugins 853 type of the plugins
830 </dd> 854 </dd>
831 </dl> 855 </dl>
832 <dl> 856 <dl>
936 list of str 960 list of str
937 </dd> 961 </dd>
938 </dl> 962 </dl>
939 <a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a> 963 <a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a>
940 <h4>PluginManager.getPluginObject</h4> 964 <h4>PluginManager.getPluginObject</h4>
941 <b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>) 965 <b>getPluginObject</b>(<i>pluginType, pluginTypename, maybeActive=False</i>)
942 <p> 966 <p>
943 Public method to activate an on-demand plugin given by type and 967 Public method to activate an on-demand plugin given by type and
944 type name. 968 type name.
945 </p> 969 </p>
946 970
947 <dl> 971 <dl>
948 972
949 <dt><i>type_</i> (str)</dt> 973 <dt><i>pluginType</i> (str)</dt>
950 <dd> 974 <dd>
951 type of the plugin to be activated 975 type of the plugin to be activated
952 </dd> 976 </dd>
953 <dt><i>typename</i> (str)</dt> 977 <dt><i>pluginTypename</i> (str)</dt>
954 <dd> 978 <dd>
955 name of the plugin within the type category 979 name of the plugin within the type category
956 </dd> 980 </dd>
957 <dt><i>maybeActive</i> (bool)</dt> 981 <dt><i>maybeActive</i> (bool)</dt>
958 <dd> 982 <dd>
972 tuple of (QObject, str) 996 tuple of (QObject, str)
973 </dd> 997 </dd>
974 </dl> 998 </dl>
975 <a NAME="PluginManager.getPluginPreviewPixmap" ID="PluginManager.getPluginPreviewPixmap"></a> 999 <a NAME="PluginManager.getPluginPreviewPixmap" ID="PluginManager.getPluginPreviewPixmap"></a>
976 <h4>PluginManager.getPluginPreviewPixmap</h4> 1000 <h4>PluginManager.getPluginPreviewPixmap</h4>
977 <b>getPluginPreviewPixmap</b>(<i>type_, name</i>) 1001 <b>getPluginPreviewPixmap</b>(<i>pluginType, name</i>)
978 <p> 1002 <p>
979 Public method to get a preview pixmap of a plugin of a specific type. 1003 Public method to get a preview pixmap of a plugin of a specific type.
980 </p> 1004 </p>
981 1005
982 <dl> 1006 <dl>
983 1007
984 <dt><i>type_</i> (str)</dt> 1008 <dt><i>pluginType</i> (str)</dt>
985 <dd> 1009 <dd>
986 type of the plugin 1010 type of the plugin
987 </dd> 1011 </dd>
988 <dt><i>name</i> (str)</dt> 1012 <dt><i>name</i> (str)</dt>
989 <dd> 1013 <dd>

eric ide

mercurial