--- a/src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Project.ProjectBrowserModel</h1>
-
<p>
Module implementing the browser model.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#ProjectBrowserDirectoryItem">ProjectBrowserDirectoryItem</a></td>
<td>Class implementing the data structure for project browser directory items.</td>
@@ -41,53 +39,53 @@
<td>Class implementing the data structure for project browser simple directory items.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="ProjectBrowserDirectoryItem" ID="ProjectBrowserDirectoryItem"></a>
<h2>ProjectBrowserDirectoryItem</h2>
-
<p>
Class implementing the data structure for project browser directory items.
</p>
+
<h3>Derived from</h3>
BrowserDirectoryItem, ProjectBrowserItemMixin
<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="#ProjectBrowserDirectoryItem.__init__">ProjectBrowserDirectoryItem</a></td>
<td>Constructor</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ProjectBrowserDirectoryItem.__init__" ID="ProjectBrowserDirectoryItem.__init__"></a>
<h4>ProjectBrowserDirectoryItem (Constructor)</h4>
<b>ProjectBrowserDirectoryItem</b>(<i>parent, dinfo, projectType, full=True, bold=False</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (BrowserItem)</dt>
@@ -116,44 +114,43 @@
<hr />
<a NAME="ProjectBrowserFileItem" ID="ProjectBrowserFileItem"></a>
<h2>ProjectBrowserFileItem</h2>
-
<p>
Class implementing the data structure for project browser file items.
</p>
+
<h3>Derived from</h3>
BrowserFileItem, ProjectBrowserItemMixin
<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="#ProjectBrowserFileItem.__init__">ProjectBrowserFileItem</a></td>
<td>Constructor</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ProjectBrowserFileItem.__init__" ID="ProjectBrowserFileItem.__init__"></a>
<h4>ProjectBrowserFileItem (Constructor)</h4>
<b>ProjectBrowserFileItem</b>(<i>parent, finfo, projectType, full=True, bold=False, sourceLanguage=""</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (BrowserItem)</dt>
@@ -186,29 +183,27 @@
<hr />
<a NAME="ProjectBrowserItemMixin" ID="ProjectBrowserItemMixin"></a>
<h2>ProjectBrowserItemMixin</h2>
-
<p>
Class implementing common methods of project browser items.
</p>
<p>
It is meant to be used as a mixin class.
</p>
+
<h3>Derived from</h3>
None
<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="#ProjectBrowserItemMixin.__init__">ProjectBrowserItemMixin</a></td>
<td>Constructor</td>
@@ -238,19 +233,20 @@
<td>Public method to set the VCS status.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ProjectBrowserItemMixin.__init__" ID="ProjectBrowserItemMixin.__init__"></a>
<h4>ProjectBrowserItemMixin (Constructor)</h4>
<b>ProjectBrowserItemMixin</b>(<i>type_, bold=False</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>type_</i> (str)</dt>
@@ -265,10 +261,10 @@
<a NAME="ProjectBrowserItemMixin.addProjectType" ID="ProjectBrowserItemMixin.addProjectType"></a>
<h4>ProjectBrowserItemMixin.addProjectType</h4>
<b>addProjectType</b>(<i>type_</i>)
-
<p>
Public method to add a type to the list.
</p>
+
<dl>
<dt><i>type_</i> (str)</dt>
@@ -279,10 +275,10 @@
<a NAME="ProjectBrowserItemMixin.addVcsStatus" ID="ProjectBrowserItemMixin.addVcsStatus"></a>
<h4>ProjectBrowserItemMixin.addVcsStatus</h4>
<b>addVcsStatus</b>(<i>vcsStatus</i>)
-
<p>
Public method to add the VCS status.
</p>
+
<dl>
<dt><i>vcsStatus</i> (str)</dt>
@@ -293,10 +289,10 @@
<a NAME="ProjectBrowserItemMixin.getProjectTypes" ID="ProjectBrowserItemMixin.getProjectTypes"></a>
<h4>ProjectBrowserItemMixin.getProjectTypes</h4>
<b>getProjectTypes</b>(<i></i>)
-
<p>
Public method to get the project type.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -312,10 +308,10 @@
<a NAME="ProjectBrowserItemMixin.getTextColor" ID="ProjectBrowserItemMixin.getTextColor"></a>
<h4>ProjectBrowserItemMixin.getTextColor</h4>
<b>getTextColor</b>(<i></i>)
-
<p>
Public method to get the items text color.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -331,10 +327,10 @@
<a NAME="ProjectBrowserItemMixin.setVcsState" ID="ProjectBrowserItemMixin.setVcsState"></a>
<h4>ProjectBrowserItemMixin.setVcsState</h4>
<b>setVcsState</b>(<i>state</i>)
-
<p>
Public method to set the items VCS state.
</p>
+
<dl>
<dt><i>state</i> (str)</dt>
@@ -345,10 +341,10 @@
<a NAME="ProjectBrowserItemMixin.setVcsStatus" ID="ProjectBrowserItemMixin.setVcsStatus"></a>
<h4>ProjectBrowserItemMixin.setVcsStatus</h4>
<b>setVcsStatus</b>(<i>vcsStatus</i>)
-
<p>
Public method to set the VCS status.
</p>
+
<dl>
<dt><i>vcsStatus</i> (str)</dt>
@@ -361,10 +357,10 @@
<hr />
<a NAME="ProjectBrowserModel" ID="ProjectBrowserModel"></a>
<h2>ProjectBrowserModel</h2>
-
<p>
Class implementing the project browser model.
</p>
+
<h3>Signals</h3>
<dl>
@@ -376,19 +372,17 @@
<h3>Derived from</h3>
BrowserModel
<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="#ProjectBrowserModel.__init__">ProjectBrowserModel</a></td>
<td>Constructor</td>
@@ -494,19 +488,20 @@
<td>Public method used to update the vcs status of a node.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ProjectBrowserModel.__init__" ID="ProjectBrowserModel.__init__"></a>
<h4>ProjectBrowserModel (Constructor)</h4>
<b>ProjectBrowserModel</b>(<i>parent</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (Project.Project)</dt>
@@ -517,10 +512,10 @@
<a NAME="ProjectBrowserModel.__addVCSStatus" ID="ProjectBrowserModel.__addVCSStatus"></a>
<h4>ProjectBrowserModel.__addVCSStatus</h4>
<b>__addVCSStatus</b>(<i>item, name</i>)
-
<p>
Private method used to set the vcs status of a node.
</p>
+
<dl>
<dt><i>item</i> (BrowserItem)</dt>
@@ -535,10 +530,10 @@
<a NAME="ProjectBrowserModel.__changeParentsVCSState" ID="ProjectBrowserModel.__changeParentsVCSState"></a>
<h4>ProjectBrowserModel.__changeParentsVCSState</h4>
<b>__changeParentsVCSState</b>(<i>path, itemCache</i>)
-
<p>
Private method to recursively change the parents VCS state.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -554,10 +549,10 @@
<a NAME="ProjectBrowserModel.__updateVCSStatus" ID="ProjectBrowserModel.__updateVCSStatus"></a>
<h4>ProjectBrowserModel.__updateVCSStatus</h4>
<b>__updateVCSStatus</b>(<i>item, name, recursive=True</i>)
-
<p>
Private method used to update the vcs status of a node.
</p>
+
<dl>
<dt><i>item</i> (BrowserItem)</dt>
@@ -576,10 +571,10 @@
<a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a>
<h4>ProjectBrowserModel.addNewItem</h4>
<b>addNewItem</b>(<i>typeString, name, additionalTypeStrings=None</i>)
-
<p>
Public method to add a new item to the model.
</p>
+
<dl>
<dt><i>typeString</i> (str)</dt>
@@ -598,10 +593,10 @@
<a NAME="ProjectBrowserModel.changeVCSStates" ID="ProjectBrowserModel.changeVCSStates"></a>
<h4>ProjectBrowserModel.changeVCSStates</h4>
<b>changeVCSStates</b>(<i>statesList</i>)
-
<p>
Public slot to record the (non normal) VCS states.
</p>
+
<dl>
<dt><i>statesList</i> (list of str)</dt>
@@ -623,10 +618,10 @@
<a NAME="ProjectBrowserModel.data" ID="ProjectBrowserModel.data"></a>
<h4>ProjectBrowserModel.data</h4>
<b>data</b>(<i>index, role</i>)
-
<p>
Public method to get data of an item.
</p>
+
<dl>
<dt><i>index</i> (QModelIndex)</dt>
@@ -653,10 +648,10 @@
<a NAME="ProjectBrowserModel.directoryChanged" ID="ProjectBrowserModel.directoryChanged"></a>
<h4>ProjectBrowserModel.directoryChanged</h4>
<b>directoryChanged</b>(<i>path</i>)
-
<p>
Public slot to handle the directoryChanged signal of the watcher.
</p>
+
<dl>
<dt><i>path</i> (str)</dt>
@@ -667,10 +662,10 @@
<a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a>
<h4>ProjectBrowserModel.findChildItem</h4>
<b>findChildItem</b>(<i>text, column, parentItem=None</i>)
-
<p>
Public method to find a child item given some text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -701,10 +696,10 @@
<a NAME="ProjectBrowserModel.findItem" ID="ProjectBrowserModel.findItem"></a>
<h4>ProjectBrowserModel.findItem</h4>
<b>findItem</b>(<i>name</i>)
-
<p>
Public method to find an item given its name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -727,7 +722,6 @@
<a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a>
<h4>ProjectBrowserModel.findParentItemByName</h4>
<b>findParentItemByName</b>(<i>type_, name, dontSplit=False</i>)
-
<p>
Public method to find an item given its name.
</p>
@@ -735,6 +729,7 @@
<b>Note</b>: This method creates all necessary parent items, if they
don't exist.
</p>
+
<dl>
<dt><i>type_</i> (str)</dt>
@@ -765,10 +760,10 @@
<a NAME="ProjectBrowserModel.itemIndexByName" ID="ProjectBrowserModel.itemIndexByName"></a>
<h4>ProjectBrowserModel.itemIndexByName</h4>
<b>itemIndexByName</b>(<i>name</i>)
-
<p>
Public method to find an item's index given its name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -791,10 +786,10 @@
<a NAME="ProjectBrowserModel.itemIndexByNameAndLine" ID="ProjectBrowserModel.itemIndexByNameAndLine"></a>
<h4>ProjectBrowserModel.itemIndexByNameAndLine</h4>
<b>itemIndexByNameAndLine</b>(<i>name, lineno</i>)
-
<p>
Public method to find an item's index given its name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -821,10 +816,10 @@
<a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a>
<h4>ProjectBrowserModel.populateItem</h4>
<b>populateItem</b>(<i>parentItem, repopulate=False</i>)
-
<p>
Public method to populate an item's subtree.
</p>
+
<dl>
<dt><i>parentItem</i> (BrowserItem)</dt>
@@ -839,10 +834,10 @@
<a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a>
<h4>ProjectBrowserModel.populateProjectDirectoryItem</h4>
<b>populateProjectDirectoryItem</b>(<i>parentItem, repopulate=False</i>)
-
<p>
Public method to populate a directory item's subtree.
</p>
+
<dl>
<dt><i>parentItem</i> (BrowserItem)</dt>
@@ -857,39 +852,39 @@
<a NAME="ProjectBrowserModel.preferencesChanged" ID="ProjectBrowserModel.preferencesChanged"></a>
<h4>ProjectBrowserModel.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
-
<p>
Public method used to handle a change in preferences.
</p>
+
<a NAME="ProjectBrowserModel.projectClosed" ID="ProjectBrowserModel.projectClosed"></a>
<h4>ProjectBrowserModel.projectClosed</h4>
<b>projectClosed</b>(<i></i>)
-
<p>
Public method called after a project has been closed.
</p>
+
<a NAME="ProjectBrowserModel.projectOpened" ID="ProjectBrowserModel.projectOpened"></a>
<h4>ProjectBrowserModel.projectOpened</h4>
<b>projectOpened</b>(<i></i>)
-
<p>
Public method used to populate the model after a project has been
opened.
</p>
+
<a NAME="ProjectBrowserModel.projectPropertiesChanged" ID="ProjectBrowserModel.projectPropertiesChanged"></a>
<h4>ProjectBrowserModel.projectPropertiesChanged</h4>
<b>projectPropertiesChanged</b>(<i></i>)
-
<p>
Public method to react on a change of the project properties.
</p>
+
<a NAME="ProjectBrowserModel.removeItem" ID="ProjectBrowserModel.removeItem"></a>
<h4>ProjectBrowserModel.removeItem</h4>
<b>removeItem</b>(<i>name</i>)
-
<p>
Public method to remove a named item.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -900,10 +895,10 @@
<a NAME="ProjectBrowserModel.renameItem" ID="ProjectBrowserModel.renameItem"></a>
<h4>ProjectBrowserModel.renameItem</h4>
<b>renameItem</b>(<i>name, newFilename</i>)
-
<p>
Public method to rename an item.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -918,10 +913,10 @@
<a NAME="ProjectBrowserModel.repopulateItem" ID="ProjectBrowserModel.repopulateItem"></a>
<h4>ProjectBrowserModel.repopulateItem</h4>
<b>repopulateItem</b>(<i>name</i>)
-
<p>
Public method to repopulate an item.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -932,10 +927,10 @@
<a NAME="ProjectBrowserModel.setProjectBrowserReference" ID="ProjectBrowserModel.setProjectBrowserReference"></a>
<h4>ProjectBrowserModel.setProjectBrowserReference</h4>
<b>setProjectBrowserReference</b>(<i>projectBrowser</i>)
-
<p>
Public method to set a reference to the project browser instance.
</p>
+
<dl>
<dt><i>projectBrowser</i> (ProjectBrowser)</dt>
@@ -946,24 +941,24 @@
<a NAME="ProjectBrowserModel.startFileSystemMonitoring" ID="ProjectBrowserModel.startFileSystemMonitoring"></a>
<h4>ProjectBrowserModel.startFileSystemMonitoring</h4>
<b>startFileSystemMonitoring</b>(<i></i>)
-
<p>
Public method to (re)start monitoring the project file system.
</p>
+
<a NAME="ProjectBrowserModel.stopFileSystemMonitoring" ID="ProjectBrowserModel.stopFileSystemMonitoring"></a>
<h4>ProjectBrowserModel.stopFileSystemMonitoring</h4>
<b>stopFileSystemMonitoring</b>(<i></i>)
-
<p>
Public method to stop monitoring the project file system.
</p>
+
<a NAME="ProjectBrowserModel.updateVCSStatus" ID="ProjectBrowserModel.updateVCSStatus"></a>
<h4>ProjectBrowserModel.updateVCSStatus</h4>
<b>updateVCSStatus</b>(<i>name, recursive=True</i>)
-
<p>
Public method used to update the vcs status of a node.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -980,45 +975,44 @@
<hr />
<a NAME="ProjectBrowserSimpleDirectoryItem" ID="ProjectBrowserSimpleDirectoryItem"></a>
<h2>ProjectBrowserSimpleDirectoryItem</h2>
-
<p>
Class implementing the data structure for project browser simple directory
items.
</p>
+
<h3>Derived from</h3>
BrowserSimpleDirectoryItem, ProjectBrowserItemMixin
<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="#ProjectBrowserSimpleDirectoryItem.__init__">ProjectBrowserSimpleDirectoryItem</a></td>
<td>Constructor</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="ProjectBrowserSimpleDirectoryItem.__init__" ID="ProjectBrowserSimpleDirectoryItem.__init__"></a>
<h4>ProjectBrowserSimpleDirectoryItem (Constructor)</h4>
<b>ProjectBrowserSimpleDirectoryItem</b>(<i>parent, projectType, text, path=""</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (BrowserItem)</dt>
@@ -1040,4 +1034,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
