Regenerated the source code documentation. eric7

Fri, 15 Dec 2023 15:30:12 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 15 Dec 2023 15:30:12 +0100
branch
eric7
changeset 10411
f9dedceca6c9
parent 10410
da82156f44e9
child 10412
883e4bc9bd07

Regenerated the source code documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MultiProject.AddProjectDialog.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MultiProject.MultiProject.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MultiProject.MultiProjectBrowser.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MultiProject.MultiProjectProjectMeta.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.MultiProject.PropertiesDialog.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/index-eric7.MultiProject.html file | annotate | diff | comparison | revisions
--- a/src/eric7/APIs/Python3/eric7.api	Fri Dec 15 15:28:54 2023 +0100
+++ b/src/eric7/APIs/Python3/eric7.api	Fri Dec 15 15:30:12 2023 +0100
@@ -3292,7 +3292,7 @@
 eric7.MicroPython.WifiDialogs.WifiNetworksWindow.WifiNetworksWindow.scanNetworks?4()
 eric7.MicroPython.WifiDialogs.WifiNetworksWindow.WifiNetworksWindow?1(device, parent=None)
 eric7.MicroPython.WifiDialogs.WifiStatusDialog.WifiStatusDialog?1(clientStatus, apStatus, overallStatus, parent=None)
-eric7.MultiProject.AddProjectDialog.AddProjectDialog.getData?4()
+eric7.MultiProject.AddProjectDialog.AddProjectDialog.getProjectMetadata?4()
 eric7.MultiProject.AddProjectDialog.AddProjectDialog.on_filenamePicker_textChanged?4(txt)
 eric7.MultiProject.AddProjectDialog.AddProjectDialog.on_nameEdit_textChanged?4(txt)
 eric7.MultiProject.AddProjectDialog.AddProjectDialog?1(parent=None, startdir="", project=None, categories=None, category="")
@@ -3302,6 +3302,7 @@
 eric7.MultiProject.MultiProject.MultiProject.changeProjectProperties?4(pro)
 eric7.MultiProject.MultiProject.MultiProject.checkDirty?4()
 eric7.MultiProject.MultiProject.MultiProject.clearRecent?4()
+eric7.MultiProject.MultiProject.MultiProject.clearRemovedProjects?4()
 eric7.MultiProject.MultiProject.MultiProject.closeMultiProject?4()
 eric7.MultiProject.MultiProject.MultiProject.copyProject?4(uid)
 eric7.MultiProject.MultiProject.MultiProject.deleteProject?4(uid)
@@ -3316,6 +3317,7 @@
 eric7.MultiProject.MultiProject.MultiProject.getMultiProjectPath?4()
 eric7.MultiProject.MultiProject.MultiProject.getProject?4(uid)
 eric7.MultiProject.MultiProject.MultiProject.getProjects?4()
+eric7.MultiProject.MultiProject.MultiProject.hasRemovedProjects?4()
 eric7.MultiProject.MultiProject.MultiProject.initActions?4()
 eric7.MultiProject.MultiProject.MultiProject.initMenu?4()
 eric7.MultiProject.MultiProject.MultiProject.initToolbar?4(toolbarManager)
@@ -3345,6 +3347,15 @@
 eric7.MultiProject.MultiProjectFile.MultiProjectFile.readFile?4(filename: str)
 eric7.MultiProject.MultiProjectFile.MultiProjectFile.writeFile?4(filename: str)
 eric7.MultiProject.MultiProjectFile.MultiProjectFile?1(multiProject: MultiProject, parent: QObject = None)
