Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.PluginManager.PluginManager.html
Documentation/Source/eric5.PluginManager.PluginManager.html
- changeset 945
- 8cd4d08fa9f6
- parent 767
- 27554f80d08f
- child 1228
- 7afaf2fca55b
equal
deleted
inserted
replaced
| 944:1b59c4ba121e | 945:8cd4d08fa9f6 |
|---|---|
| 186 <td>Public method to unload a plugin module.</td> | 186 <td>Public method to unload a plugin module.</td> |
| 187 </tr> | 187 </tr> |
| 188 </table> | 188 </table> |
| 189 <a NAME="PluginManager.__init__" ID="PluginManager.__init__"></a> | 189 <a NAME="PluginManager.__init__" ID="PluginManager.__init__"></a> |
| 190 <h4>PluginManager (Constructor)</h4> | 190 <h4>PluginManager (Constructor)</h4> |
| 191 <b>PluginManager</b>(<i>parent = None, doLoadPlugins = True, develPlugin = None</i>) | 191 <b>PluginManager</b>(<i>parent=None, doLoadPlugins=True, develPlugin=None</i>) |
| 192 <p> | 192 <p> |
| 193 Constructor | 193 Constructor |
| 194 </p><p> | 194 </p><p> |
| 195 The Plugin Manager deals with three different plugin directories. | 195 The Plugin Manager deals with three different plugin directories. |
| 196 The first is the one, that is part of eric5 (eric5/Plugins). The | 196 The first is the one, that is part of eric5 (eric5/Plugins). The |
| 197 second one is the global plugin directory called 'eric5plugins', | 197 second one is the global plugin directory called 'eric5plugins', |
| 198 which is located inside the site-packages directory. The last one | 198 which is located inside the site-packages directory. The last one |
| 199 is the user plugin directory located inside the .eric5 directory | 199 is the user plugin directory located inside the .eric5 directory |
| 200 of the users home directory. | 200 of the users home directory. |
| 201 </p><dl> | 201 </p><dl> |
| 202 <dt><i>parent</i></dt> | 202 <dt><i>parent</i></dt> |
| 298 <dd> | 298 <dd> |
| 299 flag indicating the availability of plugins (boolean) | 299 flag indicating the availability of plugins (boolean) |
| 300 </dd> | 300 </dd> |
| 301 </dl><a NAME="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a> | 301 </dl><a NAME="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a> |
| 302 <h4>PluginManager.activatePlugin</h4> | 302 <h4>PluginManager.activatePlugin</h4> |
| 303 <b>activatePlugin</b>(<i>name, onDemand = False</i>) | 303 <b>activatePlugin</b>(<i>name, onDemand=False</i>) |
| 304 <p> | 304 <p> |
| 305 Public method to activate a plugin. | 305 Public method to activate a plugin. |
| 306 </p><dl> | 306 </p><dl> |
| 307 <dt><i>name</i></dt> | 307 <dt><i>name</i></dt> |
| 308 <dd> | 308 <dd> |
| 323 <p> | 323 <p> |
| 324 Public method to activate all plugins having the "autoactivate" attribute | 324 Public method to activate all plugins having the "autoactivate" attribute |
| 325 set to True. | 325 set to True. |
| 326 </p><a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a> | 326 </p><a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a> |
| 327 <h4>PluginManager.deactivatePlugin</h4> | 327 <h4>PluginManager.deactivatePlugin</h4> |
| 328 <b>deactivatePlugin</b>(<i>name, onDemand = False</i>) | 328 <b>deactivatePlugin</b>(<i>name, onDemand=False</i>) |
| 329 <p> | 329 <p> |
| 330 Public method to deactivate a plugin. | 330 Public method to deactivate a plugin. |
| 331 </p><dl> | 331 </p><dl> |
| 332 <dt><i>name</i></dt> | 332 <dt><i>name</i></dt> |
| 333 <dd> | 333 <dd> |
| 383 This should be a localized string</dd> | 383 This should be a localized string</dd> |
| 384 <dt>pixmap name</dt> | 384 <dt>pixmap name</dt> |
| 385 <dd>filename of the pixmap to be shown next to the display string</dd> | 385 <dd>filename of the pixmap to be shown next to the display string</dd> |
| 386 <dt>page creation function</dt> | 386 <dt>page creation function</dt> |
| 387 <dd>plugin module function to be called to create the configuration | 387 <dd>plugin module function to be called to create the configuration |
| 388 page. The page must be subclasses from | 388 page. The page must be subclasses from |
| 389 Preferences.ConfigurationPages.ConfigurationPageBase and must | 389 Preferences.ConfigurationPages.ConfigurationPageBase and must |
| 390 implement a method called 'save' to save the settings. A parent | 390 implement a method called 'save' to save the settings. A parent |
| 391 entry will be created in the selection list, if this value is None.</dd> | 391 entry will be created in the selection list, if this value is None.</dd> |
| 392 <dt>parent key</dt> | 392 <dt>parent key</dt> |
| 393 <dd>dictionary key of the parent entry or None, if this defines a | 393 <dd>dictionary key of the parent entry or None, if this defines a |
| 394 toplevel entry.</dd> | 394 toplevel entry.</dd> |
| 395 <dt>reference to configuration page</dt> | 395 <dt>reference to configuration page</dt> |
| 396 <dd>This will be used by the configuration dialog and must always be None</dd> | 396 <dd>This will be used by the configuration dialog and must always be None</dd> |
| 397 </dl> | 397 </dl> |
| 398 </p><a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> | 398 </p><a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> |
| 454 <li>header - string to be diplayed as a header (string)</li> | 454 <li>header - string to be diplayed as a header (string)</li> |
| 455 <li>exe - the executable (string)</li> | 455 <li>exe - the executable (string)</li> |
| 456 <li>versionCommand - commandline parameter for the exe (string)</li> | 456 <li>versionCommand - commandline parameter for the exe (string)</li> |
| 457 <li>versionStartsWith - indicator for the output line containing | 457 <li>versionStartsWith - indicator for the output line containing |
| 458 the version (string)</li> | 458 the version (string)</li> |
| 459 <li>versionPosition - number of element containing the | 459 <li>versionPosition - number of element containing the |
| 460 version (integer)</li> | 460 version (integer)</li> |
| 461 <li>version - version to be used as default (string)</li> | 461 <li>version - version to be used as default (string)</li> |
| 462 <li>versionCleanup - tuple of two integers giving string positions | 462 <li>versionCleanup - tuple of two integers giving string positions |
| 463 start and stop for the version string (tuple of integers)</li> | 463 start and stop for the version string (tuple of integers)</li> |
| 464 </ul> | 464 </ul> |
| 478 Public method to get infos about all loaded plugins. | 478 Public method to get infos about all loaded plugins. |
| 479 </p><dl> | 479 </p><dl> |
| 480 <dt>Returns:</dt> | 480 <dt>Returns:</dt> |
| 481 <dd> | 481 <dd> |
| 482 list of tuples giving module name (string), plugin name (string), | 482 list of tuples giving module name (string), plugin name (string), |
| 483 version (string), autoactivate (boolean), active (boolean), | 483 version (string), autoactivate (boolean), active (boolean), |
| 484 short description (string), error flag (boolean) | 484 short description (string), error flag (boolean) |
| 485 </dd> | 485 </dd> |
| 486 </dl><a NAME="PluginManager.getPluginModules" ID="PluginManager.getPluginModules"></a> | 486 </dl><a NAME="PluginManager.getPluginModules" ID="PluginManager.getPluginModules"></a> |
| 487 <h4>PluginManager.getPluginModules</h4> | 487 <h4>PluginManager.getPluginModules</h4> |
| 488 <b>getPluginModules</b>(<i>pluginPath</i>) | 488 <b>getPluginModules</b>(<i>pluginPath</i>) |
| 498 <dd> | 498 <dd> |
| 499 list of plugin module names (list of string) | 499 list of plugin module names (list of string) |
| 500 </dd> | 500 </dd> |
| 501 </dl><a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a> | 501 </dl><a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a> |
| 502 <h4>PluginManager.getPluginObject</h4> | 502 <h4>PluginManager.getPluginObject</h4> |
| 503 <b>getPluginObject</b>(<i>type_, typename, maybeActive = False</i>) | 503 <b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>) |
| 504 <p> | 504 <p> |
| 505 Public method to activate an ondemand plugin given by type and typename. | 505 Public method to activate an ondemand plugin given by type and typename. |
| 506 </p><dl> | 506 </p><dl> |
| 507 <dt><i>type_</i></dt> | 507 <dt><i>type_</i></dt> |
| 508 <dd> | 508 <dd> |
| 614 <dd> | 614 <dd> |
| 615 flag indicating a valid plugin name (boolean) | 615 flag indicating a valid plugin name (boolean) |
| 616 </dd> | 616 </dd> |
| 617 </dl><a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a> | 617 </dl><a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a> |
| 618 <h4>PluginManager.loadPlugin</h4> | 618 <h4>PluginManager.loadPlugin</h4> |
| 619 <b>loadPlugin</b>(<i>name, directory, reload_ = False</i>) | 619 <b>loadPlugin</b>(<i>name, directory, reload_=False</i>) |
| 620 <p> | 620 <p> |
| 621 Public method to load a plugin module. | 621 Public method to load a plugin module. |
| 622 </p><p> | 622 </p><p> |
| 623 Initially all modules are inactive. Modules that are requested on | 623 Initially all modules are inactive. Modules that are requested on |
| 624 demand are sorted out and are added to the on demand list. Some | 624 demand are sorted out and are added to the on demand list. Some |
