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 10784
521fd465b048
parent 10692
9becf9ca115c
child 10951
8a7e3a26fe36
equal deleted inserted replaced
10783:ccf28bec1227 10784:521fd465b048
344 <tr> 344 <tr>
345 <td><a href="#Project.__openRecent">__openRecent</a></td> 345 <td><a href="#Project.__openRecent">__openRecent</a></td>
346 <td>Private method to open a project from the list of rencently opened projects.</td> 346 <td>Private method to open a project from the list of rencently opened projects.</td>
347 </tr> 347 </tr>
348 <tr> 348 <tr>
349 <td><a href="#Project.__openRemoteProject">__openRemoteProject</a></td>
350 <td>Private slot to open a project of an 'eric-ide' server.</td>
351 </tr>
352 <tr>
349 <td><a href="#Project.__performFormatWithBlack">__performFormatWithBlack</a></td> 353 <td><a href="#Project.__performFormatWithBlack">__performFormatWithBlack</a></td>
350 <td>Private method to format the project sources using the 'Black' tool.</td> 354 <td>Private method to format the project sources using the 'Black' tool.</td>
351 </tr> 355 </tr>
352 <tr> 356 <tr>
353 <td><a href="#Project.__performImportSortingWithIsort">__performImportSortingWithIsort</a></td> 357 <td><a href="#Project.__performImportSortingWithIsort">__performImportSortingWithIsort</a></td>
373 <td><a href="#Project.__readDebugProperties">__readDebugProperties</a></td> 377 <td><a href="#Project.__readDebugProperties">__readDebugProperties</a></td>
374 <td>Private method to read in the project debugger properties file (.edj).</td> 378 <td>Private method to read in the project debugger properties file (.edj).</td>
375 </tr> 379 </tr>
376 <tr> 380 <tr>
377 <td><a href="#Project.__readProject">__readProject</a></td> 381 <td><a href="#Project.__readProject">__readProject</a></td>
378 <td>Private method to read in a project (.epj) file.</td> 382 <td>Private method to read in a project file (.epj).</td>
379 </tr> 383 </tr>
380 <tr> 384 <tr>
381 <td><a href="#Project.__readSession">__readSession</a></td> 385 <td><a href="#Project.__readSession">__readSession</a></td>
382 <td>Private method to read in the project session file (.esj).</td> 386 <td>Private method to read in the project session file (.esj).</td>
383 </tr> 387 </tr>
400 <tr> 404 <tr>
401 <td><a href="#Project.__saveRecent">__saveRecent</a></td> 405 <td><a href="#Project.__saveRecent">__saveRecent</a></td>
402 <td>Private method to save the list of recently opened filenames.</td> 406 <td>Private method to save the list of recently opened filenames.</td>
403 </tr> 407 </tr>
404 <tr> 408 <tr>
409 <td><a href="#Project.__saveRemoteProjectAs">__saveRemoteProjectAs</a></td>
410 <td>Private slot to save the current remote project to different remote file.</td>
411 </tr>
412 <tr>
405 <td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td> 413 <td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td>
406 <td>Private slot used to handle the search new files action.</td> 414 <td>Private slot used to handle the search new files action.</td>
407 </tr> 415 </tr>
408 <tr> 416 <tr>
409 <td><a href="#Project.__searchProjectFile">__searchProjectFile</a></td> 417 <td><a href="#Project.__searchProjectFile">__searchProjectFile</a></td>
962 <td>Public slot to be called, if something was added to the OTHERS project data area.</td> 970 <td>Public slot to be called, if something was added to the OTHERS project data area.</td>
963 </tr> 971 </tr>
964 <tr> 972 <tr>
965 <td><a href="#Project.registerProjectType">registerProjectType</a></td> 973 <td><a href="#Project.registerProjectType">registerProjectType</a></td>
966 <td>Public method to register a project type.</td> 974 <td>Public method to register a project type.</td>
975 </tr>
976 <tr>
977 <td><a href="#Project.remoteConnectionChanged">remoteConnectionChanged</a></td>
978 <td>Public slot to handle a change of the 'eric-ide' server connection state.</td>
967 </tr> 979 </tr>
968 <tr> 980 <tr>
969 <td><a href="#Project.removeDirectory">removeDirectory</a></td> 981 <td><a href="#Project.removeDirectory">removeDirectory</a></td>
970 <td>Public method to remove a directory from the project.</td> 982 <td>Public method to remove a directory from the project.</td>
971 </tr> 983 </tr>
1097 </table> 1109 </table>
1098 1110
1099 1111
1100 <a NAME="Project.__init__" ID="Project.__init__"></a> 1112 <a NAME="Project.__init__" ID="Project.__init__"></a>
1101 <h4>Project (Constructor)</h4> 1113 <h4>Project (Constructor)</h4>
1102 <b>Project</b>(<i>parent=None, filename=None</i>) 1114 <b>Project</b>(<i>parent=None, filename=None, remoteServer=None</i>)
1103 <p> 1115 <p>
1104 Constructor 1116 Constructor
1105 </p> 1117 </p>
1106 1118
1107 <dl> 1119 <dl>
1108 1120
1109 <dt><i>parent</i> (QWidget)</dt> 1121 <dt><i>parent</i> (QWidget)</dt>
1110 <dd> 1122 <dd>
1111 parent widget (usually the ui object) 1123 parent widget (usually the ui object)
1112 </dd> 1124 </dd>
1113 <dt><i>filename</i> (str)</dt> 1125 <dt><i>filename</i> (str (optional))</dt>
1114 <dd> 1126 <dd>
1115 optional filename of a project file to open 1127 optional filename of a project file to open (defaults to None)
1128 </dd>
1129 <dt><i>remoteServer</i> (EricServerInterface)</dt>
1130 <dd>
1131 reference to the 'eric-ide' server interface object
1116 </dd> 1132 </dd>
1117 </dl> 1133 </dl>
1118 <a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a> 1134 <a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a>
1119 <h4>Project.__addRecursiveDirectory</h4> 1135 <h4>Project.__addRecursiveDirectory</h4>
1120 <b>__addRecursiveDirectory</b>(<i>filetype, source, target</i>) 1136 <b>__addRecursiveDirectory</b>(<i>filetype, source, target</i>)
1595 <dt><i>act</i> (QAction)</dt> 1611 <dt><i>act</i> (QAction)</dt>
1596 <dd> 1612 <dd>
1597 reference to the action that triggered 1613 reference to the action that triggered
1598 </dd> 1614 </dd>
1599 </dl> 1615 </dl>
1616 <a NAME="Project.__openRemoteProject" ID="Project.__openRemoteProject"></a>
1617 <h4>Project.__openRemoteProject</h4>
1618 <b>__openRemoteProject</b>(<i></i>)
1619 <p>
1620 Private slot to open a project of an 'eric-ide' server.
1621 </p>
1622
1600 <a NAME="Project.__performFormatWithBlack" ID="Project.__performFormatWithBlack"></a> 1623 <a NAME="Project.__performFormatWithBlack" ID="Project.__performFormatWithBlack"></a>
1601 <h4>Project.__performFormatWithBlack</h4> 1624 <h4>Project.__performFormatWithBlack</h4>
1602 <b>__performFormatWithBlack</b>(<i>action</i>) 1625 <b>__performFormatWithBlack</b>(<i>action</i>)
1603 <p> 1626 <p>
1604 Private method to format the project sources using the 'Black' tool. 1627 Private method to format the project sources using the 'Black' tool.
1717 </dl> 1740 </dl>
1718 <a NAME="Project.__readProject" ID="Project.__readProject"></a> 1741 <a NAME="Project.__readProject" ID="Project.__readProject"></a>
1719 <h4>Project.__readProject</h4> 1742 <h4>Project.__readProject</h4>
1720 <b>__readProject</b>(<i>fn</i>) 1743 <b>__readProject</b>(<i>fn</i>)
1721 <p> 1744 <p>
1722 Private method to read in a project (.epj) file. 1745 Private method to read in a project file (.epj).
1723 </p> 1746 </p>
1724 1747
1725 <dl> 1748 <dl>
1726 1749
1727 <dt><i>fn</i> (str)</dt> 1750 <dt><i>fn</i> (str)</dt>
1791 <a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a> 1814 <a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a>
1792 <h4>Project.__saveRecent</h4> 1815 <h4>Project.__saveRecent</h4>
1793 <b>__saveRecent</b>(<i></i>) 1816 <b>__saveRecent</b>(<i></i>)
1794 <p> 1817 <p>
1795 Private method to save the list of recently opened filenames. 1818 Private method to save the list of recently opened filenames.
1819 </p>
1820
1821 <a NAME="Project.__saveRemoteProjectAs" ID="Project.__saveRemoteProjectAs"></a>
1822 <h4>Project.__saveRemoteProjectAs</h4>
1823 <b>__saveRemoteProjectAs</b>(<i></i>)
1824 <p>
1825 Private slot to save the current remote project to different remote file.
1796 </p> 1826 </p>
1797 1827
1798 <a NAME="Project.__searchNewFiles" ID="Project.__searchNewFiles"></a> 1828 <a NAME="Project.__searchNewFiles" ID="Project.__searchNewFiles"></a>
1799 <h4>Project.__searchNewFiles</h4> 1829 <h4>Project.__searchNewFiles</h4>
1800 <b>__searchNewFiles</b>(<i></i>) 1830 <b>__searchNewFiles</b>(<i></i>)
3591 str 3621 str
3592 </dd> 3622 </dd>
3593 </dl> 3623 </dl>
3594 <a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a> 3624 <a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a>
3595 <h4>Project.getRelativePath</h4> 3625 <h4>Project.getRelativePath</h4>
3596 <b>getRelativePath</b>(<i>path</i>) 3626 <b>getRelativePath</b>(<i>fullpath</i>)
3597 <p> 3627 <p>
3598 Public method to convert a file path to a project relative 3628 Public method to convert a file path to a project relative
3599 file path. 3629 file path.
3600 </p> 3630 </p>
3601 3631
3602 <dl> 3632 <dl>
3603 3633
3604 <dt><i>path</i> (str)</dt> 3634 <dt><i>fullpath</i> (str)</dt>
3605 <dd> 3635 <dd>
3606 file or directory name to convert 3636 file or directory name to convert
3607 </dd> 3637 </dd>
3608 </dl> 3638 </dl>
3609 <dl> 3639 <dl>
3619 str 3649 str
3620 </dd> 3650 </dd>
3621 </dl> 3651 </dl>
3622 <a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a> 3652 <a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a>
3623 <h4>Project.getRelativeUniversalPath</h4> 3653 <h4>Project.getRelativeUniversalPath</h4>
3624 <b>getRelativeUniversalPath</b>(<i>path</i>) 3654 <b>getRelativeUniversalPath</b>(<i>fullpath</i>)
3625 <p> 3655 <p>
3626 Public method to convert a file path to a project relative 3656 Public method to convert a file path to a project relative
3627 file path with universal separators. 3657 file path with universal separators.
3628 </p> 3658 </p>
3629 3659
3630 <dl> 3660 <dl>
3631 3661
3632 <dt><i>path</i> (str)</dt> 3662 <dt><i>fullpath</i> (str)</dt>
3633 <dd> 3663 <dd>
3634 file or directory name to convert 3664 file or directory name to convert
3635 </dd> 3665 </dd>
3636 </dl> 3666 </dl>
3637 <dl> 3667 <dl>
4302 new directory name 4332 new directory name
4303 </dd> 4333 </dd>
4304 </dl> 4334 </dl>
4305 <a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a> 4335 <a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a>
4306 <h4>Project.newProjectAddFiles</h4> 4336 <h4>Project.newProjectAddFiles</h4>
4307 <b>newProjectAddFiles</b>(<i>mainscript</i>) 4337 <b>newProjectAddFiles</b>(<i>mainscript, isRemote=False</i>)
4308 <p> 4338 <p>
4309 Public method to add files to a new project. 4339 Public method to add files to a new project.
4310 </p> 4340 </p>
4311 4341
4312 <dl> 4342 <dl>
4313 4343
4314 <dt><i>mainscript</i> (str)</dt> 4344 <dt><i>mainscript</i> (str)</dt>
4315 <dd> 4345 <dd>
4316 name of the mainscript 4346 name of the mainscript
4347 </dd>
4348 <dt><i>isRemote</i> (bool (optional))</dt>
4349 <dd>
4350 flag indicating a remote project (defaults to False)
4317 </dd> 4351 </dd>
4318 </dl> 4352 </dl>
4319 <a NAME="Project.openProject" ID="Project.openProject"></a> 4353 <a NAME="Project.openProject" ID="Project.openProject"></a>
4320 <h4>Project.openProject</h4> 4354 <h4>Project.openProject</h4>
4321 <b>openProject</b>(<i>fn=None, restoreSession=True, reopen=False</i>) 4355 <b>openProject</b>(<i>fn=None, restoreSession=True, reopen=False</i>)
4396 <dd> 4430 <dd>
4397 programming languages supported by the 4431 programming languages supported by the
4398 project type 4432 project type
4399 </dd> 4433 </dd>
4400 </dl> 4434 </dl>
4435 <a NAME="Project.remoteConnectionChanged" ID="Project.remoteConnectionChanged"></a>
4436 <h4>Project.remoteConnectionChanged</h4>
4437 <b>remoteConnectionChanged</b>(<i>connected</i>)
4438 <p>
4439 Public slot to handle a change of the 'eric-ide' server connection state.
4440 </p>
4441
4442 <dl>
4443
4444 <dt><i>connected</i> (bool)</dt>
4445 <dd>
4446 flag indicating the connection state
4447 </dd>
4448 </dl>
4401 <a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a> 4449 <a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a>
4402 <h4>Project.removeDirectory</h4> 4450 <h4>Project.removeDirectory</h4>
4403 <b>removeDirectory</b>(<i>dn</i>) 4451 <b>removeDirectory</b>(<i>dn</i>)
4404 <p> 4452 <p>
4405 Public method to remove a directory from the project. 4453 Public method to remove a directory from the project.
4855 Public method to start the VCS status monitor thread. 4903 Public method to start the VCS status monitor thread.
4856 </p> 4904 </p>
4857 4905
4858 <a NAME="Project.startswithProjectPath" ID="Project.startswithProjectPath"></a> 4906 <a NAME="Project.startswithProjectPath" ID="Project.startswithProjectPath"></a>
4859 <h4>Project.startswithProjectPath</h4> 4907 <h4>Project.startswithProjectPath</h4>
4860 <b>startswithProjectPath</b>(<i>path</i>) 4908 <b>startswithProjectPath</b>(<i>checkpath</i>)
4861 <p> 4909 <p>
4862 Public method to check, if a path starts with the project path. 4910 Public method to check, if a path starts with the project path.
4863 </p> 4911 </p>
4864 4912
4865 <dl> 4913 <dl>
4866 4914
4867 <dt><i>path</i> (str)</dt> 4915 <dt><i>checkpath</i> (str)</dt>
4868 <dd> 4916 <dd>
4869 path to be checked 4917 path to be checked
4870 </dd> 4918 </dd>
4871 </dl> 4919 </dl>
4872 <dl> 4920 <dl>

Mercurial Repository: eric

eric ide

mercurial