diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html
--- a/src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.MultiProject.MultiProject</h1>
-
<p>
Module implementing the multi project management functionality.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#MultiProject">MultiProject</a></td>
<td>Class implementing the project management functionality.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="MultiProject" ID="MultiProject"></a>
<h2>MultiProject</h2>
-
<p>
Class implementing the project management functionality.
</p>
+
<h3>Signals</h3>
<dl>
@@ -90,19 +89,17 @@
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#MultiProject.__init__">MultiProject</a></td>
<td>Constructor</td>
@@ -296,19 +293,20 @@
<td>Public method to set the dirty state.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="MultiProject.__init__" ID="MultiProject.__init__"></a>
<h4>MultiProject (Constructor)</h4>
<b>MultiProject</b>(<i>project, parent=None, filename=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>project</i> (Project.Project)</dt>
@@ -327,7 +325,6 @@
<a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a>
<h4>MultiProject.__checkFilesExist</h4>
<b>__checkFilesExist</b>(<i></i>)
-
<p>
Private method to check, if the files in a list exist.
</p>
@@ -336,31 +333,31 @@
filesystem. Non existant projects are removed from the list and the
dirty state of the multi project is changed accordingly.
</p>
+
<a NAME="MultiProject.__extractCategories" ID="MultiProject.__extractCategories"></a>
<h4>MultiProject.__extractCategories</h4>
<b>__extractCategories</b>(<i></i>)
-
<p>
Private slot to extract the categories used in the project definitions.
</p>
+
<a NAME="MultiProject.__initData" ID="MultiProject.__initData"></a>
<h4>MultiProject.__initData</h4>
<b>__initData</b>(<i></i>)
-
<p>
Private method to initialize the multi project data part.
</p>
+
<a NAME="MultiProject.__loadRecent" ID="MultiProject.__loadRecent"></a>
<h4>MultiProject.__loadRecent</h4>
<b>__loadRecent</b>(<i></i>)
-
<p>
Private method to load the recently opened multi project filenames.
</p>
+
<a NAME="MultiProject.__newMultiProject" ID="MultiProject.__newMultiProject"></a>
<h4>MultiProject.__newMultiProject</h4>
<b>__newMultiProject</b>(<i></i>)
-
<p>
Private slot to build a new multi project.
</p>
@@ -368,13 +365,14 @@
This method displays the new multi project dialog and initializes
the multi project object with the data entered.
</p>
+
<a NAME="MultiProject.__openMainProject" ID="MultiProject.__openMainProject"></a>
<h4>MultiProject.__openMainProject</h4>
<b>__openMainProject</b>(<i>reopen=True</i>)
-
<p>
Private slot to open the main project.
</p>
+
<dl>
<dt><i>reopen</i> (bool)</dt>
@@ -386,11 +384,11 @@
<a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a>
<h4>MultiProject.__openRecent</h4>
<b>__openRecent</b>(<i>act</i>)
-
<p>
Private method to open a multi project from the list of rencently
opened multi projects.
</p>
+
<dl>
<dt><i>act</i> (QAction)</dt>
@@ -401,10 +399,10 @@
<a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a>
<h4>MultiProject.__readMultiProject</h4>
<b>__readMultiProject</b>(<i>fn</i>)
-
<p>
Private method to read in a multi project (.emj, .e4m, .e5m) file.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -427,46 +425,46 @@
<a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a>
<h4>MultiProject.__saveRecent</h4>
<b>__saveRecent</b>(<i></i>)
-
<p>
Private method to save the list of recently opened filenames.
</p>
+
<a NAME="MultiProject.__showContextMenuRecent" ID="MultiProject.__showContextMenuRecent"></a>
<h4>MultiProject.__showContextMenuRecent</h4>
<b>__showContextMenuRecent</b>(<i></i>)
-
<p>
Private method to set up the recent multi projects menu.
</p>
+
<a NAME="MultiProject.__showMenu" ID="MultiProject.__showMenu"></a>
<h4>MultiProject.__showMenu</h4>
<b>__showMenu</b>(<i></i>)
-
<p>
Private method to set up the multi project menu.
</p>
+
<a NAME="MultiProject.__showProperties" ID="MultiProject.__showProperties"></a>
<h4>MultiProject.__showProperties</h4>
<b>__showProperties</b>(<i></i>)
-
<p>
Private slot to display the properties dialog.
</p>
+
<a NAME="MultiProject.__syncRecent" ID="MultiProject.__syncRecent"></a>
<h4>MultiProject.__syncRecent</h4>
<b>__syncRecent</b>(<i></i>)
-
<p>
Private method to synchronize the list of recently opened multi
projects with the central store.
</p>
+
<a NAME="MultiProject.__writeMultiProject" ID="MultiProject.__writeMultiProject"></a>
<h4>MultiProject.__writeMultiProject</h4>
<b>__writeMultiProject</b>(<i>fn=None</i>)
-
<p>
Private method to save the multi project infos to a multi project file.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -493,10 +491,10 @@
<a NAME="MultiProject.addEricActions" ID="MultiProject.addEricActions"></a>
<h4>MultiProject.addEricActions</h4>
<b>addEricActions</b>(<i>actions</i>)
-
<p>
Public method to add actions to the list of actions.
</p>
+
<dl>
<dt><i>actions</i> (list of EricAction)</dt>
@@ -507,10 +505,10 @@
<a NAME="MultiProject.addNewProject" ID="MultiProject.addNewProject"></a>
<h4>MultiProject.addNewProject</h4>
<b>addNewProject</b>(<i>startdir="", category=""</i>)
-
<p>
Public slot used to add a new project to the multi-project.
</p>
+
<dl>
<dt><i>startdir</i> (str)</dt>
@@ -525,10 +523,10 @@
<a NAME="MultiProject.addProject" ID="MultiProject.addProject"></a>
<h4>MultiProject.addProject</h4>
<b>addProject</b>(<i>project</i>)
-
<p>
Public method to add a project to the multi-project.
</p>
+
<dl>
<dt><i>project</i> (MultiProjectProjectMeta)</dt>
@@ -539,10 +537,10 @@
<a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a>
<h4>MultiProject.changeProjectProperties</h4>
<b>changeProjectProperties</b>(<i>pro</i>)
-
<p>
Public method to change the data of a project entry.
</p>
+
<dl>
<dt><i>pro</i> (str)</dt>
@@ -553,10 +551,10 @@
<a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a>
<h4>MultiProject.checkDirty</h4>
<b>checkDirty</b>(<i></i>)
-
<p>
Public method to check the dirty status and open a message window.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -572,24 +570,24 @@
<a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a>
<h4>MultiProject.clearRecent</h4>
<b>clearRecent</b>(<i></i>)
-
<p>
Public method to clear the recent multi projects menu.
</p>
+
<a NAME="MultiProject.clearRemovedProjects" ID="MultiProject.clearRemovedProjects"></a>
<h4>MultiProject.clearRemovedProjects</h4>
<b>clearRemovedProjects</b>(<i></i>)
-
<p>
Public slot to clear out all projects marked as removed.
</p>
+
<a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a>
<h4>MultiProject.closeMultiProject</h4>
<b>closeMultiProject</b>(<i></i>)
-
<p>
Public slot to close the current multi project.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -605,10 +603,10 @@
<a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a>
<h4>MultiProject.copyProject</h4>
<b>copyProject</b>(<i>uid</i>)
-
<p>
Public method to copy the project with given UID on disk.
</p>
+
<dl>
<dt><i>uid</i> (str)</dt>
@@ -619,10 +617,10 @@
<a NAME="MultiProject.deleteProject" ID="MultiProject.deleteProject"></a>
<h4>MultiProject.deleteProject</h4>
<b>deleteProject</b>(<i>uid</i>)
-
<p>
Public slot to delete project(s) from the multi project and disk.
</p>
+
<dl>
<dt><i>uid</i> (str)</dt>
@@ -634,10 +632,10 @@
<a NAME="MultiProject.getActions" ID="MultiProject.getActions"></a>
<h4>MultiProject.getActions</h4>
<b>getActions</b>(<i></i>)
-
<p>
Public method to get a list of all actions.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -653,10 +651,10 @@
<a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a>
<h4>MultiProject.getCategories</h4>
<b>getCategories</b>(<i></i>)
-
<p>
Public method to get the list of defined categories.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -672,10 +670,10 @@
<a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a>
<h4>MultiProject.getDependantProjectFiles</h4>
<b>getDependantProjectFiles</b>(<i></i>)
-
<p>
Public method to get the filenames of the dependent projects.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -691,10 +689,10 @@
<a NAME="MultiProject.getMainProjectFile" ID="MultiProject.getMainProjectFile"></a>
<h4>MultiProject.getMainProjectFile</h4>
<b>getMainProjectFile</b>(<i></i>)
-
<p>
Public method to get the filename of the main project.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -710,10 +708,10 @@
<a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a>
<h4>MultiProject.getMenu</h4>
<b>getMenu</b>(<i>menuName</i>)
-
<p>
Public method to get a reference to the main menu or a submenu.
</p>
+
<dl>
<dt><i>menuName</i> (str)</dt>
@@ -736,10 +734,10 @@
<a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a>
<h4>MultiProject.getMostRecent</h4>
<b>getMostRecent</b>(<i></i>)
-
<p>
Public method to get the most recently opened multiproject.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -755,10 +753,10 @@
<a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a>
<h4>MultiProject.getMultiProjectFile</h4>
<b>getMultiProjectFile</b>(<i></i>)
-
<p>
Public method to get the path of the multi project file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -774,10 +772,10 @@
<a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a>
<h4>MultiProject.getMultiProjectPath</h4>
<b>getMultiProjectPath</b>(<i></i>)
-
<p>
Public method to get the multi project path.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -793,10 +791,10 @@
<a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a>
<h4>MultiProject.getProject</h4>
<b>getProject</b>(<i>uid</i>)
-
<p>
Public method to get a reference to a project entry.
</p>
+
<dl>
<dt><i>uid</i> (str)</dt>
@@ -819,10 +817,10 @@
<a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a>
<h4>MultiProject.getProjects</h4>
<b>getProjects</b>(<i></i>)
-
<p>
Public method to get all project entries.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -838,10 +836,10 @@
<a NAME="MultiProject.hasRemovedProjects" ID="MultiProject.hasRemovedProjects"></a>
<h4>MultiProject.hasRemovedProjects</h4>
<b>hasRemovedProjects</b>(<i></i>)
-
<p>
Public method to check for removed projects.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -857,17 +855,17 @@
<a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a>
<h4>MultiProject.initActions</h4>
<b>initActions</b>(<i></i>)
-
<p>
Public slot to initialize the multi project related actions.
</p>
+
<a NAME="MultiProject.initMenu" ID="MultiProject.initMenu"></a>
<h4>MultiProject.initMenu</h4>
<b>initMenu</b>(<i></i>)
-
<p>
Public slot to initialize the multi project menu.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -883,10 +881,10 @@
<a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a>
<h4>MultiProject.initToolbar</h4>
<b>initToolbar</b>(<i>toolbarManager</i>)
-
<p>
Public slot to initialize the multi project toolbar.
</p>
+
<dl>
<dt><i>toolbarManager</i> (EricToolBarManager)</dt>
@@ -909,10 +907,10 @@
<a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a>
<h4>MultiProject.isDirty</h4>
<b>isDirty</b>(<i></i>)
-
<p>
Public method to return the dirty state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -928,10 +926,10 @@
<a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a>
<h4>MultiProject.isOpen</h4>
<b>isOpen</b>(<i></i>)
-
<p>
Public method to return the opened state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -947,10 +945,10 @@
<a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a>
<h4>MultiProject.openMultiProject</h4>
<b>openMultiProject</b>(<i>fn=None, openMain=True</i>)
-
<p>
Public slot to open a multi project.
</p>
+
<dl>
<dt><i>fn</i> (str)</dt>
@@ -967,10 +965,10 @@
<a NAME="MultiProject.openProject" ID="MultiProject.openProject"></a>
<h4>MultiProject.openProject</h4>
<b>openProject</b>(<i>filename</i>)
-
<p>
Public slot to open a project.
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -981,10 +979,10 @@
<a NAME="MultiProject.removeEricActions" ID="MultiProject.removeEricActions"></a>
<h4>MultiProject.removeEricActions</h4>
<b>removeEricActions</b>(<i>actions</i>)
-
<p>
Public method to remove actions from the list of actions.
</p>
+
<dl>
<dt><i>actions</i> (list of EricAction)</dt>
@@ -995,10 +993,10 @@
<a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a>
<h4>MultiProject.removeProject</h4>
<b>removeProject</b>(<i>uid</i>)
-
<p>
Public slot to remove a project from the multi project.
</p>
+
<dl>
<dt><i>uid</i> (str)</dt>
@@ -1010,10 +1008,10 @@
<a NAME="MultiProject.saveMultiProject" ID="MultiProject.saveMultiProject"></a>
<h4>MultiProject.saveMultiProject</h4>
<b>saveMultiProject</b>(<i></i>)
-
<p>
Public slot to save the current multi project.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1029,10 +1027,10 @@
<a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a>
<h4>MultiProject.saveMultiProjectAs</h4>
<b>saveMultiProjectAs</b>(<i></i>)
-
<p>
Public slot to save the current multi project to a different file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1048,13 +1046,13 @@
<a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a>
<h4>MultiProject.setDirty</h4>
<b>setDirty</b>(<i>b</i>)
-
<p>
Public method to set the dirty state.
</p>
<p>
It emits the signal dirty(int).
</p>
+
<dl>
<dt><i>b</i> (bool)</dt>
@@ -1064,4 +1062,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
