Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Project.Project.html

eric6/Documentation/Source/eric6.Project.Project.html

branch
maintenance
changeset 8043
0acf98cd089a
parent 8008
ae9ab1e150dc
child 8049
af58c1d47e5e
equal deleted inserted replaced
7991:866adc8c315b 8043:0acf98cd089a
348 <td><a href="#Project.__openRecent">__openRecent</a></td> 348 <td><a href="#Project.__openRecent">__openRecent</a></td>
349 <td>Private method to open a project from the list of rencently opened projects.</td> 349 <td>Private method to open a project from the list of rencently opened projects.</td>
350 </tr> 350 </tr>
351 <tr> 351 <tr>
352 <td><a href="#Project.__pluginCreateArchives">__pluginCreateArchives</a></td> 352 <td><a href="#Project.__pluginCreateArchives">__pluginCreateArchives</a></td>
353 <td>Private slot to create eric6 plugin archives.</td> 353 <td>Private slot to create eric plugin archives.</td>
354 </tr> 354 </tr>
355 <tr> 355 <tr>
356 <td><a href="#Project.__pluginCreatePkgList">__pluginCreatePkgList</a></td> 356 <td><a href="#Project.__pluginCreatePkgList">__pluginCreatePkgList</a></td>
357 <td>Private slot to create a PKGLIST file needed for archive file creation.</td> 357 <td>Private slot to create a PKGLIST file needed for archive file creation.</td>
358 </tr> 358 </tr>
359 <tr> 359 <tr>
360 <td><a href="#Project.__pluginCreateSnapshotArchives">__pluginCreateSnapshotArchives</a></td> 360 <td><a href="#Project.__pluginCreateSnapshotArchives">__pluginCreateSnapshotArchives</a></td>
361 <td>Private slot to create eric6 plugin archive snapshot releases.</td> 361 <td>Private slot to create eric plugin archive snapshot releases.</td>
362 </tr> 362 </tr>
363 <tr> 363 <tr>
364 <td><a href="#Project.__pluginExtractVersion">__pluginExtractVersion</a></td> 364 <td><a href="#Project.__pluginExtractVersion">__pluginExtractVersion</a></td>
365 <td>Private method to extract the version number entry.</td> 365 <td>Private method to extract the version number entry.</td>
366 </tr> 366 </tr>
675 <tr> 675 <tr>
676 <td><a href="#Project.getDefaultSourceExtension">getDefaultSourceExtension</a></td> 676 <td><a href="#Project.getDefaultSourceExtension">getDefaultSourceExtension</a></td>
677 <td>Public method to get the default extension for the project's programming language.</td> 677 <td>Public method to get the default extension for the project's programming language.</td>
678 </tr> 678 </tr>
679 <tr> 679 <tr>
680 <td><a href="#Project.getDocstringType">getDocstringType</a></td>
681 <td>Public method to get the configured docstring style.</td>
682 </tr>
683 <tr>
680 <td><a href="#Project.getEditorLexerAssoc">getEditorLexerAssoc</a></td> 684 <td><a href="#Project.getEditorLexerAssoc">getEditorLexerAssoc</a></td>
681 <td>Public method to retrieve a lexer association.</td> 685 <td>Public method to retrieve a lexer association.</td>
682 </tr> 686 </tr>
683 <tr> 687 <tr>
684 <td><a href="#Project.getEolString">getEolString</a></td> 688 <td><a href="#Project.getEolString">getEolString</a></td>
687 <tr> 691 <tr>
688 <td><a href="#Project.getFiles">getFiles</a></td> 692 <td><a href="#Project.getFiles">getFiles</a></td>
689 <td>Public method to get all files starting with a common prefix.</td> 693 <td>Public method to get all files starting with a common prefix.</td>
690 </tr> 694 </tr>
691 <tr> 695 <tr>
696 <td><a href="#Project.getFiletypeAssociations">getFiletypeAssociations</a></td>
697 <td>Public method to get the list of file type associations for the given association type.</td>
698 </tr>
699 <tr>
692 <td><a href="#Project.getHash">getHash</a></td> 700 <td><a href="#Project.getHash">getHash</a></td>
693 <td>Public method to get the project hash.</td> 701 <td>Public method to get the project hash.</td>
694 </tr> 702 </tr>
695 <tr> 703 <tr>
696 <td><a href="#Project.getMainScript">getMainScript</a></td> 704 <td><a href="#Project.getMainScript">getMainScript</a></td>
805 <td>Public method to handle the application diagram context menu action.</td> 813 <td>Public method to handle the application diagram context menu action.</td>
806 </tr> 814 </tr>
807 <tr> 815 <tr>
808 <td><a href="#Project.handlePreferencesChanged">handlePreferencesChanged</a></td> 816 <td><a href="#Project.handlePreferencesChanged">handlePreferencesChanged</a></td>
809 <td>Public slot used to handle the preferencesChanged signal.</td> 817 <td>Public slot used to handle the preferencesChanged signal.</td>
818 </tr>
819 <tr>
820 <td><a href="#Project.hasDefaultDocstringParameter">hasDefaultDocstringParameter</a></td>
821 <td>Public method to test, if the project contains the default docstring parameter.</td>
810 </tr> 822 </tr>
811 <tr> 823 <tr>
812 <td><a href="#Project.hasDefaultIdlCompilerParameters">hasDefaultIdlCompilerParameters</a></td> 824 <td><a href="#Project.hasDefaultIdlCompilerParameters">hasDefaultIdlCompilerParameters</a></td>
813 <td>Public method to test, if the project contains the default IDL compiler parameters.</td> 825 <td>Public method to test, if the project contains the default IDL compiler parameters.</td>
814 </tr> 826 </tr>
1144 <dd> 1156 <dd>
1145 name of the raw translations file (string) 1157 name of the raw translations file (string)
1146 </dd> 1158 </dd>
1147 </dl> 1159 </dl>
1148 <dl> 1160 <dl>
1149 <dt>Returns:</dt> 1161 <dt>Return:</dt>
1150 <dd> 1162 <dd>
1151 name of the binary translations file (string) 1163 name of the binary translations file (string)
1152 </dd> 1164 </dd>
1153 </dl> 1165 </dl>
1154 <a NAME="Project.__checkFilesExist" ID="Project.__checkFilesExist"></a> 1166 <a NAME="Project.__checkFilesExist" ID="Project.__checkFilesExist"></a>
1188 <dd> 1200 <dd>
1189 group to check (string) 1201 group to check (string)
1190 </dd> 1202 </dd>
1191 </dl> 1203 </dl>
1192 <dl> 1204 <dl>
1193 <dt>Returns:</dt> 1205 <dt>Return:</dt>
1194 <dd> 1206 <dd>
1195 flag indicating membership (boolean) 1207 flag indicating membership (boolean)
1196 </dd> 1208 </dd>
1197 </dl> 1209 </dl>
1198 <a NAME="Project.__cleanupMake" ID="Project.__cleanupMake"></a> 1210 <a NAME="Project.__cleanupMake" ID="Project.__cleanupMake"></a>
1227 <dd> 1239 <dd>
1228 name of the plugin file to modify (string) 1240 name of the plugin file to modify (string)
1229 </dd> 1241 </dd>
1230 </dl> 1242 </dl>
1231 <dl> 1243 <dl>
1232 <dt>Returns:</dt> 1244 <dt>Return:</dt>
1233 <dd> 1245 <dd>
1234 modified source (bytes), snapshot version string (string) 1246 modified source (bytes), snapshot version string (string)
1235 </dd> 1247 </dd>
1236 </dl> 1248 </dl>
1237 <a NAME="Project.__createZipDirEntries" ID="Project.__createZipDirEntries"></a> 1249 <a NAME="Project.__createZipDirEntries" ID="Project.__createZipDirEntries"></a>
1346 <dd> 1358 <dd>
1347 filename to be checked 1359 filename to be checked
1348 </dd> 1360 </dd>
1349 </dl> 1361 </dl>
1350 <dl> 1362 <dl>
1351 <dt>Returns:</dt> 1363 <dt>Return:</dt>
1352 <dd> 1364 <dd>
1353 flag indicating membership 1365 flag indicating membership
1354 </dd> 1366 </dd>
1355 </dl> 1367 </dl>
1356 <dl> 1368 <dl>
1432 <a NAME="Project.__pluginCreateArchives" ID="Project.__pluginCreateArchives"></a> 1444 <a NAME="Project.__pluginCreateArchives" ID="Project.__pluginCreateArchives"></a>
1433 <h4>Project.__pluginCreateArchives</h4> 1445 <h4>Project.__pluginCreateArchives</h4>
1434 <b>__pluginCreateArchives</b>(<i>snapshot=False</i>) 1446 <b>__pluginCreateArchives</b>(<i>snapshot=False</i>)
1435 1447
1436 <p> 1448 <p>
1437 Private slot to create eric6 plugin archives. 1449 Private slot to create eric plugin archives.
1438 </p> 1450 </p>
1439 <dl> 1451 <dl>
1440 1452
1441 <dt><i>snapshot</i></dt> 1453 <dt><i>snapshot</i></dt>
1442 <dd> 1454 <dd>
1453 <a NAME="Project.__pluginCreateSnapshotArchives" ID="Project.__pluginCreateSnapshotArchives"></a> 1465 <a NAME="Project.__pluginCreateSnapshotArchives" ID="Project.__pluginCreateSnapshotArchives"></a>
1454 <h4>Project.__pluginCreateSnapshotArchives</h4> 1466 <h4>Project.__pluginCreateSnapshotArchives</h4>
1455 <b>__pluginCreateSnapshotArchives</b>(<i></i>) 1467 <b>__pluginCreateSnapshotArchives</b>(<i></i>)
1456 1468
1457 <p> 1469 <p>
1458 Private slot to create eric6 plugin archive snapshot releases. 1470 Private slot to create eric plugin archive snapshot releases.
1459 </p> 1471 </p>
1460 <a NAME="Project.__pluginExtractVersion" ID="Project.__pluginExtractVersion"></a> 1472 <a NAME="Project.__pluginExtractVersion" ID="Project.__pluginExtractVersion"></a>
1461 <h4>Project.__pluginExtractVersion</h4> 1473 <h4>Project.__pluginExtractVersion</h4>
1462 <b>__pluginExtractVersion</b>(<i>filename</i>) 1474 <b>__pluginExtractVersion</b>(<i>filename</i>)
1463 1475
1470 <dd> 1482 <dd>
1471 name of the plugin file (string) 1483 name of the plugin file (string)
1472 </dd> 1484 </dd>
1473 </dl> 1485 </dl>
1474 <dl> 1486 <dl>
1475 <dt>Returns:</dt> 1487 <dt>Return:</dt>
1476 <dd> 1488 <dd>
1477 version string (string) 1489 version string (string)
1478 </dd> 1490 </dd>
1479 </dl> 1491 </dl>
1480 <a NAME="Project.__pluginVersionToTuple" ID="Project.__pluginVersionToTuple"></a> 1492 <a NAME="Project.__pluginVersionToTuple" ID="Project.__pluginVersionToTuple"></a>
1491 <dd> 1503 <dd>
1492 version string to be converted 1504 version string to be converted
1493 </dd> 1505 </dd>
1494 </dl> 1506 </dl>
1495 <dl> 1507 <dl>
1496 <dt>Returns:</dt> 1508 <dt>Return:</dt>
1497 <dd> 1509 <dd>
1498 version info as a tuple 1510 version info as a tuple
1499 </dd> 1511 </dd>
1500 </dl> 1512 </dl>
1501 <dl> 1513 <dl>
1532 <dd> 1544 <dd>
1533 filename of the project file to be read (string) 1545 filename of the project file to be read (string)
1534 </dd> 1546 </dd>
1535 </dl> 1547 </dl>
1536 <dl> 1548 <dl>
1537 <dt>Returns:</dt> 1549 <dt>Return:</dt>
1538 <dd> 1550 <dd>
1539 flag indicating success 1551 flag indicating success
1540 </dd> 1552 </dd>
1541 </dl> 1553 </dl>
1542 <a NAME="Project.__readSession" ID="Project.__readSession"></a> 1554 <a NAME="Project.__readSession" ID="Project.__readSession"></a>
1551 <dt><i>quiet</i></dt> 1563 <dt><i>quiet</i></dt>
1552 <dd> 1564 <dd>
1553 flag indicating quiet operations. 1565 flag indicating quiet operations.
1554 If this flag is true, no errors are reported. 1566 If this flag is true, no errors are reported.
1555 </dd> 1567 </dd>
1556 <dt><i>indicator=</i></dt> 1568 <dt><i>indicator</i></dt>
1557 <dd> 1569 <dd>
1558 indicator string (string) 1570 indicator string (string)
1559 </dd> 1571 </dd>
1560 </dl> 1572 </dl>
1561 <a NAME="Project.__readTasks" ID="Project.__readTasks"></a> 1573 <a NAME="Project.__readTasks" ID="Project.__readTasks"></a>
1747 <dd> 1759 <dd>
1748 programming language (string) 1760 programming language (string)
1749 </dd> 1761 </dd>
1750 </dl> 1762 </dl>
1751 <dl> 1763 <dl>
1752 <dt>Returns:</dt> 1764 <dt>Return:</dt>
1753 <dd> 1765 <dd>
1754 source extensions (list of string) 1766 source extensions (list of string)
1755 </dd> 1767 </dd>
1756 </dl> 1768 </dl>
1757 <a NAME="Project.__statusMonitorStatus" ID="Project.__statusMonitorStatus"></a> 1769 <a NAME="Project.__statusMonitorStatus" ID="Project.__statusMonitorStatus"></a>
1822 is used instead of the one in the project object. This is the 1834 is used instead of the one in the project object. This is the
1823 'save as' action. 1835 'save as' action.
1824 </dd> 1836 </dd>
1825 </dl> 1837 </dl>
1826 <dl> 1838 <dl>
1827 <dt>Returns:</dt> 1839 <dt>Return:</dt>
1828 <dd> 1840 <dd>
1829 flag indicating success 1841 flag indicating success
1830 </dd> 1842 </dd>
1831 </dl> 1843 </dl>
1832 <a NAME="Project.__writeSession" ID="Project.__writeSession"></a> 1844 <a NAME="Project.__writeSession" ID="Project.__writeSession"></a>
1841 <dt><i>quiet</i></dt> 1853 <dt><i>quiet</i></dt>
1842 <dd> 1854 <dd>
1843 flag indicating quiet operations. 1855 flag indicating quiet operations.
1844 If this flag is true, no errors are reported. 1856 If this flag is true, no errors are reported.
1845 </dd> 1857 </dd>
1846 <dt><i>indicator=</i></dt> 1858 <dt><i>indicator</i></dt>
1847 <dd> 1859 <dd>
1848 indicator string (string) 1860 indicator string (string)
1849 </dd> 1861 </dd>
1850 </dl> 1862 </dl>
1851 <a NAME="Project.__writeUserProperties" ID="Project.__writeUserProperties"></a> 1863 <a NAME="Project.__writeUserProperties" ID="Project.__writeUserProperties"></a>
2046 Public method to check all scripts belonging to the project for 2058 Public method to check all scripts belonging to the project for
2047 their dirty status. 2059 their dirty status.
2048 </p> 2060 </p>
2049 <dl> 2061 <dl>
2050 2062
2051 <dt><i>reportSyntaxErrors=</i></dt> 2063 <dt><i>reportSyntaxErrors</i></dt>
2052 <dd> 2064 <dd>
2053 flag indicating special reporting 2065 flag indicating special reporting
2054 for syntax errors (boolean) 2066 for syntax errors (boolean)
2055 </dd> 2067 </dd>
2056 </dl> 2068 </dl>
2057 <dl> 2069 <dl>
2058 <dt>Returns:</dt> 2070 <dt>Return:</dt>
2059 <dd> 2071 <dd>
2060 flag indicating success (boolean) 2072 flag indicating success (boolean)
2061 </dd> 2073 </dd>
2062 </dl> 2074 </dl>
2063 <a NAME="Project.checkDirty" ID="Project.checkDirty"></a> 2075 <a NAME="Project.checkDirty" ID="Project.checkDirty"></a>
2066 2078
2067 <p> 2079 <p>
2068 Public method to check dirty status and open a message window. 2080 Public method to check dirty status and open a message window.
2069 </p> 2081 </p>
2070 <dl> 2082 <dl>
2071 <dt>Returns:</dt> 2083 <dt>Return:</dt>
2072 <dd> 2084 <dd>
2073 flag indicating whether this operation was successful (boolean) 2085 flag indicating whether this operation was successful (boolean)
2074 </dd> 2086 </dd>
2075 </dl> 2087 </dl>
2076 <a NAME="Project.checkLanguageFiles" ID="Project.checkLanguageFiles"></a> 2088 <a NAME="Project.checkLanguageFiles" ID="Project.checkLanguageFiles"></a>
2122 <p> 2134 <p>
2123 Public slot to close the current project. 2135 Public slot to close the current project.
2124 </p> 2136 </p>
2125 <dl> 2137 <dl>
2126 2138
2127 <dt><i>reopen=</i></dt> 2139 <dt><i>reopen</i></dt>
2128 <dd> 2140 <dd>
2129 flag indicating a reopening of the project (boolean) 2141 flag indicating a reopening of the project (boolean)
2130 </dd> 2142 </dd>
2131 <dt><i>noSave=</i></dt> 2143 <dt><i>noSave</i></dt>
2132 <dd> 2144 <dd>
2133 flag indicating to not perform save actions (boolean) 2145 flag indicating to not perform save actions (boolean)
2134 </dd> 2146 </dd>
2135 </dl> 2147 </dl>
2136 <dl> 2148 <dl>
2137 <dt>Returns:</dt> 2149 <dt>Return:</dt>
2138 <dd> 2150 <dd>
2139 flag indicating success (boolean) 2151 flag indicating success (boolean)
2140 </dd> 2152 </dd>
2141 </dl> 2153 </dl>
2142 <a NAME="Project.copyDirectory" ID="Project.copyDirectory"></a> 2154 <a NAME="Project.copyDirectory" ID="Project.copyDirectory"></a>
2191 <dd> 2203 <dd>
2192 directory name to be removed from the project 2204 directory name to be removed from the project
2193 </dd> 2205 </dd>
2194 </dl> 2206 </dl>
2195 <dl> 2207 <dl>
2196 <dt>Returns:</dt> 2208 <dt>Return:</dt>
2197 <dd> 2209 <dd>
2198 flag indicating success (boolean) 2210 flag indicating success (boolean)
2199 </dd> 2211 </dd>
2200 </dl> 2212 </dl>
2201 <a NAME="Project.deleteFile" ID="Project.deleteFile"></a> 2213 <a NAME="Project.deleteFile" ID="Project.deleteFile"></a>
2211 <dd> 2223 <dd>
2212 filename to be deleted from the project 2224 filename to be deleted from the project
2213 </dd> 2225 </dd>
2214 </dl> 2226 </dl>
2215 <dl> 2227 <dl>
2216 <dt>Returns:</dt> 2228 <dt>Return:</dt>
2217 <dd> 2229 <dd>
2218 flag indicating success (boolean) 2230 flag indicating success (boolean)
2219 </dd> 2231 </dd>
2220 </dl> 2232 </dl>
2221 <a NAME="Project.deleteLanguageFile" ID="Project.deleteLanguageFile"></a> 2233 <a NAME="Project.deleteLanguageFile" ID="Project.deleteLanguageFile"></a>
2254 <dd> 2266 <dd>
2255 file or directory name to convert (string) 2267 file or directory name to convert (string)
2256 </dd> 2268 </dd>
2257 </dl> 2269 </dl>
2258 <dl> 2270 <dl>
2259 <dt>Returns:</dt> 2271 <dt>Return:</dt>
2260 <dd> 2272 <dd>
2261 absolute path (string) 2273 absolute path (string)
2262 </dd> 2274 </dd>
2263 </dl> 2275 </dl>
2264 <a NAME="Project.getAbsoluteUniversalPath" ID="Project.getAbsoluteUniversalPath"></a> 2276 <a NAME="Project.getAbsoluteUniversalPath" ID="Project.getAbsoluteUniversalPath"></a>
2275 <dd> 2287 <dd>
2276 file or directory name to convert (string) 2288 file or directory name to convert (string)
2277 </dd> 2289 </dd>
2278 </dl> 2290 </dl>
2279 <dl> 2291 <dl>
2280 <dt>Returns:</dt> 2292 <dt>Return:</dt>
2281 <dd> 2293 <dd>
2282 absolute path (string) 2294 absolute path (string)
2283 </dd> 2295 </dd>
2284 </dl> 2296 </dl>
2285 <a NAME="Project.getActions" ID="Project.getActions"></a> 2297 <a NAME="Project.getActions" ID="Project.getActions"></a>
2288 2300
2289 <p> 2301 <p>
2290 Public method to get a list of all actions. 2302 Public method to get a list of all actions.
2291 </p> 2303 </p>
2292 <dl> 2304 <dl>
2293 <dt>Returns:</dt> 2305 <dt>Return:</dt>
2294 <dd> 2306 <dd>
2295 list of all actions (list of E5Action) 2307 list of all actions (list of E5Action)
2296 </dd> 2308 </dd>
2297 </dl> 2309 </dl>
2298 <a NAME="Project.getData" ID="Project.getData"></a> 2310 <a NAME="Project.getData" ID="Project.getData"></a>
2314 <dd> 2326 <dd>
2315 key of the data entry to get (string). 2327 key of the data entry to get (string).
2316 </dd> 2328 </dd>
2317 </dl> 2329 </dl>
2318 <dl> 2330 <dl>
2319 <dt>Returns:</dt> 2331 <dt>Return:</dt>
2320 <dd> 2332 <dd>
2321 a copy of the requested data or None 2333 a copy of the requested data or None
2322 </dd> 2334 </dd>
2323 </dl> 2335 </dl>
2324 <a NAME="Project.getDebugProperty" ID="Project.getDebugProperty"></a> 2336 <a NAME="Project.getDebugProperty" ID="Project.getDebugProperty"></a>
2334 <dd> 2346 <dd>
2335 key of the property (string) 2347 key of the property (string)
2336 </dd> 2348 </dd>
2337 </dl> 2349 </dl>
2338 <dl> 2350 <dl>
2339 <dt>Returns:</dt> 2351 <dt>Return:</dt>
2340 <dd> 2352 <dd>
2341 value of the property 2353 value of the property
2342 </dd> 2354 </dd>
2343 </dl> 2355 </dl>
2344 <a NAME="Project.getDebuggerFilters" ID="Project.getDebuggerFilters"></a> 2356 <a NAME="Project.getDebuggerFilters" ID="Project.getDebuggerFilters"></a>
2354 <dd> 2366 <dd>
2355 programming language 2367 programming language
2356 </dd> 2368 </dd>
2357 </dl> 2369 </dl>
2358 <dl> 2370 <dl>
2359 <dt>Returns:</dt> 2371 <dt>Return:</dt>
2360 <dd> 2372 <dd>
2361 filter string 2373 filter string
2362 </dd> 2374 </dd>
2363 </dl> 2375 </dl>
2364 <dl> 2376 <dl>
2373 2385
2374 <p> 2386 <p>
2375 Public method to get the default rcc compiler parameters. 2387 Public method to get the default rcc compiler parameters.
2376 </p> 2388 </p>
2377 <dl> 2389 <dl>
2378 <dt>Returns:</dt> 2390 <dt>Return:</dt>
2379 <dd> 2391 <dd>
2380 dictionary containing the default rcc compiler parameters 2392 dictionary containing the default rcc compiler parameters
2381 </dd> 2393 </dd>
2382 </dl> 2394 </dl>
2383 <dl> 2395 <dl>
2393 <p> 2405 <p>
2394 Public method to get the default extension for the project's 2406 Public method to get the default extension for the project's
2395 programming language. 2407 programming language.
2396 </p> 2408 </p>
2397 <dl> 2409 <dl>
2398 <dt>Returns:</dt> 2410 <dt>Return:</dt>
2399 <dd> 2411 <dd>
2400 default extension (including the dot) (string) 2412 default extension (including the dot) (string)
2413 </dd>
2414 </dl>
2415 <a NAME="Project.getDocstringType" ID="Project.getDocstringType"></a>
2416 <h4>Project.getDocstringType</h4>
2417 <b>getDocstringType</b>(<i></i>)
2418
2419 <p>
2420 Public method to get the configured docstring style.
2421 </p>
2422 <dl>
2423 <dt>Return:</dt>
2424 <dd>
2425 configured docstring style
2426 </dd>
2427 </dl>
2428 <dl>
2429 <dt>Return Type:</dt>
2430 <dd>
2431 str
2401 </dd> 2432 </dd>
2402 </dl> 2433 </dl>
2403 <a NAME="Project.getEditorLexerAssoc" ID="Project.getEditorLexerAssoc"></a> 2434 <a NAME="Project.getEditorLexerAssoc" ID="Project.getEditorLexerAssoc"></a>
2404 <h4>Project.getEditorLexerAssoc</h4> 2435 <h4>Project.getEditorLexerAssoc</h4>
2405 <b>getEditorLexerAssoc</b>(<i>filename</i>) 2436 <b>getEditorLexerAssoc</b>(<i>filename</i>)
2414 filename used to determine the associated lexer 2445 filename used to determine the associated lexer
2415 language (string) 2446 language (string)
2416 </dd> 2447 </dd>
2417 </dl> 2448 </dl>
2418 <dl> 2449 <dl>
2419 <dt>Returns:</dt> 2450 <dt>Return:</dt>
2420 <dd> 2451 <dd>
2421 the requested lexer language (string) 2452 the requested lexer language (string)
2422 </dd> 2453 </dd>
2423 </dl> 2454 </dl>
2424 <a NAME="Project.getEolString" ID="Project.getEolString"></a> 2455 <a NAME="Project.getEolString" ID="Project.getEolString"></a>
2427 2458
2428 <p> 2459 <p>
2429 Public method to get the EOL-string to be used by the project. 2460 Public method to get the EOL-string to be used by the project.
2430 </p> 2461 </p>
2431 <dl> 2462 <dl>
2432 <dt>Returns:</dt> 2463 <dt>Return:</dt>
2433 <dd> 2464 <dd>
2434 eol string (string) 2465 eol string (string)
2435 </dd> 2466 </dd>
2436 </dl> 2467 </dl>
2437 <a NAME="Project.getFiles" ID="Project.getFiles"></a> 2468 <a NAME="Project.getFiles" ID="Project.getFiles"></a>
2447 <dd> 2478 <dd>
2448 prefix (string) 2479 prefix (string)
2449 </dd> 2480 </dd>
2450 </dl> 2481 </dl>
2451 <dl> 2482 <dl>
2452 <dt>Returns:</dt> 2483 <dt>Return:</dt>
2453 <dd> 2484 <dd>
2454 list of files starting with a common prefix (list of strings) 2485 list of files starting with a common prefix (list of strings)
2486 </dd>
2487 </dl>
2488 <a NAME="Project.getFiletypeAssociations" ID="Project.getFiletypeAssociations"></a>
2489 <h4>Project.getFiletypeAssociations</h4>
2490 <b>getFiletypeAssociations</b>(<i>associationType</i>)
2491
2492 <p>
2493 Public method to get the list of file type associations for
2494 the given association type.
2495 </p>
2496 <dl>
2497
2498 <dt><i>associationType</i> (str)</dt>
2499 <dd>
2500 type of the association (one of FORMS,
2501 INTERFACES, OTHERS, PROTOCOLS, RESOURCES, SOURCES or
2502 TRANSLATIONS)
2503 </dd>
2504 </dl>
2505 <dl>
2506 <dt>Return:</dt>
2507 <dd>
2508 list of file patterns for the given type
2509 </dd>
2510 </dl>
2511 <dl>
2512 <dt>Return Type:</dt>
2513 <dd>
2514 list of str
2455 </dd> 2515 </dd>
2456 </dl> 2516 </dl>
2457 <a NAME="Project.getHash" ID="Project.getHash"></a> 2517 <a NAME="Project.getHash" ID="Project.getHash"></a>
2458 <h4>Project.getHash</h4> 2518 <h4>Project.getHash</h4>
2459 <b>getHash</b>(<i></i>) 2519 <b>getHash</b>(<i></i>)
2460 2520
2461 <p> 2521 <p>
2462 Public method to get the project hash. 2522 Public method to get the project hash.
2463 </p> 2523 </p>
2464 <dl> 2524 <dl>
2465 <dt>Returns:</dt> 2525 <dt>Return:</dt>
2466 <dd> 2526 <dd>
2467 project hash as a hex string (string) 2527 project hash as a hex string (string)
2468 </dd> 2528 </dd>
2469 </dl> 2529 </dl>
2470 <a NAME="Project.getMainScript" ID="Project.getMainScript"></a> 2530 <a NAME="Project.getMainScript" ID="Project.getMainScript"></a>
2481 flag indicating a normalized filename is wanted 2541 flag indicating a normalized filename is wanted
2482 (boolean) 2542 (boolean)
2483 </dd> 2543 </dd>
2484 </dl> 2544 </dl>
2485 <dl> 2545 <dl>
2486 <dt>Returns:</dt> 2546 <dt>Return:</dt>
2487 <dd> 2547 <dd>
2488 filename of the projects main script (string) 2548 filename of the projects main script (string)
2489 </dd> 2549 </dd>
2490 </dl> 2550 </dl>
2491 <a NAME="Project.getMenu" ID="Project.getMenu"></a> 2551 <a NAME="Project.getMenu" ID="Project.getMenu"></a>
2501 <dd> 2561 <dd>
2502 name of the menu (string) 2562 name of the menu (string)
2503 </dd> 2563 </dd>
2504 </dl> 2564 </dl>
2505 <dl> 2565 <dl>
2506 <dt>Returns:</dt> 2566 <dt>Return:</dt>
2507 <dd> 2567 <dd>
2508 reference to the requested menu (QMenu) or None 2568 reference to the requested menu (QMenu) or None
2509 </dd> 2569 </dd>
2510 </dl> 2570 </dl>
2511 <a NAME="Project.getModel" ID="Project.getModel"></a> 2571 <a NAME="Project.getModel" ID="Project.getModel"></a>
2514 2574
2515 <p> 2575 <p>
2516 Public method to get a reference to the project browser model. 2576 Public method to get a reference to the project browser model.
2517 </p> 2577 </p>
2518 <dl> 2578 <dl>
2519 <dt>Returns:</dt> 2579 <dt>Return:</dt>
2520 <dd> 2580 <dd>
2521 reference to the project browser model (ProjectBrowserModel) 2581 reference to the project browser model (ProjectBrowserModel)
2522 </dd> 2582 </dd>
2523 </dl> 2583 </dl>
2524 <a NAME="Project.getMostRecent" ID="Project.getMostRecent"></a> 2584 <a NAME="Project.getMostRecent" ID="Project.getMostRecent"></a>
2527 2587
2528 <p> 2588 <p>
2529 Public method to get the most recently opened project. 2589 Public method to get the most recently opened project.
2530 </p> 2590 </p>
2531 <dl> 2591 <dl>
2532 <dt>Returns:</dt> 2592 <dt>Return:</dt>
2533 <dd> 2593 <dd>
2534 path of the most recently opened project (string) 2594 path of the most recently opened project (string)
2535 </dd> 2595 </dd>
2536 </dl> 2596 </dl>
2537 <a NAME="Project.getProgrammingLanguages" ID="Project.getProgrammingLanguages"></a> 2597 <a NAME="Project.getProgrammingLanguages" ID="Project.getProgrammingLanguages"></a>
2540 2600
2541 <p> 2601 <p>
2542 Public method to get the programming languages supported by project. 2602 Public method to get the programming languages supported by project.
2543 </p> 2603 </p>
2544 <dl> 2604 <dl>
2545 <dt>Returns:</dt> 2605 <dt>Return:</dt>
2546 <dd> 2606 <dd>
2547 list of supported programming languages (list of string) 2607 list of supported programming languages (list of string)
2548 </dd> 2608 </dd>
2549 </dl> 2609 </dl>
2550 <a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a> 2610 <a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a>
2553 2613
2554 <p> 2614 <p>
2555 Public method to get the author of the project. 2615 Public method to get the author of the project.
2556 </p> 2616 </p>
2557 <dl> 2617 <dl>
2558 <dt>Returns:</dt> 2618 <dt>Return:</dt>
2559 <dd> 2619 <dd>
2560 author name 2620 author name
2561 </dd> 2621 </dd>
2562 </dl> 2622 </dl>
2563 <dl> 2623 <dl>
2572 2632
2573 <p> 2633 <p>
2574 Public method to get the email address of the project author. 2634 Public method to get the email address of the project author.
2575 </p> 2635 </p>
2576 <dl> 2636 <dl>
2577 <dt>Returns:</dt> 2637 <dt>Return:</dt>
2578 <dd> 2638 <dd>
2579 project author email 2639 project author email
2580 </dd> 2640 </dd>
2581 </dl> 2641 </dl>
2582 <dl> 2642 <dl>
2591 2651
2592 <p> 2652 <p>
2593 Public method to get the description of the project. 2653 Public method to get the description of the project.
2594 </p> 2654 </p>
2595 <dl> 2655 <dl>
2596 <dt>Returns:</dt> 2656 <dt>Return:</dt>
2597 <dd> 2657 <dd>
2598 project description 2658 project description
2599 </dd> 2659 </dd>
2600 </dl> 2660 </dl>
2601 <dl> 2661 <dl>
2610 2670
2611 <p> 2671 <p>
2612 Public method to get the names of the project specific dictionaries. 2672 Public method to get the names of the project specific dictionaries.
2613 </p> 2673 </p>
2614 <dl> 2674 <dl>
2615 <dt>Returns:</dt> 2675 <dt>Return:</dt>
2616 <dd> 2676 <dd>
2617 tuple of two strings giving the absolute path names of the 2677 tuple of two strings giving the absolute path names of the
2618 project specific word and exclude list 2678 project specific word and exclude list
2619 </dd> 2679 </dd>
2620 </dl> 2680 </dl>
2624 2684
2625 <p> 2685 <p>
2626 Public method to get the path of the project file. 2686 Public method to get the path of the project file.
2627 </p> 2687 </p>
2628 <dl> 2688 <dl>
2629 <dt>Returns:</dt> 2689 <dt>Return:</dt>
2630 <dd> 2690 <dd>
2631 path of the project file (string) 2691 path of the project file (string)
2632 </dd> 2692 </dd>
2633 </dl> 2693 </dl>
2634 <a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a> 2694 <a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a>
2649 <dd> 2709 <dd>
2650 flag indicating normalized file names are wanted 2710 flag indicating normalized file names are wanted
2651 </dd> 2711 </dd>
2652 </dl> 2712 </dl>
2653 <dl> 2713 <dl>
2654 <dt>Returns:</dt> 2714 <dt>Return:</dt>
2655 <dd> 2715 <dd>
2656 list of file names 2716 list of file names
2657 </dd> 2717 </dd>
2658 </dl> 2718 </dl>
2659 <dl> 2719 <dl>
2675 2735
2676 <p> 2736 <p>
2677 Public method to get the project's programming language. 2737 Public method to get the project's programming language.
2678 </p> 2738 </p>
2679 <dl> 2739 <dl>
2680 <dt>Returns:</dt> 2740 <dt>Return:</dt>
2681 <dd> 2741 <dd>
2682 programming language (string) 2742 programming language (string)
2683 </dd> 2743 </dd>
2684 </dl> 2744 </dl>
2685 <a NAME="Project.getProjectManagementDir" ID="Project.getProjectManagementDir"></a> 2745 <a NAME="Project.getProjectManagementDir" ID="Project.getProjectManagementDir"></a>
2688 2748
2689 <p> 2749 <p>
2690 Public method to get the path of the management directory. 2750 Public method to get the path of the management directory.
2691 </p> 2751 </p>
2692 <dl> 2752 <dl>
2693 <dt>Returns:</dt> 2753 <dt>Return:</dt>
2694 <dd> 2754 <dd>
2695 path of the management directory (string) 2755 path of the management directory (string)
2696 </dd> 2756 </dd>
2697 </dl> 2757 </dl>
2698 <a NAME="Project.getProjectName" ID="Project.getProjectName"></a> 2758 <a NAME="Project.getProjectName" ID="Project.getProjectName"></a>
2704 </p> 2764 </p>
2705 <p> 2765 <p>
2706 The project name is determined from the name of the project file. 2766 The project name is determined from the name of the project file.
2707 </p> 2767 </p>
2708 <dl> 2768 <dl>
2709 <dt>Returns:</dt> 2769 <dt>Return:</dt>
2710 <dd> 2770 <dd>
2711 name of the project (string) 2771 name of the project (string)
2712 </dd> 2772 </dd>
2713 </dl> 2773 </dl>
2714 <a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a> 2774 <a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a>
2717 2777
2718 <p> 2778 <p>
2719 Public method to get the project path. 2779 Public method to get the project path.
2720 </p> 2780 </p>
2721 <dl> 2781 <dl>
2722 <dt>Returns:</dt> 2782 <dt>Return:</dt>
2723 <dd> 2783 <dd>
2724 project path (string) 2784 project path (string)
2725 </dd> 2785 </dd>
2726 </dl> 2786 </dl>
2727 <a NAME="Project.getProjectSpellLanguage" ID="Project.getProjectSpellLanguage"></a> 2787 <a NAME="Project.getProjectSpellLanguage" ID="Project.getProjectSpellLanguage"></a>
2730 2790
2731 <p> 2791 <p>
2732 Public method to get the project's programming language. 2792 Public method to get the project's programming language.
2733 </p> 2793 </p>
2734 <dl> 2794 <dl>
2735 <dt>Returns:</dt> 2795 <dt>Return:</dt>
2736 <dd> 2796 <dd>
2737 programming language (string) 2797 programming language (string)
2738 </dd> 2798 </dd>
2739 </dl> 2799 </dl>
2740 <a NAME="Project.getProjectType" ID="Project.getProjectType"></a> 2800 <a NAME="Project.getProjectType" ID="Project.getProjectType"></a>
2743 2803
2744 <p> 2804 <p>
2745 Public method to get the type of the project. 2805 Public method to get the type of the project.
2746 </p> 2806 </p>
2747 <dl> 2807 <dl>
2748 <dt>Returns:</dt> 2808 <dt>Return:</dt>
2749 <dd> 2809 <dd>
2750 UI type of the project (string) 2810 UI type of the project (string)
2751 </dd> 2811 </dd>
2752 </dl> 2812 </dl>
2753 <a NAME="Project.getProjectTypes" ID="Project.getProjectTypes"></a> 2813 <a NAME="Project.getProjectTypes" ID="Project.getProjectTypes"></a>
2764 programming language to get project types for 2824 programming language to get project types for
2765 (string) 2825 (string)
2766 </dd> 2826 </dd>
2767 </dl> 2827 </dl>
2768 <dl> 2828 <dl>
2769 <dt>Returns:</dt> 2829 <dt>Return:</dt>
2770 <dd> 2830 <dd>
2771 reference to the dictionary of project types. 2831 reference to the dictionary of project types.
2772 </dd> 2832 </dd>
2773 </dl> 2833 </dl>
2774 <a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a> 2834 <a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a>
2777 2837
2778 <p> 2838 <p>
2779 Public mehod to get the version number of the project. 2839 Public mehod to get the version number of the project.
2780 </p> 2840 </p>
2781 <dl> 2841 <dl>
2782 <dt>Returns:</dt> 2842 <dt>Return:</dt>
2783 <dd> 2843 <dd>
2784 version number 2844 version number
2785 </dd> 2845 </dd>
2786 </dl> 2846 </dl>
2787 <dl> 2847 <dl>
2804 <dd> 2864 <dd>
2805 file or directory name to convert (string) 2865 file or directory name to convert (string)
2806 </dd> 2866 </dd>
2807 </dl> 2867 </dl>
2808 <dl> 2868 <dl>
2809 <dt>Returns:</dt> 2869 <dt>Return:</dt>
2810 <dd> 2870 <dd>
2811 project relative path or unchanged path, if path doesn't 2871 project relative path or unchanged path, if path doesn't
2812 belong to the project (string) 2872 belong to the project (string)
2813 </dd> 2873 </dd>
2814 </dl> 2874 </dl>
2826 <dd> 2886 <dd>
2827 file or directory name to convert (string) 2887 file or directory name to convert (string)
2828 </dd> 2888 </dd>
2829 </dl> 2889 </dl>
2830 <dl> 2890 <dl>
2831 <dt>Returns:</dt> 2891 <dt>Return:</dt>
2832 <dd> 2892 <dd>
2833 project relative path or unchanged path, if path doesn't 2893 project relative path or unchanged path, if path doesn't
2834 belong to the project (string) 2894 belong to the project (string)
2835 </dd> 2895 </dd>
2836 </dl> 2896 </dl>
2848 flag indicating a normalized filename is wanted 2908 flag indicating a normalized filename is wanted
2849 (boolean) 2909 (boolean)
2850 </dd> 2910 </dd>
2851 </dl> 2911 </dl>
2852 <dl> 2912 <dl>
2853 <dt>Returns:</dt> 2913 <dt>Return:</dt>
2854 <dd> 2914 <dd>
2855 list of the projects scripts (list of string) 2915 list of the projects scripts (list of string)
2856 </dd> 2916 </dd>
2857 </dl> 2917 </dl>
2858 <a NAME="Project.getStatusMonitorAutoUpdate" ID="Project.getStatusMonitorAutoUpdate"></a> 2918 <a NAME="Project.getStatusMonitorAutoUpdate" ID="Project.getStatusMonitorAutoUpdate"></a>
2861 2921
2862 <p> 2922 <p>
2863 Public method to retrieve the status of the auto update function. 2923 Public method to retrieve the status of the auto update function.
2864 </p> 2924 </p>
2865 <dl> 2925 <dl>
2866 <dt>Returns:</dt> 2926 <dt>Return:</dt>
2867 <dd> 2927 <dd>
2868 status of the auto update function (boolean) 2928 status of the auto update function (boolean)
2869 </dd> 2929 </dd>
2870 </dl> 2930 </dl>
2871 <a NAME="Project.getStatusMonitorInterval" ID="Project.getStatusMonitorInterval"></a> 2931 <a NAME="Project.getStatusMonitorInterval" ID="Project.getStatusMonitorInterval"></a>
2874 2934
2875 <p> 2935 <p>
2876 Public method to get the monitor interval. 2936 Public method to get the monitor interval.
2877 </p> 2937 </p>
2878 <dl> 2938 <dl>
2879 <dt>Returns:</dt> 2939 <dt>Return:</dt>
2880 <dd> 2940 <dd>
2881 interval in seconds (integer) 2941 interval in seconds (integer)
2882 </dd> 2942 </dd>
2883 </dl> 2943 </dl>
2884 <a NAME="Project.getTranslationPattern" ID="Project.getTranslationPattern"></a> 2944 <a NAME="Project.getTranslationPattern" ID="Project.getTranslationPattern"></a>
2887 2947
2888 <p> 2948 <p>
2889 Public method to get the translation pattern. 2949 Public method to get the translation pattern.
2890 </p> 2950 </p>
2891 <dl> 2951 <dl>
2892 <dt>Returns:</dt> 2952 <dt>Return:</dt>
2893 <dd> 2953 <dd>
2894 translation pattern (string) 2954 translation pattern (string)
2895 </dd> 2955 </dd>
2896 </dl> 2956 </dl>
2897 <a NAME="Project.getUicParameter" ID="Project.getUicParameter"></a> 2957 <a NAME="Project.getUicParameter" ID="Project.getUicParameter"></a>
2907 <dd> 2967 <dd>
2908 name of the parameter 2968 name of the parameter
2909 </dd> 2969 </dd>
2910 </dl> 2970 </dl>
2911 <dl> 2971 <dl>
2912 <dt>Returns:</dt> 2972 <dt>Return:</dt>
2913 <dd> 2973 <dd>
2914 value of the given parameter 2974 value of the given parameter
2915 </dd> 2975 </dd>
2916 </dl> 2976 </dl>
2917 <dl> 2977 <dl>
2926 2986
2927 <p> 2987 <p>
2928 Public method to get a reference to the VCS object. 2988 Public method to get a reference to the VCS object.
2929 </p> 2989 </p>
2930 <dl> 2990 <dl>
2931 <dt>Returns:</dt> 2991 <dt>Return:</dt>
2932 <dd> 2992 <dd>
2933 reference to the VCS object 2993 reference to the VCS object
2934 </dd> 2994 </dd>
2935 </dl> 2995 </dl>
2936 <a NAME="Project.handleApplicationDiagram" ID="Project.handleApplicationDiagram"></a> 2996 <a NAME="Project.handleApplicationDiagram" ID="Project.handleApplicationDiagram"></a>
2945 <b>handlePreferencesChanged</b>(<i></i>) 3005 <b>handlePreferencesChanged</b>(<i></i>)
2946 3006
2947 <p> 3007 <p>
2948 Public slot used to handle the preferencesChanged signal. 3008 Public slot used to handle the preferencesChanged signal.
2949 </p> 3009 </p>
3010 <a NAME="Project.hasDefaultDocstringParameter" ID="Project.hasDefaultDocstringParameter"></a>
3011 <h4>Project.hasDefaultDocstringParameter</h4>
3012 <b>hasDefaultDocstringParameter</b>(<i></i>)
3013
3014 <p>
3015 Public method to test, if the project contains the default docstring
3016 parameter.
3017 </p>
3018 <dl>
3019 <dt>Return:</dt>
3020 <dd>
3021 flag indicating default parameter
3022 </dd>
3023 </dl>
3024 <dl>
3025 <dt>Return Type:</dt>
3026 <dd>
3027 bool
3028 </dd>
3029 </dl>
2950 <a NAME="Project.hasDefaultIdlCompilerParameters" ID="Project.hasDefaultIdlCompilerParameters"></a> 3030 <a NAME="Project.hasDefaultIdlCompilerParameters" ID="Project.hasDefaultIdlCompilerParameters"></a>
2951 <h4>Project.hasDefaultIdlCompilerParameters</h4> 3031 <h4>Project.hasDefaultIdlCompilerParameters</h4>
2952 <b>hasDefaultIdlCompilerParameters</b>(<i></i>) 3032 <b>hasDefaultIdlCompilerParameters</b>(<i></i>)
2953 3033
2954 <p> 3034 <p>
2955 Public method to test, if the project contains the default IDL compiler 3035 Public method to test, if the project contains the default IDL compiler
2956 parameters. 3036 parameters.
2957 </p> 3037 </p>
2958 <dl> 3038 <dl>
2959 <dt>Returns:</dt> 3039 <dt>Return:</dt>
2960 <dd> 3040 <dd>
2961 flag indicating default parameter set 3041 flag indicating default parameter set
2962 </dd> 3042 </dd>
2963 </dl> 3043 </dl>
2964 <dl> 3044 <dl>
2974 <p> 3054 <p>
2975 Public method to test, if the project contains the default make 3055 Public method to test, if the project contains the default make
2976 parameters. 3056 parameters.
2977 </p> 3057 </p>
2978 <dl> 3058 <dl>
2979 <dt>Returns:</dt> 3059 <dt>Return:</dt>
2980 <dd> 3060 <dd>
2981 flag indicating default parameter set 3061 flag indicating default parameter set
2982 </dd> 3062 </dd>
2983 </dl> 3063 </dl>
2984 <dl> 3064 <dl>
2994 <p> 3074 <p>
2995 Public method to test, if the project contains the default rcc compiler 3075 Public method to test, if the project contains the default rcc compiler
2996 parameters. 3076 parameters.
2997 </p> 3077 </p>
2998 <dl> 3078 <dl>
2999 <dt>Returns:</dt> 3079 <dt>Return:</dt>
3000 <dd> 3080 <dd>
3001 flag indicating default parameter set 3081 flag indicating default parameter set
3002 </dd> 3082 </dd>
3003 </dl> 3083 </dl>
3004 <dl> 3084 <dl>
3014 <p> 3094 <p>
3015 Public method to test, if the project contains the default uic compiler 3095 Public method to test, if the project contains the default uic compiler
3016 parameters. 3096 parameters.
3017 </p> 3097 </p>
3018 <dl> 3098 <dl>
3019 <dt>Returns:</dt> 3099 <dt>Return:</dt>
3020 <dd> 3100 <dd>
3021 flag indicating default parameter set 3101 flag indicating default parameter set
3022 </dd> 3102 </dd>
3023 </dl> 3103 </dl>
3024 <dl> 3104 <dl>
3040 <dd> 3120 <dd>
3041 filename to be checked (string) 3121 filename to be checked (string)
3042 </dd> 3122 </dd>
3043 </dl> 3123 </dl>
3044 <dl> 3124 <dl>
3045 <dt>Returns:</dt> 3125 <dt>Return:</dt>
3046 <dd> 3126 <dd>
3047 flag indicating, if the project contains the file (boolean) 3127 flag indicating, if the project contains the file (boolean)
3048 </dd> 3128 </dd>
3049 </dl> 3129 </dl>
3050 <a NAME="Project.hasProjectType" ID="Project.hasProjectType"></a> 3130 <a NAME="Project.hasProjectType" ID="Project.hasProjectType"></a>
3064 <dd> 3144 <dd>
3065 programming language of the project type (string) 3145 programming language of the project type (string)
3066 </dd> 3146 </dd>
3067 </dl> 3147 </dl>
3068 <dl> 3148 <dl>
3069 <dt>Returns:</dt> 3149 <dt>Return:</dt>
3070 <dd> 3150 <dd>
3071 flag indicating presence of the project type (boolean) 3151 flag indicating presence of the project type (boolean)
3072 </dd> 3152 </dd>
3073 </dl> 3153 </dl>
3074 <a NAME="Project.initActions" ID="Project.initActions"></a> 3154 <a NAME="Project.initActions" ID="Project.initActions"></a>
3092 3172
3093 <p> 3173 <p>
3094 Public slot to initialize the project menus. 3174 Public slot to initialize the project menus.
3095 </p> 3175 </p>
3096 <dl> 3176 <dl>
3097 <dt>Returns:</dt> 3177 <dt>Return:</dt>
3098 <dd> 3178 <dd>
3099 tuple of generated menus 3179 tuple of generated menus
3100 </dd> 3180 </dd>
3101 </dl> 3181 </dl>
3102 <dl> 3182 <dl>
3120 reference to a toolbar manager object 3200 reference to a toolbar manager object
3121 (E5ToolBarManager) 3201 (E5ToolBarManager)
3122 </dd> 3202 </dd>
3123 </dl> 3203 </dl>
3124 <dl> 3204 <dl>
3125 <dt>Returns:</dt> 3205 <dt>Return:</dt>
3126 <dd> 3206 <dd>
3127 tuple of the generated toolbars (tuple of two QToolBar) 3207 tuple of the generated toolbars (tuple of two QToolBar)
3128 </dd> 3208 </dd>
3129 </dl> 3209 </dl>
3130 <a NAME="Project.initVCS" ID="Project.initVCS"></a> 3210 <a NAME="Project.initVCS" ID="Project.initVCS"></a>
3145 flag indicating to ignore an override request 3225 flag indicating to ignore an override request
3146 (boolean) 3226 (boolean)
3147 </dd> 3227 </dd>
3148 </dl> 3228 </dl>
3149 <dl> 3229 <dl>
3150 <dt>Returns:</dt> 3230 <dt>Return:</dt>
3151 <dd> 3231 <dd>
3152 a reference to the vcs object 3232 a reference to the vcs object
3153 </dd> 3233 </dd>
3154 </dl> 3234 </dl>
3155 <a NAME="Project.isDebugPropertiesLoaded" ID="Project.isDebugPropertiesLoaded"></a> 3235 <a NAME="Project.isDebugPropertiesLoaded" ID="Project.isDebugPropertiesLoaded"></a>
3158 3238
3159 <p> 3239 <p>
3160 Public method to return the status of the debug properties. 3240 Public method to return the status of the debug properties.
3161 </p> 3241 </p>
3162 <dl> 3242 <dl>
3163 <dt>Returns:</dt> 3243 <dt>Return:</dt>
3164 <dd> 3244 <dd>
3165 load status of debug properties (boolean) 3245 load status of debug properties (boolean)
3166 </dd> 3246 </dd>
3167 </dl> 3247 </dl>
3168 <a NAME="Project.isDirty" ID="Project.isDirty"></a> 3248 <a NAME="Project.isDirty" ID="Project.isDirty"></a>
3171 3251
3172 <p> 3252 <p>
3173 Public method to return the dirty state. 3253 Public method to return the dirty state.
3174 </p> 3254 </p>
3175 <dl> 3255 <dl>
3176 <dt>Returns:</dt> 3256 <dt>Return:</dt>
3177 <dd> 3257 <dd>
3178 dirty state (boolean) 3258 dirty state (boolean)
3179 </dd> 3259 </dd>
3180 </dl> 3260 </dl>
3181 <a NAME="Project.isJavaScriptProject" ID="Project.isJavaScriptProject"></a> 3261 <a NAME="Project.isJavaScriptProject" ID="Project.isJavaScriptProject"></a>
3184 3264
3185 <p> 3265 <p>
3186 Public method to check, if this project is a JavaScript project. 3266 Public method to check, if this project is a JavaScript project.
3187 </p> 3267 </p>
3188 <dl> 3268 <dl>
3189 <dt>Returns:</dt> 3269 <dt>Return:</dt>
3190 <dd> 3270 <dd>
3191 flag indicating a JavaScript project (boolean) 3271 flag indicating a JavaScript project (boolean)
3192 </dd> 3272 </dd>
3193 </dl> 3273 </dl>
3194 <a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a> 3274 <a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a>
3197 3277
3198 <p> 3278 <p>
3199 Public method to test, if make is enabled for the project. 3279 Public method to test, if make is enabled for the project.
3200 </p> 3280 </p>
3201 <dl> 3281 <dl>
3202 <dt>Returns:</dt> 3282 <dt>Return:</dt>
3203 <dd> 3283 <dd>
3204 flag indicating enabled make support 3284 flag indicating enabled make support
3205 </dd> 3285 </dd>
3206 </dl> 3286 </dl>
3207 <dl> 3287 <dl>
3216 3296
3217 <p> 3297 <p>
3218 Public method to check, if this project is a MicroPython project. 3298 Public method to check, if this project is a MicroPython project.
3219 </p> 3299 </p>
3220 <dl> 3300 <dl>
3221 <dt>Returns:</dt> 3301 <dt>Return:</dt>
3222 <dd> 3302 <dd>
3223 flag indicating a MicroPython project 3303 flag indicating a MicroPython project
3224 </dd> 3304 </dd>
3225 </dl> 3305 </dl>
3226 <dl> 3306 <dl>
3235 3315
3236 <p> 3316 <p>
3237 Public method to check, if this is a mixed language project. 3317 Public method to check, if this is a mixed language project.
3238 </p> 3318 </p>
3239 <dl> 3319 <dl>
3240 <dt>Returns:</dt> 3320 <dt>Return:</dt>
3241 <dd> 3321 <dd>
3242 flag indicating a mixed language project 3322 flag indicating a mixed language project
3243 </dd> 3323 </dd>
3244 </dl> 3324 </dl>
3245 <dl> 3325 <dl>
3254 3334
3255 <p> 3335 <p>
3256 Public method to return the opened state. 3336 Public method to return the opened state.
3257 </p> 3337 </p>
3258 <dl> 3338 <dl>
3259 <dt>Returns:</dt> 3339 <dt>Return:</dt>
3260 <dd> 3340 <dd>
3261 open state (boolean) 3341 open state (boolean)
3262 </dd> 3342 </dd>
3263 </dl> 3343 </dl>
3264 <a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a> 3344 <a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a>
3275 <dd> 3355 <dd>
3276 filename to be checked (string) 3356 filename to be checked (string)
3277 </dd> 3357 </dd>
3278 </dl> 3358 </dl>
3279 <dl> 3359 <dl>
3280 <dt>Returns:</dt> 3360 <dt>Return:</dt>
3281 <dd> 3361 <dd>
3282 flag indicating membership (boolean) 3362 flag indicating membership (boolean)
3283 </dd> 3363 </dd>
3284 </dl> 3364 </dl>
3285 <a NAME="Project.isProjectForm" ID="Project.isProjectForm"></a> 3365 <a NAME="Project.isProjectForm" ID="Project.isProjectForm"></a>
3296 <dd> 3376 <dd>
3297 filename to be checked (string) 3377 filename to be checked (string)
3298 </dd> 3378 </dd>
3299 </dl> 3379 </dl>
3300 <dl> 3380 <dl>
3301 <dt>Returns:</dt> 3381 <dt>Return:</dt>
3302 <dd> 3382 <dd>
3303 flag indicating membership (boolean) 3383 flag indicating membership (boolean)
3304 </dd> 3384 </dd>
3305 </dl> 3385 </dl>
3306 <a NAME="Project.isProjectInterface" ID="Project.isProjectInterface"></a> 3386 <a NAME="Project.isProjectInterface" ID="Project.isProjectInterface"></a>
3317 <dd> 3397 <dd>
3318 filename to be checked (string) 3398 filename to be checked (string)
3319 </dd> 3399 </dd>
3320 </dl> 3400 </dl>
3321 <dl> 3401 <dl>
3322 <dt>Returns:</dt> 3402 <dt>Return:</dt>
3323 <dd> 3403 <dd>
3324 flag indicating membership (boolean) 3404 flag indicating membership (boolean)
3325 </dd> 3405 </dd>
3326 </dl> 3406 </dl>
3327 <a NAME="Project.isProjectProtocol" ID="Project.isProjectProtocol"></a> 3407 <a NAME="Project.isProjectProtocol" ID="Project.isProjectProtocol"></a>
3338 <dd> 3418 <dd>
3339 filename to be checked 3419 filename to be checked
3340 </dd> 3420 </dd>
3341 </dl> 3421 </dl>
3342 <dl> 3422 <dl>
3343 <dt>Returns:</dt> 3423 <dt>Return:</dt>
3344 <dd> 3424 <dd>
3345 flag indicating membership 3425 flag indicating membership
3346 </dd> 3426 </dd>
3347 </dl> 3427 </dl>
3348 <dl> 3428 <dl>
3365 <dd> 3445 <dd>
3366 filename to be checked (string) 3446 filename to be checked (string)
3367 </dd> 3447 </dd>
3368 </dl> 3448 </dl>
3369 <dl> 3449 <dl>
3370 <dt>Returns:</dt> 3450 <dt>Return:</dt>
3371 <dd> 3451 <dd>
3372 flag indicating membership (boolean) 3452 flag indicating membership (boolean)
3373 </dd> 3453 </dd>
3374 </dl> 3454 </dl>
3375 <a NAME="Project.isProjectSource" ID="Project.isProjectSource"></a> 3455 <a NAME="Project.isProjectSource" ID="Project.isProjectSource"></a>
3386 <dd> 3466 <dd>
3387 filename to be checked (string) 3467 filename to be checked (string)
3388 </dd> 3468 </dd>
3389 </dl> 3469 </dl>
3390 <dl> 3470 <dl>
3391 <dt>Returns:</dt> 3471 <dt>Return:</dt>
3392 <dd> 3472 <dd>
3393 flag indicating membership (boolean) 3473 flag indicating membership (boolean)
3394 </dd> 3474 </dd>
3395 </dl> 3475 </dl>
3396 <a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a> 3476 <a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a>
3399 3479
3400 <p> 3480 <p>
3401 Public method to check, if this project is a Python3 project. 3481 Public method to check, if this project is a Python3 project.
3402 </p> 3482 </p>
3403 <dl> 3483 <dl>
3404 <dt>Returns:</dt> 3484 <dt>Return:</dt>
3405 <dd> 3485 <dd>
3406 flag indicating a Python3 project (boolean) 3486 flag indicating a Python3 project (boolean)
3407 </dd> 3487 </dd>
3408 </dl> 3488 </dl>
3409 <a NAME="Project.isPythonProject" ID="Project.isPythonProject"></a> 3489 <a NAME="Project.isPythonProject" ID="Project.isPythonProject"></a>
3413 <p> 3493 <p>
3414 Public method to check, if this project is a Python3 or MicroPython 3494 Public method to check, if this project is a Python3 or MicroPython
3415 project. 3495 project.
3416 </p> 3496 </p>
3417 <dl> 3497 <dl>
3418 <dt>Returns:</dt> 3498 <dt>Return:</dt>
3419 <dd> 3499 <dd>
3420 flag indicating a Python project (boolean) 3500 flag indicating a Python project (boolean)
3421 </dd> 3501 </dd>
3422 </dl> 3502 </dl>
3423 <a NAME="Project.isRubyProject" ID="Project.isRubyProject"></a> 3503 <a NAME="Project.isRubyProject" ID="Project.isRubyProject"></a>
3426 3506
3427 <p> 3507 <p>
3428 Public method to check, if this project is a Ruby project. 3508 Public method to check, if this project is a Ruby project.
3429 </p> 3509 </p>
3430 <dl> 3510 <dl>
3431 <dt>Returns:</dt> 3511 <dt>Return:</dt>
3432 <dd> 3512 <dd>
3433 flag indicating a Ruby project (boolean) 3513 flag indicating a Ruby project (boolean)
3434 </dd> 3514 </dd>
3435 </dl> 3515 </dl>
3436 <a NAME="Project.moveDirectory" ID="Project.moveDirectory"></a> 3516 <a NAME="Project.moveDirectory" ID="Project.moveDirectory"></a>
3481 <dt><i>restoreSession</i></dt> 3561 <dt><i>restoreSession</i></dt>
3482 <dd> 3562 <dd>
3483 flag indicating to restore the project 3563 flag indicating to restore the project
3484 session (boolean) 3564 session (boolean)
3485 </dd> 3565 </dd>
3486 <dt><i>reopen=</i></dt> 3566 <dt><i>reopen</i></dt>
3487 <dd> 3567 <dd>
3488 flag indicating a reopening of the project (boolean) 3568 flag indicating a reopening of the project (boolean)
3489 </dd> 3569 </dd>
3490 </dl> 3570 </dl>
3491 <a NAME="Project.othersAdded" ID="Project.othersAdded"></a> 3571 <a NAME="Project.othersAdded" ID="Project.othersAdded"></a>
3523 </dd> 3603 </dd>
3524 <dt><i>description</i></dt> 3604 <dt><i>description</i></dt>
3525 <dd> 3605 <dd>
3526 more verbose type name (display string) (string) 3606 more verbose type name (display string) (string)
3527 </dd> 3607 </dd>
3528 <dt><i>fileTypeCallback=</i></dt> 3608 <dt><i>fileTypeCallback</i></dt>
3529 <dd> 3609 <dd>
3530 reference to a method returning a dictionary 3610 reference to a method returning a dictionary
3531 of filetype associations. 3611 of filetype associations.
3532 </dd> 3612 </dd>
3533 <dt><i>binaryTranslationsCallback=</i></dt> 3613 <dt><i>binaryTranslationsCallback</i></dt>
3534 <dd> 3614 <dd>
3535 reference to a method returning 3615 reference to a method returning
3536 the name of the binary translation file given the name of the raw 3616 the name of the binary translation file given the name of the raw
3537 translation file 3617 translation file
3538 </dd> 3618 </dd>
3539 <dt><i>lexerAssociationCallback=</i></dt> 3619 <dt><i>lexerAssociationCallback</i></dt>
3540 <dd> 3620 <dd>
3541 reference to a method returning the 3621 reference to a method returning the
3542 lexer type to be used for syntax highlighting given the name of 3622 lexer type to be used for syntax highlighting given the name of
3543 a file 3623 a file
3544 </dd> 3624 </dd>
3545 <dt><i>progLanguages=</i></dt> 3625 <dt><i>progLanguages</i></dt>
3546 <dd> 3626 <dd>
3547 programming languages supported by the 3627 programming languages supported by the
3548 project type (list of string) 3628 project type (list of string)
3549 </dd> 3629 </dd>
3550 </dl> 3630 </dl>
3635 <dd> 3715 <dd>
3636 new filename of the file (string) 3716 new filename of the file (string)
3637 </dd> 3717 </dd>
3638 </dl> 3718 </dl>
3639 <dl> 3719 <dl>
3640 <dt>Returns:</dt> 3720 <dt>Return:</dt>
3641 <dd> 3721 <dd>
3642 flag indicating success 3722 flag indicating success
3643 </dd> 3723 </dd>
3644 </dl> 3724 </dl>
3645 <a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a> 3725 <a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a>
3718 <p> 3798 <p>
3719 Public method to save all scripts belonging to the project. 3799 Public method to save all scripts belonging to the project.
3720 </p> 3800 </p>
3721 <dl> 3801 <dl>
3722 3802
3723 <dt><i>reportSyntaxErrors=</i></dt> 3803 <dt><i>reportSyntaxErrors</i></dt>
3724 <dd> 3804 <dd>
3725 flag indicating special reporting 3805 flag indicating special reporting
3726 for syntax errors (boolean) 3806 for syntax errors (boolean)
3727 </dd> 3807 </dd>
3728 </dl> 3808 </dl>
3729 <dl> 3809 <dl>
3730 <dt>Returns:</dt> 3810 <dt>Return:</dt>
3731 <dd> 3811 <dd>
3732 flag indicating success (boolean) 3812 flag indicating success (boolean)
3733 </dd> 3813 </dd>
3734 </dl> 3814 </dl>
3735 <a NAME="Project.saveProject" ID="Project.saveProject"></a> 3815 <a NAME="Project.saveProject" ID="Project.saveProject"></a>
3738 3818
3739 <p> 3819 <p>
3740 Public slot to save the current project. 3820 Public slot to save the current project.
3741 </p> 3821 </p>
3742 <dl> 3822 <dl>
3743 <dt>Returns:</dt> 3823 <dt>Return:</dt>
3744 <dd> 3824 <dd>
3745 flag indicating success 3825 flag indicating success
3746 </dd> 3826 </dd>
3747 </dl> 3827 </dl>
3748 <a NAME="Project.saveProjectAs" ID="Project.saveProjectAs"></a> 3828 <a NAME="Project.saveProjectAs" ID="Project.saveProjectAs"></a>
3751 3831
3752 <p> 3832 <p>
3753 Public slot to save the current project to a different file. 3833 Public slot to save the current project to a different file.
3754 </p> 3834 </p>
3755 <dl> 3835 <dl>
3756 <dt>Returns:</dt> 3836 <dt>Return:</dt>
3757 <dd> 3837 <dd>
3758 flag indicating success (boolean) 3838 flag indicating success (boolean)
3759 </dd> 3839 </dd>
3760 </dl> 3840 </dl>
3761 <a NAME="Project.setData" ID="Project.setData"></a> 3841 <a NAME="Project.setData" ID="Project.setData"></a>
3781 <dd> 3861 <dd>
3782 data to be stored 3862 data to be stored
3783 </dd> 3863 </dd>
3784 </dl> 3864 </dl>
3785 <dl> 3865 <dl>
3786 <dt>Returns:</dt> 3866 <dt>Return:</dt>
3787 <dd> 3867 <dd>
3788 flag indicating success (boolean) 3868 flag indicating success (boolean)
3789 </dd> 3869 </dd>
3790 </dl> 3870 </dl>
3791 <a NAME="Project.setDbgInfo" ID="Project.setDbgInfo"></a> 3871 <a NAME="Project.setDbgInfo" ID="Project.setDbgInfo"></a>
3792 <h4>Project.setDbgInfo</h4> 3872 <h4>Project.setDbgInfo</h4>
3793 <b>setDbgInfo</b>(<i>venvName, argv, wd, env, excReporting, excList, excIgnoreList, autoClearShell, tracePython=None, autoContinue=None</i>) 3873 <b>setDbgInfo</b>(<i>venvName, argv, wd, env, excReporting, excList, excIgnoreList, autoClearShell, tracePython=None, autoContinue=None, enableMultiprocess=None, multiprocessNoDebug=None</i>)
3794 3874
3795 <p> 3875 <p>
3796 Public method to set the debugging information. 3876 Public method to set the debugging information.
3797 </p> 3877 </p>
3798 <dl> 3878 <dl>
3828 <dt><i>autoClearShell</i> (bool)</dt> 3908 <dt><i>autoClearShell</i> (bool)</dt>
3829 <dd> 3909 <dd>
3830 flag indicating, that the interpreter window 3910 flag indicating, that the interpreter window
3831 should be cleared 3911 should be cleared
3832 </dd> 3912 </dd>
3833 <dt><i>tracePython=</i> (bool)</dt> 3913 <dt><i>tracePython</i> (bool)</dt>
3834 <dd> 3914 <dd>
3835 flag to indicate if the Python library should be 3915 flag to indicate if the Python library should be
3836 traced as well 3916 traced as well
3837 </dd> 3917 </dd>
3838 <dt><i>autoContinue=</i> (bool)</dt> 3918 <dt><i>autoContinue</i> (bool)</dt>
3839 <dd> 3919 <dd>
3840 flag indicating, that the debugger should not 3920 flag indicating, that the debugger should not
3841 stop at the first executable line 3921 stop at the first executable line
3922 </dd>
3923 <dt><i>enableMultiprocess</i> (bool)</dt>
3924 <dd>
3925 flag indicating, that the debugger should
3926 run in multi process mode
3927 </dd>
3928 <dt><i>multiprocessNoDebug</i> (str)</dt>
3929 <dd>
3930 list of programs not to be debugged in
3931 multi process mode
3842 </dd> 3932 </dd>
3843 </dl> 3933 </dl>
3844 <a NAME="Project.setDirty" ID="Project.setDirty"></a> 3934 <a NAME="Project.setDirty" ID="Project.setDirty"></a>
3845 <h4>Project.setDirty</h4> 3935 <h4>Project.setDirty</h4>
3846 <b>setDirty</b>(<i>dirty</i>) 3936 <b>setDirty</b>(<i>dirty</i>)
3927 <dd> 4017 <dd>
3928 path to be checked (string) 4018 path to be checked (string)
3929 </dd> 4019 </dd>
3930 </dl> 4020 </dl>
3931 <dl> 4021 <dl>
3932 <dt>Returns:</dt> 4022 <dt>Return:</dt>
3933 <dd> 4023 <dd>
3934 flag indicating that the path starts with the project path 4024 flag indicating that the path starts with the project path
3935 (boolean) 4025 (boolean)
3936 </dd> 4026 </dd>
3937 </dl> 4027 </dl>
3977 4067
3978 <p> 4068 <p>
3979 Public method to check, if the project uses the system eol setting. 4069 Public method to check, if the project uses the system eol setting.
3980 </p> 4070 </p>
3981 <dl> 4071 <dl>
3982 <dt>Returns:</dt> 4072 <dt>Return:</dt>
3983 <dd> 4073 <dd>
3984 flag indicating the usage of system eol (boolean) 4074 flag indicating the usage of system eol (boolean)
3985 </dd> 4075 </dd>
3986 </dl> 4076 </dl>
3987 <a NAME="Project.vcsSoftwareAvailable" ID="Project.vcsSoftwareAvailable"></a> 4077 <a NAME="Project.vcsSoftwareAvailable" ID="Project.vcsSoftwareAvailable"></a>
3991 <p> 4081 <p>
3992 Public method to check, if some supported VCS software is available 4082 Public method to check, if some supported VCS software is available
3993 to the IDE. 4083 to the IDE.
3994 </p> 4084 </p>
3995 <dl> 4085 <dl>
3996 <dt>Returns:</dt> 4086 <dt>Return:</dt>
3997 <dd> 4087 <dd>
3998 flag indicating availability of VCS software (boolean) 4088 flag indicating availability of VCS software (boolean)
3999 </dd> 4089 </dd>
4000 </dl> 4090 </dl>
4001 <a NAME="Project.writeTasks" ID="Project.writeTasks"></a> 4091 <a NAME="Project.writeTasks" ID="Project.writeTasks"></a>

Mercurial Repository: eric

eric ide

mercurial