Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html

src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html

branch
eric7
changeset 10411
f9dedceca6c9
parent 9971
773ad1f1ed22
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html	Fri Dec 15 15:28:54 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html	Fri Dec 15 15:30:12 2023 +0100
@@ -62,12 +62,12 @@
 <dd>
 emitted after a new multi project was generated
 </dd>
-<dt>projectAdded(project data dict)</dt>
+<dt>projectAdded(project metadata)</dt>
 <dd>
 emitted after a project entry
             has been added
 </dd>
-<dt>projectDataChanged(project data dict)</dt>
+<dt>projectDataChanged(project metadata)</dt>
 <dd>
 emitted after a project entry
             has been changed
@@ -76,7 +76,7 @@
 <dd>
 emitted after the project has been opened
 </dd>
-<dt>projectRemoved(project data dict)</dt>
+<dt>projectRemoved(project metadata)</dt>
 <dd>
 emitted after a project entry
             has been removed
@@ -188,6 +188,10 @@
 <td>Public method to clear the recent multi projects menu.</td>
 </tr>
 <tr>
+<td><a href="#MultiProject.clearRemovedProjects">clearRemovedProjects</a></td>
+<td>Public slot to clear out all projects marked as removed.</td>
+</tr>
+<tr>
 <td><a href="#MultiProject.closeMultiProject">closeMultiProject</a></td>
 <td>Public slot to close the current multi project.</td>
 </tr>
@@ -240,6 +244,10 @@
 <td>Public method to get all project entries.</td>
 </tr>
 <tr>
+<td><a href="#MultiProject.hasRemovedProjects">hasRemovedProjects</a></td>
+<td>Public method to check for removed projects.</td>
+</tr>
+<tr>
 <td><a href="#MultiProject.initActions">initActions</a></td>
 <td>Public slot to initialize the multi project related actions.</td>
 </tr>
@@ -303,18 +311,17 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project.Project)</dt>
 <dd>
-reference to the project object (Project.Project)
+reference to the project object
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget (usually the ui object) (QWidget)
+parent widget (usually the ui object)
 </dd>
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
 optional filename of a multi project file to open
-            (string)
 </dd>
 </dl>
 <a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a>
@@ -370,10 +377,10 @@
 </p>
 <dl>
 
-<dt><i>reopen</i></dt>
+<dt><i>reopen</i> (bool)</dt>
 <dd>
 flag indicating, that the main project should be
-            reopened, if it has been opened already (boolean)
+            reopened, if it has been opened already
 </dd>
 </dl>
 <a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a>
@@ -386,9 +393,9 @@
 </p>
 <dl>
 
-<dt><i>act</i></dt>
+<dt><i>act</i> (QAction)</dt>
 <dd>
-reference to the action that triggered (QAction)
+reference to the action that triggered
 </dd>
 </dl>
 <a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a>
@@ -400,9 +407,9 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename of the multi project file to be read (string)
+filename of the multi project file to be read
 </dd>
 </dl>
 <dl>
@@ -411,6 +418,12 @@
 flag indicating success
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a>
 <h4>MultiProject.__saveRecent</h4>
 <b>__saveRecent</b>(<i></i>)
@@ -456,7 +469,7 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
 optional filename of the multi project file to be written.
             If fn is None, the filename stored in the multi project object
@@ -471,6 +484,12 @@
 flag indicating success
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="MultiProject.addEricActions" ID="MultiProject.addEricActions"></a>
 <h4>MultiProject.addEricActions</h4>
 <b>addEricActions</b>(<i>actions</i>)
@@ -480,9 +499,9 @@
 </p>
 <dl>
 
-<dt><i>actions</i></dt>
+<dt><i>actions</i> (list of EricAction)</dt>
 <dd>
-list of actions (list of EricAction)
+list of actions
 </dd>
 </dl>
 <a NAME="MultiProject.addNewProject" ID="MultiProject.addNewProject"></a>
@@ -512,7 +531,7 @@
 </p>
 <dl>
 
-<dt><i>project</i> (dict)</dt>
+<dt><i>project</i> (MultiProjectProjectMeta)</dt>
 <dd>
 dictionary containing the project data to be added
 </dd>
@@ -526,9 +545,9 @@
 </p>
 <dl>
 
-<dt><i>pro</i></dt>
+<dt><i>pro</i> (str)</dt>
 <dd>
-dictionary with the project data (string)
+dictionary with the project data
 </dd>
 </dl>
 <a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a>
@@ -541,7 +560,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating whether this operation was successful (boolean)
+flag indicating whether this operation was successful
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a>
@@ -551,6 +576,13 @@
 <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>)
@@ -561,7 +593,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a>
@@ -603,7 +641,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of all actions (list of EricAction)
+list of all actions
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of EricAction
 </dd>
 </dl>
 <a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a>
@@ -616,7 +660,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of categories (list of string)
+list of categories
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a>
@@ -629,7 +679,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-names of the dependent project files (list of strings)
+names of the dependent project files
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="MultiProject.getMainProjectFile" ID="MultiProject.getMainProjectFile"></a>
@@ -660,15 +716,21 @@
 </p>
 <dl>
 
-<dt><i>menuName</i></dt>
+<dt><i>menuName</i> (str)</dt>
 <dd>
-name of the menu (string)
+name of the menu
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the requested menu (QMenu) or None
+reference to the requested menu
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu or None
 </dd>
 </dl>
 <a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a>
@@ -681,7 +743,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-path of the most recently opened multiproject (string)
+path of the most recently opened multiproject
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a>
@@ -694,7 +762,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-path of the multi project file (string)
+path of the multi project file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a>
@@ -707,7 +781,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-multi project path (string)
+multi project path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a>
@@ -727,13 +807,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-dictionary containing the project data
+project metadata
 </dd>
 </dl>
 <dl>
 <dt>Return Type:</dt>
 <dd>
-dict
+MultiProjectProjectMeta
 </dd>
 </dl>
 <a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a>
@@ -746,7 +826,32 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of all project entries (list of dictionaries)
+list of all project entries
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of MultiProjectProjectMeta
+</dd>
+</dl>
+<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>
+flag indicating the existence of a removed project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a>
@@ -766,7 +871,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-the menu generated (QMenu)
+the menu generated
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QMenu
 </dd>
 </dl>
 <a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a>
@@ -778,16 +889,21 @@
 </p>
 <dl>
 
-<dt><i>toolbarManager</i></dt>
+<dt><i>toolbarManager</i> (EricToolBarManager)</dt>
 <dd>
 reference to a toolbar manager object
-            (EricToolBarManager)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-the toolbar generated (QToolBar)
+the toolbar generated
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QToolBar
 </dd>
 </dl>
 <a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a>
@@ -800,7 +916,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-dirty state (boolean)
+dirty state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a>
@@ -813,7 +935,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-open state (boolean)
+open state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a>
@@ -845,9 +973,9 @@
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-filename of the project file (string)
+filename of the project file
 </dd>
 </dl>
 <a NAME="MultiProject.removeEricActions" ID="MultiProject.removeEricActions"></a>
@@ -859,9 +987,9 @@
 </p>
 <dl>
 
-<dt><i>actions</i></dt>
+<dt><i>actions</i> (list of EricAction)</dt>
 <dd>
-list of actions (list of EricAction)
+list of actions
 </dd>
 </dl>
 <a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a>
@@ -929,9 +1057,9 @@
 </p>
 <dl>
 
-<dt><i>b</i></dt>
+<dt><i>b</i> (bool)</dt>
 <dd>
-dirty state (boolean)
+dirty state
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial