Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Project.Project.html
src/eric7/Documentation/Source/eric7.Project.Project.html
- branch
- eric7
- changeset 9925
- a267ac36dd69
- parent 9744
- 92fbd6bdba84
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9924:b41c9a7bcbbb | 9925:a267ac36dd69 |
|---|---|
| 2454 list of all actions (list of EricAction) | 2454 list of all actions (list of EricAction) |
| 2455 </dd> | 2455 </dd> |
| 2456 </dl> | 2456 </dl> |
| 2457 <a NAME="Project.getData" ID="Project.getData"></a> | 2457 <a NAME="Project.getData" ID="Project.getData"></a> |
| 2458 <h4>Project.getData</h4> | 2458 <h4>Project.getData</h4> |
| 2459 <b>getData</b>(<i>category, key</i>) | 2459 <b>getData</b>(<i>category, key, default=None</i>) |
| 2460 | 2460 |
| 2461 <p> | 2461 <p> |
| 2462 Public method to get data out of the project data store. | 2462 Public method to get data out of the project data store. |
| 2463 </p> | |
| 2464 <dl> | |
| 2465 | |
| 2466 <dt><i>category</i> (str)</dt> | |
| 2467 <dd> | |
| 2468 category of the data to get (one of | |
| 2469 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS, | |
| 2470 DOCUMENTATIONPARMS or OTHERTOOLSPARMS) | |
| 2471 </dd> | |
| 2472 <dt><i>key</i> (str)</dt> | |
| 2473 <dd> | |
| 2474 key of the data entry to get | |
| 2475 </dd> | |
| 2476 <dt><i>default</i> (Any (optional))</dt> | |
| 2477 <dd> | |
| 2478 value to return in case the key is not found (defaults to None) | |
| 2479 </dd> | |
| 2480 </dl> | |
| 2481 <dl> | |
| 2482 <dt>Return:</dt> | |
| 2483 <dd> | |
| 2484 a copy of the requested data or None | |
| 2485 </dd> | |
| 2486 </dl> | |
| 2487 <a NAME="Project.getDebugProperty" ID="Project.getDebugProperty"></a> | |
| 2488 <h4>Project.getDebugProperty</h4> | |
| 2489 <b>getDebugProperty</b>(<i>key</i>) | |
| 2490 | |
| 2491 <p> | |
| 2492 Public method to retrieve a debugger property. | |
| 2493 </p> | |
| 2494 <dl> | |
| 2495 | |
| 2496 <dt><i>key</i></dt> | |
| 2497 <dd> | |
| 2498 key of the property (string) | |
| 2499 </dd> | |
| 2500 </dl> | |
| 2501 <dl> | |
| 2502 <dt>Return:</dt> | |
| 2503 <dd> | |
| 2504 value of the property | |
| 2505 </dd> | |
| 2506 </dl> | |
| 2507 <a NAME="Project.getDebuggerFilters" ID="Project.getDebuggerFilters"></a> | |
| 2508 <h4>Project.getDebuggerFilters</h4> | |
| 2509 <b>getDebuggerFilters</b>(<i>language</i>) | |
| 2510 | |
| 2511 <p> | |
| 2512 Public method to get the debugger filters for a programming language. | |
| 2513 </p> | |
| 2514 <dl> | |
| 2515 | |
| 2516 <dt><i>language</i> (str)</dt> | |
| 2517 <dd> | |
| 2518 programming language | |
| 2519 </dd> | |
| 2520 </dl> | |
| 2521 <dl> | |
| 2522 <dt>Return:</dt> | |
| 2523 <dd> | |
| 2524 filter string | |
| 2525 </dd> | |
| 2526 </dl> | |
| 2527 <dl> | |
| 2528 <dt>Return Type:</dt> | |
| 2529 <dd> | |
| 2530 str | |
| 2531 </dd> | |
| 2532 </dl> | |
| 2533 <a NAME="Project.getDefaultRccCompilerParameters" ID="Project.getDefaultRccCompilerParameters"></a> | |
| 2534 <h4>Project.getDefaultRccCompilerParameters</h4> | |
| 2535 <b>getDefaultRccCompilerParameters</b>(<i></i>) | |
| 2536 | |
| 2537 <p> | |
| 2538 Public method to get the default rcc compiler parameters. | |
| 2539 </p> | |
| 2540 <dl> | |
| 2541 <dt>Return:</dt> | |
| 2542 <dd> | |
| 2543 dictionary containing the default rcc compiler parameters | |
| 2544 </dd> | |
| 2545 </dl> | |
| 2546 <dl> | |
| 2547 <dt>Return Type:</dt> | |
| 2548 <dd> | |
| 2549 dict | |
| 2550 </dd> | |
| 2551 </dl> | |
| 2552 <a NAME="Project.getDefaultSourceExtension" ID="Project.getDefaultSourceExtension"></a> | |
| 2553 <h4>Project.getDefaultSourceExtension</h4> | |
| 2554 <b>getDefaultSourceExtension</b>(<i></i>) | |
| 2555 | |
| 2556 <p> | |
| 2557 Public method to get the default extension for the project's | |
| 2558 programming language. | |
| 2559 </p> | |
| 2560 <dl> | |
| 2561 <dt>Return:</dt> | |
| 2562 <dd> | |
| 2563 default extension (including the dot) (string) | |
| 2564 </dd> | |
| 2565 </dl> | |
| 2566 <a NAME="Project.getDocstringType" ID="Project.getDocstringType"></a> | |
| 2567 <h4>Project.getDocstringType</h4> | |
| 2568 <b>getDocstringType</b>(<i></i>) | |
| 2569 | |
| 2570 <p> | |
| 2571 Public method to get the configured docstring style. | |
| 2572 </p> | |
| 2573 <dl> | |
| 2574 <dt>Return:</dt> | |
| 2575 <dd> | |
| 2576 configured docstring style | |
| 2577 </dd> | |
| 2578 </dl> | |
| 2579 <dl> | |
| 2580 <dt>Return Type:</dt> | |
| 2581 <dd> | |
| 2582 str | |
| 2583 </dd> | |
| 2584 </dl> | |
| 2585 <a NAME="Project.getEditorLexerAssoc" ID="Project.getEditorLexerAssoc"></a> | |
| 2586 <h4>Project.getEditorLexerAssoc</h4> | |
| 2587 <b>getEditorLexerAssoc</b>(<i>filename</i>) | |
| 2588 | |
| 2589 <p> | |
| 2590 Public method to retrieve a lexer association. | |
| 2591 </p> | |
| 2592 <dl> | |
| 2593 | |
| 2594 <dt><i>filename</i></dt> | |
| 2595 <dd> | |
| 2596 filename used to determine the associated lexer | |
| 2597 language (string) | |
| 2598 </dd> | |
| 2599 </dl> | |
| 2600 <dl> | |
| 2601 <dt>Return:</dt> | |
| 2602 <dd> | |
| 2603 the requested lexer language (string) | |
| 2604 </dd> | |
| 2605 </dl> | |
| 2606 <a NAME="Project.getEolString" ID="Project.getEolString"></a> | |
| 2607 <h4>Project.getEolString</h4> | |
| 2608 <b>getEolString</b>(<i></i>) | |
| 2609 | |
| 2610 <p> | |
| 2611 Public method to get the EOL-string to be used by the project. | |
| 2612 </p> | |
| 2613 <dl> | |
| 2614 <dt>Return:</dt> | |
| 2615 <dd> | |
| 2616 eol string (string) | |
| 2617 </dd> | |
| 2618 </dl> | |
| 2619 <a NAME="Project.getFileCategories" ID="Project.getFileCategories"></a> | |
| 2620 <h4>Project.getFileCategories</h4> | |
| 2621 <b>getFileCategories</b>(<i></i>) | |
| 2622 | |
| 2623 <p> | |
| 2624 Public method to get the list of known file categories. | |
| 2625 </p> | |
| 2626 <dl> | |
| 2627 <dt>Return:</dt> | |
| 2628 <dd> | |
| 2629 list of known file categories | |
| 2630 </dd> | |
| 2631 </dl> | |
| 2632 <dl> | |
| 2633 <dt>Return Type:</dt> | |
| 2634 <dd> | |
| 2635 list of str | |
| 2636 </dd> | |
| 2637 </dl> | |
| 2638 <a NAME="Project.getFileCategoryExtension" ID="Project.getFileCategoryExtension"></a> | |
| 2639 <h4>Project.getFileCategoryExtension</h4> | |
| 2640 <b>getFileCategoryExtension</b>(<i>category, reverse=False</i>) | |
| 2641 | |
| 2642 <p> | |
| 2643 Public method to get a list of default file extensions for the given category. | |
| 2644 </p> | |
| 2645 <dl> | |
| 2646 | |
| 2647 <dt><i>category</i> (str)</dt> | |
| 2648 <dd> | |
| 2649 file type category | |
| 2650 </dd> | |
| 2651 <dt><i>reverse</i> (bool)</dt> | |
| 2652 <dd> | |
| 2653 flag indicating to get all other extensions except the one of | |
| 2654 the given category | |
| 2655 </dd> | |
| 2656 </dl> | |
| 2657 <dl> | |
| 2658 <dt>Return:</dt> | |
| 2659 <dd> | |
| 2660 list of default file extensions for the category | |
| 2661 </dd> | |
| 2662 </dl> | |
| 2663 <dl> | |
| 2664 <dt>Return Type:</dt> | |
| 2665 <dd> | |
| 2666 list of str | |
| 2667 </dd> | |
| 2668 </dl> | |
| 2669 <a NAME="Project.getFileCategoryFilterString" ID="Project.getFileCategoryFilterString"></a> | |
| 2670 <h4>Project.getFileCategoryFilterString</h4> | |
| 2671 <b>getFileCategoryFilterString</b>(<i>categories=None, withOthers=False, withAll=True</i>) | |
| 2672 | |
| 2673 <p> | |
| 2674 Public method to get a file selection string for the given categories. | |
| 2675 </p> | |
| 2676 <dl> | |
| 2677 | |
| 2678 <dt><i>categories</i> (list of str (optional))</dt> | |
| 2679 <dd> | |
| 2680 list of file type categories (defaults to None). | |
| 2681 A value of None means all categories except 'OTHERS'. | |
| 2682 </dd> | |
| 2683 <dt><i>withOthers</i> (bool (optional))</dt> | |
| 2684 <dd> | |
| 2685 flag indicating to include the 'OTHERS' category | |
| 2686 (defaults to False) | |
| 2687 </dd> | |
| 2688 <dt><i>withAll</i> (bool (optional))</dt> | |
| 2689 <dd> | |
| 2690 flag indicating to include a filter for 'All Files' | |
| 2691 (defaults to True) | |
| 2692 </dd> | |
| 2693 </dl> | |
| 2694 <dl> | |
| 2695 <dt>Return:</dt> | |
| 2696 <dd> | |
| 2697 file selection filter string | |
| 2698 </dd> | |
| 2699 </dl> | |
| 2700 <dl> | |
| 2701 <dt>Return Type:</dt> | |
| 2702 <dd> | |
| 2703 str | |
| 2704 </dd> | |
| 2705 </dl> | |
| 2706 <a NAME="Project.getFileCategoryString" ID="Project.getFileCategoryString"></a> | |
| 2707 <h4>Project.getFileCategoryString</h4> | |
| 2708 <b>getFileCategoryString</b>(<i>category</i>) | |
| 2709 | |
| 2710 <p> | |
| 2711 Public method to get a user string for the given category. | |
| 2712 </p> | |
| 2713 <dl> | |
| 2714 | |
| 2715 <dt><i>category</i> (str)</dt> | |
| 2716 <dd> | |
| 2717 file type category | |
| 2718 </dd> | |
| 2719 </dl> | |
| 2720 <dl> | |
| 2721 <dt>Return:</dt> | |
| 2722 <dd> | |
| 2723 user string for the category | |
| 2724 </dd> | |
| 2725 </dl> | |
| 2726 <dl> | |
| 2727 <dt>Return Type:</dt> | |
| 2728 <dd> | |
| 2729 str | |
| 2730 </dd> | |
| 2731 </dl> | |
| 2732 <a NAME="Project.getFileCategoryType" ID="Project.getFileCategoryType"></a> | |
| 2733 <h4>Project.getFileCategoryType</h4> | |
| 2734 <b>getFileCategoryType</b>(<i>category</i>) | |
| 2735 | |
| 2736 <p> | |
| 2737 Public method to get a user type string for the given category. | |
| 2738 </p> | |
| 2739 <dl> | |
| 2740 | |
| 2741 <dt><i>category</i> (str)</dt> | |
| 2742 <dd> | |
| 2743 file type category | |
| 2744 </dd> | |
| 2745 </dl> | |
| 2746 <dl> | |
| 2747 <dt>Return:</dt> | |
| 2748 <dd> | |
| 2749 user type string for the category | |
| 2750 </dd> | |
| 2751 </dl> | |
| 2752 <dl> | |
| 2753 <dt>Return Type:</dt> | |
| 2754 <dd> | |
| 2755 str | |
| 2756 </dd> | |
| 2757 </dl> | |
| 2758 <a NAME="Project.getFiles" ID="Project.getFiles"></a> | |
| 2759 <h4>Project.getFiles</h4> | |
| 2760 <b>getFiles</b>(<i>start</i>) | |
| 2761 | |
| 2762 <p> | |
| 2763 Public method to get all files starting with a common prefix. | |
| 2764 </p> | |
| 2765 <dl> | |
| 2766 | |
| 2767 <dt><i>start</i></dt> | |
| 2768 <dd> | |
| 2769 prefix (string) | |
| 2770 </dd> | |
| 2771 </dl> | |
| 2772 <dl> | |
| 2773 <dt>Return:</dt> | |
| 2774 <dd> | |
| 2775 list of files starting with a common prefix (list of strings) | |
| 2776 </dd> | |
| 2777 </dl> | |
| 2778 <a NAME="Project.getFiletypeAssociations" ID="Project.getFiletypeAssociations"></a> | |
| 2779 <h4>Project.getFiletypeAssociations</h4> | |
| 2780 <b>getFiletypeAssociations</b>(<i>associationType</i>) | |
| 2781 | |
| 2782 <p> | |
| 2783 Public method to get the list of file type associations for | |
| 2784 the given association type. | |
| 2785 </p> | |
| 2786 <dl> | |
| 2787 | |
| 2788 <dt><i>associationType</i> (str)</dt> | |
| 2789 <dd> | |
| 2790 type of the association (one of the known file categories | |
| 2791 or __IGNORE__) | |
| 2792 </dd> | |
| 2793 </dl> | |
| 2794 <dl> | |
| 2795 <dt>Return:</dt> | |
| 2796 <dd> | |
| 2797 list of file patterns for the given type | |
| 2798 </dd> | |
| 2799 </dl> | |
| 2800 <dl> | |
| 2801 <dt>Return Type:</dt> | |
| 2802 <dd> | |
| 2803 list of str | |
| 2804 </dd> | |
| 2805 </dl> | |
| 2806 <a NAME="Project.getHash" ID="Project.getHash"></a> | |
| 2807 <h4>Project.getHash</h4> | |
| 2808 <b>getHash</b>(<i></i>) | |
| 2809 | |
| 2810 <p> | |
| 2811 Public method to get the project hash. | |
| 2812 </p> | |
| 2813 <dl> | |
| 2814 <dt>Return:</dt> | |
| 2815 <dd> | |
| 2816 project hash as a hex string (string) | |
| 2817 </dd> | |
| 2818 </dl> | |
| 2819 <a NAME="Project.getIgnorePatterns" ID="Project.getIgnorePatterns"></a> | |
| 2820 <h4>Project.getIgnorePatterns</h4> | |
| 2821 <b>getIgnorePatterns</b>(<i></i>) | |
| 2822 | |
| 2823 <p> | |
| 2824 Public method to get the list of file name patterns for files to be | |
| 2825 ignored. | |
| 2826 </p> | |
| 2827 <dl> | |
| 2828 <dt>Return:</dt> | |
| 2829 <dd> | |
| 2830 list of ignore file name patterns | |
| 2831 </dd> | |
| 2832 </dl> | |
| 2833 <dl> | |
| 2834 <dt>Return Type:</dt> | |
| 2835 <dd> | |
| 2836 list of str | |
| 2837 </dd> | |
| 2838 </dl> | |
| 2839 <a NAME="Project.getMainScript" ID="Project.getMainScript"></a> | |
| 2840 <h4>Project.getMainScript</h4> | |
| 2841 <b>getMainScript</b>(<i>normalized=False</i>) | |
| 2842 | |
| 2843 <p> | |
| 2844 Public method to return the main script filename. | |
| 2845 </p> | |
| 2846 <p> | |
| 2847 The normalized name is the name of the main script prepended with | |
| 2848 the project path. | |
| 2849 </p> | |
| 2850 <dl> | |
| 2851 | |
| 2852 <dt><i>normalized</i> (bool)</dt> | |
| 2853 <dd> | |
| 2854 flag indicating a normalized filename is wanted | |
| 2855 </dd> | |
| 2856 </dl> | |
| 2857 <dl> | |
| 2858 <dt>Return:</dt> | |
| 2859 <dd> | |
| 2860 filename of the projects main script | |
| 2861 </dd> | |
| 2862 </dl> | |
| 2863 <dl> | |
| 2864 <dt>Return Type:</dt> | |
| 2865 <dd> | |
| 2866 str | |
| 2867 </dd> | |
| 2868 </dl> | |
| 2869 <a NAME="Project.getMenu" ID="Project.getMenu"></a> | |
| 2870 <h4>Project.getMenu</h4> | |
| 2871 <b>getMenu</b>(<i>menuName</i>) | |
| 2872 | |
| 2873 <p> | |
| 2874 Public method to get a reference to the main menu or a submenu. | |
| 2875 </p> | |
| 2876 <dl> | |
| 2877 | |
| 2878 <dt><i>menuName</i></dt> | |
| 2879 <dd> | |
| 2880 name of the menu (string) | |
| 2881 </dd> | |
| 2882 </dl> | |
| 2883 <dl> | |
| 2884 <dt>Return:</dt> | |
| 2885 <dd> | |
| 2886 reference to the requested menu (QMenu) or None | |
| 2887 </dd> | |
| 2888 </dl> | |
| 2889 <a NAME="Project.getModel" ID="Project.getModel"></a> | |
| 2890 <h4>Project.getModel</h4> | |
| 2891 <b>getModel</b>(<i></i>) | |
| 2892 | |
| 2893 <p> | |
| 2894 Public method to get a reference to the project browser model. | |
| 2895 </p> | |
| 2896 <dl> | |
| 2897 <dt>Return:</dt> | |
| 2898 <dd> | |
| 2899 reference to the project browser model (ProjectBrowserModel) | |
| 2900 </dd> | |
| 2901 </dl> | |
| 2902 <a NAME="Project.getMostRecent" ID="Project.getMostRecent"></a> | |
| 2903 <h4>Project.getMostRecent</h4> | |
| 2904 <b>getMostRecent</b>(<i></i>) | |
| 2905 | |
| 2906 <p> | |
| 2907 Public method to get the most recently opened project. | |
| 2908 </p> | |
| 2909 <dl> | |
| 2910 <dt>Return:</dt> | |
| 2911 <dd> | |
| 2912 path of the most recently opened project (string) | |
| 2913 </dd> | |
| 2914 </dl> | |
| 2915 <a NAME="Project.getProgrammingLanguages" ID="Project.getProgrammingLanguages"></a> | |
| 2916 <h4>Project.getProgrammingLanguages</h4> | |
| 2917 <b>getProgrammingLanguages</b>(<i></i>) | |
| 2918 | |
| 2919 <p> | |
| 2920 Public method to get the programming languages supported by project. | |
| 2921 </p> | |
| 2922 <dl> | |
| 2923 <dt>Return:</dt> | |
| 2924 <dd> | |
| 2925 list of supported programming languages (list of string) | |
| 2926 </dd> | |
| 2927 </dl> | |
| 2928 <a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a> | |
| 2929 <h4>Project.getProjectAuthor</h4> | |
| 2930 <b>getProjectAuthor</b>(<i></i>) | |
| 2931 | |
| 2932 <p> | |
| 2933 Public method to get the author of the project. | |
| 2934 </p> | |
| 2935 <dl> | |
| 2936 <dt>Return:</dt> | |
| 2937 <dd> | |
| 2938 author name | |
| 2939 </dd> | |
| 2940 </dl> | |
| 2941 <dl> | |
| 2942 <dt>Return Type:</dt> | |
| 2943 <dd> | |
| 2944 str | |
| 2945 </dd> | |
| 2946 </dl> | |
| 2947 <a NAME="Project.getProjectAuthorEmail" ID="Project.getProjectAuthorEmail"></a> | |
| 2948 <h4>Project.getProjectAuthorEmail</h4> | |
| 2949 <b>getProjectAuthorEmail</b>(<i></i>) | |
| 2950 | |
| 2951 <p> | |
| 2952 Public method to get the email address of the project author. | |
| 2953 </p> | |
| 2954 <dl> | |
| 2955 <dt>Return:</dt> | |
| 2956 <dd> | |
| 2957 project author email | |
| 2958 </dd> | |
| 2959 </dl> | |
| 2960 <dl> | |
| 2961 <dt>Return Type:</dt> | |
| 2962 <dd> | |
| 2963 str | |
| 2964 </dd> | |
| 2965 </dl> | |
| 2966 <a NAME="Project.getProjectData" ID="Project.getProjectData"></a> | |
| 2967 <h4>Project.getProjectData</h4> | |
| 2968 <b>getProjectData</b>(<i>dataKey=None, default=None</i>) | |
| 2969 | |
| 2970 <p> | |
| 2971 Public method to get the data associated with the given data key. | |
| 2972 </p> | |
| 2973 <p> | |
| 2974 Note: If dataKey is None, a copy of the project data structure | |
| 2975 is returned. | |
| 2976 </p> | |
| 2977 <dl> | |
| 2978 | |
| 2979 <dt><i>dataKey</i> (str (optional))</dt> | |
| 2980 <dd> | |
| 2981 key of the data to get (defaults to None) | |
| 2982 </dd> | |
| 2983 <dt><i>default</i> (Any (optional))</dt> | |
| 2984 <dd> | |
| 2985 default value for non-existent keys (defaults to None) | |
| 2986 </dd> | |
| 2987 </dl> | |
| 2988 <dl> | |
| 2989 <dt>Return:</dt> | |
| 2990 <dd> | |
| 2991 requested data or None if the data key doesn't exist or | |
| 2992 a copy of the project data dictionary | |
| 2993 </dd> | |
| 2994 </dl> | |
| 2995 <dl> | |
| 2996 <dt>Return Type:</dt> | |
| 2997 <dd> | |
| 2998 Any | |
| 2999 </dd> | |
| 3000 </dl> | |
| 3001 <a NAME="Project.getProjectDescription" ID="Project.getProjectDescription"></a> | |
| 3002 <h4>Project.getProjectDescription</h4> | |
| 3003 <b>getProjectDescription</b>(<i></i>) | |
| 3004 | |
| 3005 <p> | |
| 3006 Public method to get the description of the project. | |
| 3007 </p> | |
| 3008 <dl> | |
| 3009 <dt>Return:</dt> | |
| 3010 <dd> | |
| 3011 project description | |
| 3012 </dd> | |
| 3013 </dl> | |
| 3014 <dl> | |
| 3015 <dt>Return Type:</dt> | |
| 3016 <dd> | |
| 3017 str | |
| 3018 </dd> | |
| 3019 </dl> | |
| 3020 <a NAME="Project.getProjectDictionaries" ID="Project.getProjectDictionaries"></a> | |
| 3021 <h4>Project.getProjectDictionaries</h4> | |
| 3022 <b>getProjectDictionaries</b>(<i></i>) | |
| 3023 | |
| 3024 <p> | |
| 3025 Public method to get the names of the project specific dictionaries. | |
| 3026 </p> | |
| 3027 <dl> | |
| 3028 <dt>Return:</dt> | |
| 3029 <dd> | |
| 3030 tuple of two strings giving the absolute path names of the | |
| 3031 project specific word and exclude list | |
| 3032 </dd> | |
| 3033 </dl> | |
| 3034 <a NAME="Project.getProjectExecPath" ID="Project.getProjectExecPath"></a> | |
| 3035 <h4>Project.getProjectExecPath</h4> | |
| 3036 <b>getProjectExecPath</b>(<i></i>) | |
| 3037 | |
| 3038 <p> | |
| 3039 Public method to get the executable search path prefix of the project. | |
| 3040 </p> | |
| 3041 <dl> | |
| 3042 <dt>Return:</dt> | |
| 3043 <dd> | |
| 3044 executable search path prefix | |
| 3045 </dd> | |
| 3046 </dl> | |
| 3047 <dl> | |
| 3048 <dt>Return Type:</dt> | |
| 3049 <dd> | |
| 3050 str | |
| 3051 </dd> | |
| 3052 </dl> | |
| 3053 <a NAME="Project.getProjectFile" ID="Project.getProjectFile"></a> | |
| 3054 <h4>Project.getProjectFile</h4> | |
| 3055 <b>getProjectFile</b>(<i></i>) | |
| 3056 | |
| 3057 <p> | |
| 3058 Public method to get the path of the project file. | |
| 3059 </p> | |
| 3060 <dl> | |
| 3061 <dt>Return:</dt> | |
| 3062 <dd> | |
| 3063 path of the project file (string) | |
| 3064 </dd> | |
| 3065 </dl> | |
| 3066 <a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a> | |
| 3067 <h4>Project.getProjectFiles</h4> | |
| 3068 <b>getProjectFiles</b>(<i>fileType, normalized=False</i>) | |
| 3069 | |
| 3070 <p> | |
| 3071 Public method to get the file entries of the given type. | |
| 3072 </p> | |
| 3073 <dl> | |
| 3074 | |
| 3075 <dt><i>fileType</i> (str)</dt> | |
| 3076 <dd> | |
| 3077 project file type (one of the known file categories) | |
| 3078 </dd> | |
| 3079 <dt><i>normalized</i> (boolean)</dt> | |
| 3080 <dd> | |
| 3081 flag indicating normalized file names are wanted | |
| 3082 </dd> | |
| 3083 </dl> | |
| 3084 <dl> | |
| 3085 <dt>Return:</dt> | |
| 3086 <dd> | |
| 3087 list of file names | |
| 3088 </dd> | |
| 3089 </dl> | |
| 3090 <dl> | |
| 3091 <dt>Return Type:</dt> | |
| 3092 <dd> | |
| 3093 list of str | |
| 3094 </dd> | |
| 3095 </dl> | |
| 3096 <dl> | |
| 3097 | |
| 3098 <dt>Raises <b>ValueError</b>:</dt> | |
| 3099 <dd> | |
| 3100 raised when an unsupported file type is given | |
| 3101 </dd> | |
| 3102 </dl> | |
| 3103 <a NAME="Project.getProjectInterpreter" ID="Project.getProjectInterpreter"></a> | |
| 3104 <h4>Project.getProjectInterpreter</h4> | |
| 3105 <b>getProjectInterpreter</b>(<i>resolveGlobal=True</i>) | |
| 3106 | |
| 3107 <p> | |
| 3108 Public method to get the path of the interpreter used by the project. | |
| 3109 </p> | |
| 3110 <dl> | |
| 3111 | |
| 3112 <dt><i>resolveGlobal</i> (bool)</dt> | |
| 3113 <dd> | |
| 3114 flag indicating to resolve the interpreter using | |
| 3115 the global interpreter if no project or debugger specific | |
| 3116 environment was configured | |
| 3117 </dd> | |
| 3118 </dl> | |
| 3119 <dl> | |
| 3120 <dt>Return:</dt> | |
| 3121 <dd> | |
| 3122 path of the project's interpreter | |
| 3123 </dd> | |
| 3124 </dl> | |
| 3125 <dl> | |
| 3126 <dt>Return Type:</dt> | |
| 3127 <dd> | |
| 3128 str | |
| 3129 </dd> | |
| 3130 </dl> | |
| 3131 <a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a> | |
| 3132 <h4>Project.getProjectLanguage</h4> | |
| 3133 <b>getProjectLanguage</b>(<i></i>) | |
| 3134 | |
| 3135 <p> | |
| 3136 Public method to get the project's programming language. | |
| 3137 </p> | |
| 3138 <dl> | |
| 3139 <dt>Return:</dt> | |
| 3140 <dd> | |
| 3141 programming language (string) | |
| 3142 </dd> | |
| 3143 </dl> | |
| 3144 <a NAME="Project.getProjectLicense" ID="Project.getProjectLicense"></a> | |
| 3145 <h4>Project.getProjectLicense</h4> | |
| 3146 <b>getProjectLicense</b>(<i></i>) | |
| 3147 | |
| 3148 <p> | |
| 3149 Public method to get the license type used by the project. | |
| 3150 </p> | |
| 3151 <dl> | |
| 3152 <dt>Return:</dt> | |
| 3153 <dd> | |
| 3154 license type of the project | |
| 3155 </dd> | |
| 3156 </dl> | |
| 3157 <dl> | |
| 3158 <dt>Return Type:</dt> | |
| 3159 <dd> | |
| 3160 str | |
| 3161 </dd> | |
| 3162 </dl> | |
| 3163 <a NAME="Project.getProjectManagementDir" ID="Project.getProjectManagementDir"></a> | |
| 3164 <h4>Project.getProjectManagementDir</h4> | |
| 3165 <b>getProjectManagementDir</b>(<i></i>) | |
| 3166 | |
| 3167 <p> | |
| 3168 Public method to get the path of the management directory. | |
| 3169 </p> | |
| 3170 <dl> | |
| 3171 <dt>Return:</dt> | |
| 3172 <dd> | |
| 3173 path of the management directory (string) | |
| 3174 </dd> | |
| 3175 </dl> | |
| 3176 <a NAME="Project.getProjectName" ID="Project.getProjectName"></a> | |
| 3177 <h4>Project.getProjectName</h4> | |
| 3178 <b>getProjectName</b>(<i></i>) | |
| 3179 | |
| 3180 <p> | |
| 3181 Public method to get the name of the project. | |
| 3182 </p> | |
| 3183 <p> | |
| 3184 The project name is determined from the name of the project file. | |
| 3185 </p> | |
| 3186 <dl> | |
| 3187 <dt>Return:</dt> | |
| 3188 <dd> | |
| 3189 name of the project (string) | |
| 3190 </dd> | |
| 3191 </dl> | |
| 3192 <a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a> | |
| 3193 <h4>Project.getProjectPath</h4> | |
| 3194 <b>getProjectPath</b>(<i></i>) | |
| 3195 | |
| 3196 <p> | |
| 3197 Public method to get the project path. | |
| 3198 </p> | |
| 3199 <dl> | |
| 3200 <dt>Return:</dt> | |
| 3201 <dd> | |
| 3202 project path (string) | |
| 3203 </dd> | |
| 3204 </dl> | |
| 3205 <a NAME="Project.getProjectSpellLanguage" ID="Project.getProjectSpellLanguage"></a> | |
| 3206 <h4>Project.getProjectSpellLanguage</h4> | |
| 3207 <b>getProjectSpellLanguage</b>(<i></i>) | |
| 3208 | |
| 3209 <p> | |
| 3210 Public method to get the project's programming language. | |
| 3211 </p> | |
| 3212 <dl> | |
| 3213 <dt>Return:</dt> | |
| 3214 <dd> | |
| 3215 programming language (string) | |
| 3216 </dd> | |
| 3217 </dl> | |
| 3218 <a NAME="Project.getProjectTestingFramework" ID="Project.getProjectTestingFramework"></a> | |
| 3219 <h4>Project.getProjectTestingFramework</h4> | |
| 3220 <b>getProjectTestingFramework</b>(<i></i>) | |
| 3221 | |
| 3222 <p> | |
| 3223 Public method to get the testing framework name of the project. | |
| 3224 </p> | |
| 3225 <dl> | |
| 3226 <dt>Return:</dt> | |
| 3227 <dd> | |
| 3228 testing framework name of the project | |
| 3229 </dd> | |
| 3230 </dl> | |
| 3231 <dl> | |
| 3232 <dt>Return Type:</dt> | |
| 3233 <dd> | |
| 3234 str | |
| 3235 </dd> | |
| 3236 </dl> | |
| 3237 <a NAME="Project.getProjectType" ID="Project.getProjectType"></a> | |
| 3238 <h4>Project.getProjectType</h4> | |
| 3239 <b>getProjectType</b>(<i></i>) | |
| 3240 | |
| 3241 <p> | |
| 3242 Public method to get the type of the project. | |
| 3243 </p> | |
| 3244 <dl> | |
| 3245 <dt>Return:</dt> | |
| 3246 <dd> | |
| 3247 UI type of the project (string) | |
| 3248 </dd> | |
| 3249 </dl> | |
| 3250 <a NAME="Project.getProjectTypes" ID="Project.getProjectTypes"></a> | |
| 3251 <h4>Project.getProjectTypes</h4> | |
| 3252 <b>getProjectTypes</b>(<i>progLanguage=""</i>) | |
| 3253 | |
| 3254 <p> | |
| 3255 Public method to get the list of supported project types. | |
| 3256 </p> | |
| 3257 <dl> | |
| 3258 | |
| 3259 <dt><i>progLanguage</i></dt> | |
| 3260 <dd> | |
| 3261 programming language to get project types for | |
| 3262 (string) | |
| 3263 </dd> | |
| 3264 </dl> | |
| 3265 <dl> | |
| 3266 <dt>Return:</dt> | |
| 3267 <dd> | |
| 3268 reference to the dictionary of project types. | |
| 3269 </dd> | |
| 3270 </dl> | |
| 3271 <a NAME="Project.getProjectVenv" ID="Project.getProjectVenv"></a> | |
| 3272 <h4>Project.getProjectVenv</h4> | |
| 3273 <b>getProjectVenv</b>(<i>resolveDebugger=True</i>) | |
| 3274 | |
| 3275 <p> | |
| 3276 Public method to get the name of the virtual environment used by the | |
| 3277 project. | |
| 3278 </p> | |
| 3279 <dl> | |
| 3280 | |
| 3281 <dt><i>resolveDebugger</i> (bool)</dt> | |
| 3282 <dd> | |
| 3283 flag indicating to resolve the virtual | |
| 3284 environment name via the debugger settings if none was configured | |
| 3285 </dd> | |
| 3286 </dl> | |
| 3287 <dl> | |
| 3288 <dt>Return:</dt> | |
| 3289 <dd> | |
| 3290 name of the project's virtual environment | |
| 3291 </dd> | |
| 3292 </dl> | |
| 3293 <dl> | |
| 3294 <dt>Return Type:</dt> | |
| 3295 <dd> | |
| 3296 str | |
| 3297 </dd> | |
| 3298 </dl> | |
| 3299 <a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a> | |
| 3300 <h4>Project.getProjectVersion</h4> | |
| 3301 <b>getProjectVersion</b>(<i></i>) | |
| 3302 | |
| 3303 <p> | |
| 3304 Public mehod to get the version number of the project. | |
| 3305 </p> | |
| 3306 <dl> | |
| 3307 <dt>Return:</dt> | |
| 3308 <dd> | |
| 3309 version number | |
| 3310 </dd> | |
| 3311 </dl> | |
| 3312 <dl> | |
| 3313 <dt>Return Type:</dt> | |
| 3314 <dd> | |
| 3315 str | |
| 3316 </dd> | |
| 3317 </dl> | |
| 3318 <a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a> | |
| 3319 <h4>Project.getRelativePath</h4> | |
| 3320 <b>getRelativePath</b>(<i>path</i>) | |
| 3321 | |
| 3322 <p> | |
| 3323 Public method to convert a file path to a project relative | |
| 3324 file path. | |
| 3325 </p> | |
| 3326 <dl> | |
| 3327 | |
| 3328 <dt><i>path</i></dt> | |
| 3329 <dd> | |
| 3330 file or directory name to convert (string) | |
| 3331 </dd> | |
| 3332 </dl> | |
| 3333 <dl> | |
| 3334 <dt>Return:</dt> | |
| 3335 <dd> | |
| 3336 project relative path or unchanged path, if path doesn't | |
| 3337 belong to the project (string) | |
| 3338 </dd> | |
| 3339 </dl> | |
| 3340 <a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a> | |
| 3341 <h4>Project.getRelativeUniversalPath</h4> | |
| 3342 <b>getRelativeUniversalPath</b>(<i>path</i>) | |
| 3343 | |
| 3344 <p> | |
| 3345 Public method to convert a file path to a project relative | |
| 3346 file path with universal separators. | |
| 3347 </p> | |
| 3348 <dl> | |
| 3349 | |
| 3350 <dt><i>path</i></dt> | |
| 3351 <dd> | |
| 3352 file or directory name to convert (string) | |
| 3353 </dd> | |
| 3354 </dl> | |
| 3355 <dl> | |
| 3356 <dt>Return:</dt> | |
| 3357 <dd> | |
| 3358 project relative path or unchanged path, if path doesn't | |
| 3359 belong to the project (string) | |
| 3360 </dd> | |
| 3361 </dl> | |
| 3362 <a NAME="Project.getSources" ID="Project.getSources"></a> | |
| 3363 <h4>Project.getSources</h4> | |
| 3364 <b>getSources</b>(<i>normalized=False</i>) | |
| 3365 | |
| 3366 <p> | |
| 3367 Public method to return the source script files. | |
| 3368 </p> | |
| 3369 <dl> | |
| 3370 | |
| 3371 <dt><i>normalized</i> (bool)</dt> | |
| 3372 <dd> | |
| 3373 flag indicating a normalized filename is wanted | |
| 3374 </dd> | |
| 3375 </dl> | |
| 3376 <dl> | |
| 3377 <dt>Return:</dt> | |
| 3378 <dd> | |
| 3379 list of the projects scripts | |
| 3380 </dd> | |
| 3381 </dl> | |
| 3382 <dl> | |
| 3383 <dt>Return Type:</dt> | |
| 3384 <dd> | |
| 3385 list of str | |
| 3386 </dd> | |
| 3387 </dl> | |
| 3388 <a NAME="Project.getStatusMonitorAutoUpdate" ID="Project.getStatusMonitorAutoUpdate"></a> | |
| 3389 <h4>Project.getStatusMonitorAutoUpdate</h4> | |
| 3390 <b>getStatusMonitorAutoUpdate</b>(<i></i>) | |
| 3391 | |
| 3392 <p> | |
| 3393 Public method to retrieve the status of the auto update function. | |
| 3394 </p> | |
| 3395 <dl> | |
| 3396 <dt>Return:</dt> | |
| 3397 <dd> | |
| 3398 status of the auto update function (boolean) | |
| 3399 </dd> | |
| 3400 </dl> | |
| 3401 <a NAME="Project.getStatusMonitorInterval" ID="Project.getStatusMonitorInterval"></a> | |
| 3402 <h4>Project.getStatusMonitorInterval</h4> | |
| 3403 <b>getStatusMonitorInterval</b>(<i></i>) | |
| 3404 | |
| 3405 <p> | |
| 3406 Public method to get the monitor interval. | |
| 3407 </p> | |
| 3408 <dl> | |
| 3409 <dt>Return:</dt> | |
| 3410 <dd> | |
| 3411 interval in seconds (integer) | |
| 3412 </dd> | |
| 3413 </dl> | |
| 3414 <a NAME="Project.getTranslationPattern" ID="Project.getTranslationPattern"></a> | |
| 3415 <h4>Project.getTranslationPattern</h4> | |
| 3416 <b>getTranslationPattern</b>(<i></i>) | |
| 3417 | |
| 3418 <p> | |
| 3419 Public method to get the translation pattern. | |
| 3420 </p> | |
| 3421 <dl> | |
| 3422 <dt>Return:</dt> | |
| 3423 <dd> | |
| 3424 translation pattern (string) | |
| 3425 </dd> | |
| 3426 </dl> | |
| 3427 <a NAME="Project.getUicParameter" ID="Project.getUicParameter"></a> | |
| 3428 <h4>Project.getUicParameter</h4> | |
| 3429 <b>getUicParameter</b>(<i>name</i>) | |
| 3430 | |
| 3431 <p> | |
| 3432 Public method to get a named uic related parameter. | |
| 3433 </p> | |
| 3434 <dl> | |
| 3435 | |
| 3436 <dt><i>name</i> (str)</dt> | |
| 3437 <dd> | |
| 3438 name of the parameter | |
| 3439 </dd> | |
| 3440 </dl> | |
| 3441 <dl> | |
| 3442 <dt>Return:</dt> | |
| 3443 <dd> | |
| 3444 value of the given parameter | |
| 3445 </dd> | |
| 3446 </dl> | |
| 3447 <dl> | |
| 3448 <dt>Return Type:</dt> | |
| 3449 <dd> | |
| 3450 any, None in case on non-existence | |
| 3451 </dd> | |
| 3452 </dl> | |
| 3453 <a NAME="Project.getVcs" ID="Project.getVcs"></a> | |
| 3454 <h4>Project.getVcs</h4> | |
| 3455 <b>getVcs</b>(<i></i>) | |
| 3456 | |
| 3457 <p> | |
| 3458 Public method to get a reference to the VCS object. | |
| 3459 </p> | |
| 3460 <dl> | |
| 3461 <dt>Return:</dt> | |
| 3462 <dd> | |
| 3463 reference to the VCS object | |
| 3464 </dd> | |
| 3465 </dl> | |
| 3466 <a NAME="Project.handleApplicationDiagram" ID="Project.handleApplicationDiagram"></a> | |
| 3467 <h4>Project.handleApplicationDiagram</h4> | |
| 3468 <b>handleApplicationDiagram</b>(<i></i>) | |
| 3469 | |
| 3470 <p> | |
| 3471 Public method to handle the application diagram context menu action. | |
| 3472 </p> | |
| 3473 <a NAME="Project.handlePreferencesChanged" ID="Project.handlePreferencesChanged"></a> | |
| 3474 <h4>Project.handlePreferencesChanged</h4> | |
| 3475 <b>handlePreferencesChanged</b>(<i></i>) | |
| 3476 | |
| 3477 <p> | |
| 3478 Public slot used to handle the preferencesChanged signal. | |
| 3479 </p> | |
| 3480 <a NAME="Project.hasDefaultDocstringParameter" ID="Project.hasDefaultDocstringParameter"></a> | |
| 3481 <h4>Project.hasDefaultDocstringParameter</h4> | |
| 3482 <b>hasDefaultDocstringParameter</b>(<i></i>) | |
| 3483 | |
| 3484 <p> | |
| 3485 Public method to test, if the project contains the default docstring | |
| 3486 parameter. | |
| 3487 </p> | |
| 3488 <dl> | |
| 3489 <dt>Return:</dt> | |
| 3490 <dd> | |
| 3491 flag indicating default parameter | |
| 3492 </dd> | |
| 3493 </dl> | |
| 3494 <dl> | |
| 3495 <dt>Return Type:</dt> | |
| 3496 <dd> | |
| 3497 bool | |
| 3498 </dd> | |
| 3499 </dl> | |
| 3500 <a NAME="Project.hasDefaultMakeParameters" ID="Project.hasDefaultMakeParameters"></a> | |
| 3501 <h4>Project.hasDefaultMakeParameters</h4> | |
| 3502 <b>hasDefaultMakeParameters</b>(<i></i>) | |
| 3503 | |
| 3504 <p> | |
| 3505 Public method to test, if the project contains the default make | |
| 3506 parameters. | |
| 3507 </p> | |
| 3508 <dl> | |
| 3509 <dt>Return:</dt> | |
| 3510 <dd> | |
| 3511 flag indicating default parameter set | |
| 3512 </dd> | |
| 3513 </dl> | |
| 3514 <dl> | |
| 3515 <dt>Return Type:</dt> | |
| 3516 <dd> | |
| 3517 bool | |
| 3518 </dd> | |
| 3519 </dl> | |
| 3520 <a NAME="Project.hasDefaultRccCompilerParameters" ID="Project.hasDefaultRccCompilerParameters"></a> | |
| 3521 <h4>Project.hasDefaultRccCompilerParameters</h4> | |
| 3522 <b>hasDefaultRccCompilerParameters</b>(<i></i>) | |
| 3523 | |
| 3524 <p> | |
| 3525 Public method to test, if the project contains the default rcc compiler | |
| 3526 parameters. | |
| 3527 </p> | |
| 3528 <dl> | |
| 3529 <dt>Return:</dt> | |
| 3530 <dd> | |
| 3531 flag indicating default parameter set | |
| 3532 </dd> | |
| 3533 </dl> | |
| 3534 <dl> | |
| 3535 <dt>Return Type:</dt> | |
| 3536 <dd> | |
| 3537 bool | |
| 3538 </dd> | |
| 3539 </dl> | |
| 3540 <a NAME="Project.hasDefaultUicCompilerParameters" ID="Project.hasDefaultUicCompilerParameters"></a> | |
| 3541 <h4>Project.hasDefaultUicCompilerParameters</h4> | |
| 3542 <b>hasDefaultUicCompilerParameters</b>(<i></i>) | |
| 3543 | |
| 3544 <p> | |
| 3545 Public method to test, if the project contains the default uic compiler | |
| 3546 parameters. | |
| 3547 </p> | |
| 3548 <dl> | |
| 3549 <dt>Return:</dt> | |
| 3550 <dd> | |
| 3551 flag indicating default parameter set | |
| 3552 </dd> | |
| 3553 </dl> | |
| 3554 <dl> | |
| 3555 <dt>Return Type:</dt> | |
| 3556 <dd> | |
| 3557 bool | |
| 3558 </dd> | |
| 3559 </dl> | |
| 3560 <a NAME="Project.hasEntry" ID="Project.hasEntry"></a> | |
| 3561 <h4>Project.hasEntry</h4> | |
| 3562 <b>hasEntry</b>(<i>fn</i>) | |
| 3563 | |
| 3564 <p> | |
| 3565 Public method to check the project for a file. | |
| 3566 </p> | |
| 3567 <dl> | |
| 3568 | |
| 3569 <dt><i>fn</i></dt> | |
| 3570 <dd> | |
| 3571 filename to be checked (string) | |
| 3572 </dd> | |
| 3573 </dl> | |
| 3574 <dl> | |
| 3575 <dt>Return:</dt> | |
| 3576 <dd> | |
| 3577 flag indicating, if the project contains the file (boolean) | |
| 3578 </dd> | |
| 3579 </dl> | |
| 3580 <a NAME="Project.hasProjectType" ID="Project.hasProjectType"></a> | |
| 3581 <h4>Project.hasProjectType</h4> | |
| 3582 <b>hasProjectType</b>(<i>type_, progLanguage=""</i>) | |
| 3583 | |
| 3584 <p> | |
| 3585 Public method to check, if a project type is already registered. | |
| 3586 </p> | |
| 3587 <dl> | |
| 3588 | |
| 3589 <dt><i>type_</i></dt> | |
| 3590 <dd> | |
| 3591 internal type designator (string) | |
| 3592 </dd> | |
| 3593 <dt><i>progLanguage</i></dt> | |
| 3594 <dd> | |
| 3595 programming language of the project type (string) | |
| 3596 </dd> | |
| 3597 </dl> | |
| 3598 <dl> | |
| 3599 <dt>Return:</dt> | |
| 3600 <dd> | |
| 3601 flag indicating presence of the project type (boolean) | |
| 3602 </dd> | |
| 3603 </dl> | |
| 3604 <a NAME="Project.initActions" ID="Project.initActions"></a> | |
| 3605 <h4>Project.initActions</h4> | |
| 3606 <b>initActions</b>(<i></i>) | |
| 3607 | |
| 3608 <p> | |
| 3609 Public slot to initialize the project related actions. | |
| 3610 </p> | |
| 3611 <a NAME="Project.initFileTypes" ID="Project.initFileTypes"></a> | |
| 3612 <h4>Project.initFileTypes</h4> | |
| 3613 <b>initFileTypes</b>(<i></i>) | |
| 3614 | |
| 3615 <p> | |
| 3616 Public method to initialize the file type associations with default | |
| 3617 values. | |
| 3618 </p> | |
| 3619 <a NAME="Project.initMenus" ID="Project.initMenus"></a> | |
| 3620 <h4>Project.initMenus</h4> | |
| 3621 <b>initMenus</b>(<i></i>) | |
| 3622 | |
| 3623 <p> | |
| 3624 Public slot to initialize the project menus. | |
| 3625 </p> | |
| 3626 <dl> | |
| 3627 <dt>Return:</dt> | |
| 3628 <dd> | |
| 3629 tuple of generated menus | |
| 3630 </dd> | |
| 3631 </dl> | |
| 3632 <dl> | |
| 3633 <dt>Return Type:</dt> | |
| 3634 <dd> | |
| 3635 tuple of (QMenu, QMenu) | |
| 3636 </dd> | |
| 3637 </dl> | |
| 3638 <a NAME="Project.initToolbars" ID="Project.initToolbars"></a> | |
| 3639 <h4>Project.initToolbars</h4> | |
| 3640 <b>initToolbars</b>(<i>toolbarManager</i>) | |
| 3641 | |
| 3642 <p> | |
| 3643 Public slot to initialize the project toolbar and the basic VCS | |
| 3644 toolbar. | |
| 3645 </p> | |
| 3646 <dl> | |
| 3647 | |
| 3648 <dt><i>toolbarManager</i></dt> | |
| 3649 <dd> | |
| 3650 reference to a toolbar manager object | |
| 3651 (EricToolBarManager) | |
| 3652 </dd> | |
| 3653 </dl> | |
| 3654 <dl> | |
| 3655 <dt>Return:</dt> | |
| 3656 <dd> | |
| 3657 tuple of the generated toolbars (tuple of two QToolBar) | |
| 3658 </dd> | |
| 3659 </dl> | |
| 3660 <a NAME="Project.initVCS" ID="Project.initVCS"></a> | |
| 3661 <h4>Project.initVCS</h4> | |
| 3662 <b>initVCS</b>(<i>vcsSystem=None, nooverride=False</i>) | |
| 3663 | |
| 3664 <p> | |
| 3665 Public method used to instantiate a vcs system. | |
| 3666 </p> | |
| 3667 <dl> | |
| 3668 | |
| 3669 <dt><i>vcsSystem</i></dt> | |
| 3670 <dd> | |
| 3671 type of VCS to be used (string) | |
| 3672 </dd> | |
| 3673 <dt><i>nooverride</i></dt> | |
| 3674 <dd> | |
| 3675 flag indicating to ignore an override request | |
| 3676 (boolean) | |
| 3677 </dd> | |
| 3678 </dl> | |
| 3679 <dl> | |
| 3680 <dt>Return:</dt> | |
| 3681 <dd> | |
| 3682 a reference to the vcs object | |
| 3683 </dd> | |
| 3684 </dl> | |
| 3685 <a NAME="Project.isDebugPropertiesLoaded" ID="Project.isDebugPropertiesLoaded"></a> | |
| 3686 <h4>Project.isDebugPropertiesLoaded</h4> | |
| 3687 <b>isDebugPropertiesLoaded</b>(<i></i>) | |
| 3688 | |
| 3689 <p> | |
| 3690 Public method to return the status of the debug properties. | |
| 3691 </p> | |
| 3692 <dl> | |
| 3693 <dt>Return:</dt> | |
| 3694 <dd> | |
| 3695 load status of debug properties (boolean) | |
| 3696 </dd> | |
| 3697 </dl> | |
| 3698 <a NAME="Project.isDirty" ID="Project.isDirty"></a> | |
| 3699 <h4>Project.isDirty</h4> | |
| 3700 <b>isDirty</b>(<i></i>) | |
| 3701 | |
| 3702 <p> | |
| 3703 Public method to return the dirty state. | |
| 3704 </p> | |
| 3705 <dl> | |
| 3706 <dt>Return:</dt> | |
| 3707 <dd> | |
| 3708 dirty state (boolean) | |
| 3709 </dd> | |
| 3710 </dl> | |
| 3711 <a NAME="Project.isJavaScriptProject" ID="Project.isJavaScriptProject"></a> | |
| 3712 <h4>Project.isJavaScriptProject</h4> | |
| 3713 <b>isJavaScriptProject</b>(<i></i>) | |
| 3714 | |
| 3715 <p> | |
| 3716 Public method to check, if this project is a JavaScript project. | |
| 3717 </p> | |
| 3718 <dl> | |
| 3719 <dt>Return:</dt> | |
| 3720 <dd> | |
| 3721 flag indicating a JavaScript project (boolean) | |
| 3722 </dd> | |
| 3723 </dl> | |
| 3724 <a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a> | |
| 3725 <h4>Project.isMakeEnabled</h4> | |
| 3726 <b>isMakeEnabled</b>(<i></i>) | |
| 3727 | |
| 3728 <p> | |
| 3729 Public method to test, if make is enabled for the project. | |
| 3730 </p> | |
| 3731 <dl> | |
| 3732 <dt>Return:</dt> | |
| 3733 <dd> | |
| 3734 flag indicating enabled make support | |
| 3735 </dd> | |
| 3736 </dl> | |
| 3737 <dl> | |
| 3738 <dt>Return Type:</dt> | |
| 3739 <dd> | |
| 3740 bool | |
| 3741 </dd> | |
| 3742 </dl> | |
| 3743 <a NAME="Project.isMicroPythonProject" ID="Project.isMicroPythonProject"></a> | |
| 3744 <h4>Project.isMicroPythonProject</h4> | |
| 3745 <b>isMicroPythonProject</b>(<i></i>) | |
| 3746 | |
| 3747 <p> | |
| 3748 Public method to check, if this project is a MicroPython project. | |
| 3749 </p> | |
| 3750 <dl> | |
| 3751 <dt>Return:</dt> | |
| 3752 <dd> | |
| 3753 flag indicating a MicroPython project | |
| 3754 </dd> | |
| 3755 </dl> | |
| 3756 <dl> | |
| 3757 <dt>Return Type:</dt> | |
| 3758 <dd> | |
| 3759 bool | |
| 3760 </dd> | |
| 3761 </dl> | |
| 3762 <a NAME="Project.isMixedLanguageProject" ID="Project.isMixedLanguageProject"></a> | |
| 3763 <h4>Project.isMixedLanguageProject</h4> | |
| 3764 <b>isMixedLanguageProject</b>(<i></i>) | |
| 3765 | |
| 3766 <p> | |
| 3767 Public method to check, if this is a mixed language project. | |
| 3768 </p> | |
| 3769 <dl> | |
| 3770 <dt>Return:</dt> | |
| 3771 <dd> | |
| 3772 flag indicating a mixed language project | |
| 3773 </dd> | |
| 3774 </dl> | |
| 3775 <dl> | |
| 3776 <dt>Return Type:</dt> | |
| 3777 <dd> | |
| 3778 bool | |
| 3779 </dd> | |
| 3780 </dl> | |
| 3781 <a NAME="Project.isOpen" ID="Project.isOpen"></a> | |
| 3782 <h4>Project.isOpen</h4> | |
| 3783 <b>isOpen</b>(<i></i>) | |
| 3784 | |
| 3785 <p> | |
| 3786 Public method to return the opened state. | |
| 3787 </p> | |
| 3788 <dl> | |
| 3789 <dt>Return:</dt> | |
| 3790 <dd> | |
| 3791 open state (boolean) | |
| 3792 </dd> | |
| 3793 </dl> | |
| 3794 <a NAME="Project.isProjectCategory" ID="Project.isProjectCategory"></a> | |
| 3795 <h4>Project.isProjectCategory</h4> | |
| 3796 <b>isProjectCategory</b>(<i>fn, category</i>) | |
| 3797 | |
| 3798 <p> | |
| 3799 Public method to check, if the passed in filename belongs to the given | |
| 3800 category. | |
| 3801 </p> | |
| 3802 <dl> | |
| 3803 | |
| 3804 <dt><i>fn</i> (str)</dt> | |
| 3805 <dd> | |
| 3806 filename to be checked | |
| 3807 </dd> | |
| 3808 <dt><i>category</i> (str)</dt> | |
| 3809 <dd> | |
| 3810 file category to check against | |
| 3811 </dd> | |
| 3812 </dl> | |
| 3813 <dl> | |
| 3814 <dt>Return:</dt> | |
| 3815 <dd> | |
| 3816 flag indicating membership | |
| 3817 </dd> | |
| 3818 </dl> | |
| 3819 <dl> | |
| 3820 <dt>Return Type:</dt> | |
| 3821 <dd> | |
| 3822 bool | |
| 3823 </dd> | |
| 3824 </dl> | |
| 3825 <a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a> | |
| 3826 <h4>Project.isProjectFile</h4> | |
| 3827 <b>isProjectFile</b>(<i>fn</i>) | |
| 3828 | |
| 3829 <p> | |
| 3830 Public method used to check, if the passed in filename belongs to the | |
| 3831 project. | |
| 3832 </p> | |
| 3833 <dl> | |
| 3834 | |
| 3835 <dt><i>fn</i></dt> | |
| 3836 <dd> | |
| 3837 filename to be checked (string) | |
| 3838 </dd> | |
| 3839 </dl> | |
| 3840 <dl> | |
| 3841 <dt>Return:</dt> | |
| 3842 <dd> | |
| 3843 flag indicating membership (boolean) | |
| 3844 </dd> | |
| 3845 </dl> | |
| 3846 <a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a> | |
| 3847 <h4>Project.isPy3Project</h4> | |
| 3848 <b>isPy3Project</b>(<i></i>) | |
| 3849 | |
| 3850 <p> | |
| 3851 Public method to check, if this project is a Python3 project. | |
| 3852 </p> | |
| 3853 <dl> | |
| 3854 <dt>Return:</dt> | |
| 3855 <dd> | |
| 3856 flag indicating a Python3 project (boolean) | |
| 3857 </dd> | |
| 3858 </dl> | |
| 3859 <a NAME="Project.isPythonProject" ID="Project.isPythonProject"></a> | |
| 3860 <h4>Project.isPythonProject</h4> | |
| 3861 <b>isPythonProject</b>(<i></i>) | |
| 3862 | |
| 3863 <p> | |
| 3864 Public method to check, if this project is a Python3 or MicroPython | |
| 3865 project. | |
| 3866 </p> | |
| 3867 <dl> | |
| 3868 <dt>Return:</dt> | |
| 3869 <dd> | |
| 3870 flag indicating a Python project (boolean) | |
| 3871 </dd> | |
| 3872 </dl> | |
| 3873 <a NAME="Project.isRubyProject" ID="Project.isRubyProject"></a> | |
| 3874 <h4>Project.isRubyProject</h4> | |
| 3875 <b>isRubyProject</b>(<i></i>) | |
| 3876 | |
| 3877 <p> | |
| 3878 Public method to check, if this project is a Ruby project. | |
| 3879 </p> | |
| 3880 <dl> | |
| 3881 <dt>Return:</dt> | |
| 3882 <dd> | |
| 3883 flag indicating a Ruby project (boolean) | |
| 3884 </dd> | |
| 3885 </dl> | |
| 3886 <a NAME="Project.isVcsControlled" ID="Project.isVcsControlled"></a> | |
| 3887 <h4>Project.isVcsControlled</h4> | |
| 3888 <b>isVcsControlled</b>(<i></i>) | |
| 3889 | |
| 3890 <p> | |
| 3891 Public method to check, if the project is controlled by a VCS. | |
| 3892 </p> | |
| 3893 <dl> | |
| 3894 <dt>Return:</dt> | |
| 3895 <dd> | |
| 3896 flag indicating a VCS controlled project | |
| 3897 </dd> | |
| 3898 </dl> | |
| 3899 <dl> | |
| 3900 <dt>Return Type:</dt> | |
| 3901 <dd> | |
| 3902 bool | |
| 3903 </dd> | |
| 3904 </dl> | |
| 3905 <a NAME="Project.moveDirectory" ID="Project.moveDirectory"></a> | |
| 3906 <h4>Project.moveDirectory</h4> | |
| 3907 <b>moveDirectory</b>(<i>olddn, newdn</i>) | |
| 3908 | |
| 3909 <p> | |
| 3910 Public slot to move a directory. | |
| 3911 </p> | |
| 3912 <dl> | |
| 3913 | |
| 3914 <dt><i>olddn</i></dt> | |
| 3915 <dd> | |
| 3916 old directory name (string) | |
| 3917 </dd> | |
| 3918 <dt><i>newdn</i></dt> | |
| 3919 <dd> | |
| 3920 new directory name (string) | |
| 3921 </dd> | |
| 3922 </dl> | |
| 3923 <a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a> | |
| 3924 <h4>Project.newProjectAddFiles</h4> | |
| 3925 <b>newProjectAddFiles</b>(<i>mainscript</i>) | |
| 3926 | |
| 3927 <p> | |
| 3928 Public method to add files to a new project. | |
| 3929 </p> | |
| 3930 <dl> | |
| 3931 | |
| 3932 <dt><i>mainscript</i></dt> | |
| 3933 <dd> | |
| 3934 name of the mainscript (string) | |
| 3935 </dd> | |
| 3936 </dl> | |
| 3937 <a NAME="Project.openProject" ID="Project.openProject"></a> | |
| 3938 <h4>Project.openProject</h4> | |
| 3939 <b>openProject</b>(<i>fn=None, restoreSession=True, reopen=False</i>) | |
| 3940 | |
| 3941 <p> | |
| 3942 Public slot to open a project. | |
| 3943 </p> | |
| 3944 <dl> | |
| 3945 | |
| 3946 <dt><i>fn</i></dt> | |
| 3947 <dd> | |
| 3948 optional filename of the project file to be read | |
| 3949 </dd> | |
| 3950 <dt><i>restoreSession</i></dt> | |
| 3951 <dd> | |
| 3952 flag indicating to restore the project | |
| 3953 session (boolean) | |
| 3954 </dd> | |
| 3955 <dt><i>reopen</i></dt> | |
| 3956 <dd> | |
| 3957 flag indicating a reopening of the project (boolean) | |
| 3958 </dd> | |
| 3959 </dl> | |
| 3960 <a NAME="Project.othersAdded" ID="Project.othersAdded"></a> | |
| 3961 <h4>Project.othersAdded</h4> | |
| 3962 <b>othersAdded</b>(<i>fn, updateModel=True</i>) | |
| 3963 | |
| 3964 <p> | |
| 3965 Public slot to be called, if something was added to the OTHERS project | |
| 3966 data area. | |
| 3967 </p> | |
| 3968 <dl> | |
| 3969 | |
| 3970 <dt><i>fn</i></dt> | |
| 3971 <dd> | |
| 3972 filename or directory name added (string) | |
| 3973 </dd> | |
| 3974 <dt><i>updateModel</i></dt> | |
| 3975 <dd> | |
| 3976 flag indicating an update of the model is requested | |
| 3977 (boolean) | |
| 3978 </dd> | |
| 3979 </dl> | |
| 3980 <a NAME="Project.registerProjectType" ID="Project.registerProjectType"></a> | |
| 3981 <h4>Project.registerProjectType</h4> | |
| 3982 <b>registerProjectType</b>(<i>type_, description, fileTypeCallback=None, binaryTranslationsCallback=None, lexerAssociationCallback=None, progLanguages=None, </i>) | |
| 3983 | |
| 3984 <p> | |
| 3985 Public method to register a project type. | |
| 3986 </p> | |
| 3987 <dl> | |
| 3988 | |
| 3989 <dt><i>type_</i></dt> | |
| 3990 <dd> | |
| 3991 internal type designator to be registered (string) | |
| 3992 </dd> | |
| 3993 <dt><i>description</i></dt> | |
| 3994 <dd> | |
| 3995 more verbose type name (display string) (string) | |
| 3996 </dd> | |
| 3997 <dt><i>fileTypeCallback</i></dt> | |
| 3998 <dd> | |
| 3999 reference to a method returning a dictionary | |
| 4000 of filetype associations. | |
| 4001 </dd> | |
| 4002 <dt><i>binaryTranslationsCallback</i></dt> | |
| 4003 <dd> | |
| 4004 reference to a method returning | |
| 4005 the name of the binary translation file given the name of the raw | |
| 4006 translation file | |
| 4007 </dd> | |
| 4008 <dt><i>lexerAssociationCallback</i></dt> | |
| 4009 <dd> | |
| 4010 reference to a method returning the | |
| 4011 lexer type to be used for syntax highlighting given the name of | |
| 4012 a file | |
| 4013 </dd> | |
| 4014 <dt><i>progLanguages</i></dt> | |
| 4015 <dd> | |
| 4016 programming languages supported by the | |
| 4017 project type (list of string) | |
| 4018 </dd> | |
| 4019 </dl> | |
| 4020 <a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a> | |
| 4021 <h4>Project.removeDirectory</h4> | |
| 4022 <b>removeDirectory</b>(<i>dn</i>) | |
| 4023 | |
| 4024 <p> | |
| 4025 Public method to remove a directory from the project. | |
| 4026 </p> | |
| 4027 <p> | |
| 4028 The directory is not deleted from the project directory. | |
| 4029 </p> | |
| 4030 <dl> | |
| 4031 | |
| 4032 <dt><i>dn</i></dt> | |
| 4033 <dd> | |
| 4034 directory name to be removed from the project | |
| 4035 </dd> | |
| 4036 </dl> | |
| 4037 <a NAME="Project.removeEricActions" ID="Project.removeEricActions"></a> | |
| 4038 <h4>Project.removeEricActions</h4> | |
| 4039 <b>removeEricActions</b>(<i>actions</i>) | |
| 4040 | |
| 4041 <p> | |
| 4042 Public method to remove actions from the list of actions. | |
| 4043 </p> | |
| 4044 <dl> | |
| 4045 | |
| 4046 <dt><i>actions</i></dt> | |
| 4047 <dd> | |
| 4048 list of actions (list of EricAction) | |
| 4049 </dd> | |
| 4050 </dl> | |
| 4051 <a NAME="Project.removeFile" ID="Project.removeFile"></a> | |
| 4052 <h4>Project.removeFile</h4> | |
| 4053 <b>removeFile</b>(<i>fn, updateModel=True</i>) | |
| 4054 | |
| 4055 <p> | |
| 4056 Public slot to remove a file from the project. | |
| 4057 </p> | |
| 4058 <p> | |
| 4059 The file is not deleted from the project directory. | |
| 4060 </p> | |
| 4061 <dl> | |
| 4062 | |
| 4063 <dt><i>fn</i></dt> | |
| 4064 <dd> | |
| 4065 filename to be removed from the project | |
| 4066 </dd> | |
| 4067 <dt><i>updateModel</i></dt> | |
| 4068 <dd> | |
| 4069 flag indicating an update of the model is | |
| 4070 requested (boolean) | |
| 4071 </dd> | |
| 4072 </dl> | |
| 4073 <a NAME="Project.removeFileCategory" ID="Project.removeFileCategory"></a> | |
| 4074 <h4>Project.removeFileCategory</h4> | |
| 4075 <b>removeFileCategory</b>(<i>category</i>) | |
| 4076 | |
| 4077 <p> | |
| 4078 Public method to remove a category from the categories repository. | |
| 4079 </p> | |
| 4080 <p> | |
| 4081 Note: If the category is not contained in the repository, the request to | |
| 4082 remove it will be ignored silently. | |
| 4083 </p> | |
| 4084 <dl> | |
| 4085 | |
| 4086 <dt><i>category</i> (str)</dt> | |
| 4087 <dd> | |
| 4088 file category | |
| 4089 </dd> | |
| 4090 </dl> | |
| 4091 <a NAME="Project.removeLanguageFile" ID="Project.removeLanguageFile"></a> | |
| 4092 <h4>Project.removeLanguageFile</h4> | |
| 4093 <b>removeLanguageFile</b>(<i>langFile</i>) | |
| 4094 | |
| 4095 <p> | |
| 4096 Public slot to remove a translation from the project. | |
| 4097 </p> | |
| 4098 <p> | |
| 4099 The translation file is not deleted from the project directory. | |
| 4100 </p> | |
| 4101 <dl> | |
| 4102 | |
| 4103 <dt><i>langFile</i></dt> | |
| 4104 <dd> | |
| 4105 the translation file to be removed (string) | |
| 4106 </dd> | |
| 4107 </dl> | |
| 4108 <a NAME="Project.renameFile" ID="Project.renameFile"></a> | |
| 4109 <h4>Project.renameFile</h4> | |
| 4110 <b>renameFile</b>(<i>oldfn, newfn=None</i>) | |
| 4111 | |
| 4112 <p> | |
| 4113 Public slot to rename a file of the project. | |
| 4114 </p> | |
| 4115 <dl> | |
| 4116 | |
| 4117 <dt><i>oldfn</i></dt> | |
| 4118 <dd> | |
| 4119 old filename of the file (string) | |
| 4120 </dd> | |
| 4121 <dt><i>newfn</i></dt> | |
| 4122 <dd> | |
| 4123 new filename of the file (string) | |
| 4124 </dd> | |
| 4125 </dl> | |
| 4126 <dl> | |
| 4127 <dt>Return:</dt> | |
| 4128 <dd> | |
| 4129 flag indicating success | |
| 4130 </dd> | |
| 4131 </dl> | |
| 4132 <a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a> | |
| 4133 <h4>Project.renameFileInPdata</h4> | |
| 4134 <b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile=False</i>) | |
| 4135 | |
| 4136 <p> | |
| 4137 Public method to rename a file in the __pdata structure. | |
| 4138 </p> | |
| 4139 <dl> | |
| 4140 | |
| 4141 <dt><i>oldname</i></dt> | |
| 4142 <dd> | |
| 4143 old filename (string) | |
| 4144 </dd> | |
| 4145 <dt><i>newname</i></dt> | |
| 4146 <dd> | |
| 4147 new filename (string) | |
| 4148 </dd> | |
| 4149 <dt><i>isSourceFile</i></dt> | |
| 4150 <dd> | |
| 4151 flag indicating that this is a source file | |
| 4152 even if it doesn't have the source extension (boolean) | |
| 4153 </dd> | |
| 4154 </dl> | |
| 4155 <a NAME="Project.renameMainScript" ID="Project.renameMainScript"></a> | |
| 4156 <h4>Project.renameMainScript</h4> | |
| 4157 <b>renameMainScript</b>(<i>oldfn, newfn</i>) | |
| 4158 | |
| 4159 <p> | |
| 4160 Public method to rename the main script. | |
| 4161 </p> | |
| 4162 <dl> | |
| 4163 | |
| 4164 <dt><i>oldfn</i></dt> | |
| 4165 <dd> | |
| 4166 old filename (string) | |
| 4167 </dd> | |
| 4168 <dt><i>newfn</i></dt> | |
| 4169 <dd> | |
| 4170 new filename of the main script (string) | |
| 4171 </dd> | |
| 4172 </dl> | |
| 4173 <a NAME="Project.reopenProject" ID="Project.reopenProject"></a> | |
| 4174 <h4>Project.reopenProject</h4> | |
| 4175 <b>reopenProject</b>(<i></i>) | |
| 4176 | |
| 4177 <p> | |
| 4178 Public slot to reopen the current project. | |
| 4179 </p> | |
| 4180 <a NAME="Project.repopulateItem" ID="Project.repopulateItem"></a> | |
| 4181 <h4>Project.repopulateItem</h4> | |
| 4182 <b>repopulateItem</b>(<i>fullname</i>) | |
| 4183 | |
| 4184 <p> | |
| 4185 Public slot to repopulate a named item. | |
| 4186 </p> | |
| 4187 <dl> | |
| 4188 | |
| 4189 <dt><i>fullname</i></dt> | |
| 4190 <dd> | |
| 4191 full name of the item to repopulate (string) | |
| 4192 </dd> | |
| 4193 </dl> | |
| 4194 <a NAME="Project.resetVCS" ID="Project.resetVCS"></a> | |
| 4195 <h4>Project.resetVCS</h4> | |
| 4196 <b>resetVCS</b>(<i></i>) | |
| 4197 | |
| 4198 <p> | |
| 4199 Public method to reset the VCS. | |
| 4200 </p> | |
| 4201 <a NAME="Project.saveAllScripts" ID="Project.saveAllScripts"></a> | |
| 4202 <h4>Project.saveAllScripts</h4> | |
| 4203 <b>saveAllScripts</b>(<i>reportSyntaxErrors=False</i>) | |
| 4204 | |
| 4205 <p> | |
| 4206 Public method to save all scripts belonging to the project. | |
| 4207 </p> | |
| 4208 <dl> | |
| 4209 | |
| 4210 <dt><i>reportSyntaxErrors</i></dt> | |
| 4211 <dd> | |
| 4212 flag indicating special reporting | |
| 4213 for syntax errors (boolean) | |
| 4214 </dd> | |
| 4215 </dl> | |
| 4216 <dl> | |
| 4217 <dt>Return:</dt> | |
| 4218 <dd> | |
| 4219 flag indicating success (boolean) | |
| 4220 </dd> | |
| 4221 </dl> | |
| 4222 <a NAME="Project.saveProject" ID="Project.saveProject"></a> | |
| 4223 <h4>Project.saveProject</h4> | |
| 4224 <b>saveProject</b>(<i></i>) | |
| 4225 | |
| 4226 <p> | |
| 4227 Public slot to save the current project. | |
| 4228 </p> | |
| 4229 <dl> | |
| 4230 <dt>Return:</dt> | |
| 4231 <dd> | |
| 4232 flag indicating success | |
| 4233 </dd> | |
| 4234 </dl> | |
| 4235 <a NAME="Project.saveProjectAs" ID="Project.saveProjectAs"></a> | |
| 4236 <h4>Project.saveProjectAs</h4> | |
| 4237 <b>saveProjectAs</b>(<i></i>) | |
| 4238 | |
| 4239 <p> | |
| 4240 Public slot to save the current project to a different file. | |
| 4241 </p> | |
| 4242 <dl> | |
| 4243 <dt>Return:</dt> | |
| 4244 <dd> | |
| 4245 flag indicating success (boolean) | |
| 4246 </dd> | |
| 4247 </dl> | |
| 4248 <a NAME="Project.setData" ID="Project.setData"></a> | |
| 4249 <h4>Project.setData</h4> | |
| 4250 <b>setData</b>(<i>category, key, data</i>) | |
| 4251 | |
| 4252 <p> | |
| 4253 Public method to store data in the project data store. | |
| 2463 </p> | 4254 </p> |
| 2464 <dl> | 4255 <dl> |
| 2465 | 4256 |
| 2466 <dt><i>category</i></dt> | 4257 <dt><i>category</i></dt> |
| 2467 <dd> | 4258 <dd> |
| 2471 </dd> | 4262 </dd> |
| 2472 <dt><i>key</i></dt> | 4263 <dt><i>key</i></dt> |
| 2473 <dd> | 4264 <dd> |
| 2474 key of the data entry to get (string). | 4265 key of the data entry to get (string). |
| 2475 </dd> | 4266 </dd> |
| 2476 </dl> | |
| 2477 <dl> | |
| 2478 <dt>Return:</dt> | |
| 2479 <dd> | |
| 2480 a copy of the requested data or None | |
| 2481 </dd> | |
| 2482 </dl> | |
| 2483 <a NAME="Project.getDebugProperty" ID="Project.getDebugProperty"></a> | |
| 2484 <h4>Project.getDebugProperty</h4> | |
| 2485 <b>getDebugProperty</b>(<i>key</i>) | |
| 2486 | |
| 2487 <p> | |
| 2488 Public method to retrieve a debugger property. | |
| 2489 </p> | |
| 2490 <dl> | |
| 2491 | |
| 2492 <dt><i>key</i></dt> | |
| 2493 <dd> | |
| 2494 key of the property (string) | |
| 2495 </dd> | |
| 2496 </dl> | |
| 2497 <dl> | |
| 2498 <dt>Return:</dt> | |
| 2499 <dd> | |
| 2500 value of the property | |
| 2501 </dd> | |
| 2502 </dl> | |
| 2503 <a NAME="Project.getDebuggerFilters" ID="Project.getDebuggerFilters"></a> | |
| 2504 <h4>Project.getDebuggerFilters</h4> | |
| 2505 <b>getDebuggerFilters</b>(<i>language</i>) | |
| 2506 | |
| 2507 <p> | |
| 2508 Public method to get the debugger filters for a programming language. | |
| 2509 </p> | |
| 2510 <dl> | |
| 2511 | |
| 2512 <dt><i>language</i> (str)</dt> | |
| 2513 <dd> | |
| 2514 programming language | |
| 2515 </dd> | |
| 2516 </dl> | |
| 2517 <dl> | |
| 2518 <dt>Return:</dt> | |
| 2519 <dd> | |
| 2520 filter string | |
| 2521 </dd> | |
| 2522 </dl> | |
| 2523 <dl> | |
| 2524 <dt>Return Type:</dt> | |
| 2525 <dd> | |
| 2526 str | |
| 2527 </dd> | |
| 2528 </dl> | |
| 2529 <a NAME="Project.getDefaultRccCompilerParameters" ID="Project.getDefaultRccCompilerParameters"></a> | |
| 2530 <h4>Project.getDefaultRccCompilerParameters</h4> | |
| 2531 <b>getDefaultRccCompilerParameters</b>(<i></i>) | |
| 2532 | |
| 2533 <p> | |
| 2534 Public method to get the default rcc compiler parameters. | |
| 2535 </p> | |
| 2536 <dl> | |
| 2537 <dt>Return:</dt> | |
| 2538 <dd> | |
| 2539 dictionary containing the default rcc compiler parameters | |
| 2540 </dd> | |
| 2541 </dl> | |
| 2542 <dl> | |
| 2543 <dt>Return Type:</dt> | |
| 2544 <dd> | |
| 2545 dict | |
| 2546 </dd> | |
| 2547 </dl> | |
| 2548 <a NAME="Project.getDefaultSourceExtension" ID="Project.getDefaultSourceExtension"></a> | |
| 2549 <h4>Project.getDefaultSourceExtension</h4> | |
| 2550 <b>getDefaultSourceExtension</b>(<i></i>) | |
| 2551 | |
| 2552 <p> | |
| 2553 Public method to get the default extension for the project's | |
| 2554 programming language. | |
| 2555 </p> | |
| 2556 <dl> | |
| 2557 <dt>Return:</dt> | |
| 2558 <dd> | |
| 2559 default extension (including the dot) (string) | |
| 2560 </dd> | |
| 2561 </dl> | |
| 2562 <a NAME="Project.getDocstringType" ID="Project.getDocstringType"></a> | |
| 2563 <h4>Project.getDocstringType</h4> | |
| 2564 <b>getDocstringType</b>(<i></i>) | |
| 2565 | |
| 2566 <p> | |
| 2567 Public method to get the configured docstring style. | |
| 2568 </p> | |
| 2569 <dl> | |
| 2570 <dt>Return:</dt> | |
| 2571 <dd> | |
| 2572 configured docstring style | |
| 2573 </dd> | |
| 2574 </dl> | |
| 2575 <dl> | |
| 2576 <dt>Return Type:</dt> | |
| 2577 <dd> | |
| 2578 str | |
| 2579 </dd> | |
| 2580 </dl> | |
| 2581 <a NAME="Project.getEditorLexerAssoc" ID="Project.getEditorLexerAssoc"></a> | |
| 2582 <h4>Project.getEditorLexerAssoc</h4> | |
| 2583 <b>getEditorLexerAssoc</b>(<i>filename</i>) | |
| 2584 | |
| 2585 <p> | |
| 2586 Public method to retrieve a lexer association. | |
| 2587 </p> | |
| 2588 <dl> | |
| 2589 | |
| 2590 <dt><i>filename</i></dt> | |
| 2591 <dd> | |
| 2592 filename used to determine the associated lexer | |
| 2593 language (string) | |
| 2594 </dd> | |
| 2595 </dl> | |
| 2596 <dl> | |
| 2597 <dt>Return:</dt> | |
| 2598 <dd> | |
| 2599 the requested lexer language (string) | |
| 2600 </dd> | |
| 2601 </dl> | |
| 2602 <a NAME="Project.getEolString" ID="Project.getEolString"></a> | |
| 2603 <h4>Project.getEolString</h4> | |
| 2604 <b>getEolString</b>(<i></i>) | |
| 2605 | |
| 2606 <p> | |
| 2607 Public method to get the EOL-string to be used by the project. | |
| 2608 </p> | |
| 2609 <dl> | |
| 2610 <dt>Return:</dt> | |
| 2611 <dd> | |
| 2612 eol string (string) | |
| 2613 </dd> | |
| 2614 </dl> | |
| 2615 <a NAME="Project.getFileCategories" ID="Project.getFileCategories"></a> | |
| 2616 <h4>Project.getFileCategories</h4> | |
| 2617 <b>getFileCategories</b>(<i></i>) | |
| 2618 | |
| 2619 <p> | |
| 2620 Public method to get the list of known file categories. | |
| 2621 </p> | |
| 2622 <dl> | |
| 2623 <dt>Return:</dt> | |
| 2624 <dd> | |
| 2625 list of known file categories | |
| 2626 </dd> | |
| 2627 </dl> | |
| 2628 <dl> | |
| 2629 <dt>Return Type:</dt> | |
| 2630 <dd> | |
| 2631 list of str | |
| 2632 </dd> | |
| 2633 </dl> | |
| 2634 <a NAME="Project.getFileCategoryExtension" ID="Project.getFileCategoryExtension"></a> | |
| 2635 <h4>Project.getFileCategoryExtension</h4> | |
| 2636 <b>getFileCategoryExtension</b>(<i>category, reverse=False</i>) | |
| 2637 | |
| 2638 <p> | |
| 2639 Public method to get a list of default file extensions for the given category. | |
| 2640 </p> | |
| 2641 <dl> | |
| 2642 | |
| 2643 <dt><i>category</i> (str)</dt> | |
| 2644 <dd> | |
| 2645 file type category | |
| 2646 </dd> | |
| 2647 <dt><i>reverse</i> (bool)</dt> | |
| 2648 <dd> | |
| 2649 flag indicating to get all other extensions except the one of | |
| 2650 the given category | |
| 2651 </dd> | |
| 2652 </dl> | |
| 2653 <dl> | |
| 2654 <dt>Return:</dt> | |
| 2655 <dd> | |
| 2656 list of default file extensions for the category | |
| 2657 </dd> | |
| 2658 </dl> | |
| 2659 <dl> | |
| 2660 <dt>Return Type:</dt> | |
| 2661 <dd> | |
| 2662 list of str | |
| 2663 </dd> | |
| 2664 </dl> | |
| 2665 <a NAME="Project.getFileCategoryFilterString" ID="Project.getFileCategoryFilterString"></a> | |
| 2666 <h4>Project.getFileCategoryFilterString</h4> | |
| 2667 <b>getFileCategoryFilterString</b>(<i>categories=None, withOthers=False, withAll=True</i>) | |
| 2668 | |
| 2669 <p> | |
| 2670 Public method to get a file selection string for the given categories. | |
| 2671 </p> | |
| 2672 <dl> | |
| 2673 | |
| 2674 <dt><i>categories</i> (list of str (optional))</dt> | |
| 2675 <dd> | |
| 2676 list of file type categories (defaults to None). | |
| 2677 A value of None means all categories except 'OTHERS'. | |
| 2678 </dd> | |
| 2679 <dt><i>withOthers</i> (bool (optional))</dt> | |
| 2680 <dd> | |
| 2681 flag indicating to include the 'OTHERS' category | |
| 2682 (defaults to False) | |
| 2683 </dd> | |
| 2684 <dt><i>withAll</i> (bool (optional))</dt> | |
| 2685 <dd> | |
| 2686 flag indicating to include a filter for 'All Files' | |
| 2687 (defaults to True) | |
| 2688 </dd> | |
| 2689 </dl> | |
| 2690 <dl> | |
| 2691 <dt>Return:</dt> | |
| 2692 <dd> | |
| 2693 file selection filter string | |
| 2694 </dd> | |
| 2695 </dl> | |
| 2696 <dl> | |
| 2697 <dt>Return Type:</dt> | |
| 2698 <dd> | |
| 2699 str | |
| 2700 </dd> | |
| 2701 </dl> | |
| 2702 <a NAME="Project.getFileCategoryString" ID="Project.getFileCategoryString"></a> | |
| 2703 <h4>Project.getFileCategoryString</h4> | |
| 2704 <b>getFileCategoryString</b>(<i>category</i>) | |
| 2705 | |
| 2706 <p> | |
| 2707 Public method to get a user string for the given category. | |
| 2708 </p> | |
| 2709 <dl> | |
| 2710 | |
| 2711 <dt><i>category</i> (str)</dt> | |
| 2712 <dd> | |
| 2713 file type category | |
| 2714 </dd> | |
| 2715 </dl> | |
| 2716 <dl> | |
| 2717 <dt>Return:</dt> | |
| 2718 <dd> | |
| 2719 user string for the category | |
| 2720 </dd> | |
| 2721 </dl> | |
| 2722 <dl> | |
| 2723 <dt>Return Type:</dt> | |
| 2724 <dd> | |
| 2725 str | |
| 2726 </dd> | |
| 2727 </dl> | |
| 2728 <a NAME="Project.getFileCategoryType" ID="Project.getFileCategoryType"></a> | |
| 2729 <h4>Project.getFileCategoryType</h4> | |
| 2730 <b>getFileCategoryType</b>(<i>category</i>) | |
| 2731 | |
| 2732 <p> | |
| 2733 Public method to get a user type string for the given category. | |
| 2734 </p> | |
| 2735 <dl> | |
| 2736 | |
| 2737 <dt><i>category</i> (str)</dt> | |
| 2738 <dd> | |
| 2739 file type category | |
| 2740 </dd> | |
| 2741 </dl> | |
| 2742 <dl> | |
| 2743 <dt>Return:</dt> | |
| 2744 <dd> | |
| 2745 user type string for the category | |
| 2746 </dd> | |
| 2747 </dl> | |
| 2748 <dl> | |
| 2749 <dt>Return Type:</dt> | |
| 2750 <dd> | |
| 2751 str | |
| 2752 </dd> | |
| 2753 </dl> | |
| 2754 <a NAME="Project.getFiles" ID="Project.getFiles"></a> | |
| 2755 <h4>Project.getFiles</h4> | |
| 2756 <b>getFiles</b>(<i>start</i>) | |
| 2757 | |
| 2758 <p> | |
| 2759 Public method to get all files starting with a common prefix. | |
| 2760 </p> | |
| 2761 <dl> | |
| 2762 | |
| 2763 <dt><i>start</i></dt> | |
| 2764 <dd> | |
| 2765 prefix (string) | |
| 2766 </dd> | |
| 2767 </dl> | |
| 2768 <dl> | |
| 2769 <dt>Return:</dt> | |
| 2770 <dd> | |
| 2771 list of files starting with a common prefix (list of strings) | |
| 2772 </dd> | |
| 2773 </dl> | |
| 2774 <a NAME="Project.getFiletypeAssociations" ID="Project.getFiletypeAssociations"></a> | |
| 2775 <h4>Project.getFiletypeAssociations</h4> | |
| 2776 <b>getFiletypeAssociations</b>(<i>associationType</i>) | |
| 2777 | |
| 2778 <p> | |
| 2779 Public method to get the list of file type associations for | |
| 2780 the given association type. | |
| 2781 </p> | |
| 2782 <dl> | |
| 2783 | |
| 2784 <dt><i>associationType</i> (str)</dt> | |
| 2785 <dd> | |
| 2786 type of the association (one of the known file categories | |
| 2787 or __IGNORE__) | |
| 2788 </dd> | |
| 2789 </dl> | |
| 2790 <dl> | |
| 2791 <dt>Return:</dt> | |
| 2792 <dd> | |
| 2793 list of file patterns for the given type | |
| 2794 </dd> | |
| 2795 </dl> | |
| 2796 <dl> | |
| 2797 <dt>Return Type:</dt> | |
| 2798 <dd> | |
| 2799 list of str | |
| 2800 </dd> | |
| 2801 </dl> | |
| 2802 <a NAME="Project.getHash" ID="Project.getHash"></a> | |
| 2803 <h4>Project.getHash</h4> | |
| 2804 <b>getHash</b>(<i></i>) | |
| 2805 | |
| 2806 <p> | |
| 2807 Public method to get the project hash. | |
| 2808 </p> | |
| 2809 <dl> | |
| 2810 <dt>Return:</dt> | |
| 2811 <dd> | |
| 2812 project hash as a hex string (string) | |
| 2813 </dd> | |
| 2814 </dl> | |
| 2815 <a NAME="Project.getIgnorePatterns" ID="Project.getIgnorePatterns"></a> | |
| 2816 <h4>Project.getIgnorePatterns</h4> | |
| 2817 <b>getIgnorePatterns</b>(<i></i>) | |
| 2818 | |
| 2819 <p> | |
| 2820 Public method to get the list of file name patterns for files to be | |
| 2821 ignored. | |
| 2822 </p> | |
| 2823 <dl> | |
| 2824 <dt>Return:</dt> | |
| 2825 <dd> | |
| 2826 list of ignore file name patterns | |
| 2827 </dd> | |
| 2828 </dl> | |
| 2829 <dl> | |
| 2830 <dt>Return Type:</dt> | |
| 2831 <dd> | |
| 2832 list of str | |
| 2833 </dd> | |
| 2834 </dl> | |
| 2835 <a NAME="Project.getMainScript" ID="Project.getMainScript"></a> | |
| 2836 <h4>Project.getMainScript</h4> | |
| 2837 <b>getMainScript</b>(<i>normalized=False</i>) | |
| 2838 | |
| 2839 <p> | |
| 2840 Public method to return the main script filename. | |
| 2841 </p> | |
| 2842 <p> | |
| 2843 The normalized name is the name of the main script prepended with | |
| 2844 the project path. | |
| 2845 </p> | |
| 2846 <dl> | |
| 2847 | |
| 2848 <dt><i>normalized</i> (bool)</dt> | |
| 2849 <dd> | |
| 2850 flag indicating a normalized filename is wanted | |
| 2851 </dd> | |
| 2852 </dl> | |
| 2853 <dl> | |
| 2854 <dt>Return:</dt> | |
| 2855 <dd> | |
| 2856 filename of the projects main script | |
| 2857 </dd> | |
| 2858 </dl> | |
| 2859 <dl> | |
| 2860 <dt>Return Type:</dt> | |
| 2861 <dd> | |
| 2862 str | |
| 2863 </dd> | |
| 2864 </dl> | |
| 2865 <a NAME="Project.getMenu" ID="Project.getMenu"></a> | |
| 2866 <h4>Project.getMenu</h4> | |
| 2867 <b>getMenu</b>(<i>menuName</i>) | |
| 2868 | |
| 2869 <p> | |
| 2870 Public method to get a reference to the main menu or a submenu. | |
| 2871 </p> | |
| 2872 <dl> | |
| 2873 | |
| 2874 <dt><i>menuName</i></dt> | |
| 2875 <dd> | |
| 2876 name of the menu (string) | |
| 2877 </dd> | |
| 2878 </dl> | |
| 2879 <dl> | |
| 2880 <dt>Return:</dt> | |
| 2881 <dd> | |
| 2882 reference to the requested menu (QMenu) or None | |
| 2883 </dd> | |
| 2884 </dl> | |
| 2885 <a NAME="Project.getModel" ID="Project.getModel"></a> | |
| 2886 <h4>Project.getModel</h4> | |
| 2887 <b>getModel</b>(<i></i>) | |
| 2888 | |
| 2889 <p> | |
| 2890 Public method to get a reference to the project browser model. | |
| 2891 </p> | |
| 2892 <dl> | |
| 2893 <dt>Return:</dt> | |
| 2894 <dd> | |
| 2895 reference to the project browser model (ProjectBrowserModel) | |
| 2896 </dd> | |
| 2897 </dl> | |
| 2898 <a NAME="Project.getMostRecent" ID="Project.getMostRecent"></a> | |
| 2899 <h4>Project.getMostRecent</h4> | |
| 2900 <b>getMostRecent</b>(<i></i>) | |
| 2901 | |
| 2902 <p> | |
| 2903 Public method to get the most recently opened project. | |
| 2904 </p> | |
| 2905 <dl> | |
| 2906 <dt>Return:</dt> | |
| 2907 <dd> | |
| 2908 path of the most recently opened project (string) | |
| 2909 </dd> | |
| 2910 </dl> | |
| 2911 <a NAME="Project.getProgrammingLanguages" ID="Project.getProgrammingLanguages"></a> | |
| 2912 <h4>Project.getProgrammingLanguages</h4> | |
| 2913 <b>getProgrammingLanguages</b>(<i></i>) | |
| 2914 | |
| 2915 <p> | |
| 2916 Public method to get the programming languages supported by project. | |
| 2917 </p> | |
| 2918 <dl> | |
| 2919 <dt>Return:</dt> | |
| 2920 <dd> | |
| 2921 list of supported programming languages (list of string) | |
| 2922 </dd> | |
| 2923 </dl> | |
| 2924 <a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a> | |
| 2925 <h4>Project.getProjectAuthor</h4> | |
| 2926 <b>getProjectAuthor</b>(<i></i>) | |
| 2927 | |
| 2928 <p> | |
| 2929 Public method to get the author of the project. | |
| 2930 </p> | |
| 2931 <dl> | |
| 2932 <dt>Return:</dt> | |
| 2933 <dd> | |
| 2934 author name | |
| 2935 </dd> | |
| 2936 </dl> | |
| 2937 <dl> | |
| 2938 <dt>Return Type:</dt> | |
| 2939 <dd> | |
| 2940 str | |
| 2941 </dd> | |
| 2942 </dl> | |
| 2943 <a NAME="Project.getProjectAuthorEmail" ID="Project.getProjectAuthorEmail"></a> | |
| 2944 <h4>Project.getProjectAuthorEmail</h4> | |
| 2945 <b>getProjectAuthorEmail</b>(<i></i>) | |
| 2946 | |
| 2947 <p> | |
| 2948 Public method to get the email address of the project author. | |
| 2949 </p> | |
| 2950 <dl> | |
| 2951 <dt>Return:</dt> | |
| 2952 <dd> | |
| 2953 project author email | |
| 2954 </dd> | |
| 2955 </dl> | |
| 2956 <dl> | |
| 2957 <dt>Return Type:</dt> | |
| 2958 <dd> | |
| 2959 str | |
| 2960 </dd> | |
| 2961 </dl> | |
| 2962 <a NAME="Project.getProjectData" ID="Project.getProjectData"></a> | |
| 2963 <h4>Project.getProjectData</h4> | |
| 2964 <b>getProjectData</b>(<i>dataKey=None, default=None</i>) | |
| 2965 | |
| 2966 <p> | |
| 2967 Public method to get the data associated with the given data key. | |
| 2968 </p> | |
| 2969 <p> | |
| 2970 Note: If dataKey is None, a copy of the project data structure | |
| 2971 is returned. | |
| 2972 </p> | |
| 2973 <dl> | |
| 2974 | |
| 2975 <dt><i>dataKey</i> (str (optional))</dt> | |
| 2976 <dd> | |
| 2977 key of the data to get (defaults to None) | |
| 2978 </dd> | |
| 2979 <dt><i>default</i> (Any (optional))</dt> | |
| 2980 <dd> | |
| 2981 default value for non-existent keys (defaults to None) | |
| 2982 </dd> | |
| 2983 </dl> | |
| 2984 <dl> | |
| 2985 <dt>Return:</dt> | |
| 2986 <dd> | |
| 2987 requested data or None if the data key doesn't exist or | |
| 2988 a copy of the project data dictionary | |
| 2989 </dd> | |
| 2990 </dl> | |
| 2991 <dl> | |
| 2992 <dt>Return Type:</dt> | |
| 2993 <dd> | |
| 2994 Any | |
| 2995 </dd> | |
| 2996 </dl> | |
| 2997 <a NAME="Project.getProjectDescription" ID="Project.getProjectDescription"></a> | |
| 2998 <h4>Project.getProjectDescription</h4> | |
| 2999 <b>getProjectDescription</b>(<i></i>) | |
| 3000 | |
| 3001 <p> | |
| 3002 Public method to get the description of the project. | |
| 3003 </p> | |
| 3004 <dl> | |
| 3005 <dt>Return:</dt> | |
| 3006 <dd> | |
| 3007 project description | |
| 3008 </dd> | |
| 3009 </dl> | |
| 3010 <dl> | |
| 3011 <dt>Return Type:</dt> | |
| 3012 <dd> | |
| 3013 str | |
| 3014 </dd> | |
| 3015 </dl> | |
| 3016 <a NAME="Project.getProjectDictionaries" ID="Project.getProjectDictionaries"></a> | |
| 3017 <h4>Project.getProjectDictionaries</h4> | |
| 3018 <b>getProjectDictionaries</b>(<i></i>) | |
| 3019 | |
| 3020 <p> | |
| 3021 Public method to get the names of the project specific dictionaries. | |
| 3022 </p> | |
| 3023 <dl> | |
| 3024 <dt>Return:</dt> | |
| 3025 <dd> | |
| 3026 tuple of two strings giving the absolute path names of the | |
| 3027 project specific word and exclude list | |
| 3028 </dd> | |
| 3029 </dl> | |
| 3030 <a NAME="Project.getProjectExecPath" ID="Project.getProjectExecPath"></a> | |
| 3031 <h4>Project.getProjectExecPath</h4> | |
| 3032 <b>getProjectExecPath</b>(<i></i>) | |
| 3033 | |
| 3034 <p> | |
| 3035 Public method to get the executable search path prefix of the project. | |
| 3036 </p> | |
| 3037 <dl> | |
| 3038 <dt>Return:</dt> | |
| 3039 <dd> | |
| 3040 executable search path prefix | |
| 3041 </dd> | |
| 3042 </dl> | |
| 3043 <dl> | |
| 3044 <dt>Return Type:</dt> | |
| 3045 <dd> | |
| 3046 str | |
| 3047 </dd> | |
| 3048 </dl> | |
| 3049 <a NAME="Project.getProjectFile" ID="Project.getProjectFile"></a> | |
| 3050 <h4>Project.getProjectFile</h4> | |
| 3051 <b>getProjectFile</b>(<i></i>) | |
| 3052 | |
| 3053 <p> | |
| 3054 Public method to get the path of the project file. | |
| 3055 </p> | |
| 3056 <dl> | |
| 3057 <dt>Return:</dt> | |
| 3058 <dd> | |
| 3059 path of the project file (string) | |
| 3060 </dd> | |
| 3061 </dl> | |
| 3062 <a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a> | |
| 3063 <h4>Project.getProjectFiles</h4> | |
| 3064 <b>getProjectFiles</b>(<i>fileType, normalized=False</i>) | |
| 3065 | |
| 3066 <p> | |
| 3067 Public method to get the file entries of the given type. | |
| 3068 </p> | |
| 3069 <dl> | |
| 3070 | |
| 3071 <dt><i>fileType</i> (str)</dt> | |
| 3072 <dd> | |
| 3073 project file type (one of the known file categories) | |
| 3074 </dd> | |
| 3075 <dt><i>normalized</i> (boolean)</dt> | |
| 3076 <dd> | |
| 3077 flag indicating normalized file names are wanted | |
| 3078 </dd> | |
| 3079 </dl> | |
| 3080 <dl> | |
| 3081 <dt>Return:</dt> | |
| 3082 <dd> | |
| 3083 list of file names | |
| 3084 </dd> | |
| 3085 </dl> | |
| 3086 <dl> | |
| 3087 <dt>Return Type:</dt> | |
| 3088 <dd> | |
| 3089 list of str | |
| 3090 </dd> | |
| 3091 </dl> | |
| 3092 <dl> | |
| 3093 | |
| 3094 <dt>Raises <b>ValueError</b>:</dt> | |
| 3095 <dd> | |
| 3096 raised when an unsupported file type is given | |
| 3097 </dd> | |
| 3098 </dl> | |
| 3099 <a NAME="Project.getProjectInterpreter" ID="Project.getProjectInterpreter"></a> | |
| 3100 <h4>Project.getProjectInterpreter</h4> | |
| 3101 <b>getProjectInterpreter</b>(<i>resolveGlobal=True</i>) | |
| 3102 | |
| 3103 <p> | |
| 3104 Public method to get the path of the interpreter used by the project. | |
| 3105 </p> | |
| 3106 <dl> | |
| 3107 | |
| 3108 <dt><i>resolveGlobal</i> (bool)</dt> | |
| 3109 <dd> | |
| 3110 flag indicating to resolve the interpreter using | |
| 3111 the global interpreter if no project or debugger specific | |
| 3112 environment was configured | |
| 3113 </dd> | |
| 3114 </dl> | |
| 3115 <dl> | |
| 3116 <dt>Return:</dt> | |
| 3117 <dd> | |
| 3118 path of the project's interpreter | |
| 3119 </dd> | |
| 3120 </dl> | |
| 3121 <dl> | |
| 3122 <dt>Return Type:</dt> | |
| 3123 <dd> | |
| 3124 str | |
| 3125 </dd> | |
| 3126 </dl> | |
| 3127 <a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a> | |
| 3128 <h4>Project.getProjectLanguage</h4> | |
| 3129 <b>getProjectLanguage</b>(<i></i>) | |
| 3130 | |
| 3131 <p> | |
| 3132 Public method to get the project's programming language. | |
| 3133 </p> | |
| 3134 <dl> | |
| 3135 <dt>Return:</dt> | |
| 3136 <dd> | |
| 3137 programming language (string) | |
| 3138 </dd> | |
| 3139 </dl> | |
| 3140 <a NAME="Project.getProjectLicense" ID="Project.getProjectLicense"></a> | |
| 3141 <h4>Project.getProjectLicense</h4> | |
| 3142 <b>getProjectLicense</b>(<i></i>) | |
| 3143 | |
| 3144 <p> | |
| 3145 Public method to get the license type used by the project. | |
| 3146 </p> | |
| 3147 <dl> | |
| 3148 <dt>Return:</dt> | |
| 3149 <dd> | |
| 3150 license type of the project | |
| 3151 </dd> | |
| 3152 </dl> | |
| 3153 <dl> | |
| 3154 <dt>Return Type:</dt> | |
| 3155 <dd> | |
| 3156 str | |
| 3157 </dd> | |
| 3158 </dl> | |
| 3159 <a NAME="Project.getProjectManagementDir" ID="Project.getProjectManagementDir"></a> | |
| 3160 <h4>Project.getProjectManagementDir</h4> | |
| 3161 <b>getProjectManagementDir</b>(<i></i>) | |
| 3162 | |
| 3163 <p> | |
| 3164 Public method to get the path of the management directory. | |
| 3165 </p> | |
| 3166 <dl> | |
| 3167 <dt>Return:</dt> | |
| 3168 <dd> | |
| 3169 path of the management directory (string) | |
| 3170 </dd> | |
| 3171 </dl> | |
| 3172 <a NAME="Project.getProjectName" ID="Project.getProjectName"></a> | |
| 3173 <h4>Project.getProjectName</h4> | |
| 3174 <b>getProjectName</b>(<i></i>) | |
| 3175 | |
| 3176 <p> | |
| 3177 Public method to get the name of the project. | |
| 3178 </p> | |
| 3179 <p> | |
| 3180 The project name is determined from the name of the project file. | |
| 3181 </p> | |
| 3182 <dl> | |
| 3183 <dt>Return:</dt> | |
| 3184 <dd> | |
| 3185 name of the project (string) | |
| 3186 </dd> | |
| 3187 </dl> | |
| 3188 <a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a> | |
| 3189 <h4>Project.getProjectPath</h4> | |
| 3190 <b>getProjectPath</b>(<i></i>) | |
| 3191 | |
| 3192 <p> | |
| 3193 Public method to get the project path. | |
| 3194 </p> | |
| 3195 <dl> | |
| 3196 <dt>Return:</dt> | |
| 3197 <dd> | |
| 3198 project path (string) | |
| 3199 </dd> | |
| 3200 </dl> | |
| 3201 <a NAME="Project.getProjectSpellLanguage" ID="Project.getProjectSpellLanguage"></a> | |
| 3202 <h4>Project.getProjectSpellLanguage</h4> | |
| 3203 <b>getProjectSpellLanguage</b>(<i></i>) | |
| 3204 | |
| 3205 <p> | |
| 3206 Public method to get the project's programming language. | |
| 3207 </p> | |
| 3208 <dl> | |
| 3209 <dt>Return:</dt> | |
| 3210 <dd> | |
| 3211 programming language (string) | |
| 3212 </dd> | |
| 3213 </dl> | |
| 3214 <a NAME="Project.getProjectTestingFramework" ID="Project.getProjectTestingFramework"></a> | |
| 3215 <h4>Project.getProjectTestingFramework</h4> | |
| 3216 <b>getProjectTestingFramework</b>(<i></i>) | |
| 3217 | |
| 3218 <p> | |
| 3219 Public method to get the testing framework name of the project. | |
| 3220 </p> | |
| 3221 <dl> | |
| 3222 <dt>Return:</dt> | |
| 3223 <dd> | |
| 3224 testing framework name of the project | |
| 3225 </dd> | |
| 3226 </dl> | |
| 3227 <dl> | |
| 3228 <dt>Return Type:</dt> | |
| 3229 <dd> | |
| 3230 str | |
| 3231 </dd> | |
| 3232 </dl> | |
| 3233 <a NAME="Project.getProjectType" ID="Project.getProjectType"></a> | |
| 3234 <h4>Project.getProjectType</h4> | |
| 3235 <b>getProjectType</b>(<i></i>) | |
| 3236 | |
| 3237 <p> | |
| 3238 Public method to get the type of the project. | |
| 3239 </p> | |
| 3240 <dl> | |
| 3241 <dt>Return:</dt> | |
| 3242 <dd> | |
| 3243 UI type of the project (string) | |
| 3244 </dd> | |
| 3245 </dl> | |
| 3246 <a NAME="Project.getProjectTypes" ID="Project.getProjectTypes"></a> | |
| 3247 <h4>Project.getProjectTypes</h4> | |
| 3248 <b>getProjectTypes</b>(<i>progLanguage=""</i>) | |
| 3249 | |
| 3250 <p> | |
| 3251 Public method to get the list of supported project types. | |
| 3252 </p> | |
| 3253 <dl> | |
| 3254 | |
| 3255 <dt><i>progLanguage</i></dt> | |
| 3256 <dd> | |
| 3257 programming language to get project types for | |
| 3258 (string) | |
| 3259 </dd> | |
| 3260 </dl> | |
| 3261 <dl> | |
| 3262 <dt>Return:</dt> | |
| 3263 <dd> | |
| 3264 reference to the dictionary of project types. | |
| 3265 </dd> | |
| 3266 </dl> | |
| 3267 <a NAME="Project.getProjectVenv" ID="Project.getProjectVenv"></a> | |
| 3268 <h4>Project.getProjectVenv</h4> | |
| 3269 <b>getProjectVenv</b>(<i>resolveDebugger=True</i>) | |
| 3270 | |
| 3271 <p> | |
| 3272 Public method to get the name of the virtual environment used by the | |
| 3273 project. | |
| 3274 </p> | |
| 3275 <dl> | |
| 3276 | |
| 3277 <dt><i>resolveDebugger</i> (bool)</dt> | |
| 3278 <dd> | |
| 3279 flag indicating to resolve the virtual | |
| 3280 environment name via the debugger settings if none was configured | |
| 3281 </dd> | |
| 3282 </dl> | |
| 3283 <dl> | |
| 3284 <dt>Return:</dt> | |
| 3285 <dd> | |
| 3286 name of the project's virtual environment | |
| 3287 </dd> | |
| 3288 </dl> | |
| 3289 <dl> | |
| 3290 <dt>Return Type:</dt> | |
| 3291 <dd> | |
| 3292 str | |
| 3293 </dd> | |
| 3294 </dl> | |
| 3295 <a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a> | |
| 3296 <h4>Project.getProjectVersion</h4> | |
| 3297 <b>getProjectVersion</b>(<i></i>) | |
| 3298 | |
| 3299 <p> | |
| 3300 Public mehod to get the version number of the project. | |
| 3301 </p> | |
| 3302 <dl> | |
| 3303 <dt>Return:</dt> | |
| 3304 <dd> | |
| 3305 version number | |
| 3306 </dd> | |
| 3307 </dl> | |
| 3308 <dl> | |
| 3309 <dt>Return Type:</dt> | |
| 3310 <dd> | |
| 3311 str | |
| 3312 </dd> | |
| 3313 </dl> | |
| 3314 <a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a> | |
| 3315 <h4>Project.getRelativePath</h4> | |
| 3316 <b>getRelativePath</b>(<i>path</i>) | |
| 3317 | |
| 3318 <p> | |
| 3319 Public method to convert a file path to a project relative | |
| 3320 file path. | |
| 3321 </p> | |
| 3322 <dl> | |
| 3323 | |
| 3324 <dt><i>path</i></dt> | |
| 3325 <dd> | |
| 3326 file or directory name to convert (string) | |
| 3327 </dd> | |
| 3328 </dl> | |
| 3329 <dl> | |
| 3330 <dt>Return:</dt> | |
| 3331 <dd> | |
| 3332 project relative path or unchanged path, if path doesn't | |
| 3333 belong to the project (string) | |
| 3334 </dd> | |
| 3335 </dl> | |
| 3336 <a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a> | |
| 3337 <h4>Project.getRelativeUniversalPath</h4> | |
| 3338 <b>getRelativeUniversalPath</b>(<i>path</i>) | |
| 3339 | |
| 3340 <p> | |
| 3341 Public method to convert a file path to a project relative | |
| 3342 file path with universal separators. | |
| 3343 </p> | |
| 3344 <dl> | |
| 3345 | |
| 3346 <dt><i>path</i></dt> | |
| 3347 <dd> | |
| 3348 file or directory name to convert (string) | |
| 3349 </dd> | |
| 3350 </dl> | |
| 3351 <dl> | |
| 3352 <dt>Return:</dt> | |
| 3353 <dd> | |
| 3354 project relative path or unchanged path, if path doesn't | |
| 3355 belong to the project (string) | |
| 3356 </dd> | |
| 3357 </dl> | |
| 3358 <a NAME="Project.getSources" ID="Project.getSources"></a> | |
| 3359 <h4>Project.getSources</h4> | |
| 3360 <b>getSources</b>(<i>normalized=False</i>) | |
| 3361 | |
| 3362 <p> | |
| 3363 Public method to return the source script files. | |
| 3364 </p> | |
| 3365 <dl> | |
| 3366 | |
| 3367 <dt><i>normalized</i> (bool)</dt> | |
| 3368 <dd> | |
| 3369 flag indicating a normalized filename is wanted | |
| 3370 </dd> | |
| 3371 </dl> | |
| 3372 <dl> | |
| 3373 <dt>Return:</dt> | |
| 3374 <dd> | |
| 3375 list of the projects scripts | |
| 3376 </dd> | |
| 3377 </dl> | |
| 3378 <dl> | |
| 3379 <dt>Return Type:</dt> | |
| 3380 <dd> | |
| 3381 list of str | |
| 3382 </dd> | |
| 3383 </dl> | |
| 3384 <a NAME="Project.getStatusMonitorAutoUpdate" ID="Project.getStatusMonitorAutoUpdate"></a> | |
| 3385 <h4>Project.getStatusMonitorAutoUpdate</h4> | |
| 3386 <b>getStatusMonitorAutoUpdate</b>(<i></i>) | |
| 3387 | |
| 3388 <p> | |
| 3389 Public method to retrieve the status of the auto update function. | |
| 3390 </p> | |
| 3391 <dl> | |
| 3392 <dt>Return:</dt> | |
| 3393 <dd> | |
| 3394 status of the auto update function (boolean) | |
| 3395 </dd> | |
| 3396 </dl> | |
| 3397 <a NAME="Project.getStatusMonitorInterval" ID="Project.getStatusMonitorInterval"></a> | |
| 3398 <h4>Project.getStatusMonitorInterval</h4> | |
| 3399 <b>getStatusMonitorInterval</b>(<i></i>) | |
| 3400 | |
| 3401 <p> | |
| 3402 Public method to get the monitor interval. | |
| 3403 </p> | |
| 3404 <dl> | |
| 3405 <dt>Return:</dt> | |
| 3406 <dd> | |
| 3407 interval in seconds (integer) | |
| 3408 </dd> | |
| 3409 </dl> | |
| 3410 <a NAME="Project.getTranslationPattern" ID="Project.getTranslationPattern"></a> | |
| 3411 <h4>Project.getTranslationPattern</h4> | |
| 3412 <b>getTranslationPattern</b>(<i></i>) | |
| 3413 | |
| 3414 <p> | |
| 3415 Public method to get the translation pattern. | |
| 3416 </p> | |
| 3417 <dl> | |
| 3418 <dt>Return:</dt> | |
| 3419 <dd> | |
| 3420 translation pattern (string) | |
| 3421 </dd> | |
| 3422 </dl> | |
| 3423 <a NAME="Project.getUicParameter" ID="Project.getUicParameter"></a> | |
| 3424 <h4>Project.getUicParameter</h4> | |
| 3425 <b>getUicParameter</b>(<i>name</i>) | |
| 3426 | |
| 3427 <p> | |
| 3428 Public method to get a named uic related parameter. | |
| 3429 </p> | |
| 3430 <dl> | |
| 3431 | |
| 3432 <dt><i>name</i> (str)</dt> | |
| 3433 <dd> | |
| 3434 name of the parameter | |
| 3435 </dd> | |
| 3436 </dl> | |
| 3437 <dl> | |
| 3438 <dt>Return:</dt> | |
| 3439 <dd> | |
| 3440 value of the given parameter | |
| 3441 </dd> | |
| 3442 </dl> | |
| 3443 <dl> | |
| 3444 <dt>Return Type:</dt> | |
| 3445 <dd> | |
| 3446 any, None in case on non-existence | |
| 3447 </dd> | |
| 3448 </dl> | |
| 3449 <a NAME="Project.getVcs" ID="Project.getVcs"></a> | |
| 3450 <h4>Project.getVcs</h4> | |
| 3451 <b>getVcs</b>(<i></i>) | |
| 3452 | |
| 3453 <p> | |
| 3454 Public method to get a reference to the VCS object. | |
| 3455 </p> | |
| 3456 <dl> | |
| 3457 <dt>Return:</dt> | |
| 3458 <dd> | |
| 3459 reference to the VCS object | |
| 3460 </dd> | |
| 3461 </dl> | |
| 3462 <a NAME="Project.handleApplicationDiagram" ID="Project.handleApplicationDiagram"></a> | |
| 3463 <h4>Project.handleApplicationDiagram</h4> | |
| 3464 <b>handleApplicationDiagram</b>(<i></i>) | |
| 3465 | |
| 3466 <p> | |
| 3467 Public method to handle the application diagram context menu action. | |
| 3468 </p> | |
| 3469 <a NAME="Project.handlePreferencesChanged" ID="Project.handlePreferencesChanged"></a> | |
| 3470 <h4>Project.handlePreferencesChanged</h4> | |
| 3471 <b>handlePreferencesChanged</b>(<i></i>) | |
| 3472 | |
| 3473 <p> | |
| 3474 Public slot used to handle the preferencesChanged signal. | |
| 3475 </p> | |
| 3476 <a NAME="Project.hasDefaultDocstringParameter" ID="Project.hasDefaultDocstringParameter"></a> | |
| 3477 <h4>Project.hasDefaultDocstringParameter</h4> | |
| 3478 <b>hasDefaultDocstringParameter</b>(<i></i>) | |
| 3479 | |
| 3480 <p> | |
| 3481 Public method to test, if the project contains the default docstring | |
| 3482 parameter. | |
| 3483 </p> | |
| 3484 <dl> | |
| 3485 <dt>Return:</dt> | |
| 3486 <dd> | |
| 3487 flag indicating default parameter | |
| 3488 </dd> | |
| 3489 </dl> | |
| 3490 <dl> | |
| 3491 <dt>Return Type:</dt> | |
| 3492 <dd> | |
| 3493 bool | |
| 3494 </dd> | |
| 3495 </dl> | |
| 3496 <a NAME="Project.hasDefaultMakeParameters" ID="Project.hasDefaultMakeParameters"></a> | |
| 3497 <h4>Project.hasDefaultMakeParameters</h4> | |
| 3498 <b>hasDefaultMakeParameters</b>(<i></i>) | |
| 3499 | |
| 3500 <p> | |
| 3501 Public method to test, if the project contains the default make | |
| 3502 parameters. | |
| 3503 </p> | |
| 3504 <dl> | |
| 3505 <dt>Return:</dt> | |
| 3506 <dd> | |
| 3507 flag indicating default parameter set | |
| 3508 </dd> | |
| 3509 </dl> | |
| 3510 <dl> | |
| 3511 <dt>Return Type:</dt> | |
| 3512 <dd> | |
| 3513 bool | |
| 3514 </dd> | |
| 3515 </dl> | |
| 3516 <a NAME="Project.hasDefaultRccCompilerParameters" ID="Project.hasDefaultRccCompilerParameters"></a> | |
| 3517 <h4>Project.hasDefaultRccCompilerParameters</h4> | |
| 3518 <b>hasDefaultRccCompilerParameters</b>(<i></i>) | |
| 3519 | |
| 3520 <p> | |
| 3521 Public method to test, if the project contains the default rcc compiler | |
| 3522 parameters. | |
| 3523 </p> | |
| 3524 <dl> | |
| 3525 <dt>Return:</dt> | |
| 3526 <dd> | |
| 3527 flag indicating default parameter set | |
| 3528 </dd> | |
| 3529 </dl> | |
| 3530 <dl> | |
| 3531 <dt>Return Type:</dt> | |
| 3532 <dd> | |
| 3533 bool | |
| 3534 </dd> | |
| 3535 </dl> | |
| 3536 <a NAME="Project.hasDefaultUicCompilerParameters" ID="Project.hasDefaultUicCompilerParameters"></a> | |
| 3537 <h4>Project.hasDefaultUicCompilerParameters</h4> | |
| 3538 <b>hasDefaultUicCompilerParameters</b>(<i></i>) | |
| 3539 | |
| 3540 <p> | |
| 3541 Public method to test, if the project contains the default uic compiler | |
| 3542 parameters. | |
| 3543 </p> | |
| 3544 <dl> | |
| 3545 <dt>Return:</dt> | |
| 3546 <dd> | |
| 3547 flag indicating default parameter set | |
| 3548 </dd> | |
| 3549 </dl> | |
| 3550 <dl> | |
| 3551 <dt>Return Type:</dt> | |
| 3552 <dd> | |
| 3553 bool | |
| 3554 </dd> | |
| 3555 </dl> | |
| 3556 <a NAME="Project.hasEntry" ID="Project.hasEntry"></a> | |
| 3557 <h4>Project.hasEntry</h4> | |
| 3558 <b>hasEntry</b>(<i>fn</i>) | |
| 3559 | |
| 3560 <p> | |
| 3561 Public method to check the project for a file. | |
| 3562 </p> | |
| 3563 <dl> | |
| 3564 | |
| 3565 <dt><i>fn</i></dt> | |
| 3566 <dd> | |
| 3567 filename to be checked (string) | |
| 3568 </dd> | |
| 3569 </dl> | |
| 3570 <dl> | |
| 3571 <dt>Return:</dt> | |
| 3572 <dd> | |
| 3573 flag indicating, if the project contains the file (boolean) | |
| 3574 </dd> | |
| 3575 </dl> | |
| 3576 <a NAME="Project.hasProjectType" ID="Project.hasProjectType"></a> | |
| 3577 <h4>Project.hasProjectType</h4> | |
| 3578 <b>hasProjectType</b>(<i>type_, progLanguage=""</i>) | |
| 3579 | |
| 3580 <p> | |
| 3581 Public method to check, if a project type is already registered. | |
| 3582 </p> | |
| 3583 <dl> | |
| 3584 | |
| 3585 <dt><i>type_</i></dt> | |
| 3586 <dd> | |
| 3587 internal type designator (string) | |
| 3588 </dd> | |
| 3589 <dt><i>progLanguage</i></dt> | |
| 3590 <dd> | |
| 3591 programming language of the project type (string) | |
| 3592 </dd> | |
| 3593 </dl> | |
| 3594 <dl> | |
| 3595 <dt>Return:</dt> | |
| 3596 <dd> | |
| 3597 flag indicating presence of the project type (boolean) | |
| 3598 </dd> | |
| 3599 </dl> | |
| 3600 <a NAME="Project.initActions" ID="Project.initActions"></a> | |
| 3601 <h4>Project.initActions</h4> | |
| 3602 <b>initActions</b>(<i></i>) | |
| 3603 | |
| 3604 <p> | |
| 3605 Public slot to initialize the project related actions. | |
| 3606 </p> | |
| 3607 <a NAME="Project.initFileTypes" ID="Project.initFileTypes"></a> | |
| 3608 <h4>Project.initFileTypes</h4> | |
| 3609 <b>initFileTypes</b>(<i></i>) | |
| 3610 | |
| 3611 <p> | |
| 3612 Public method to initialize the file type associations with default | |
| 3613 values. | |
| 3614 </p> | |
| 3615 <a NAME="Project.initMenus" ID="Project.initMenus"></a> | |
| 3616 <h4>Project.initMenus</h4> | |
| 3617 <b>initMenus</b>(<i></i>) | |
| 3618 | |
| 3619 <p> | |
| 3620 Public slot to initialize the project menus. | |
| 3621 </p> | |
| 3622 <dl> | |
| 3623 <dt>Return:</dt> | |
| 3624 <dd> | |
| 3625 tuple of generated menus | |
| 3626 </dd> | |
| 3627 </dl> | |
| 3628 <dl> | |
| 3629 <dt>Return Type:</dt> | |
| 3630 <dd> | |
| 3631 tuple of (QMenu, QMenu) | |
| 3632 </dd> | |
| 3633 </dl> | |
| 3634 <a NAME="Project.initToolbars" ID="Project.initToolbars"></a> | |
| 3635 <h4>Project.initToolbars</h4> | |
| 3636 <b>initToolbars</b>(<i>toolbarManager</i>) | |
| 3637 | |
| 3638 <p> | |
| 3639 Public slot to initialize the project toolbar and the basic VCS | |
| 3640 toolbar. | |
| 3641 </p> | |
| 3642 <dl> | |
| 3643 | |
| 3644 <dt><i>toolbarManager</i></dt> | |
| 3645 <dd> | |
| 3646 reference to a toolbar manager object | |
| 3647 (EricToolBarManager) | |
| 3648 </dd> | |
| 3649 </dl> | |
| 3650 <dl> | |
| 3651 <dt>Return:</dt> | |
| 3652 <dd> | |
| 3653 tuple of the generated toolbars (tuple of two QToolBar) | |
| 3654 </dd> | |
| 3655 </dl> | |
| 3656 <a NAME="Project.initVCS" ID="Project.initVCS"></a> | |
| 3657 <h4>Project.initVCS</h4> | |
| 3658 <b>initVCS</b>(<i>vcsSystem=None, nooverride=False</i>) | |
| 3659 | |
| 3660 <p> | |
| 3661 Public method used to instantiate a vcs system. | |
| 3662 </p> | |
| 3663 <dl> | |
| 3664 | |
| 3665 <dt><i>vcsSystem</i></dt> | |
| 3666 <dd> | |
| 3667 type of VCS to be used (string) | |
| 3668 </dd> | |
| 3669 <dt><i>nooverride</i></dt> | |
| 3670 <dd> | |
| 3671 flag indicating to ignore an override request | |
| 3672 (boolean) | |
| 3673 </dd> | |
| 3674 </dl> | |
| 3675 <dl> | |
| 3676 <dt>Return:</dt> | |
| 3677 <dd> | |
| 3678 a reference to the vcs object | |
| 3679 </dd> | |
| 3680 </dl> | |
| 3681 <a NAME="Project.isDebugPropertiesLoaded" ID="Project.isDebugPropertiesLoaded"></a> | |
| 3682 <h4>Project.isDebugPropertiesLoaded</h4> | |
| 3683 <b>isDebugPropertiesLoaded</b>(<i></i>) | |
| 3684 | |
| 3685 <p> | |
| 3686 Public method to return the status of the debug properties. | |
| 3687 </p> | |
| 3688 <dl> | |
| 3689 <dt>Return:</dt> | |
| 3690 <dd> | |
| 3691 load status of debug properties (boolean) | |
| 3692 </dd> | |
| 3693 </dl> | |
| 3694 <a NAME="Project.isDirty" ID="Project.isDirty"></a> | |
| 3695 <h4>Project.isDirty</h4> | |
| 3696 <b>isDirty</b>(<i></i>) | |
| 3697 | |
| 3698 <p> | |
| 3699 Public method to return the dirty state. | |
| 3700 </p> | |
| 3701 <dl> | |
| 3702 <dt>Return:</dt> | |
| 3703 <dd> | |
| 3704 dirty state (boolean) | |
| 3705 </dd> | |
| 3706 </dl> | |
| 3707 <a NAME="Project.isJavaScriptProject" ID="Project.isJavaScriptProject"></a> | |
| 3708 <h4>Project.isJavaScriptProject</h4> | |
| 3709 <b>isJavaScriptProject</b>(<i></i>) | |
| 3710 | |
| 3711 <p> | |
| 3712 Public method to check, if this project is a JavaScript project. | |
| 3713 </p> | |
| 3714 <dl> | |
| 3715 <dt>Return:</dt> | |
| 3716 <dd> | |
| 3717 flag indicating a JavaScript project (boolean) | |
| 3718 </dd> | |
| 3719 </dl> | |
| 3720 <a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a> | |
| 3721 <h4>Project.isMakeEnabled</h4> | |
| 3722 <b>isMakeEnabled</b>(<i></i>) | |
| 3723 | |
| 3724 <p> | |
| 3725 Public method to test, if make is enabled for the project. | |
| 3726 </p> | |
| 3727 <dl> | |
| 3728 <dt>Return:</dt> | |
| 3729 <dd> | |
| 3730 flag indicating enabled make support | |
| 3731 </dd> | |
| 3732 </dl> | |
| 3733 <dl> | |
| 3734 <dt>Return Type:</dt> | |
| 3735 <dd> | |
| 3736 bool | |
| 3737 </dd> | |
| 3738 </dl> | |
| 3739 <a NAME="Project.isMicroPythonProject" ID="Project.isMicroPythonProject"></a> | |
| 3740 <h4>Project.isMicroPythonProject</h4> | |
| 3741 <b>isMicroPythonProject</b>(<i></i>) | |
| 3742 | |
| 3743 <p> | |
| 3744 Public method to check, if this project is a MicroPython project. | |
| 3745 </p> | |
| 3746 <dl> | |
| 3747 <dt>Return:</dt> | |
| 3748 <dd> | |
| 3749 flag indicating a MicroPython project | |
| 3750 </dd> | |
| 3751 </dl> | |
| 3752 <dl> | |
| 3753 <dt>Return Type:</dt> | |
| 3754 <dd> | |
| 3755 bool | |
| 3756 </dd> | |
| 3757 </dl> | |
| 3758 <a NAME="Project.isMixedLanguageProject" ID="Project.isMixedLanguageProject"></a> | |
| 3759 <h4>Project.isMixedLanguageProject</h4> | |
| 3760 <b>isMixedLanguageProject</b>(<i></i>) | |
| 3761 | |
| 3762 <p> | |
| 3763 Public method to check, if this is a mixed language project. | |
| 3764 </p> | |
| 3765 <dl> | |
| 3766 <dt>Return:</dt> | |
| 3767 <dd> | |
| 3768 flag indicating a mixed language project | |
| 3769 </dd> | |
| 3770 </dl> | |
| 3771 <dl> | |
| 3772 <dt>Return Type:</dt> | |
| 3773 <dd> | |
| 3774 bool | |
| 3775 </dd> | |
| 3776 </dl> | |
| 3777 <a NAME="Project.isOpen" ID="Project.isOpen"></a> | |
| 3778 <h4>Project.isOpen</h4> | |
| 3779 <b>isOpen</b>(<i></i>) | |
| 3780 | |
| 3781 <p> | |
| 3782 Public method to return the opened state. | |
| 3783 </p> | |
| 3784 <dl> | |
| 3785 <dt>Return:</dt> | |
| 3786 <dd> | |
| 3787 open state (boolean) | |
| 3788 </dd> | |
| 3789 </dl> | |
| 3790 <a NAME="Project.isProjectCategory" ID="Project.isProjectCategory"></a> | |
| 3791 <h4>Project.isProjectCategory</h4> | |
| 3792 <b>isProjectCategory</b>(<i>fn, category</i>) | |
| 3793 | |
| 3794 <p> | |
| 3795 Public method to check, if the passed in filename belongs to the given | |
| 3796 category. | |
| 3797 </p> | |
| 3798 <dl> | |
| 3799 | |
| 3800 <dt><i>fn</i> (str)</dt> | |
| 3801 <dd> | |
| 3802 filename to be checked | |
| 3803 </dd> | |
| 3804 <dt><i>category</i> (str)</dt> | |
| 3805 <dd> | |
| 3806 file category to check against | |
| 3807 </dd> | |
| 3808 </dl> | |
| 3809 <dl> | |
| 3810 <dt>Return:</dt> | |
| 3811 <dd> | |
| 3812 flag indicating membership | |
| 3813 </dd> | |
| 3814 </dl> | |
| 3815 <dl> | |
| 3816 <dt>Return Type:</dt> | |
| 3817 <dd> | |
| 3818 bool | |
| 3819 </dd> | |
| 3820 </dl> | |
| 3821 <a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a> | |
| 3822 <h4>Project.isProjectFile</h4> | |
| 3823 <b>isProjectFile</b>(<i>fn</i>) | |
| 3824 | |
| 3825 <p> | |
| 3826 Public method used to check, if the passed in filename belongs to the | |
| 3827 project. | |
| 3828 </p> | |
| 3829 <dl> | |
| 3830 | |
| 3831 <dt><i>fn</i></dt> | |
| 3832 <dd> | |
| 3833 filename to be checked (string) | |
| 3834 </dd> | |
| 3835 </dl> | |
| 3836 <dl> | |
| 3837 <dt>Return:</dt> | |
| 3838 <dd> | |
| 3839 flag indicating membership (boolean) | |
| 3840 </dd> | |
| 3841 </dl> | |
| 3842 <a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a> | |
| 3843 <h4>Project.isPy3Project</h4> | |
| 3844 <b>isPy3Project</b>(<i></i>) | |
| 3845 | |
| 3846 <p> | |
| 3847 Public method to check, if this project is a Python3 project. | |
| 3848 </p> | |
| 3849 <dl> | |
| 3850 <dt>Return:</dt> | |
| 3851 <dd> | |
| 3852 flag indicating a Python3 project (boolean) | |
| 3853 </dd> | |
| 3854 </dl> | |
| 3855 <a NAME="Project.isPythonProject" ID="Project.isPythonProject"></a> | |
| 3856 <h4>Project.isPythonProject</h4> | |
| 3857 <b>isPythonProject</b>(<i></i>) | |
| 3858 | |
| 3859 <p> | |
| 3860 Public method to check, if this project is a Python3 or MicroPython | |
| 3861 project. | |
| 3862 </p> | |
| 3863 <dl> | |
| 3864 <dt>Return:</dt> | |
| 3865 <dd> | |
| 3866 flag indicating a Python project (boolean) | |
| 3867 </dd> | |
| 3868 </dl> | |
| 3869 <a NAME="Project.isRubyProject" ID="Project.isRubyProject"></a> | |
| 3870 <h4>Project.isRubyProject</h4> | |
| 3871 <b>isRubyProject</b>(<i></i>) | |
| 3872 | |
| 3873 <p> | |
| 3874 Public method to check, if this project is a Ruby project. | |
| 3875 </p> | |
| 3876 <dl> | |
| 3877 <dt>Return:</dt> | |
| 3878 <dd> | |
| 3879 flag indicating a Ruby project (boolean) | |
| 3880 </dd> | |
| 3881 </dl> | |
| 3882 <a NAME="Project.isVcsControlled" ID="Project.isVcsControlled"></a> | |
| 3883 <h4>Project.isVcsControlled</h4> | |
| 3884 <b>isVcsControlled</b>(<i></i>) | |
| 3885 | |
| 3886 <p> | |
| 3887 Public method to check, if the project is controlled by a VCS. | |
| 3888 </p> | |
| 3889 <dl> | |
| 3890 <dt>Return:</dt> | |
| 3891 <dd> | |
| 3892 flag indicating a VCS controlled project | |
| 3893 </dd> | |
| 3894 </dl> | |
| 3895 <dl> | |
| 3896 <dt>Return Type:</dt> | |
| 3897 <dd> | |
| 3898 bool | |
| 3899 </dd> | |
| 3900 </dl> | |
| 3901 <a NAME="Project.moveDirectory" ID="Project.moveDirectory"></a> | |
| 3902 <h4>Project.moveDirectory</h4> | |
| 3903 <b>moveDirectory</b>(<i>olddn, newdn</i>) | |
| 3904 | |
| 3905 <p> | |
| 3906 Public slot to move a directory. | |
| 3907 </p> | |
| 3908 <dl> | |
| 3909 | |
| 3910 <dt><i>olddn</i></dt> | |
| 3911 <dd> | |
| 3912 old directory name (string) | |
| 3913 </dd> | |
| 3914 <dt><i>newdn</i></dt> | |
| 3915 <dd> | |
| 3916 new directory name (string) | |
| 3917 </dd> | |
| 3918 </dl> | |
| 3919 <a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a> | |
| 3920 <h4>Project.newProjectAddFiles</h4> | |
| 3921 <b>newProjectAddFiles</b>(<i>mainscript</i>) | |
| 3922 | |
| 3923 <p> | |
| 3924 Public method to add files to a new project. | |
| 3925 </p> | |
| 3926 <dl> | |
| 3927 | |
| 3928 <dt><i>mainscript</i></dt> | |
| 3929 <dd> | |
| 3930 name of the mainscript (string) | |
| 3931 </dd> | |
| 3932 </dl> | |
| 3933 <a NAME="Project.openProject" ID="Project.openProject"></a> | |
| 3934 <h4>Project.openProject</h4> | |
| 3935 <b>openProject</b>(<i>fn=None, restoreSession=True, reopen=False</i>) | |
| 3936 | |
| 3937 <p> | |
| 3938 Public slot to open a project. | |
| 3939 </p> | |
| 3940 <dl> | |
| 3941 | |
| 3942 <dt><i>fn</i></dt> | |
| 3943 <dd> | |
| 3944 optional filename of the project file to be read | |
| 3945 </dd> | |
| 3946 <dt><i>restoreSession</i></dt> | |
| 3947 <dd> | |
| 3948 flag indicating to restore the project | |
| 3949 session (boolean) | |
| 3950 </dd> | |
| 3951 <dt><i>reopen</i></dt> | |
| 3952 <dd> | |
| 3953 flag indicating a reopening of the project (boolean) | |
| 3954 </dd> | |
| 3955 </dl> | |
| 3956 <a NAME="Project.othersAdded" ID="Project.othersAdded"></a> | |
| 3957 <h4>Project.othersAdded</h4> | |
| 3958 <b>othersAdded</b>(<i>fn, updateModel=True</i>) | |
| 3959 | |
| 3960 <p> | |
| 3961 Public slot to be called, if something was added to the OTHERS project | |
| 3962 data area. | |
| 3963 </p> | |
| 3964 <dl> | |
| 3965 | |
| 3966 <dt><i>fn</i></dt> | |
| 3967 <dd> | |
| 3968 filename or directory name added (string) | |
| 3969 </dd> | |
| 3970 <dt><i>updateModel</i></dt> | |
| 3971 <dd> | |
| 3972 flag indicating an update of the model is requested | |
| 3973 (boolean) | |
| 3974 </dd> | |
| 3975 </dl> | |
| 3976 <a NAME="Project.registerProjectType" ID="Project.registerProjectType"></a> | |
| 3977 <h4>Project.registerProjectType</h4> | |
| 3978 <b>registerProjectType</b>(<i>type_, description, fileTypeCallback=None, binaryTranslationsCallback=None, lexerAssociationCallback=None, progLanguages=None, </i>) | |
| 3979 | |
| 3980 <p> | |
| 3981 Public method to register a project type. | |
| 3982 </p> | |
| 3983 <dl> | |
| 3984 | |
| 3985 <dt><i>type_</i></dt> | |
| 3986 <dd> | |
| 3987 internal type designator to be registered (string) | |
| 3988 </dd> | |
| 3989 <dt><i>description</i></dt> | |
| 3990 <dd> | |
| 3991 more verbose type name (display string) (string) | |
| 3992 </dd> | |
| 3993 <dt><i>fileTypeCallback</i></dt> | |
| 3994 <dd> | |
| 3995 reference to a method returning a dictionary | |
| 3996 of filetype associations. | |
| 3997 </dd> | |
| 3998 <dt><i>binaryTranslationsCallback</i></dt> | |
| 3999 <dd> | |
| 4000 reference to a method returning | |
| 4001 the name of the binary translation file given the name of the raw | |
| 4002 translation file | |
| 4003 </dd> | |
| 4004 <dt><i>lexerAssociationCallback</i></dt> | |
| 4005 <dd> | |
| 4006 reference to a method returning the | |
| 4007 lexer type to be used for syntax highlighting given the name of | |
| 4008 a file | |
| 4009 </dd> | |
| 4010 <dt><i>progLanguages</i></dt> | |
| 4011 <dd> | |
| 4012 programming languages supported by the | |
| 4013 project type (list of string) | |
| 4014 </dd> | |
| 4015 </dl> | |
| 4016 <a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a> | |
| 4017 <h4>Project.removeDirectory</h4> | |
| 4018 <b>removeDirectory</b>(<i>dn</i>) | |
| 4019 | |
| 4020 <p> | |
| 4021 Public method to remove a directory from the project. | |
| 4022 </p> | |
| 4023 <p> | |
| 4024 The directory is not deleted from the project directory. | |
| 4025 </p> | |
| 4026 <dl> | |
| 4027 | |
| 4028 <dt><i>dn</i></dt> | |
| 4029 <dd> | |
| 4030 directory name to be removed from the project | |
| 4031 </dd> | |
| 4032 </dl> | |
| 4033 <a NAME="Project.removeEricActions" ID="Project.removeEricActions"></a> | |
| 4034 <h4>Project.removeEricActions</h4> | |
| 4035 <b>removeEricActions</b>(<i>actions</i>) | |
| 4036 | |
| 4037 <p> | |
| 4038 Public method to remove actions from the list of actions. | |
| 4039 </p> | |
| 4040 <dl> | |
| 4041 | |
| 4042 <dt><i>actions</i></dt> | |
| 4043 <dd> | |
| 4044 list of actions (list of EricAction) | |
| 4045 </dd> | |
| 4046 </dl> | |
| 4047 <a NAME="Project.removeFile" ID="Project.removeFile"></a> | |
| 4048 <h4>Project.removeFile</h4> | |
| 4049 <b>removeFile</b>(<i>fn, updateModel=True</i>) | |
| 4050 | |
| 4051 <p> | |
| 4052 Public slot to remove a file from the project. | |
| 4053 </p> | |
| 4054 <p> | |
| 4055 The file is not deleted from the project directory. | |
| 4056 </p> | |
| 4057 <dl> | |
| 4058 | |
| 4059 <dt><i>fn</i></dt> | |
| 4060 <dd> | |
| 4061 filename to be removed from the project | |
| 4062 </dd> | |
| 4063 <dt><i>updateModel</i></dt> | |
| 4064 <dd> | |
| 4065 flag indicating an update of the model is | |
| 4066 requested (boolean) | |
| 4067 </dd> | |
| 4068 </dl> | |
| 4069 <a NAME="Project.removeFileCategory" ID="Project.removeFileCategory"></a> | |
| 4070 <h4>Project.removeFileCategory</h4> | |
| 4071 <b>removeFileCategory</b>(<i>category</i>) | |
| 4072 | |
| 4073 <p> | |
| 4074 Public method to remove a category from the categories repository. | |
| 4075 </p> | |
| 4076 <p> | |
| 4077 Note: If the category is not contained in the repository, the request to | |
| 4078 remove it will be ignored silently. | |
| 4079 </p> | |
| 4080 <dl> | |
| 4081 | |
| 4082 <dt><i>category</i> (str)</dt> | |
| 4083 <dd> | |
| 4084 file category | |
| 4085 </dd> | |
| 4086 </dl> | |
| 4087 <a NAME="Project.removeLanguageFile" ID="Project.removeLanguageFile"></a> | |
| 4088 <h4>Project.removeLanguageFile</h4> | |
| 4089 <b>removeLanguageFile</b>(<i>langFile</i>) | |
| 4090 | |
| 4091 <p> | |
| 4092 Public slot to remove a translation from the project. | |
| 4093 </p> | |
| 4094 <p> | |
| 4095 The translation file is not deleted from the project directory. | |
| 4096 </p> | |
| 4097 <dl> | |
| 4098 | |
| 4099 <dt><i>langFile</i></dt> | |
| 4100 <dd> | |
| 4101 the translation file to be removed (string) | |
| 4102 </dd> | |
| 4103 </dl> | |
| 4104 <a NAME="Project.renameFile" ID="Project.renameFile"></a> | |
| 4105 <h4>Project.renameFile</h4> | |
| 4106 <b>renameFile</b>(<i>oldfn, newfn=None</i>) | |
| 4107 | |
| 4108 <p> | |
| 4109 Public slot to rename a file of the project. | |
| 4110 </p> | |
| 4111 <dl> | |
| 4112 | |
| 4113 <dt><i>oldfn</i></dt> | |
| 4114 <dd> | |
| 4115 old filename of the file (string) | |
| 4116 </dd> | |
| 4117 <dt><i>newfn</i></dt> | |
| 4118 <dd> | |
| 4119 new filename of the file (string) | |
| 4120 </dd> | |
| 4121 </dl> | |
| 4122 <dl> | |
| 4123 <dt>Return:</dt> | |
| 4124 <dd> | |
| 4125 flag indicating success | |
| 4126 </dd> | |
| 4127 </dl> | |
| 4128 <a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a> | |
| 4129 <h4>Project.renameFileInPdata</h4> | |
| 4130 <b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile=False</i>) | |
| 4131 | |
| 4132 <p> | |
| 4133 Public method to rename a file in the __pdata structure. | |
| 4134 </p> | |
| 4135 <dl> | |
| 4136 | |
| 4137 <dt><i>oldname</i></dt> | |
| 4138 <dd> | |
| 4139 old filename (string) | |
| 4140 </dd> | |
| 4141 <dt><i>newname</i></dt> | |
| 4142 <dd> | |
| 4143 new filename (string) | |
| 4144 </dd> | |
| 4145 <dt><i>isSourceFile</i></dt> | |
| 4146 <dd> | |
| 4147 flag indicating that this is a source file | |
| 4148 even if it doesn't have the source extension (boolean) | |
| 4149 </dd> | |
| 4150 </dl> | |
| 4151 <a NAME="Project.renameMainScript" ID="Project.renameMainScript"></a> | |
| 4152 <h4>Project.renameMainScript</h4> | |
| 4153 <b>renameMainScript</b>(<i>oldfn, newfn</i>) | |
| 4154 | |
| 4155 <p> | |
| 4156 Public method to rename the main script. | |
| 4157 </p> | |
| 4158 <dl> | |
| 4159 | |
| 4160 <dt><i>oldfn</i></dt> | |
| 4161 <dd> | |
| 4162 old filename (string) | |
| 4163 </dd> | |
| 4164 <dt><i>newfn</i></dt> | |
| 4165 <dd> | |
| 4166 new filename of the main script (string) | |
| 4167 </dd> | |
| 4168 </dl> | |
| 4169 <a NAME="Project.reopenProject" ID="Project.reopenProject"></a> | |
| 4170 <h4>Project.reopenProject</h4> | |
| 4171 <b>reopenProject</b>(<i></i>) | |
| 4172 | |
| 4173 <p> | |
| 4174 Public slot to reopen the current project. | |
| 4175 </p> | |
| 4176 <a NAME="Project.repopulateItem" ID="Project.repopulateItem"></a> | |
| 4177 <h4>Project.repopulateItem</h4> | |
| 4178 <b>repopulateItem</b>(<i>fullname</i>) | |
| 4179 | |
| 4180 <p> | |
| 4181 Public slot to repopulate a named item. | |
| 4182 </p> | |
| 4183 <dl> | |
| 4184 | |
| 4185 <dt><i>fullname</i></dt> | |
| 4186 <dd> | |
| 4187 full name of the item to repopulate (string) | |
| 4188 </dd> | |
| 4189 </dl> | |
| 4190 <a NAME="Project.resetVCS" ID="Project.resetVCS"></a> | |
| 4191 <h4>Project.resetVCS</h4> | |
| 4192 <b>resetVCS</b>(<i></i>) | |
| 4193 | |
| 4194 <p> | |
| 4195 Public method to reset the VCS. | |
| 4196 </p> | |
| 4197 <a NAME="Project.saveAllScripts" ID="Project.saveAllScripts"></a> | |
| 4198 <h4>Project.saveAllScripts</h4> | |
| 4199 <b>saveAllScripts</b>(<i>reportSyntaxErrors=False</i>) | |
| 4200 | |
| 4201 <p> | |
| 4202 Public method to save all scripts belonging to the project. | |
| 4203 </p> | |
| 4204 <dl> | |
| 4205 | |
| 4206 <dt><i>reportSyntaxErrors</i></dt> | |
| 4207 <dd> | |
| 4208 flag indicating special reporting | |
| 4209 for syntax errors (boolean) | |
| 4210 </dd> | |
| 4211 </dl> | |
| 4212 <dl> | |
| 4213 <dt>Return:</dt> | |
| 4214 <dd> | |
| 4215 flag indicating success (boolean) | |
| 4216 </dd> | |
| 4217 </dl> | |
| 4218 <a NAME="Project.saveProject" ID="Project.saveProject"></a> | |
| 4219 <h4>Project.saveProject</h4> | |
| 4220 <b>saveProject</b>(<i></i>) | |
| 4221 | |
| 4222 <p> | |
| 4223 Public slot to save the current project. | |
| 4224 </p> | |
| 4225 <dl> | |
| 4226 <dt>Return:</dt> | |
| 4227 <dd> | |
| 4228 flag indicating success | |
| 4229 </dd> | |
| 4230 </dl> | |
| 4231 <a NAME="Project.saveProjectAs" ID="Project.saveProjectAs"></a> | |
| 4232 <h4>Project.saveProjectAs</h4> | |
| 4233 <b>saveProjectAs</b>(<i></i>) | |
| 4234 | |
| 4235 <p> | |
| 4236 Public slot to save the current project to a different file. | |
| 4237 </p> | |
| 4238 <dl> | |
| 4239 <dt>Return:</dt> | |
| 4240 <dd> | |
| 4241 flag indicating success (boolean) | |
| 4242 </dd> | |
| 4243 </dl> | |
| 4244 <a NAME="Project.setData" ID="Project.setData"></a> | |
| 4245 <h4>Project.setData</h4> | |
| 4246 <b>setData</b>(<i>category, key, data</i>) | |
| 4247 | |
| 4248 <p> | |
| 4249 Public method to store data in the project data store. | |
| 4250 </p> | |
| 4251 <dl> | |
| 4252 | |
| 4253 <dt><i>category</i></dt> | |
| 4254 <dd> | |
| 4255 category of the data to get (string, one of | |
| 4256 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS, | |
| 4257 DOCUMENTATIONPARMS or OTHERTOOLSPARMS) | |
| 4258 </dd> | |
| 4259 <dt><i>key</i></dt> | |
| 4260 <dd> | |
| 4261 key of the data entry to get (string). | |
| 4262 </dd> | |
| 4263 <dt><i>data</i></dt> | 4267 <dt><i>data</i></dt> |
| 4264 <dd> | 4268 <dd> |
| 4265 data to be stored | 4269 data to be stored |
| 4266 </dd> | 4270 </dd> |
| 4267 </dl> | 4271 </dl> |
