--- a/src/eric7/Documentation/Source/eric7.UI.BrowserModel.html Mon Dec 11 10:30:24 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.UI.BrowserModel.html Mon Dec 11 10:31:27 2023 +0100 @@ -14,7 +14,7 @@ <h3>Global Attributes</h3> <table> -<tr><td>BrowserItemAttribute</td></tr><tr><td>BrowserItemAttributes</td></tr><tr><td>BrowserItemClass</td></tr><tr><td>BrowserItemCoding</td></tr><tr><td>BrowserItemDirectory</td></tr><tr><td>BrowserItemFile</td></tr><tr><td>BrowserItemImport</td></tr><tr><td>BrowserItemImports</td></tr><tr><td>BrowserItemMethod</td></tr><tr><td>BrowserItemRoot</td></tr><tr><td>BrowserItemSysPath</td></tr> +<tr><td>BrowserItemAttribute</td></tr><tr><td>BrowserItemAttributes</td></tr><tr><td>BrowserItemClass</td></tr><tr><td>BrowserItemCoding</td></tr><tr><td>BrowserItemDirectory</td></tr><tr><td>BrowserItemFile</td></tr><tr><td>BrowserItemImport</td></tr><tr><td>BrowserItemImports</td></tr><tr><td>BrowserItemMethod</td></tr><tr><td>BrowserItemRoot</td></tr><tr><td>BrowserItemSimpleDirectory</td></tr><tr><td>BrowserItemSysPath</td></tr> </table> <h3>Classes</h3> @@ -69,6 +69,10 @@ <td>Class implementing the browser model.</td> </tr> <tr> +<td><a href="#BrowserSimpleDirectoryItem">BrowserSimpleDirectoryItem</a></td> +<td>Class implementing the data structure for browser simple directory items.</td> +</tr> +<tr> <td><a href="#BrowserSysPathItem">BrowserSysPathItem</a></td> <td>Class implementing the data structure for browser sys.path items.</td> </tr> @@ -2937,6 +2941,152 @@ <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> +<a NAME="BrowserSimpleDirectoryItem" ID="BrowserSimpleDirectoryItem"></a> +<h2>BrowserSimpleDirectoryItem</h2> + +<p> + Class implementing the data structure for browser simple directory items. +</p> +<h3>Derived from</h3> +BrowserItem +<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="#BrowserSimpleDirectoryItem.__init__">BrowserSimpleDirectoryItem</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#BrowserSimpleDirectoryItem.dirName">dirName</a></td> +<td>Public method returning the directory name.</td> +</tr> +<tr> +<td><a href="#BrowserSimpleDirectoryItem.lessThan">lessThan</a></td> +<td>Public method to check, if the item is less than the other one.</td> +</tr> +<tr> +<td><a href="#BrowserSimpleDirectoryItem.name">name</a></td> +<td>Public method to return the name of the item.</td> +</tr> +<tr> +<td><a href="#BrowserSimpleDirectoryItem.setName">setName</a></td> +<td>Public method to set the directory name.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="BrowserSimpleDirectoryItem.__init__" ID="BrowserSimpleDirectoryItem.__init__"></a> +<h4>BrowserSimpleDirectoryItem (Constructor)</h4> +<b>BrowserSimpleDirectoryItem</b>(<i>parent, text, path=""</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i></dt> +<dd> +parent item +</dd> +<dt><i>text</i></dt> +<dd> +text to be displayed (string) +</dd> +<dt><i>path</i></dt> +<dd> +path of the directory (string) +</dd> +</dl> +<a NAME="BrowserSimpleDirectoryItem.dirName" ID="BrowserSimpleDirectoryItem.dirName"></a> +<h4>BrowserSimpleDirectoryItem.dirName</h4> +<b>dirName</b>(<i></i>) + +<p> + Public method returning the directory name. +</p> +<dl> +<dt>Return:</dt> +<dd> +directory name (string) +</dd> +</dl> +<a NAME="BrowserSimpleDirectoryItem.lessThan" ID="BrowserSimpleDirectoryItem.lessThan"></a> +<h4>BrowserSimpleDirectoryItem.lessThan</h4> +<b>lessThan</b>(<i>other, column, order</i>) + +<p> + Public method to check, if the item is less than the other one. +</p> +<dl> + +<dt><i>other</i></dt> +<dd> +reference to item to compare against (BrowserItem) +</dd> +<dt><i>column</i></dt> +<dd> +column number to use for the comparison (integer) +</dd> +<dt><i>order</i></dt> +<dd> +sort order (Qt.SortOrder) (for special sorting) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +true, if this item is less than other (boolean) +</dd> +</dl> +<a NAME="BrowserSimpleDirectoryItem.name" ID="BrowserSimpleDirectoryItem.name"></a> +<h4>BrowserSimpleDirectoryItem.name</h4> +<b>name</b>(<i></i>) + +<p> + Public method to return the name of the item. +</p> +<dl> +<dt>Return:</dt> +<dd> +name of the item (string) +</dd> +</dl> +<a NAME="BrowserSimpleDirectoryItem.setName" ID="BrowserSimpleDirectoryItem.setName"></a> +<h4>BrowserSimpleDirectoryItem.setName</h4> +<b>setName</b>(<i>dinfo, full=True</i>) + +<p> + Public method to set the directory name. +</p> +<dl> + +<dt><i>dinfo</i></dt> +<dd> +dinfo is the string for the directory (string) +</dd> +<dt><i>full</i></dt> +<dd> +flag indicating full path name should be displayed (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> <a NAME="BrowserSysPathItem" ID="BrowserSysPathItem"></a> <h2>BrowserSysPathItem</h2>