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 10314
- 1f7d52f024b1
- parent 10070
- 9f5758c0fec1
- child 10478
- de9106c55c3d
equal
deleted
inserted
replaced
| 10313:8f69edb4ad73 | 10314:1f7d52f024b1 |
|---|---|
| 116 <td><a href="#PluginManager.__getShortInfo">__getShortInfo</a></td> | 116 <td><a href="#PluginManager.__getShortInfo">__getShortInfo</a></td> |
| 117 <td>Private method to extract the short info from a module.</td> | 117 <td>Private method to extract the short info from a module.</td> |
| 118 </tr> | 118 </tr> |
| 119 <tr> | 119 <tr> |
| 120 <td><a href="#PluginManager.__insertPluginsPaths">__insertPluginsPaths</a></td> | 120 <td><a href="#PluginManager.__insertPluginsPaths">__insertPluginsPaths</a></td> |
| 121 <td>Private method to insert the valid plugin paths intos the search path.</td> | 121 <td>Private method to insert the valid plugin paths into the search path.</td> |
| 122 </tr> | 122 </tr> |
| 123 <tr> | 123 <tr> |
| 124 <td><a href="#PluginManager.__loadPlugins">__loadPlugins</a></td> | 124 <td><a href="#PluginManager.__loadPlugins">__loadPlugins</a></td> |
| 125 <td>Private method to load the plugins found.</td> | 125 <td>Private method to load the plugins found.</td> |
| 126 </tr> | 126 </tr> |
| 208 <td><a href="#PluginManager.getPluginModules">getPluginModules</a></td> | 208 <td><a href="#PluginManager.getPluginModules">getPluginModules</a></td> |
| 209 <td>Public method to get a list of plugin modules.</td> | 209 <td>Public method to get a list of plugin modules.</td> |
| 210 </tr> | 210 </tr> |
| 211 <tr> | 211 <tr> |
| 212 <td><a href="#PluginManager.getPluginObject">getPluginObject</a></td> | 212 <td><a href="#PluginManager.getPluginObject">getPluginObject</a></td> |
| 213 <td>Public method to activate an ondemand plugin given by type and typename.</td> | 213 <td>Public method to activate an on-demand plugin given by type and type name.</td> |
| 214 </tr> | 214 </tr> |
| 215 <tr> | 215 <tr> |
| 216 <td><a href="#PluginManager.getPluginPreviewPixmap">getPluginPreviewPixmap</a></td> | 216 <td><a href="#PluginManager.getPluginPreviewPixmap">getPluginPreviewPixmap</a></td> |
| 217 <td>Public method to get a preview pixmap of a plugin of a specific type.</td> | 217 <td>Public method to get a preview pixmap of a plugin of a specific type.</td> |
| 218 </tr> | 218 </tr> |
| 335 <p> | 335 <p> |
| 336 Private method to check, if a plugin can be activated. | 336 Private method to check, if a plugin can be activated. |
| 337 </p> | 337 </p> |
| 338 <dl> | 338 <dl> |
| 339 | 339 |
| 340 <dt><i>module</i></dt> | 340 <dt><i>module</i> (Module)</dt> |
| 341 <dd> | 341 <dd> |
| 342 reference to the module to be activated | 342 reference to the module to be activated |
| 343 </dd> | 343 </dd> |
| 344 </dl> | 344 </dl> |
| 345 <dl> | 345 <dl> |
| 346 <dt>Return:</dt> | 346 <dt>Return:</dt> |
| 347 <dd> | 347 <dd> |
| 348 flag indicating, if the module satisfies all requirements | 348 flag indicating, if the module satisfies all requirements |
| 349 for being activated (boolean) | 349 for being activated |
| 350 </dd> | |
| 351 </dl> | |
| 352 <dl> | |
| 353 <dt>Return Type:</dt> | |
| 354 <dd> | |
| 355 bool | |
| 350 </dd> | 356 </dd> |
| 351 </dl> | 357 </dl> |
| 352 <dl> | 358 <dl> |
| 353 | 359 |
| 354 <dt>Raises <b>PluginClassFormatError</b>:</dt> | 360 <dt>Raises <b>PluginClassFormatError</b>:</dt> |
| 369 <p> | 375 <p> |
| 370 Private method to check, if a plugin can be deactivated. | 376 Private method to check, if a plugin can be deactivated. |
| 371 </p> | 377 </p> |
| 372 <dl> | 378 <dl> |
| 373 | 379 |
| 374 <dt><i>module</i></dt> | 380 <dt><i>module</i> (Module)</dt> |
| 375 <dd> | 381 <dd> |
| 376 reference to the module to be deactivated | 382 reference to the module to be deactivated |
| 377 </dd> | 383 </dd> |
| 378 </dl> | 384 </dl> |
| 379 <dl> | 385 <dl> |
| 380 <dt>Return:</dt> | 386 <dt>Return:</dt> |
| 381 <dd> | 387 <dd> |
| 382 flag indicating, if the module satisfies all requirements | 388 flag indicating, if the module satisfies all requirements |
| 383 for being deactivated (boolean) | 389 for being deactivated |
| 390 </dd> | |
| 391 </dl> | |
| 392 <dl> | |
| 393 <dt>Return Type:</dt> | |
| 394 <dd> | |
| 395 bool | |
| 384 </dd> | 396 </dd> |
| 385 </dl> | 397 </dl> |
| 386 <a NAME="PluginManager.__checkPluginsDownloadDirectory" ID="PluginManager.__checkPluginsDownloadDirectory"></a> | 398 <a NAME="PluginManager.__checkPluginsDownloadDirectory" ID="PluginManager.__checkPluginsDownloadDirectory"></a> |
| 387 <h4>PluginManager.__checkPluginsDownloadDirectory</h4> | 399 <h4>PluginManager.__checkPluginsDownloadDirectory</h4> |
| 388 <b>__checkPluginsDownloadDirectory</b>(<i></i>) | 400 <b>__checkPluginsDownloadDirectory</b>(<i></i>) |
| 412 <p> | 424 <p> |
| 413 Private method to extract the short info from a module. | 425 Private method to extract the short info from a module. |
| 414 </p> | 426 </p> |
| 415 <dl> | 427 <dl> |
| 416 | 428 |
| 417 <dt><i>module</i></dt> | 429 <dt><i>module</i> (Module)</dt> |
| 418 <dd> | 430 <dd> |
| 419 module to extract short info from | 431 module to extract short info from |
| 420 </dd> | 432 </dd> |
| 421 </dl> | 433 </dl> |
| 422 <dl> | 434 <dl> |
| 423 <dt>Return:</dt> | 435 <dt>Return:</dt> |
| 424 <dd> | 436 <dd> |
| 425 dictionay containing plug-in data | 437 dictionary containing plug-in data |
| 426 </dd> | 438 </dd> |
| 427 </dl> | 439 </dl> |
| 428 <dl> | 440 <dl> |
| 429 <dt>Return Type:</dt> | 441 <dt>Return Type:</dt> |
| 430 <dd> | 442 <dd> |
| 435 <a NAME="PluginManager.__insertPluginsPaths" ID="PluginManager.__insertPluginsPaths"></a> | 447 <a NAME="PluginManager.__insertPluginsPaths" ID="PluginManager.__insertPluginsPaths"></a> |
| 436 <h4>PluginManager.__insertPluginsPaths</h4> | 448 <h4>PluginManager.__insertPluginsPaths</h4> |
| 437 <b>__insertPluginsPaths</b>(<i></i>) | 449 <b>__insertPluginsPaths</b>(<i></i>) |
| 438 | 450 |
| 439 <p> | 451 <p> |
| 440 Private method to insert the valid plugin paths intos the search path. | 452 Private method to insert the valid plugin paths into the search path. |
| 441 </p> | 453 </p> |
| 442 <a NAME="PluginManager.__loadPlugins" ID="PluginManager.__loadPlugins"></a> | 454 <a NAME="PluginManager.__loadPlugins" ID="PluginManager.__loadPlugins"></a> |
| 443 <h4>PluginManager.__loadPlugins</h4> | 455 <h4>PluginManager.__loadPlugins</h4> |
| 444 <b>__loadPlugins</b>(<i></i>) | 456 <b>__loadPlugins</b>(<i></i>) |
| 445 | 457 |
| 458 </p> | 470 </p> |
| 459 <dl> | 471 <dl> |
| 460 <dt>Return:</dt> | 472 <dt>Return:</dt> |
| 461 <dd> | 473 <dd> |
| 462 tuple of a flag indicating existence of any of the plugin | 474 tuple of a flag indicating existence of any of the plugin |
| 463 directories (boolean) and a message (string) | 475 directories and a message |
| 476 </dd> | |
| 477 </dl> | |
| 478 <dl> | |
| 479 <dt>Return Type:</dt> | |
| 480 <dd> | |
| 481 tuple of (bool, str) | |
| 464 </dd> | 482 </dd> |
| 465 </dl> | 483 </dl> |
| 466 <a NAME="PluginManager.__pluginModulesExist" ID="PluginManager.__pluginModulesExist"></a> | 484 <a NAME="PluginManager.__pluginModulesExist" ID="PluginManager.__pluginModulesExist"></a> |
| 467 <h4>PluginManager.__pluginModulesExist</h4> | 485 <h4>PluginManager.__pluginModulesExist</h4> |
| 468 <b>__pluginModulesExist</b>(<i></i>) | 486 <b>__pluginModulesExist</b>(<i></i>) |
| 471 Private method to check, if there are plugins available. | 489 Private method to check, if there are plugins available. |
| 472 </p> | 490 </p> |
| 473 <dl> | 491 <dl> |
| 474 <dt>Return:</dt> | 492 <dt>Return:</dt> |
| 475 <dd> | 493 <dd> |
| 476 flag indicating the availability of plugins (boolean) | 494 flag indicating the availability of plugins |
| 495 </dd> | |
| 496 </dl> | |
| 497 <dl> | |
| 498 <dt>Return Type:</dt> | |
| 499 <dd> | |
| 500 bool | |
| 477 </dd> | 501 </dd> |
| 478 </dl> | 502 </dl> |
| 479 <a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a> | 503 <a NAME="PluginManager.__sslErrors" ID="PluginManager.__sslErrors"></a> |
| 480 <h4>PluginManager.__sslErrors</h4> | 504 <h4>PluginManager.__sslErrors</h4> |
| 481 <b>__sslErrors</b>(<i>reply, errors</i>) | 505 <b>__sslErrors</b>(<i>reply, errors</i>) |
| 483 <p> | 507 <p> |
| 484 Private slot to handle SSL errors. | 508 Private slot to handle SSL errors. |
| 485 </p> | 509 </p> |
| 486 <dl> | 510 <dl> |
| 487 | 511 |
| 488 <dt><i>reply</i></dt> | 512 <dt><i>reply</i> (QNetworkReply)</dt> |
| 489 <dd> | 513 <dd> |
| 490 reference to the reply object (QNetworkReply) | 514 reference to the reply object |
| 491 </dd> | 515 </dd> |
| 492 <dt><i>errors</i></dt> | 516 <dt><i>errors</i> (list of QSslError)</dt> |
| 493 <dd> | 517 <dd> |
| 494 list of SSL errors (list of QSslError) | 518 list of SSL errors |
| 495 </dd> | 519 </dd> |
| 496 </dl> | 520 </dl> |
| 497 <a NAME="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a> | 521 <a NAME="PluginManager.activatePlugin" ID="PluginManager.activatePlugin"></a> |
| 498 <h4>PluginManager.activatePlugin</h4> | 522 <h4>PluginManager.activatePlugin</h4> |
| 499 <b>activatePlugin</b>(<i>name, onDemand=False</i>) | 523 <b>activatePlugin</b>(<i>name, onDemand=False</i>) |
| 541 Public method to activate all plugins having the "autoactivate" | 565 Public method to activate all plugins having the "autoactivate" |
| 542 attribute set to True. | 566 attribute set to True. |
| 543 </p> | 567 </p> |
| 544 <a NAME="PluginManager.checkPluginEntry" ID="PluginManager.checkPluginEntry"></a> | 568 <a NAME="PluginManager.checkPluginEntry" ID="PluginManager.checkPluginEntry"></a> |
| 545 <h4>PluginManager.checkPluginEntry</h4> | 569 <h4>PluginManager.checkPluginEntry</h4> |
| 546 <b>checkPluginEntry</b>(<i>name, short, description, url, author, version, filename, status, </i>) | 570 <b>checkPluginEntry</b>(<i>name, short, description, url, author, version, filename, status, category, </i>) |
| 547 | 571 |
| 548 <p> | 572 <p> |
| 549 Public method to check a plug-in's data for an update. | 573 Public method to check a plug-in's data for an update. |
| 550 </p> | 574 </p> |
| 551 <dl> | 575 <dl> |
| 552 | 576 |
| 553 <dt><i>name</i></dt> | 577 <dt><i>name</i> (str)</dt> |
| 554 <dd> | 578 <dd> |
| 555 data for the name field (string) | 579 data for the name field |
| 556 </dd> | 580 </dd> |
| 557 <dt><i>short</i></dt> | 581 <dt><i>short</i> (str)</dt> |
| 558 <dd> | 582 <dd> |
| 559 data for the short field (string) | 583 data for the short field |
| 560 </dd> | 584 </dd> |
| 561 <dt><i>description</i></dt> | 585 <dt><i>description</i> (list of str)</dt> |
| 562 <dd> | 586 <dd> |
| 563 data for the description field (list of strings) | 587 data for the description field |
| 564 </dd> | 588 </dd> |
| 565 <dt><i>url</i></dt> | 589 <dt><i>url</i> (str)</dt> |
| 566 <dd> | 590 <dd> |
| 567 data for the url field (string) | 591 data for the url field |
| 568 </dd> | 592 </dd> |
| 569 <dt><i>author</i></dt> | 593 <dt><i>author</i> (str)</dt> |
| 570 <dd> | 594 <dd> |
| 571 data for the author field (string) | 595 data for the author field |
| 572 </dd> | 596 </dd> |
| 573 <dt><i>version</i></dt> | 597 <dt><i>version</i> (str)</dt> |
| 574 <dd> | 598 <dd> |
| 575 data for the version field (string) | 599 data for the version field |
| 576 </dd> | 600 </dd> |
| 577 <dt><i>filename</i></dt> | 601 <dt><i>filename</i> (str)</dt> |
| 578 <dd> | 602 <dd> |
| 579 data for the filename field (string) | 603 data for the filename field |
| 580 </dd> | 604 </dd> |
| 581 <dt><i>status</i></dt> | 605 <dt><i>status</i> (str)</dt> |
| 582 <dd> | 606 <dd> |
| 583 status of the plugin (string [stable, unstable, unknown]) | 607 status of the plugin (one of stable, unstable, unknown) |
| 608 </dd> | |
| 609 <dt><i>category</i> (str)</dt> | |
| 610 <dd> | |
| 611 category designation of the plugin | |
| 584 </dd> | 612 </dd> |
| 585 </dl> | 613 </dl> |
| 586 <a NAME="PluginManager.checkPluginUpdatesAvailable" ID="PluginManager.checkPluginUpdatesAvailable"></a> | 614 <a NAME="PluginManager.checkPluginUpdatesAvailable" ID="PluginManager.checkPluginUpdatesAvailable"></a> |
| 587 <h4>PluginManager.checkPluginUpdatesAvailable</h4> | 615 <h4>PluginManager.checkPluginUpdatesAvailable</h4> |
| 588 <b>checkPluginUpdatesAvailable</b>(<i></i>) | 616 <b>checkPluginUpdatesAvailable</b>(<i></i>) |
| 602 Plugins supporting this functionality must support the module function | 630 Plugins supporting this functionality must support the module function |
| 603 clearPrivateData() and have the module level attribute pluginType. | 631 clearPrivateData() and have the module level attribute pluginType. |
| 604 </p> | 632 </p> |
| 605 <dl> | 633 <dl> |
| 606 | 634 |
| 607 <dt><i>type_</i></dt> | 635 <dt><i>type_</i> (str)</dt> |
| 608 <dd> | 636 <dd> |
| 609 type of the plugin to clear private data for (string) | 637 type of the plugin to clear private data for |
| 610 </dd> | 638 </dd> |
| 611 </dl> | 639 </dl> |
| 612 <a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a> | 640 <a NAME="PluginManager.deactivatePlugin" ID="PluginManager.deactivatePlugin"></a> |
| 613 <h4>PluginManager.deactivatePlugin</h4> | 641 <h4>PluginManager.deactivatePlugin</h4> |
| 614 <b>deactivatePlugin</b>(<i>name, onDemand=False</i>) | 642 <b>deactivatePlugin</b>(<i>name, onDemand=False</i>) |
| 616 <p> | 644 <p> |
| 617 Public method to deactivate a plugin. | 645 Public method to deactivate a plugin. |
| 618 </p> | 646 </p> |
| 619 <dl> | 647 <dl> |
| 620 | 648 |
| 621 <dt><i>name</i></dt> | 649 <dt><i>name</i> (str)</dt> |
| 622 <dd> | 650 <dd> |
| 623 name of the module to be deactivated | 651 name of the module to be deactivated |
| 624 </dd> | 652 </dd> |
| 625 <dt><i>onDemand</i></dt> | 653 <dt><i>onDemand</i> (bool)</dt> |
| 626 <dd> | 654 <dd> |
| 627 flag indicating deactivation of an | 655 flag indicating deactivation of an |
| 628 on demand plugin (boolean) | 656 on demand plugin |
| 629 </dd> | 657 </dd> |
| 630 </dl> | 658 </dl> |
| 631 <a NAME="PluginManager.deactivateVcsPlugins" ID="PluginManager.deactivateVcsPlugins"></a> | 659 <a NAME="PluginManager.deactivateVcsPlugins" ID="PluginManager.deactivateVcsPlugins"></a> |
| 632 <h4>PluginManager.deactivateVcsPlugins</h4> | 660 <h4>PluginManager.deactivateVcsPlugins</h4> |
| 633 <b>deactivateVcsPlugins</b>(<i></i>) | 661 <b>deactivateVcsPlugins</b>(<i></i>) |
| 671 <p> | 699 <p> |
| 672 Public method to get the list of API files installed by a plugin. | 700 Public method to get the list of API files installed by a plugin. |
| 673 </p> | 701 </p> |
| 674 <dl> | 702 <dl> |
| 675 | 703 |
| 676 <dt><i>language</i></dt> | 704 <dt><i>language</i> (str)</dt> |
| 677 <dd> | 705 <dd> |
| 678 language of the requested API files (string) | 706 language of the requested API files |
| 679 </dd> | 707 </dd> |
| 680 </dl> | 708 </dl> |
| 681 <dl> | 709 <dl> |
| 682 <dt>Return:</dt> | 710 <dt>Return:</dt> |
| 683 <dd> | 711 <dd> |
| 684 list of API filenames (list of string) | 712 list of API filenames |
| 713 </dd> | |
| 714 </dl> | |
| 715 <dl> | |
| 716 <dt>Return Type:</dt> | |
| 717 <dd> | |
| 718 list of str | |
| 685 </dd> | 719 </dd> |
| 686 </dl> | 720 </dl> |
| 687 <a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a> | 721 <a NAME="PluginManager.getPluginConfigData" ID="PluginManager.getPluginConfigData"></a> |
| 688 <h4>PluginManager.getPluginConfigData</h4> | 722 <h4>PluginManager.getPluginConfigData</h4> |
| 689 <b>getPluginConfigData</b>(<i></i>) | 723 <b>getPluginConfigData</b>(<i></i>) |
| 722 <dt>Return:</dt> | 756 <dt>Return:</dt> |
| 723 <dd> | 757 <dd> |
| 724 plug-in configuration data | 758 plug-in configuration data |
| 725 </dd> | 759 </dd> |
| 726 </dl> | 760 </dl> |
| 761 <dl> | |
| 762 <dt>Return Type:</dt> | |
| 763 <dd> | |
| 764 dict | |
| 765 </dd> | |
| 766 </dl> | |
| 727 <a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> | 767 <a NAME="PluginManager.getPluginDetails" ID="PluginManager.getPluginDetails"></a> |
| 728 <h4>PluginManager.getPluginDetails</h4> | 768 <h4>PluginManager.getPluginDetails</h4> |
| 729 <b>getPluginDetails</b>(<i>name</i>) | 769 <b>getPluginDetails</b>(<i>name</i>) |
| 730 | 770 |
| 731 <p> | 771 <p> |
| 732 Public method to get detailed information about a plugin. | 772 Public method to get detailed information about a plugin. |
| 733 </p> | 773 </p> |
| 734 <dl> | 774 <dl> |
| 735 | 775 |
| 736 <dt><i>name</i></dt> | 776 <dt><i>name</i> (str)</dt> |
| 737 <dd> | 777 <dd> |
| 738 name of the module to get detailed infos about (string) | 778 name of the module to get detailed infos about |
| 739 </dd> | 779 </dd> |
| 740 </dl> | 780 </dl> |
| 741 <dl> | 781 <dl> |
| 742 <dt>Return:</dt> | 782 <dt>Return:</dt> |
| 743 <dd> | 783 <dd> |
| 744 details of the plugin as a dictionary | 784 details of the plugin as a dictionary |
| 785 </dd> | |
| 786 </dl> | |
| 787 <dl> | |
| 788 <dt>Return Type:</dt> | |
| 789 <dd> | |
| 790 dict | |
| 745 </dd> | 791 </dd> |
| 746 </dl> | 792 </dl> |
| 747 <a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a> | 793 <a NAME="PluginManager.getPluginDir" ID="PluginManager.getPluginDir"></a> |
| 748 <h4>PluginManager.getPluginDir</h4> | 794 <h4>PluginManager.getPluginDir</h4> |
| 749 <b>getPluginDir</b>(<i>key</i>) | 795 <b>getPluginDir</b>(<i>key</i>) |
| 751 <p> | 797 <p> |
| 752 Public method to get the path of a plugin directory. | 798 Public method to get the path of a plugin directory. |
| 753 </p> | 799 </p> |
| 754 <dl> | 800 <dl> |
| 755 | 801 |
| 756 <dt><i>key</i></dt> | 802 <dt><i>key</i> (str)</dt> |
| 757 <dd> | 803 <dd> |
| 758 key of the plug-in directory (string) | 804 key of the plug-in directory |
| 759 </dd> | 805 </dd> |
| 760 </dl> | 806 </dl> |
| 761 <dl> | 807 <dl> |
| 762 <dt>Return:</dt> | 808 <dt>Return:</dt> |
| 763 <dd> | 809 <dd> |
| 764 path of the requested plugin directory (string) | 810 path of the requested plugin directory |
| 811 </dd> | |
| 812 </dl> | |
| 813 <dl> | |
| 814 <dt>Return Type:</dt> | |
| 815 <dd> | |
| 816 str | |
| 765 </dd> | 817 </dd> |
| 766 </dl> | 818 </dl> |
| 767 <a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a> | 819 <a NAME="PluginManager.getPluginDisplayStrings" ID="PluginManager.getPluginDisplayStrings"></a> |
| 768 <h4>PluginManager.getPluginDisplayStrings</h4> | 820 <h4>PluginManager.getPluginDisplayStrings</h4> |
| 769 <b>getPluginDisplayStrings</b>(<i>type_</i>) | 821 <b>getPluginDisplayStrings</b>(<i>type_</i>) |
| 772 Public method to get the display strings of all plugins of a specific | 824 Public method to get the display strings of all plugins of a specific |
| 773 type. | 825 type. |
| 774 </p> | 826 </p> |
| 775 <dl> | 827 <dl> |
| 776 | 828 |
| 777 <dt><i>type_</i></dt> | 829 <dt><i>type_</i> (str)</dt> |
| 778 <dd> | 830 <dd> |
| 779 type of the plugins (string) | 831 type of the plugins |
| 780 </dd> | 832 </dd> |
| 781 </dl> | 833 </dl> |
| 782 <dl> | 834 <dl> |
| 783 <dt>Return:</dt> | 835 <dt>Return:</dt> |
| 784 <dd> | 836 <dd> |
| 785 dictionary with name as key and display string as value | 837 dictionary with name as key and display string as value |
| 786 (dictionary of string) | 838 </dd> |
| 839 </dl> | |
| 840 <dl> | |
| 841 <dt>Return Type:</dt> | |
| 842 <dd> | |
| 843 dict | |
| 787 </dd> | 844 </dd> |
| 788 </dl> | 845 </dl> |
| 789 <a NAME="PluginManager.getPluginExeDisplayData" ID="PluginManager.getPluginExeDisplayData"></a> | 846 <a NAME="PluginManager.getPluginExeDisplayData" ID="PluginManager.getPluginExeDisplayData"></a> |
| 790 <h4>PluginManager.getPluginExeDisplayData</h4> | 847 <h4>PluginManager.getPluginExeDisplayData</h4> |
| 791 <b>getPluginExeDisplayData</b>(<i></i>) | 848 <b>getPluginExeDisplayData</b>(<i></i>) |
| 825 <li>text - entry text to be shown (string)</li> | 882 <li>text - entry text to be shown (string)</li> |
| 826 <li>version - version text to be shown (string)</li> | 883 <li>version - version text to be shown (string)</li> |
| 827 </ul> | 884 </ul> |
| 828 </dd> | 885 </dd> |
| 829 </dl> | 886 </dl> |
| 887 <dl> | |
| 888 <dt>Return Type:</dt> | |
| 889 <dd> | |
| 890 list of dict | |
| 891 </dd> | |
| 892 </dl> | |
| 830 <a NAME="PluginManager.getPluginInfos" ID="PluginManager.getPluginInfos"></a> | 893 <a NAME="PluginManager.getPluginInfos" ID="PluginManager.getPluginInfos"></a> |
| 831 <h4>PluginManager.getPluginInfos</h4> | 894 <h4>PluginManager.getPluginInfos</h4> |
| 832 <b>getPluginInfos</b>(<i></i>) | 895 <b>getPluginInfos</b>(<i></i>) |
| 833 | 896 |
| 834 <p> | 897 <p> |
| 856 <p> | 919 <p> |
| 857 Public method to get a list of plugin modules. | 920 Public method to get a list of plugin modules. |
| 858 </p> | 921 </p> |
| 859 <dl> | 922 <dl> |
| 860 | 923 |
| 861 <dt><i>pluginPath</i></dt> | 924 <dt><i>pluginPath</i> (str)</dt> |
| 862 <dd> | 925 <dd> |
| 863 name of the path to search (string) | 926 name of the path to search |
| 864 </dd> | 927 </dd> |
| 865 </dl> | 928 </dl> |
| 866 <dl> | 929 <dl> |
| 867 <dt>Return:</dt> | 930 <dt>Return:</dt> |
| 868 <dd> | 931 <dd> |
| 869 list of plugin module names (list of string) | 932 list of plugin module names |
| 933 </dd> | |
| 934 </dl> | |
| 935 <dl> | |
| 936 <dt>Return Type:</dt> | |
| 937 <dd> | |
| 938 list of str | |
| 870 </dd> | 939 </dd> |
| 871 </dl> | 940 </dl> |
| 872 <a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a> | 941 <a NAME="PluginManager.getPluginObject" ID="PluginManager.getPluginObject"></a> |
| 873 <h4>PluginManager.getPluginObject</h4> | 942 <h4>PluginManager.getPluginObject</h4> |
| 874 <b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>) | 943 <b>getPluginObject</b>(<i>type_, typename, maybeActive=False</i>) |
| 875 | 944 |
| 876 <p> | 945 <p> |
| 877 Public method to activate an ondemand plugin given by type and | 946 Public method to activate an on-demand plugin given by type and |
| 878 typename. | 947 type name. |
| 879 </p> | 948 </p> |
| 880 <dl> | 949 <dl> |
| 881 | 950 |
| 882 <dt><i>type_</i> (str)</dt> | 951 <dt><i>type_</i> (str)</dt> |
| 883 <dd> | 952 <dd> |
| 912 <p> | 981 <p> |
| 913 Public method to get a preview pixmap of a plugin of a specific type. | 982 Public method to get a preview pixmap of a plugin of a specific type. |
| 914 </p> | 983 </p> |
| 915 <dl> | 984 <dl> |
| 916 | 985 |
| 917 <dt><i>type_</i></dt> | 986 <dt><i>type_</i> (str)</dt> |
| 918 <dd> | 987 <dd> |
| 919 type of the plugin (string) | 988 type of the plugin |
| 920 </dd> | 989 </dd> |
| 921 <dt><i>name</i></dt> | 990 <dt><i>name</i> (str)</dt> |
| 922 <dd> | 991 <dd> |
| 923 name of the plugin type (string) | 992 name of the plugin type |
| 924 </dd> | 993 </dd> |
| 925 </dl> | 994 </dl> |
| 926 <dl> | 995 <dl> |
| 927 <dt>Return:</dt> | 996 <dt>Return:</dt> |
| 928 <dd> | 997 <dd> |
| 929 preview pixmap (QPixmap) | 998 preview pixmap |
| 999 </dd> | |
| 1000 </dl> | |
| 1001 <dl> | |
| 1002 <dt>Return Type:</dt> | |
| 1003 <dd> | |
| 1004 QPixmap | |
| 930 </dd> | 1005 </dd> |
| 931 </dl> | 1006 </dl> |
| 932 <a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a> | 1007 <a NAME="PluginManager.getPluginQtHelpFiles" ID="PluginManager.getPluginQtHelpFiles"></a> |
| 933 <h4>PluginManager.getPluginQtHelpFiles</h4> | 1008 <h4>PluginManager.getPluginQtHelpFiles</h4> |
| 934 <b>getPluginQtHelpFiles</b>(<i></i>) | 1009 <b>getPluginQtHelpFiles</b>(<i></i>) |
| 964 </p> | 1039 </p> |
| 965 <dl> | 1040 <dl> |
| 966 <dt>Return:</dt> | 1041 <dt>Return:</dt> |
| 967 <dd> | 1042 <dd> |
| 968 dictionary with indicator as key and a list of tuples as | 1043 dictionary with indicator as key and a list of tuples as |
| 969 values. Each tuple contains the vcs name (string) and vcs display | 1044 values. Each tuple contains the vcs name (str) and vcs display |
| 970 string (string). | 1045 string (str). |
| 1046 </dd> | |
| 1047 </dl> | |
| 1048 <dl> | |
| 1049 <dt>Return Type:</dt> | |
| 1050 <dd> | |
| 1051 dict | |
| 971 </dd> | 1052 </dd> |
| 972 </dl> | 1053 </dl> |
| 973 <a NAME="PluginManager.initOnDemandPlugin" ID="PluginManager.initOnDemandPlugin"></a> | 1054 <a NAME="PluginManager.initOnDemandPlugin" ID="PluginManager.initOnDemandPlugin"></a> |
| 974 <h4>PluginManager.initOnDemandPlugin</h4> | 1055 <h4>PluginManager.initOnDemandPlugin</h4> |
| 975 <b>initOnDemandPlugin</b>(<i>name</i>) | 1056 <b>initOnDemandPlugin</b>(<i>name</i>) |
| 980 <p> | 1061 <p> |
| 981 Note: The plug-in is not activated. | 1062 Note: The plug-in is not activated. |
| 982 </p> | 1063 </p> |
| 983 <dl> | 1064 <dl> |
| 984 | 1065 |
| 985 <dt><i>name</i></dt> | 1066 <dt><i>name</i> (str)</dt> |
| 986 <dd> | 1067 <dd> |
| 987 name of the plug-in (string) | 1068 name of the plug-in |
| 988 </dd> | 1069 </dd> |
| 989 </dl> | 1070 </dl> |
| 990 <dl> | 1071 <dl> |
| 991 | 1072 |
| 992 <dt>Raises <b>PluginActivationError</b>:</dt> | 1073 <dt>Raises <b>PluginActivationError</b>:</dt> |
| 1012 <p> | 1093 <p> |
| 1013 Public method to initialize plug-in toolbars. | 1094 Public method to initialize plug-in toolbars. |
| 1014 </p> | 1095 </p> |
| 1015 <dl> | 1096 <dl> |
| 1016 | 1097 |
| 1017 <dt><i>toolbarManager</i></dt> | 1098 <dt><i>toolbarManager</i> (EricToolBarManager)</dt> |
| 1018 <dd> | 1099 <dd> |
| 1019 reference to the toolbar manager object | 1100 reference to the toolbar manager object |
| 1020 (EricToolBarManager) | |
| 1021 </dd> | 1101 </dd> |
| 1022 </dl> | 1102 </dl> |
| 1023 <a NAME="PluginManager.isPluginActive" ID="PluginManager.isPluginActive"></a> | 1103 <a NAME="PluginManager.isPluginActive" ID="PluginManager.isPluginActive"></a> |
| 1024 <h4>PluginManager.isPluginActive</h4> | 1104 <h4>PluginManager.isPluginActive</h4> |
| 1025 <b>isPluginActive</b>(<i>pluginName</i>) | 1105 <b>isPluginActive</b>(<i>pluginName</i>) |
| 1027 <p> | 1107 <p> |
| 1028 Public method to check, if a certain plugin is active. | 1108 Public method to check, if a certain plugin is active. |
| 1029 </p> | 1109 </p> |
| 1030 <dl> | 1110 <dl> |
| 1031 | 1111 |
| 1032 <dt><i>pluginName</i></dt> | 1112 <dt><i>pluginName</i> (str)</dt> |
| 1033 <dd> | 1113 <dd> |
| 1034 name of the plugin to check for (string) | 1114 name of the plugin to check for |
| 1035 </dd> | 1115 </dd> |
| 1036 </dl> | 1116 </dl> |
| 1037 <dl> | 1117 <dl> |
| 1038 <dt>Return:</dt> | 1118 <dt>Return:</dt> |
| 1039 <dd> | 1119 <dd> |
| 1040 flag indicating, if the plugin is active (boolean) | 1120 flag indicating, if the plugin is active |
| 1121 </dd> | |
| 1122 </dl> | |
| 1123 <dl> | |
| 1124 <dt>Return Type:</dt> | |
| 1125 <dd> | |
| 1126 bool | |
| 1041 </dd> | 1127 </dd> |
| 1042 </dl> | 1128 </dl> |
| 1043 <a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a> | 1129 <a NAME="PluginManager.isPluginLoaded" ID="PluginManager.isPluginLoaded"></a> |
| 1044 <h4>PluginManager.isPluginLoaded</h4> | 1130 <h4>PluginManager.isPluginLoaded</h4> |
| 1045 <b>isPluginLoaded</b>(<i>pluginName</i>) | 1131 <b>isPluginLoaded</b>(<i>pluginName</i>) |
| 1047 <p> | 1133 <p> |
| 1048 Public method to check, if a certain plugin is loaded. | 1134 Public method to check, if a certain plugin is loaded. |
| 1049 </p> | 1135 </p> |
| 1050 <dl> | 1136 <dl> |
| 1051 | 1137 |
| 1052 <dt><i>pluginName</i></dt> | 1138 <dt><i>pluginName</i> (str)</dt> |
| 1053 <dd> | 1139 <dd> |
| 1054 name of the plugin to check for (string) | 1140 name of the plugin to check for |
| 1055 </dd> | 1141 </dd> |
| 1056 </dl> | 1142 </dl> |
| 1057 <dl> | 1143 <dl> |
| 1058 <dt>Return:</dt> | 1144 <dt>Return:</dt> |
| 1059 <dd> | 1145 <dd> |
| 1060 flag indicating, if the plugin is loaded (boolean) | 1146 flag indicating, if the plugin is loaded |
| 1147 </dd> | |
| 1148 </dl> | |
| 1149 <dl> | |
| 1150 <dt>Return Type:</dt> | |
| 1151 <dd> | |
| 1152 bool | |
| 1061 </dd> | 1153 </dd> |
| 1062 </dl> | 1154 </dl> |
| 1063 <a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a> | 1155 <a NAME="PluginManager.isValidPluginName" ID="PluginManager.isValidPluginName"></a> |
| 1064 <h4>PluginManager.isValidPluginName</h4> | 1156 <h4>PluginManager.isValidPluginName</h4> |
| 1065 <b>isValidPluginName</b>(<i>pluginName</i>) | 1157 <b>isValidPluginName</b>(<i>pluginName</i>) |
| 1070 <p> | 1162 <p> |
| 1071 Plugin modules must start with "Plugin" and have the extension ".py". | 1163 Plugin modules must start with "Plugin" and have the extension ".py". |
| 1072 </p> | 1164 </p> |
| 1073 <dl> | 1165 <dl> |
| 1074 | 1166 |
| 1075 <dt><i>pluginName</i></dt> | 1167 <dt><i>pluginName</i> (str)</dt> |
| 1076 <dd> | 1168 <dd> |
| 1077 name of the file to be checked (string) | 1169 name of the file to be checked |
| 1078 </dd> | 1170 </dd> |
| 1079 </dl> | 1171 </dl> |
| 1080 <dl> | 1172 <dl> |
| 1081 <dt>Return:</dt> | 1173 <dt>Return:</dt> |
| 1082 <dd> | 1174 <dd> |
| 1083 flag indicating a valid plugin name (boolean) | 1175 flag indicating a valid plugin name |
| 1176 </dd> | |
| 1177 </dl> | |
| 1178 <dl> | |
| 1179 <dt>Return Type:</dt> | |
| 1180 <dd> | |
| 1181 bool | |
| 1084 </dd> | 1182 </dd> |
| 1085 </dl> | 1183 </dl> |
| 1086 <a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a> | 1184 <a NAME="PluginManager.loadDocumentationSetPlugins" ID="PluginManager.loadDocumentationSetPlugins"></a> |
| 1087 <h4>PluginManager.loadDocumentationSetPlugins</h4> | 1185 <h4>PluginManager.loadDocumentationSetPlugins</h4> |
| 1088 <b>loadDocumentationSetPlugins</b>(<i></i>) | 1186 <b>loadDocumentationSetPlugins</b>(<i></i>) |
| 1168 Public method to remove a plugin and all related modules from | 1266 Public method to remove a plugin and all related modules from |
| 1169 sys.modules. | 1267 sys.modules. |
| 1170 </p> | 1268 </p> |
| 1171 <dl> | 1269 <dl> |
| 1172 | 1270 |
| 1173 <dt><i>pluginName</i></dt> | 1271 <dt><i>pluginName</i> (str)</dt> |
| 1174 <dd> | 1272 <dd> |
| 1175 name of the plugin module (string) | 1273 name of the plugin module |
| 1176 </dd> | 1274 </dd> |
| 1177 <dt><i>package</i></dt> | 1275 <dt><i>package</i> (str)</dt> |
| 1178 <dd> | 1276 <dd> |
| 1179 name of the plugin package (string) | 1277 name of the plugin package |
| 1180 </dd> | 1278 </dd> |
| 1181 <dt><i>internalPackages</i></dt> | 1279 <dt><i>internalPackages</i> (list of str)</dt> |
| 1182 <dd> | 1280 <dd> |
| 1183 list of intenal packages (list of string) | 1281 list of intenal packages |
| 1184 </dd> | 1282 </dd> |
| 1185 </dl> | 1283 </dl> |
| 1186 <dl> | 1284 <dl> |
| 1187 <dt>Return:</dt> | 1285 <dt>Return:</dt> |
| 1188 <dd> | 1286 <dd> |
| 1189 flag indicating the plugin module was found in sys.modules | 1287 flag indicating the plugin module was found in sys.modules |
| 1190 (boolean) | 1288 </dd> |
| 1289 </dl> | |
| 1290 <dl> | |
| 1291 <dt>Return Type:</dt> | |
| 1292 <dd> | |
| 1293 bool | |
| 1191 </dd> | 1294 </dd> |
| 1192 </dl> | 1295 </dl> |
| 1193 <a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a> | 1296 <a NAME="PluginManager.unloadPlugin" ID="PluginManager.unloadPlugin"></a> |
| 1194 <h4>PluginManager.unloadPlugin</h4> | 1297 <h4>PluginManager.unloadPlugin</h4> |
| 1195 <b>unloadPlugin</b>(<i>name</i>) | 1298 <b>unloadPlugin</b>(<i>name</i>) |
| 1197 <p> | 1300 <p> |
| 1198 Public method to unload a plugin module. | 1301 Public method to unload a plugin module. |
| 1199 </p> | 1302 </p> |
| 1200 <dl> | 1303 <dl> |
| 1201 | 1304 |
| 1202 <dt><i>name</i></dt> | 1305 <dt><i>name</i> (str)</dt> |
| 1203 <dd> | 1306 <dd> |
| 1204 name of the module to be unloaded (string) | 1307 name of the module to be unloaded |
| 1205 </dd> | 1308 </dd> |
| 1206 </dl> | 1309 </dl> |
| 1207 <dl> | 1310 <dl> |
| 1208 <dt>Return:</dt> | 1311 <dt>Return:</dt> |
| 1209 <dd> | 1312 <dd> |
| 1210 flag indicating success (boolean) | 1313 flag indicating success |
| 1314 </dd> | |
| 1315 </dl> | |
| 1316 <dl> | |
| 1317 <dt>Return Type:</dt> | |
| 1318 <dd> | |
| 1319 bool | |
| 1211 </dd> | 1320 </dd> |
| 1212 </dl> | 1321 </dl> |
| 1213 <div align="right"><a href="#top">Up</a></div> | 1322 <div align="right"><a href="#top">Up</a></div> |
| 1214 <hr /> | 1323 <hr /> |
| 1215 </body></html> | 1324 </body></html> |
