Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.PluginManager.PluginManager.html

eric6/Documentation/Source/eric6.PluginManager.PluginManager.html

changeset 7273
391d6b7b1eff
parent 7204
cbf6d88004ce
child 7900
72b88fb20261
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.PluginManager.PluginManager</h1> 23 <h1>eric6.PluginManager.PluginManager</h1>
24
23 <p> 25 <p>
24 Module implementing the Plugin Manager. 26 Module implementing the Plugin Manager.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#PluginManager">PluginManager</a></td> 38 <td><a href="#PluginManager">PluginManager</a></td>
34 <td>Class implementing the Plugin Manager.</td> 39 <td>Class implementing the Plugin Manager.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="PluginManager" ID="PluginManager"></a> 49 <a NAME="PluginManager" ID="PluginManager"></a>
43 <h2>PluginManager</h2> 50 <h2>PluginManager</h2>
51
44 <p> 52 <p>
45 Class implementing the Plugin Manager. 53 Class implementing the Plugin Manager.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>allPlugginsActivated()</dt> 58 <dt>allPlugginsActivated()</dt>
49 <dd> 59 <dd>
50 emitted at startup after all plugins have 60 emitted at startup after all plugins have
51 been activated 61 been activated
52 </dd><dt>pluginAboutToBeActivated(modulName, pluginObject)</dt> 62 </dd>
63 <dt>pluginAboutToBeActivated(modulName, pluginObject)</dt>
53 <dd> 64 <dd>
54 emitted just 65 emitted just
55 before a plugin is activated 66 before a plugin is activated
56 </dd><dt>pluginAboutToBeDeactivated(moduleName, pluginObject)</dt> 67 </dd>
68 <dt>pluginAboutToBeDeactivated(moduleName, pluginObject)</dt>
57 <dd> 69 <dd>
58 emitted just 70 emitted just
59 before a plugin is deactivated 71 before a plugin is deactivated
60 </dd><dt>pluginActivated(moduleName, pluginObject)</dt> 72 </dd>
73 <dt>pluginActivated(moduleName, pluginObject)</dt>
61 <dd> 74 <dd>
62 emitted just after 75 emitted just after
63 a plugin was activated 76 a plugin was activated
64 </dd><dt>pluginDeactivated(moduleName, pluginObject)</dt> 77 </dd>
78 <dt>pluginDeactivated(moduleName, pluginObject)</dt>
65 <dd> 79 <dd>
66 emitted just after 80 emitted just after
67 a plugin was deactivated 81 a plugin was deactivated
68 </dd><dt>shutdown()</dt> 82 </dd>
83 <dt>shutdown()</dt>
69 <dd> 84 <dd>
70 emitted at shutdown of the IDE 85 emitted at shutdown of the IDE
71 </dd> 86 </dd>
72 </dl> 87 </dl>
73 <h3>Derived from</h3> 88 <h3>Derived from</h3>
74 QObject 89 QObject
75 <h3>Class Attributes</h3> 90 <h3>Class Attributes</h3>
91
76 <table> 92 <table>
77 <tr><td>None</td></tr> 93 <tr><td>None</td></tr>
78 </table> 94 </table>
79 <h3>Class Methods</h3> 95 <h3>Class Methods</h3>
96
80 <table> 97 <table>
81 <tr><td>None</td></tr> 98 <tr><td>None</td></tr>
82 </table> 99 </table>
83 <h3>Methods</h3> 100 <h3>Methods</h3>
101
84 <table> 102 <table>
103
85 <tr> 104 <tr>
86 <td><a href="#PluginManager.__init__">PluginManager</a></td> 105 <td><a href="#PluginManager.__init__">PluginManager</a></td>
87 <td>Constructor</td> 106 <td>Constructor</td>
88 </tr><tr> 107 </tr>
108 <tr>
89 <td><a href="#PluginManager.__canActivatePlugin">__canActivatePlugin</a></td> 109 <td><a href="#PluginManager.__canActivatePlugin">__canActivatePlugin</a></td>
90 <td>Private method to check, if a plugin can be activated.</td> 110 <td>Private method to check, if a plugin can be activated.</td>
91 </tr><tr> 111 </tr>
112 <tr>
92 <td><a href="#PluginManager.__canDeactivatePlugin">__canDeactivatePlugin</a></td> 113 <td><a href="#PluginManager.__canDeactivatePlugin">__canDeactivatePlugin</a></td>
93 <td>Private method to check, if a plugin can be deactivated.</td> 114 <td>Private method to check, if a plugin can be deactivated.</td>
94 </tr><tr> 115 </tr>
116 <tr>
95 <td><a href="#PluginManager.__checkPluginsDownloadDirectory">__checkPluginsDownloadDirectory</a></td> 117 <td><a href="#PluginManager.__checkPluginsDownloadDirectory">__checkPluginsDownloadDirectory</a></td>
96 <td>Private slot to check for the existence of the plugins download directory.</td> 118 <td>Private slot to check for the existence of the plugins download directory.</td>
97 </tr><tr> 119 </tr>
120 <tr>
98 <td><a href="#PluginManager.__downloadRepositoryFileDone">__downloadRepositoryFileDone</a></td> 121 <td><a href="#PluginManager.__downloadRepositoryFileDone">__downloadRepositoryFileDone</a></td>
99 <td>Private method called after the repository file was downloaded.</td> 122 <td>Private method called after the repository file was downloaded.</td>
100 </tr><tr> 123 </tr>
124 <tr>
101 <td><a href="#PluginManager.__getShortInfo">__getShortInfo</a></td> 125 <td><a href="#PluginManager.__getShortInfo">__getShortInfo</a></td>
102 <td>Private method to extract the short info from a module.</td> 126 <td>Private method to extract the short info from a module.</td>
103 </tr><tr> 127 </tr>
128 <tr>
104 <td><a href="#PluginManager.__insertPluginsPaths">__insertPluginsPaths</a></td> 129 <td><a href="#PluginManager.__insertPluginsPaths">__insertPluginsPaths</a></td>
105 <td>Private method to insert the valid plugin paths intos the search path.</td> 130 <td>Private method to insert the valid plugin paths intos the search path.</td>
106 </tr><tr> 131 </tr>
132 <tr>
107 <td><a href="#PluginManager.__loadPlugins">__loadPlugins</a></td> 133 <td><a href="#PluginManager.__loadPlugins">__loadPlugins</a></td>
108 <td>Private method to load the plugins found.</td> 134 <td>Private method to load the plugins found.</td>
109 </tr><tr> 135 </tr>
136 <tr>
110 <td><a href="#PluginManager.__onlineStateChanged">__onlineStateChanged</a></td> 137 <td><a href="#PluginManager.__onlineStateChanged">__onlineStateChanged</a></td>
111 <td>Private slot handling changes in online state.</td> 138 <td>Private slot handling changes in online state.</td>
112 </tr><tr> 139 </tr>
140 <tr>
113 <td><a href="#PluginManager.__pluginDirectoriesExist">__pluginDirectoriesExist</a></td> 141 <td><a href="#PluginManager.__pluginDirectoriesExist">__pluginDirectoriesExist</a></td>
114 <td>Private method to check, if the plugin folders exist.</td> 142 <td>Private method to check, if the plugin folders exist.</td>
115 </tr><tr> 143 </tr>
144 <tr>
116 <td><a href="#PluginManager.__pluginModulesExist">__pluginModulesExist</a></td> 145 <td><a href="#PluginManager.__pluginModulesExist">__pluginModulesExist</a></td>
117 <td>Private method to check, if there are plugins available.</td> 146 <td>Private method to check, if there are plugins available.</td>
118 </tr><tr> 147 </tr>
148 <tr>
119 <td><a href="#PluginManager.__sslErrors">__sslErrors</a></td> 149 <td><a href="#PluginManager.__sslErrors">__sslErrors</a></td>
120 <td>Private slot to handle SSL errors.</td> 150 <td>Private slot to handle SSL errors.</td>
121 </tr><tr> 151 </tr>
152 <tr>
122 <td><a href="#PluginManager.activatePlugin">activatePlugin</a></td> 153 <td><a href="#PluginManager.activatePlugin">activatePlugin</a></td>
123 <td>Public method to activate a plugin.</td> 154 <td>Public method to activate a plugin.</td>
124 </tr><tr> 155 </tr>
156 <tr>
125 <td><a href="#PluginManager.activatePlugins">activatePlugins</a></td> 157 <td><a href="#PluginManager.activatePlugins">activatePlugins</a></td>
126 <td>Public method to activate all plugins having the "autoactivate" attribute set to True.</td> 158 <td>Public method to activate all plugins having the "autoactivate" attribute set to True.</td>
127 </tr><tr> 159 </tr>
160 <tr>
128 <td><a href="#PluginManager.checkPluginEntry">checkPluginEntry</a></td> 161 <td><a href="#PluginManager.checkPluginEntry">checkPluginEntry</a></td>
129 <td>Public method to check a plug-in's data for an update.</td> 162 <td>Public method to check a plug-in's data for an update.</td>
130 </tr><tr> 163 </tr>
164 <tr>
131 <td><a href="#PluginManager.checkPluginUpdatesAvailable">checkPluginUpdatesAvailable</a></td> 165 <td><a href="#PluginManager.checkPluginUpdatesAvailable">checkPluginUpdatesAvailable</a></td>
132 <td>Public method to check the availability of updates of plug-ins.</td> 166 <td>Public method to check the availability of updates of plug-ins.</td>
133 </tr><tr> 167 </tr>
168 <tr>
134 <td><a href="#PluginManager.clearPluginsPrivateData">clearPluginsPrivateData</a></td> 169 <td><a href="#PluginManager.clearPluginsPrivateData">clearPluginsPrivateData</a></td>
135 <td>Public method to clear the private data of plug-ins of a specified type.</td> 170 <td>Public method to clear the private data of plug-ins of a specified type.</td>
136 </tr><tr> 171 </tr>
172 <tr>
137 <td><a href="#PluginManager.deactivatePlugin">deactivatePlugin</a></td> 173 <td><a href="#PluginManager.deactivatePlugin">deactivatePlugin</a></td>
138 <td>Public method to deactivate a plugin.</td> 174 <td>Public method to deactivate a plugin.</td>
139 </tr><tr> 175 </tr>
176 <tr>
140 <td><a href="#PluginManager.deactivateVcsPlugins">deactivateVcsPlugins</a></td> 177 <td><a href="#PluginManager.deactivateVcsPlugins">deactivateVcsPlugins</a></td>
141 <td>Public method to deactivated all activated VCS plugins.</td> 178 <td>Public method to deactivated all activated VCS plugins.</td>
142 </tr><tr> 179 </tr>
180 <tr>
143 <td><a href="#PluginManager.doShutdown">doShutdown</a></td> 181 <td><a href="#PluginManager.doShutdown">doShutdown</a></td>
144 <td>Public method called to perform actions upon shutdown of the IDE.</td> 182 <td>Public method called to perform actions upon shutdown of the IDE.</td>
145 </tr><tr> 183 </tr>
184 <tr>
146 <td><a href="#PluginManager.finalizeSetup">finalizeSetup</a></td> 185 <td><a href="#PluginManager.finalizeSetup">finalizeSetup</a></td>
147 <td>Public method to finalize the setup of the plugin manager.</td> 186 <td>Public method to finalize the setup of the plugin manager.</td>
148 </tr><tr> 187 </tr>
188 <tr>
149 <td><a href="#PluginManager.getPluginApiFiles">getPluginApiFiles</a></td> 189 <td><a href="#PluginManager.getPluginApiFiles">getPluginApiFiles</a></td>
150 <td>Public method to get the list of API files installed by a plugin.</td> 190 <td>Public method to get the list of API files installed by a plugin.</td>
151 </tr><tr> 191 </tr>
192 <tr>
152 <td><a href="#PluginManager.getPluginConfigData">getPluginConfigData</a></td> 193 <td><a href="#PluginManager.getPluginConfigData">getPluginConfigData</a></td>
153 <td>Public method to get the config data of all active, non on-demand plugins used by the configuration dialog.</td> 194 <td>Public method to get the config data of all active, non on-demand plugins used by the configuration dialog.</td>
154 </tr><tr> 195 </tr>
196 <tr>
155 <td><a href="#PluginManager.getPluginDetails">getPluginDetails</a></td> 197 <td><a href="#PluginManager.getPluginDetails">getPluginDetails</a></td>
156 <td>Public method to get detailed information about a plugin.</td> 198 <td>Public method to get detailed information about a plugin.</td>
157 </tr><tr> 199 </tr>
200 <tr>
158 <td><a href="#PluginManager.getPluginDir">getPluginDir</a></td> 201 <td><a href="#PluginManager.getPluginDir">getPluginDir</a></td>
159 <td>Public method to get the path of a plugin directory.</td> 202 <td>Public method to get the path of a plugin directory.</td>
160 </tr><tr> 203 </tr>
204 <tr>
161 <td><a href="#PluginManager.getPluginDisplayStrings">getPluginDisplayStrings</a></td> 205 <td><a href="#PluginManager.getPluginDisplayStrings">getPluginDisplayStrings</a></td>
162 <td>Public method to get the display strings of all plugins of a specific type.</td> 206 <td>Public method to get the display strings of all plugins of a specific type.</td>
163 </tr><tr> 207 </tr>
208 <tr>
164 <td><a href="#PluginManager.getPluginExeDisplayData">getPluginExeDisplayData</a></td> 209 <td><a href="#PluginManager.getPluginExeDisplayData">getPluginExeDisplayData</a></td>
165 <td>Public method to get data to display information about a plugins external tool.</td> 210 <td>Public method to get data to display information about a plugins external tool.</td>
166 </tr><tr> 211 </tr>
212 <tr>
167 <td><a href="#PluginManager.getPluginInfos">getPluginInfos</a></td> 213 <td><a href="#PluginManager.getPluginInfos">getPluginInfos</a></td>
168 <td>Public method to get infos about all loaded plug-ins.</td> 214 <td>Public method to get infos about all loaded plug-ins.</td>
169 </tr><tr> 215 </tr>
216 <tr>
170 <td><a href="#PluginManager.getPluginModules">getPluginModules</a></td> 217 <td><a href="#PluginManager.getPluginModules">getPluginModules</a></td>
171 <td>Public method to get a list of plugin modules.</td> 218 <td>Public method to get a list of plugin modules.</td>
172 </tr><tr> 219 </tr>
220 <tr>
173 <td><a href="#PluginManager.getPluginObject">getPluginObject</a></td> 221 <td><a href="#PluginManager.getPluginObject">getPluginObject</a></td>
174 <td>Public method to activate an ondemand plugin given by type and typename.</td> 222 <td>Public method to activate an ondemand plugin given by type and typename.</td>
175 </tr><tr> 223 </tr>
224 <tr>
176 <td><a href="#PluginManager.getPluginPreviewPixmap">getPluginPreviewPixmap</a></td> 225 <td><a href="#PluginManager.getPluginPreviewPixmap">getPluginPreviewPixmap</a></td>
177 <td>Public method to get a preview pixmap of a plugin of a specific type.</td> 226 <td>Public method to get a preview pixmap of a plugin of a specific type.</td>
178 </tr><tr> 227 </tr>
228 <tr>
179 <td><a href="#PluginManager.getPluginQtHelpFiles">getPluginQtHelpFiles</a></td> 229 <td><a href="#PluginManager.getPluginQtHelpFiles">getPluginQtHelpFiles</a></td>
180 <td>Public method to get the list of QtHelp documentation files provided by a plug-in.</td> 230 <td>Public method to get the list of QtHelp documentation files provided by a plug-in.</td>
181 </tr><tr> 231 </tr>
232 <tr>
182 <td><a href="#PluginManager.getVcsSystemIndicators">getVcsSystemIndicators</a></td> 233 <td><a href="#PluginManager.getVcsSystemIndicators">getVcsSystemIndicators</a></td>
183 <td>Public method to get the Vcs System indicators.</td> 234 <td>Public method to get the Vcs System indicators.</td>
184 </tr><tr> 235 </tr>
236 <tr>
185 <td><a href="#PluginManager.initOnDemandPlugin">initOnDemandPlugin</a></td> 237 <td><a href="#PluginManager.initOnDemandPlugin">initOnDemandPlugin</a></td>
186 <td>Public method to create a plugin object for the named on demand plugin.</td> 238 <td>Public method to create a plugin object for the named on demand plugin.</td>
187 </tr><tr> 239 </tr>
240 <tr>
188 <td><a href="#PluginManager.initOnDemandPlugins">initOnDemandPlugins</a></td> 241 <td><a href="#PluginManager.initOnDemandPlugins">initOnDemandPlugins</a></td>
189 <td>Public method to create plugin objects for all on demand plugins.</td> 242 <td>Public method to create plugin objects for all on demand plugins.</td>
190 </tr><tr> 243 </tr>
244 <tr>
191 <td><a href="#PluginManager.initPluginToolbars">initPluginToolbars</a></td> 245 <td><a href="#PluginManager.initPluginToolbars">initPluginToolbars</a></td>
192 <td>Public method to initialize plug-in toolbars.</td> 246 <td>Public method to initialize plug-in toolbars.</td>
193 </tr><tr> 247 </tr>
248 <tr>
194 <td><a href="#PluginManager.isPluginActive">isPluginActive</a></td> 249 <td><a href="#PluginManager.isPluginActive">isPluginActive</a></td>
195 <td>Public method to check, if a certain plugin is active.</td> 250 <td>Public method to check, if a certain plugin is active.</td>
196 </tr><tr> 251 </tr>
252 <tr>
197 <td><a href="#PluginManager.isPluginLoaded">isPluginLoaded</a></td> 253 <td><a href="#PluginManager.isPluginLoaded">isPluginLoaded</a></td>
198 <td>Public method to check, if a certain plugin is loaded.</td> 254 <td>Public method to check, if a certain plugin is loaded.</td>
199 </tr><tr> 255 </tr>
256 <tr>
200 <td><a href="#PluginManager.isValidPluginName">isValidPluginName</a></td> 257 <td><a href="#PluginManager.isValidPluginName">isValidPluginName</a></td>
201 <td>Public methode to check, if a file name is a valid plugin name.</td> 258 <td>Public methode to check, if a file name is a valid plugin name.</td>
202 </tr><tr> 259 </tr>
260 <tr>
203 <td><a href="#PluginManager.loadDocumentationSetPlugins">loadDocumentationSetPlugins</a></td> 261 <td><a href="#PluginManager.loadDocumentationSetPlugins">loadDocumentationSetPlugins</a></td>
204 <td>Public method to load just the documentation sets plugins.</td> 262 <td>Public method to load just the documentation sets plugins.</td>
205 </tr><tr> 263 </tr>
264 <tr>
206 <td><a href="#PluginManager.loadPlugin">loadPlugin</a></td> 265 <td><a href="#PluginManager.loadPlugin">loadPlugin</a></td>
207 <td>Public method to load a plugin module.</td> 266 <td>Public method to load a plugin module.</td>
208 </tr><tr> 267 </tr>
268 <tr>
209 <td><a href="#PluginManager.preferencesChanged">preferencesChanged</a></td> 269 <td><a href="#PluginManager.preferencesChanged">preferencesChanged</a></td>
210 <td>Public slot to react to changes in configuration.</td> 270 <td>Public slot to react to changes in configuration.</td>
211 </tr><tr> 271 </tr>
272 <tr>
212 <td><a href="#PluginManager.removePluginFromSysModules">removePluginFromSysModules</a></td> 273 <td><a href="#PluginManager.removePluginFromSysModules">removePluginFromSysModules</a></td>
213 <td>Public method to remove a plugin and all related modules from sys.modules.</td> 274 <td>Public method to remove a plugin and all related modules from sys.modules.</td>
214 </tr><tr> 275 </tr>
276 <tr>
215 <td><a href="#PluginManager.unloadPlugin">unloadPlugin</a></td> 277 <td><a href="#PluginManager.unloadPlugin">unloadPlugin</a></td>
216 <td>Public method to unload a plugin module.</td> 278 <td>Public method to unload a plugin module.</td>
217 </tr> 279 </tr>
218 </table> 280 </table>
219 <h3>Static Methods</h3> 281 <h3>Static Methods</h3>
282
220 <table> 283 <table>
221 <tr><td>None</td></tr> 284 <tr><td>None</td></tr>
222 </table> 285 </table>
286
223 <a NAME="PluginManager.__init__" ID="PluginManager.__init__"></a> 287 <a NAME="PluginManager.__init__" ID="PluginManager.__init__"></a>
224 <h4>PluginManager (Constructor)</h4> 288 <h4>PluginManager (Constructor)</h4>
225 <b>PluginManager</b>(<i>parent=None, disabledPlugins=None, doLoadPlugins=True, develPlugin=None</i>) 289 <b>PluginManager</b>(<i>parent=None, disabledPlugins=None, doLoadPlugins=True, develPlugin=None</i>)
290
226 <p> 291 <p>
227 Constructor 292 Constructor
228 </p><p> 293 </p>
294 <p>
229 The Plugin Manager deals with three different plugin directories. 295 The Plugin Manager deals with three different plugin directories.
230 The first is the one, that is part of eric6 (eric6/Plugins). The 296 The first is the one, that is part of eric6 (eric6/Plugins). The
231 second one is the global plugin directory called 'eric6plugins', 297 second one is the global plugin directory called 'eric6plugins',
232 which is located inside the site-packages directory. The last one 298 which is located inside the site-packages directory. The last one
233 is the user plugin directory located inside the .eric6 directory 299 is the user plugin directory located inside the .eric6 directory
234 of the users home directory. 300 of the users home directory.
235 </p><dl> 301 </p>
302 <dl>
303
236 <dt><i>parent</i> (QObject)</dt> 304 <dt><i>parent</i> (QObject)</dt>
237 <dd> 305 <dd>
238 reference to the parent object 306 reference to the parent object
239 </dd><dt><i>disabledPlugins</i> (list of str)</dt> 307 </dd>
308 <dt><i>disabledPlugins</i> (list of str)</dt>
240 <dd> 309 <dd>
241 list of plug-ins that have been disabled via 310 list of plug-ins that have been disabled via
242 the command line parameters '--disable-plugin=' 311 the command line parameters '--disable-plugin='
243 </dd><dt><i>doLoadPlugins</i> (bool)</dt> 312 </dd>
313 <dt><i>doLoadPlugins</i> (bool)</dt>
244 <dd> 314 <dd>
245 flag indicating, that plug-ins should 315 flag indicating, that plug-ins should
246 be loaded 316 be loaded
247 </dd><dt><i>develPlugin</i> (str)</dt> 317 </dd>
318 <dt><i>develPlugin</i> (str)</dt>
248 <dd> 319 <dd>
249 filename of a plug-in to be loaded for 320 filename of a plug-in to be loaded for
250 development 321 development
251 </dd> 322 </dd>
252 </dl><dl> 323 </dl>
324 <dl>
325
253 <dt>Raises <b>PluginModulesError</b>:</dt> 326 <dt>Raises <b>PluginModulesError</b>:</dt>
254 <dd> 327 <dd>
255 raised to indicate the absence of 328 raised to indicate the absence of
256 plug-in modules 329 plug-in modules
257 </dd><dt>Raises <b>PluginPathError</b>:</dt> 330 </dd>
331 <dt>Raises <b>PluginPathError</b>:</dt>
258 <dd> 332 <dd>
259 raised to indicate an invalid plug-in path 333 raised to indicate an invalid plug-in path
260 </dd> 334 </dd>
261 </dl><a NAME="PluginManager.__canActivatePlugin" ID="PluginManager.__canActivatePlugin"></a> 335 </dl>
336 <a NAME="PluginManager.__canActivatePlugin" ID="PluginManager.__canActivatePlugin"></a>
262 <h4>PluginManager.__canActivatePlugin</h4> 337 <h4>PluginManager.__canActivatePlugin</h4>
263 <b>__canActivatePlugin</b>(<i>module</i>) 338 <b>__canActivatePlugin</b>(<i>module</i>)
339
264 <p> 340 <p>
265 Private method to check, if a plugin can be activated. 341 Private method to check, if a plugin can be activated.
266 </p><dl> 342 </p>
343 <dl>
344
267 <dt><i>module</i></dt> 345 <dt><i>module</i></dt>
268 <dd> 346 <dd>
269 reference to the module to be activated 347 reference to the module to be activated
270 </dd> 348 </dd>
271 </dl><dl> 349 </dl>
350 <dl>
272 <dt>Returns:</dt> 351 <dt>Returns:</dt>
273 <dd> 352 <dd>
274 flag indicating, if the module satisfies all requirements 353 flag indicating, if the module satisfies all requirements
275 for being activated (boolean) 354 for being activated (boolean)
276 </dd> 355 </dd>
277 </dl><dl> 356 </dl>
357 <dl>
358
278 <dt>Raises <b>PluginClassFormatError</b>:</dt> 359 <dt>Raises <b>PluginClassFormatError</b>:</dt>
279 <dd> 360 <dd>
280 raised to indicate an invalid 361 raised to indicate an invalid
281 plug-in class format 362 plug-in class format
282 </dd><dt>Raises <b>PluginModuleFormatError</b>:</dt> 363 </dd>
364 <dt>Raises <b>PluginModuleFormatError</b>:</dt>
283 <dd> 365 <dd>
284 raised to indicate an invalid 366 raised to indicate an invalid
285 plug-in module format 367 plug-in module format
286 </dd> 368 </dd>
287 </dl><a NAME="PluginManager.__canDeactivatePlugin" ID="PluginManager.__canDeactivatePlugin"></a> 369 </dl>
370 <a NAME="PluginManager.__canDeactivatePlugin" ID="PluginManager.__canDeactivatePlugin"></a>
288 <h4>PluginManager.__canDeactivatePlugin</h4> 371 <h4>PluginManager.__canDeactivatePlugin</h4>
289 <b>__canDeactivatePlugin</b>(<i>module</i>) 372 <b>__canDeactivatePlugin</b>(<i>module</i>)
373
290 <p> 374 <p>
291 Private method to check, if a plugin can be deactivated. 375 Private method to check, if a plugin can be deactivated.
292 </p><dl> 376 </p>
377 <dl>
378
293 <dt><i>module</i></dt> 379 <dt><i>module</i></dt>
294 <dd> 380 <dd>
295 reference to the module to be deactivated 381 reference to the module to be deactivated
296 </dd> 382 </dd>
297 </dl><dl> 383 </dl>
384 <dl>
298 <dt>Returns:</dt> 385 <dt>Returns:</dt>
299 <dd> 386 <dd>
300 flag indicating, if the module satisfies all requirements 387 flag indicating, if the module satisfies all requirements
301 for being deactivated (boolean) 388 for being deactivated (boolean)
302 </dd> 389 </dd>
303 </dl><a NAME="PluginManager.__checkPluginsDownloadDirectory" ID="PluginManager.__checkPluginsDownloadDirectory"></a> 390 </dl>
391 <a NAME="PluginManager.__checkPluginsDownloadDirectory" ID="PluginManager.__checkPluginsDownloadDirectory"></a>
304 <h4>PluginManager.__checkPluginsDownloadDirectory</h4> 392 <h4>PluginManager.__checkPluginsDownloadDirectory</h4>
305 <b>__checkPluginsDownloadDirectory</b>(<i></i>) 393 <b>__checkPluginsDownloadDirectory</b>(<i></i>)
394
306 <p> 395 <p>
307 Private slot to check for the existence of the plugins download 396 Private slot to check for the existence of the plugins download
308 directory. 397 directory.
309 </p><a NAME="PluginManager.__downloadRepositoryFileDone" ID="PluginManager.__downloadRepositoryFileDone"></a> 398 </p>
399 <a NAME="PluginManager.__downloadRepositoryFileDone" ID="PluginManager.__downloadRepositoryFileDone"></a>
310 <h4>PluginManager.__downloadRepositoryFileDone</h4> 400 <h4>PluginManager.__downloadRepositoryFileDone</h4>
311 <b>__downloadRepositoryFileDone</b>(<i>reply</i>) 401 <b>__downloadRepositoryFileDone</b>(<i>reply</i>)
402
312 <p> 403 <p>
313 Private method called after the repository file was downloaded. 404 Private method called after the repository file was downloaded.
314 </p><dl> 405 </p>
406 <dl>
407
315 <dt><i>reply</i> (QNetworkReply)</dt> 408 <dt><i>reply</i> (QNetworkReply)</dt>
316 <dd> 409 <dd>
317 reference to the reply object of the download 410 reference to the reply object of the download
318 </dd> 411 </dd>
319 </dl><a NAME="PluginManager.__getShortInfo" ID="PluginManager.__getShortInfo"></a> 412 </dl>
413 <a NAME="PluginManager.__getShortInfo" ID="PluginManager.__getShortInfo"></a>
320 <h4>PluginManager.__getShortInfo</h4> 414 <h4>PluginManager.__getShortInfo</h4>
321 <b>__getShortInfo</b>(<i>module</i>) 415 <b>__getShortInfo</b>(<i>module</i>)
416
322 <p> 417 <p>
323 Private method to extract the short info from a module. 418 Private method to extract the short info from a module.
324 </p><dl> 419 </p>
420 <dl>
421
325 <dt><i>module</i></dt> 422 <dt><i>module</i></dt>
326 <dd> 423 <dd>
327 module to extract short info from 424 module to extract short info from
328 </dd> 425 </dd>
329 </dl><dl> 426 </dl>
427 <dl>
330 <dt>Returns:</dt> 428 <dt>Returns:</dt>
331 <dd> 429 <dd>
332 dictionay containing plug-in data 430 dictionay containing plug-in data
333 </dd> 431 </dd>
334 </dl><dl> 432 </dl>
433 <dl>
335 <dt>Return Type:</dt> 434 <dt>Return Type:</dt>
336 <dd> 435 <dd>
337 dict ("plugin_name": str, "version": str, "short_desc": str, 436 dict ("plugin_name": str, "version": str, "short_desc": str,
338 "error": bool) 437 "error": bool)
339 </dd> 438 </dd>
340 </dl><a NAME="PluginManager.__insertPluginsPaths" ID="PluginManager.__insertPluginsPaths"></a> 439 </dl>
440 <a NAME="PluginManager.__insertPluginsPaths" ID="PluginManager.__insertPluginsPaths"></a>
341 <h4>PluginManager.__insertPluginsPaths</h4> 441 <h4>PluginManager.__insertPluginsPaths</h4>
342 <b>__insertPluginsPaths</b>(<i></i>) 442 <b>__insertPluginsPaths</b>(<i></i>)
443
343 <p> 444 <p>
344 Private method to insert the valid plugin paths intos the search path. 445 Private method to insert the valid plugin paths intos the search path.
345 </p><a NAME="PluginManager.__loadPlugins" ID="PluginManager.__loadPlugins"></a> 446 </p>
447 <a NAME="PluginManager.__loadPlugins" ID="PluginManager.__loadPlugins"></a>
346 <h4>PluginManager.__loadPlugins</h4> 448 <h4>PluginManager.__loadPlugins</h4>
347 <b>__loadPlugins</b>(<i></i>) 449 <b>__loadPlugins</b>(<i></i>)
450
348 <p> 451 <p>
349 Private method to load the plugins found. 452 Private method to load the plugins found.
350 </p><a NAME="PluginManager.__onlineStateChanged" ID="PluginManager.__onlineStateChanged"></a> 453 </p>
454 <a NAME="PluginManager.__onlineStateChanged" ID="PluginManager.__onlineStateChanged"></a>
351 <h4>PluginManager.__onlineStateChanged</h4> 455 <h4>PluginManager.__onlineStateChanged</h4>
352 <b>__onlineStateChanged</b>(<i>online</i>) 456 <b>__onlineStateChanged</b>(<i>online</i>)
457
353 <p> 458 <p>
354 Private slot handling changes in online state. 459 Private slot handling changes in online state.
355 </p><dl> 460 </p>
461 <dl>
462
356 <dt><i>online</i> (bool)</dt> 463 <dt><i>online</i> (bool)</dt>
357 <dd> 464 <dd>
358 flag indicating the online state 465 flag indicating the online state
359 </dd> 466 </dd>
360 </dl><a NAME="PluginManager.__pluginDirectoriesExist" ID="PluginManager.__pluginDirectoriesExist"></a> 467 </dl>
468 <a NAME="PluginManager.__pluginDirectoriesExist" ID="PluginManager.__pluginDirectoriesExist"></a>
361 <h4>PluginManager.__pluginDirectoriesExist</h4> 469 <h4>PluginManager.__pluginDirectoriesExist</h4>
362 <b>__pluginDirectoriesExist</b>(<i></i>) 470 <b>__pluginDirectoriesExist</b>(<i></i>)
471
363 <p> 472 <p>
364 Private method to check, if the plugin folders exist. 473 Private method to check, if the plugin folders exist.
365 </p><p> 474 </p>
475 <p>
366 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).
367 </p><dl> 477 </p>
478 <dl>
368 <dt>Returns:</dt> 479 <dt>Returns:</dt>
369 <dd> 480 <dd>
370 tuple of a flag indicating existence of any of the plugin 481 tuple of a flag indicating existence of any of the plugin
371 directories (boolean) and a message (string) 482 directories (boolean) and a message (string)
372 </dd> 483 </dd>
373 </dl><a NAME="PluginManager.__pluginModulesExist" ID="PluginManager.__pluginModulesExist"></a> 484 </dl>
485 <a NAME="PluginManager.__pluginModulesExist" ID="PluginManager.__pluginModulesExist"></a>
374 <h4>PluginManager.__pluginModulesExist</h4> 486 <h4>PluginManager.__pluginModulesExist</h4>
375 <b>__pluginModulesExist</b>(<i></i>) 487 <b>__pluginModulesExist</b>(<i></i>)
488
376 <p> 489 <p>
377 Private method to check, if there are plugins available. 490 Private method to check, if there are plugins available.
378 </p><dl> 491 </p>
492 <dl>
379 <dt>Returns:</dt> 493 <dt>Returns:</dt>
380 <dd> 494 <dd>
381 flag indicating the availability of plugins (boolean) 495 flag indicating the availability of plugins (boolean)
382 </dd> 496 </dd>
383 </dl><a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a> 497 </dl>
498 <a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a>
384 <h4>PluginManager.__sslErrors</h4> 499 <h4>PluginManager.__sslErrors</h4>
385 <b>__sslErrors</b>(<i>reply, errors</i>) 500 <b>__sslErrors</b>(<i>reply, errors</i>)
501
386 <p> 502 <p>
387 Private slot to handle SSL errors. 503 Private slot to handle SSL errors.
388 </p><dl> 504 </p>
505 <dl>
506
389 <dt><i>reply</i></dt> 507 <dt><i>reply</i></dt>
390 <dd> 508 <dd>
391 reference to the reply object (QNetworkReply) 509 reference to the reply object (QNetworkReply)
392 </dd><dt><i>errors</i></dt> 510 </dd>
511 <dt><i>errors</i></dt>
393 <dd> 512 <dd>
394 list of SSL errors (list of QSslError) 513 list of SSL errors (list of QSslError)
395 </dd> 514 </dd>
396 </dl><a NAME="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a> 515 </dl>
516 <a NAME="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a>
397 <h4>PluginManager.activatePlugin</h4> 517 <h4>PluginManager.activatePlugin</h4>
398 <b>activatePlugin</b>(<i>name, onDemand=False</i>) 518 <b>activatePlugin</b>(<i>name, onDemand=False</i>)
519
399 <p> 520 <p>
400 Public method to activate a plugin. 521 Public method to activate a plugin.
401 </p><dl> 522 </p>
523 <dl>
524
402 <dt><i>name</i></dt> 525 <dt><i>name</i></dt>
403 <dd> 526 <dd>
404 name of the module to be activated 527 name of the module to be activated
405 </dd><dt><i>onDemand=</i></dt> 528 </dd>
529 <dt><i>onDemand=</i></dt>
406 <dd> 530 <dd>
407 flag indicating activation of an 531 flag indicating activation of an
408 on demand plugin (boolean) 532 on demand plugin (boolean)
409 </dd> 533 </dd>
410 </dl><dl> 534 </dl>
535 <dl>
411 <dt>Returns:</dt> 536 <dt>Returns:</dt>
412 <dd> 537 <dd>
413 reference to the initialized plugin object 538 reference to the initialized plugin object
414 </dd> 539 </dd>
415 </dl><dl> 540 </dl>
541 <dl>
542
416 <dt>Raises <b>PluginActivationError</b>:</dt> 543 <dt>Raises <b>PluginActivationError</b>:</dt>
417 <dd> 544 <dd>
418 raised to indicate an issue during the 545 raised to indicate an issue during the
419 plug-in activation 546 plug-in activation
420 </dd> 547 </dd>
421 </dl><a NAME="PluginManager.activatePlugins" ID="PluginManager.activatePlugins"></a> 548 </dl>
549 <a NAME="PluginManager.activatePlugins" ID="PluginManager.activatePlugins"></a>
422 <h4>PluginManager.activatePlugins</h4> 550 <h4>PluginManager.activatePlugins</h4>
423 <b>activatePlugins</b>(<i></i>) 551 <b>activatePlugins</b>(<i></i>)
552
424 <p> 553 <p>
425 Public method to activate all plugins having the "autoactivate" 554 Public method to activate all plugins having the "autoactivate"
426 attribute set to True. 555 attribute set to True.
427 </p><a NAME="PluginManager.checkPluginEntry" ID="PluginManager.checkPluginEntry"></a> 556 </p>
557 <a NAME="PluginManager.checkPluginEntry" ID="PluginManager.checkPluginEntry"></a>
428 <h4>PluginManager.checkPluginEntry</h4> 558 <h4>PluginManager.checkPluginEntry</h4>
429 <b>checkPluginEntry</b>(<i>name, short, description, url, author, version, filename, status</i>) 559 <b>checkPluginEntry</b>(<i>name, short, description, url, author, version, filename, status</i>)
560
430 <p> 561 <p>
431 Public method to check a plug-in's data for an update. 562 Public method to check a plug-in's data for an update.
432 </p><dl> 563 </p>
564 <dl>
565
433 <dt><i>name</i></dt> 566 <dt><i>name</i></dt>
434 <dd> 567 <dd>
435 data for the name field (string) 568 data for the name field (string)
436 </dd><dt><i>short</i></dt> 569 </dd>
570 <dt><i>short</i></dt>
437 <dd> 571 <dd>
438 data for the short field (string) 572 data for the short field (string)
439 </dd><dt><i>description</i></dt> 573 </dd>
574 <dt><i>description</i></dt>
440 <dd> 575 <dd>
441 data for the description field (list of strings) 576 data for the description field (list of strings)
442 </dd><dt><i>url</i></dt> 577 </dd>
578 <dt><i>url</i></dt>
443 <dd> 579 <dd>
444 data for the url field (string) 580 data for the url field (string)
445 </dd><dt><i>author</i></dt> 581 </dd>
582 <dt><i>author</i></dt>
446 <dd> 583 <dd>
447 data for the author field (string) 584 data for the author field (string)
448 </dd><dt><i>version</i></dt> 585 </dd>
586 <dt><i>version</i></dt>
449 <dd> 587 <dd>
450 data for the version field (string) 588 data for the version field (string)
451 </dd><dt><i>filename</i></dt> 589 </dd>
590 <dt><i>filename</i></dt>
452 <dd> 591 <dd>
453 data for the filename field (string) 592 data for the filename field (string)
454 </dd><dt><i>status</i></dt> 593 </dd>
594 <dt><i>status</i></dt>
455 <dd> 595 <dd>
456 status of the plugin (string [stable, unstable, unknown]) 596 status of the plugin (string [stable, unstable, unknown])
457 </dd> 597 </dd>
458 </dl><a NAME="PluginManager.checkPluginUpdatesAvailable" ID="PluginManager.checkPluginUpdatesAvailable"></a> 598 </dl>
599 <a NAME="PluginManager.checkPluginUpdatesAvailable" ID="PluginManager.checkPluginUpdatesAvailable"></a>
459 <h4>PluginManager.checkPluginUpdatesAvailable</h4> 600 <h4>PluginManager.checkPluginUpdatesAvailable</h4>
460 <b>checkPluginUpdatesAvailable</b>(<i></i>) 601 <b>checkPluginUpdatesAvailable</b>(<i></i>)
602
461 <p> 603 <p>
462 Public method to check the availability of updates of plug-ins. 604 Public method to check the availability of updates of plug-ins.
463 </p><a NAME="PluginManager.clearPluginsPrivateData" ID="PluginManager.clearPluginsPrivateData"></a> 605 </p>
606 <a NAME="PluginManager.clearPluginsPrivateData" ID="PluginManager.clearPluginsPrivateData"></a>
464 <h4>PluginManager.clearPluginsPrivateData</h4> 607 <h4>PluginManager.clearPluginsPrivateData</h4>
465 <b>clearPluginsPrivateData</b>(<i>type_</i>) 608 <b>clearPluginsPrivateData</b>(<i>type_</i>)
609
466 <p> 610 <p>
467 Public method to clear the private data of plug-ins of a specified 611 Public method to clear the private data of plug-ins of a specified
468 type. 612 type.
469 </p><p> 613 </p>
614 <p>
470 Plugins supporting this functionality must support the module function 615 Plugins supporting this functionality must support the module function
471 clearPrivateData() and have the module level attribute pluginType. 616 clearPrivateData() and have the module level attribute pluginType.
472 </p><dl> 617 </p>
618 <dl>
619
473 <dt><i>type_</i></dt> 620 <dt><i>type_</i></dt>
474 <dd> 621 <dd>
475 type of the plugin to clear private data for (string) 622 type of the plugin to clear private data for (string)
476 </dd> 623 </dd>
477 </dl><a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a> 624 </dl>
625 <a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a>
478 <h4>PluginManager.deactivatePlugin</h4> 626 <h4>PluginManager.deactivatePlugin</h4>
479 <b>deactivatePlugin</b>(<i>name, onDemand=False</i>) 627 <b>deactivatePlugin</b>(<i>name, onDemand=False</i>)
628
480 <p> 629 <p>
481 Public method to deactivate a plugin. 630 Public method to deactivate a plugin.
482 </p><dl> 631 </p>
632 <dl>
633
483 <dt><i>name</i></dt> 634 <dt><i>name</i></dt>
484 <dd> 635 <dd>
485 name of the module to be deactivated 636 name of the module to be deactivated
486 </dd><dt><i>onDemand=</i></dt> 637 </dd>
638 <dt><i>onDemand=</i></dt>
487 <dd> 639 <dd>
488 flag indicating deactivation of an 640 flag indicating deactivation of an
489 on demand plugin (boolean) 641 on demand plugin (boolean)
490 </dd> 642 </dd>
491 </dl><a NAME="PluginManager.deactivateVcsPlugins" ID="PluginManager.deactivateVcsPlugins"></a> 643 </dl>
644 <a NAME="PluginManager.deactivateVcsPlugins" ID="PluginManager.deactivateVcsPlugins"></a>
492 <h4>PluginManager.deactivateVcsPlugins</h4> 645 <h4>PluginManager.deactivateVcsPlugins</h4>
493 <b>deactivateVcsPlugins</b>(<i></i>) 646 <b>deactivateVcsPlugins</b>(<i></i>)
647
494 <p> 648 <p>
495 Public method to deactivated all activated VCS plugins. 649 Public method to deactivated all activated VCS plugins.
496 </p><a NAME="PluginManager.doShutdown" ID="PluginManager.doShutdown"></a> 650 </p>
651 <a NAME="PluginManager.doShutdown" ID="PluginManager.doShutdown"></a>
497 <h4>PluginManager.doShutdown</h4> 652 <h4>PluginManager.doShutdown</h4>
498 <b>doShutdown</b>(<i></i>) 653 <b>doShutdown</b>(<i></i>)
654
499 <p> 655 <p>
500 Public method called to perform actions upon shutdown of the IDE. 656 Public method called to perform actions upon shutdown of the IDE.
501 </p><a NAME="PluginManager.finalizeSetup" ID="PluginManager.finalizeSetup"></a> 657 </p>
658 <a NAME="PluginManager.finalizeSetup" ID="PluginManager.finalizeSetup"></a>
502 <h4>PluginManager.finalizeSetup</h4> 659 <h4>PluginManager.finalizeSetup</h4>
503 <b>finalizeSetup</b>(<i></i>) 660 <b>finalizeSetup</b>(<i></i>)
661
504 <p> 662 <p>
505 Public method to finalize the setup of the plugin manager. 663 Public method to finalize the setup of the plugin manager.
506 </p><a NAME="PluginManager.getPluginApiFiles" ID="PluginManager.getPluginApiFiles"></a> 664 </p>
665 <a NAME="PluginManager.getPluginApiFiles" ID="PluginManager.getPluginApiFiles"></a>
507 <h4>PluginManager.getPluginApiFiles</h4> 666 <h4>PluginManager.getPluginApiFiles</h4>
508 <b>getPluginApiFiles</b>(<i>language</i>) 667 <b>getPluginApiFiles</b>(<i>language</i>)
668
509 <p> 669 <p>
510 Public method to get the list of API files installed by a plugin. 670 Public method to get the list of API files installed by a plugin.
511 </p><dl> 671 </p>
672 <dl>
673
512 <dt><i>language</i></dt> 674 <dt><i>language</i></dt>
513 <dd> 675 <dd>
514 language of the requested API files (string) 676 language of the requested API files (string)
515 </dd> 677 </dd>
516 </dl><dl> 678 </dl>
679 <dl>
517 <dt>Returns:</dt> 680 <dt>Returns:</dt>
518 <dd> 681 <dd>
519 list of API filenames (list of string) 682 list of API filenames (list of string)
520 </dd> 683 </dd>
521 </dl><a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a> 684 </dl>
685 <a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a>
522 <h4>PluginManager.getPluginConfigData</h4> 686 <h4>PluginManager.getPluginConfigData</h4>
523 <b>getPluginConfigData</b>(<i></i>) 687 <b>getPluginConfigData</b>(<i></i>)
688
524 <p> 689 <p>
525 Public method to get the config data of all active, non on-demand 690 Public method to get the config data of all active, non on-demand
526 plugins used by the configuration dialog. 691 plugins used by the configuration dialog.
527 </p><p> 692 </p>
693 <p>
528 Plugins supporting this functionality must provide the plugin module 694 Plugins supporting this functionality must provide the plugin module
529 function 'getConfigData' returning a dictionary with unique keys 695 function 'getConfigData' returning a dictionary with unique keys
530 of lists with the following list contents: 696 of lists with the following list contents:
531 <dl> 697 <dl>
532 <dt>display string</dt> 698 <dt>display string</dt>
547 toplevel entry.</dd> 713 toplevel entry.</dd>
548 <dt>reference to configuration page</dt> 714 <dt>reference to configuration page</dt>
549 <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
550 be None</dd> 716 be None</dd>
551 </dl> 717 </dl>
552 </p><dl> 718 </p>
719 <dl>
553 <dt>Returns:</dt> 720 <dt>Returns:</dt>
554 <dd> 721 <dd>
555 plug-in configuration data 722 plug-in configuration data
556 </dd> 723 </dd>
557 </dl><a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> 724 </dl>
725 <a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a>
558 <h4>PluginManager.getPluginDetails</h4> 726 <h4>PluginManager.getPluginDetails</h4>
559 <b>getPluginDetails</b>(<i>name</i>) 727 <b>getPluginDetails</b>(<i>name</i>)
728
560 <p> 729 <p>
561 Public method to get detailed information about a plugin. 730 Public method to get detailed information about a plugin.
562 </p><dl> 731 </p>
732 <dl>
733
563 <dt><i>name</i></dt> 734 <dt><i>name</i></dt>
564 <dd> 735 <dd>
565 name of the module to get detailed infos about (string) 736 name of the module to get detailed infos about (string)
566 </dd> 737 </dd>
567 </dl><dl> 738 </dl>
739 <dl>
568 <dt>Returns:</dt> 740 <dt>Returns:</dt>
569 <dd> 741 <dd>
570 details of the plugin as a dictionary 742 details of the plugin as a dictionary
571 </dd> 743 </dd>
572 </dl><a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a> 744 </dl>
745 <a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a>
573 <h4>PluginManager.getPluginDir</h4> 746 <h4>PluginManager.getPluginDir</h4>
574 <b>getPluginDir</b>(<i>key</i>) 747 <b>getPluginDir</b>(<i>key</i>)
748
575 <p> 749 <p>
576 Public method to get the path of a plugin directory. 750 Public method to get the path of a plugin directory.
577 </p><dl> 751 </p>
752 <dl>
753
578 <dt><i>key</i></dt> 754 <dt><i>key</i></dt>
579 <dd> 755 <dd>
580 key of the plug-in directory (string) 756 key of the plug-in directory (string)
581 </dd> 757 </dd>
582 </dl><dl> 758 </dl>
759 <dl>
583 <dt>Returns:</dt> 760 <dt>Returns:</dt>
584 <dd> 761 <dd>
585 path of the requested plugin directory (string) 762 path of the requested plugin directory (string)
586 </dd> 763 </dd>
587 </dl><a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a> 764 </dl>
765 <a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a>
588 <h4>PluginManager.getPluginDisplayStrings</h4> 766 <h4>PluginManager.getPluginDisplayStrings</h4>
589 <b>getPluginDisplayStrings</b>(<i>type_</i>) 767 <b>getPluginDisplayStrings</b>(<i>type_</i>)
768
590 <p> 769 <p>
591 Public method to get the display strings of all plugins of a specific 770 Public method to get the display strings of all plugins of a specific
592 type. 771 type.
593 </p><dl> 772 </p>
773 <dl>
774
594 <dt><i>type_</i></dt> 775 <dt><i>type_</i></dt>
595 <dd> 776 <dd>
596 type of the plugins (string) 777 type of the plugins (string)
597 </dd> 778 </dd>
598 </dl><dl> 779 </dl>
780 <dl>
599 <dt>Returns:</dt> 781 <dt>Returns:</dt>
600 <dd> 782 <dd>
601 dictionary with name as key and display string as value 783 dictionary with name as key and display string as value
602 (dictionary of string) 784 (dictionary of string)
603 </dd> 785 </dd>
604 </dl><a NAME="PluginManager.getPluginExeDisplayData" ID="PluginManager.getPluginExeDisplayData"></a> 786 </dl>
787 <a NAME="PluginManager.getPluginExeDisplayData" ID="PluginManager.getPluginExeDisplayData"></a>
605 <h4>PluginManager.getPluginExeDisplayData</h4> 788 <h4>PluginManager.getPluginExeDisplayData</h4>
606 <b>getPluginExeDisplayData</b>(<i></i>) 789 <b>getPluginExeDisplayData</b>(<i></i>)
790
607 <p> 791 <p>
608 Public method to get data to display information about a plugins 792 Public method to get data to display information about a plugins
609 external tool. 793 external tool.
610 </p><dl> 794 </p>
795 <dl>
611 <dt>Returns:</dt> 796 <dt>Returns:</dt>
612 <dd> 797 <dd>
613 list of dictionaries containing the data. Each dictionary must 798 list of dictionaries containing the data. Each dictionary must
614 either contain data for the determination or the data to be 799 either contain data for the determination or the data to be
615 displayed.<br /> 800 displayed.<br />
637 <li>header - string to be diplayed as a header (string)</li> 822 <li>header - string to be diplayed as a header (string)</li>
638 <li>text - entry text to be shown (string)</li> 823 <li>text - entry text to be shown (string)</li>
639 <li>version - version text to be shown (string)</li> 824 <li>version - version text to be shown (string)</li>
640 </ul> 825 </ul>
641 </dd> 826 </dd>
642 </dl><a NAME="PluginManager.getPluginInfos" ID="PluginManager.getPluginInfos"></a> 827 </dl>
828 <a NAME="PluginManager.getPluginInfos" ID="PluginManager.getPluginInfos"></a>
643 <h4>PluginManager.getPluginInfos</h4> 829 <h4>PluginManager.getPluginInfos</h4>
644 <b>getPluginInfos</b>(<i></i>) 830 <b>getPluginInfos</b>(<i></i>)
831
645 <p> 832 <p>
646 Public method to get infos about all loaded plug-ins. 833 Public method to get infos about all loaded plug-ins.
647 </p><dl> 834 </p>
835 <dl>
648 <dt>Returns:</dt> 836 <dt>Returns:</dt>
649 <dd> 837 <dd>
650 list of dictionaries with keys "module_name", "plugin_name", 838 list of dictionaries with keys "module_name", "plugin_name",
651 "version", "auto_activate", "active", "short_desc", "error" 839 "version", "auto_activate", "active", "short_desc", "error"
652 </dd> 840 </dd>
653 </dl><dl> 841 </dl>
842 <dl>
654 <dt>Return Type:</dt> 843 <dt>Return Type:</dt>
655 <dd> 844 <dd>
656 list of dict ("module_name": str, "plugin_name": str, 845 list of dict ("module_name": str, "plugin_name": str,
657 "version": str, "auto_activate": bool, "active": bool, 846 "version": str, "auto_activate": bool, "active": bool,
658 "short_desc": str, "error": bool) 847 "short_desc": str, "error": bool)
659 </dd> 848 </dd>
660 </dl><a NAME="PluginManager.getPluginModules" ID="PluginManager.getPluginModules"></a> 849 </dl>
850 <a NAME="PluginManager.getPluginModules" ID="PluginManager.getPluginModules"></a>
661 <h4>PluginManager.getPluginModules</h4> 851 <h4>PluginManager.getPluginModules</h4>
662 <b>getPluginModules</b>(<i>pluginPath</i>) 852 <b>getPluginModules</b>(<i>pluginPath</i>)
853
663 <p> 854 <p>
664 Public method to get a list of plugin modules. 855 Public method to get a list of plugin modules.
665 </p><dl> 856 </p>
857 <dl>
858
666 <dt><i>pluginPath</i></dt> 859 <dt><i>pluginPath</i></dt>
667 <dd> 860 <dd>
668 name of the path to search (string) 861 name of the path to search (string)
669 </dd> 862 </dd>
670 </dl><dl> 863 </dl>
864 <dl>
671 <dt>Returns:</dt> 865 <dt>Returns:</dt>
672 <dd> 866 <dd>
673 list of plugin module names (list of string) 867 list of plugin module names (list of string)
674 </dd> 868 </dd>
675 </dl><a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a> 869 </dl>
870 <a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a>
676 <h4>PluginManager.getPluginObject</h4> 871 <h4>PluginManager.getPluginObject</h4>
677 <b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>) 872 <b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>)
873
678 <p> 874 <p>
679 Public method to activate an ondemand plugin given by type and 875 Public method to activate an ondemand plugin given by type and
680 typename. 876 typename.
681 </p><dl> 877 </p>
878 <dl>
879
682 <dt><i>type_</i></dt> 880 <dt><i>type_</i></dt>
683 <dd> 881 <dd>
684 type of the plugin to be activated (string) 882 type of the plugin to be activated (string)
685 </dd><dt><i>typename</i></dt> 883 </dd>
884 <dt><i>typename</i></dt>
686 <dd> 885 <dd>
687 name of the plugin within the type category (string) 886 name of the plugin within the type category (string)
688 </dd><dt><i>maybeActive=</i></dt> 887 </dd>
888 <dt><i>maybeActive=</i></dt>
689 <dd> 889 <dd>
690 flag indicating, that the plugin may be active 890 flag indicating, that the plugin may be active
691 already (boolean) 891 already (boolean)
692 </dd> 892 </dd>
693 </dl><dl> 893 </dl>
894 <dl>
694 <dt>Returns:</dt> 895 <dt>Returns:</dt>
695 <dd> 896 <dd>
696 reference to the initialized plugin object 897 reference to the initialized plugin object
697 </dd> 898 </dd>
698 </dl><a NAME="PluginManager.getPluginPreviewPixmap" ID="PluginManager.getPluginPreviewPixmap"></a> 899 </dl>
900 <a NAME="PluginManager.getPluginPreviewPixmap" ID="PluginManager.getPluginPreviewPixmap"></a>
699 <h4>PluginManager.getPluginPreviewPixmap</h4> 901 <h4>PluginManager.getPluginPreviewPixmap</h4>
700 <b>getPluginPreviewPixmap</b>(<i>type_, name</i>) 902 <b>getPluginPreviewPixmap</b>(<i>type_, name</i>)
903
701 <p> 904 <p>
702 Public method to get a preview pixmap of a plugin of a specific type. 905 Public method to get a preview pixmap of a plugin of a specific type.
703 </p><dl> 906 </p>
907 <dl>
908
704 <dt><i>type_</i></dt> 909 <dt><i>type_</i></dt>
705 <dd> 910 <dd>
706 type of the plugin (string) 911 type of the plugin (string)
707 </dd><dt><i>name</i></dt> 912 </dd>
913 <dt><i>name</i></dt>
708 <dd> 914 <dd>
709 name of the plugin type (string) 915 name of the plugin type (string)
710 </dd> 916 </dd>
711 </dl><dl> 917 </dl>
918 <dl>
712 <dt>Returns:</dt> 919 <dt>Returns:</dt>
713 <dd> 920 <dd>
714 preview pixmap (QPixmap) 921 preview pixmap (QPixmap)
715 </dd> 922 </dd>
716 </dl><a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a> 923 </dl>
924 <a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a>
717 <h4>PluginManager.getPluginQtHelpFiles</h4> 925 <h4>PluginManager.getPluginQtHelpFiles</h4>
718 <b>getPluginQtHelpFiles</b>(<i></i>) 926 <b>getPluginQtHelpFiles</b>(<i></i>)
927
719 <p> 928 <p>
720 Public method to get the list of QtHelp documentation files provided 929 Public method to get the list of QtHelp documentation files provided
721 by a plug-in. 930 by a plug-in.
722 </p><dl> 931 </p>
932 <dl>
723 <dt>Returns:</dt> 933 <dt>Returns:</dt>
724 <dd> 934 <dd>
725 dictionary with documentation type as key and list of files 935 dictionary with documentation type as key and list of files
726 as value 936 as value
727 </dd> 937 </dd>
728 </dl><dl> 938 </dl>
939 <dl>
729 <dt>Return Type:</dt> 940 <dt>Return Type:</dt>
730 <dd> 941 <dd>
731 dict (key: str, value: list of str) 942 dict (key: str, value: list of str)
732 </dd> 943 </dd>
733 </dl><a NAME="PluginManager.getVcsSystemIndicators" ID="PluginManager.getVcsSystemIndicators"></a> 944 </dl>
945 <a NAME="PluginManager.getVcsSystemIndicators" ID="PluginManager.getVcsSystemIndicators"></a>
734 <h4>PluginManager.getVcsSystemIndicators</h4> 946 <h4>PluginManager.getVcsSystemIndicators</h4>
735 <b>getVcsSystemIndicators</b>(<i></i>) 947 <b>getVcsSystemIndicators</b>(<i></i>)
948
736 <p> 949 <p>
737 Public method to get the Vcs System indicators. 950 Public method to get the Vcs System indicators.
738 </p><p> 951 </p>
952 <p>
739 Plugins supporting this functionality must support the module function 953 Plugins supporting this functionality must support the module function
740 getVcsSystemIndicator returning a dictionary with indicator as key and 954 getVcsSystemIndicator returning a dictionary with indicator as key and
741 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).
742 </p><dl> 956 </p>
957 <dl>
743 <dt>Returns:</dt> 958 <dt>Returns:</dt>
744 <dd> 959 <dd>
745 dictionary with indicator as key and a list of tuples as 960 dictionary with indicator as key and a list of tuples as
746 values. Each tuple contains the vcs name (string) and vcs display 961 values. Each tuple contains the vcs name (string) and vcs display
747 string (string). 962 string (string).
748 </dd> 963 </dd>
749 </dl><a NAME="PluginManager.initOnDemandPlugin" ID="PluginManager.initOnDemandPlugin"></a> 964 </dl>
965 <a NAME="PluginManager.initOnDemandPlugin" ID="PluginManager.initOnDemandPlugin"></a>
750 <h4>PluginManager.initOnDemandPlugin</h4> 966 <h4>PluginManager.initOnDemandPlugin</h4>
751 <b>initOnDemandPlugin</b>(<i>name</i>) 967 <b>initOnDemandPlugin</b>(<i>name</i>)
968
752 <p> 969 <p>
753 Public method to create a plugin object for the named on demand plugin. 970 Public method to create a plugin object for the named on demand plugin.
754 </p><p> 971 </p>
972 <p>
755 Note: The plug-in is not activated. 973 Note: The plug-in is not activated.
756 </p><dl> 974 </p>
975 <dl>
976
757 <dt><i>name</i></dt> 977 <dt><i>name</i></dt>
758 <dd> 978 <dd>
759 name of the plug-in (string) 979 name of the plug-in (string)
760 </dd> 980 </dd>
761 </dl><dl> 981 </dl>
982 <dl>
983
762 <dt>Raises <b>PluginActivationError</b>:</dt> 984 <dt>Raises <b>PluginActivationError</b>:</dt>
763 <dd> 985 <dd>
764 raised to indicate an issue during the 986 raised to indicate an issue during the
765 plug-in activation 987 plug-in activation
766 </dd> 988 </dd>
767 </dl><a NAME="PluginManager.initOnDemandPlugins" ID="PluginManager.initOnDemandPlugins"></a> 989 </dl>
990 <a NAME="PluginManager.initOnDemandPlugins" ID="PluginManager.initOnDemandPlugins"></a>
768 <h4>PluginManager.initOnDemandPlugins</h4> 991 <h4>PluginManager.initOnDemandPlugins</h4>
769 <b>initOnDemandPlugins</b>(<i></i>) 992 <b>initOnDemandPlugins</b>(<i></i>)
993
770 <p> 994 <p>
771 Public method to create plugin objects for all on demand plugins. 995 Public method to create plugin objects for all on demand plugins.
772 </p><p> 996 </p>
997 <p>
773 Note: The plugins are not activated. 998 Note: The plugins are not activated.
774 </p><a NAME="PluginManager.initPluginToolbars" ID="PluginManager.initPluginToolbars"></a> 999 </p>
1000 <a NAME="PluginManager.initPluginToolbars" ID="PluginManager.initPluginToolbars"></a>
775 <h4>PluginManager.initPluginToolbars</h4> 1001 <h4>PluginManager.initPluginToolbars</h4>
776 <b>initPluginToolbars</b>(<i>toolbarManager</i>) 1002 <b>initPluginToolbars</b>(<i>toolbarManager</i>)
1003
777 <p> 1004 <p>
778 Public method to initialize plug-in toolbars. 1005 Public method to initialize plug-in toolbars.
779 </p><dl> 1006 </p>
1007 <dl>
1008
780 <dt><i>toolbarManager</i></dt> 1009 <dt><i>toolbarManager</i></dt>
781 <dd> 1010 <dd>
782 reference to the toolbar manager object 1011 reference to the toolbar manager object
783 (E5ToolBarManager) 1012 (E5ToolBarManager)
784 </dd> 1013 </dd>
785 </dl><a NAME="PluginManager.isPluginActive" ID="PluginManager.isPluginActive"></a> 1014 </dl>
1015 <a NAME="PluginManager.isPluginActive" ID="PluginManager.isPluginActive"></a>
786 <h4>PluginManager.isPluginActive</h4> 1016 <h4>PluginManager.isPluginActive</h4>
787 <b>isPluginActive</b>(<i>pluginName</i>) 1017 <b>isPluginActive</b>(<i>pluginName</i>)
1018
788 <p> 1019 <p>
789 Public method to check, if a certain plugin is active. 1020 Public method to check, if a certain plugin is active.
790 </p><dl> 1021 </p>
1022 <dl>
1023
791 <dt><i>pluginName</i></dt> 1024 <dt><i>pluginName</i></dt>
792 <dd> 1025 <dd>
793 name of the plugin to check for (string) 1026 name of the plugin to check for (string)
794 </dd> 1027 </dd>
795 </dl><dl> 1028 </dl>
1029 <dl>
796 <dt>Returns:</dt> 1030 <dt>Returns:</dt>
797 <dd> 1031 <dd>
798 flag indicating, if the plugin is active (boolean) 1032 flag indicating, if the plugin is active (boolean)
799 </dd> 1033 </dd>
800 </dl><a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a> 1034 </dl>
1035 <a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a>
801 <h4>PluginManager.isPluginLoaded</h4> 1036 <h4>PluginManager.isPluginLoaded</h4>
802 <b>isPluginLoaded</b>(<i>pluginName</i>) 1037 <b>isPluginLoaded</b>(<i>pluginName</i>)
1038
803 <p> 1039 <p>
804 Public method to check, if a certain plugin is loaded. 1040 Public method to check, if a certain plugin is loaded.
805 </p><dl> 1041 </p>
1042 <dl>
1043
806 <dt><i>pluginName</i></dt> 1044 <dt><i>pluginName</i></dt>
807 <dd> 1045 <dd>
808 name of the plugin to check for (string) 1046 name of the plugin to check for (string)
809 </dd> 1047 </dd>
810 </dl><dl> 1048 </dl>
1049 <dl>
811 <dt>Returns:</dt> 1050 <dt>Returns:</dt>
812 <dd> 1051 <dd>
813 flag indicating, if the plugin is loaded (boolean) 1052 flag indicating, if the plugin is loaded (boolean)
814 </dd> 1053 </dd>
815 </dl><a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a> 1054 </dl>
1055 <a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a>
816 <h4>PluginManager.isValidPluginName</h4> 1056 <h4>PluginManager.isValidPluginName</h4>
817 <b>isValidPluginName</b>(<i>pluginName</i>) 1057 <b>isValidPluginName</b>(<i>pluginName</i>)
1058
818 <p> 1059 <p>
819 Public methode to check, if a file name is a valid plugin name. 1060 Public methode to check, if a file name is a valid plugin name.
820 </p><p> 1061 </p>
1062 <p>
821 Plugin modules must start with "Plugin" and have the extension ".py". 1063 Plugin modules must start with "Plugin" and have the extension ".py".
822 </p><dl> 1064 </p>
1065 <dl>
1066
823 <dt><i>pluginName</i></dt> 1067 <dt><i>pluginName</i></dt>
824 <dd> 1068 <dd>
825 name of the file to be checked (string) 1069 name of the file to be checked (string)
826 </dd> 1070 </dd>
827 </dl><dl> 1071 </dl>
1072 <dl>
828 <dt>Returns:</dt> 1073 <dt>Returns:</dt>
829 <dd> 1074 <dd>
830 flag indicating a valid plugin name (boolean) 1075 flag indicating a valid plugin name (boolean)
831 </dd> 1076 </dd>
832 </dl><a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a> 1077 </dl>
1078 <a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a>
833 <h4>PluginManager.loadDocumentationSetPlugins</h4> 1079 <h4>PluginManager.loadDocumentationSetPlugins</h4>
834 <b>loadDocumentationSetPlugins</b>(<i></i>) 1080 <b>loadDocumentationSetPlugins</b>(<i></i>)
1081
835 <p> 1082 <p>
836 Public method to load just the documentation sets plugins. 1083 Public method to load just the documentation sets plugins.
837 </p><dl> 1084 </p>
1085 <dl>
1086
838 <dt>Raises <b>PluginModulesError</b>:</dt> 1087 <dt>Raises <b>PluginModulesError</b>:</dt>
839 <dd> 1088 <dd>
840 raised to indicate the absence of 1089 raised to indicate the absence of
841 plug-in modules 1090 plug-in modules
842 </dd> 1091 </dd>
843 </dl><a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a> 1092 </dl>
1093 <a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a>
844 <h4>PluginManager.loadPlugin</h4> 1094 <h4>PluginManager.loadPlugin</h4>
845 <b>loadPlugin</b>(<i>name, directory, reload_=False</i>) 1095 <b>loadPlugin</b>(<i>name, directory, reload_=False</i>)
1096
846 <p> 1097 <p>
847 Public method to load a plugin module. 1098 Public method to load a plugin module.
848 </p><p> 1099 </p>
1100 <p>
849 Initially all modules are inactive. Modules that are requested on 1101 Initially all modules are inactive. Modules that are requested on
850 demand are sorted out and are added to the on demand list. Some 1102 demand are sorted out and are added to the on demand list. Some
851 basic validity checks are performed as well. Modules failing these 1103 basic validity checks are performed as well. Modules failing these
852 checks are added to the failed modules list. 1104 checks are added to the failed modules list.
853 </p><dl> 1105 </p>
1106 <dl>
1107
854 <dt><i>name</i></dt> 1108 <dt><i>name</i></dt>
855 <dd> 1109 <dd>
856 name of the module to be loaded (string) 1110 name of the module to be loaded (string)
857 </dd><dt><i>directory</i></dt> 1111 </dd>
1112 <dt><i>directory</i></dt>
858 <dd> 1113 <dd>
859 name of the plugin directory (string) 1114 name of the plugin directory (string)
860 </dd><dt><i>reload_</i></dt> 1115 </dd>
1116 <dt><i>reload_</i></dt>
861 <dd> 1117 <dd>
862 flag indicating to reload the module (boolean) 1118 flag indicating to reload the module (boolean)
863 </dd> 1119 </dd>
864 </dl><dl> 1120 </dl>
1121 <dl>
1122
865 <dt>Raises <b>PluginLoadError</b>:</dt> 1123 <dt>Raises <b>PluginLoadError</b>:</dt>
866 <dd> 1124 <dd>
867 raised to indicate an issue loading 1125 raised to indicate an issue loading
868 the plug-in 1126 the plug-in
869 </dd> 1127 </dd>
870 </dl><a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a> 1128 </dl>
1129 <a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a>
871 <h4>PluginManager.preferencesChanged</h4> 1130 <h4>PluginManager.preferencesChanged</h4>
872 <b>preferencesChanged</b>(<i></i>) 1131 <b>preferencesChanged</b>(<i></i>)
1132
873 <p> 1133 <p>
874 Public slot to react to changes in configuration. 1134 Public slot to react to changes in configuration.
875 </p><a NAME="PluginManager.removePluginFromSysModules" ID="PluginManager.removePluginFromSysModules"></a> 1135 </p>
1136 <a NAME="PluginManager.removePluginFromSysModules" ID="PluginManager.removePluginFromSysModules"></a>
876 <h4>PluginManager.removePluginFromSysModules</h4> 1137 <h4>PluginManager.removePluginFromSysModules</h4>
877 <b>removePluginFromSysModules</b>(<i>pluginName, package, internalPackages</i>) 1138 <b>removePluginFromSysModules</b>(<i>pluginName, package, internalPackages</i>)
1139
878 <p> 1140 <p>
879 Public method to remove a plugin and all related modules from 1141 Public method to remove a plugin and all related modules from
880 sys.modules. 1142 sys.modules.
881 </p><dl> 1143 </p>
1144 <dl>
1145
882 <dt><i>pluginName</i></dt> 1146 <dt><i>pluginName</i></dt>
883 <dd> 1147 <dd>
884 name of the plugin module (string) 1148 name of the plugin module (string)
885 </dd><dt><i>package</i></dt> 1149 </dd>
1150 <dt><i>package</i></dt>
886 <dd> 1151 <dd>
887 name of the plugin package (string) 1152 name of the plugin package (string)
888 </dd><dt><i>internalPackages</i></dt> 1153 </dd>
1154 <dt><i>internalPackages</i></dt>
889 <dd> 1155 <dd>
890 list of intenal packages (list of string) 1156 list of intenal packages (list of string)
891 </dd> 1157 </dd>
892 </dl><dl> 1158 </dl>
1159 <dl>
893 <dt>Returns:</dt> 1160 <dt>Returns:</dt>
894 <dd> 1161 <dd>
895 flag indicating the plugin module was found in sys.modules 1162 flag indicating the plugin module was found in sys.modules
896 (boolean) 1163 (boolean)
897 </dd> 1164 </dd>
898 </dl><a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a> 1165 </dl>
1166 <a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a>
899 <h4>PluginManager.unloadPlugin</h4> 1167 <h4>PluginManager.unloadPlugin</h4>
900 <b>unloadPlugin</b>(<i>name</i>) 1168 <b>unloadPlugin</b>(<i>name</i>)
1169
901 <p> 1170 <p>
902 Public method to unload a plugin module. 1171 Public method to unload a plugin module.
903 </p><dl> 1172 </p>
1173 <dl>
1174
904 <dt><i>name</i></dt> 1175 <dt><i>name</i></dt>
905 <dd> 1176 <dd>
906 name of the module to be unloaded (string) 1177 name of the module to be unloaded (string)
907 </dd> 1178 </dd>
908 </dl><dl> 1179 </dl>
1180 <dl>
909 <dt>Returns:</dt> 1181 <dt>Returns:</dt>
910 <dd> 1182 <dd>
911 flag indicating success (boolean) 1183 flag indicating success (boolean)
912 </dd> 1184 </dd>
913 </dl> 1185 </dl>

Mercurial Repository: eric

eric ide

mercurial