src/eric7/Documentation/Source/eric7.UI.BrowserModel.html

branch
eric7
changeset 10832
479cf39ac9cb
parent 10784
521fd465b048
child 10845
bbcad422aea7
--- a/src/eric7/Documentation/Source/eric7.UI.BrowserModel.html	Sat Jul 06 19:48:50 2024 +0200
+++ b/src/eric7/Documentation/Source/eric7.UI.BrowserModel.html	Sun Jul 07 12:57:21 2024 +0200
@@ -71,6 +71,10 @@
 <td>Class implementing the browser model.</td>
 </tr>
 <tr>
+<td><a href="#BrowserModelType">BrowserModelType</a></td>
+<td>Class defining the various browser model types.</td>
+</tr>
+<tr>
 <td><a href="#BrowserSimpleDirectoryItem">BrowserSimpleDirectoryItem</a></td>
 <td>Class implementing the data structure for browser simple directory items.</td>
 </tr>
@@ -149,7 +153,7 @@
 
 <a NAME="BrowserClassAttributeItem.__init__" ID="BrowserClassAttributeItem.__init__"></a>
 <h4>BrowserClassAttributeItem (Constructor)</h4>
-<b>BrowserClassAttributeItem</b>(<i>parent, attribute, isClass=False</i>)
+<b>BrowserClassAttributeItem</b>(<i>parent, attribute, isClass=False, modelType=BrowserModelType.Generic</i>)
 <p>
         Constructor
 </p>
@@ -164,9 +168,14 @@
 <dd>
 reference to the attribute object
 </dd>
-<dt><i>isClass</i> (bool)</dt>
-<dd>
-flag indicating a class attribute
+<dt><i>isClass</i> (bool (optional))</dt>
+<dd>
+flag indicating a class attribute (defaults to False)
+</dd>
+<dt><i>modelType</i> (BrowserModelType (optional))</dt>
+<dd>
+type of the browser model (defaults to
+            BrowserModelType.Generic)
 </dd>
 </dl>
 <a NAME="BrowserClassAttributeItem.attributeObject" ID="BrowserClassAttributeItem.attributeObject"></a>
@@ -554,7 +563,7 @@
 
 <a NAME="BrowserClassItem.__init__" ID="BrowserClassItem.__init__"></a>
 <h4>BrowserClassItem (Constructor)</h4>
-<b>BrowserClassItem</b>(<i>parent, cl, filename</i>)
+<b>BrowserClassItem</b>(<i>parent, cl, filename, modelType=BrowserModelType.Generic</i>)
 <p>
         Constructor
 </p>
@@ -573,6 +582,11 @@
 <dd>
 file name of the file defining this class
 </dd>
+<dt><i>modelType</i> (BrowserModelType (optional))</dt>
+<dd>
+type of the browser model (defaults to
+            BrowserModelType.Generic)
+</dd>
 </dl>
 <a NAME="BrowserClassItem.boundaries" ID="BrowserClassItem.boundaries"></a>
 <h4>BrowserClassItem.boundaries</h4>
@@ -1724,7 +1738,7 @@
 
 <a NAME="BrowserImportItem.__init__" ID="BrowserImportItem.__init__"></a>
 <h4>BrowserImportItem (Constructor)</h4>
-<b>BrowserImportItem</b>(<i>parent, text, filename, lineNumbers, isModule=True</i>)
+<b>BrowserImportItem</b>(<i>parent, text, filename, lineNumbers, isModule=True, modelType=BrowserModelType.Generic, </i>)
 <p>
         Constructor
 </p>
@@ -1747,9 +1761,14 @@
 <dd>
 list of line numbers of the import statement
 </dd>
-<dt><i>isModule</i> (bool)</dt>
-<dd>
-flag indicating a module item entry
+<dt><i>isModule</i> (bool (optional))</dt>
+<dd>
+flag indicating a module item entry (defaults to True)
+</dd>
+<dt><i>modelType</i> (BrowserModelType (optional))</dt>
+<dd>
+type of the browser model (defaults to
+            BrowserModelType.Generic)
 </dd>
 </dl>
 <a NAME="BrowserImportItem.fileName" ID="BrowserImportItem.fileName"></a>
@@ -2546,7 +2565,7 @@
 
 <a NAME="BrowserMethodItem.__init__" ID="BrowserMethodItem.__init__"></a>
 <h4>BrowserMethodItem (Constructor)</h4>
-<b>BrowserMethodItem</b>(<i>parent, fn, filename</i>)
+<b>BrowserMethodItem</b>(<i>parent, fn, filename, modelType=BrowserModelType.Generic</i>)
 <p>
         Constructor
 </p>
@@ -2565,6 +2584,11 @@
 <dd>
 filename of the file defining this class
 </dd>
+<dt><i>modelType</i> (BrowserModelType (optional))</dt>
+<dd>
+type of the browser model (defaults to
+            BrowserModelType.Generic)
+</dd>
 </dl>
 <a NAME="BrowserMethodItem.boundaries" ID="BrowserMethodItem.boundaries"></a>
 <h4>BrowserMethodItem.boundaries</h4>
@@ -2894,7 +2918,7 @@
 
 <a NAME="BrowserModel.__init__" ID="BrowserModel.__init__"></a>
 <h4>BrowserModel (Constructor)</h4>
-<b>BrowserModel</b>(<i>parent=None, nopopulate=False, fsInterface=None</i>)
+<b>BrowserModel</b>(<i>parent=None, nopopulate=False, fsInterface=None, modelType=BrowserModelType.Generic, </i>)
 <p>
         Constructor
 </p>
@@ -2914,6 +2938,11 @@
 reference to the 'eric-ide' server interface object
             (defaults to None)
 </dd>
+<dt><i>modelType</i> (BrowserModelType (optional))</dt>
+<dd>
+type of the browser model (defaults to
+            BrowserModelType.Generic)
+</dd>
 </dl>
 <a NAME="BrowserModel.__populateModel" ID="BrowserModel.__populateModel"></a>
 <h4>BrowserModel.__populateModel</h4>
@@ -3509,6 +3538,40 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="BrowserModelType" ID="BrowserModelType"></a>
+<h2>BrowserModelType</h2>
+<p>
+    Class defining the various browser model types.
+</p>
+
+<h3>Derived from</h3>
+enum.Enum
+<h3>Class Attributes</h3>
+<table>
+<tr><td>EditorOutline</td></tr>
+<tr><td>Generic</td></tr>
+<tr><td>Project</td></tr>
+</table>
+
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="BrowserSimpleDirectoryItem" ID="BrowserSimpleDirectoryItem"></a>
 <h2>BrowserSimpleDirectoryItem</h2>
 <p>

eric ide

mercurial