Documentation/Source/eric5.Project.Project.html

changeset 153
ef200d69dba0
parent 123
5f8c8cd86111
child 155
375e3c884874
equal deleted inserted replaced
152:ee3a13a0ad59 153:ef200d69dba0
407 <td>Public method to retrieve a lexer association.</td> 407 <td>Public method to retrieve a lexer association.</td>
408 </tr><tr> 408 </tr><tr>
409 <td><a href="#Project.getFiles">getFiles</a></td> 409 <td><a href="#Project.getFiles">getFiles</a></td>
410 <td>Public method to get all files starting with a common prefix.</td> 410 <td>Public method to get all files starting with a common prefix.</td>
411 </tr><tr> 411 </tr><tr>
412 <td><a href="#Project.getHash">getHash</a></td>
413 <td>Public method to get the project hash.</td>
414 </tr><tr>
412 <td><a href="#Project.getMainScript">getMainScript</a></td> 415 <td><a href="#Project.getMainScript">getMainScript</a></td>
413 <td>Public method to return the main script filename.</td> 416 <td>Public method to return the main script filename.</td>
414 </tr><tr> 417 </tr><tr>
415 <td><a href="#Project.getMenu">getMenu</a></td> 418 <td><a href="#Project.getMenu">getMenu</a></td>
416 <td>Public method to get a reference to the main menu or a submenu.</td> 419 <td>Public method to get a reference to the main menu or a submenu.</td>
442 <td><a href="#Project.getProjectType">getProjectType</a></td> 445 <td><a href="#Project.getProjectType">getProjectType</a></td>
443 <td>Public method to get the type of the project.</td> 446 <td>Public method to get the type of the project.</td>
444 </tr><tr> 447 </tr><tr>
445 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td> 448 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td>
446 <td>Public method to get the list of supported project types.</td> 449 <td>Public method to get the list of supported project types.</td>
450 </tr><tr>
451 <td><a href="#Project.getRelativePath">getRelativePath</a></td>
452 <td>Public method to convert a file path to a project relative file path.</td>
453 </tr><tr>
454 <td><a href="#Project.getRelativeUniversalPath">getRelativeUniversalPath</a></td>
455 <td>Public method to convert a file path to a project relative file path with universal separators.</td>
447 </tr><tr> 456 </tr><tr>
448 <td><a href="#Project.getSources">getSources</a></td> 457 <td><a href="#Project.getSources">getSources</a></td>
449 <td>Public method to return the source script files.</td> 458 <td>Public method to return the source script files.</td>
450 </tr><tr> 459 </tr><tr>
451 <td><a href="#Project.getStatusMonitorAutoUpdate">getStatusMonitorAutoUpdate</a></td> 460 <td><a href="#Project.getStatusMonitorAutoUpdate">getStatusMonitorAutoUpdate</a></td>
1432 </p><dl> 1441 </p><dl>
1433 <dt><i>start</i></dt> 1442 <dt><i>start</i></dt>
1434 <dd> 1443 <dd>
1435 prefix (string) 1444 prefix (string)
1436 </dd> 1445 </dd>
1446 </dl><a NAME="Project.getHash" ID="Project.getHash"></a>
1447 <h4>Project.getHash</h4>
1448 <b>getHash</b>(<i></i>)
1449 <p>
1450 Public method to get the project hash.
1451 </p><dl>
1452 <dt>Returns:</dt>
1453 <dd>
1454 project hash as a hex string (string)
1455 </dd>
1437 </dl><a NAME="Project.getMainScript" ID="Project.getMainScript"></a> 1456 </dl><a NAME="Project.getMainScript" ID="Project.getMainScript"></a>
1438 <h4>Project.getMainScript</h4> 1457 <h4>Project.getMainScript</h4>
1439 <b>getMainScript</b>(<i>normalized = False</i>) 1458 <b>getMainScript</b>(<i>normalized = False</i>)
1440 <p> 1459 <p>
1441 Public method to return the main script filename. 1460 Public method to return the main script filename.
1562 Public method to get the list of supported project types. 1581 Public method to get the list of supported project types.
1563 </p><dl> 1582 </p><dl>
1564 <dt>Returns:</dt> 1583 <dt>Returns:</dt>
1565 <dd> 1584 <dd>
1566 reference to the dictionary of project types. 1585 reference to the dictionary of project types.
1586 </dd>
1587 </dl><a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a>
1588 <h4>Project.getRelativePath</h4>
1589 <b>getRelativePath</b>(<i>fn</i>)
1590 <p>
1591 Public method to convert a file path to a project relative
1592 file path.
1593 </p><dl>
1594 <dt><i>fn</i></dt>
1595 <dd>
1596 file or directory name to convert (string)
1597 </dd>
1598 </dl><dl>
1599 <dt>Returns:</dt>
1600 <dd>
1601 project relative path or unchanged path, if fn doesn't
1602 belong to the project (string)
1603 </dd>
1604 </dl><a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a>
1605 <h4>Project.getRelativeUniversalPath</h4>
1606 <b>getRelativeUniversalPath</b>(<i>fn</i>)
1607 <p>
1608 Public method to convert a file path to a project relative
1609 file path with universal separators.
1610 </p><dl>
1611 <dt><i>fn</i></dt>
1612 <dd>
1613 file or directory name to convert (string)
1614 </dd>
1615 </dl><dl>
1616 <dt>Returns:</dt>
1617 <dd>
1618 project relative path or unchanged path, if fn doesn't
1619 belong to the project (string)
1567 </dd> 1620 </dd>
1568 </dl><a NAME="Project.getSources" ID="Project.getSources"></a> 1621 </dl><a NAME="Project.getSources" ID="Project.getSources"></a>
1569 <h4>Project.getSources</h4> 1622 <h4>Project.getSources</h4>
1570 <b>getSources</b>(<i>normalized = False</i>) 1623 <b>getSources</b>(<i>normalized = False</i>)
1571 <p> 1624 <p>

eric ide

mercurial