+eric7.MultiProject.MultiProjectProjectMeta.MultiProjectProjectMeta.as_dict?4()
+eric7.MultiProject.MultiProjectProjectMeta.MultiProjectProjectMeta.category?7
+eric7.MultiProject.MultiProjectProjectMeta.MultiProjectProjectMeta.description?7
+eric7.MultiProject.MultiProjectProjectMeta.MultiProjectProjectMeta.file?7
+eric7.MultiProject.MultiProjectProjectMeta.MultiProjectProjectMeta.from_dict?4(data)
+eric7.MultiProject.MultiProjectProjectMeta.MultiProjectProjectMeta.master?7
+eric7.MultiProject.MultiProjectProjectMeta.MultiProjectProjectMeta.name?7
+eric7.MultiProject.MultiProjectProjectMeta.MultiProjectProjectMeta.removed?7
+eric7.MultiProject.MultiProjectProjectMeta.MultiProjectProjectMeta.uid?7
 eric7.MultiProject.PropertiesDialog.PropertiesDialog.storeData?4()
 eric7.MultiProject.PropertiesDialog.PropertiesDialog?1(multiProject, new=True, parent=None)
 eric7.Network.IRC.IrcChannelEditDialog.IrcChannelEditDialog.getData?4()
@@ -3771,7 +3782,6 @@
 eric7.PipInterface.PipPackagesWidget.PipPackagesWidget.on_localCheckBox_clicked?4()
 eric7.PipInterface.PipPackagesWidget.PipPackagesWidget.on_localDepCheckBox_clicked?4()
 eric7.PipInterface.PipPackagesWidget.PipPackagesWidget.on_notRequiredCheckBox_clicked?4()
-eric7.PipInterface.PipPackagesWidget.PipPackagesWidget.on_packagesList_currentItemChanged?4(curr, prev)
 eric7.PipInterface.PipPackagesWidget.PipPackagesWidget.on_packagesList_itemActivated?4(item, column)
 eric7.PipInterface.PipPackagesWidget.PipPackagesWidget.on_packagesList_itemSelectionChanged?4()
 eric7.PipInterface.PipPackagesWidget.PipPackagesWidget.on_refreshButton_clicked?4()
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Fri Dec 15 15:28:54 2023 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Fri Dec 15 15:30:12 2023 +0100
@@ -351,6 +351,7 @@
             <section title="eric7.MultiProject.MultiProject" ref="eric7.MultiProject.MultiProject.html" />
             <section title="eric7.MultiProject.MultiProjectBrowser" ref="eric7.MultiProject.MultiProjectBrowser.html" />
             <section title="eric7.MultiProject.MultiProjectFile" ref="eric7.MultiProject.MultiProjectFile.html" />
+            <section title="eric7.MultiProject.MultiProjectProjectMeta" ref="eric7.MultiProject.MultiProjectProjectMeta.html" />
             <section title="eric7.MultiProject.PropertiesDialog" ref="eric7.MultiProject.PropertiesDialog.html" />
           </section>
           <section title="eric7.Network" ref="index-eric7.Network.html">
@@ -1914,8 +1915,9 @@
       <keyword name="AddProjectDialog" id="AddProjectDialog" ref="eric7.MultiProject.AddProjectDialog.html#AddProjectDialog" />
       <keyword name="AddProjectDialog (Constructor)" id="AddProjectDialog (Constructor)" ref="eric7.MultiProject.AddProjectDialog.html#AddProjectDialog.__init__" />
       <keyword name="AddProjectDialog (Module)" id="AddProjectDialog (Module)" ref="eric7.MultiProject.AddProjectDialog.html" />
+      <keyword name="AddProjectDialog.__getFileName" id="AddProjectDialog.__getFileName" ref="eric7.MultiProject.AddProjectDialog.html#AddProjectDialog.__getFileName" />
       <keyword name="AddProjectDialog.__updateUi" id="AddProjectDialog.__updateUi" ref="eric7.MultiProject.AddProjectDialog.html#AddProjectDialog.__updateUi" />
