src/eric7/Documentation/Source/eric7.Project.Project.html

branch
eric7
changeset 9323
6ae7193558ac
parent 9295
d14096c04126
child 9338
e7e6c61805cf
equal deleted inserted replaced
9322:3f0fe9a79aa1 9323:6ae7193558ac
287 <tr> 287 <tr>
288 <td><a href="#Project.__closeAllWindows">__closeAllWindows</a></td> 288 <td><a href="#Project.__closeAllWindows">__closeAllWindows</a></td>
289 <td>Private method to close all project related windows.</td> 289 <td>Private method to close all project related windows.</td>
290 </tr> 290 </tr>
291 <tr> 291 <tr>
292 <td><a href="#Project.__configureEnvironment">__configureEnvironment</a></td>
293 <td>Private slot to configure the embedded environment.</td>
294 </tr>
295 <tr>
296 <td><a href="#Project.__createEmbeddedEnvironment">__createEmbeddedEnvironment</a></td>
297 <td>Private method to create the embedded virtual environment.</td>
298 </tr>
299 <tr>
292 <td><a href="#Project.__createSBOMFile">__createSBOMFile</a></td> 300 <td><a href="#Project.__createSBOMFile">__createSBOMFile</a></td>
293 <td>Private slot to create a SBOM file of the project dependencies.</td> 301 <td>Private slot to create a SBOM file of the project dependencies.</td>
294 </tr> 302 </tr>
295 <tr> 303 <tr>
296 <td><a href="#Project.__createSnapshotSource">__createSnapshotSource</a></td> 304 <td><a href="#Project.__createSnapshotSource">__createSnapshotSource</a></td>
315 <tr> 323 <tr>
316 <td><a href="#Project.__executeMake">__executeMake</a></td> 324 <td><a href="#Project.__executeMake">__executeMake</a></td>
317 <td>Private method to execute a project specific make run.</td> 325 <td>Private method to execute a project specific make run.</td>
318 </tr> 326 </tr>
319 <tr> 327 <tr>
328 <td><a href="#Project.__findEmbeddedEnvironment">__findEmbeddedEnvironment</a></td>
329 <td>Private method to find the path of the embedded virtual environment.</td>
330 </tr>
331 <tr>
320 <td><a href="#Project.__initData">__initData</a></td> 332 <td><a href="#Project.__initData">__initData</a></td>
321 <td>Private method to initialize the project data part.</td> 333 <td>Private method to initialize the project data part.</td>
322 </tr> 334 </tr>
323 <tr> 335 <tr>
324 <td><a href="#Project.__initDebugProperties">__initDebugProperties</a></td> 336 <td><a href="#Project.__initDebugProperties">__initDebugProperties</a></td>
327 <tr> 339 <tr>
328 <td><a href="#Project.__initProjectTypes">__initProjectTypes</a></td> 340 <td><a href="#Project.__initProjectTypes">__initProjectTypes</a></td>
329 <td>Private method to initialize the list of supported project types.</td> 341 <td>Private method to initialize the list of supported project types.</td>
330 </tr> 342 </tr>
331 <tr> 343 <tr>
344 <td><a href="#Project.__initVenvConfiguration">__initVenvConfiguration</a></td>
345 <td>Private method to initialize the environment configuration.</td>
346 </tr>
347 <tr>
348 <td><a href="#Project.__installProjectIntoEnvironment">__installProjectIntoEnvironment</a></td>
349 <td>Private method to install the project into the embedded environment in development mode.</td>
350 </tr>
351 <tr>
332 <td><a href="#Project.__isInPdata">__isInPdata</a></td> 352 <td><a href="#Project.__isInPdata">__isInPdata</a></td>
333 <td>Private method used to check, if the passed in filename is project controlled..</td> 353 <td>Private method used to check, if the passed in filename is project controlled..</td>
334 </tr> 354 </tr>
335 <tr> 355 <tr>
336 <td><a href="#Project.__loadDiagram">__loadDiagram</a></td> 356 <td><a href="#Project.__loadDiagram">__loadDiagram</a></td>
337 <td>Private slot to load a diagram from file.</td> 357 <td>Private slot to load a diagram from file.</td>
338 </tr> 358 </tr>
339 <tr> 359 <tr>
360 <td><a href="#Project.__loadEnvironmentConfiguration">__loadEnvironmentConfiguration</a></td>
361 <td>Private method to load the embedded environment configuration.</td>
362 </tr>
363 <tr>
340 <td><a href="#Project.__loadRecent">__loadRecent</a></td> 364 <td><a href="#Project.__loadRecent">__loadRecent</a></td>
341 <td>Private method to load the recently opened project filenames.</td> 365 <td>Private method to load the recently opened project filenames.</td>
342 </tr> 366 </tr>
343 <tr> 367 <tr>
344 <td><a href="#Project.__makeFinished">__makeFinished</a></td> 368 <td><a href="#Project.__makeFinished">__makeFinished</a></td>
403 <tr> 427 <tr>
404 <td><a href="#Project.__reorganizeFiles">__reorganizeFiles</a></td> 428 <td><a href="#Project.__reorganizeFiles">__reorganizeFiles</a></td>
405 <td>Private method to reorganize files stored in the project.</td> 429 <td>Private method to reorganize files stored in the project.</td>
406 </tr> 430 </tr>
407 <tr> 431 <tr>
432 <td><a href="#Project.__saveEnvironmentConfiguration">__saveEnvironmentConfiguration</a></td>
433 <td>Private method to save the embedded environment configuration.</td>
434 </tr>
435 <tr>
408 <td><a href="#Project.__saveRecent">__saveRecent</a></td> 436 <td><a href="#Project.__saveRecent">__saveRecent</a></td>
409 <td>Private method to save the list of recently opened filenames.</td> 437 <td>Private method to save the list of recently opened filenames.</td>
410 </tr> 438 </tr>
411 <tr> 439 <tr>
412 <td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td> 440 <td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td>
415 <tr> 443 <tr>
416 <td><a href="#Project.__searchProjectFile">__searchProjectFile</a></td> 444 <td><a href="#Project.__searchProjectFile">__searchProjectFile</a></td>
417 <td>Private slot to show the Find Project File dialog.</td> 445 <td>Private slot to show the Find Project File dialog.</td>
418 </tr> 446 </tr>
419 <tr> 447 <tr>
448 <td><a href="#Project.__setEmbeddedEnvironmentProjectConfig">__setEmbeddedEnvironmentProjectConfig</a></td>
449 <td>Private method to set the embedded environment project configuration.</td>
450 </tr>
451 <tr>
420 <td><a href="#Project.__showCodeCoverage">__showCodeCoverage</a></td> 452 <td><a href="#Project.__showCodeCoverage">__showCodeCoverage</a></td>
421 <td>Private slot used to show the code coverage information for the project files.</td> 453 <td>Private slot used to show the code coverage information for the project files.</td>
422 </tr> 454 </tr>
423 <tr> 455 <tr>
424 <td><a href="#Project.__showCodeMetrics">__showCodeMetrics</a></td> 456 <td><a href="#Project.__showCodeMetrics">__showCodeMetrics</a></td>
433 <td>Private slot called before the checks menu is shown.</td> 465 <td>Private slot called before the checks menu is shown.</td>
434 </tr> 466 </tr>
435 <tr> 467 <tr>
436 <td><a href="#Project.__showContextMenuDebugger">__showContextMenuDebugger</a></td> 468 <td><a href="#Project.__showContextMenuDebugger">__showContextMenuDebugger</a></td>
437 <td>Private slot called before the Debugger menu is shown.</td> 469 <td>Private slot called before the Debugger menu is shown.</td>
470 </tr>
471 <tr>
472 <td><a href="#Project.__showContextMenuEnvironment">__showContextMenuEnvironment</a></td>
473 <td>Private slot called before the 'Embedded Environment' menu is shown.</td>
438 </tr> 474 </tr>
439 <tr> 475 <tr>
440 <td><a href="#Project.__showContextMenuFormat">__showContextMenuFormat</a></td> 476 <td><a href="#Project.__showContextMenuFormat">__showContextMenuFormat</a></td>
441 <td>Private slot called before the 'Code Formatting' menu is shown.</td> 477 <td>Private slot called before the 'Code Formatting' menu is shown.</td>
442 </tr> 478 </tr>
1269 <h4>Project.__closeAllWindows</h4> 1305 <h4>Project.__closeAllWindows</h4>
1270 <b>__closeAllWindows</b>(<i></i>) 1306 <b>__closeAllWindows</b>(<i></i>)
1271 1307
1272 <p> 1308 <p>
1273 Private method to close all project related windows. 1309 Private method to close all project related windows.
1310 </p>
1311 <a NAME="Project.__configureEnvironment" ID="Project.__configureEnvironment"></a>
1312 <h4>Project.__configureEnvironment</h4>
1313 <b>__configureEnvironment</b>(<i>environmentPath=""</i>)
1314
1315 <p>
1316 Private slot to configure the embedded environment.
1317 </p>
1318 <dl>
1319
1320 <dt><i>environmentPath</i> (str (optional))</dt>
1321 <dd>
1322 path of the virtual environment (defaults to "")
1323 </dd>
1324 </dl>
1325 <a NAME="Project.__createEmbeddedEnvironment" ID="Project.__createEmbeddedEnvironment"></a>
1326 <h4>Project.__createEmbeddedEnvironment</h4>
1327 <b>__createEmbeddedEnvironment</b>(<i></i>)
1328
1329 <p>
1330 Private method to create the embedded virtual environment.
1274 </p> 1331 </p>
1275 <a NAME="Project.__createSBOMFile" ID="Project.__createSBOMFile"></a> 1332 <a NAME="Project.__createSBOMFile" ID="Project.__createSBOMFile"></a>
1276 <h4>Project.__createSBOMFile</h4> 1333 <h4>Project.__createSBOMFile</h4>
1277 <b>__createSBOMFile</b>(<i></i>) 1334 <b>__createSBOMFile</b>(<i></i>)
1278 1335
1380 <dd> 1437 <dd>
1381 flag indicating an interactive invocation (i.e. 1438 flag indicating an interactive invocation (i.e.
1382 through a menu action) 1439 through a menu action)
1383 </dd> 1440 </dd>
1384 </dl> 1441 </dl>
1442 <a NAME="Project.__findEmbeddedEnvironment" ID="Project.__findEmbeddedEnvironment"></a>
1443 <h4>Project.__findEmbeddedEnvironment</h4>
1444 <b>__findEmbeddedEnvironment</b>(<i></i>)
1445
1446 <p>
1447 Private method to find the path of the embedded virtual environment.
1448 </p>
1449 <dl>
1450 <dt>Return:</dt>
1451 <dd>
1452 path of the embedded virtual environment (empty if not found)
1453 </dd>
1454 </dl>
1455 <dl>
1456 <dt>Return Type:</dt>
1457 <dd>
1458 str
1459 </dd>
1460 </dl>
1385 <a NAME="Project.__initData" ID="Project.__initData"></a> 1461 <a NAME="Project.__initData" ID="Project.__initData"></a>
1386 <h4>Project.__initData</h4> 1462 <h4>Project.__initData</h4>
1387 <b>__initData</b>(<i></i>) 1463 <b>__initData</b>(<i></i>)
1388 1464
1389 <p> 1465 <p>
1401 <b>__initProjectTypes</b>(<i></i>) 1477 <b>__initProjectTypes</b>(<i></i>)
1402 1478
1403 <p> 1479 <p>
1404 Private method to initialize the list of supported project types. 1480 Private method to initialize the list of supported project types.
1405 </p> 1481 </p>
1482 <a NAME="Project.__initVenvConfiguration" ID="Project.__initVenvConfiguration"></a>
1483 <h4>Project.__initVenvConfiguration</h4>
1484 <b>__initVenvConfiguration</b>(<i></i>)
1485
1486 <p>
1487 Private method to initialize the environment configuration.
1488 </p>
1489 <a NAME="Project.__installProjectIntoEnvironment" ID="Project.__installProjectIntoEnvironment"></a>
1490 <h4>Project.__installProjectIntoEnvironment</h4>
1491 <b>__installProjectIntoEnvironment</b>(<i></i>)
1492
1493 <p>
1494 Private method to install the project into the embedded environment in
1495 development mode.
1496 </p>
1406 <a NAME="Project.__isInPdata" ID="Project.__isInPdata"></a> 1497 <a NAME="Project.__isInPdata" ID="Project.__isInPdata"></a>
1407 <h4>Project.__isInPdata</h4> 1498 <h4>Project.__isInPdata</h4>
1408 <b>__isInPdata</b>(<i>fn</i>) 1499 <b>__isInPdata</b>(<i>fn</i>)
1409 1500
1410 <p> 1501 <p>
1434 <h4>Project.__loadDiagram</h4> 1525 <h4>Project.__loadDiagram</h4>
1435 <b>__loadDiagram</b>(<i></i>) 1526 <b>__loadDiagram</b>(<i></i>)
1436 1527
1437 <p> 1528 <p>
1438 Private slot to load a diagram from file. 1529 Private slot to load a diagram from file.
1530 </p>
1531 <a NAME="Project.__loadEnvironmentConfiguration" ID="Project.__loadEnvironmentConfiguration"></a>
1532 <h4>Project.__loadEnvironmentConfiguration</h4>
1533 <b>__loadEnvironmentConfiguration</b>(<i></i>)
1534
1535 <p>
1536 Private method to load the embedded environment configuration.
1439 </p> 1537 </p>
1440 <a NAME="Project.__loadRecent" ID="Project.__loadRecent"></a> 1538 <a NAME="Project.__loadRecent" ID="Project.__loadRecent"></a>
1441 <h4>Project.__loadRecent</h4> 1539 <h4>Project.__loadRecent</h4>
1442 <b>__loadRecent</b>(<i></i>) 1540 <b>__loadRecent</b>(<i></i>)
1443 1541
1674 <b>__reorganizeFiles</b>(<i></i>) 1772 <b>__reorganizeFiles</b>(<i></i>)
1675 1773
1676 <p> 1774 <p>
1677 Private method to reorganize files stored in the project. 1775 Private method to reorganize files stored in the project.
1678 </p> 1776 </p>
1777 <a NAME="Project.__saveEnvironmentConfiguration" ID="Project.__saveEnvironmentConfiguration"></a>
1778 <h4>Project.__saveEnvironmentConfiguration</h4>
1779 <b>__saveEnvironmentConfiguration</b>(<i></i>)
1780
1781 <p>
1782 Private method to save the embedded environment configuration.
1783 </p>
1679 <a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a> 1784 <a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a>
1680 <h4>Project.__saveRecent</h4> 1785 <h4>Project.__saveRecent</h4>
1681 <b>__saveRecent</b>(<i></i>) 1786 <b>__saveRecent</b>(<i></i>)
1682 1787
1683 <p> 1788 <p>
1695 <b>__searchProjectFile</b>(<i></i>) 1800 <b>__searchProjectFile</b>(<i></i>)
1696 1801
1697 <p> 1802 <p>
1698 Private slot to show the Find Project File dialog. 1803 Private slot to show the Find Project File dialog.
1699 </p> 1804 </p>
1805 <a NAME="Project.__setEmbeddedEnvironmentProjectConfig" ID="Project.__setEmbeddedEnvironmentProjectConfig"></a>
1806 <h4>Project.__setEmbeddedEnvironmentProjectConfig</h4>
1807 <b>__setEmbeddedEnvironmentProjectConfig</b>(<i>value</i>)
1808
1809 <p>
1810 Private method to set the embedded environment project configuration.
1811 </p>
1812 <dl>
1813
1814 <dt><i>value</i> (bool)</dt>
1815 <dd>
1816 flag indicating an embedded environment
1817 </dd>
1818 </dl>
1700 <a NAME="Project.__showCodeCoverage" ID="Project.__showCodeCoverage"></a> 1819 <a NAME="Project.__showCodeCoverage" ID="Project.__showCodeCoverage"></a>
1701 <h4>Project.__showCodeCoverage</h4> 1820 <h4>Project.__showCodeCoverage</h4>
1702 <b>__showCodeCoverage</b>(<i></i>) 1821 <b>__showCodeCoverage</b>(<i></i>)
1703 1822
1704 <p> 1823 <p>
1730 <h4>Project.__showContextMenuDebugger</h4> 1849 <h4>Project.__showContextMenuDebugger</h4>
1731 <b>__showContextMenuDebugger</b>(<i></i>) 1850 <b>__showContextMenuDebugger</b>(<i></i>)
1732 1851
1733 <p> 1852 <p>
1734 Private slot called before the Debugger menu is shown. 1853 Private slot called before the Debugger menu is shown.
1854 </p>
1855 <a NAME="Project.__showContextMenuEnvironment" ID="Project.__showContextMenuEnvironment"></a>
1856 <h4>Project.__showContextMenuEnvironment</h4>
1857 <b>__showContextMenuEnvironment</b>(<i></i>)
1858
1859 <p>
1860 Private slot called before the 'Embedded Environment' menu is shown.
1735 </p> 1861 </p>
1736 <a NAME="Project.__showContextMenuFormat" ID="Project.__showContextMenuFormat"></a> 1862 <a NAME="Project.__showContextMenuFormat" ID="Project.__showContextMenuFormat"></a>
1737 <h4>Project.__showContextMenuFormat</h4> 1863 <h4>Project.__showContextMenuFormat</h4>
1738 <b>__showContextMenuFormat</b>(<i></i>) 1864 <b>__showContextMenuFormat</b>(<i></i>)
1739 1865

eric ide

mercurial