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 10430
e440aaf179ce
parent 10417
c6011e501282
child 10479
856476537696
equal deleted inserted replaced
10429:643989a1e2bd 10430:e440aaf179ce
1100 <p> 1100 <p>
1101 Constructor 1101 Constructor
1102 </p> 1102 </p>
1103 <dl> 1103 <dl>
1104 1104
1105 <dt><i>parent</i></dt> 1105 <dt><i>parent</i> (QWidget)</dt>
1106 <dd> 1106 <dd>
1107 parent widget (usually the ui object) (QWidget) 1107 parent widget (usually the ui object)
1108 </dd> 1108 </dd>
1109 <dt><i>filename</i></dt> 1109 <dt><i>filename</i> (str)</dt>
1110 <dd> 1110 <dd>
1111 optional filename of a project file to open (string) 1111 optional filename of a project file to open
1112 </dd> 1112 </dd>
1113 </dl> 1113 </dl>
1114 <a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a> 1114 <a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a>
1115 <h4>Project.__addRecursiveDirectory</h4> 1115 <h4>Project.__addRecursiveDirectory</h4>
1116 <b>__addRecursiveDirectory</b>(<i>filetype, source, target</i>) 1116 <b>__addRecursiveDirectory</b>(<i>filetype, source, target</i>)
1122 The tree is rooted at source to another one rooted at target. This 1122 The tree is rooted at source to another one rooted at target. This
1123 method decents down to the lowest subdirectory. 1123 method decents down to the lowest subdirectory.
1124 </p> 1124 </p>
1125 <dl> 1125 <dl>
1126 1126
1127 <dt><i>filetype</i></dt> 1127 <dt><i>filetype</i> (str)</dt>
1128 <dd> 1128 <dd>
1129 type of files to add (string) 1129 type of files to add
1130 </dd> 1130 </dd>
1131 <dt><i>source</i></dt> 1131 <dt><i>source</i> (str)</dt>
1132 <dd> 1132 <dd>
1133 source directory (string) 1133 source directory
1134 </dd> 1134 </dd>
1135 <dt><i>target</i></dt> 1135 <dt><i>target</i> (str)</dt>
1136 <dd> 1136 <dd>
1137 target directory (string) 1137 target directory
1138 </dd> 1138 </dd>
1139 </dl> 1139 </dl>
1140 <a NAME="Project.__addSingleDirectory" ID="Project.__addSingleDirectory"></a> 1140 <a NAME="Project.__addSingleDirectory" ID="Project.__addSingleDirectory"></a>
1141 <h4>Project.__addSingleDirectory</h4> 1141 <h4>Project.__addSingleDirectory</h4>
1142 <b>__addSingleDirectory</b>(<i>filetype, source, target, quiet=False</i>) 1142 <b>__addSingleDirectory</b>(<i>filetype, source, target, quiet=False</i>)
1145 Private method used to add all files of a single directory to the 1145 Private method used to add all files of a single directory to the
1146 project. 1146 project.
1147 </p> 1147 </p>
1148 <dl> 1148 <dl>
1149 1149
1150 <dt><i>filetype</i></dt> 1150 <dt><i>filetype</i> (str)</dt>
1151 <dd> 1151 <dd>
1152 type of files to add (string) 1152 type of files to add
1153 </dd> 1153 </dd>
1154 <dt><i>source</i></dt> 1154 <dt><i>source</i> (str)</dt>
1155 <dd> 1155 <dd>
1156 source directory (string) 1156 source directory
1157 </dd> 1157 </dd>
1158 <dt><i>target</i></dt> 1158 <dt><i>target</i> (str)</dt>
1159 <dd> 1159 <dd>
1160 target directory (string) 1160 target directory
1161 </dd> 1161 </dd>
1162 <dt><i>quiet</i></dt> 1162 <dt><i>quiet</i> (bool)</dt>
1163 <dd> 1163 <dd>
1164 flag indicating quiet operations (boolean) 1164 flag indicating quiet operations
1165 </dd> 1165 </dd>
1166 </dl> 1166 </dl>
1167 <a NAME="Project.__autoExecuteMake" ID="Project.__autoExecuteMake"></a> 1167 <a NAME="Project.__autoExecuteMake" ID="Project.__autoExecuteMake"></a>
1168 <h4>Project.__autoExecuteMake</h4> 1168 <h4>Project.__autoExecuteMake</h4>
1169 <b>__autoExecuteMake</b>(<i></i>) 1169 <b>__autoExecuteMake</b>(<i></i>)
1180 Private method to calculate the filename of the binary translations 1180 Private method to calculate the filename of the binary translations
1181 file given the name of the raw translations file. 1181 file given the name of the raw translations file.
1182 </p> 1182 </p>
1183 <dl> 1183 <dl>
1184 1184
1185 <dt><i>langFile</i></dt> 1185 <dt><i>langFile</i> (str)</dt>
1186 <dd> 1186 <dd>
1187 name of the raw translations file (string) 1187 name of the raw translations file
1188 </dd> 1188 </dd>
1189 </dl> 1189 </dl>
1190 <dl> 1190 <dl>
1191 <dt>Return:</dt> 1191 <dt>Return:</dt>
1192 <dd> 1192 <dd>
1193 name of the binary translations file (string) 1193 name of the binary translations file
1194 </dd>
1195 </dl>
1196 <dl>
1197 <dt>Return Type:</dt>
1198 <dd>
1199 str
1194 </dd> 1200 </dd>
1195 </dl> 1201 </dl>
1196 <a NAME="Project.__checkFilesExist" ID="Project.__checkFilesExist"></a> 1202 <a NAME="Project.__checkFilesExist" ID="Project.__checkFilesExist"></a>
1197 <h4>Project.__checkFilesExist</h4> 1203 <h4>Project.__checkFilesExist</h4>
1198 <b>__checkFilesExist</b>(<i>index</i>) 1204 <b>__checkFilesExist</b>(<i>index</i>)
1205 filesystem. Non existant files are removed from the list and the 1211 filesystem. Non existant files are removed from the list and the
1206 dirty state of the project is changed accordingly. 1212 dirty state of the project is changed accordingly.
1207 </p> 1213 </p>
1208 <dl> 1214 <dl>
1209 1215
1210 <dt><i>index</i></dt> 1216 <dt><i>index</i> (str)</dt>
1211 <dd> 1217 <dd>
1212 key of the list to be checked (string) 1218 key of the list to be checked
1213 </dd> 1219 </dd>
1214 </dl> 1220 </dl>
1215 <a NAME="Project.__checkProjectFileGroup" ID="Project.__checkProjectFileGroup"></a> 1221 <a NAME="Project.__checkProjectFileGroup" ID="Project.__checkProjectFileGroup"></a>
1216 <h4>Project.__checkProjectFileGroup</h4> 1222 <h4>Project.__checkProjectFileGroup</h4>
1217 <b>__checkProjectFileGroup</b>(<i>fn, group</i>) 1223 <b>__checkProjectFileGroup</b>(<i>fn, group</i>)
1220 Private method to check, if a file is in a specific file group of the 1226 Private method to check, if a file is in a specific file group of the
1221 project. 1227 project.
1222 </p> 1228 </p>
1223 <dl> 1229 <dl>
1224 1230
1225 <dt><i>fn</i></dt> 1231 <dt><i>fn</i> (str)</dt>
1226 <dd> 1232 <dd>
1227 filename to be checked (string) 1233 filename to be checked
1228 </dd> 1234 </dd>
1229 <dt><i>group</i></dt> 1235 <dt><i>group</i> (str)</dt>
1230 <dd> 1236 <dd>
1231 group to check (string) 1237 group to check
1232 </dd> 1238 </dd>
1233 </dl> 1239 </dl>
1234 <dl> 1240 <dl>
1235 <dt>Return:</dt> 1241 <dt>Return:</dt>
1236 <dd> 1242 <dd>
1237 flag indicating membership (boolean) 1243 flag indicating membership
1244 </dd>
1245 </dl>
1246 <dl>
1247 <dt>Return Type:</dt>
1248 <dd>
1249 bool
1238 </dd> 1250 </dd>
1239 </dl> 1251 </dl>
1240 <a NAME="Project.__cleanupMake" ID="Project.__cleanupMake"></a> 1252 <a NAME="Project.__cleanupMake" ID="Project.__cleanupMake"></a>
1241 <h4>Project.__cleanupMake</h4> 1253 <h4>Project.__cleanupMake</h4>
1242 <b>__cleanupMake</b>(<i></i>) 1254 <b>__cleanupMake</b>(<i></i>)
1318 a snapshot version. This method appends the string "-snapshot-" 1330 a snapshot version. This method appends the string "-snapshot-"
1319 and date indicator to the version string. 1331 and date indicator to the version string.
1320 </p> 1332 </p>
1321 <dl> 1333 <dl>
1322 1334
1323 <dt><i>filename</i></dt> 1335 <dt><i>filename</i> (str)</dt>
1324 <dd> 1336 <dd>
1325 name of the plugin file to modify (string) 1337 name of the plugin file to modify
1326 </dd> 1338 </dd>
1327 </dl> 1339 </dl>
1328 <dl> 1340 <dl>
1329 <dt>Return:</dt> 1341 <dt>Return:</dt>
1330 <dd> 1342 <dd>
1331 modified source (bytes), snapshot version string (string) 1343 modified source (bytes), snapshot version string
1344 </dd>
1345 </dl>
1346 <dl>
1347 <dt>Return Type:</dt>
1348 <dd>
1349 str
1332 </dd> 1350 </dd>
1333 </dl> 1351 </dl>
1334 <a NAME="Project.__createZipDirEntries" ID="Project.__createZipDirEntries"></a> 1352 <a NAME="Project.__createZipDirEntries" ID="Project.__createZipDirEntries"></a>
1335 <h4>Project.__createZipDirEntries</h4> 1353 <h4>Project.__createZipDirEntries</h4>
1336 <b>__createZipDirEntries</b>(<i>path, zipFile</i>) 1354 <b>__createZipDirEntries</b>(<i>path, zipFile</i>)
1338 <p> 1356 <p>
1339 Private method to create dir entries in the zip file. 1357 Private method to create dir entries in the zip file.
1340 </p> 1358 </p>
1341 <dl> 1359 <dl>
1342 1360
1343 <dt><i>path</i></dt> 1361 <dt><i>path</i> (str)</dt>
1344 <dd> 1362 <dd>
1345 name of the directory entry to create (string) 1363 name of the directory entry to create
1346 </dd> 1364 </dd>
1347 <dt><i>zipFile</i></dt> 1365 <dt><i>zipFile</i> (zipfile.ZipFile)</dt>
1348 <dd> 1366 <dd>
1349 open ZipFile object (zipfile.ZipFile) 1367 open ZipFile object
1350 </dd> 1368 </dd>
1351 </dl> 1369 </dl>
1352 <a NAME="Project.__deleteDebugProperties" ID="Project.__deleteDebugProperties"></a> 1370 <a NAME="Project.__deleteDebugProperties" ID="Project.__deleteDebugProperties"></a>
1353 <h4>Project.__deleteDebugProperties</h4> 1371 <h4>Project.__deleteDebugProperties</h4>
1354 <b>__deleteDebugProperties</b>(<i></i>) 1372 <b>__deleteDebugProperties</b>(<i></i>)
1377 include. If 'Automatic Inclusion' is enabled, the new files are 1395 include. If 'Automatic Inclusion' is enabled, the new files are
1378 automatically added to the project. 1396 automatically added to the project.
1379 </p> 1397 </p>
1380 <dl> 1398 <dl>
1381 1399
1382 <dt><i>AI</i></dt> 1400 <dt><i>AI</i> (bool)</dt>
1383 <dd> 1401 <dd>
1384 flag indicating whether the automatic inclusion should 1402 flag indicating whether the automatic inclusion should
1385 be honoured (boolean) 1403 be honoured
1386 </dd> 1404 </dd>
1387 <dt><i>onUserDemand</i></dt> 1405 <dt><i>onUserDemand</i> (bool)</dt>
1388 <dd> 1406 <dd>
1389 flag indicating whether this method was 1407 flag indicating whether this method was
1390 requested by the user via a menu action (boolean) 1408 requested by the user via a menu action
1391 </dd> 1409 </dd>
1392 </dl> 1410 </dl>
1393 <a NAME="Project.__executeMake" ID="Project.__executeMake"></a> 1411 <a NAME="Project.__executeMake" ID="Project.__executeMake"></a>
1394 <h4>Project.__executeMake</h4> 1412 <h4>Project.__executeMake</h4>
1395 <b>__executeMake</b>(<i>questionOnly=False, interactive=True</i>) 1413 <b>__executeMake</b>(<i>questionOnly=False, interactive=True</i>)
1556 Private method to open a project from the list of rencently opened 1574 Private method to open a project from the list of rencently opened
1557 projects. 1575 projects.
1558 </p> 1576 </p>
1559 <dl> 1577 <dl>
1560 1578
1561 <dt><i>act</i></dt> 1579 <dt><i>act</i> (QAction)</dt>
1562 <dd> 1580 <dd>
1563 reference to the action that triggered (QAction) 1581 reference to the action that triggered
1564 </dd> 1582 </dd>
1565 </dl> 1583 </dl>
1566 <a NAME="Project.__performFormatWithBlack" ID="Project.__performFormatWithBlack"></a> 1584 <a NAME="Project.__performFormatWithBlack" ID="Project.__performFormatWithBlack"></a>
1567 <h4>Project.__performFormatWithBlack</h4> 1585 <h4>Project.__performFormatWithBlack</h4>
1568 <b>__performFormatWithBlack</b>(<i>action</i>) 1586 <b>__performFormatWithBlack</b>(<i>action</i>)
1619 <p> 1637 <p>
1620 Private slot to create eric plugin archives. 1638 Private slot to create eric plugin archives.
1621 </p> 1639 </p>
1622 <dl> 1640 <dl>
1623 1641
1624 <dt><i>snapshot</i></dt> 1642 <dt><i>snapshot</i> (bool)</dt>
1625 <dd> 1643 <dd>
1626 flag indicating snapshot archives (boolean) 1644 flag indicating snapshot archives
1627 </dd> 1645 </dd>
1628 </dl> 1646 </dl>
1629 <a NAME="Project.__pluginCreatePkgList" ID="Project.__pluginCreatePkgList"></a> 1647 <a NAME="Project.__pluginCreatePkgList" ID="Project.__pluginCreatePkgList"></a>
1630 <h4>Project.__pluginCreatePkgList</h4> 1648 <h4>Project.__pluginCreatePkgList</h4>
1631 <b>__pluginCreatePkgList</b>(<i></i>) 1649 <b>__pluginCreatePkgList</b>(<i></i>)
1647 <p> 1665 <p>
1648 Private method to extract the version number entry. 1666 Private method to extract the version number entry.
1649 </p> 1667 </p>
1650 <dl> 1668 <dl>
1651 1669
1652 <dt><i>filename</i></dt> 1670 <dt><i>filename</i> (str)</dt>
1653 <dd> 1671 <dd>
1654 name of the plugin file (string) 1672 name of the plugin file
1655 </dd> 1673 </dd>
1656 </dl> 1674 </dl>
1657 <dl> 1675 <dl>
1658 <dt>Return:</dt> 1676 <dt>Return:</dt>
1659 <dd> 1677 <dd>
1660 version string (string) 1678 version string
1679 </dd>
1680 </dl>
1681 <dl>
1682 <dt>Return Type:</dt>
1683 <dd>
1684 str
1661 </dd> 1685 </dd>
1662 </dl> 1686 </dl>
1663 <a NAME="Project.__readDebugProperties" ID="Project.__readDebugProperties"></a> 1687 <a NAME="Project.__readDebugProperties" ID="Project.__readDebugProperties"></a>
1664 <h4>Project.__readDebugProperties</h4> 1688 <h4>Project.__readDebugProperties</h4>
1665 <b>__readDebugProperties</b>(<i>quiet=False</i>) 1689 <b>__readDebugProperties</b>(<i>quiet=False</i>)
1668 Private method to read in the project debugger properties file 1692 Private method to read in the project debugger properties file
1669 (.edj or .e4d). 1693 (.edj or .e4d).
1670 </p> 1694 </p>
1671 <dl> 1695 <dl>
1672 1696
1673 <dt><i>quiet</i></dt> 1697 <dt><i>quiet</i> (bool)</dt>
1674 <dd> 1698 <dd>
1675 flag indicating quiet operations. 1699 flag indicating quiet operations.
1676 If this flag is true, no errors are reported. 1700 If this flag is true, no errors are reported.
1677 </dd> 1701 </dd>
1678 </dl> 1702 </dl>
1683 <p> 1707 <p>
1684 Private method to read in a project (.epj or .e4p) file. 1708 Private method to read in a project (.epj or .e4p) file.
1685 </p> 1709 </p>
1686 <dl> 1710 <dl>
1687 1711
1688 <dt><i>fn</i></dt> 1712 <dt><i>fn</i> (str)</dt>
1689 <dd> 1713 <dd>
1690 filename of the project file to be read (string) 1714 filename of the project file to be read
1691 </dd> 1715 </dd>
1692 </dl> 1716 </dl>
1693 <dl> 1717 <dl>
1694 <dt>Return:</dt> 1718 <dt>Return:</dt>
1695 <dd> 1719 <dd>
1696 flag indicating success 1720 flag indicating success
1721 </dd>
1722 </dl>
1723 <dl>
1724 <dt>Return Type:</dt>
1725 <dd>
1726 bool
1697 </dd> 1727 </dd>
1698 </dl> 1728 </dl>
1699 <a NAME="Project.__readSession" ID="Project.__readSession"></a> 1729 <a NAME="Project.__readSession" ID="Project.__readSession"></a>
1700 <h4>Project.__readSession</h4> 1730 <h4>Project.__readSession</h4>
1701 <b>__readSession</b>(<i>quiet=False, indicator=""</i>) 1731 <b>__readSession</b>(<i>quiet=False, indicator=""</i>)
1703 <p> 1733 <p>
1704 Private method to read in the project session file (.esj or .e5s). 1734 Private method to read in the project session file (.esj or .e5s).
1705 </p> 1735 </p>
1706 <dl> 1736 <dl>
1707 1737
1708 <dt><i>quiet</i></dt> 1738 <dt><i>quiet</i> (bool)</dt>
1709 <dd> 1739 <dd>
1710 flag indicating quiet operations. 1740 flag indicating quiet operations.
1711 If this flag is true, no errors are reported. 1741 If this flag is true, no errors are reported.
1712 </dd> 1742 </dd>
1713 <dt><i>indicator</i></dt> 1743 <dt><i>indicator</i> (str)</dt>
1714 <dd> 1744 <dd>
1715 indicator string (string) 1745 indicator string
1716 </dd> 1746 </dd>
1717 </dl> 1747 </dl>
1718 <a NAME="Project.__readTasks" ID="Project.__readTasks"></a> 1748 <a NAME="Project.__readTasks" ID="Project.__readTasks"></a>
1719 <h4>Project.__readTasks</h4> 1749 <h4>Project.__readTasks</h4>
1720 <b>__readTasks</b>(<i></i>) 1750 <b>__readTasks</b>(<i></i>)
1941 <p> 1971 <p>
1942 Private method to get the source extensions of a programming language. 1972 Private method to get the source extensions of a programming language.
1943 </p> 1973 </p>
1944 <dl> 1974 <dl>
1945 1975
1946 <dt><i>language</i></dt> 1976 <dt><i>language</i> (str)</dt>
1947 <dd> 1977 <dd>
1948 programming language (string) 1978 programming language
1949 </dd> 1979 </dd>
1950 </dl> 1980 </dl>
1951 <dl> 1981 <dl>
1952 <dt>Return:</dt> 1982 <dt>Return:</dt>
1953 <dd> 1983 <dd>
1954 source extensions (list of string) 1984 source extensions
1985 </dd>
1986 </dl>
1987 <dl>
1988 <dt>Return Type:</dt>
1989 <dd>
1990 list of str
1955 </dd> 1991 </dd>
1956 </dl> 1992 </dl>
1957 <a NAME="Project.__syncRecent" ID="Project.__syncRecent"></a> 1993 <a NAME="Project.__syncRecent" ID="Project.__syncRecent"></a>
1958 <h4>Project.__syncRecent</h4> 1994 <h4>Project.__syncRecent</h4>
1959 <b>__syncRecent</b>(<i></i>) 1995 <b>__syncRecent</b>(<i></i>)
1983 <p> 2019 <p>
1984 Private method to write the project debugger properties file (.edj). 2020 Private method to write the project debugger properties file (.edj).
1985 </p> 2021 </p>
1986 <dl> 2022 <dl>
1987 2023
1988 <dt><i>quiet</i></dt> 2024 <dt><i>quiet</i> (bool)</dt>
1989 <dd> 2025 <dd>
1990 flag indicating quiet operations. 2026 flag indicating quiet operations.
1991 If this flag is true, no errors are reported. 2027 If this flag is true, no errors are reported.
1992 </dd> 2028 </dd>
1993 </dl> 2029 </dl>
1998 <p> 2034 <p>
1999 Private method to save the project infos to a project file. 2035 Private method to save the project infos to a project file.
2000 </p> 2036 </p>
2001 <dl> 2037 <dl>
2002 2038
2003 <dt><i>fn</i></dt> 2039 <dt><i>fn</i> (str)</dt>
2004 <dd> 2040 <dd>
2005 optional filename of the project file to be written (string). 2041 optional filename of the project file to be written (string).
2006 If fn is None, the filename stored in the project object 2042 If fn is None, the filename stored in the project object
2007 is used. This is the 'save' action. If fn is given, this filename 2043 is used. This is the 'save' action. If fn is given, this filename
2008 is used instead of the one in the project object. This is the 2044 is used instead of the one in the project object. This is the
2013 <dt>Return:</dt> 2049 <dt>Return:</dt>
2014 <dd> 2050 <dd>
2015 flag indicating success 2051 flag indicating success
2016 </dd> 2052 </dd>
2017 </dl> 2053 </dl>
2054 <dl>
2055 <dt>Return Type:</dt>
2056 <dd>
2057 bool
2058 </dd>
2059 </dl>
2018 <a NAME="Project.__writeSession" ID="Project.__writeSession"></a> 2060 <a NAME="Project.__writeSession" ID="Project.__writeSession"></a>
2019 <h4>Project.__writeSession</h4> 2061 <h4>Project.__writeSession</h4>
2020 <b>__writeSession</b>(<i>quiet=False, indicator=""</i>) 2062 <b>__writeSession</b>(<i>quiet=False, indicator=""</i>)
2021 2063
2022 <p> 2064 <p>
2023 Private method to write the session data to an XML file (.esj). 2065 Private method to write the session data to an XML file (.esj).
2024 </p> 2066 </p>
2025 <dl> 2067 <dl>
2026 2068
2027 <dt><i>quiet</i></dt> 2069 <dt><i>quiet</i> (bool)</dt>
2028 <dd> 2070 <dd>
2029 flag indicating quiet operations. 2071 flag indicating quiet operations.
2030 If this flag is true, no errors are reported. 2072 If this flag is true, no errors are reported.
2031 </dd> 2073 </dd>
2032 <dt><i>indicator</i></dt> 2074 <dt><i>indicator</i> (str)</dt>
2033 <dd> 2075 <dd>
2034 indicator string (string) 2076 indicator string
2035 </dd> 2077 </dd>
2036 </dl> 2078 </dl>
2037 <a NAME="Project.__writeUserProperties" ID="Project.__writeUserProperties"></a> 2079 <a NAME="Project.__writeUserProperties" ID="Project.__writeUserProperties"></a>
2038 <h4>Project.__writeUserProperties</h4> 2080 <h4>Project.__writeUserProperties</h4>
2039 <b>__writeUserProperties</b>(<i></i>) 2081 <b>__writeUserProperties</b>(<i></i>)
2066 <p> 2108 <p>
2067 Public method to add actions to the list of actions. 2109 Public method to add actions to the list of actions.
2068 </p> 2110 </p>
2069 <dl> 2111 <dl>
2070 2112
2071 <dt><i>actions</i></dt> 2113 <dt><i>actions</i> (list of EricAction)</dt>
2072 <dd> 2114 <dd>
2073 list of actions (list of EricAction) 2115 list of actions
2074 </dd> 2116 </dd>
2075 </dl> 2117 </dl>
2076 <a NAME="Project.addFileCategory" ID="Project.addFileCategory"></a> 2118 <a NAME="Project.addFileCategory" ID="Project.addFileCategory"></a>
2077 <h4>Project.addFileCategory</h4> 2119 <h4>Project.addFileCategory</h4>
2078 <b>addFileCategory</b>(<i>category, categoryItem</i>) 2120 <b>addFileCategory</b>(<i>category, categoryItem</i>)
2133 <p> 2175 <p>
2134 Public method to add a file/directory to the OTHERS project data. 2176 Public method to add a file/directory to the OTHERS project data.
2135 </p> 2177 </p>
2136 <dl> 2178 <dl>
2137 2179
2138 <dt><i>fn</i></dt> 2180 <dt><i>fn</i> (str)</dt>
2139 <dd> 2181 <dd>
2140 file name or directory name to add (string) 2182 file name or directory name to add
2141 </dd> 2183 </dd>
2142 </dl> 2184 </dl>
2143 <a NAME="Project.appendFile" ID="Project.appendFile"></a> 2185 <a NAME="Project.appendFile" ID="Project.appendFile"></a>
2144 <h4>Project.appendFile</h4> 2186 <h4>Project.appendFile</h4>
2145 <b>appendFile</b>(<i>fn, isSourceFile=False, updateModel=True</i>) 2187 <b>appendFile</b>(<i>fn, isSourceFile=False, updateModel=True</i>)
2147 <p> 2189 <p>
2148 Public method to append a file to the project. 2190 Public method to append a file to the project.
2149 </p> 2191 </p>
2150 <dl> 2192 <dl>
2151 2193
2152 <dt><i>fn</i></dt> 2194 <dt><i>fn</i> (str)</dt>
2153 <dd> 2195 <dd>
2154 filename to be added to the project (string) 2196 filename to be added to the project
2155 </dd> 2197 </dd>
2156 <dt><i>isSourceFile</i></dt> 2198 <dt><i>isSourceFile</i> (bool)</dt>
2157 <dd> 2199 <dd>
2158 flag indicating that this is a source file 2200 flag indicating that this is a source file
2159 even if it doesn't have the source extension (boolean) 2201 even if it doesn't have the source extension
2160 </dd> 2202 </dd>
2161 <dt><i>updateModel</i></dt> 2203 <dt><i>updateModel</i> (bool)</dt>
2162 <dd> 2204 <dd>
2163 flag indicating an update of the model is 2205 flag indicating an update of the model is
2164 requested (boolean) 2206 requested
2165 </dd> 2207 </dd>
2166 </dl> 2208 </dl>
2167 <a NAME="Project.checkAllScriptsDirty" ID="Project.checkAllScriptsDirty"></a> 2209 <a NAME="Project.checkAllScriptsDirty" ID="Project.checkAllScriptsDirty"></a>
2168 <h4>Project.checkAllScriptsDirty</h4> 2210 <h4>Project.checkAllScriptsDirty</h4>
2169 <b>checkAllScriptsDirty</b>(<i>reportSyntaxErrors=False</i>) 2211 <b>checkAllScriptsDirty</b>(<i>reportSyntaxErrors=False</i>)
2172 Public method to check all scripts belonging to the project for 2214 Public method to check all scripts belonging to the project for
2173 their dirty status. 2215 their dirty status.
2174 </p> 2216 </p>
2175 <dl> 2217 <dl>
2176 2218
2177 <dt><i>reportSyntaxErrors</i></dt> 2219 <dt><i>reportSyntaxErrors</i> (bool)</dt>
2178 <dd> 2220 <dd>
2179 flag indicating special reporting 2221 flag indicating special reporting
2180 for syntax errors (boolean) 2222 for syntax errors
2181 </dd> 2223 </dd>
2182 </dl> 2224 </dl>
2183 <dl> 2225 <dl>
2184 <dt>Return:</dt> 2226 <dt>Return:</dt>
2185 <dd> 2227 <dd>
2186 flag indicating success (boolean) 2228 flag indicating success
2229 </dd>
2230 </dl>
2231 <dl>
2232 <dt>Return Type:</dt>
2233 <dd>
2234 bool
2187 </dd> 2235 </dd>
2188 </dl> 2236 </dl>
2189 <a NAME="Project.checkDirty" ID="Project.checkDirty"></a> 2237 <a NAME="Project.checkDirty" ID="Project.checkDirty"></a>
2190 <h4>Project.checkDirty</h4> 2238 <h4>Project.checkDirty</h4>
2191 <b>checkDirty</b>(<i></i>) 2239 <b>checkDirty</b>(<i></i>)
2194 Public method to check dirty status and open a message window. 2242 Public method to check dirty status and open a message window.
2195 </p> 2243 </p>
2196 <dl> 2244 <dl>
2197 <dt>Return:</dt> 2245 <dt>Return:</dt>
2198 <dd> 2246 <dd>
2199 flag indicating whether this operation was successful (boolean) 2247 flag indicating whether this operation was successful
2248 </dd>
2249 </dl>
2250 <dl>
2251 <dt>Return Type:</dt>
2252 <dd>
2253 bool
2200 </dd> 2254 </dd>
2201 </dl> 2255 </dl>
2202 <a NAME="Project.checkLanguageFiles" ID="Project.checkLanguageFiles"></a> 2256 <a NAME="Project.checkLanguageFiles" ID="Project.checkLanguageFiles"></a>
2203 <h4>Project.checkLanguageFiles</h4> 2257 <h4>Project.checkLanguageFiles</h4>
2204 <b>checkLanguageFiles</b>(<i></i>) 2258 <b>checkLanguageFiles</b>(<i></i>)
2234 <p> 2288 <p>
2235 Public method to clear the cached VCS state of a file/directory. 2289 Public method to clear the cached VCS state of a file/directory.
2236 </p> 2290 </p>
2237 <dl> 2291 <dl>
2238 2292
2239 <dt><i>name</i></dt> 2293 <dt><i>name</i> (str)</dt>
2240 <dd> 2294 <dd>
2241 name of the entry to be cleared (string) 2295 name of the entry to be cleared
2242 </dd> 2296 </dd>
2243 </dl> 2297 </dl>
2244 <a NAME="Project.closeProject" ID="Project.closeProject"></a> 2298 <a NAME="Project.closeProject" ID="Project.closeProject"></a>
2245 <h4>Project.closeProject</h4> 2299 <h4>Project.closeProject</h4>
2246 <b>closeProject</b>(<i>reopen=False, noSave=False, shutdown=False</i>) 2300 <b>closeProject</b>(<i>reopen=False, noSave=False, shutdown=False</i>)
2282 <p> 2336 <p>
2283 Public slot to copy a directory. 2337 Public slot to copy a directory.
2284 </p> 2338 </p>
2285 <dl> 2339 <dl>
2286 2340
2287 <dt><i>olddn</i></dt> 2341 <dt><i>olddn</i> (str)</dt>
2288 <dd> 2342 <dd>
2289 original directory name (string) 2343 original directory name
2290 </dd> 2344 </dd>
2291 <dt><i>newdn</i></dt> 2345 <dt><i>newdn</i> (str)</dt>
2292 <dd> 2346 <dd>
2293 new directory name (string) 2347 new directory name
2294 </dd> 2348 </dd>
2295 </dl> 2349 </dl>
2296 <a NAME="Project.createNewProject" ID="Project.createNewProject"></a> 2350 <a NAME="Project.createNewProject" ID="Project.createNewProject"></a>
2297 <h4>Project.createNewProject</h4> 2351 <h4>Project.createNewProject</h4>
2298 <b>createNewProject</b>(<i></i>) 2352 <b>createNewProject</b>(<i></i>)
2355 <p> 2409 <p>
2356 Public method to delete a directory from the project directory. 2410 Public method to delete a directory from the project directory.
2357 </p> 2411 </p>
2358 <dl> 2412 <dl>
2359 2413
2360 <dt><i>dn</i></dt> 2414 <dt><i>dn</i> (str)</dt>
2361 <dd> 2415 <dd>
2362 directory name to be removed from the project 2416 directory name to be removed from the project
2363 </dd> 2417 </dd>
2364 </dl> 2418 </dl>
2365 <dl> 2419 <dl>
2366 <dt>Return:</dt> 2420 <dt>Return:</dt>
2367 <dd> 2421 <dd>
2368 flag indicating success (boolean) 2422 flag indicating success
2423 </dd>
2424 </dl>
2425 <dl>
2426 <dt>Return Type:</dt>
2427 <dd>
2428 bool
2369 </dd> 2429 </dd>
2370 </dl> 2430 </dl>
2371 <a NAME="Project.deleteFile" ID="Project.deleteFile"></a> 2431 <a NAME="Project.deleteFile" ID="Project.deleteFile"></a>
2372 <h4>Project.deleteFile</h4> 2432 <h4>Project.deleteFile</h4>
2373 <b>deleteFile</b>(<i>fn</i>) 2433 <b>deleteFile</b>(<i>fn</i>)
2375 <p> 2435 <p>
2376 Public method to delete a file from the project directory. 2436 Public method to delete a file from the project directory.
2377 </p> 2437 </p>
2378 <dl> 2438 <dl>
2379 2439
2380 <dt><i>fn</i></dt> 2440 <dt><i>fn</i> (str)</dt>
2381 <dd> 2441 <dd>
2382 filename to be deleted from the project 2442 filename to be deleted from the project
2383 </dd> 2443 </dd>
2384 </dl> 2444 </dl>
2385 <dl> 2445 <dl>
2386 <dt>Return:</dt> 2446 <dt>Return:</dt>
2387 <dd> 2447 <dd>
2388 flag indicating success (boolean) 2448 flag indicating success
2449 </dd>
2450 </dl>
2451 <dl>
2452 <dt>Return Type:</dt>
2453 <dd>
2454 bool
2389 </dd> 2455 </dd>
2390 </dl> 2456 </dl>
2391 <a NAME="Project.deleteLanguageFile" ID="Project.deleteLanguageFile"></a> 2457 <a NAME="Project.deleteLanguageFile" ID="Project.deleteLanguageFile"></a>
2392 <h4>Project.deleteLanguageFile</h4> 2458 <h4>Project.deleteLanguageFile</h4>
2393 <b>deleteLanguageFile</b>(<i>langFile</i>) 2459 <b>deleteLanguageFile</b>(<i>langFile</i>)
2395 <p> 2461 <p>
2396 Public slot to delete a translation from the project directory. 2462 Public slot to delete a translation from the project directory.
2397 </p> 2463 </p>
2398 <dl> 2464 <dl>
2399 2465
2400 <dt><i>langFile</i></dt> 2466 <dt><i>langFile</i> (str)</dt>
2401 <dd> 2467 <dd>
2402 the translation file to be removed (string) 2468 the translation file to be removed
2403 </dd> 2469 </dd>
2404 </dl> 2470 </dl>
2405 <a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a> 2471 <a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a>
2406 <h4>Project.getAbsolutePath</h4> 2472 <h4>Project.getAbsolutePath</h4>
2407 <b>getAbsolutePath</b>(<i>fn</i>) 2473 <b>getAbsolutePath</b>(<i>fn</i>)
2410 Public method to convert a project relative file path to an absolute 2476 Public method to convert a project relative file path to an absolute
2411 file path. 2477 file path.
2412 </p> 2478 </p>
2413 <dl> 2479 <dl>
2414 2480
2415 <dt><i>fn</i></dt> 2481 <dt><i>fn</i> (str)</dt>
2416 <dd> 2482 <dd>
2417 file or directory name to convert (string) 2483 file or directory name to convert
2418 </dd> 2484 </dd>
2419 </dl> 2485 </dl>
2420 <dl> 2486 <dl>
2421 <dt>Return:</dt> 2487 <dt>Return:</dt>
2422 <dd> 2488 <dd>
2423 absolute path (string) 2489 absolute path
2490 </dd>
2491 </dl>
2492 <dl>
2493 <dt>Return Type:</dt>
2494 <dd>
2495 str
2424 </dd> 2496 </dd>
2425 </dl> 2497 </dl>
2426 <a NAME="Project.getAbsoluteUniversalPath" ID="Project.getAbsoluteUniversalPath"></a> 2498 <a NAME="Project.getAbsoluteUniversalPath" ID="Project.getAbsoluteUniversalPath"></a>
2427 <h4>Project.getAbsoluteUniversalPath</h4> 2499 <h4>Project.getAbsoluteUniversalPath</h4>
2428 <b>getAbsoluteUniversalPath</b>(<i>fn</i>) 2500 <b>getAbsoluteUniversalPath</b>(<i>fn</i>)
2431 Public method to convert a project relative file path with universal 2503 Public method to convert a project relative file path with universal
2432 separators to an absolute file path. 2504 separators to an absolute file path.
2433 </p> 2505 </p>
2434 <dl> 2506 <dl>
2435 2507
2436 <dt><i>fn</i></dt> 2508 <dt><i>fn</i> (str)</dt>
2437 <dd> 2509 <dd>
2438 file or directory name to convert (string) 2510 file or directory name to convert
2439 </dd> 2511 </dd>
2440 </dl> 2512 </dl>
2441 <dl> 2513 <dl>
2442 <dt>Return:</dt> 2514 <dt>Return:</dt>
2443 <dd> 2515 <dd>
2444 absolute path (string) 2516 absolute path
2517 </dd>
2518 </dl>
2519 <dl>
2520 <dt>Return Type:</dt>
2521 <dd>
2522 str
2445 </dd> 2523 </dd>
2446 </dl> 2524 </dl>
2447 <a NAME="Project.getActions" ID="Project.getActions"></a> 2525 <a NAME="Project.getActions" ID="Project.getActions"></a>
2448 <h4>Project.getActions</h4> 2526 <h4>Project.getActions</h4>
2449 <b>getActions</b>(<i></i>) 2527 <b>getActions</b>(<i></i>)
2452 Public method to get a list of all actions. 2530 Public method to get a list of all actions.
2453 </p> 2531 </p>
2454 <dl> 2532 <dl>
2455 <dt>Return:</dt> 2533 <dt>Return:</dt>
2456 <dd> 2534 <dd>
2457 list of all actions (list of EricAction) 2535 list of all actions
2536 </dd>
2537 </dl>
2538 <dl>
2539 <dt>Return Type:</dt>
2540 <dd>
2541 list of EricAction
2458 </dd> 2542 </dd>
2459 </dl> 2543 </dl>
2460 <a NAME="Project.getData" ID="Project.getData"></a> 2544 <a NAME="Project.getData" ID="Project.getData"></a>
2461 <h4>Project.getData</h4> 2545 <h4>Project.getData</h4>
2462 <b>getData</b>(<i>category, key, default=None</i>) 2546 <b>getData</b>(<i>category, key, default=None</i>)
2485 <dt>Return:</dt> 2569 <dt>Return:</dt>
2486 <dd> 2570 <dd>
2487 a copy of the requested data or None 2571 a copy of the requested data or None
2488 </dd> 2572 </dd>
2489 </dl> 2573 </dl>
2574 <dl>
2575 <dt>Return Type:</dt>
2576 <dd>
2577 Any
2578 </dd>
2579 </dl>
2490 <a NAME="Project.getDebugProperty" ID="Project.getDebugProperty"></a> 2580 <a NAME="Project.getDebugProperty" ID="Project.getDebugProperty"></a>
2491 <h4>Project.getDebugProperty</h4> 2581 <h4>Project.getDebugProperty</h4>
2492 <b>getDebugProperty</b>(<i>key</i>) 2582 <b>getDebugProperty</b>(<i>key</i>)
2493 2583
2494 <p> 2584 <p>
2495 Public method to retrieve a debugger property. 2585 Public method to retrieve a debugger property.
2496 </p> 2586 </p>
2497 <dl> 2587 <dl>
2498 2588
2499 <dt><i>key</i></dt> 2589 <dt><i>key</i> (str)</dt>
2500 <dd> 2590 <dd>
2501 key of the property (string) 2591 key of the property
2502 </dd> 2592 </dd>
2503 </dl> 2593 </dl>
2504 <dl> 2594 <dl>
2505 <dt>Return:</dt> 2595 <dt>Return:</dt>
2506 <dd> 2596 <dd>
2507 value of the property 2597 value of the property
2598 </dd>
2599 </dl>
2600 <dl>
2601 <dt>Return Type:</dt>
2602 <dd>
2603 Any
2508 </dd> 2604 </dd>
2509 </dl> 2605 </dl>
2510 <a NAME="Project.getDebuggerFilters" ID="Project.getDebuggerFilters"></a> 2606 <a NAME="Project.getDebuggerFilters" ID="Project.getDebuggerFilters"></a>
2511 <h4>Project.getDebuggerFilters</h4> 2607 <h4>Project.getDebuggerFilters</h4>
2512 <b>getDebuggerFilters</b>(<i>language</i>) 2608 <b>getDebuggerFilters</b>(<i>language</i>)
2561 programming language. 2657 programming language.
2562 </p> 2658 </p>
2563 <dl> 2659 <dl>
2564 <dt>Return:</dt> 2660 <dt>Return:</dt>
2565 <dd> 2661 <dd>
2566 default extension (including the dot) (string) 2662 default extension (including the dot)
2663 </dd>
2664 </dl>
2665 <dl>
2666 <dt>Return Type:</dt>
2667 <dd>
2668 str
2567 </dd> 2669 </dd>
2568 </dl> 2670 </dl>
2569 <a NAME="Project.getDocstringType" ID="Project.getDocstringType"></a> 2671 <a NAME="Project.getDocstringType" ID="Project.getDocstringType"></a>
2570 <h4>Project.getDocstringType</h4> 2672 <h4>Project.getDocstringType</h4>
2571 <b>getDocstringType</b>(<i></i>) 2673 <b>getDocstringType</b>(<i></i>)
2592 <p> 2694 <p>
2593 Public method to retrieve a lexer association. 2695 Public method to retrieve a lexer association.
2594 </p> 2696 </p>
2595 <dl> 2697 <dl>
2596 2698
2597 <dt><i>filename</i></dt> 2699 <dt><i>filename</i> (str)</dt>
2598 <dd> 2700 <dd>
2599 filename used to determine the associated lexer 2701 filename used to determine the associated lexer
2600 language (string) 2702 language
2601 </dd> 2703 </dd>
2602 </dl> 2704 </dl>
2603 <dl> 2705 <dl>
2604 <dt>Return:</dt> 2706 <dt>Return:</dt>
2605 <dd> 2707 <dd>
2606 the requested lexer language (string) 2708 the requested lexer language
2709 </dd>
2710 </dl>
2711 <dl>
2712 <dt>Return Type:</dt>
2713 <dd>
2714 str
2607 </dd> 2715 </dd>
2608 </dl> 2716 </dl>
2609 <a NAME="Project.getEolString" ID="Project.getEolString"></a> 2717 <a NAME="Project.getEolString" ID="Project.getEolString"></a>
2610 <h4>Project.getEolString</h4> 2718 <h4>Project.getEolString</h4>
2611 <b>getEolString</b>(<i></i>) 2719 <b>getEolString</b>(<i></i>)
2614 Public method to get the EOL-string to be used by the project. 2722 Public method to get the EOL-string to be used by the project.
2615 </p> 2723 </p>
2616 <dl> 2724 <dl>
2617 <dt>Return:</dt> 2725 <dt>Return:</dt>
2618 <dd> 2726 <dd>
2619 eol string (string) 2727 eol string
2728 </dd>
2729 </dl>
2730 <dl>
2731 <dt>Return Type:</dt>
2732 <dd>
2733 str
2620 </dd> 2734 </dd>
2621 </dl> 2735 </dl>
2622 <a NAME="Project.getFileCategories" ID="Project.getFileCategories"></a> 2736 <a NAME="Project.getFileCategories" ID="Project.getFileCategories"></a>
2623 <h4>Project.getFileCategories</h4> 2737 <h4>Project.getFileCategories</h4>
2624 <b>getFileCategories</b>(<i></i>) 2738 <b>getFileCategories</b>(<i></i>)
2802 <p> 2916 <p>
2803 Public method to get all files starting with a common prefix. 2917 Public method to get all files starting with a common prefix.
2804 </p> 2918 </p>
2805 <dl> 2919 <dl>
2806 2920
2807 <dt><i>start</i></dt> 2921 <dt><i>start</i> (str)</dt>
2808 <dd> 2922 <dd>
2809 prefix (string) 2923 prefix
2810 </dd> 2924 </dd>
2811 </dl> 2925 </dl>
2812 <dl> 2926 <dl>
2813 <dt>Return:</dt> 2927 <dt>Return:</dt>
2814 <dd> 2928 <dd>
2815 list of files starting with a common prefix (list of strings) 2929 list of files starting with a common prefix
2930 </dd>
2931 </dl>
2932 <dl>
2933 <dt>Return Type:</dt>
2934 <dd>
2935 list of str
2816 </dd> 2936 </dd>
2817 </dl> 2937 </dl>
2818 <a NAME="Project.getFiletypeAssociations" ID="Project.getFiletypeAssociations"></a> 2938 <a NAME="Project.getFiletypeAssociations" ID="Project.getFiletypeAssociations"></a>
2819 <h4>Project.getFiletypeAssociations</h4> 2939 <h4>Project.getFiletypeAssociations</h4>
2820 <b>getFiletypeAssociations</b>(<i>associationType</i>) 2940 <b>getFiletypeAssociations</b>(<i>associationType</i>)
2851 Public method to get the project hash. 2971 Public method to get the project hash.
2852 </p> 2972 </p>
2853 <dl> 2973 <dl>
2854 <dt>Return:</dt> 2974 <dt>Return:</dt>
2855 <dd> 2975 <dd>
2856 project hash as a hex string (string) 2976 project hash as a hex string
2977 </dd>
2978 </dl>
2979 <dl>
2980 <dt>Return Type:</dt>
2981 <dd>
2982 str
2857 </dd> 2983 </dd>
2858 </dl> 2984 </dl>
2859 <a NAME="Project.getIgnorePatterns" ID="Project.getIgnorePatterns"></a> 2985 <a NAME="Project.getIgnorePatterns" ID="Project.getIgnorePatterns"></a>
2860 <h4>Project.getIgnorePatterns</h4> 2986 <h4>Project.getIgnorePatterns</h4>
2861 <b>getIgnorePatterns</b>(<i></i>) 2987 <b>getIgnorePatterns</b>(<i></i>)
2913 <p> 3039 <p>
2914 Public method to get a reference to the main menu or a submenu. 3040 Public method to get a reference to the main menu or a submenu.
2915 </p> 3041 </p>
2916 <dl> 3042 <dl>
2917 3043
2918 <dt><i>menuName</i></dt> 3044 <dt><i>menuName</i> (str)</dt>
2919 <dd> 3045 <dd>
2920 name of the menu (string) 3046 name of the menu
2921 </dd> 3047 </dd>
2922 </dl> 3048 </dl>
2923 <dl> 3049 <dl>
2924 <dt>Return:</dt> 3050 <dt>Return:</dt>
2925 <dd> 3051 <dd>
2926 reference to the requested menu (QMenu) or None 3052 reference to the requested menu or None
3053 </dd>
3054 </dl>
3055 <dl>
3056 <dt>Return Type:</dt>
3057 <dd>
3058 QMenu
2927 </dd> 3059 </dd>
2928 </dl> 3060 </dl>
2929 <a NAME="Project.getModel" ID="Project.getModel"></a> 3061 <a NAME="Project.getModel" ID="Project.getModel"></a>
2930 <h4>Project.getModel</h4> 3062 <h4>Project.getModel</h4>
2931 <b>getModel</b>(<i></i>) 3063 <b>getModel</b>(<i></i>)
2934 Public method to get a reference to the project browser model. 3066 Public method to get a reference to the project browser model.
2935 </p> 3067 </p>
2936 <dl> 3068 <dl>
2937 <dt>Return:</dt> 3069 <dt>Return:</dt>
2938 <dd> 3070 <dd>
2939 reference to the project browser model (ProjectBrowserModel) 3071 reference to the project browser model
3072 </dd>
3073 </dl>
3074 <dl>
3075 <dt>Return Type:</dt>
3076 <dd>
3077 ProjectBrowserModel
2940 </dd> 3078 </dd>
2941 </dl> 3079 </dl>
2942 <a NAME="Project.getMostRecent" ID="Project.getMostRecent"></a> 3080 <a NAME="Project.getMostRecent" ID="Project.getMostRecent"></a>
2943 <h4>Project.getMostRecent</h4> 3081 <h4>Project.getMostRecent</h4>
2944 <b>getMostRecent</b>(<i></i>) 3082 <b>getMostRecent</b>(<i></i>)
2947 Public method to get the most recently opened project. 3085 Public method to get the most recently opened project.
2948 </p> 3086 </p>
2949 <dl> 3087 <dl>
2950 <dt>Return:</dt> 3088 <dt>Return:</dt>
2951 <dd> 3089 <dd>
2952 path of the most recently opened project (string) 3090 path of the most recently opened project
3091 </dd>
3092 </dl>
3093 <dl>
3094 <dt>Return Type:</dt>
3095 <dd>
3096 str
2953 </dd> 3097 </dd>
2954 </dl> 3098 </dl>
2955 <a NAME="Project.getProgrammingLanguages" ID="Project.getProgrammingLanguages"></a> 3099 <a NAME="Project.getProgrammingLanguages" ID="Project.getProgrammingLanguages"></a>
2956 <h4>Project.getProgrammingLanguages</h4> 3100 <h4>Project.getProgrammingLanguages</h4>
2957 <b>getProgrammingLanguages</b>(<i></i>) 3101 <b>getProgrammingLanguages</b>(<i></i>)
2960 Public method to get the programming languages supported by project. 3104 Public method to get the programming languages supported by project.
2961 </p> 3105 </p>
2962 <dl> 3106 <dl>
2963 <dt>Return:</dt> 3107 <dt>Return:</dt>
2964 <dd> 3108 <dd>
2965 list of supported programming languages (list of string) 3109 list of supported programming languages
3110 </dd>
3111 </dl>
3112 <dl>
3113 <dt>Return Type:</dt>
3114 <dd>
3115 list of str
2966 </dd> 3116 </dd>
2967 </dl> 3117 </dl>
2968 <a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a> 3118 <a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a>
2969 <h4>Project.getProjectAuthor</h4> 3119 <h4>Project.getProjectAuthor</h4>
2970 <b>getProjectAuthor</b>(<i></i>) 3120 <b>getProjectAuthor</b>(<i></i>)
3065 Public method to get the names of the project specific dictionaries. 3215 Public method to get the names of the project specific dictionaries.
3066 </p> 3216 </p>
3067 <dl> 3217 <dl>
3068 <dt>Return:</dt> 3218 <dt>Return:</dt>
3069 <dd> 3219 <dd>
3070 tuple of two strings giving the absolute path names of the 3220 tuple containing the absolute path names of the project specific
3071 project specific word and exclude list 3221 word and exclude list
3222 </dd>
3223 </dl>
3224 <dl>
3225 <dt>Return Type:</dt>
3226 <dd>
3227 tuple of (str, str)
3072 </dd> 3228 </dd>
3073 </dl> 3229 </dl>
3074 <a NAME="Project.getProjectExecPath" ID="Project.getProjectExecPath"></a> 3230 <a NAME="Project.getProjectExecPath" ID="Project.getProjectExecPath"></a>
3075 <h4>Project.getProjectExecPath</h4> 3231 <h4>Project.getProjectExecPath</h4>
3076 <b>getProjectExecPath</b>(<i></i>) 3232 <b>getProjectExecPath</b>(<i></i>)
3098 Public method to get the path of the project file. 3254 Public method to get the path of the project file.
3099 </p> 3255 </p>
3100 <dl> 3256 <dl>
3101 <dt>Return:</dt> 3257 <dt>Return:</dt>
3102 <dd> 3258 <dd>
3103 path of the project file (string) 3259 path of the project file
3260 </dd>
3261 </dl>
3262 <dl>
3263 <dt>Return Type:</dt>
3264 <dd>
3265 str
3104 </dd> 3266 </dd>
3105 </dl> 3267 </dl>
3106 <a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a> 3268 <a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a>
3107 <h4>Project.getProjectFiles</h4> 3269 <h4>Project.getProjectFiles</h4>
3108 <b>getProjectFiles</b>(<i>fileType, normalized=False</i>) 3270 <b>getProjectFiles</b>(<i>fileType, normalized=False</i>)
3176 Public method to get the project's programming language. 3338 Public method to get the project's programming language.
3177 </p> 3339 </p>
3178 <dl> 3340 <dl>
3179 <dt>Return:</dt> 3341 <dt>Return:</dt>
3180 <dd> 3342 <dd>
3181 programming language (string) 3343 programming language
3344 </dd>
3345 </dl>
3346 <dl>
3347 <dt>Return Type:</dt>
3348 <dd>
3349 str
3182 </dd> 3350 </dd>
3183 </dl> 3351 </dl>
3184 <a NAME="Project.getProjectLicense" ID="Project.getProjectLicense"></a> 3352 <a NAME="Project.getProjectLicense" ID="Project.getProjectLicense"></a>
3185 <h4>Project.getProjectLicense</h4> 3353 <h4>Project.getProjectLicense</h4>
3186 <b>getProjectLicense</b>(<i></i>) 3354 <b>getProjectLicense</b>(<i></i>)
3208 Public method to get the path of the management directory. 3376 Public method to get the path of the management directory.
3209 </p> 3377 </p>
3210 <dl> 3378 <dl>
3211 <dt>Return:</dt> 3379 <dt>Return:</dt>
3212 <dd> 3380 <dd>
3213 path of the management directory (string) 3381 path of the management directory
3382 </dd>
3383 </dl>
3384 <dl>
3385 <dt>Return Type:</dt>
3386 <dd>
3387 str
3214 </dd> 3388 </dd>
3215 </dl> 3389 </dl>
3216 <a NAME="Project.getProjectName" ID="Project.getProjectName"></a> 3390 <a NAME="Project.getProjectName" ID="Project.getProjectName"></a>
3217 <h4>Project.getProjectName</h4> 3391 <h4>Project.getProjectName</h4>
3218 <b>getProjectName</b>(<i></i>) 3392 <b>getProjectName</b>(<i></i>)
3224 The project name is determined from the name of the project file. 3398 The project name is determined from the name of the project file.
3225 </p> 3399 </p>
3226 <dl> 3400 <dl>
3227 <dt>Return:</dt> 3401 <dt>Return:</dt>
3228 <dd> 3402 <dd>
3229 name of the project (string) 3403 name of the project
3404 </dd>
3405 </dl>
3406 <dl>
3407 <dt>Return Type:</dt>
3408 <dd>
3409 str
3230 </dd> 3410 </dd>
3231 </dl> 3411 </dl>
3232 <a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a> 3412 <a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a>
3233 <h4>Project.getProjectPath</h4> 3413 <h4>Project.getProjectPath</h4>
3234 <b>getProjectPath</b>(<i></i>) 3414 <b>getProjectPath</b>(<i></i>)
3237 Public method to get the project path. 3417 Public method to get the project path.
3238 </p> 3418 </p>
3239 <dl> 3419 <dl>
3240 <dt>Return:</dt> 3420 <dt>Return:</dt>
3241 <dd> 3421 <dd>
3242 project path (string) 3422 project path
3423 </dd>
3424 </dl>
3425 <dl>
3426 <dt>Return Type:</dt>
3427 <dd>
3428 str
3243 </dd> 3429 </dd>
3244 </dl> 3430 </dl>
3245 <a NAME="Project.getProjectSpellLanguage" ID="Project.getProjectSpellLanguage"></a> 3431 <a NAME="Project.getProjectSpellLanguage" ID="Project.getProjectSpellLanguage"></a>
3246 <h4>Project.getProjectSpellLanguage</h4> 3432 <h4>Project.getProjectSpellLanguage</h4>
3247 <b>getProjectSpellLanguage</b>(<i></i>) 3433 <b>getProjectSpellLanguage</b>(<i></i>)
3250 Public method to get the project's programming language. 3436 Public method to get the project's programming language.
3251 </p> 3437 </p>
3252 <dl> 3438 <dl>
3253 <dt>Return:</dt> 3439 <dt>Return:</dt>
3254 <dd> 3440 <dd>
3255 programming language (string) 3441 programming language
3442 </dd>
3443 </dl>
3444 <dl>
3445 <dt>Return Type:</dt>
3446 <dd>
3447 str
3256 </dd> 3448 </dd>
3257 </dl> 3449 </dl>
3258 <a NAME="Project.getProjectTestingFramework" ID="Project.getProjectTestingFramework"></a> 3450 <a NAME="Project.getProjectTestingFramework" ID="Project.getProjectTestingFramework"></a>
3259 <h4>Project.getProjectTestingFramework</h4> 3451 <h4>Project.getProjectTestingFramework</h4>
3260 <b>getProjectTestingFramework</b>(<i></i>) 3452 <b>getProjectTestingFramework</b>(<i></i>)
3282 Public method to get the type of the project. 3474 Public method to get the type of the project.
3283 </p> 3475 </p>
3284 <dl> 3476 <dl>
3285 <dt>Return:</dt> 3477 <dt>Return:</dt>
3286 <dd> 3478 <dd>
3287 UI type of the project (string) 3479 UI type of the project
3480 </dd>
3481 </dl>
3482 <dl>
3483 <dt>Return Type:</dt>
3484 <dd>
3485 str
3288 </dd> 3486 </dd>
3289 </dl> 3487 </dl>
3290 <a NAME="Project.getProjectTypes" ID="Project.getProjectTypes"></a> 3488 <a NAME="Project.getProjectTypes" ID="Project.getProjectTypes"></a>
3291 <h4>Project.getProjectTypes</h4> 3489 <h4>Project.getProjectTypes</h4>
3292 <b>getProjectTypes</b>(<i>progLanguage=""</i>) 3490 <b>getProjectTypes</b>(<i>progLanguage=""</i>)
3294 <p> 3492 <p>
3295 Public method to get the list of supported project types. 3493 Public method to get the list of supported project types.
3296 </p> 3494 </p>
3297 <dl> 3495 <dl>
3298 3496
3299 <dt><i>progLanguage</i></dt> 3497 <dt><i>progLanguage</i> (str)</dt>
3300 <dd> 3498 <dd>
3301 programming language to get project types for 3499 programming language to get project types for
3302 (string)
3303 </dd> 3500 </dd>
3304 </dl> 3501 </dl>
3305 <dl> 3502 <dl>
3306 <dt>Return:</dt> 3503 <dt>Return:</dt>
3307 <dd> 3504 <dd>
3308 reference to the dictionary of project types. 3505 reference to the dictionary of project types.
3506 </dd>
3507 </dl>
3508 <dl>
3509 <dt>Return Type:</dt>
3510 <dd>
3511 dict
3309 </dd> 3512 </dd>
3310 </dl> 3513 </dl>
3311 <a NAME="Project.getProjectVenv" ID="Project.getProjectVenv"></a> 3514 <a NAME="Project.getProjectVenv" ID="Project.getProjectVenv"></a>
3312 <h4>Project.getProjectVenv</h4> 3515 <h4>Project.getProjectVenv</h4>
3313 <b>getProjectVenv</b>(<i>resolveDebugger=True</i>) 3516 <b>getProjectVenv</b>(<i>resolveDebugger=True</i>)
3382 Public method to convert a file path to a project relative 3585 Public method to convert a file path to a project relative
3383 file path. 3586 file path.
3384 </p> 3587 </p>
3385 <dl> 3588 <dl>
3386 3589
3387 <dt><i>path</i></dt> 3590 <dt><i>path</i> (str)</dt>
3388 <dd> 3591 <dd>
3389 file or directory name to convert (string) 3592 file or directory name to convert
3390 </dd> 3593 </dd>
3391 </dl> 3594 </dl>
3392 <dl> 3595 <dl>
3393 <dt>Return:</dt> 3596 <dt>Return:</dt>
3394 <dd> 3597 <dd>
3395 project relative path or unchanged path, if path doesn't 3598 project relative path or unchanged path, if path doesn't
3396 belong to the project (string) 3599 belong to the project
3600 </dd>
3601 </dl>
3602 <dl>
3603 <dt>Return Type:</dt>
3604 <dd>
3605 str
3397 </dd> 3606 </dd>
3398 </dl> 3607 </dl>
3399 <a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a> 3608 <a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a>
3400 <h4>Project.getRelativeUniversalPath</h4> 3609 <h4>Project.getRelativeUniversalPath</h4>
3401 <b>getRelativeUniversalPath</b>(<i>path</i>) 3610 <b>getRelativeUniversalPath</b>(<i>path</i>)
3404 Public method to convert a file path to a project relative 3613 Public method to convert a file path to a project relative
3405 file path with universal separators. 3614 file path with universal separators.
3406 </p> 3615 </p>
3407 <dl> 3616 <dl>
3408 3617
3409 <dt><i>path</i></dt> 3618 <dt><i>path</i> (str)</dt>
3410 <dd> 3619 <dd>
3411 file or directory name to convert (string) 3620 file or directory name to convert
3412 </dd> 3621 </dd>
3413 </dl> 3622 </dl>
3414 <dl> 3623 <dl>
3415 <dt>Return:</dt> 3624 <dt>Return:</dt>
3416 <dd> 3625 <dd>
3417 project relative path or unchanged path, if path doesn't 3626 project relative path or unchanged path, if path doesn't
3418 belong to the project (string) 3627 belong to the project
3628 </dd>
3629 </dl>
3630 <dl>
3631 <dt>Return Type:</dt>
3632 <dd>
3633 str
3419 </dd> 3634 </dd>
3420 </dl> 3635 </dl>
3421 <a NAME="Project.getSources" ID="Project.getSources"></a> 3636 <a NAME="Project.getSources" ID="Project.getSources"></a>
3422 <h4>Project.getSources</h4> 3637 <h4>Project.getSources</h4>
3423 <b>getSources</b>(<i>normalized=False</i>) 3638 <b>getSources</b>(<i>normalized=False</i>)
3452 Public method to retrieve the status of the auto update function. 3667 Public method to retrieve the status of the auto update function.
3453 </p> 3668 </p>
3454 <dl> 3669 <dl>
3455 <dt>Return:</dt> 3670 <dt>Return:</dt>
3456 <dd> 3671 <dd>
3457 status of the auto update function (boolean) 3672 status of the auto update function
3673 </dd>
3674 </dl>
3675 <dl>
3676 <dt>Return Type:</dt>
3677 <dd>
3678 bool
3458 </dd> 3679 </dd>
3459 </dl> 3680 </dl>
3460 <a NAME="Project.getStatusMonitorInterval" ID="Project.getStatusMonitorInterval"></a> 3681 <a NAME="Project.getStatusMonitorInterval" ID="Project.getStatusMonitorInterval"></a>
3461 <h4>Project.getStatusMonitorInterval</h4> 3682 <h4>Project.getStatusMonitorInterval</h4>
3462 <b>getStatusMonitorInterval</b>(<i></i>) 3683 <b>getStatusMonitorInterval</b>(<i></i>)
3465 Public method to get the monitor interval. 3686 Public method to get the monitor interval.
3466 </p> 3687 </p>
3467 <dl> 3688 <dl>
3468 <dt>Return:</dt> 3689 <dt>Return:</dt>
3469 <dd> 3690 <dd>
3470 interval in seconds (integer) 3691 interval in seconds
3692 </dd>
3693 </dl>
3694 <dl>
3695 <dt>Return Type:</dt>
3696 <dd>
3697 int
3471 </dd> 3698 </dd>
3472 </dl> 3699 </dl>
3473 <a NAME="Project.getTranslationPattern" ID="Project.getTranslationPattern"></a> 3700 <a NAME="Project.getTranslationPattern" ID="Project.getTranslationPattern"></a>
3474 <h4>Project.getTranslationPattern</h4> 3701 <h4>Project.getTranslationPattern</h4>
3475 <b>getTranslationPattern</b>(<i></i>) 3702 <b>getTranslationPattern</b>(<i></i>)
3478 Public method to get the translation pattern. 3705 Public method to get the translation pattern.
3479 </p> 3706 </p>
3480 <dl> 3707 <dl>
3481 <dt>Return:</dt> 3708 <dt>Return:</dt>
3482 <dd> 3709 <dd>
3483 translation pattern (string) 3710 translation pattern
3711 </dd>
3712 </dl>
3713 <dl>
3714 <dt>Return Type:</dt>
3715 <dd>
3716 str
3484 </dd> 3717 </dd>
3485 </dl> 3718 </dl>
3486 <a NAME="Project.getUicParameter" ID="Project.getUicParameter"></a> 3719 <a NAME="Project.getUicParameter" ID="Project.getUicParameter"></a>
3487 <h4>Project.getUicParameter</h4> 3720 <h4>Project.getUicParameter</h4>
3488 <b>getUicParameter</b>(<i>name</i>) 3721 <b>getUicParameter</b>(<i>name</i>)
3520 <dt>Return:</dt> 3753 <dt>Return:</dt>
3521 <dd> 3754 <dd>
3522 reference to the VCS object 3755 reference to the VCS object
3523 </dd> 3756 </dd>
3524 </dl> 3757 </dl>
3758 <dl>
3759 <dt>Return Type:</dt>
3760 <dd>
3761 VersionControl
3762 </dd>
3763 </dl>
3525 <a NAME="Project.handleApplicationDiagram" ID="Project.handleApplicationDiagram"></a> 3764 <a NAME="Project.handleApplicationDiagram" ID="Project.handleApplicationDiagram"></a>
3526 <h4>Project.handleApplicationDiagram</h4> 3765 <h4>Project.handleApplicationDiagram</h4>
3527 <b>handleApplicationDiagram</b>(<i></i>) 3766 <b>handleApplicationDiagram</b>(<i></i>)
3528 3767
3529 <p> 3768 <p>
3623 <p> 3862 <p>
3624 Public method to check the project for a file. 3863 Public method to check the project for a file.
3625 </p> 3864 </p>
3626 <dl> 3865 <dl>
3627 3866
3628 <dt><i>fn</i></dt> 3867 <dt><i>fn</i> (str)</dt>
3629 <dd> 3868 <dd>
3630 filename to be checked (string) 3869 filename to be checked
3631 </dd> 3870 </dd>
3632 </dl> 3871 </dl>
3633 <dl> 3872 <dl>
3634 <dt>Return:</dt> 3873 <dt>Return:</dt>
3635 <dd> 3874 <dd>
3636 flag indicating, if the project contains the file (boolean) 3875 flag indicating, if the project contains the file
3876 </dd>
3877 </dl>
3878 <dl>
3879 <dt>Return Type:</dt>
3880 <dd>
3881 bool
3637 </dd> 3882 </dd>
3638 </dl> 3883 </dl>
3639 <a NAME="Project.hasProjectType" ID="Project.hasProjectType"></a> 3884 <a NAME="Project.hasProjectType" ID="Project.hasProjectType"></a>
3640 <h4>Project.hasProjectType</h4> 3885 <h4>Project.hasProjectType</h4>
3641 <b>hasProjectType</b>(<i>type_, progLanguage=""</i>) 3886 <b>hasProjectType</b>(<i>type_, progLanguage=""</i>)
3643 <p> 3888 <p>
3644 Public method to check, if a project type is already registered. 3889 Public method to check, if a project type is already registered.
3645 </p> 3890 </p>
3646 <dl> 3891 <dl>
3647 3892
3648 <dt><i>type_</i></dt> 3893 <dt><i>type_</i> (str)</dt>
3649 <dd> 3894 <dd>
3650 internal type designator (string) 3895 internal type designator
3651 </dd> 3896 </dd>
3652 <dt><i>progLanguage</i></dt> 3897 <dt><i>progLanguage</i> (str)</dt>
3653 <dd> 3898 <dd>
3654 programming language of the project type (string) 3899 programming language of the project type
3655 </dd> 3900 </dd>
3656 </dl> 3901 </dl>
3657 <dl> 3902 <dl>
3658 <dt>Return:</dt> 3903 <dt>Return:</dt>
3659 <dd> 3904 <dd>
3660 flag indicating presence of the project type (boolean) 3905 flag indicating presence of the project type
3906 </dd>
3907 </dl>
3908 <dl>
3909 <dt>Return Type:</dt>
3910 <dd>
3911 bool
3661 </dd> 3912 </dd>
3662 </dl> 3913 </dl>
3663 <a NAME="Project.initActions" ID="Project.initActions"></a> 3914 <a NAME="Project.initActions" ID="Project.initActions"></a>
3664 <h4>Project.initActions</h4> 3915 <h4>Project.initActions</h4>
3665 <b>initActions</b>(<i></i>) 3916 <b>initActions</b>(<i></i>)
3702 Public slot to initialize the project toolbar and the basic VCS 3953 Public slot to initialize the project toolbar and the basic VCS
3703 toolbar. 3954 toolbar.
3704 </p> 3955 </p>
3705 <dl> 3956 <dl>
3706 3957
3707 <dt><i>toolbarManager</i></dt> 3958 <dt><i>toolbarManager</i> (EricToolBarManager)</dt>
3708 <dd> 3959 <dd>
3709 reference to a toolbar manager object 3960 reference to a toolbar manager object
3710 (EricToolBarManager) 3961 </dd>
3711 </dd> 3962 </dl>
3712 </dl> 3963 <dl>
3713 <dl> 3964 <dt>Return:</dt>
3714 <dt>Return:</dt> 3965 <dd>
3715 <dd> 3966 tuple of the generated toolbars
3716 tuple of the generated toolbars (tuple of two QToolBar) 3967 </dd>
3968 </dl>
3969 <dl>
3970 <dt>Return Type:</dt>
3971 <dd>
3972 tuple of two QToolBar
3717 </dd> 3973 </dd>
3718 </dl> 3974 </dl>
3719 <a NAME="Project.initVCS" ID="Project.initVCS"></a> 3975 <a NAME="Project.initVCS" ID="Project.initVCS"></a>
3720 <h4>Project.initVCS</h4> 3976 <h4>Project.initVCS</h4>
3721 <b>initVCS</b>(<i>vcsSystem=None, nooverride=False</i>) 3977 <b>initVCS</b>(<i>vcsSystem=None, nooverride=False</i>)
3723 <p> 3979 <p>
3724 Public method used to instantiate a vcs system. 3980 Public method used to instantiate a vcs system.
3725 </p> 3981 </p>
3726 <dl> 3982 <dl>
3727 3983
3728 <dt><i>vcsSystem</i></dt> 3984 <dt><i>vcsSystem</i> (str)</dt>
3729 <dd> 3985 <dd>
3730 type of VCS to be used (string) 3986 type of VCS to be used
3731 </dd> 3987 </dd>
3732 <dt><i>nooverride</i></dt> 3988 <dt><i>nooverride</i> (bool)</dt>
3733 <dd> 3989 <dd>
3734 flag indicating to ignore an override request 3990 flag indicating to ignore an override request
3735 (boolean)
3736 </dd> 3991 </dd>
3737 </dl> 3992 </dl>
3738 <dl> 3993 <dl>
3739 <dt>Return:</dt> 3994 <dt>Return:</dt>
3740 <dd> 3995 <dd>
3741 a reference to the vcs object 3996 a reference to the vcs object
3997 </dd>
3998 </dl>
3999 <dl>
4000 <dt>Return Type:</dt>
4001 <dd>
4002 VersionControl
3742 </dd> 4003 </dd>
3743 </dl> 4004 </dl>
3744 <a NAME="Project.isDebugPropertiesLoaded" ID="Project.isDebugPropertiesLoaded"></a> 4005 <a NAME="Project.isDebugPropertiesLoaded" ID="Project.isDebugPropertiesLoaded"></a>
3745 <h4>Project.isDebugPropertiesLoaded</h4> 4006 <h4>Project.isDebugPropertiesLoaded</h4>
3746 <b>isDebugPropertiesLoaded</b>(<i></i>) 4007 <b>isDebugPropertiesLoaded</b>(<i></i>)
3749 Public method to return the status of the debug properties. 4010 Public method to return the status of the debug properties.
3750 </p> 4011 </p>
3751 <dl> 4012 <dl>
3752 <dt>Return:</dt> 4013 <dt>Return:</dt>
3753 <dd> 4014 <dd>
3754 load status of debug properties (boolean) 4015 load status of debug properties
4016 </dd>
4017 </dl>
4018 <dl>
4019 <dt>Return Type:</dt>
4020 <dd>
4021 bool
3755 </dd> 4022 </dd>
3756 </dl> 4023 </dl>
3757 <a NAME="Project.isDirty" ID="Project.isDirty"></a> 4024 <a NAME="Project.isDirty" ID="Project.isDirty"></a>
3758 <h4>Project.isDirty</h4> 4025 <h4>Project.isDirty</h4>
3759 <b>isDirty</b>(<i></i>) 4026 <b>isDirty</b>(<i></i>)
3762 Public method to return the dirty state. 4029 Public method to return the dirty state.
3763 </p> 4030 </p>
3764 <dl> 4031 <dl>
3765 <dt>Return:</dt> 4032 <dt>Return:</dt>
3766 <dd> 4033 <dd>
3767 dirty state (boolean) 4034 dirty state
4035 </dd>
4036 </dl>
4037 <dl>
4038 <dt>Return Type:</dt>
4039 <dd>
4040 bool
3768 </dd> 4041 </dd>
3769 </dl> 4042 </dl>
3770 <a NAME="Project.isJavaScriptProject" ID="Project.isJavaScriptProject"></a> 4043 <a NAME="Project.isJavaScriptProject" ID="Project.isJavaScriptProject"></a>
3771 <h4>Project.isJavaScriptProject</h4> 4044 <h4>Project.isJavaScriptProject</h4>
3772 <b>isJavaScriptProject</b>(<i></i>) 4045 <b>isJavaScriptProject</b>(<i></i>)
3775 Public method to check, if this project is a JavaScript project. 4048 Public method to check, if this project is a JavaScript project.
3776 </p> 4049 </p>
3777 <dl> 4050 <dl>
3778 <dt>Return:</dt> 4051 <dt>Return:</dt>
3779 <dd> 4052 <dd>
3780 flag indicating a JavaScript project (boolean) 4053 flag indicating a JavaScript project
4054 </dd>
4055 </dl>
4056 <dl>
4057 <dt>Return Type:</dt>
4058 <dd>
4059 bool
3781 </dd> 4060 </dd>
3782 </dl> 4061 </dl>
3783 <a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a> 4062 <a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a>
3784 <h4>Project.isMakeEnabled</h4> 4063 <h4>Project.isMakeEnabled</h4>
3785 <b>isMakeEnabled</b>(<i></i>) 4064 <b>isMakeEnabled</b>(<i></i>)
3845 Public method to return the opened state. 4124 Public method to return the opened state.
3846 </p> 4125 </p>
3847 <dl> 4126 <dl>
3848 <dt>Return:</dt> 4127 <dt>Return:</dt>
3849 <dd> 4128 <dd>
3850 open state (boolean) 4129 open state
4130 </dd>
4131 </dl>
4132 <dl>
4133 <dt>Return Type:</dt>
4134 <dd>
4135 bool
3851 </dd> 4136 </dd>
3852 </dl> 4137 </dl>
3853 <a NAME="Project.isProjectCategory" ID="Project.isProjectCategory"></a> 4138 <a NAME="Project.isProjectCategory" ID="Project.isProjectCategory"></a>
3854 <h4>Project.isProjectCategory</h4> 4139 <h4>Project.isProjectCategory</h4>
3855 <b>isProjectCategory</b>(<i>fn, category</i>) 4140 <b>isProjectCategory</b>(<i>fn, category</i>)
3889 Public method used to check, if the passed in filename belongs to the 4174 Public method used to check, if the passed in filename belongs to the
3890 project. 4175 project.
3891 </p> 4176 </p>
3892 <dl> 4177 <dl>
3893 4178
3894 <dt><i>fn</i></dt> 4179 <dt><i>fn</i> (str)</dt>
3895 <dd> 4180 <dd>
3896 filename to be checked (string) 4181 filename to be checked
3897 </dd> 4182 </dd>
3898 </dl> 4183 </dl>
3899 <dl> 4184 <dl>
3900 <dt>Return:</dt> 4185 <dt>Return:</dt>
3901 <dd> 4186 <dd>
3902 flag indicating membership (boolean) 4187 flag indicating membership
4188 </dd>
4189 </dl>
4190 <dl>
4191 <dt>Return Type:</dt>
4192 <dd>
4193 bool
3903 </dd> 4194 </dd>
3904 </dl> 4195 </dl>
3905 <a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a> 4196 <a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a>
3906 <h4>Project.isPy3Project</h4> 4197 <h4>Project.isPy3Project</h4>
3907 <b>isPy3Project</b>(<i></i>) 4198 <b>isPy3Project</b>(<i></i>)
3910 Public method to check, if this project is a Python3 project. 4201 Public method to check, if this project is a Python3 project.
3911 </p> 4202 </p>
3912 <dl> 4203 <dl>
3913 <dt>Return:</dt> 4204 <dt>Return:</dt>
3914 <dd> 4205 <dd>
3915 flag indicating a Python3 project (boolean) 4206 flag indicating a Python3 project
4207 </dd>
4208 </dl>
4209 <dl>
4210 <dt>Return Type:</dt>
4211 <dd>
4212 bool
3916 </dd> 4213 </dd>
3917 </dl> 4214 </dl>
3918 <a NAME="Project.isPythonProject" ID="Project.isPythonProject"></a> 4215 <a NAME="Project.isPythonProject" ID="Project.isPythonProject"></a>
3919 <h4>Project.isPythonProject</h4> 4216 <h4>Project.isPythonProject</h4>
3920 <b>isPythonProject</b>(<i></i>) 4217 <b>isPythonProject</b>(<i></i>)
3924 project. 4221 project.
3925 </p> 4222 </p>
3926 <dl> 4223 <dl>
3927 <dt>Return:</dt> 4224 <dt>Return:</dt>
3928 <dd> 4225 <dd>
3929 flag indicating a Python project (boolean) 4226 flag indicating a Python project
4227 </dd>
4228 </dl>
4229 <dl>
4230 <dt>Return Type:</dt>
4231 <dd>
4232 bool
3930 </dd> 4233 </dd>
3931 </dl> 4234 </dl>
3932 <a NAME="Project.isRubyProject" ID="Project.isRubyProject"></a> 4235 <a NAME="Project.isRubyProject" ID="Project.isRubyProject"></a>
3933 <h4>Project.isRubyProject</h4> 4236 <h4>Project.isRubyProject</h4>
3934 <b>isRubyProject</b>(<i></i>) 4237 <b>isRubyProject</b>(<i></i>)
3937 Public method to check, if this project is a Ruby project. 4240 Public method to check, if this project is a Ruby project.
3938 </p> 4241 </p>
3939 <dl> 4242 <dl>
3940 <dt>Return:</dt> 4243 <dt>Return:</dt>
3941 <dd> 4244 <dd>
3942 flag indicating a Ruby project (boolean) 4245 flag indicating a Ruby project
4246 </dd>
4247 </dl>
4248 <dl>
4249 <dt>Return Type:</dt>
4250 <dd>
4251 bool
3943 </dd> 4252 </dd>
3944 </dl> 4253 </dl>
3945 <a NAME="Project.isVcsControlled" ID="Project.isVcsControlled"></a> 4254 <a NAME="Project.isVcsControlled" ID="Project.isVcsControlled"></a>
3946 <h4>Project.isVcsControlled</h4> 4255 <h4>Project.isVcsControlled</h4>
3947 <b>isVcsControlled</b>(<i></i>) 4256 <b>isVcsControlled</b>(<i></i>)
3968 <p> 4277 <p>
3969 Public slot to move a directory. 4278 Public slot to move a directory.
3970 </p> 4279 </p>
3971 <dl> 4280 <dl>
3972 4281
3973 <dt><i>olddn</i></dt> 4282 <dt><i>olddn</i> (str)</dt>
3974 <dd> 4283 <dd>
3975 old directory name (string) 4284 old directory name
3976 </dd> 4285 </dd>
3977 <dt><i>newdn</i></dt> 4286 <dt><i>newdn</i> (str)</dt>
3978 <dd> 4287 <dd>
3979 new directory name (string) 4288 new directory name
3980 </dd> 4289 </dd>
3981 </dl> 4290 </dl>
3982 <a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a> 4291 <a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a>
3983 <h4>Project.newProjectAddFiles</h4> 4292 <h4>Project.newProjectAddFiles</h4>
3984 <b>newProjectAddFiles</b>(<i>mainscript</i>) 4293 <b>newProjectAddFiles</b>(<i>mainscript</i>)
3986 <p> 4295 <p>
3987 Public method to add files to a new project. 4296 Public method to add files to a new project.
3988 </p> 4297 </p>
3989 <dl> 4298 <dl>
3990 4299
3991 <dt><i>mainscript</i></dt> 4300 <dt><i>mainscript</i> (str)</dt>
3992 <dd> 4301 <dd>
3993 name of the mainscript (string) 4302 name of the mainscript
3994 </dd> 4303 </dd>
3995 </dl> 4304 </dl>
3996 <a NAME="Project.openProject" ID="Project.openProject"></a> 4305 <a NAME="Project.openProject" ID="Project.openProject"></a>
3997 <h4>Project.openProject</h4> 4306 <h4>Project.openProject</h4>
3998 <b>openProject</b>(<i>fn=None, restoreSession=True, reopen=False</i>) 4307 <b>openProject</b>(<i>fn=None, restoreSession=True, reopen=False</i>)
4000 <p> 4309 <p>
4001 Public slot to open a project. 4310 Public slot to open a project.
4002 </p> 4311 </p>
4003 <dl> 4312 <dl>
4004 4313
4005 <dt><i>fn</i></dt> 4314 <dt><i>fn</i> (str)</dt>
4006 <dd> 4315 <dd>
4007 optional filename of the project file to be read 4316 optional filename of the project file to be read
4008 </dd> 4317 </dd>
4009 <dt><i>restoreSession</i></dt> 4318 <dt><i>restoreSession</i> (bool)</dt>
4010 <dd> 4319 <dd>
4011 flag indicating to restore the project 4320 flag indicating to restore the project
4012 session (boolean) 4321 session
4013 </dd> 4322 </dd>
4014 <dt><i>reopen</i></dt> 4323 <dt><i>reopen</i> (bool)</dt>
4015 <dd> 4324 <dd>
4016 flag indicating a reopening of the project (boolean) 4325 flag indicating a reopening of the project
4017 </dd> 4326 </dd>
4018 </dl> 4327 </dl>
4019 <a NAME="Project.othersAdded" ID="Project.othersAdded"></a> 4328 <a NAME="Project.othersAdded" ID="Project.othersAdded"></a>
4020 <h4>Project.othersAdded</h4> 4329 <h4>Project.othersAdded</h4>
4021 <b>othersAdded</b>(<i>fn, updateModel=True</i>) 4330 <b>othersAdded</b>(<i>fn, updateModel=True</i>)
4024 Public slot to be called, if something was added to the OTHERS project 4333 Public slot to be called, if something was added to the OTHERS project
4025 data area. 4334 data area.
4026 </p> 4335 </p>
4027 <dl> 4336 <dl>
4028 4337
4029 <dt><i>fn</i></dt> 4338 <dt><i>fn</i> (str)</dt>
4030 <dd> 4339 <dd>
4031 filename or directory name added (string) 4340 filename or directory name added
4032 </dd> 4341 </dd>
4033 <dt><i>updateModel</i></dt> 4342 <dt><i>updateModel</i> (bool)</dt>
4034 <dd> 4343 <dd>
4035 flag indicating an update of the model is requested 4344 flag indicating an update of the model is requested
4036 (boolean)
4037 </dd> 4345 </dd>
4038 </dl> 4346 </dl>
4039 <a NAME="Project.registerProjectType" ID="Project.registerProjectType"></a> 4347 <a NAME="Project.registerProjectType" ID="Project.registerProjectType"></a>
4040 <h4>Project.registerProjectType</h4> 4348 <h4>Project.registerProjectType</h4>
4041 <b>registerProjectType</b>(<i>type_, description, fileTypeCallback=None, binaryTranslationsCallback=None, lexerAssociationCallback=None, progLanguages=None, </i>) 4349 <b>registerProjectType</b>(<i>type_, description, fileTypeCallback=None, binaryTranslationsCallback=None, lexerAssociationCallback=None, progLanguages=None, </i>)
4043 <p> 4351 <p>
4044 Public method to register a project type. 4352 Public method to register a project type.
4045 </p> 4353 </p>
4046 <dl> 4354 <dl>
4047 4355
4048 <dt><i>type_</i></dt> 4356 <dt><i>type_</i> (str)</dt>
4049 <dd> 4357 <dd>
4050 internal type designator to be registered (string) 4358 internal type designator to be registered
4051 </dd> 4359 </dd>
4052 <dt><i>description</i></dt> 4360 <dt><i>description</i> (str)</dt>
4053 <dd> 4361 <dd>
4054 more verbose type name (display string) (string) 4362 more verbose type name (display string)
4055 </dd> 4363 </dd>
4056 <dt><i>fileTypeCallback</i></dt> 4364 <dt><i>fileTypeCallback</i> (function)</dt>
4057 <dd> 4365 <dd>
4058 reference to a method returning a dictionary 4366 reference to a method returning a dictionary
4059 of filetype associations. 4367 of filetype associations
4060 </dd> 4368 </dd>
4061 <dt><i>binaryTranslationsCallback</i></dt> 4369 <dt><i>binaryTranslationsCallback</i> (function)</dt>
4062 <dd> 4370 <dd>
4063 reference to a method returning 4371 reference to a method returning
4064 the name of the binary translation file given the name of the raw 4372 the name of the binary translation file given the name of the raw
4065 translation file 4373 translation file
4066 </dd> 4374 </dd>
4067 <dt><i>lexerAssociationCallback</i></dt> 4375 <dt><i>lexerAssociationCallback</i> (function)</dt>
4068 <dd> 4376 <dd>
4069 reference to a method returning the 4377 reference to a method returning the
4070 lexer type to be used for syntax highlighting given the name of 4378 lexer type to be used for syntax highlighting given the name of
4071 a file 4379 a file
4072 </dd> 4380 </dd>
4073 <dt><i>progLanguages</i></dt> 4381 <dt><i>progLanguages</i> (list of str)</dt>
4074 <dd> 4382 <dd>
4075 programming languages supported by the 4383 programming languages supported by the
4076 project type (list of string) 4384 project type
4077 </dd> 4385 </dd>
4078 </dl> 4386 </dl>
4079 <a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a> 4387 <a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a>
4080 <h4>Project.removeDirectory</h4> 4388 <h4>Project.removeDirectory</h4>
4081 <b>removeDirectory</b>(<i>dn</i>) 4389 <b>removeDirectory</b>(<i>dn</i>)
4086 <p> 4394 <p>
4087 The directory is not deleted from the project directory. 4395 The directory is not deleted from the project directory.
4088 </p> 4396 </p>
4089 <dl> 4397 <dl>
4090 4398
4091 <dt><i>dn</i></dt> 4399 <dt><i>dn</i> (str)</dt>
4092 <dd> 4400 <dd>
4093 directory name to be removed from the project 4401 directory name to be removed from the project
4094 </dd> 4402 </dd>
4095 </dl> 4403 </dl>
4096 <a NAME="Project.removeEricActions" ID="Project.removeEricActions"></a> 4404 <a NAME="Project.removeEricActions" ID="Project.removeEricActions"></a>
4100 <p> 4408 <p>
4101 Public method to remove actions from the list of actions. 4409 Public method to remove actions from the list of actions.
4102 </p> 4410 </p>
4103 <dl> 4411 <dl>
4104 4412
4105 <dt><i>actions</i></dt> 4413 <dt><i>actions</i> (list of EricAction)</dt>
4106 <dd> 4414 <dd>
4107 list of actions (list of EricAction) 4415 list of actions
4108 </dd> 4416 </dd>
4109 </dl> 4417 </dl>
4110 <a NAME="Project.removeFile" ID="Project.removeFile"></a> 4418 <a NAME="Project.removeFile" ID="Project.removeFile"></a>
4111 <h4>Project.removeFile</h4> 4419 <h4>Project.removeFile</h4>
4112 <b>removeFile</b>(<i>fn, updateModel=True</i>) 4420 <b>removeFile</b>(<i>fn, updateModel=True</i>)
4117 <p> 4425 <p>
4118 The file is not deleted from the project directory. 4426 The file is not deleted from the project directory.
4119 </p> 4427 </p>
4120 <dl> 4428 <dl>
4121 4429
4122 <dt><i>fn</i></dt> 4430 <dt><i>fn</i> (str)</dt>
4123 <dd> 4431 <dd>
4124 filename to be removed from the project 4432 filename to be removed from the project
4125 </dd> 4433 </dd>
4126 <dt><i>updateModel</i></dt> 4434 <dt><i>updateModel</i> (bool)</dt>
4127 <dd> 4435 <dd>
4128 flag indicating an update of the model is 4436 flag indicating an update of the model is requested
4129 requested (boolean)
4130 </dd> 4437 </dd>
4131 </dl> 4438 </dl>
4132 <a NAME="Project.removeFileCategory" ID="Project.removeFileCategory"></a> 4439 <a NAME="Project.removeFileCategory" ID="Project.removeFileCategory"></a>
4133 <h4>Project.removeFileCategory</h4> 4440 <h4>Project.removeFileCategory</h4>
4134 <b>removeFileCategory</b>(<i>category</i>) 4441 <b>removeFileCategory</b>(<i>category</i>)
4157 <p> 4464 <p>
4158 The translation file is not deleted from the project directory. 4465 The translation file is not deleted from the project directory.
4159 </p> 4466 </p>
4160 <dl> 4467 <dl>
4161 4468
4162 <dt><i>langFile</i></dt> 4469 <dt><i>langFile</i> (str)</dt>
4163 <dd> 4470 <dd>
4164 the translation file to be removed (string) 4471 the translation file to be removed
4165 </dd> 4472 </dd>
4166 </dl> 4473 </dl>
4167 <a NAME="Project.renameFile" ID="Project.renameFile"></a> 4474 <a NAME="Project.renameFile" ID="Project.renameFile"></a>
4168 <h4>Project.renameFile</h4> 4475 <h4>Project.renameFile</h4>
4169 <b>renameFile</b>(<i>oldfn, newfn=None</i>) 4476 <b>renameFile</b>(<i>oldfn, newfn=None</i>)
4171 <p> 4478 <p>
4172 Public slot to rename a file of the project. 4479 Public slot to rename a file of the project.
4173 </p> 4480 </p>
4174 <dl> 4481 <dl>
4175 4482
4176 <dt><i>oldfn</i></dt> 4483 <dt><i>oldfn</i> (str)</dt>
4177 <dd> 4484 <dd>
4178 old filename of the file (string) 4485 old filename of the file
4179 </dd> 4486 </dd>
4180 <dt><i>newfn</i></dt> 4487 <dt><i>newfn</i> (str)</dt>
4181 <dd> 4488 <dd>
4182 new filename of the file (string) 4489 new filename of the file
4183 </dd> 4490 </dd>
4184 </dl> 4491 </dl>
4185 <dl> 4492 <dl>
4186 <dt>Return:</dt> 4493 <dt>Return:</dt>
4187 <dd> 4494 <dd>
4188 flag indicating success 4495 flag indicating success
4496 </dd>
4497 </dl>
4498 <dl>
4499 <dt>Return Type:</dt>
4500 <dd>
4501 bool
4189 </dd> 4502 </dd>
4190 </dl> 4503 </dl>
4191 <a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a> 4504 <a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a>
4192 <h4>Project.renameFileInPdata</h4> 4505 <h4>Project.renameFileInPdata</h4>
4193 <b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile=False</i>) 4506 <b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile=False</i>)
4195 <p> 4508 <p>
4196 Public method to rename a file in the __pdata structure. 4509 Public method to rename a file in the __pdata structure.
4197 </p> 4510 </p>
4198 <dl> 4511 <dl>
4199 4512
4200 <dt><i>oldname</i></dt> 4513 <dt><i>oldname</i> (str)</dt>
4201 <dd> 4514 <dd>
4202 old filename (string) 4515 old filename
4203 </dd> 4516 </dd>
4204 <dt><i>newname</i></dt> 4517 <dt><i>newname</i> (str)</dt>
4205 <dd> 4518 <dd>
4206 new filename (string) 4519 new filename
4207 </dd> 4520 </dd>
4208 <dt><i>isSourceFile</i></dt> 4521 <dt><i>isSourceFile</i> (bool)</dt>
4209 <dd> 4522 <dd>
4210 flag indicating that this is a source file 4523 flag indicating that this is a source file
4211 even if it doesn't have the source extension (boolean) 4524 even if it doesn't have the source extension
4212 </dd> 4525 </dd>
4213 </dl> 4526 </dl>
4214 <a NAME="Project.renameMainScript" ID="Project.renameMainScript"></a> 4527 <a NAME="Project.renameMainScript" ID="Project.renameMainScript"></a>
4215 <h4>Project.renameMainScript</h4> 4528 <h4>Project.renameMainScript</h4>
4216 <b>renameMainScript</b>(<i>oldfn, newfn</i>) 4529 <b>renameMainScript</b>(<i>oldfn, newfn</i>)
4218 <p> 4531 <p>
4219 Public method to rename the main script. 4532 Public method to rename the main script.
4220 </p> 4533 </p>
4221 <dl> 4534 <dl>
4222 4535
4223 <dt><i>oldfn</i></dt> 4536 <dt><i>oldfn</i> (str)</dt>
4224 <dd> 4537 <dd>
4225 old filename (string) 4538 old filename
4226 </dd> 4539 </dd>
4227 <dt><i>newfn</i></dt> 4540 <dt><i>newfn</i> (str)</dt>
4228 <dd> 4541 <dd>
4229 new filename of the main script (string) 4542 new filename of the main script
4230 </dd> 4543 </dd>
4231 </dl> 4544 </dl>
4232 <a NAME="Project.reopenProject" ID="Project.reopenProject"></a> 4545 <a NAME="Project.reopenProject" ID="Project.reopenProject"></a>
4233 <h4>Project.reopenProject</h4> 4546 <h4>Project.reopenProject</h4>
4234 <b>reopenProject</b>(<i></i>) 4547 <b>reopenProject</b>(<i></i>)
4243 <p> 4556 <p>
4244 Public slot to repopulate a named item. 4557 Public slot to repopulate a named item.
4245 </p> 4558 </p>
4246 <dl> 4559 <dl>
4247 4560
4248 <dt><i>fullname</i></dt> 4561 <dt><i>fullname</i> (str)</dt>
4249 <dd> 4562 <dd>
4250 full name of the item to repopulate (string) 4563 full name of the item to repopulate
4251 </dd> 4564 </dd>
4252 </dl> 4565 </dl>
4253 <a NAME="Project.resetVCS" ID="Project.resetVCS"></a> 4566 <a NAME="Project.resetVCS" ID="Project.resetVCS"></a>
4254 <h4>Project.resetVCS</h4> 4567 <h4>Project.resetVCS</h4>
4255 <b>resetVCS</b>(<i></i>) 4568 <b>resetVCS</b>(<i></i>)
4264 <p> 4577 <p>
4265 Public method to save all scripts belonging to the project. 4578 Public method to save all scripts belonging to the project.
4266 </p> 4579 </p>
4267 <dl> 4580 <dl>
4268 4581
4269 <dt><i>reportSyntaxErrors</i></dt> 4582 <dt><i>reportSyntaxErrors</i> (bool)</dt>
4270 <dd> 4583 <dd>
4271 flag indicating special reporting 4584 flag indicating special reporting
4272 for syntax errors (boolean) 4585 for syntax errors
4273 </dd> 4586 </dd>
4274 </dl> 4587 </dl>
4275 <dl> 4588 <dl>
4276 <dt>Return:</dt> 4589 <dt>Return:</dt>
4277 <dd> 4590 <dd>
4278 flag indicating success (boolean) 4591 flag indicating success
4592 </dd>
4593 </dl>
4594 <dl>
4595 <dt>Return Type:</dt>
4596 <dd>
4597 bool
4279 </dd> 4598 </dd>
4280 </dl> 4599 </dl>
4281 <a NAME="Project.saveProject" ID="Project.saveProject"></a> 4600 <a NAME="Project.saveProject" ID="Project.saveProject"></a>
4282 <h4>Project.saveProject</h4> 4601 <h4>Project.saveProject</h4>
4283 <b>saveProject</b>(<i></i>) 4602 <b>saveProject</b>(<i></i>)
4289 <dt>Return:</dt> 4608 <dt>Return:</dt>
4290 <dd> 4609 <dd>
4291 flag indicating success 4610 flag indicating success
4292 </dd> 4611 </dd>
4293 </dl> 4612 </dl>
4613 <dl>
4614 <dt>Return Type:</dt>
4615 <dd>
4616 bool
4617 </dd>
4618 </dl>
4294 <a NAME="Project.saveProjectAs" ID="Project.saveProjectAs"></a> 4619 <a NAME="Project.saveProjectAs" ID="Project.saveProjectAs"></a>
4295 <h4>Project.saveProjectAs</h4> 4620 <h4>Project.saveProjectAs</h4>
4296 <b>saveProjectAs</b>(<i></i>) 4621 <b>saveProjectAs</b>(<i></i>)
4297 4622
4298 <p> 4623 <p>
4299 Public slot to save the current project to a different file. 4624 Public slot to save the current project to a different file.
4300 </p> 4625 </p>
4301 <dl> 4626 <dl>
4302 <dt>Return:</dt> 4627 <dt>Return:</dt>
4303 <dd> 4628 <dd>
4304 flag indicating success (boolean) 4629 flag indicating success
4630 </dd>
4631 </dl>
4632 <dl>
4633 <dt>Return Type:</dt>
4634 <dd>
4635 bool
4305 </dd> 4636 </dd>
4306 </dl> 4637 </dl>
4307 <a NAME="Project.setData" ID="Project.setData"></a> 4638 <a NAME="Project.setData" ID="Project.setData"></a>
4308 <h4>Project.setData</h4> 4639 <h4>Project.setData</h4>
4309 <b>setData</b>(<i>category, key, data</i>) 4640 <b>setData</b>(<i>category, key, data</i>)
4311 <p> 4642 <p>
4312 Public method to store data in the project data store. 4643 Public method to store data in the project data store.
4313 </p> 4644 </p>
4314 <dl> 4645 <dl>
4315 4646
4316 <dt><i>category</i></dt> 4647 <dt><i>category</i> (str)</dt>
4317 <dd> 4648 <dd>
4318 category of the data to get (string, one of 4649 category of the data to get (one of
4319 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS, 4650 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS,
4320 DOCUMENTATIONPARMS or OTHERTOOLSPARMS) 4651 DOCUMENTATIONPARMS or OTHERTOOLSPARMS)
4321 </dd> 4652 </dd>
4322 <dt><i>key</i></dt> 4653 <dt><i>key</i> (str)</dt>
4323 <dd> 4654 <dd>
4324 key of the data entry to get (string). 4655 key of the data entry to get
4325 </dd> 4656 </dd>
4326 <dt><i>data</i></dt> 4657 <dt><i>data</i> (Any)</dt>
4327 <dd> 4658 <dd>
4328 data to be stored 4659 data to be stored
4329 </dd> 4660 </dd>
4330 </dl> 4661 </dl>
4331 <dl> 4662 <dl>
4332 <dt>Return:</dt> 4663 <dt>Return:</dt>
4333 <dd> 4664 <dd>
4334 flag indicating success (boolean) 4665 flag indicating success
4666 </dd>
4667 </dl>
4668 <dl>
4669 <dt>Return Type:</dt>
4670 <dd>
4671 bool
4335 </dd> 4672 </dd>
4336 </dl> 4673 </dl>
4337 <a NAME="Project.setDbgInfo" ID="Project.setDbgInfo"></a> 4674 <a NAME="Project.setDbgInfo" ID="Project.setDbgInfo"></a>
4338 <h4>Project.setDbgInfo</h4> 4675 <h4>Project.setDbgInfo</h4>
4339 <b>setDbgInfo</b>(<i>venvName, argv, wd, env, excList, excIgnoreList, autoClearShell, tracePython=None, autoContinue=None, reportAllExceptions=None, enableMultiprocess=None, multiprocessNoDebug=None, configOverride=None, </i>) 4676 <b>setDbgInfo</b>(<i>venvName, argv, wd, env, excList, excIgnoreList, autoClearShell, tracePython=None, autoContinue=None, reportAllExceptions=None, enableMultiprocess=None, multiprocessNoDebug=None, configOverride=None, </i>)
4455 <p> 4792 <p>
4456 Public method to enable the auto update function. 4793 Public method to enable the auto update function.
4457 </p> 4794 </p>
4458 <dl> 4795 <dl>
4459 4796
4460 <dt><i>auto</i></dt> 4797 <dt><i>auto</i> (bool)</dt>
4461 <dd> 4798 <dd>
4462 status of the auto update function (boolean) 4799 status of the auto update function
4463 </dd> 4800 </dd>
4464 </dl> 4801 </dl>
4465 <a NAME="Project.setStatusMonitorInterval" ID="Project.setStatusMonitorInterval"></a> 4802 <a NAME="Project.setStatusMonitorInterval" ID="Project.setStatusMonitorInterval"></a>
4466 <h4>Project.setStatusMonitorInterval</h4> 4803 <h4>Project.setStatusMonitorInterval</h4>
4467 <b>setStatusMonitorInterval</b>(<i>interval</i>) 4804 <b>setStatusMonitorInterval</b>(<i>interval</i>)
4469 <p> 4806 <p>
4470 Public method to se the interval of the VCS status monitor thread. 4807 Public method to se the interval of the VCS status monitor thread.
4471 </p> 4808 </p>
4472 <dl> 4809 <dl>
4473 4810
4474 <dt><i>interval</i></dt> 4811 <dt><i>interval</i> (int)</dt>
4475 <dd> 4812 <dd>
4476 status monitor interval in seconds (integer) 4813 status monitor interval in seconds
4477 </dd> 4814 </dd>
4478 </dl> 4815 </dl>
4479 <a NAME="Project.setTranslationPattern" ID="Project.setTranslationPattern"></a> 4816 <a NAME="Project.setTranslationPattern" ID="Project.setTranslationPattern"></a>
4480 <h4>Project.setTranslationPattern</h4> 4817 <h4>Project.setTranslationPattern</h4>
4481 <b>setTranslationPattern</b>(<i>pattern</i>) 4818 <b>setTranslationPattern</b>(<i>pattern</i>)
4551 <p> 4888 <p>
4552 Public method to unregister a project type. 4889 Public method to unregister a project type.
4553 </p> 4890 </p>
4554 <dl> 4891 <dl>
4555 4892
4556 <dt><i>type_</i></dt> 4893 <dt><i>type_</i> (str)</dt>
4557 <dd> 4894 <dd>
4558 internal type designator to be unregistered (string) 4895 internal type designator to be unregistered
4559 </dd> 4896 </dd>
4560 </dl> 4897 </dl>
4561 <a NAME="Project.updateFileTypes" ID="Project.updateFileTypes"></a> 4898 <a NAME="Project.updateFileTypes" ID="Project.updateFileTypes"></a>
4562 <h4>Project.updateFileTypes</h4> 4899 <h4>Project.updateFileTypes</h4>
4563 <b>updateFileTypes</b>(<i></i>) 4900 <b>updateFileTypes</b>(<i></i>)
4574 Public method to check, if the project uses the system eol setting. 4911 Public method to check, if the project uses the system eol setting.
4575 </p> 4912 </p>
4576 <dl> 4913 <dl>
4577 <dt>Return:</dt> 4914 <dt>Return:</dt>
4578 <dd> 4915 <dd>
4579 flag indicating the usage of system eol (boolean) 4916 flag indicating the usage of system eol
4917 </dd>
4918 </dl>
4919 <dl>
4920 <dt>Return Type:</dt>
4921 <dd>
4922 bool
4580 </dd> 4923 </dd>
4581 </dl> 4924 </dl>
4582 <a NAME="Project.vcsSoftwareAvailable" ID="Project.vcsSoftwareAvailable"></a> 4925 <a NAME="Project.vcsSoftwareAvailable" ID="Project.vcsSoftwareAvailable"></a>
4583 <h4>Project.vcsSoftwareAvailable</h4> 4926 <h4>Project.vcsSoftwareAvailable</h4>
4584 <b>vcsSoftwareAvailable</b>(<i></i>) 4927 <b>vcsSoftwareAvailable</b>(<i></i>)
4588 to the IDE. 4931 to the IDE.
4589 </p> 4932 </p>
4590 <dl> 4933 <dl>
4591 <dt>Return:</dt> 4934 <dt>Return:</dt>
4592 <dd> 4935 <dd>
4593 flag indicating availability of VCS software (boolean) 4936 flag indicating availability of VCS software
4937 </dd>
4938 </dl>
4939 <dl>
4940 <dt>Return Type:</dt>
4941 <dd>
4942 bool
4594 </dd> 4943 </dd>
4595 </dl> 4944 </dl>
4596 <a NAME="Project.writeTasks" ID="Project.writeTasks"></a> 4945 <a NAME="Project.writeTasks" ID="Project.writeTasks"></a>
4597 <h4>Project.writeTasks</h4> 4946 <h4>Project.writeTasks</h4>
4598 <b>writeTasks</b>(<i></i>) 4947 <b>writeTasks</b>(<i></i>)

Mercurial Repository: eric

eric ide

mercurial