-      <keyword name="AddProjectDialog.getData" id="AddProjectDialog.getData" ref="eric7.MultiProject.AddProjectDialog.html#AddProjectDialog.getData" />
+      <keyword name="AddProjectDialog.getProjectMetadata" id="AddProjectDialog.getProjectMetadata" ref="eric7.MultiProject.AddProjectDialog.html#AddProjectDialog.getProjectMetadata" />
       <keyword name="AddProjectDialog.on_filenamePicker_textChanged" id="AddProjectDialog.on_filenamePicker_textChanged" ref="eric7.MultiProject.AddProjectDialog.html#AddProjectDialog.on_filenamePicker_textChanged" />
       <keyword name="AddProjectDialog.on_nameEdit_textChanged" id="AddProjectDialog.on_nameEdit_textChanged" ref="eric7.MultiProject.AddProjectDialog.html#AddProjectDialog.on_nameEdit_textChanged" />
       <keyword name="AddProjectUrlDialog" id="AddProjectUrlDialog" ref="eric7.Plugins.WizardPlugins.SetupWizard.AddProjectUrlDialog.html#AddProjectUrlDialog" />
@@ -11542,6 +11544,7 @@
       <keyword name="MultiProject.changeProjectProperties" id="MultiProject.changeProjectProperties" ref="eric7.MultiProject.MultiProject.html#MultiProject.changeProjectProperties" />
       <keyword name="MultiProject.checkDirty" id="MultiProject.checkDirty" ref="eric7.MultiProject.MultiProject.html#MultiProject.checkDirty" />
       <keyword name="MultiProject.clearRecent" id="MultiProject.clearRecent" ref="eric7.MultiProject.MultiProject.html#MultiProject.clearRecent" />
+      <keyword name="MultiProject.clearRemovedProjects" id="MultiProject.clearRemovedProjects" ref="eric7.MultiProject.MultiProject.html#MultiProject.clearRemovedProjects" />
       <keyword name="MultiProject.closeMultiProject" id="MultiProject.closeMultiProject" ref="eric7.MultiProject.MultiProject.html#MultiProject.closeMultiProject" />
       <keyword name="MultiProject.copyProject" id="MultiProject.copyProject" ref="eric7.MultiProject.MultiProject.html#MultiProject.copyProject" />
       <keyword name="MultiProject.deleteProject" id="MultiProject.deleteProject" ref="eric7.MultiProject.MultiProject.html#MultiProject.deleteProject" />
@@ -11555,6 +11558,7 @@
       <keyword name="MultiProject.getMultiProjectPath" id="MultiProject.getMultiProjectPath" ref="eric7.MultiProject.MultiProject.html#MultiProject.getMultiProjectPath" />
       <keyword name="MultiProject.getProject" id="MultiProject.getProject" ref="eric7.MultiProject.MultiProject.html#MultiProject.getProject" />
       <keyword name="MultiProject.getProjects" id="MultiProject.getProjects" ref="eric7.MultiProject.MultiProject.html#MultiProject.getProjects" />
+      <keyword name="MultiProject.hasRemovedProjects" id="MultiProject.hasRemovedProjects" ref="eric7.MultiProject.MultiProject.html#MultiProject.hasRemovedProjects" />
       <keyword name="MultiProject.initActions" id="MultiProject.initActions" ref="eric7.MultiProject.MultiProject.html#MultiProject.initActions" />
       <keyword name="MultiProject.initMenu" id="MultiProject.initMenu" ref="eric7.MultiProject.MultiProject.html#MultiProject.initMenu" />
       <keyword name="MultiProject.initToolbar" id="MultiProject.initToolbar" ref="eric7.MultiProject.MultiProject.html#MultiProject.initToolbar" />
@@ -11600,6 +11604,10 @@
       <keyword name="MultiProjectPage (Constructor)" id="MultiProjectPage (Constructor)" ref="eric7.Preferences.ConfigurationPages.MultiProjectPage.html#MultiProjectPage.__init__" />
       <keyword name="MultiProjectPage (Module)" id="MultiProjectPage (Module)" ref="eric7.Preferences.ConfigurationPages.MultiProjectPage.html" />
       <keyword name="MultiProjectPage.save" id="MultiProjectPage.save" ref="eric7.Preferences.ConfigurationPages.MultiProjectPage.html#MultiProjectPage.save" />
