Mercurial Repositories > Pyramid Project / file comparison
comparison: ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html
ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.Project.html
- changeset 144
- 5c3684ee818e
- parent 138
- 72ebb74aa42d
- child 147
- eb28b4b6f7f5
equal
deleted
inserted
replaced
| 143:4ef44e854b39 | 144:5c3684ee818e |
|---|---|
| 349 <p> | 349 <p> |
| 350 Private method to determine the relative path of all Pyramid | 350 Private method to determine the relative path of all Pyramid |
| 351 projects (= top level dirs). | 351 projects (= top level dirs). |
| 352 </p> | 352 </p> |
| 353 <dl> | 353 <dl> |
| 354 <dt>Returns:</dt> | 354 <dt>Return:</dt> |
| 355 <dd> | 355 <dd> |
| 356 list of projects (list of string) | 356 list of projects (list of string) |
| 357 </dd> | 357 </dd> |
| 358 </dl> | 358 </dl> |
| 359 <a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a> | 359 <a NAME="Project.__getDebugEnvironment" ID="Project.__getDebugEnvironment"></a> |
| 370 Python variant to get the debugger environment | 370 Python variant to get the debugger environment |
| 371 for (string, one of '' or 'Python3') | 371 for (string, one of '' or 'Python3') |
| 372 </dd> | 372 </dd> |
| 373 </dl> | 373 </dl> |
| 374 <dl> | 374 <dl> |
| 375 <dt>Returns:</dt> | 375 <dt>Return:</dt> |
| 376 <dd> | 376 <dd> |
| 377 path of the debugger environment (string) | 377 path of the debugger environment (string) |
| 378 </dd> | 378 </dd> |
| 379 </dl> | 379 </dl> |
| 380 <a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a> | 380 <a NAME="Project.__getExecutablePaths" ID="Project.__getExecutablePaths"></a> |
| 391 <dd> | 391 <dd> |
| 392 filename of the executable (string) | 392 filename of the executable (string) |
| 393 </dd> | 393 </dd> |
| 394 </dl> | 394 </dl> |
| 395 <dl> | 395 <dl> |
| 396 <dt>Returns:</dt> | 396 <dt>Return:</dt> |
| 397 <dd> | 397 <dd> |
| 398 list of full executable names, if the executable file is | 398 list of full executable names, if the executable file is |
| 399 accessible via the searchpath defined by the PATH environment | 399 accessible via the searchpath defined by the PATH environment |
| 400 variable, or an empty list otherwise. | 400 variable, or an empty list otherwise. |
| 401 </dd> | 401 </dd> |
| 406 | 406 |
| 407 <p> | 407 <p> |
| 408 Private method to create the path to the initialization script. | 408 Private method to create the path to the initialization script. |
| 409 </p> | 409 </p> |
| 410 <dl> | 410 <dl> |
| 411 <dt>Returns:</dt> | 411 <dt>Return:</dt> |
| 412 <dd> | 412 <dd> |
| 413 path to the initialization script (string) | 413 path to the initialization script (string) |
| 414 </dd> | 414 </dd> |
| 415 </dl> | 415 </dl> |
| 416 <a NAME="Project.__getLocale" ID="Project.__getLocale"></a> | 416 <a NAME="Project.__getLocale" ID="Project.__getLocale"></a> |
| 426 <dd> | 426 <dd> |
| 427 name of the file used for extraction (string) | 427 name of the file used for extraction (string) |
| 428 </dd> | 428 </dd> |
| 429 </dl> | 429 </dl> |
| 430 <dl> | 430 <dl> |
| 431 <dt>Returns:</dt> | 431 <dt>Return:</dt> |
| 432 <dd> | 432 <dd> |
| 433 extracted locale (string) or None | 433 extracted locale (string) or None |
| 434 </dd> | 434 </dd> |
| 435 </dl> | 435 </dl> |
| 436 <a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a> | 436 <a NAME="Project.__getVirtualEnvironment" ID="Project.__getVirtualEnvironment"></a> |
| 447 Python variant to get the virtual environment | 447 Python variant to get the virtual environment |
| 448 for (string, one of '' or 'Python3') | 448 for (string, one of '' or 'Python3') |
| 449 </dd> | 449 </dd> |
| 450 </dl> | 450 </dl> |
| 451 <dl> | 451 <dl> |
| 452 <dt>Returns:</dt> | 452 <dt>Return:</dt> |
| 453 <dd> | 453 <dd> |
| 454 path of the virtual environment (string) | 454 path of the virtual environment (string) |
| 455 </dd> | 455 </dd> |
| 456 </dl> | 456 </dl> |
| 457 <a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a> | 457 <a NAME="Project.__initializeDatabase" ID="Project.__initializeDatabase"></a> |
| 479 <dd> | 479 <dd> |
| 480 first line of the executable | 480 first line of the executable |
| 481 </dd> | 481 </dd> |
| 482 </dl> | 482 </dl> |
| 483 <dl> | 483 <dl> |
| 484 <dt>Returns:</dt> | 484 <dt>Return:</dt> |
| 485 <dd> | 485 <dd> |
| 486 flag indicating a suitable command | 486 flag indicating a suitable command |
| 487 </dd> | 487 </dd> |
| 488 </dl> | 488 </dl> |
| 489 <dl> | 489 <dl> |
| 505 <dd> | 505 <dd> |
| 506 list of file names to normalize (list of string) | 506 list of file names to normalize (list of string) |
| 507 </dd> | 507 </dd> |
| 508 </dl> | 508 </dl> |
| 509 <dl> | 509 <dl> |
| 510 <dt>Returns:</dt> | 510 <dt>Return:</dt> |
| 511 <dd> | 511 <dd> |
| 512 normalized file names (list of string) | 512 normalized file names (list of string) |
| 513 </dd> | 513 </dd> |
| 514 </dl> | 514 </dl> |
| 515 <a NAME="Project.__project" ID="Project.__project"></a> | 515 <a NAME="Project.__project" ID="Project.__project"></a> |
| 518 | 518 |
| 519 <p> | 519 <p> |
| 520 Private method to get the name of the current Pyramid project. | 520 Private method to get the name of the current Pyramid project. |
| 521 </p> | 521 </p> |
| 522 <dl> | 522 <dl> |
| 523 <dt>Returns:</dt> | 523 <dt>Return:</dt> |
| 524 <dd> | 524 <dd> |
| 525 name of the project (string) | 525 name of the project (string) |
| 526 </dd> | 526 </dd> |
| 527 </dl> | 527 </dl> |
| 528 <dl> | 528 <dl> |
| 546 <dd> | 546 <dd> |
| 547 list of file names to be filtered (list of string) | 547 list of file names to be filtered (list of string) |
| 548 </dd> | 548 </dd> |
| 549 </dl> | 549 </dl> |
| 550 <dl> | 550 <dl> |
| 551 <dt>Returns:</dt> | 551 <dt>Return:</dt> |
| 552 <dd> | 552 <dd> |
| 553 file names belonging to the current site (list of string) | 553 file names belonging to the current site (list of string) |
| 554 </dd> | 554 </dd> |
| 555 </dl> | 555 </dl> |
| 556 <a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a> | 556 <a NAME="Project.__projectLanguageAdded" ID="Project.__projectLanguageAdded"></a> |
| 573 | 573 |
| 574 <p> | 574 <p> |
| 575 Private method to calculate the full path of the Pyramid project. | 575 Private method to calculate the full path of the Pyramid project. |
| 576 </p> | 576 </p> |
| 577 <dl> | 577 <dl> |
| 578 <dt>Returns:</dt> | 578 <dt>Return:</dt> |
| 579 <dd> | 579 <dd> |
| 580 path of the project (string) | 580 path of the project (string) |
| 581 </dd> | 581 </dd> |
| 582 </dl> | 582 </dl> |
| 583 <dl> | 583 <dl> |
| 742 <dd> | 742 <dd> |
| 743 name of the menu (string) | 743 name of the menu (string) |
| 744 </dd> | 744 </dd> |
| 745 </dl> | 745 </dl> |
| 746 <dl> | 746 <dl> |
| 747 <dt>Returns:</dt> | 747 <dt>Return:</dt> |
| 748 <dd> | 748 <dd> |
| 749 reference to the menu (QMenu) or None, if no | 749 reference to the menu (QMenu) or None, if no |
| 750 menu with the given name exists | 750 menu with the given name exists |
| 751 </dd> | 751 </dd> |
| 752 </dl> | 752 </dl> |
| 756 | 756 |
| 757 <p> | 757 <p> |
| 758 Public method to get the names of all menus. | 758 Public method to get the names of all menus. |
| 759 </p> | 759 </p> |
| 760 <dl> | 760 <dl> |
| 761 <dt>Returns:</dt> | 761 <dt>Return:</dt> |
| 762 <dd> | 762 <dd> |
| 763 menu names (list of string) | 763 menu names (list of string) |
| 764 </dd> | 764 </dd> |
| 765 </dl> | 765 </dl> |
| 766 <a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a> | 766 <a NAME="Project.getPyramidCommand" ID="Project.getPyramidCommand"></a> |
| 781 Python variant to get the virtual environment | 781 Python variant to get the virtual environment |
| 782 for (string, one of '' or 'Python3') | 782 for (string, one of '' or 'Python3') |
| 783 </dd> | 783 </dd> |
| 784 </dl> | 784 </dl> |
| 785 <dl> | 785 <dl> |
| 786 <dt>Returns:</dt> | 786 <dt>Return:</dt> |
| 787 <dd> | 787 <dd> |
| 788 full pyramid command (string) | 788 full pyramid command (string) |
| 789 </dd> | 789 </dd> |
| 790 </dl> | 790 </dl> |
| 791 <a NAME="Project.getPyramidVersion" ID="Project.getPyramidVersion"></a> | 791 <a NAME="Project.getPyramidVersion" ID="Project.getPyramidVersion"></a> |
| 794 | 794 |
| 795 <p> | 795 <p> |
| 796 Public method to get the Pyramid version as a tuple. | 796 Public method to get the Pyramid version as a tuple. |
| 797 </p> | 797 </p> |
| 798 <dl> | 798 <dl> |
| 799 <dt>Returns:</dt> | 799 <dt>Return:</dt> |
| 800 <dd> | 800 <dd> |
| 801 Pyramid version | 801 Pyramid version |
| 802 </dd> | 802 </dd> |
| 803 </dl> | 803 </dl> |
| 804 <dl> | 804 <dl> |
| 813 | 813 |
| 814 <p> | 814 <p> |
| 815 Public method to get the Pyramid version as a string. | 815 Public method to get the Pyramid version as a string. |
| 816 </p> | 816 </p> |
| 817 <dl> | 817 <dl> |
| 818 <dt>Returns:</dt> | 818 <dt>Return:</dt> |
| 819 <dd> | 819 <dd> |
| 820 Pyramid version | 820 Pyramid version |
| 821 </dd> | 821 </dd> |
| 822 </dl> | 822 </dl> |
| 823 <dl> | 823 <dl> |
| 832 | 832 |
| 833 <p> | 833 <p> |
| 834 Public method to build the Python command. | 834 Public method to build the Python command. |
| 835 </p> | 835 </p> |
| 836 <dl> | 836 <dl> |
| 837 <dt>Returns:</dt> | 837 <dt>Return:</dt> |
| 838 <dd> | 838 <dd> |
| 839 python command (string) | 839 python command (string) |
| 840 </dd> | 840 </dd> |
| 841 </dl> | 841 </dl> |
| 842 <a NAME="Project.initActions" ID="Project.initActions"></a> | 842 <a NAME="Project.initActions" ID="Project.initActions"></a> |
| 852 | 852 |
| 853 <p> | 853 <p> |
| 854 Public slot to initialize the Pyramid menu. | 854 Public slot to initialize the Pyramid menu. |
| 855 </p> | 855 </p> |
| 856 <dl> | 856 <dl> |
| 857 <dt>Returns:</dt> | 857 <dt>Return:</dt> |
| 858 <dd> | 858 <dd> |
| 859 the menu generated (QMenu) | 859 the menu generated (QMenu) |
| 860 </dd> | 860 </dd> |
| 861 </dl> | 861 </dl> |
| 862 <a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a> | 862 <a NAME="Project.isSpawningConsole" ID="Project.isSpawningConsole"></a> |
| 872 <dd> | 872 <dd> |
| 873 console command (string) | 873 console command (string) |
| 874 </dd> | 874 </dd> |
| 875 </dl> | 875 </dl> |
| 876 <dl> | 876 <dl> |
| 877 <dt>Returns:</dt> | 877 <dt>Return:</dt> |
| 878 <dd> | 878 <dd> |
| 879 tuple of two entries giving an indication, if the console | 879 tuple of two entries giving an indication, if the console |
| 880 is spawning (boolean) and the (possibly) cleaned console command | 880 is spawning (boolean) and the (possibly) cleaned console command |
| 881 (string) | 881 (string) |
| 882 </dd> | 882 </dd> |
| 944 | 944 |
| 945 <p> | 945 <p> |
| 946 Public method to get the supported Python variants. | 946 Public method to get the supported Python variants. |
| 947 </p> | 947 </p> |
| 948 <dl> | 948 <dl> |
| 949 <dt>Returns:</dt> | 949 <dt>Return:</dt> |
| 950 <dd> | 950 <dd> |
| 951 list of supported Python variants (list of strings) | 951 list of supported Python variants (list of strings) |
| 952 </dd> | 952 </dd> |
| 953 </dl> | 953 </dl> |
| 954 <a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> | 954 <a NAME="Project.updateCatalogs" ID="Project.updateCatalogs"></a> |
| 1096 <dd> | 1096 <dd> |
| 1097 new working directory (string) | 1097 new working directory (string) |
| 1098 </dd> | 1098 </dd> |
| 1099 </dl> | 1099 </dl> |
| 1100 <dl> | 1100 <dl> |
| 1101 <dt>Returns:</dt> | 1101 <dt>Return:</dt> |
| 1102 <dd> | 1102 <dd> |
| 1103 tuple of successful start and process id (boolean, integer) | 1103 tuple of successful start and process id (boolean, integer) |
| 1104 </dd> | 1104 </dd> |
| 1105 </dl> | 1105 </dl> |
| 1106 <div align="right"><a href="#top">Up</a></div> | 1106 <div align="right"><a href="#top">Up</a></div> |
