Documentation/Source/eric5.Project.Project.html

changeset 3018
70924c0bdaf1
parent 2966
f85f686981ad
child 3164
a027fc190f82
equal deleted inserted replaced
3017:6a8cb7632448 3018:70924c0bdaf1
46 </p><h3>Signals</h3> 46 </p><h3>Signals</h3>
47 <dl> 47 <dl>
48 <dt>completeRepopulateItem(str)</dt> 48 <dt>completeRepopulateItem(str)</dt>
49 <dd> 49 <dd>
50 emitted after an item of the model was 50 emitted after an item of the model was
51 repopulated 51 repopulated
52 </dd><dt>directoryRemoved(str)</dt> 52 </dd><dt>directoryRemoved(str)</dt>
53 <dd> 53 <dd>
54 emitted after a directory has been removed from 54 emitted after a directory has been removed
55 the project 55 from the project
56 </dd><dt>dirty(int)</dt> 56 </dd><dt>dirty(int)</dt>
57 <dd> 57 <dd>
58 emitted when the dirty state changes 58 emitted when the dirty state changes
59 </dd><dt>lexerAssociationsChanged()</dt> 59 </dd><dt>lexerAssociationsChanged()</dt>
60 <dd> 60 <dd>
61 emitted after the lexer associations have been 61 emitted after the lexer associations
62 changed 62 have been changed
63 </dd><dt>newProject()</dt> 63 </dd><dt>newProject()</dt>
64 <dd> 64 <dd>
65 emitted after a new project was generated 65 emitted after a new project was generated
66 </dd><dt>newProjectHooks()</dt> 66 </dd><dt>newProjectHooks()</dt>
67 <dd> 67 <dd>
68 emitted after a new project was generated but before 68 emitted after a new project was generated but
69 the newProject() signal is sent 69 before the newProject() signal is sent
70 </dd><dt>prepareRepopulateItem(str)</dt> 70 </dd><dt>prepareRepopulateItem(str)</dt>
71 <dd> 71 <dd>
72 emitted before an item of the model is 72 emitted before an item of the model is
73 repopulated 73 repopulated
74 </dd><dt>projectAboutToBeCreated()</dt> 74 </dd><dt>projectAboutToBeCreated()</dt>
75 <dd> 75 <dd>
76 emitted just before the project will be created 76 emitted just before the project will be
77 created
77 </dd><dt>projectChanged()</dt> 78 </dd><dt>projectChanged()</dt>
78 <dd> 79 <dd>
79 emitted to signal a change of the project 80 emitted to signal a change of the project
80 </dd><dt>projectClosed()</dt> 81 </dd><dt>projectClosed()</dt>
81 <dd> 82 <dd>
82 emitted after a project was closed 83 emitted after a project was closed
83 </dd><dt>projectClosedHooks()</dt> 84 </dd><dt>projectClosedHooks()</dt>
84 <dd> 85 <dd>
85 emitted after a project file was closed but before the 86 emitted after a project file was closed but
86 projectClosed() signal is sent 87 before the projectClosed() signal is sent
87 </dd><dt>projectFileRenamed(str, str)</dt> 88 </dd><dt>projectFileRenamed(str, str)</dt>
88 <dd> 89 <dd>
89 emitted after a file of the project 90 emitted after a file of the project
90 has been renamed 91 has been renamed
91 </dd><dt>projectFormAdded(str)</dt> 92 </dd><dt>projectFormAdded(str)</dt>
92 <dd> 93 <dd>
93 emitted after a new form was added 94 emitted after a new form was added
94 </dd><dt>projectFormCompiled(str)</dt> 95 </dd><dt>projectFormCompiled(str)</dt>
95 <dd> 96 <dd>
106 </dd><dt>projectLanguageAdded(str)</dt> 107 </dd><dt>projectLanguageAdded(str)</dt>
107 <dd> 108 <dd>
108 emitted after a new language was added 109 emitted after a new language was added
109 </dd><dt>projectLanguageAddedByCode(str)</dt> 110 </dd><dt>projectLanguageAddedByCode(str)</dt>
110 <dd> 111 <dd>
111 emitted after a new language was added. 112 emitted after a new language was
112 The language code is sent by this signal. 113 added. The language code is sent by this signal.
113 </dd><dt>projectLanguageRemoved(str)</dt> 114 </dd><dt>projectLanguageRemoved(str)</dt>
114 <dd> 115 <dd>
115 emitted after a language was removed 116 emitted after a language was removed
116 </dd><dt>projectOpened()</dt> 117 </dd><dt>projectOpened()</dt>
117 <dd> 118 <dd>
118 emitted after a project file was read 119 emitted after a project file was read
119 </dd><dt>projectOpenedHooks()</dt> 120 </dd><dt>projectOpenedHooks()</dt>
120 <dd> 121 <dd>
121 emitted after a project file was read but before the 122 emitted after a project file was read but
122 projectOpened() signal is sent 123 before the projectOpened() signal is sent
123 </dd><dt>projectOthersAdded(str)</dt> 124 </dd><dt>projectOthersAdded(str)</dt>
124 <dd> 125 <dd>
125 emitted after a file or directory was added 126 emitted after a file or directory was added
126 to the OTHERS project data area 127 to the OTHERS project data area
127 </dd><dt>projectOthersRemoved(str)</dt> 128 </dd><dt>projectOthersRemoved(str)</dt>
128 <dd> 129 <dd>
129 emitted after a file was removed from the 130 emitted after a file was removed from the
130 OTHERS project data area 131 OTHERS project data area
131 </dd><dt>projectPropertiesChanged()</dt> 132 </dd><dt>projectPropertiesChanged()</dt>
132 <dd> 133 <dd>
133 emitted after the project properties were changed 134 emitted after the project properties
135 were changed
134 </dd><dt>projectResourceAdded(str)</dt> 136 </dd><dt>projectResourceAdded(str)</dt>
135 <dd> 137 <dd>
136 emitted after a new resource file was added 138 emitted after a new resource file was
139 added
137 </dd><dt>projectResourceRemoved(str)</dt> 140 </dd><dt>projectResourceRemoved(str)</dt>
138 <dd> 141 <dd>
139 emitted after a resource was removed 142 emitted after a resource was removed
140 </dd><dt>projectSourceAdded(str)</dt> 143 </dd><dt>projectSourceAdded(str)</dt>
141 <dd> 144 <dd>
146 </dd><dt>reinitVCS()</dt> 149 </dd><dt>reinitVCS()</dt>
147 <dd> 150 <dd>
148 emitted after the VCS has been reinitialized 151 emitted after the VCS has been reinitialized
149 </dd><dt>showMenu(str, QMenu)</dt> 152 </dd><dt>showMenu(str, QMenu)</dt>
150 <dd> 153 <dd>
151 emitted when a menu is about to be shown. The name 154 emitted when a menu is about to be shown. The
152 of the menu and a reference to the menu are given. 155 name of the menu and a reference to the menu are given.
153 </dd><dt>sourceFile(str)</dt> 156 </dd><dt>sourceFile(str)</dt>
154 <dd> 157 <dd>
155 emitted after a project file was read to 158 emitted after a project file was read to
156 open the main script 159 open the main script
157 </dd><dt>vcsStatusMonitorStatus(str, str)</dt> 160 </dd><dt>vcsStatusMonitorStatus(str, str)</dt>
158 <dd> 161 <dd>
159 emitted to signal the status of the 162 emitted to signal the status of
160 monitoring thread (ok, nok, op, off) and a status message 163 the monitoring thread (ok, nok, op, off) and a status message
161 </dd> 164 </dd>
162 </dl> 165 </dl>
163 <h3>Derived from</h3> 166 <h3>Derived from</h3>
164 QObject 167 QObject
165 <h3>Class Attributes</h3> 168 <h3>Class Attributes</h3>
701 </dd> 704 </dd>
702 </dl><a NAME="Project.__addSingleDirectory" ID="Project.__addSingleDirectory"></a> 705 </dl><a NAME="Project.__addSingleDirectory" ID="Project.__addSingleDirectory"></a>
703 <h4>Project.__addSingleDirectory</h4> 706 <h4>Project.__addSingleDirectory</h4>
704 <b>__addSingleDirectory</b>(<i>filetype, source, target, quiet=False</i>) 707 <b>__addSingleDirectory</b>(<i>filetype, source, target, quiet=False</i>)
705 <p> 708 <p>
706 Private method used to add all files of a single directory to the project. 709 Private method used to add all files of a single directory to the
710 project.
707 </p><dl> 711 </p><dl>
708 <dt><i>filetype</i></dt> 712 <dt><i>filetype</i></dt>
709 <dd> 713 <dd>
710 type of files to add (string) 714 type of files to add (string)
711 </dd><dt><i>source</i></dt> 715 </dd><dt><i>source</i></dt>
720 </dd> 724 </dd>
721 </dl><a NAME="Project.__binaryTranslationFile" ID="Project.__binaryTranslationFile"></a> 725 </dl><a NAME="Project.__binaryTranslationFile" ID="Project.__binaryTranslationFile"></a>
722 <h4>Project.__binaryTranslationFile</h4> 726 <h4>Project.__binaryTranslationFile</h4>
723 <b>__binaryTranslationFile</b>(<i>langFile</i>) 727 <b>__binaryTranslationFile</b>(<i>langFile</i>)
724 <p> 728 <p>
725 Private method to calculate the filename of the binary translations file 729 Private method to calculate the filename of the binary translations
726 given the name of the raw translations file. 730 file given the name of the raw translations file.
727 </p><dl> 731 </p><dl>
728 <dt><i>langFile</i></dt> 732 <dt><i>langFile</i></dt>
729 <dd> 733 <dd>
730 name of the raw translations file (string) 734 name of the raw translations file (string)
731 </dd> 735 </dd>
750 </dd> 754 </dd>
751 </dl><a NAME="Project.__checkProjectFileGroup" ID="Project.__checkProjectFileGroup"></a> 755 </dl><a NAME="Project.__checkProjectFileGroup" ID="Project.__checkProjectFileGroup"></a>
752 <h4>Project.__checkProjectFileGroup</h4> 756 <h4>Project.__checkProjectFileGroup</h4>
753 <b>__checkProjectFileGroup</b>(<i>fn, group</i>) 757 <b>__checkProjectFileGroup</b>(<i>fn, group</i>)
754 <p> 758 <p>
755 Private method to check, if a file is in a specific file group of the project. 759 Private method to check, if a file is in a specific file group of the
760 project.
756 </p><dl> 761 </p><dl>
757 <dt><i>fn</i></dt> 762 <dt><i>fn</i></dt>
758 <dd> 763 <dd>
759 filename to be checked (string) 764 filename to be checked (string)
760 </dd><dt><i>group</i></dt> 765 </dd><dt><i>group</i></dt>
865 Private method to load the recently opened project filenames. 870 Private method to load the recently opened project filenames.
866 </p><a NAME="Project.__openRecent" ID="Project.__openRecent"></a> 871 </p><a NAME="Project.__openRecent" ID="Project.__openRecent"></a>
867 <h4>Project.__openRecent</h4> 872 <h4>Project.__openRecent</h4>
868 <b>__openRecent</b>(<i>act</i>) 873 <b>__openRecent</b>(<i>act</i>)
869 <p> 874 <p>
870 Private method to open a project from the list of rencently opened projects. 875 Private method to open a project from the list of rencently opened
876 projects.
871 </p><dl> 877 </p><dl>
872 <dt><i>act</i></dt> 878 <dt><i>act</i></dt>
873 <dd> 879 <dd>
874 reference to the action that triggered (QAction) 880 reference to the action that triggered (QAction)
875 </dd> 881 </dd>
970 Private slot used to handle the search new files action. 976 Private slot used to handle the search new files action.
971 </p><a NAME="Project.__showCodeCoverage" ID="Project.__showCodeCoverage"></a> 977 </p><a NAME="Project.__showCodeCoverage" ID="Project.__showCodeCoverage"></a>
972 <h4>Project.__showCodeCoverage</h4> 978 <h4>Project.__showCodeCoverage</h4>
973 <b>__showCodeCoverage</b>(<i></i>) 979 <b>__showCodeCoverage</b>(<i></i>)
974 <p> 980 <p>
975 Private slot used to show the code coverage information for the project files. 981 Private slot used to show the code coverage information for the
982 project files.
976 </p><a NAME="Project.__showCodeMetrics" ID="Project.__showCodeMetrics"></a> 983 </p><a NAME="Project.__showCodeMetrics" ID="Project.__showCodeMetrics"></a>
977 <h4>Project.__showCodeMetrics</h4> 984 <h4>Project.__showCodeMetrics</h4>
978 <b>__showCodeMetrics</b>(<i></i>) 985 <b>__showCodeMetrics</b>(<i></i>)
979 <p> 986 <p>
980 Private slot used to calculate some code metrics for the project files. 987 Private slot used to calculate some code metrics for the project files.
1102 Private method to save the project infos to a project file. 1109 Private method to save the project infos to a project file.
1103 </p><dl> 1110 </p><dl>
1104 <dt><i>fn</i></dt> 1111 <dt><i>fn</i></dt>
1105 <dd> 1112 <dd>
1106 optional filename of the project file to be written (string). 1113 optional filename of the project file to be written (string).
1107 If fn is None, the filename stored in the project object 1114 If fn is None, the filename stored in the project object
1108 is used. This is the 'save' action. If fn is given, this filename 1115 is used. This is the 'save' action. If fn is given, this filename
1109 is used instead of the one in the project object. This is the 1116 is used instead of the one in the project object. This is the
1110 'save as' action. 1117 'save as' action.
1111 </dd> 1118 </dd>
1112 </dl><dl> 1119 </dl><dl>
1113 <dt>Returns:</dt> 1120 <dt>Returns:</dt>
1114 <dd> 1121 <dd>
1115 flag indicating success 1122 flag indicating success
1173 </dd> 1180 </dd>
1174 </dl><a NAME="Project.addIdlDir" ID="Project.addIdlDir"></a> 1181 </dl><a NAME="Project.addIdlDir" ID="Project.addIdlDir"></a>
1175 <h4>Project.addIdlDir</h4> 1182 <h4>Project.addIdlDir</h4>
1176 <b>addIdlDir</b>(<i></i>) 1183 <b>addIdlDir</b>(<i></i>)
1177 <p> 1184 <p>
1178 Public slot to add all IDL interfaces of a directory to the current project. 1185 Public slot to add all IDL interfaces of a directory to the current
1186 project.
1179 </p><a NAME="Project.addIdlFiles" ID="Project.addIdlFiles"></a> 1187 </p><a NAME="Project.addIdlFiles" ID="Project.addIdlFiles"></a>
1180 <h4>Project.addIdlFiles</h4> 1188 <h4>Project.addIdlFiles</h4>
1181 <b>addIdlFiles</b>(<i></i>) 1189 <b>addIdlFiles</b>(<i></i>)
1182 <p> 1190 <p>
1183 Public slot to add IDL interfaces to the current project. 1191 Public slot to add IDL interfaces to the current project.
1198 Public slot to add files to the OTHERS project data. 1206 Public slot to add files to the OTHERS project data.
1199 </p><a NAME="Project.addResourceDir" ID="Project.addResourceDir"></a> 1207 </p><a NAME="Project.addResourceDir" ID="Project.addResourceDir"></a>
1200 <h4>Project.addResourceDir</h4> 1208 <h4>Project.addResourceDir</h4>
1201 <b>addResourceDir</b>(<i></i>) 1209 <b>addResourceDir</b>(<i></i>)
1202 <p> 1210 <p>
1203 Public slot to add all Qt resource files of a directory to the current project. 1211 Public slot to add all Qt resource files of a directory to the current
1212 project.
1204 </p><a NAME="Project.addResourceFiles" ID="Project.addResourceFiles"></a> 1213 </p><a NAME="Project.addResourceFiles" ID="Project.addResourceFiles"></a>
1205 <h4>Project.addResourceFiles</h4> 1214 <h4>Project.addResourceFiles</h4>
1206 <b>addResourceFiles</b>(<i></i>) 1215 <b>addResourceFiles</b>(<i></i>)
1207 <p> 1216 <p>
1208 Public slot to add Qt resources to the current project. 1217 Public slot to add Qt resources to the current project.
1209 </p><a NAME="Project.addSourceDir" ID="Project.addSourceDir"></a> 1218 </p><a NAME="Project.addSourceDir" ID="Project.addSourceDir"></a>
1210 <h4>Project.addSourceDir</h4> 1219 <h4>Project.addSourceDir</h4>
1211 <b>addSourceDir</b>(<i></i>) 1220 <b>addSourceDir</b>(<i></i>)
1212 <p> 1221 <p>
1213 Public slot to add all source files of a directory to the current project. 1222 Public slot to add all source files of a directory to the current
1223 project.
1214 </p><a NAME="Project.addSourceFiles" ID="Project.addSourceFiles"></a> 1224 </p><a NAME="Project.addSourceFiles" ID="Project.addSourceFiles"></a>
1215 <h4>Project.addSourceFiles</h4> 1225 <h4>Project.addSourceFiles</h4>
1216 <b>addSourceFiles</b>(<i></i>) 1226 <b>addSourceFiles</b>(<i></i>)
1217 <p> 1227 <p>
1218 Public slot to add source files to the current project. 1228 Public slot to add source files to the current project.
1246 <dd> 1256 <dd>
1247 filename to be added to the project (string) 1257 filename to be added to the project (string)
1248 </dd><dt><i>isSourceFile</i></dt> 1258 </dd><dt><i>isSourceFile</i></dt>
1249 <dd> 1259 <dd>
1250 flag indicating that this is a source file 1260 flag indicating that this is a source file
1251 even if it doesn't have the source extension (boolean) 1261 even if it doesn't have the source extension (boolean)
1252 </dd><dt><i>updateModel</i></dt> 1262 </dd><dt><i>updateModel</i></dt>
1253 <dd> 1263 <dd>
1254 flag indicating an update of the model is requested (boolean) 1264 flag indicating an update of the model is
1265 requested (boolean)
1255 </dd> 1266 </dd>
1256 </dl><a NAME="Project.checkAllScriptsDirty" ID="Project.checkAllScriptsDirty"></a> 1267 </dl><a NAME="Project.checkAllScriptsDirty" ID="Project.checkAllScriptsDirty"></a>
1257 <h4>Project.checkAllScriptsDirty</h4> 1268 <h4>Project.checkAllScriptsDirty</h4>
1258 <b>checkAllScriptsDirty</b>(<i>reportSyntaxErrors=False</i>) 1269 <b>checkAllScriptsDirty</b>(<i>reportSyntaxErrors=False</i>)
1259 <p> 1270 <p>
1428 Public method to get data out of the project data store. 1439 Public method to get data out of the project data store.
1429 </p><dl> 1440 </p><dl>
1430 <dt><i>category</i></dt> 1441 <dt><i>category</i></dt>
1431 <dd> 1442 <dd>
1432 category of the data to get (string, one of 1443 category of the data to get (string, one of
1433 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS, DOCUMENTATIONPARMS 1444 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS,
1434 or OTHERTOOLSPARMS) 1445 DOCUMENTATIONPARMS or OTHERTOOLSPARMS)
1435 </dd><dt><i>key</i></dt> 1446 </dd><dt><i>key</i></dt>
1436 <dd> 1447 <dd>
1437 key of the data entry to get (string). 1448 key of the data entry to get (string).
1438 </dd> 1449 </dd>
1439 </dl><dl> 1450 </dl><dl>
1473 <p> 1484 <p>
1474 Public method to retrieve a lexer association. 1485 Public method to retrieve a lexer association.
1475 </p><dl> 1486 </p><dl>
1476 <dt><i>filename</i></dt> 1487 <dt><i>filename</i></dt>
1477 <dd> 1488 <dd>
1478 filename used to determine the associated lexer language (string) 1489 filename used to determine the associated lexer
1490 language (string)
1479 </dd> 1491 </dd>
1480 </dl><dl> 1492 </dl><dl>
1481 <dt>Returns:</dt> 1493 <dt>Returns:</dt>
1482 <dd> 1494 <dd>
1483 the requested lexer language (string) 1495 the requested lexer language (string)
1523 <p> 1535 <p>
1524 Public method to return the main script filename. 1536 Public method to return the main script filename.
1525 </p><dl> 1537 </p><dl>
1526 <dt><i>normalized</i></dt> 1538 <dt><i>normalized</i></dt>
1527 <dd> 1539 <dd>
1528 flag indicating a normalized filename is wanted (boolean) 1540 flag indicating a normalized filename is wanted
1541 (boolean)
1529 </dd> 1542 </dd>
1530 </dl><dl> 1543 </dl><dl>
1531 <dt>Returns:</dt> 1544 <dt>Returns:</dt>
1532 <dd> 1545 <dd>
1533 filename of the projects main script (string) 1546 filename of the projects main script (string)
1666 <p> 1679 <p>
1667 Public method to get the list of supported project types. 1680 Public method to get the list of supported project types.
1668 </p><dl> 1681 </p><dl>
1669 <dt><i>progLanguage</i></dt> 1682 <dt><i>progLanguage</i></dt>
1670 <dd> 1683 <dd>
1671 programming language to get project types for (string) 1684 programming language to get project types for
1685 (string)
1672 </dd> 1686 </dd>
1673 </dl><dl> 1687 </dl><dl>
1674 <dt>Returns:</dt> 1688 <dt>Returns:</dt>
1675 <dd> 1689 <dd>
1676 reference to the dictionary of project types. 1690 reference to the dictionary of project types.
1715 <p> 1729 <p>
1716 Public method to return the source script files. 1730 Public method to return the source script files.
1717 </p><dl> 1731 </p><dl>
1718 <dt><i>normalized</i></dt> 1732 <dt><i>normalized</i></dt>
1719 <dd> 1733 <dd>
1720 flag indicating a normalized filename is wanted (boolean) 1734 flag indicating a normalized filename is wanted
1735 (boolean)
1721 </dd> 1736 </dd>
1722 </dl><dl> 1737 </dl><dl>
1723 <dt>Returns:</dt> 1738 <dt>Returns:</dt>
1724 <dd> 1739 <dd>
1725 list of the projects scripts (list of string) 1740 list of the projects scripts (list of string)
1814 Public slot to initialize the project related actions. 1829 Public slot to initialize the project related actions.
1815 </p><a NAME="Project.initFileTypes" ID="Project.initFileTypes"></a> 1830 </p><a NAME="Project.initFileTypes" ID="Project.initFileTypes"></a>
1816 <h4>Project.initFileTypes</h4> 1831 <h4>Project.initFileTypes</h4>
1817 <b>initFileTypes</b>(<i></i>) 1832 <b>initFileTypes</b>(<i></i>)
1818 <p> 1833 <p>
1819 Public method to initialize the filetype associations with default values. 1834 Public method to initialize the filetype associations with default
1835 values.
1820 </p><a NAME="Project.initMenu" ID="Project.initMenu"></a> 1836 </p><a NAME="Project.initMenu" ID="Project.initMenu"></a>
1821 <h4>Project.initMenu</h4> 1837 <h4>Project.initMenu</h4>
1822 <b>initMenu</b>(<i></i>) 1838 <b>initMenu</b>(<i></i>)
1823 <p> 1839 <p>
1824 Public slot to initialize the project menu. 1840 Public slot to initialize the project menu.
1833 <p> 1849 <p>
1834 Public slot to initialize the project toolbar. 1850 Public slot to initialize the project toolbar.
1835 </p><dl> 1851 </p><dl>
1836 <dt><i>toolbarManager</i></dt> 1852 <dt><i>toolbarManager</i></dt>
1837 <dd> 1853 <dd>
1838 reference to a toolbar manager object (E5ToolBarManager) 1854 reference to a toolbar manager object
1855 (E5ToolBarManager)
1839 </dd> 1856 </dd>
1840 </dl><dl> 1857 </dl><dl>
1841 <dt>Returns:</dt> 1858 <dt>Returns:</dt>
1842 <dd> 1859 <dd>
1843 the toolbar generated (QToolBar) 1860 the toolbar generated (QToolBar)
1851 <dt><i>vcsSystem</i></dt> 1868 <dt><i>vcsSystem</i></dt>
1852 <dd> 1869 <dd>
1853 type of VCS to be used (string) 1870 type of VCS to be used (string)
1854 </dd><dt><i>nooverride</i></dt> 1871 </dd><dt><i>nooverride</i></dt>
1855 <dd> 1872 <dd>
1856 flag indicating to ignore an override request (boolean) 1873 flag indicating to ignore an override request
1874 (boolean)
1857 </dd> 1875 </dd>
1858 </dl><dl> 1876 </dl><dl>
1859 <dt>Returns:</dt> 1877 <dt>Returns:</dt>
1860 <dd> 1878 <dd>
1861 a reference to the vcs object 1879 a reference to the vcs object
1892 </dd> 1910 </dd>
1893 </dl><a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a> 1911 </dl><a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a>
1894 <h4>Project.isProjectFile</h4> 1912 <h4>Project.isProjectFile</h4>
1895 <b>isProjectFile</b>(<i>fn</i>) 1913 <b>isProjectFile</b>(<i>fn</i>)
1896 <p> 1914 <p>
1897 Public method used to check, if the passed in filename belongs to the project. 1915 Public method used to check, if the passed in filename belongs to the
1916 project.
1898 </p><dl> 1917 </p><dl>
1899 <dt><i>fn</i></dt> 1918 <dt><i>fn</i></dt>
1900 <dd> 1919 <dd>
1901 filename to be checked (string) 1920 filename to be checked (string)
1902 </dd> 1921 </dd>
1907 </dd> 1926 </dd>
1908 </dl><a NAME="Project.isProjectForm" ID="Project.isProjectForm"></a> 1927 </dl><a NAME="Project.isProjectForm" ID="Project.isProjectForm"></a>
1909 <h4>Project.isProjectForm</h4> 1928 <h4>Project.isProjectForm</h4>
1910 <b>isProjectForm</b>(<i>fn</i>) 1929 <b>isProjectForm</b>(<i>fn</i>)
1911 <p> 1930 <p>
1912 Public method used to check, if the passed in filename belongs to the project 1931 Public method used to check, if the passed in filename belongs to the
1913 forms. 1932 project forms.
1914 </p><dl> 1933 </p><dl>
1915 <dt><i>fn</i></dt> 1934 <dt><i>fn</i></dt>
1916 <dd> 1935 <dd>
1917 filename to be checked (string) 1936 filename to be checked (string)
1918 </dd> 1937 </dd>
1923 </dd> 1942 </dd>
1924 </dl><a NAME="Project.isProjectInterface" ID="Project.isProjectInterface"></a> 1943 </dl><a NAME="Project.isProjectInterface" ID="Project.isProjectInterface"></a>
1925 <h4>Project.isProjectInterface</h4> 1944 <h4>Project.isProjectInterface</h4>
1926 <b>isProjectInterface</b>(<i>fn</i>) 1945 <b>isProjectInterface</b>(<i>fn</i>)
1927 <p> 1946 <p>
1928 Public method used to check, if the passed in filename belongs to the project 1947 Public method used to check, if the passed in filename belongs to the
1929 interfaces. 1948 project interfaces.
1930 </p><dl> 1949 </p><dl>
1931 <dt><i>fn</i></dt> 1950 <dt><i>fn</i></dt>
1932 <dd> 1951 <dd>
1933 filename to be checked (string) 1952 filename to be checked (string)
1934 </dd> 1953 </dd>
1939 </dd> 1958 </dd>
1940 </dl><a NAME="Project.isProjectResource" ID="Project.isProjectResource"></a> 1959 </dl><a NAME="Project.isProjectResource" ID="Project.isProjectResource"></a>
1941 <h4>Project.isProjectResource</h4> 1960 <h4>Project.isProjectResource</h4>
1942 <b>isProjectResource</b>(<i>fn</i>) 1961 <b>isProjectResource</b>(<i>fn</i>)
1943 <p> 1962 <p>
1944 Public method used to check, if the passed in filename belongs to the project 1963 Public method used to check, if the passed in filename belongs to the
1945 resources. 1964 project resources.
1946 </p><dl> 1965 </p><dl>
1947 <dt><i>fn</i></dt> 1966 <dt><i>fn</i></dt>
1948 <dd> 1967 <dd>
1949 filename to be checked (string) 1968 filename to be checked (string)
1950 </dd> 1969 </dd>
1955 </dd> 1974 </dd>
1956 </dl><a NAME="Project.isProjectSource" ID="Project.isProjectSource"></a> 1975 </dl><a NAME="Project.isProjectSource" ID="Project.isProjectSource"></a>
1957 <h4>Project.isProjectSource</h4> 1976 <h4>Project.isProjectSource</h4>
1958 <b>isProjectSource</b>(<i>fn</i>) 1977 <b>isProjectSource</b>(<i>fn</i>)
1959 <p> 1978 <p>
1960 Public method used to check, if the passed in filename belongs to the project 1979 Public method used to check, if the passed in filename belongs to the
1961 sources. 1980 project sources.
1962 </p><dl> 1981 </p><dl>
1963 <dt><i>fn</i></dt> 1982 <dt><i>fn</i></dt>
1964 <dd> 1983 <dd>
1965 filename to be checked (string) 1984 filename to be checked (string)
1966 </dd> 1985 </dd>
2041 </dd> 2060 </dd>
2042 </dl><a NAME="Project.othersAdded" ID="Project.othersAdded"></a> 2061 </dl><a NAME="Project.othersAdded" ID="Project.othersAdded"></a>
2043 <h4>Project.othersAdded</h4> 2062 <h4>Project.othersAdded</h4>
2044 <b>othersAdded</b>(<i>fn, updateModel=True</i>) 2063 <b>othersAdded</b>(<i>fn, updateModel=True</i>)
2045 <p> 2064 <p>
2046 Public slot to be called, if something was added to the OTHERS project data area. 2065 Public slot to be called, if something was added to the OTHERS project
2066 data area.
2047 </p><dl> 2067 </p><dl>
2048 <dt><i>fn</i></dt> 2068 <dt><i>fn</i></dt>
2049 <dd> 2069 <dd>
2050 filename or directory name added (string) 2070 filename or directory name added (string)
2051 </dd><dt><i>updateModel</i></dt> 2071 </dd><dt><i>updateModel</i></dt>
2052 <dd> 2072 <dd>
2053 flag indicating an update of the model is requested (boolean) 2073 flag indicating an update of the model is requested
2074 (boolean)
2054 </dd> 2075 </dd>
2055 </dl><a NAME="Project.registerProjectType" ID="Project.registerProjectType"></a> 2076 </dl><a NAME="Project.registerProjectType" ID="Project.registerProjectType"></a>
2056 <h4>Project.registerProjectType</h4> 2077 <h4>Project.registerProjectType</h4>
2057 <b>registerProjectType</b>(<i>type_, description, fileTypeCallback=None, binaryTranslationsCallback=None, lexerAssociationCallback=None, progLanguages=None</i>) 2078 <b>registerProjectType</b>(<i>type_, description, fileTypeCallback=None, binaryTranslationsCallback=None, lexerAssociationCallback=None, progLanguages=None</i>)
2058 <p> 2079 <p>
2068 <dd> 2089 <dd>
2069 reference to a method returning a dictionary 2090 reference to a method returning a dictionary
2070 of filetype associations. 2091 of filetype associations.
2071 </dd><dt><i>binaryTranslationsCallback=</i></dt> 2092 </dd><dt><i>binaryTranslationsCallback=</i></dt>
2072 <dd> 2093 <dd>
2073 reference to a method returning the 2094 reference to a method returning
2074 name of the binary translation file given the name of the raw 2095 the name of the binary translation file given the name of the raw
2075 translation file 2096 translation file
2076 </dd><dt><i>lexerAssociationCallback=</i></dt> 2097 </dd><dt><i>lexerAssociationCallback=</i></dt>
2077 <dd> 2098 <dd>
2078 reference to a method returning the 2099 reference to a method returning the
2079 lexer type to be used for syntax highlighting given the name of 2100 lexer type to be used for syntax highlighting given the name of
2116 <dt><i>fn</i></dt> 2137 <dt><i>fn</i></dt>
2117 <dd> 2138 <dd>
2118 filename to be removed from the project 2139 filename to be removed from the project
2119 </dd><dt><i>updateModel</i></dt> 2140 </dd><dt><i>updateModel</i></dt>
2120 <dd> 2141 <dd>
2121 flag indicating an update of the model is requested (boolean) 2142 flag indicating an update of the model is
2143 requested (boolean)
2122 </dd> 2144 </dd>
2123 </dl><a NAME="Project.removeLanguageFile" ID="Project.removeLanguageFile"></a> 2145 </dl><a NAME="Project.removeLanguageFile" ID="Project.removeLanguageFile"></a>
2124 <h4>Project.removeLanguageFile</h4> 2146 <h4>Project.removeLanguageFile</h4>
2125 <b>removeLanguageFile</b>(<i>langFile</i>) 2147 <b>removeLanguageFile</b>(<i>langFile</i>)
2126 <p> 2148 <p>
2238 Public method to store data in the project data store. 2260 Public method to store data in the project data store.
2239 </p><dl> 2261 </p><dl>
2240 <dt><i>category</i></dt> 2262 <dt><i>category</i></dt>
2241 <dd> 2263 <dd>
2242 category of the data to get (string, one of 2264 category of the data to get (string, one of
2243 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS, DOCUMENTATIONPARMS 2265 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS,
2244 or OTHERTOOLSPARMS) 2266 DOCUMENTATIONPARMS or OTHERTOOLSPARMS)
2245 </dd><dt><i>key</i></dt> 2267 </dd><dt><i>key</i></dt>
2246 <dd> 2268 <dd>
2247 key of the data entry to get (string). 2269 key of the data entry to get (string).
2248 </dd><dt><i>data</i></dt> 2270 </dd><dt><i>data</i></dt>
2249 <dd> 2271 <dd>
2286 <dd> 2308 <dd>
2287 flag to indicate if the Python library should be 2309 flag to indicate if the Python library should be
2288 traced as well (boolean) 2310 traced as well (boolean)
2289 </dd><dt><i>autoContinue=</i></dt> 2311 </dd><dt><i>autoContinue=</i></dt>
2290 <dd> 2312 <dd>
2291 flag indicating, that the debugger should not stop 2313 flag indicating, that the debugger should not
2292 at the first executable line (boolean) 2314 stop at the first executable line (boolean)
2293 </dd> 2315 </dd>
2294 </dl><a NAME="Project.setDirty" ID="Project.setDirty"></a> 2316 </dl><a NAME="Project.setDirty" ID="Project.setDirty"></a>
2295 <h4>Project.setDirty</h4> 2317 <h4>Project.setDirty</h4>
2296 <b>setDirty</b>(<i>b</i>) 2318 <b>setDirty</b>(<i>b</i>)
2297 <p> 2319 <p>
2361 </dd> 2383 </dd>
2362 </dl><a NAME="Project.updateFileTypes" ID="Project.updateFileTypes"></a> 2384 </dl><a NAME="Project.updateFileTypes" ID="Project.updateFileTypes"></a>
2363 <h4>Project.updateFileTypes</h4> 2385 <h4>Project.updateFileTypes</h4>
2364 <b>updateFileTypes</b>(<i></i>) 2386 <b>updateFileTypes</b>(<i></i>)
2365 <p> 2387 <p>
2366 Public method to update the filetype associations with new default values. 2388 Public method to update the filetype associations with new default
2389 values.
2367 </p><a NAME="Project.useSystemEol" ID="Project.useSystemEol"></a> 2390 </p><a NAME="Project.useSystemEol" ID="Project.useSystemEol"></a>
2368 <h4>Project.useSystemEol</h4> 2391 <h4>Project.useSystemEol</h4>
2369 <b>useSystemEol</b>(<i></i>) 2392 <b>useSystemEol</b>(<i></i>)
2370 <p> 2393 <p>
2371 Public method to check, if the project uses the system eol setting. 2394 Public method to check, if the project uses the system eol setting.

eric ide

mercurial