+      <keyword name="MultiProjectProjectMeta" id="MultiProjectProjectMeta" ref="eric7.MultiProject.MultiProjectProjectMeta.html#MultiProjectProjectMeta" />
+      <keyword name="MultiProjectProjectMeta (Module)" id="MultiProjectProjectMeta (Module)" ref="eric7.MultiProject.MultiProjectProjectMeta.html" />
+      <keyword name="MultiProjectProjectMeta.as_dict" id="MultiProjectProjectMeta.as_dict" ref="eric7.MultiProject.MultiProjectProjectMeta.html#MultiProjectProjectMeta.as_dict" />
+      <keyword name="MultiProjectProjectMeta.from_dict" id="MultiProjectProjectMeta.from_dict" ref="eric7.MultiProject.MultiProjectProjectMeta.html#MultiProjectProjectMeta.from_dict" />
       <keyword name="MultiProjectReader" id="MultiProjectReader" ref="eric7.EricXML.MultiProjectReader.html#MultiProjectReader" />
       <keyword name="MultiProjectReader (Constructor)" id="MultiProjectReader (Constructor)" ref="eric7.EricXML.MultiProjectReader.html#MultiProjectReader.__init__" />
       <keyword name="MultiProjectReader (Module)" id="MultiProjectReader (Module)" ref="eric7.EricXML.MultiProjectReader.html" />
@@ -12504,7 +12512,6 @@
       <keyword name="PipPackagesWidget.on_localCheckBox_clicked" id="PipPackagesWidget.on_localCheckBox_clicked" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.on_localCheckBox_clicked" />
       <keyword name="PipPackagesWidget.on_localDepCheckBox_clicked" id="PipPackagesWidget.on_localDepCheckBox_clicked" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.on_localDepCheckBox_clicked" />
       <keyword name="PipPackagesWidget.on_notRequiredCheckBox_clicked" id="PipPackagesWidget.on_notRequiredCheckBox_clicked" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.on_notRequiredCheckBox_clicked" />
-      <keyword name="PipPackagesWidget.on_packagesList_currentItemChanged" id="PipPackagesWidget.on_packagesList_currentItemChanged" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.on_packagesList_currentItemChanged" />
       <keyword name="PipPackagesWidget.on_packagesList_itemActivated" id="PipPackagesWidget.on_packagesList_itemActivated" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.on_packagesList_itemActivated" />
       <keyword name="PipPackagesWidget.on_packagesList_itemSelectionChanged" id="PipPackagesWidget.on_packagesList_itemSelectionChanged" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.on_packagesList_itemSelectionChanged" />
       <keyword name="PipPackagesWidget.on_refreshButton_clicked" id="PipPackagesWidget.on_refreshButton_clicked" ref="eric7.PipInterface.PipPackagesWidget.html#PipPackagesWidget.on_refreshButton_clicked" />
@@ -20984,6 +20991,7 @@
       <file>eric7.MultiProject.MultiProject.html</file>
       <file>eric7.MultiProject.MultiProjectBrowser.html</file>
       <file>eric7.MultiProject.MultiProjectFile.html</file>
+      <file>eric7.MultiProject.MultiProjectProjectMeta.html</file>
       <file>eric7.MultiProject.PropertiesDialog.html</file>
       <file>eric7.Network.IRC.IrcChannelEditDialog.html</file>
       <file>eric7.Network.IRC.IrcChannelWidget.html</file>
--- a/src/eric7/Documentation/Source/eric7.MultiProject.AddProjectDialog.html	Fri Dec 15 15:28:54 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MultiProject.AddProjectDialog.html	Fri Dec 15 15:30:12 2023 +0100
@@ -59,12 +59,16 @@
 <td>Constructor</td>
 </tr>
 <tr>
+<td><a href="#AddProjectDialog.__getFileName">__getFileName</a></td>
+<td>Private method to get the file name of the project file.</td>
+</tr>
+<tr>
 <td><a href="#AddProjectDialog.__updateUi">__updateUi</a></td>
 <td>Private method to update the dialog.</td>
 </tr>
 <tr>
