Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 10478
de9106c55c3d
child 10684
58c7f23ae1cb
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.PluginManager.PluginManager</h1> 9 <h1>eric7.PluginManager.PluginManager</h1>
10
11 <p> 10 <p>
12 Module implementing the Plugin Manager. 11 Module implementing the Plugin Manager.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>SSL_AVAILABLE</td></tr> 16 <tr><td>SSL_AVAILABLE</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20
21 <table> 20 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#PluginManager">PluginManager</a></td> 22 <td><a href="#PluginManager">PluginManager</a></td>
25 <td>Class implementing the Plugin Manager.</td> 23 <td>Class implementing the Plugin Manager.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="PluginManager" ID="PluginManager"></a> 34 <a NAME="PluginManager" ID="PluginManager"></a>
36 <h2>PluginManager</h2> 35 <h2>PluginManager</h2>
37
38 <p> 36 <p>
39 Class implementing the Plugin Manager. 37 Class implementing the Plugin Manager.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>allPlugginsActivated()</dt> 43 <dt>allPlugginsActivated()</dt>
45 <dd> 44 <dd>
77 </dd> 76 </dd>
78 </dl> 77 </dl>
79 <h3>Derived from</h3> 78 <h3>Derived from</h3>
80 QObject 79 QObject
81 <h3>Class Attributes</h3> 80 <h3>Class Attributes</h3>
82
83 <table> 81 <table>
84 <tr><td>None</td></tr> 82 <tr><td>None</td></tr>
85 </table> 83 </table>
84
86 <h3>Class Methods</h3> 85 <h3>Class Methods</h3>
87
88 <table> 86 <table>
89 <tr><td>None</td></tr> 87 <tr><td>None</td></tr>
90 </table> 88 </table>
89
91 <h3>Methods</h3> 90 <h3>Methods</h3>
92
93 <table> 91 <table>
94
95 <tr> 92 <tr>
96 <td><a href="#PluginManager.__init__">PluginManager</a></td> 93 <td><a href="#PluginManager.__init__">PluginManager</a></td>
97 <td>Constructor</td> 94 <td>Constructor</td>
98 </tr> 95 </tr>
99 <tr> 96 <tr>
271 <tr> 268 <tr>
272 <td><a href="#PluginManager.unloadPlugin">unloadPlugin</a></td> 269 <td><a href="#PluginManager.unloadPlugin">unloadPlugin</a></td>
273 <td>Public method to unload a plugin module.</td> 270 <td>Public method to unload a plugin module.</td>
274 </tr> 271 </tr>
275 </table> 272 </table>
273
276 <h3>Static Methods</h3> 274 <h3>Static Methods</h3>
277
278 <table> 275 <table>
279 <tr><td>None</td></tr> 276 <tr><td>None</td></tr>
280 </table> 277 </table>
281 278
279
282 <a NAME="PluginManager.__init__" ID="PluginManager.__init__"></a> 280 <a NAME="PluginManager.__init__" ID="PluginManager.__init__"></a>
283 <h4>PluginManager (Constructor)</h4> 281 <h4>PluginManager (Constructor)</h4>
284 <b>PluginManager</b>(<i>parent=None, disabledPlugins=None, doLoadPlugins=True, develPlugin=None</i>) 282 <b>PluginManager</b>(<i>parent=None, disabledPlugins=None, doLoadPlugins=True, develPlugin=None</i>)
285
286 <p> 283 <p>
287 Constructor 284 Constructor
288 </p> 285 </p>
289 <p> 286 <p>
290 The Plugin Manager deals with three different plugin directories. 287 The Plugin Manager deals with three different plugin directories.
292 second one is the global plugin directory called 'eric7plugins', 289 second one is the global plugin directory called 'eric7plugins',
293 which is located inside the site-packages directory. The last one 290 which is located inside the site-packages directory. The last one
294 is the user plugin directory located inside the .eric7 directory 291 is the user plugin directory located inside the .eric7 directory
295 of the users home directory. 292 of the users home directory.
296 </p> 293 </p>
294
297 <dl> 295 <dl>
298 296
299 <dt><i>parent</i> (QObject)</dt> 297 <dt><i>parent</i> (QObject)</dt>
300 <dd> 298 <dd>
301 reference to the parent object 299 reference to the parent object
329 </dd> 327 </dd>
330 </dl> 328 </dl>
331 <a NAME="PluginManager.__canActivatePlugin" ID="PluginManager.__canActivatePlugin"></a> 329 <a NAME="PluginManager.__canActivatePlugin" ID="PluginManager.__canActivatePlugin"></a>
332 <h4>PluginManager.__canActivatePlugin</h4> 330 <h4>PluginManager.__canActivatePlugin</h4>
333 <b>__canActivatePlugin</b>(<i>module</i>) 331 <b>__canActivatePlugin</b>(<i>module</i>)
334
335 <p> 332 <p>
336 Private method to check, if a plugin can be activated. 333 Private method to check, if a plugin can be activated.
337 </p> 334 </p>
335
338 <dl> 336 <dl>
339 337
340 <dt><i>module</i> (Module)</dt> 338 <dt><i>module</i> (Module)</dt>
341 <dd> 339 <dd>
342 reference to the module to be activated 340 reference to the module to be activated
369 </dd> 367 </dd>
370 </dl> 368 </dl>
371 <a NAME="PluginManager.__canDeactivatePlugin" ID="PluginManager.__canDeactivatePlugin"></a> 369 <a NAME="PluginManager.__canDeactivatePlugin" ID="PluginManager.__canDeactivatePlugin"></a>
372 <h4>PluginManager.__canDeactivatePlugin</h4> 370 <h4>PluginManager.__canDeactivatePlugin</h4>
373 <b>__canDeactivatePlugin</b>(<i>module</i>) 371 <b>__canDeactivatePlugin</b>(<i>module</i>)
374
375 <p> 372 <p>
376 Private method to check, if a plugin can be deactivated. 373 Private method to check, if a plugin can be deactivated.
377 </p> 374 </p>
375
378 <dl> 376 <dl>
379 377
380 <dt><i>module</i> (Module)</dt> 378 <dt><i>module</i> (Module)</dt>
381 <dd> 379 <dd>
382 reference to the module to be deactivated 380 reference to the module to be deactivated
396 </dd> 394 </dd>
397 </dl> 395 </dl>
398 <a NAME="PluginManager.__checkPluginsDownloadDirectory" ID="PluginManager.__checkPluginsDownloadDirectory"></a> 396 <a NAME="PluginManager.__checkPluginsDownloadDirectory" ID="PluginManager.__checkPluginsDownloadDirectory"></a>
399 <h4>PluginManager.__checkPluginsDownloadDirectory</h4> 397 <h4>PluginManager.__checkPluginsDownloadDirectory</h4>
400 <b>__checkPluginsDownloadDirectory</b>(<i></i>) 398 <b>__checkPluginsDownloadDirectory</b>(<i></i>)
401
402 <p> 399 <p>
403 Private slot to check for the existence of the plugins download 400 Private slot to check for the existence of the plugins download
404 directory. 401 directory.
405 </p> 402 </p>
403
406 <a NAME="PluginManager.__downloadRepositoryFileDone" ID="PluginManager.__downloadRepositoryFileDone"></a> 404 <a NAME="PluginManager.__downloadRepositoryFileDone" ID="PluginManager.__downloadRepositoryFileDone"></a>
407 <h4>PluginManager.__downloadRepositoryFileDone</h4> 405 <h4>PluginManager.__downloadRepositoryFileDone</h4>
408 <b>__downloadRepositoryFileDone</b>(<i>reply</i>) 406 <b>__downloadRepositoryFileDone</b>(<i>reply</i>)
409
410 <p> 407 <p>
411 Private method called after the repository file was downloaded. 408 Private method called after the repository file was downloaded.
412 </p> 409 </p>
410
413 <dl> 411 <dl>
414 412
415 <dt><i>reply</i> (QNetworkReply)</dt> 413 <dt><i>reply</i> (QNetworkReply)</dt>
416 <dd> 414 <dd>
417 reference to the reply object of the download 415 reference to the reply object of the download
418 </dd> 416 </dd>
419 </dl> 417 </dl>
420 <a NAME="PluginManager.__getShortInfo" ID="PluginManager.__getShortInfo"></a> 418 <a NAME="PluginManager.__getShortInfo" ID="PluginManager.__getShortInfo"></a>
421 <h4>PluginManager.__getShortInfo</h4> 419 <h4>PluginManager.__getShortInfo</h4>
422 <b>__getShortInfo</b>(<i>module</i>) 420 <b>__getShortInfo</b>(<i>module</i>)
423
424 <p> 421 <p>
425 Private method to extract the short info from a module. 422 Private method to extract the short info from a module.
426 </p> 423 </p>
424
427 <dl> 425 <dl>
428 426
429 <dt><i>module</i> (Module)</dt> 427 <dt><i>module</i> (Module)</dt>
430 <dd> 428 <dd>
431 module to extract short info from 429 module to extract short info from
445 </dd> 443 </dd>
446 </dl> 444 </dl>
447 <a NAME="PluginManager.__insertPluginsPaths" ID="PluginManager.__insertPluginsPaths"></a> 445 <a NAME="PluginManager.__insertPluginsPaths" ID="PluginManager.__insertPluginsPaths"></a>
448 <h4>PluginManager.__insertPluginsPaths</h4> 446 <h4>PluginManager.__insertPluginsPaths</h4>
449 <b>__insertPluginsPaths</b>(<i></i>) 447 <b>__insertPluginsPaths</b>(<i></i>)
450
451 <p> 448 <p>
452 Private method to insert the valid plugin paths into the search path. 449 Private method to insert the valid plugin paths into the search path.
453 </p> 450 </p>
451
454 <a NAME="PluginManager.__loadPlugins" ID="PluginManager.__loadPlugins"></a> 452 <a NAME="PluginManager.__loadPlugins" ID="PluginManager.__loadPlugins"></a>
455 <h4>PluginManager.__loadPlugins</h4> 453 <h4>PluginManager.__loadPlugins</h4>
456 <b>__loadPlugins</b>(<i></i>) 454 <b>__loadPlugins</b>(<i></i>)
457
458 <p> 455 <p>
459 Private method to load the plugins found. 456 Private method to load the plugins found.
460 </p> 457 </p>
458
461 <a NAME="PluginManager.__pluginDirectoriesExist" ID="PluginManager.__pluginDirectoriesExist"></a> 459 <a NAME="PluginManager.__pluginDirectoriesExist" ID="PluginManager.__pluginDirectoriesExist"></a>
462 <h4>PluginManager.__pluginDirectoriesExist</h4> 460 <h4>PluginManager.__pluginDirectoriesExist</h4>
463 <b>__pluginDirectoriesExist</b>(<i></i>) 461 <b>__pluginDirectoriesExist</b>(<i></i>)
464
465 <p> 462 <p>
466 Private method to check, if the plugin folders exist. 463 Private method to check, if the plugin folders exist.
467 </p> 464 </p>
468 <p> 465 <p>
469 If the plugin folders don't exist, they are created (if possible). 466 If the plugin folders don't exist, they are created (if possible).
470 </p> 467 </p>
468
471 <dl> 469 <dl>
472 <dt>Return:</dt> 470 <dt>Return:</dt>
473 <dd> 471 <dd>
474 tuple of a flag indicating existence of any of the plugin 472 tuple of a flag indicating existence of any of the plugin
475 directories and a message 473 directories and a message
482 </dd> 480 </dd>
483 </dl> 481 </dl>
484 <a NAME="PluginManager.__pluginModulesExist" ID="PluginManager.__pluginModulesExist"></a> 482 <a NAME="PluginManager.__pluginModulesExist" ID="PluginManager.__pluginModulesExist"></a>
485 <h4>PluginManager.__pluginModulesExist</h4> 483 <h4>PluginManager.__pluginModulesExist</h4>
486 <b>__pluginModulesExist</b>(<i></i>) 484 <b>__pluginModulesExist</b>(<i></i>)
487
488 <p> 485 <p>
489 Private method to check, if there are plugins available. 486 Private method to check, if there are plugins available.
490 </p> 487 </p>
488
491 <dl> 489 <dl>
492 <dt>Return:</dt> 490 <dt>Return:</dt>
493 <dd> 491 <dd>
494 flag indicating the availability of plugins 492 flag indicating the availability of plugins
495 </dd> 493 </dd>
501 </dd> 499 </dd>
502 </dl> 500 </dl>
503 <a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a> 501 <a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a>
504 <h4>PluginManager.__sslErrors</h4> 502 <h4>PluginManager.__sslErrors</h4>
505 <b>__sslErrors</b>(<i>reply, errors</i>) 503 <b>__sslErrors</b>(<i>reply, errors</i>)
506
507 <p> 504 <p>
508 Private slot to handle SSL errors. 505 Private slot to handle SSL errors.
509 </p> 506 </p>
507
510 <dl> 508 <dl>
511 509
512 <dt><i>reply</i> (QNetworkReply)</dt> 510 <dt><i>reply</i> (QNetworkReply)</dt>
513 <dd> 511 <dd>
514 reference to the reply object 512 reference to the reply object
519 </dd> 517 </dd>
520 </dl> 518 </dl>
521 <a NAME="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a> 519 <a NAME="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a>
522 <h4>PluginManager.activatePlugin</h4> 520 <h4>PluginManager.activatePlugin</h4>
523 <b>activatePlugin</b>(<i>name, onDemand=False</i>) 521 <b>activatePlugin</b>(<i>name, onDemand=False</i>)
524
525 <p> 522 <p>
526 Public method to activate a plugin. 523 Public method to activate a plugin.
527 </p> 524 </p>
525
528 <dl> 526 <dl>
529 527
530 <dt><i>name</i> (str)</dt> 528 <dt><i>name</i> (str)</dt>
531 <dd> 529 <dd>
532 name of the module to be activated 530 name of the module to be activated
558 </dd> 556 </dd>
559 </dl> 557 </dl>
560 <a NAME="PluginManager.activatePlugins" ID="PluginManager.activatePlugins"></a> 558 <a NAME="PluginManager.activatePlugins" ID="PluginManager.activatePlugins"></a>
561 <h4>PluginManager.activatePlugins</h4> 559 <h4>PluginManager.activatePlugins</h4>
562 <b>activatePlugins</b>(<i></i>) 560 <b>activatePlugins</b>(<i></i>)
563
564 <p> 561 <p>
565 Public method to activate all plugins having the "autoactivate" 562 Public method to activate all plugins having the "autoactivate"
566 attribute set to True. 563 attribute set to True.
567 </p> 564 </p>
565
568 <a NAME="PluginManager.checkPluginEntry" ID="PluginManager.checkPluginEntry"></a> 566 <a NAME="PluginManager.checkPluginEntry" ID="PluginManager.checkPluginEntry"></a>
569 <h4>PluginManager.checkPluginEntry</h4> 567 <h4>PluginManager.checkPluginEntry</h4>
570 <b>checkPluginEntry</b>(<i>name, short, description, url, author, version, filename, status, category, </i>) 568 <b>checkPluginEntry</b>(<i>name, short, description, url, author, version, filename, status, category, </i>)
571
572 <p> 569 <p>
573 Public method to check a plug-in's data for an update. 570 Public method to check a plug-in's data for an update.
574 </p> 571 </p>
572
575 <dl> 573 <dl>
576 574
577 <dt><i>name</i> (str)</dt> 575 <dt><i>name</i> (str)</dt>
578 <dd> 576 <dd>
579 data for the name field 577 data for the name field
612 </dd> 610 </dd>
613 </dl> 611 </dl>
614 <a NAME="PluginManager.checkPluginUpdatesAvailable" ID="PluginManager.checkPluginUpdatesAvailable"></a> 612 <a NAME="PluginManager.checkPluginUpdatesAvailable" ID="PluginManager.checkPluginUpdatesAvailable"></a>
615 <h4>PluginManager.checkPluginUpdatesAvailable</h4> 613 <h4>PluginManager.checkPluginUpdatesAvailable</h4>
616 <b>checkPluginUpdatesAvailable</b>(<i></i>) 614 <b>checkPluginUpdatesAvailable</b>(<i></i>)
617
618 <p> 615 <p>
619 Public method to check the availability of updates of plug-ins. 616 Public method to check the availability of updates of plug-ins.
620 </p> 617 </p>
618
621 <a NAME="PluginManager.clearPluginsPrivateData" ID="PluginManager.clearPluginsPrivateData"></a> 619 <a NAME="PluginManager.clearPluginsPrivateData" ID="PluginManager.clearPluginsPrivateData"></a>
622 <h4>PluginManager.clearPluginsPrivateData</h4> 620 <h4>PluginManager.clearPluginsPrivateData</h4>
623 <b>clearPluginsPrivateData</b>(<i>type_</i>) 621 <b>clearPluginsPrivateData</b>(<i>type_</i>)
624
625 <p> 622 <p>
626 Public method to clear the private data of plug-ins of a specified 623 Public method to clear the private data of plug-ins of a specified
627 type. 624 type.
628 </p> 625 </p>
629 <p> 626 <p>
630 Plugins supporting this functionality must support the module function 627 Plugins supporting this functionality must support the module function
631 clearPrivateData() and have the module level attribute pluginType. 628 clearPrivateData() and have the module level attribute pluginType.
632 </p> 629 </p>
630
633 <dl> 631 <dl>
634 632
635 <dt><i>type_</i> (str)</dt> 633 <dt><i>type_</i> (str)</dt>
636 <dd> 634 <dd>
637 type of the plugin to clear private data for 635 type of the plugin to clear private data for
638 </dd> 636 </dd>
639 </dl> 637 </dl>
640 <a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a> 638 <a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a>
641 <h4>PluginManager.deactivatePlugin</h4> 639 <h4>PluginManager.deactivatePlugin</h4>
642 <b>deactivatePlugin</b>(<i>name, onDemand=False</i>) 640 <b>deactivatePlugin</b>(<i>name, onDemand=False</i>)
643
644 <p> 641 <p>
645 Public method to deactivate a plugin. 642 Public method to deactivate a plugin.
646 </p> 643 </p>
644
647 <dl> 645 <dl>
648 646
649 <dt><i>name</i> (str)</dt> 647 <dt><i>name</i> (str)</dt>
650 <dd> 648 <dd>
651 name of the module to be deactivated 649 name of the module to be deactivated
657 </dd> 655 </dd>
658 </dl> 656 </dl>
659 <a NAME="PluginManager.deactivateVcsPlugins" ID="PluginManager.deactivateVcsPlugins"></a> 657 <a NAME="PluginManager.deactivateVcsPlugins" ID="PluginManager.deactivateVcsPlugins"></a>
660 <h4>PluginManager.deactivateVcsPlugins</h4> 658 <h4>PluginManager.deactivateVcsPlugins</h4>
661 <b>deactivateVcsPlugins</b>(<i></i>) 659 <b>deactivateVcsPlugins</b>(<i></i>)
662
663 <p> 660 <p>
664 Public method to deactivated all activated VCS plugins. 661 Public method to deactivated all activated VCS plugins.
665 </p> 662 </p>
663
666 <a NAME="PluginManager.doShutdown" ID="PluginManager.doShutdown"></a> 664 <a NAME="PluginManager.doShutdown" ID="PluginManager.doShutdown"></a>
667 <h4>PluginManager.doShutdown</h4> 665 <h4>PluginManager.doShutdown</h4>
668 <b>doShutdown</b>(<i></i>) 666 <b>doShutdown</b>(<i></i>)
669
670 <p> 667 <p>
671 Public method called to perform actions upon shutdown of the IDE. 668 Public method called to perform actions upon shutdown of the IDE.
672 </p> 669 </p>
670
673 <a NAME="PluginManager.downLoadRepositoryFile" ID="PluginManager.downLoadRepositoryFile"></a> 671 <a NAME="PluginManager.downLoadRepositoryFile" ID="PluginManager.downLoadRepositoryFile"></a>
674 <h4>PluginManager.downLoadRepositoryFile</h4> 672 <h4>PluginManager.downLoadRepositoryFile</h4>
675 <b>downLoadRepositoryFile</b>(<i>url=None</i>) 673 <b>downLoadRepositoryFile</b>(<i>url=None</i>)
676
677 <p> 674 <p>
678 Public method to download the plugin repository file. 675 Public method to download the plugin repository file.
679 </p> 676 </p>
677
680 <dl> 678 <dl>
681 679
682 <dt><i>url</i> (QUrl or str (optional))</dt> 680 <dt><i>url</i> (QUrl or str (optional))</dt>
683 <dd> 681 <dd>
684 URL to get the plugin repository file from 682 URL to get the plugin repository file from
686 </dd> 684 </dd>
687 </dl> 685 </dl>
688 <a NAME="PluginManager.finalizeSetup" ID="PluginManager.finalizeSetup"></a> 686 <a NAME="PluginManager.finalizeSetup" ID="PluginManager.finalizeSetup"></a>
689 <h4>PluginManager.finalizeSetup</h4> 687 <h4>PluginManager.finalizeSetup</h4>
690 <b>finalizeSetup</b>(<i></i>) 688 <b>finalizeSetup</b>(<i></i>)
691
692 <p> 689 <p>
693 Public method to finalize the setup of the plugin manager. 690 Public method to finalize the setup of the plugin manager.
694 </p> 691 </p>
692
695 <a NAME="PluginManager.getPluginApiFiles" ID="PluginManager.getPluginApiFiles"></a> 693 <a NAME="PluginManager.getPluginApiFiles" ID="PluginManager.getPluginApiFiles"></a>
696 <h4>PluginManager.getPluginApiFiles</h4> 694 <h4>PluginManager.getPluginApiFiles</h4>
697 <b>getPluginApiFiles</b>(<i>language</i>) 695 <b>getPluginApiFiles</b>(<i>language</i>)
698
699 <p> 696 <p>
700 Public method to get the list of API files installed by a plugin. 697 Public method to get the list of API files installed by a plugin.
701 </p> 698 </p>
699
702 <dl> 700 <dl>
703 701
704 <dt><i>language</i> (str)</dt> 702 <dt><i>language</i> (str)</dt>
705 <dd> 703 <dd>
706 language of the requested API files 704 language of the requested API files
719 </dd> 717 </dd>
720 </dl> 718 </dl>
721 <a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a> 719 <a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a>
722 <h4>PluginManager.getPluginConfigData</h4> 720 <h4>PluginManager.getPluginConfigData</h4>
723 <b>getPluginConfigData</b>(<i></i>) 721 <b>getPluginConfigData</b>(<i></i>)
724
725 <p> 722 <p>
726 Public method to get the config data of all active, non on-demand 723 Public method to get the config data of all active, non on-demand
727 plugins used by the configuration dialog. 724 plugins used by the configuration dialog.
728 </p> 725 </p>
729 <p> 726 <p>
750 <dt>reference to configuration page</dt> 747 <dt>reference to configuration page</dt>
751 <dd>This will be used by the configuration dialog and must always 748 <dd>This will be used by the configuration dialog and must always
752 be None</dd> 749 be None</dd>
753 </dl> 750 </dl>
754 </p> 751 </p>
752
755 <dl> 753 <dl>
756 <dt>Return:</dt> 754 <dt>Return:</dt>
757 <dd> 755 <dd>
758 plug-in configuration data 756 plug-in configuration data
759 </dd> 757 </dd>
765 </dd> 763 </dd>
766 </dl> 764 </dl>
767 <a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> 765 <a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a>
768 <h4>PluginManager.getPluginDetails</h4> 766 <h4>PluginManager.getPluginDetails</h4>
769 <b>getPluginDetails</b>(<i>name</i>) 767 <b>getPluginDetails</b>(<i>name</i>)
770
771 <p> 768 <p>
772 Public method to get detailed information about a plugin. 769 Public method to get detailed information about a plugin.
773 </p> 770 </p>
771
774 <dl> 772 <dl>
775 773
776 <dt><i>name</i> (str)</dt> 774 <dt><i>name</i> (str)</dt>
777 <dd> 775 <dd>
778 name of the module to get detailed infos about 776 name of the module to get detailed infos about
791 </dd> 789 </dd>
792 </dl> 790 </dl>
793 <a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a> 791 <a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a>
794 <h4>PluginManager.getPluginDir</h4> 792 <h4>PluginManager.getPluginDir</h4>
795 <b>getPluginDir</b>(<i>key</i>) 793 <b>getPluginDir</b>(<i>key</i>)
796
797 <p> 794 <p>
798 Public method to get the path of a plugin directory. 795 Public method to get the path of a plugin directory.
799 </p> 796 </p>
797
800 <dl> 798 <dl>
801 799
802 <dt><i>key</i> (str)</dt> 800 <dt><i>key</i> (str)</dt>
803 <dd> 801 <dd>
804 key of the plug-in directory 802 key of the plug-in directory
817 </dd> 815 </dd>
818 </dl> 816 </dl>
819 <a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a> 817 <a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a>
820 <h4>PluginManager.getPluginDisplayStrings</h4> 818 <h4>PluginManager.getPluginDisplayStrings</h4>
821 <b>getPluginDisplayStrings</b>(<i>type_</i>) 819 <b>getPluginDisplayStrings</b>(<i>type_</i>)
822
823 <p> 820 <p>
824 Public method to get the display strings of all plugins of a specific 821 Public method to get the display strings of all plugins of a specific
825 type. 822 type.
826 </p> 823 </p>
824
827 <dl> 825 <dl>
828 826
829 <dt><i>type_</i> (str)</dt> 827 <dt><i>type_</i> (str)</dt>
830 <dd> 828 <dd>
831 type of the plugins 829 type of the plugins
844 </dd> 842 </dd>
845 </dl> 843 </dl>
846 <a NAME="PluginManager.getPluginExeDisplayData" ID="PluginManager.getPluginExeDisplayData"></a> 844 <a NAME="PluginManager.getPluginExeDisplayData" ID="PluginManager.getPluginExeDisplayData"></a>
847 <h4>PluginManager.getPluginExeDisplayData</h4> 845 <h4>PluginManager.getPluginExeDisplayData</h4>
848 <b>getPluginExeDisplayData</b>(<i></i>) 846 <b>getPluginExeDisplayData</b>(<i></i>)
849
850 <p> 847 <p>
851 Public method to get data to display information about a plugins 848 Public method to get data to display information about a plugins
852 external tool. 849 external tool.
853 </p> 850 </p>
851
854 <dl> 852 <dl>
855 <dt>Return:</dt> 853 <dt>Return:</dt>
856 <dd> 854 <dd>
857 list of dictionaries containing the data. Each dictionary must 855 list of dictionaries containing the data. Each dictionary must
858 either contain data for the determination or the data to be 856 either contain data for the determination or the data to be
891 </dd> 889 </dd>
892 </dl> 890 </dl>
893 <a NAME="PluginManager.getPluginInfos" ID="PluginManager.getPluginInfos"></a> 891 <a NAME="PluginManager.getPluginInfos" ID="PluginManager.getPluginInfos"></a>
894 <h4>PluginManager.getPluginInfos</h4> 892 <h4>PluginManager.getPluginInfos</h4>
895 <b>getPluginInfos</b>(<i></i>) 893 <b>getPluginInfos</b>(<i></i>)
896
897 <p> 894 <p>
898 Public method to get infos about all loaded plug-ins. 895 Public method to get infos about all loaded plug-ins.
899 </p> 896 </p>
897
900 <dl> 898 <dl>
901 <dt>Return:</dt> 899 <dt>Return:</dt>
902 <dd> 900 <dd>
903 list of dictionaries with keys "module_name", "plugin_name", 901 list of dictionaries with keys "module_name", "plugin_name",
904 "version", "auto_activate", "active", "short_desc", "error" 902 "version", "auto_activate", "active", "short_desc", "error"
913 </dd> 911 </dd>
914 </dl> 912 </dl>
915 <a NAME="PluginManager.getPluginModules" ID="PluginManager.getPluginModules"></a> 913 <a NAME="PluginManager.getPluginModules" ID="PluginManager.getPluginModules"></a>
916 <h4>PluginManager.getPluginModules</h4> 914 <h4>PluginManager.getPluginModules</h4>
917 <b>getPluginModules</b>(<i>pluginPath</i>) 915 <b>getPluginModules</b>(<i>pluginPath</i>)
918
919 <p> 916 <p>
920 Public method to get a list of plugin modules. 917 Public method to get a list of plugin modules.
921 </p> 918 </p>
919
922 <dl> 920 <dl>
923 921
924 <dt><i>pluginPath</i> (str)</dt> 922 <dt><i>pluginPath</i> (str)</dt>
925 <dd> 923 <dd>
926 name of the path to search 924 name of the path to search
939 </dd> 937 </dd>
940 </dl> 938 </dl>
941 <a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a> 939 <a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a>
942 <h4>PluginManager.getPluginObject</h4> 940 <h4>PluginManager.getPluginObject</h4>
943 <b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>) 941 <b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>)
944
945 <p> 942 <p>
946 Public method to activate an on-demand plugin given by type and 943 Public method to activate an on-demand plugin given by type and
947 type name. 944 type name.
948 </p> 945 </p>
946
949 <dl> 947 <dl>
950 948
951 <dt><i>type_</i> (str)</dt> 949 <dt><i>type_</i> (str)</dt>
952 <dd> 950 <dd>
953 type of the plugin to be activated 951 type of the plugin to be activated
975 </dd> 973 </dd>
976 </dl> 974 </dl>
977 <a NAME="PluginManager.getPluginPreviewPixmap" ID="PluginManager.getPluginPreviewPixmap"></a> 975 <a NAME="PluginManager.getPluginPreviewPixmap" ID="PluginManager.getPluginPreviewPixmap"></a>
978 <h4>PluginManager.getPluginPreviewPixmap</h4> 976 <h4>PluginManager.getPluginPreviewPixmap</h4>
979 <b>getPluginPreviewPixmap</b>(<i>type_, name</i>) 977 <b>getPluginPreviewPixmap</b>(<i>type_, name</i>)
980
981 <p> 978 <p>
982 Public method to get a preview pixmap of a plugin of a specific type. 979 Public method to get a preview pixmap of a plugin of a specific type.
983 </p> 980 </p>
981
984 <dl> 982 <dl>
985 983
986 <dt><i>type_</i> (str)</dt> 984 <dt><i>type_</i> (str)</dt>
987 <dd> 985 <dd>
988 type of the plugin 986 type of the plugin
1005 </dd> 1003 </dd>
1006 </dl> 1004 </dl>
1007 <a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a> 1005 <a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a>
1008 <h4>PluginManager.getPluginQtHelpFiles</h4> 1006 <h4>PluginManager.getPluginQtHelpFiles</h4>
1009 <b>getPluginQtHelpFiles</b>(<i></i>) 1007 <b>getPluginQtHelpFiles</b>(<i></i>)
1010
1011 <p> 1008 <p>
1012 Public method to get the list of QtHelp documentation files provided 1009 Public method to get the list of QtHelp documentation files provided
1013 by a plug-in. 1010 by a plug-in.
1014 </p> 1011 </p>
1012
1015 <dl> 1013 <dl>
1016 <dt>Return:</dt> 1014 <dt>Return:</dt>
1017 <dd> 1015 <dd>
1018 dictionary with documentation type as key and list of files 1016 dictionary with documentation type as key and list of files
1019 as value 1017 as value
1026 </dd> 1024 </dd>
1027 </dl> 1025 </dl>
1028 <a NAME="PluginManager.getVcsSystemIndicators" ID="PluginManager.getVcsSystemIndicators"></a> 1026 <a NAME="PluginManager.getVcsSystemIndicators" ID="PluginManager.getVcsSystemIndicators"></a>
1029 <h4>PluginManager.getVcsSystemIndicators</h4> 1027 <h4>PluginManager.getVcsSystemIndicators</h4>
1030 <b>getVcsSystemIndicators</b>(<i></i>) 1028 <b>getVcsSystemIndicators</b>(<i></i>)
1031
1032 <p> 1029 <p>
1033 Public method to get the Vcs System indicators. 1030 Public method to get the Vcs System indicators.
1034 </p> 1031 </p>
1035 <p> 1032 <p>
1036 Plugins supporting this functionality must support the module function 1033 Plugins supporting this functionality must support the module function
1037 getVcsSystemIndicator returning a dictionary with indicator as key and 1034 getVcsSystemIndicator returning a dictionary with indicator as key and
1038 a tuple with the vcs name (string) and vcs display string (string). 1035 a tuple with the vcs name (string) and vcs display string (string).
1039 </p> 1036 </p>
1037
1040 <dl> 1038 <dl>
1041 <dt>Return:</dt> 1039 <dt>Return:</dt>
1042 <dd> 1040 <dd>
1043 dictionary with indicator as key and a list of tuples as 1041 dictionary with indicator as key and a list of tuples as
1044 values. Each tuple contains the vcs name (str) and vcs display 1042 values. Each tuple contains the vcs name (str) and vcs display
1052 </dd> 1050 </dd>
1053 </dl> 1051 </dl>
1054 <a NAME="PluginManager.initOnDemandPlugin" ID="PluginManager.initOnDemandPlugin"></a> 1052 <a NAME="PluginManager.initOnDemandPlugin" ID="PluginManager.initOnDemandPlugin"></a>
1055 <h4>PluginManager.initOnDemandPlugin</h4> 1053 <h4>PluginManager.initOnDemandPlugin</h4>
1056 <b>initOnDemandPlugin</b>(<i>name</i>) 1054 <b>initOnDemandPlugin</b>(<i>name</i>)
1057
1058 <p> 1055 <p>
1059 Public method to create a plugin object for the named on demand plugin. 1056 Public method to create a plugin object for the named on demand plugin.
1060 </p> 1057 </p>
1061 <p> 1058 <p>
1062 Note: The plug-in is not activated. 1059 Note: The plug-in is not activated.
1063 </p> 1060 </p>
1061
1064 <dl> 1062 <dl>
1065 1063
1066 <dt><i>name</i> (str)</dt> 1064 <dt><i>name</i> (str)</dt>
1067 <dd> 1065 <dd>
1068 name of the plug-in 1066 name of the plug-in
1077 </dd> 1075 </dd>
1078 </dl> 1076 </dl>
1079 <a NAME="PluginManager.initOnDemandPlugins" ID="PluginManager.initOnDemandPlugins"></a> 1077 <a NAME="PluginManager.initOnDemandPlugins" ID="PluginManager.initOnDemandPlugins"></a>
1080 <h4>PluginManager.initOnDemandPlugins</h4> 1078 <h4>PluginManager.initOnDemandPlugins</h4>
1081 <b>initOnDemandPlugins</b>(<i></i>) 1079 <b>initOnDemandPlugins</b>(<i></i>)
1082
1083 <p> 1080 <p>
1084 Public method to create plugin objects for all on demand plugins. 1081 Public method to create plugin objects for all on demand plugins.
1085 </p> 1082 </p>
1086 <p> 1083 <p>
1087 Note: The plugins are not activated. 1084 Note: The plugins are not activated.
1088 </p> 1085 </p>
1086
1089 <a NAME="PluginManager.initPluginToolbars" ID="PluginManager.initPluginToolbars"></a> 1087 <a NAME="PluginManager.initPluginToolbars" ID="PluginManager.initPluginToolbars"></a>
1090 <h4>PluginManager.initPluginToolbars</h4> 1088 <h4>PluginManager.initPluginToolbars</h4>
1091 <b>initPluginToolbars</b>(<i>toolbarManager</i>) 1089 <b>initPluginToolbars</b>(<i>toolbarManager</i>)
1092
1093 <p> 1090 <p>
1094 Public method to initialize plug-in toolbars. 1091 Public method to initialize plug-in toolbars.
1095 </p> 1092 </p>
1093
1096 <dl> 1094 <dl>
1097 1095
1098 <dt><i>toolbarManager</i> (EricToolBarManager)</dt> 1096 <dt><i>toolbarManager</i> (EricToolBarManager)</dt>
1099 <dd> 1097 <dd>
1100 reference to the toolbar manager object 1098 reference to the toolbar manager object
1101 </dd> 1099 </dd>
1102 </dl> 1100 </dl>
1103 <a NAME="PluginManager.isPluginActive" ID="PluginManager.isPluginActive"></a> 1101 <a NAME="PluginManager.isPluginActive" ID="PluginManager.isPluginActive"></a>
1104 <h4>PluginManager.isPluginActive</h4> 1102 <h4>PluginManager.isPluginActive</h4>
1105 <b>isPluginActive</b>(<i>pluginName</i>) 1103 <b>isPluginActive</b>(<i>pluginName</i>)
1106
1107 <p> 1104 <p>
1108 Public method to check, if a certain plugin is active. 1105 Public method to check, if a certain plugin is active.
1109 </p> 1106 </p>
1107
1110 <dl> 1108 <dl>
1111 1109
1112 <dt><i>pluginName</i> (str)</dt> 1110 <dt><i>pluginName</i> (str)</dt>
1113 <dd> 1111 <dd>
1114 name of the plugin to check for 1112 name of the plugin to check for
1127 </dd> 1125 </dd>
1128 </dl> 1126 </dl>
1129 <a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a> 1127 <a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a>
1130 <h4>PluginManager.isPluginLoaded</h4> 1128 <h4>PluginManager.isPluginLoaded</h4>
1131 <b>isPluginLoaded</b>(<i>pluginName</i>) 1129 <b>isPluginLoaded</b>(<i>pluginName</i>)
1132
1133 <p> 1130 <p>
1134 Public method to check, if a certain plugin is loaded. 1131 Public method to check, if a certain plugin is loaded.
1135 </p> 1132 </p>
1133
1136 <dl> 1134 <dl>
1137 1135
1138 <dt><i>pluginName</i> (str)</dt> 1136 <dt><i>pluginName</i> (str)</dt>
1139 <dd> 1137 <dd>
1140 name of the plugin to check for 1138 name of the plugin to check for
1153 </dd> 1151 </dd>
1154 </dl> 1152 </dl>
1155 <a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a> 1153 <a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a>
1156 <h4>PluginManager.isValidPluginName</h4> 1154 <h4>PluginManager.isValidPluginName</h4>
1157 <b>isValidPluginName</b>(<i>pluginName</i>) 1155 <b>isValidPluginName</b>(<i>pluginName</i>)
1158
1159 <p> 1156 <p>
1160 Public method to check, if a file name is a valid plugin name. 1157 Public method to check, if a file name is a valid plugin name.
1161 </p> 1158 </p>
1162 <p> 1159 <p>
1163 Plugin modules must start with "Plugin" and have the extension ".py". 1160 Plugin modules must start with "Plugin" and have the extension ".py".
1164 </p> 1161 </p>
1162
1165 <dl> 1163 <dl>
1166 1164
1167 <dt><i>pluginName</i> (str)</dt> 1165 <dt><i>pluginName</i> (str)</dt>
1168 <dd> 1166 <dd>
1169 name of the file to be checked 1167 name of the file to be checked
1182 </dd> 1180 </dd>
1183 </dl> 1181 </dl>
1184 <a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a> 1182 <a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a>
1185 <h4>PluginManager.loadDocumentationSetPlugins</h4> 1183 <h4>PluginManager.loadDocumentationSetPlugins</h4>
1186 <b>loadDocumentationSetPlugins</b>(<i></i>) 1184 <b>loadDocumentationSetPlugins</b>(<i></i>)
1187
1188 <p> 1185 <p>
1189 Public method to load just the documentation sets plugins. 1186 Public method to load just the documentation sets plugins.
1190 </p> 1187 </p>
1188
1191 <dl> 1189 <dl>
1192 1190
1193 <dt>Raises <b>PluginModulesError</b>:</dt> 1191 <dt>Raises <b>PluginModulesError</b>:</dt>
1194 <dd> 1192 <dd>
1195 raised to indicate the absence of 1193 raised to indicate the absence of
1197 </dd> 1195 </dd>
1198 </dl> 1196 </dl>
1199 <a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a> 1197 <a NAME="PluginManager.loadPlugin" ID="PluginManager.loadPlugin"></a>
1200 <h4>PluginManager.loadPlugin</h4> 1198 <h4>PluginManager.loadPlugin</h4>
1201 <b>loadPlugin</b>(<i>name, directory, reload_=False, install=False</i>) 1199 <b>loadPlugin</b>(<i>name, directory, reload_=False, install=False</i>)
1202
1203 <p> 1200 <p>
1204 Public method to load a plugin module. 1201 Public method to load a plugin module.
1205 </p> 1202 </p>
1206 <p> 1203 <p>
1207 Initially all modules are inactive. Modules that are requested on 1204 Initially all modules are inactive. Modules that are requested on
1208 demand are sorted out and are added to the on demand list. Some 1205 demand are sorted out and are added to the on demand list. Some
1209 basic validity checks are performed as well. Modules failing these 1206 basic validity checks are performed as well. Modules failing these
1210 checks are added to the failed modules list. 1207 checks are added to the failed modules list.
1211 </p> 1208 </p>
1209
1212 <dl> 1210 <dl>
1213 1211
1214 <dt><i>name</i> (str)</dt> 1212 <dt><i>name</i> (str)</dt>
1215 <dd> 1213 <dd>
1216 name of the module to be loaded 1214 name of the module to be loaded
1238 </dd> 1236 </dd>
1239 </dl> 1237 </dl>
1240 <a NAME="PluginManager.pipInstall" ID="PluginManager.pipInstall"></a> 1238 <a NAME="PluginManager.pipInstall" ID="PluginManager.pipInstall"></a>
1241 <h4>PluginManager.pipInstall</h4> 1239 <h4>PluginManager.pipInstall</h4>
1242 <b>pipInstall</b>(<i>packages</i>) 1240 <b>pipInstall</b>(<i>packages</i>)
1243
1244 <p> 1241 <p>
1245 Public method to install the given package via pip. 1242 Public method to install the given package via pip.
1246 </p> 1243 </p>
1244
1247 <dl> 1245 <dl>
1248 1246
1249 <dt><i>packages</i> (list of str)</dt> 1247 <dt><i>packages</i> (list of str)</dt>
1250 <dd> 1248 <dd>
1251 list of packages to install 1249 list of packages to install
1252 </dd> 1250 </dd>
1253 </dl> 1251 </dl>
1254 <a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a> 1252 <a NAME="PluginManager.preferencesChanged" ID="PluginManager.preferencesChanged"></a>
1255 <h4>PluginManager.preferencesChanged</h4> 1253 <h4>PluginManager.preferencesChanged</h4>
1256 <b>preferencesChanged</b>(<i></i>) 1254 <b>preferencesChanged</b>(<i></i>)
1257
1258 <p> 1255 <p>
1259 Public slot to react to changes in configuration. 1256 Public slot to react to changes in configuration.
1260 </p> 1257 </p>
1258
1261 <a NAME="PluginManager.removePluginFromSysModules" ID="PluginManager.removePluginFromSysModules"></a> 1259 <a NAME="PluginManager.removePluginFromSysModules" ID="PluginManager.removePluginFromSysModules"></a>
1262 <h4>PluginManager.removePluginFromSysModules</h4> 1260 <h4>PluginManager.removePluginFromSysModules</h4>
1263 <b>removePluginFromSysModules</b>(<i>pluginName, package, internalPackages</i>) 1261 <b>removePluginFromSysModules</b>(<i>pluginName, package, internalPackages</i>)
1264
1265 <p> 1262 <p>
1266 Public method to remove a plugin and all related modules from 1263 Public method to remove a plugin and all related modules from
1267 sys.modules. 1264 sys.modules.
1268 </p> 1265 </p>
1266
1269 <dl> 1267 <dl>
1270 1268
1271 <dt><i>pluginName</i> (str)</dt> 1269 <dt><i>pluginName</i> (str)</dt>
1272 <dd> 1270 <dd>
1273 name of the plugin module 1271 name of the plugin module
1294 </dd> 1292 </dd>
1295 </dl> 1293 </dl>
1296 <a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a> 1294 <a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a>
1297 <h4>PluginManager.unloadPlugin</h4> 1295 <h4>PluginManager.unloadPlugin</h4>
1298 <b>unloadPlugin</b>(<i>name</i>) 1296 <b>unloadPlugin</b>(<i>name</i>)
1299
1300 <p> 1297 <p>
1301 Public method to unload a plugin module. 1298 Public method to unload a plugin module.
1302 </p> 1299 </p>
1300
1303 <dl> 1301 <dl>
1304 1302
1305 <dt><i>name</i> (str)</dt> 1303 <dt><i>name</i> (str)</dt>
1306 <dd> 1304 <dd>
1307 name of the module to be unloaded 1305 name of the module to be unloaded

Mercurial Repository: eric

eric ide

mercurial