Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.PluginManager.PluginManager.html
Documentation/Source/eric5.PluginManager.PluginManager.html
- changeset 2966
- f85f686981ad
- parent 2889
- 3737e9f17f44
- child 3018
- 70924c0bdaf1
equal
deleted
inserted
replaced
| 2965:d133c7edd88a | 2966:f85f686981ad |
|---|---|
| 216 </dd><dt><i>develPlugin=</i></dt> | 216 </dd><dt><i>develPlugin=</i></dt> |
| 217 <dd> | 217 <dd> |
| 218 filename of a plugin to be loaded for | 218 filename of a plugin to be loaded for |
| 219 development (string) | 219 development (string) |
| 220 </dd> | 220 </dd> |
| 221 </dl><dl> | |
| 222 <dt>Raises <b>PluginPathError</b>:</dt> | |
| 223 <dd> | |
| 224 raised to indicate an invalid plug-in path | |
| 225 </dd> | |
| 221 </dl><a NAME="PluginManager.__canActivatePlugin" ID="PluginManager.__canActivatePlugin"></a> | 226 </dl><a NAME="PluginManager.__canActivatePlugin" ID="PluginManager.__canActivatePlugin"></a> |
| 222 <h4>PluginManager.__canActivatePlugin</h4> | 227 <h4>PluginManager.__canActivatePlugin</h4> |
| 223 <b>__canActivatePlugin</b>(<i>module</i>) | 228 <b>__canActivatePlugin</b>(<i>module</i>) |
| 224 <p> | 229 <p> |
| 225 Private method to check, if a plugin can be activated. | 230 Private method to check, if a plugin can be activated. |
| 231 </dl><dl> | 236 </dl><dl> |
| 232 <dt>Returns:</dt> | 237 <dt>Returns:</dt> |
| 233 <dd> | 238 <dd> |
| 234 flag indicating, if the module satisfies all requirements | 239 flag indicating, if the module satisfies all requirements |
| 235 for being activated (boolean) | 240 for being activated (boolean) |
| 241 </dd> | |
| 242 </dl><dl> | |
| 243 <dt>Raises <b>PluginClassFormatError</b>:</dt> | |
| 244 <dd> | |
| 245 raised to indicate an invalid | |
| 246 plug-in class format | |
| 247 </dd><dt>Raises <b>PluginModuleFormatError</b>:</dt> | |
| 248 <dd> | |
| 249 raised to indicate an invalid | |
| 250 plug-in module format | |
| 236 </dd> | 251 </dd> |
| 237 </dl><a NAME="PluginManager.__canDeactivatePlugin" ID="PluginManager.__canDeactivatePlugin"></a> | 252 </dl><a NAME="PluginManager.__canDeactivatePlugin" ID="PluginManager.__canDeactivatePlugin"></a> |
| 238 <h4>PluginManager.__canDeactivatePlugin</h4> | 253 <h4>PluginManager.__canDeactivatePlugin</h4> |
| 239 <b>__canDeactivatePlugin</b>(<i>module</i>) | 254 <b>__canDeactivatePlugin</b>(<i>module</i>) |
| 240 <p> | 255 <p> |
| 321 </dd> | 336 </dd> |
| 322 </dl><dl> | 337 </dl><dl> |
| 323 <dt>Returns:</dt> | 338 <dt>Returns:</dt> |
| 324 <dd> | 339 <dd> |
| 325 reference to the initialized plugin object | 340 reference to the initialized plugin object |
| 341 </dd> | |
| 342 </dl><dl> | |
| 343 <dt>Raises <b>PluginActivationError</b>:</dt> | |
| 344 <dd> | |
| 345 raised to indicate an issue during the | |
| 346 plug-in activation | |
| 326 </dd> | 347 </dd> |
| 327 </dl><a NAME="PluginManager.activatePlugins" ID="PluginManager.activatePlugins"></a> | 348 </dl><a NAME="PluginManager.activatePlugins" ID="PluginManager.activatePlugins"></a> |
| 328 <h4>PluginManager.activatePlugins</h4> | 349 <h4>PluginManager.activatePlugins</h4> |
| 329 <b>activatePlugins</b>(<i></i>) | 350 <b>activatePlugins</b>(<i></i>) |
| 330 <p> | 351 <p> |
| 400 <dd>dictionary key of the parent entry or None, if this defines a | 421 <dd>dictionary key of the parent entry or None, if this defines a |
| 401 toplevel entry.</dd> | 422 toplevel entry.</dd> |
| 402 <dt>reference to configuration page</dt> | 423 <dt>reference to configuration page</dt> |
| 403 <dd>This will be used by the configuration dialog and must always be None</dd> | 424 <dd>This will be used by the configuration dialog and must always be None</dd> |
| 404 </dl> | 425 </dl> |
| 405 </p><a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> | 426 </p><dl> |
| 427 <dt>Returns:</dt> | |
| 428 <dd> | |
| 429 plug-in configuration data | |
| 430 </dd> | |
| 431 </dl><a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> | |
| 406 <h4>PluginManager.getPluginDetails</h4> | 432 <h4>PluginManager.getPluginDetails</h4> |
| 407 <b>getPluginDetails</b>(<i>name</i>) | 433 <b>getPluginDetails</b>(<i>name</i>) |
| 408 <p> | 434 <p> |
| 409 Public method to get detailed information about a plugin. | 435 Public method to get detailed information about a plugin. |
| 410 </p><dl> | 436 </p><dl> |
| 421 <h4>PluginManager.getPluginDir</h4> | 447 <h4>PluginManager.getPluginDir</h4> |
| 422 <b>getPluginDir</b>(<i>key</i>) | 448 <b>getPluginDir</b>(<i>key</i>) |
| 423 <p> | 449 <p> |
| 424 Public method to get the path of a plugin directory. | 450 Public method to get the path of a plugin directory. |
| 425 </p><dl> | 451 </p><dl> |
| 452 <dt><i>key</i></dt> | |
| 453 <dd> | |
| 454 key of the plug-in directory (string) | |
| 455 </dd> | |
| 456 </dl><dl> | |
| 426 <dt>Returns:</dt> | 457 <dt>Returns:</dt> |
| 427 <dd> | 458 <dd> |
| 428 path of the requested plugin directory (string) | 459 path of the requested plugin directory (string) |
| 429 </dd> | 460 </dd> |
| 430 </dl><a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a> | 461 </dl><a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a> |
| 564 <h4>PluginManager.initOnDemandPlugin</h4> | 595 <h4>PluginManager.initOnDemandPlugin</h4> |
| 565 <b>initOnDemandPlugin</b>(<i>name</i>) | 596 <b>initOnDemandPlugin</b>(<i>name</i>) |
| 566 <p> | 597 <p> |
| 567 Public method to create a plugin object for the named on demand plugin. | 598 Public method to create a plugin object for the named on demand plugin. |
| 568 </p><p> | 599 </p><p> |
| 569 Note: The plugin is not activated. | 600 Note: The plug-in is not activated. |
| 570 </p><a NAME="PluginManager.initOnDemandPlugins" ID="PluginManager.initOnDemandPlugins"></a> | 601 </p><dl> |
| 602 <dt><i>name</i></dt> | |
| 603 <dd> | |
| 604 name of the plug-in (string) | |
| 605 </dd> | |
| 606 </dl><dl> | |
| 607 <dt>Raises <b>PluginActivationError</b>:</dt> | |
| 608 <dd> | |
| 609 raised to indicate an issue during the | |
| 610 plug-in activation | |
| 611 </dd> | |
| 612 </dl><a NAME="PluginManager.initOnDemandPlugins" ID="PluginManager.initOnDemandPlugins"></a> | |
| 571 <h4>PluginManager.initOnDemandPlugins</h4> | 613 <h4>PluginManager.initOnDemandPlugins</h4> |
| 572 <b>initOnDemandPlugins</b>(<i></i>) | 614 <b>initOnDemandPlugins</b>(<i></i>) |
| 573 <p> | 615 <p> |
| 574 Public method to create plugin objects for all on demand plugins. | 616 Public method to create plugin objects for all on demand plugins. |
| 575 </p><p> | 617 </p><p> |
| 640 name of the plugin directory (string) | 682 name of the plugin directory (string) |
| 641 </dd><dt><i>reload_</i></dt> | 683 </dd><dt><i>reload_</i></dt> |
| 642 <dd> | 684 <dd> |
| 643 flag indicating to reload the module (boolean) | 685 flag indicating to reload the module (boolean) |
| 644 </dd> | 686 </dd> |
| 687 </dl><dl> | |
| 688 <dt>Raises <b>PluginLoadError</b>:</dt> | |
| 689 <dd> | |
| 690 raised to indicate an issue loading | |
| 691 the plug-in | |
| 692 </dd> | |
| 645 </dl><a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a> | 693 </dl><a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a> |
| 646 <h4>PluginManager.preferencesChanged</h4> | 694 <h4>PluginManager.preferencesChanged</h4> |
| 647 <b>preferencesChanged</b>(<i></i>) | 695 <b>preferencesChanged</b>(<i></i>) |
| 648 <p> | 696 <p> |
| 649 Public slot to react to changes in configuration. | 697 Public slot to react to changes in configuration. |