-<td><a href="#AddProjectDialog.getData">getData</a></td>
-<td>Public slot to retrieve the dialogs data.</td>
+<td><a href="#AddProjectDialog.getProjectMetadata">getProjectMetadata</a></td>
+<td>Public method to get the entered project metadata.</td>
 </tr>
 <tr>
 <td><a href="#AddProjectDialog.on_filenamePicker_textChanged">on_filenamePicker_textChanged</a></td>
@@ -98,9 +102,9 @@
 <dd>
 start directory for the selection dialog
 </dd>
-<dt><i>project</i> (dict)</dt>
+<dt><i>project</i> (MultiProjectProjectMeta)</dt>
 <dd>
-dictionary containing project data
+dictionary containing project metadata
 </dd>
 <dt><i>categories</i> (list of str)</dt>
 <dd>
@@ -111,6 +115,25 @@
 category to be preset
 </dd>
 </dl>
+<a NAME="AddProjectDialog.__getFileName" ID="AddProjectDialog.__getFileName"></a>
+<h4>AddProjectDialog.__getFileName</h4>
+<b>__getFileName</b>(<i></i>)
+
+<p>
+        Private method to get the file name of the project file.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+project file name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="AddProjectDialog.__updateUi" ID="AddProjectDialog.__updateUi"></a>
 <h4>AddProjectDialog.__updateUi</h4>
 <b>__updateUi</b>(<i></i>)
@@ -118,25 +141,23 @@
 <p>
         Private method to update the dialog.
 </p>
-<a NAME="AddProjectDialog.getData" ID="AddProjectDialog.getData"></a>
-<h4>AddProjectDialog.getData</h4>
-<b>getData</b>(<i></i>)
+<a NAME="AddProjectDialog.getProjectMetadata" ID="AddProjectDialog.getProjectMetadata"></a>
+<h4>AddProjectDialog.getProjectMetadata</h4>
+<b>getProjectMetadata</b>(<i></i>)
 
 <p>
-        Public slot to retrieve the dialogs data.
+        Public method to get the entered project metadata.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of five values giving the project name, the name of the project
-            file, a flag telling whether the project shall be the main project, a short
-            description for the project and the project category
+project metadata iaw. the entered values
 </dd>
 </dl>
 <dl>
 <dt>Return Type:</dt>
 <dd>
-tuple of (str, str, bool, str, str)
+MultiProjectProjectMeta
 </dd>
 </dl>
 <a NAME="AddProjectDialog.on_filenamePicker_textChanged" ID="AddProjectDialog.on_filenamePicker_textChanged"></a>
--- 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>
--- a/src/eric7/Documentation/Source/eric7.MultiProject.MultiProjectBrowser.html	Fri Dec 15 15:28:54 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MultiProject.MultiProjectBrowser.html	Fri Dec 15 15:30:12 2023 +0100
@@ -187,9 +187,9 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (MultiProjectProjectMeta)</dt>
 <dd>
-reference to the project data dictionary
+reference to the project metadata
 </dd>
 </dl>
 <a NAME="MultiProjectBrowser.__configure" ID="MultiProjectBrowser.__configure"></a>
@@ -208,9 +208,9 @@
 </p>
 <dl>
 
-<dt><i>coord</i></dt>
+<dt><i>coord</i> (QPoint)</dt>
 <dd>
-the position of the mouse pointer (QPoint)
+the position of the mouse pointer
 </dd>
 </dl>
 <a NAME="MultiProjectBrowser.__copyProject" ID="MultiProjectBrowser.__copyProject"></a>
@@ -243,16 +243,22 @@
 </p>
 <dl>
 
-<dt><i>category</i></dt>
+<dt><i>category</i> (str)</dt>
 <dd>
-category to search for (string)
+category to search for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
 reference to the category item or None, if there is
