--- a/src/eric7/Documentation/Source/eric7.Project.Project.html Fri Jun 14 11:18:10 2024 +0200
+++ b/src/eric7/Documentation/Source/eric7.Project.Project.html Fri Jun 14 11:23:45 2024 +0200
@@ -346,6 +346,10 @@
<td>Private method to open a project from the list of rencently opened projects.</td>
</tr>
<tr>
+<td><a href="#Project.__openRemoteProject">__openRemoteProject</a></td>
+<td>Private slot to open a project of an 'eric-ide' server.</td>
+</tr>
+<tr>
<td><a href="#Project.__performFormatWithBlack">__performFormatWithBlack</a></td>
<td>Private method to format the project sources using the 'Black' tool.</td>
</tr>
@@ -375,7 +379,7 @@
</tr>
<tr>
<td><a href="#Project.__readProject">__readProject</a></td>
-<td>Private method to read in a project (.epj) file.</td>
+<td>Private method to read in a project file (.epj).</td>
</tr>
<tr>
<td><a href="#Project.__readSession">__readSession</a></td>
@@ -402,6 +406,10 @@
<td>Private method to save the list of recently opened filenames.</td>
</tr>
<tr>
+<td><a href="#Project.__saveRemoteProjectAs">__saveRemoteProjectAs</a></td>
+<td>Private slot to save the current remote project to different remote file.</td>
+</tr>
+<tr>
<td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td>
<td>Private slot used to handle the search new files action.</td>
</tr>
@@ -966,6 +974,10 @@
<td>Public method to register a project type.</td>
</tr>
<tr>
+<td><a href="#Project.remoteConnectionChanged">remoteConnectionChanged</a></td>
+<td>Public slot to handle a change of the 'eric-ide' server connection state.</td>
+</tr>
+<tr>
<td><a href="#Project.removeDirectory">removeDirectory</a></td>
<td>Public method to remove a directory from the project.</td>
</tr>
@@ -1099,7 +1111,7 @@
<a NAME="Project.__init__" ID="Project.__init__"></a>
<h4>Project (Constructor)</h4>
-<b>Project</b>(<i>parent=None, filename=None</i>)
+<b>Project</b>(<i>parent=None, filename=None, remoteServer=None</i>)
<p>
Constructor
</p>
@@ -1110,9 +1122,13 @@
<dd>
parent widget (usually the ui object)
</dd>
-<dt><i>filename</i> (str)</dt>
-<dd>
-optional filename of a project file to open
+<dt><i>filename</i> (str (optional))</dt>
+<dd>
+optional filename of a project file to open (defaults to None)
+</dd>
+<dt><i>remoteServer</i> (EricServerInterface)</dt>
+<dd>
+reference to the 'eric-ide' server interface object
</dd>
</dl>
<a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a>
@@ -1597,6 +1613,13 @@
reference to the action that triggered
</dd>
</dl>
+<a NAME="Project.__openRemoteProject" ID="Project.__openRemoteProject"></a>
+<h4>Project.__openRemoteProject</h4>
+<b>__openRemoteProject</b>(<i></i>)
+<p>
+ Private slot to open a project of an 'eric-ide' server.
+</p>
+
<a NAME="Project.__performFormatWithBlack" ID="Project.__performFormatWithBlack"></a>
<h4>Project.__performFormatWithBlack</h4>
<b>__performFormatWithBlack</b>(<i>action</i>)
@@ -1719,7 +1742,7 @@
<h4>Project.__readProject</h4>
<b>__readProject</b>(<i>fn</i>)
<p>
- Private method to read in a project (.epj) file.
+ Private method to read in a project file (.epj).
</p>
<dl>
@@ -1795,6 +1818,13 @@
Private method to save the list of recently opened filenames.
</p>
+<a NAME="Project.__saveRemoteProjectAs" ID="Project.__saveRemoteProjectAs"></a>
+<h4>Project.__saveRemoteProjectAs</h4>
+<b>__saveRemoteProjectAs</b>(<i></i>)
+<p>
+ Private slot to save the current remote project to different remote file.
+</p>
+
<a NAME="Project.__searchNewFiles" ID="Project.__searchNewFiles"></a>
<h4>Project.__searchNewFiles</h4>
<b>__searchNewFiles</b>(<i></i>)
@@ -3593,7 +3623,7 @@
</dl>
<a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a>
<h4>Project.getRelativePath</h4>
-<b>getRelativePath</b>(<i>path</i>)
+<b>getRelativePath</b>(<i>fullpath</i>)
<p>
Public method to convert a file path to a project relative
file path.
@@ -3601,7 +3631,7 @@
<dl>
-<dt><i>path</i> (str)</dt>
+<dt><i>fullpath</i> (str)</dt>
<dd>
file or directory name to convert
</dd>
@@ -3621,7 +3651,7 @@
</dl>
<a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a>
<h4>Project.getRelativeUniversalPath</h4>
-<b>getRelativeUniversalPath</b>(<i>path</i>)
+<b>getRelativeUniversalPath</b>(<i>fullpath</i>)
<p>
Public method to convert a file path to a project relative
file path with universal separators.
@@ -3629,7 +3659,7 @@
<dl>
-<dt><i>path</i> (str)</dt>
+<dt><i>fullpath</i> (str)</dt>
<dd>
file or directory name to convert
</dd>
@@ -4304,7 +4334,7 @@
</dl>
<a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a>
<h4>Project.newProjectAddFiles</h4>
-<b>newProjectAddFiles</b>(<i>mainscript</i>)
+<b>newProjectAddFiles</b>(<i>mainscript, isRemote=False</i>)
<p>
Public method to add files to a new project.
</p>
@@ -4315,6 +4345,10 @@
<dd>
name of the mainscript
</dd>
+<dt><i>isRemote</i> (bool (optional))</dt>
+<dd>
+flag indicating a remote project (defaults to False)
+</dd>
</dl>
<a NAME="Project.openProject" ID="Project.openProject"></a>
<h4>Project.openProject</h4>
@@ -4398,6 +4432,20 @@
project type
</dd>
</dl>
+<a NAME="Project.remoteConnectionChanged" ID="Project.remoteConnectionChanged"></a>
+<h4>Project.remoteConnectionChanged</h4>
+<b>remoteConnectionChanged</b>(<i>connected</i>)
+<p>
+ Public slot to handle a change of the 'eric-ide' server connection state.
+</p>
+
+<dl>
+
+<dt><i>connected</i> (bool)</dt>
+<dd>
+flag indicating the connection state
+</dd>
+</dl>
<a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a>
<h4>Project.removeDirectory</h4>
<b>removeDirectory</b>(<i>dn</i>)
@@ -4857,14 +4905,14 @@
<a NAME="Project.startswithProjectPath" ID="Project.startswithProjectPath"></a>
<h4>Project.startswithProjectPath</h4>
-<b>startswithProjectPath</b>(<i>path</i>)
+<b>startswithProjectPath</b>(<i>checkpath</i>)
<p>
Public method to check, if a path starts with the project path.
</p>
<dl>
-<dt><i>path</i> (str)</dt>
+<dt><i>checkpath</i> (str)</dt>
<dd>
path to be checked
</dd>
