Mercurial Repositories > Eric Assistant / file comparison
comparison: AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html
AssistantEric/Documentation/source/Plugin_Assistant_Eric.AssistantEric.APIsManager.html
- changeset 177
- 25cb41783971
- parent 163
- 842fce9b31ce
- child 180
- 89ff060ef0d9
equal
deleted
inserted
replaced
| 176:cd43366c7394 | 177:25cb41783971 |
|---|---|
| 88 <tr> | 88 <tr> |
| 89 <td><a href="#APIsManager.__showMessage">__showMessage</a></td> | 89 <td><a href="#APIsManager.__showMessage">__showMessage</a></td> |
| 90 <td>Private message to show a message in the main windows status bar.</td> | 90 <td>Private message to show a message in the main windows status bar.</td> |
| 91 </tr> | 91 </tr> |
| 92 <tr> | 92 <tr> |
| 93 <td><a href="#APIsManager.__supportedApiLanguages">__supportedApiLanguages</a></td> | |
| 94 <td>Private method to build a list of supported API languages.</td> | |
| 95 </tr> | |
| 96 <tr> | |
| 97 <td><a href="#APIsManager.deactivate">deactivate</a></td> | 93 <td><a href="#APIsManager.deactivate">deactivate</a></td> |
| 98 <td>Public method to perform actions upon deactivation.</td> | 94 <td>Public method to perform actions upon deactivation.</td> |
| 99 </tr> | 95 </tr> |
| 100 <tr> | 96 <tr> |
| 101 <td><a href="#APIsManager.getAPIs">getAPIs</a></td> | 97 <td><a href="#APIsManager.getAPIs">getAPIs</a></td> |
| 164 <dt><i>msg</i></dt> | 160 <dt><i>msg</i></dt> |
| 165 <dd> | 161 <dd> |
| 166 message to be shown (string) | 162 message to be shown (string) |
| 167 </dd> | 163 </dd> |
| 168 </dl> | 164 </dl> |
| 169 <a NAME="APIsManager.__supportedApiLanguages" ID="APIsManager.__supportedApiLanguages"></a> | |
| 170 <h4>APIsManager.__supportedApiLanguages</h4> | |
| 171 <b>__supportedApiLanguages</b>(<i></i>) | |
| 172 | |
| 173 <p> | |
| 174 Private method to build a list of supported API languages. | |
| 175 </p> | |
| 176 <p> | |
| 177 Note: This is a compatibility method to make this code work with | |
| 178 older eric versions. | |
| 179 </p> | |
| 180 <dl> | |
| 181 <dt>Returns:</dt> | |
| 182 <dd> | |
| 183 list of supported API languages | |
| 184 </dd> | |
| 185 </dl> | |
| 186 <dl> | |
| 187 <dt>Return Type:</dt> | |
| 188 <dd> | |
| 189 list of str | |
| 190 </dd> | |
| 191 </dl> | |
| 192 <a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a> | 165 <a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a> |
| 193 <h4>APIsManager.deactivate</h4> | 166 <h4>APIsManager.deactivate</h4> |
| 194 <b>deactivate</b>(<i></i>) | 167 <b>deactivate</b>(<i></i>) |
| 195 | 168 |
| 196 <p> | 169 <p> |
| 218 <dd> | 191 <dd> |
| 219 type of the project | 192 type of the project |
| 220 </dd> | 193 </dd> |
| 221 </dl> | 194 </dl> |
| 222 <dl> | 195 <dl> |
| 223 <dt>Returns:</dt> | 196 <dt>Return:</dt> |
| 224 <dd> | 197 <dd> |
| 225 reference to the APIs object | 198 reference to the APIs object |
| 226 </dd> | 199 </dd> |
| 227 </dl> | 200 </dl> |
| 228 <dl> | 201 <dl> |
| 422 <dd> | 395 <dd> |
| 423 number of commas to check for (integer) | 396 number of commas to check for (integer) |
| 424 </dd> | 397 </dd> |
| 425 </dl> | 398 </dl> |
| 426 <dl> | 399 <dl> |
| 427 <dt>Returns:</dt> | 400 <dt>Return:</dt> |
| 428 <dd> | 401 <dd> |
| 429 flag indicating, that there are enough commas (boolean) | 402 flag indicating, that there are enough commas (boolean) |
| 430 </dd> | 403 </dd> |
| 431 </dl> | 404 </dl> |
| 432 <a NAME="DbAPIs.__getProjectFormSources" ID="DbAPIs.__getProjectFormSources"></a> | 405 <a NAME="DbAPIs.__getProjectFormSources" ID="DbAPIs.__getProjectFormSources"></a> |
| 443 flag indicating a normalized filename is wanted | 416 flag indicating a normalized filename is wanted |
| 444 (boolean) | 417 (boolean) |
| 445 </dd> | 418 </dd> |
| 446 </dl> | 419 </dl> |
| 447 <dl> | 420 <dl> |
| 448 <dt>Returns:</dt> | 421 <dt>Return:</dt> |
| 449 <dd> | 422 <dd> |
| 450 list of project form sources (list of strings) | 423 list of project form sources (list of strings) |
| 451 </dd> | 424 </dd> |
| 452 </dl> | 425 </dl> |
| 453 <a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a> | 426 <a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a> |
| 470 | 443 |
| 471 <p> | 444 <p> |
| 472 Private method to check, if the database has been prepared. | 445 Private method to check, if the database has been prepared. |
| 473 </p> | 446 </p> |
| 474 <dl> | 447 <dl> |
| 475 <dt>Returns:</dt> | 448 <dt>Return:</dt> |
| 476 <dd> | 449 <dd> |
| 477 flag indicating the prepared status (boolean) | 450 flag indicating the prepared status (boolean) |
| 478 </dd> | 451 </dd> |
| 479 </dl> | 452 </dl> |
| 480 <a NAME="DbAPIs.__openAPIs" ID="DbAPIs.__openAPIs"></a> | 453 <a NAME="DbAPIs.__openAPIs" ID="DbAPIs.__openAPIs"></a> |
| 490 | 463 |
| 491 <p> | 464 <p> |
| 492 Private method to open the API database. | 465 Private method to open the API database. |
| 493 </p> | 466 </p> |
| 494 <dl> | 467 <dl> |
| 495 <dt>Returns:</dt> | 468 <dt>Return:</dt> |
| 496 <dd> | 469 <dd> |
| 497 flag indicating the database status (boolean) | 470 flag indicating the database status (boolean) |
| 498 </dd> | 471 </dd> |
| 499 </dl> | 472 </dl> |
| 500 <a NAME="DbAPIs.__processQueue" ID="DbAPIs.__processQueue"></a> | 473 <a NAME="DbAPIs.__processQueue" ID="DbAPIs.__processQueue"></a> |
| 564 | 537 |
| 565 <p> | 538 <p> |
| 566 Protected method to determine the name of the database file. | 539 Protected method to determine the name of the database file. |
| 567 </p> | 540 </p> |
| 568 <dl> | 541 <dl> |
| 569 <dt>Returns:</dt> | 542 <dt>Return:</dt> |
| 570 <dd> | 543 <dd> |
| 571 name of the database file (string) | 544 name of the database file (string) |
| 572 </dd> | 545 </dd> |
| 573 </dl> | 546 </dl> |
| 574 <a NAME="DbAPIs.autoCompletionWordSeparators" ID="DbAPIs.autoCompletionWordSeparators"></a> | 547 <a NAME="DbAPIs.autoCompletionWordSeparators" ID="DbAPIs.autoCompletionWordSeparators"></a> |
| 577 | 550 |
| 578 <p> | 551 <p> |
| 579 Public method to get the word separator characters. | 552 Public method to get the word separator characters. |
| 580 </p> | 553 </p> |
| 581 <dl> | 554 <dl> |
| 582 <dt>Returns:</dt> | 555 <dt>Return:</dt> |
| 583 <dd> | 556 <dd> |
| 584 word separator characters (list of strings) | 557 word separator characters (list of strings) |
| 585 </dd> | 558 </dd> |
| 586 </dl> | 559 </dl> |
| 587 <a NAME="DbAPIs.close" ID="DbAPIs.close"></a> | 560 <a NAME="DbAPIs.close" ID="DbAPIs.close"></a> |
| 611 | 584 |
| 612 <p> | 585 <p> |
| 613 Public method to get a list of API files loaded into the database. | 586 Public method to get a list of API files loaded into the database. |
| 614 </p> | 587 </p> |
| 615 <dl> | 588 <dl> |
| 616 <dt>Returns:</dt> | 589 <dt>Return:</dt> |
| 617 <dd> | 590 <dd> |
| 618 list of API filenames (list of strings) | 591 list of API filenames (list of strings) |
| 619 </dd> | 592 </dd> |
| 620 </dl> | 593 </dl> |
| 621 <a NAME="DbAPIs.getCalltips" ID="DbAPIs.getCalltips"></a> | 594 <a NAME="DbAPIs.getCalltips" ID="DbAPIs.getCalltips"></a> |
| 654 flag indicating to follow the hierarchy of | 627 flag indicating to follow the hierarchy of |
| 655 base classes (boolean) | 628 base classes (boolean) |
| 656 </dd> | 629 </dd> |
| 657 </dl> | 630 </dl> |
| 658 <dl> | 631 <dl> |
| 659 <dt>Returns:</dt> | 632 <dt>Return:</dt> |
| 660 <dd> | 633 <dd> |
| 661 list of calltips (list of string) | 634 list of calltips (list of string) |
| 662 </dd> | 635 </dd> |
| 663 </dl> | 636 </dl> |
| 664 <a NAME="DbAPIs.getCompletions" ID="DbAPIs.getCompletions"></a> | 637 <a NAME="DbAPIs.getCompletions" ID="DbAPIs.getCompletions"></a> |
| 685 flag indicating to follow the hierarchy of | 658 flag indicating to follow the hierarchy of |
| 686 base classes (boolean) | 659 base classes (boolean) |
| 687 </dd> | 660 </dd> |
| 688 </dl> | 661 </dl> |
| 689 <dl> | 662 <dl> |
| 690 <dt>Returns:</dt> | 663 <dt>Return:</dt> |
| 691 <dd> | 664 <dd> |
| 692 list of dictionaries with possible completions | 665 list of dictionaries with possible completions |
| 693 (key 'completion' contains the completion (string), | 666 (key 'completion' contains the completion (string), |
| 694 key 'context' contains the context (string) and | 667 key 'context' contains the context (string) and |
| 695 key 'pictureId' contains the ID of the icon to be shown (string)) | 668 key 'pictureId' contains the ID of the icon to be shown (string)) |
| 701 | 674 |
| 702 <p> | 675 <p> |
| 703 Public method to return a reference to our lexer object. | 676 Public method to return a reference to our lexer object. |
| 704 </p> | 677 </p> |
| 705 <dl> | 678 <dl> |
| 706 <dt>Returns:</dt> | 679 <dt>Return:</dt> |
| 707 <dd> | 680 <dd> |
| 708 reference to the lexer object (QScintilla.Lexers.Lexer) | 681 reference to the lexer object (QScintilla.Lexers.Lexer) |
| 709 </dd> | 682 </dd> |
| 710 </dl> | 683 </dl> |
| 711 <a NAME="DbAPIs.prepareAPIs" ID="DbAPIs.prepareAPIs"></a> | 684 <a NAME="DbAPIs.prepareAPIs" ID="DbAPIs.prepareAPIs"></a> |
| 859 <dd> | 832 <dd> |
| 860 language of the APIs object (string) | 833 language of the APIs object (string) |
| 861 </dd> | 834 </dd> |
| 862 </dl> | 835 </dl> |
| 863 <dl> | 836 <dl> |
| 864 <dt>Returns:</dt> | 837 <dt>Return:</dt> |
| 865 <dd> | 838 <dd> |
| 866 word separator characters (list of strings) | 839 word separator characters (list of strings) |
| 867 </dd> | 840 </dd> |
| 868 </dl> | 841 </dl> |
| 869 <a NAME="DbAPIsWorker.__classesAttributesApi" ID="DbAPIsWorker.__classesAttributesApi"></a> | 842 <a NAME="DbAPIsWorker.__classesAttributesApi" ID="DbAPIsWorker.__classesAttributesApi"></a> |
| 879 <dd> | 852 <dd> |
| 880 module object to get the info from (Module) | 853 module object to get the info from (Module) |
| 881 </dd> | 854 </dd> |
| 882 </dl> | 855 </dl> |
| 883 <dl> | 856 <dl> |
| 884 <dt>Returns:</dt> | 857 <dt>Return:</dt> |
| 885 <dd> | 858 <dd> |
| 886 API information (list of strings) | 859 API information (list of strings) |
| 887 </dd> | 860 </dd> |
| 888 </dl> | 861 </dl> |
| 889 <a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a> | 862 <a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a> |
| 906 | 879 |
| 907 <p> | 880 <p> |
| 908 Private method to get a list of API files loaded into the database. | 881 Private method to get a list of API files loaded into the database. |
| 909 </p> | 882 </p> |
| 910 <dl> | 883 <dl> |
| 911 <dt>Returns:</dt> | 884 <dt>Return:</dt> |
| 912 <dd> | 885 <dd> |
| 913 list of API filenames | 886 list of API filenames |
| 914 </dd> | 887 </dd> |
| 915 </dl> | 888 </dl> |
| 916 <dl> | 889 <dl> |