-            no such item (QTreeWidgetItem or None)
+            no such item
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QTreeWidgetItem or None
 </dd>
 </dl>
 <a NAME="MultiProjectBrowser.__findProjectItem" ID="MultiProjectBrowser.__findProjectItem"></a>
@@ -264,15 +270,21 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (MultiProjectProjectMeta)</dt>
 <dd>
-reference to the project data dictionary
+reference to the project metadata
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the item (QTreeWidgetItem) or None
+reference to the item or None
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QTreeWidgetItem
 </dd>
 </dl>
 <a NAME="MultiProjectBrowser.__multiProjectClosed" ID="MultiProjectBrowser.__multiProjectClosed"></a>
@@ -305,9 +317,9 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the project item to be opened (QTreeWidgetItem)
+reference to the project item to be opened
 </dd>
 </dl>
 <a NAME="MultiProjectBrowser.__projectAdded" ID="MultiProjectBrowser.__projectAdded"></a>
@@ -319,9 +331,9 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (MultiProjectProjectMeta)</dt>
 <dd>
-reference to the project data dictionary
+reference to the project metadata
 </dd>
 </dl>
 <a NAME="MultiProjectBrowser.__projectClosed" ID="MultiProjectBrowser.__projectClosed"></a>
@@ -342,7 +354,7 @@
 
 <dt><i>project</i></dt>
 <dd>
-reference to the project data dictionary
+reference to the project metadata
 </dd>
 </dl>
 <a NAME="MultiProjectBrowser.__projectOpened" ID="MultiProjectBrowser.__projectOpened"></a>
@@ -361,9 +373,9 @@
 </p>
 <dl>
 
-<dt><i>project</i></dt>
+<dt><i>project</i> (MultiProjectProjectMeta)</dt>
 <dd>
-reference to the project data dictionary
+reference to the project metadata
 </dd>
 </dl>
 <a NAME="MultiProjectBrowser.__removeProject" ID="MultiProjectBrowser.__removeProject"></a>
@@ -382,13 +394,13 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the item to be set (QTreeWidgetItem)
+reference to the item to be set
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (MultiProjectProjectMeta)</dt>
 <dd>
-reference to the project data dictionary
+reference to the project metadata
 </dd>
 </dl>
 <a NAME="MultiProjectBrowser.__showProjectProperties" ID="MultiProjectBrowser.__showProjectProperties"></a>
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.MultiProject.MultiProjectProjectMeta.html	Fri Dec 15 15:30:12 2023 +0100
@@ -0,0 +1,119 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.MultiProject.MultiProjectProjectMeta</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.MultiProject.MultiProjectProjectMeta</h1>
+
+<p>
+Module defining a class containing the individual project metadata.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#MultiProjectProjectMeta">MultiProjectProjectMeta</a></td>
+<td>Class containing the individual project metadata.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="MultiProjectProjectMeta" ID="MultiProjectProjectMeta"></a>
+<h2>MultiProjectProjectMeta</h2>
+
+<p>
+    Class containing the individual project metadata.
+</p>
+<h3>Derived from</h3>
+None
+<h3>Class Attributes</h3>
+
+<table>
+<tr><td>category</td></tr><tr><td>description</td></tr><tr><td>file</td></tr><tr><td>master</td></tr><tr><td>name</td></tr><tr><td>removed</td></tr><tr><td>uid</td></tr>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#MultiProjectProjectMeta.from_dict">from_dict</a></td>
+<td>Class method to create a metadata object from the given dictionary.</td>
+</tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+
+<tr>
+<td><a href="#MultiProjectProjectMeta.as_dict">as_dict</a></td>
+<td>Public method to convert the metadata into a dictionary.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="MultiProjectProjectMeta.from_dict" ID="MultiProjectProjectMeta.from_dict"></a>
+<h4>MultiProjectProjectMeta.from_dict (class method)</h4>
+<b>from_dict</b>(<i>data</i>)
+
+<p>
+        Class method to create a metadata object from the given dictionary.
+</p>
+<dl>
+
+<dt><i>data</i> (dict)</dt>
+<dd>
+dictionary containing the metadata
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+created project metadata object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+MultiProjectProjectMeta
+</dd>
+</dl>
+<a NAME="MultiProjectProjectMeta.as_dict" ID="MultiProjectProjectMeta.as_dict"></a>
+<h4>MultiProjectProjectMeta.as_dict</h4>
+<b>as_dict</b>(<i></i>)
+
+<p>
+        Public method to convert the metadata into a dictionary.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing the metadata
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
--- a/src/eric7/Documentation/Source/eric7.MultiProject.PropertiesDialog.html	Fri Dec 15 15:28:54 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.MultiProject.PropertiesDialog.html	Fri Dec 15 15:30:12 2023 +0100
@@ -78,17 +78,18 @@
 </p>
 <dl>
 
