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
- branch
- eric7
- changeset 180
- 89ff060ef0d9
- parent 177
- 25cb41783971
- child 193
- e1b0e65903d9
equal
deleted
inserted
replaced
| 179:62d9dc4eedd5 | 180:89ff060ef0d9 |
|---|---|
| 115 <p> | 115 <p> |
| 116 Constructor | 116 Constructor |
| 117 </p> | 117 </p> |
| 118 <dl> | 118 <dl> |
| 119 | 119 |
| 120 <dt><i>mainWindow</i></dt> | 120 <dt><i>mainWindow</i> (QMainWindow)</dt> |
| 121 <dd> | 121 <dd> |
| 122 reference to the main eric6 window (QMainWindow) | 122 reference to the main eric7 window |
| 123 </dd> | 123 </dd> |
| 124 <dt><i>parent</i></dt> | 124 <dt><i>parent</i> (QObject)</dt> |
| 125 <dd> | 125 <dd> |
| 126 reference to the parent object (QObject) | 126 reference to the parent object |
| 127 </dd> | 127 </dd> |
| 128 </dl> | 128 </dl> |
| 129 <a NAME="APIsManager.__apiPreparationStatus" ID="APIsManager.__apiPreparationStatus"></a> | 129 <a NAME="APIsManager.__apiPreparationStatus" ID="APIsManager.__apiPreparationStatus"></a> |
| 130 <h4>APIsManager.__apiPreparationStatus</h4> | 130 <h4>APIsManager.__apiPreparationStatus</h4> |
| 131 <b>__apiPreparationStatus</b>(<i>language, status, filename</i>) | 131 <b>__apiPreparationStatus</b>(<i>language, status, filename</i>) |
| 133 <p> | 133 <p> |
| 134 Private slot handling the preparation status signal of an API object. | 134 Private slot handling the preparation status signal of an API object. |
| 135 </p> | 135 </p> |
| 136 <dl> | 136 <dl> |
| 137 | 137 |
| 138 <dt><i>language</i></dt> | 138 <dt><i>language</i> (str)</dt> |
| 139 <dd> | 139 <dd> |
| 140 language of the API (string) | 140 language of the API |
| 141 </dd> | 141 </dd> |
| 142 <dt><i>status</i></dt> | 142 <dt><i>status</i> (int)</dt> |
| 143 <dd> | 143 <dd> |
| 144 preparation status (integer, one of WorkerStatus...) | 144 preparation status (one of WorkerStatus...) |
| 145 </dd> | 145 </dd> |
| 146 <dt><i>filename</i></dt> | 146 <dt><i>filename</i> (str)</dt> |
| 147 <dd> | 147 <dd> |
| 148 name of the file being processed (string) | 148 name of the file being processed |
| 149 </dd> | 149 </dd> |
| 150 </dl> | 150 </dl> |
| 151 <a NAME="APIsManager.__showMessage" ID="APIsManager.__showMessage"></a> | 151 <a NAME="APIsManager.__showMessage" ID="APIsManager.__showMessage"></a> |
| 152 <h4>APIsManager.__showMessage</h4> | 152 <h4>APIsManager.__showMessage</h4> |
| 153 <b>__showMessage</b>(<i>msg</i>) | 153 <b>__showMessage</b>(<i>msg</i>) |
| 155 <p> | 155 <p> |
| 156 Private message to show a message in the main windows status bar. | 156 Private message to show a message in the main windows status bar. |
| 157 </p> | 157 </p> |
| 158 <dl> | 158 <dl> |
| 159 | 159 |
| 160 <dt><i>msg</i></dt> | 160 <dt><i>msg</i> (str)</dt> |
| 161 <dd> | 161 <dd> |
| 162 message to be shown (string) | 162 message to be shown |
| 163 </dd> | 163 </dd> |
| 164 </dl> | 164 </dl> |
| 165 <a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a> | 165 <a NAME="APIsManager.deactivate" ID="APIsManager.deactivate"></a> |
| 166 <h4>APIsManager.deactivate</h4> | 166 <h4>APIsManager.deactivate</h4> |
| 167 <b>deactivate</b>(<i></i>) | 167 <b>deactivate</b>(<i></i>) |
| 385 Private method to determine, if the given string contains enough | 385 Private method to determine, if the given string contains enough |
| 386 commas. | 386 commas. |
| 387 </p> | 387 </p> |
| 388 <dl> | 388 <dl> |
| 389 | 389 |
| 390 <dt><i>s</i></dt> | 390 <dt><i>s</i> (str)</dt> |
| 391 <dd> | 391 <dd> |
| 392 string to check (string) | 392 string to check |
| 393 </dd> | 393 </dd> |
| 394 <dt><i>commas</i></dt> | 394 <dt><i>commas</i> (int)</dt> |
| 395 <dd> | 395 <dd> |
| 396 number of commas to check for (integer) | 396 number of commas to check for |
| 397 </dd> | 397 </dd> |
| 398 </dl> | 398 </dl> |
| 399 <dl> | 399 <dl> |
| 400 <dt>Return:</dt> | 400 <dt>Return:</dt> |
| 401 <dd> | 401 <dd> |
| 402 flag indicating, that there are enough commas (boolean) | 402 flag indicating, that there are enough commas |
| 403 </dd> | |
| 404 </dl> | |
| 405 <dl> | |
| 406 <dt>Return Type:</dt> | |
| 407 <dd> | |
| 408 bool | |
| 403 </dd> | 409 </dd> |
| 404 </dl> | 410 </dl> |
| 405 <a NAME="DbAPIs.__getProjectFormSources" ID="DbAPIs.__getProjectFormSources"></a> | 411 <a NAME="DbAPIs.__getProjectFormSources" ID="DbAPIs.__getProjectFormSources"></a> |
| 406 <h4>DbAPIs.__getProjectFormSources</h4> | 412 <h4>DbAPIs.__getProjectFormSources</h4> |
| 407 <b>__getProjectFormSources</b>(<i>normalized=False</i>) | 413 <b>__getProjectFormSources</b>(<i>normalized=False</i>) |
| 409 <p> | 415 <p> |
| 410 Private method to get the source files for the project forms. | 416 Private method to get the source files for the project forms. |
| 411 </p> | 417 </p> |
| 412 <dl> | 418 <dl> |
| 413 | 419 |
| 414 <dt><i>normalized=</i></dt> | 420 <dt><i>normalized</i> (bool)</dt> |
| 415 <dd> | 421 <dd> |
| 416 flag indicating a normalized filename is wanted | 422 flag indicating a normalized filename is wanted |
| 417 (boolean) | 423 </dd> |
| 418 </dd> | 424 </dl> |
| 419 </dl> | 425 <dl> |
| 420 <dl> | 426 <dt>Return:</dt> |
| 421 <dt>Return:</dt> | 427 <dd> |
| 422 <dd> | 428 list of project form sources |
| 423 list of project form sources (list of strings) | 429 </dd> |
| 430 </dl> | |
| 431 <dl> | |
| 432 <dt>Return Type:</dt> | |
| 433 <dd> | |
| 434 list of str | |
| 424 </dd> | 435 </dd> |
| 425 </dl> | 436 </dl> |
| 426 <a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a> | 437 <a NAME="DbAPIs.__initAsLanguage" ID="DbAPIs.__initAsLanguage"></a> |
| 427 <h4>DbAPIs.__initAsLanguage</h4> | 438 <h4>DbAPIs.__initAsLanguage</h4> |
| 428 <b>__initAsLanguage</b>(<i></i>) | 439 <b>__initAsLanguage</b>(<i></i>) |
| 445 Private method to check, if the database has been prepared. | 456 Private method to check, if the database has been prepared. |
| 446 </p> | 457 </p> |
| 447 <dl> | 458 <dl> |
| 448 <dt>Return:</dt> | 459 <dt>Return:</dt> |
| 449 <dd> | 460 <dd> |
| 450 flag indicating the prepared status (boolean) | 461 flag indicating the prepared status |
| 462 </dd> | |
| 463 </dl> | |
| 464 <dl> | |
| 465 <dt>Return Type:</dt> | |
| 466 <dd> | |
| 467 bool | |
| 451 </dd> | 468 </dd> |
| 452 </dl> | 469 </dl> |
| 453 <a NAME="DbAPIs.__openAPIs" ID="DbAPIs.__openAPIs"></a> | 470 <a NAME="DbAPIs.__openAPIs" ID="DbAPIs.__openAPIs"></a> |
| 454 <h4>DbAPIs.__openAPIs</h4> | 471 <h4>DbAPIs.__openAPIs</h4> |
| 455 <b>__openAPIs</b>(<i></i>) | 472 <b>__openAPIs</b>(<i></i>) |
| 465 Private method to open the API database. | 482 Private method to open the API database. |
| 466 </p> | 483 </p> |
| 467 <dl> | 484 <dl> |
| 468 <dt>Return:</dt> | 485 <dt>Return:</dt> |
| 469 <dd> | 486 <dd> |
| 470 flag indicating the database status (boolean) | 487 flag indicating the database status |
| 488 </dd> | |
| 489 </dl> | |
| 490 <dl> | |
| 491 <dt>Return Type:</dt> | |
| 492 <dd> | |
| 493 bool | |
| 471 </dd> | 494 </dd> |
| 472 </dl> | 495 </dl> |
| 473 <a NAME="DbAPIs.__processQueue" ID="DbAPIs.__processQueue"></a> | 496 <a NAME="DbAPIs.__processQueue" ID="DbAPIs.__processQueue"></a> |
| 474 <h4>DbAPIs.__processQueue</h4> | 497 <h4>DbAPIs.__processQueue</h4> |
| 475 <b>__processQueue</b>(<i></i>) | 498 <b>__processQueue</b>(<i></i>) |
| 485 Private slot handling the processing signal of the API preparation | 508 Private slot handling the processing signal of the API preparation |
| 486 thread. | 509 thread. |
| 487 </p> | 510 </p> |
| 488 <dl> | 511 <dl> |
| 489 | 512 |
| 490 <dt><i>status</i></dt> | 513 <dt><i>status</i> (int)</dt> |
| 491 <dd> | 514 <dd> |
| 492 preparation status (integer, one of WorkerStatus...) | 515 preparation status (one of WorkerStatus...) |
| 493 </dd> | 516 </dd> |
| 494 <dt><i>filename</i></dt> | 517 <dt><i>filename</i> (str)</dt> |
| 495 <dd> | 518 <dd> |
| 496 name of the file being processed (string) | 519 name of the file being processed |
| 497 </dd> | 520 </dd> |
| 498 </dl> | 521 </dl> |
| 499 <a NAME="DbAPIs.__projectChanged" ID="DbAPIs.__projectChanged"></a> | 522 <a NAME="DbAPIs.__projectChanged" ID="DbAPIs.__projectChanged"></a> |
| 500 <h4>DbAPIs.__projectChanged</h4> | 523 <h4>DbAPIs.__projectChanged</h4> |
| 501 <b>__projectChanged</b>(<i></i>) | 524 <b>__projectChanged</b>(<i></i>) |
| 517 <p> | 540 <p> |
| 518 Private slot to handle the projectFormCompiled signal. | 541 Private slot to handle the projectFormCompiled signal. |
| 519 </p> | 542 </p> |
| 520 <dl> | 543 <dl> |
| 521 | 544 |
| 522 <dt><i>filename</i></dt> | 545 <dt><i>filename</i> (str)</dt> |
| 523 <dd> | 546 <dd> |
| 524 name of the form file that was compiled (string) | 547 name of the form file that was compiled |
| 525 </dd> | 548 </dd> |
| 526 </dl> | 549 </dl> |
| 527 <a NAME="DbAPIs.__projectOpened" ID="DbAPIs.__projectOpened"></a> | 550 <a NAME="DbAPIs.__projectOpened" ID="DbAPIs.__projectOpened"></a> |
| 528 <h4>DbAPIs.__projectOpened</h4> | 551 <h4>DbAPIs.__projectOpened</h4> |
| 529 <b>__projectOpened</b>(<i></i>) | 552 <b>__projectOpened</b>(<i></i>) |
| 539 Protected method to determine the name of the database file. | 562 Protected method to determine the name of the database file. |
| 540 </p> | 563 </p> |
| 541 <dl> | 564 <dl> |
| 542 <dt>Return:</dt> | 565 <dt>Return:</dt> |
| 543 <dd> | 566 <dd> |
| 544 name of the database file (string) | 567 name of the database file |
| 568 </dd> | |
| 569 </dl> | |
| 570 <dl> | |
| 571 <dt>Return Type:</dt> | |
| 572 <dd> | |
| 573 str | |
| 545 </dd> | 574 </dd> |
| 546 </dl> | 575 </dl> |
| 547 <a NAME="DbAPIs.autoCompletionWordSeparators" ID="DbAPIs.autoCompletionWordSeparators"></a> | 576 <a NAME="DbAPIs.autoCompletionWordSeparators" ID="DbAPIs.autoCompletionWordSeparators"></a> |
| 548 <h4>DbAPIs.autoCompletionWordSeparators</h4> | 577 <h4>DbAPIs.autoCompletionWordSeparators</h4> |
| 549 <b>autoCompletionWordSeparators</b>(<i></i>) | 578 <b>autoCompletionWordSeparators</b>(<i></i>) |
| 552 Public method to get the word separator characters. | 581 Public method to get the word separator characters. |
| 553 </p> | 582 </p> |
| 554 <dl> | 583 <dl> |
| 555 <dt>Return:</dt> | 584 <dt>Return:</dt> |
| 556 <dd> | 585 <dd> |
| 557 word separator characters (list of strings) | 586 word separator characters |
| 587 </dd> | |
| 588 </dl> | |
| 589 <dl> | |
| 590 <dt>Return Type:</dt> | |
| 591 <dd> | |
| 592 list of str | |
| 558 </dd> | 593 </dd> |
| 559 </dl> | 594 </dl> |
| 560 <a NAME="DbAPIs.close" ID="DbAPIs.close"></a> | 595 <a NAME="DbAPIs.close" ID="DbAPIs.close"></a> |
| 561 <h4>DbAPIs.close</h4> | 596 <h4>DbAPIs.close</h4> |
| 562 <b>close</b>(<i></i>) | 597 <b>close</b>(<i></i>) |
| 571 <p> | 606 <p> |
| 572 Public slot to handle the editorSaved signal. | 607 Public slot to handle the editorSaved signal. |
| 573 </p> | 608 </p> |
| 574 <dl> | 609 <dl> |
| 575 | 610 |
| 576 <dt><i>filename</i></dt> | 611 <dt><i>filename</i> (str)</dt> |
| 577 <dd> | 612 <dd> |
| 578 name of the file that was saved (string) | 613 name of the file that was saved |
| 579 </dd> | 614 </dd> |
| 580 </dl> | 615 </dl> |
| 581 <a NAME="DbAPIs.getApiFiles" ID="DbAPIs.getApiFiles"></a> | 616 <a NAME="DbAPIs.getApiFiles" ID="DbAPIs.getApiFiles"></a> |
| 582 <h4>DbAPIs.getApiFiles</h4> | 617 <h4>DbAPIs.getApiFiles</h4> |
| 583 <b>getApiFiles</b>(<i></i>) | 618 <b>getApiFiles</b>(<i></i>) |
| 586 Public method to get a list of API files loaded into the database. | 621 Public method to get a list of API files loaded into the database. |
| 587 </p> | 622 </p> |
| 588 <dl> | 623 <dl> |
| 589 <dt>Return:</dt> | 624 <dt>Return:</dt> |
| 590 <dd> | 625 <dd> |
| 591 list of API filenames (list of strings) | 626 list of API filenames |
| 627 </dd> | |
| 628 </dl> | |
| 629 <dl> | |
| 630 <dt>Return Type:</dt> | |
| 631 <dd> | |
| 632 list of str | |
| 592 </dd> | 633 </dd> |
| 593 </dl> | 634 </dl> |
| 594 <a NAME="DbAPIs.getCalltips" ID="DbAPIs.getCalltips"></a> | 635 <a NAME="DbAPIs.getCalltips" ID="DbAPIs.getCalltips"></a> |
| 595 <h4>DbAPIs.getCalltips</h4> | 636 <h4>DbAPIs.getCalltips</h4> |
| 596 <b>getCalltips</b>(<i>acWord, commas, context=None, fullContext=None, showContext=True, followHierarchy=False</i>) | 637 <b>getCalltips</b>(<i>acWord, commas, context=None, fullContext=None, showContext=True, followHierarchy=False</i>) |
| 598 <p> | 639 <p> |
| 599 Public method to determine the calltips. | 640 Public method to determine the calltips. |
| 600 </p> | 641 </p> |
| 601 <dl> | 642 <dl> |
| 602 | 643 |
| 603 <dt><i>acWord</i></dt> | 644 <dt><i>acWord</i> (str)</dt> |
| 604 <dd> | 645 <dd> |
| 605 function to get calltips for (string) | 646 function to get calltips for |
| 606 </dd> | 647 </dd> |
| 607 <dt><i>commas</i></dt> | 648 <dt><i>commas</i> (int)</dt> |
| 608 <dd> | 649 <dd> |
| 609 minimum number of commas contained in the calltip | 650 minimum number of commas contained in the calltip |
| 610 (integer) | 651 </dd> |
| 611 </dd> | 652 <dt><i>context</i> (str)</dt> |
| 612 <dt><i>context</i></dt> | 653 <dd> |
| 613 <dd> | 654 string giving the context (e.g. classname) |
| 614 string giving the context (e.g. classname) (string) | 655 </dd> |
| 615 </dd> | 656 <dt><i>fullContext</i> (str)</dt> |
| 616 <dt><i>fullContext</i></dt> | 657 <dd> |
| 617 <dd> | 658 string giving the full context |
| 618 string giving the full context (string) | 659 </dd> |
| 619 </dd> | 660 <dt><i>showContext</i> (bool)</dt> |
| 620 <dt><i>showContext</i></dt> | |
| 621 <dd> | 661 <dd> |
| 622 flag indicating to show the calltip context | 662 flag indicating to show the calltip context |
| 623 (boolean) | 663 </dd> |
| 624 </dd> | 664 <dt><i>followHierarchy</i> (bool)</dt> |
| 625 <dt><i>followHierarchy=</i></dt> | |
| 626 <dd> | 665 <dd> |
| 627 flag indicating to follow the hierarchy of | 666 flag indicating to follow the hierarchy of |
| 628 base classes (boolean) | 667 base classes |
| 629 </dd> | 668 </dd> |
| 630 </dl> | 669 </dl> |
| 631 <dl> | 670 <dl> |
| 632 <dt>Return:</dt> | 671 <dt>Return:</dt> |
| 633 <dd> | 672 <dd> |
| 634 list of calltips (list of string) | 673 list of calltips |
| 674 </dd> | |
| 675 </dl> | |
| 676 <dl> | |
| 677 <dt>Return Type:</dt> | |
| 678 <dd> | |
| 679 list of str | |
| 635 </dd> | 680 </dd> |
| 636 </dl> | 681 </dl> |
| 637 <a NAME="DbAPIs.getCompletions" ID="DbAPIs.getCompletions"></a> | 682 <a NAME="DbAPIs.getCompletions" ID="DbAPIs.getCompletions"></a> |
| 638 <h4>DbAPIs.getCompletions</h4> | 683 <h4>DbAPIs.getCompletions</h4> |
| 639 <b>getCompletions</b>(<i>start=None, context=None, followHierarchy=False</i>) | 684 <b>getCompletions</b>(<i>start=None, context=None, followHierarchy=False</i>) |
| 641 <p> | 686 <p> |
| 642 Public method to determine the possible completions. | 687 Public method to determine the possible completions. |
| 643 </p> | 688 </p> |
| 644 <dl> | 689 <dl> |
| 645 | 690 |
| 646 <dt><i>start=</i></dt> | 691 <dt><i>start</i> (str)</dt> |
| 647 <dd> | 692 <dd> |
| 648 string giving the start of the word to be | 693 string giving the start of the word to be |
| 649 completed (string) | 694 completed |
| 650 </dd> | 695 </dd> |
| 651 <dt><i>context=</i></dt> | 696 <dt><i>context</i> (str)</dt> |
| 652 <dd> | 697 <dd> |
| 653 string giving the context (e.g. classname) | 698 string giving the context (e.g. classname) |
| 654 to be completed (string) | 699 to be completed |
| 655 </dd> | 700 </dd> |
| 656 <dt><i>followHierarchy=</i></dt> | 701 <dt><i>followHierarchy</i> (bool)</dt> |
| 657 <dd> | 702 <dd> |
| 658 flag indicating to follow the hierarchy of | 703 flag indicating to follow the hierarchy of |
| 659 base classes (boolean) | 704 base classes |
| 660 </dd> | 705 </dd> |
| 661 </dl> | 706 </dl> |
| 662 <dl> | 707 <dl> |
| 663 <dt>Return:</dt> | 708 <dt>Return:</dt> |
| 664 <dd> | 709 <dd> |
| 665 list of dictionaries with possible completions | 710 list of dictionaries with possible completions |
| 666 (key 'completion' contains the completion (string), | 711 (key 'completion' contains the completion, |
| 667 key 'context' contains the context (string) and | 712 key 'context' contains the context and |
| 668 key 'pictureId' contains the ID of the icon to be shown (string)) | 713 key 'pictureId' contains the ID of the icon to be shown) |
| 714 </dd> | |
| 715 </dl> | |
| 716 <dl> | |
| 717 <dt>Return Type:</dt> | |
| 718 <dd> | |
| 719 list of dict | |
| 669 </dd> | 720 </dd> |
| 670 </dl> | 721 </dl> |
| 671 <a NAME="DbAPIs.getLexer" ID="DbAPIs.getLexer"></a> | 722 <a NAME="DbAPIs.getLexer" ID="DbAPIs.getLexer"></a> |
| 672 <h4>DbAPIs.getLexer</h4> | 723 <h4>DbAPIs.getLexer</h4> |
| 673 <b>getLexer</b>(<i></i>) | 724 <b>getLexer</b>(<i></i>) |
| 676 Public method to return a reference to our lexer object. | 727 Public method to return a reference to our lexer object. |
| 677 </p> | 728 </p> |
| 678 <dl> | 729 <dl> |
| 679 <dt>Return:</dt> | 730 <dt>Return:</dt> |
| 680 <dd> | 731 <dd> |
| 681 reference to the lexer object (QScintilla.Lexers.Lexer) | 732 reference to the lexer object |
| 733 </dd> | |
| 734 </dl> | |
| 735 <dl> | |
| 736 <dt>Return Type:</dt> | |
| 737 <dd> | |
| 738 Lexer | |
| 682 </dd> | 739 </dd> |
| 683 </dl> | 740 </dl> |
| 684 <a NAME="DbAPIs.prepareAPIs" ID="DbAPIs.prepareAPIs"></a> | 741 <a NAME="DbAPIs.prepareAPIs" ID="DbAPIs.prepareAPIs"></a> |
| 685 <h4>DbAPIs.prepareAPIs</h4> | 742 <h4>DbAPIs.prepareAPIs</h4> |
| 686 <b>prepareAPIs</b>(<i>rawList=None</i>) | 743 <b>prepareAPIs</b>(<i>rawList=None</i>) |
| 688 <p> | 745 <p> |
| 689 Public method to prepare the APIs if neccessary. | 746 Public method to prepare the APIs if neccessary. |
| 690 </p> | 747 </p> |
| 691 <dl> | 748 <dl> |
| 692 | 749 |
| 693 <dt><i>rawList=</i></dt> | 750 <dt><i>rawList</i> (list of str)</dt> |
| 694 <dd> | 751 <dd> |
| 695 list of raw API files (list of strings) | 752 list of raw API files |
| 696 </dd> | 753 </dd> |
| 697 </dl> | 754 </dl> |
| 698 <div align="right"><a href="#top">Up</a></div> | 755 <div align="right"><a href="#top">Up</a></div> |
| 699 <hr /> | 756 <hr /> |
| 700 <hr /> | 757 <hr /> |
| 826 <p> | 883 <p> |
| 827 Private method to get the word separator characters for a language. | 884 Private method to get the word separator characters for a language. |
| 828 </p> | 885 </p> |
| 829 <dl> | 886 <dl> |
| 830 | 887 |
| 831 <dt><i>language</i></dt> | 888 <dt><i>language</i> (str)</dt> |
| 832 <dd> | 889 <dd> |
| 833 language of the APIs object (string) | 890 language of the APIs object |
| 834 </dd> | 891 </dd> |
| 835 </dl> | 892 </dl> |
| 836 <dl> | 893 <dl> |
| 837 <dt>Return:</dt> | 894 <dt>Return:</dt> |
| 838 <dd> | 895 <dd> |
| 839 word separator characters (list of strings) | 896 word separator characters |
| 897 </dd> | |
| 898 </dl> | |
| 899 <dl> | |
| 900 <dt>Return Type:</dt> | |
| 901 <dd> | |
| 902 list of str | |
| 840 </dd> | 903 </dd> |
| 841 </dl> | 904 </dl> |
| 842 <a NAME="DbAPIsWorker.__classesAttributesApi" ID="DbAPIsWorker.__classesAttributesApi"></a> | 905 <a NAME="DbAPIsWorker.__classesAttributesApi" ID="DbAPIsWorker.__classesAttributesApi"></a> |
| 843 <h4>DbAPIsWorker.__classesAttributesApi</h4> | 906 <h4>DbAPIsWorker.__classesAttributesApi</h4> |
| 844 <b>__classesAttributesApi</b>(<i>module</i>) | 907 <b>__classesAttributesApi</b>(<i>module</i>) |
| 846 <p> | 909 <p> |
| 847 Private method to generate class api section for class attributes. | 910 Private method to generate class api section for class attributes. |
| 848 </p> | 911 </p> |
| 849 <dl> | 912 <dl> |
| 850 | 913 |
| 851 <dt><i>module</i></dt> | 914 <dt><i>module</i> (Module)</dt> |
| 852 <dd> | 915 <dd> |
| 853 module object to get the info from (Module) | 916 module object to get the info from |
| 854 </dd> | 917 </dd> |
| 855 </dl> | 918 </dl> |
| 856 <dl> | 919 <dl> |
| 857 <dt>Return:</dt> | 920 <dt>Return:</dt> |
| 858 <dd> | 921 <dd> |
| 859 API information (list of strings) | 922 API information |
| 923 </dd> | |
| 924 </dl> | |
| 925 <dl> | |
| 926 <dt>Return Type:</dt> | |
| 927 <dd> | |
| 928 list of str | |
| 860 </dd> | 929 </dd> |
| 861 </dl> | 930 </dl> |
| 862 <a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a> | 931 <a NAME="DbAPIsWorker.__deleteApiFile" ID="DbAPIsWorker.__deleteApiFile"></a> |
| 863 <h4>DbAPIsWorker.__deleteApiFile</h4> | 932 <h4>DbAPIsWorker.__deleteApiFile</h4> |
| 864 <b>__deleteApiFile</b>(<i>apiFile</i>) | 933 <b>__deleteApiFile</b>(<i>apiFile</i>) |
| 866 <p> | 935 <p> |
| 867 Private method to delete all references to an api file. | 936 Private method to delete all references to an api file. |
| 868 </p> | 937 </p> |
| 869 <dl> | 938 <dl> |
| 870 | 939 |
| 871 <dt><i>apiFile</i></dt> | 940 <dt><i>apiFile</i> (str)</dt> |
| 872 <dd> | 941 <dd> |
| 873 filename of the raw API file (string) | 942 filename of the raw API file |
| 874 </dd> | 943 </dd> |
| 875 </dl> | 944 </dl> |
| 876 <a NAME="DbAPIsWorker.__getApiFiles" ID="DbAPIsWorker.__getApiFiles"></a> | 945 <a NAME="DbAPIsWorker.__getApiFiles" ID="DbAPIsWorker.__getApiFiles"></a> |
| 877 <h4>DbAPIsWorker.__getApiFiles</h4> | 946 <h4>DbAPIsWorker.__getApiFiles</h4> |
| 878 <b>__getApiFiles</b>(<i></i>) | 947 <b>__getApiFiles</b>(<i></i>) |
| 899 <p> | 968 <p> |
| 900 Private method to read a raw API file into the database. | 969 Private method to read a raw API file into the database. |
| 901 </p> | 970 </p> |
| 902 <dl> | 971 <dl> |
| 903 | 972 |
| 904 <dt><i>apiFile</i></dt> | 973 <dt><i>apiFile</i> (str)</dt> |
| 905 <dd> | 974 <dd> |
| 906 filename of the raw API file (string) | 975 filename of the raw API file |
| 907 </dd> | 976 </dd> |
| 908 </dl> | 977 </dl> |
| 909 <a NAME="DbAPIsWorker.__loadApiFileIfNewer" ID="DbAPIsWorker.__loadApiFileIfNewer"></a> | 978 <a NAME="DbAPIsWorker.__loadApiFileIfNewer" ID="DbAPIsWorker.__loadApiFileIfNewer"></a> |
| 910 <h4>DbAPIsWorker.__loadApiFileIfNewer</h4> | 979 <h4>DbAPIsWorker.__loadApiFileIfNewer</h4> |
| 911 <b>__loadApiFileIfNewer</b>(<i>apiFile</i>) | 980 <b>__loadApiFileIfNewer</b>(<i>apiFile</i>) |
| 914 Private method to load an API file, if it is newer than the one read | 983 Private method to load an API file, if it is newer than the one read |
| 915 into the database. | 984 into the database. |
| 916 </p> | 985 </p> |
| 917 <dl> | 986 <dl> |
| 918 | 987 |
| 919 <dt><i>apiFile</i></dt> | 988 <dt><i>apiFile</i> (str)</dt> |
| 920 <dd> | 989 <dd> |
| 921 filename of the raw API file (string) | 990 filename of the raw API file |
| 922 </dd> | 991 </dd> |
| 923 </dl> | 992 </dl> |
| 924 <a NAME="DbAPIsWorker.__storeApis" ID="DbAPIsWorker.__storeApis"></a> | 993 <a NAME="DbAPIsWorker.__storeApis" ID="DbAPIsWorker.__storeApis"></a> |
| 925 <h4>DbAPIsWorker.__storeApis</h4> | 994 <h4>DbAPIsWorker.__storeApis</h4> |
| 926 <b>__storeApis</b>(<i>apis, bases, apiFile, language</i>) | 995 <b>__storeApis</b>(<i>apis, bases, apiFile, language</i>) |
| 928 <p> | 997 <p> |
| 929 Private method to put the API entries into the database. | 998 Private method to put the API entries into the database. |
| 930 </p> | 999 </p> |
| 931 <dl> | 1000 <dl> |
| 932 | 1001 |
| 933 <dt><i>apis</i></dt> | 1002 <dt><i>apis</i> (list of str)</dt> |
| 934 <dd> | 1003 <dd> |
| 935 list of api entries (list of strings) | 1004 list of api entries |
| 936 </dd> | 1005 </dd> |
| 937 <dt><i>bases</i></dt> | 1006 <dt><i>bases</i> (list of str)</dt> |
| 938 <dd> | 1007 <dd> |
| 939 list of base class entries (list of strings) | 1008 list of base class entries |
| 940 </dd> | 1009 </dd> |
| 941 <dt><i>apiFile</i></dt> | 1010 <dt><i>apiFile</i> (str)</dt> |
| 942 <dd> | 1011 <dd> |
| 943 filename of the file read to get the APIs (string) | 1012 filename of the file read to get the APIs |
| 944 </dd> | 1013 </dd> |
| 945 <dt><i>language</i></dt> | 1014 <dt><i>language</i> (str)</dt> |
| 946 <dd> | 1015 <dd> |
| 947 programming language of the file of the APIs (string) | 1016 programming language of the file of the APIs |
| 948 </dd> | 1017 </dd> |
| 949 </dl> | 1018 </dl> |
| 950 <a NAME="DbAPIsWorker.__storeFileInfoOnly" ID="DbAPIsWorker.__storeFileInfoOnly"></a> | 1019 <a NAME="DbAPIsWorker.__storeFileInfoOnly" ID="DbAPIsWorker.__storeFileInfoOnly"></a> |
| 951 <h4>DbAPIsWorker.__storeFileInfoOnly</h4> | 1020 <h4>DbAPIsWorker.__storeFileInfoOnly</h4> |
| 952 <b>__storeFileInfoOnly</b>(<i>apiFile</i>) | 1021 <b>__storeFileInfoOnly</b>(<i>apiFile</i>) |
| 958 Doing this avoids rereading the file whenever the API is initialized | 1027 Doing this avoids rereading the file whenever the API is initialized |
| 959 in case the given file doesn't contain API data. | 1028 in case the given file doesn't contain API data. |
| 960 </p> | 1029 </p> |
| 961 <dl> | 1030 <dl> |
| 962 | 1031 |
| 963 <dt><i>apiFile</i></dt> | 1032 <dt><i>apiFile</i> (str)</dt> |
| 964 <dd> | 1033 <dd> |
| 965 file name of the API file (string) | 1034 file name of the API file |
| 966 </dd> | 1035 </dd> |
| 967 </dl> | 1036 </dl> |
| 968 <a NAME="DbAPIsWorker.abort" ID="DbAPIsWorker.abort"></a> | 1037 <a NAME="DbAPIsWorker.abort" ID="DbAPIsWorker.abort"></a> |
| 969 <h4>DbAPIsWorker.abort</h4> | 1038 <h4>DbAPIsWorker.abort</h4> |
| 970 <b>abort</b>(<i></i>) | 1039 <b>abort</b>(<i></i>) |