-<dt><i>multiProject</i></dt>
+<dt><i>multiProject</i> (MultiProject)</dt>
 <dd>
 reference to the multi project object
 </dd>
-<dt><i>new</i></dt>
+<dt><i>new</i> (bool (optional))</dt>
 <dd>
 flag indicating the generation of a new multi project
+            (defaults to True)
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of this dialog (QWidget)
+reference to the parent widget (defaults to None)
 </dd>
 </dl>
 <a NAME="PropertiesDialog.storeData" ID="PropertiesDialog.storeData"></a>
--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Fri Dec 15 15:28:54 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Fri Dec 15 15:30:12 2023 +0100
@@ -331,10 +331,6 @@
 <td>Private slot handling the switching of the 'not required' mode.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.on_packagesList_currentItemChanged">on_packagesList_currentItemChanged</a></td>
-<td>Private slot to handle a change of the current item.</td>
-</tr>
-<tr>
 <td><a href="#PipPackagesWidget.on_packagesList_itemActivated">on_packagesList_itemActivated</a></td>
 <td>Private slot reacting on a package item being activated.</td>
 </tr>
@@ -1196,24 +1192,6 @@
 <p>
         Private slot handling the switching of the 'not required' mode.
 </p>
-<a NAME="PipPackagesWidget.on_packagesList_currentItemChanged" ID="PipPackagesWidget.on_packagesList_currentItemChanged"></a>
-<h4>PipPackagesWidget.on_packagesList_currentItemChanged</h4>
-<b>on_packagesList_currentItemChanged</b>(<i>curr, prev</i>)
-
-<p>
-        Private slot to handle a change of the current item.
-</p>
-<dl>
-
-<dt><i>curr</i> (QTreeWidgetItem)</dt>
-<dd>
-new current item
-</dd>
-<dt><i>prev</i> (QTreeWidgetItem)</dt>
-<dd>
-previous current item
-</dd>
-</dl>
 <a NAME="PipPackagesWidget.on_packagesList_itemActivated" ID="PipPackagesWidget.on_packagesList_itemActivated"></a>
 <h4>PipPackagesWidget.on_packagesList_itemActivated</h4>
 <b>on_packagesList_itemActivated</b>(<i>item, column</i>)
--- a/src/eric7/Documentation/Source/index-eric7.MultiProject.html	Fri Dec 15 15:28:54 2023 +0100
+++ b/src/eric7/Documentation/Source/index-eric7.MultiProject.html	Fri Dec 15 15:30:12 2023 +0100
@@ -39,6 +39,10 @@
 <td>Module implementing a class representing the multi project JSON file.</td>
 </tr>
 <tr>
+<td><a href="eric7.MultiProject.MultiProjectProjectMeta.html">MultiProjectProjectMeta</a></td>
+<td>Module defining a class containing the individual project metadata.</td>
+</tr>
+<tr>
 <td><a href="eric7.MultiProject.PropertiesDialog.html">PropertiesDialog</a></td>
 <td>Module implementing the multi project properties dialog.</td>
 </tr>

eric ide

mercurial