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

branch
eric7
changeset 10951
8a7e3a26fe36
parent 10845
bbcad422aea7
diff -r fa0ea22dd909 -r 8a7e3a26fe36 src/eric7/Documentation/Source/eric7.UI.BrowserModel.html
--- a/src/eric7/Documentation/Source/eric7.UI.BrowserModel.html	Sat Oct 05 11:39:18 2024 +0200
+++ b/src/eric7/Documentation/Source/eric7.UI.BrowserModel.html	Sat Oct 05 11:40:01 2024 +0200
@@ -901,6 +901,10 @@
 <td>Constructor</td>
 </tr>
 <tr>
+<td><a href="#BrowserDirectoryItem.__prepareInfo">__prepareInfo</a></td>
+<td>Private method to prepare the information to be stored.</td>
+</tr>
+<tr>
 <td><a href="#BrowserDirectoryItem.dirName">dirName</a></td>
 <td>Public method returning the directory name.</td>
 </tr>
@@ -939,7 +943,7 @@
 </dd>
 <dt><i>dinfo</i> (str)</dt>
 <dd>
-dinfo is the string for the directory
+string containing the directory info
 </dd>
 <dt><i>full</i> (bool (optional))</dt>
 <dd>
@@ -951,6 +955,37 @@
             (defaults to None)
 </dd>
 </dl>
+<a NAME="BrowserDirectoryItem.__prepareInfo" ID="BrowserDirectoryItem.__prepareInfo"></a>
+<h4>BrowserDirectoryItem.__prepareInfo</h4>
+<b>__prepareInfo</b>(<i>dinfo, full=True</i>)
+<p>
+        Private method to prepare the information to be stored.
+</p>
+
+<dl>
+
+<dt><i>dinfo</i> (str)</dt>
+<dd>
+string containing the directory info
+</dd>
+<dt><i>full</i> (bool (optional))</dt>
+<dd>
+flag indicating full pathname should be displayed (defaults to True)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the path name to be shown, a flag indicating a
+            remote (eric-ide server) path and a string with the connection info
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, bool)
+</dd>
+</dl>
 <a NAME="BrowserDirectoryItem.dirName" ID="BrowserDirectoryItem.dirName"></a>
 <h4>BrowserDirectoryItem.dirName</h4>
 <b>dirName</b>(<i></i>)
@@ -1034,11 +1069,11 @@
 
 <dt><i>dinfo</i> (str)</dt>
 <dd>
-dinfo is the string for the directory
-</dd>
-<dt><i>full</i> (bool)</dt>
-<dd>
-flag indicating full pathname should be displayed
+string containing the directory info
+</dd>
+<dt><i>full</i> (bool (optional))</dt>
+<dd>
+flag indicating full pathname should be displayed (defaults to True)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -2013,6 +2048,10 @@
 <td>Public method to get the items icon.</td>
 </tr>
 <tr>
+<td><a href="#BrowserItem.getRemoteInfo">getRemoteInfo</a></td>
+<td>Public method to get data about the remote connection.</td>
+</tr>
+<tr>
 <td><a href="#BrowserItem.isLazyPopulated">isLazyPopulated</a></td>
 <td>Public method to check, if this item should be populated lazyly.</td>
 </tr>
@@ -2025,8 +2064,12 @@
 <td>Public method returning the public visibility status.</td>
 </tr>
 <tr>
+<td><a href="#BrowserItem.isRemote">isRemote</a></td>
+<td>Public method to check, if the item is a remote path item.</td>
+</tr>
+<tr>
 <td><a href="#BrowserItem.isSymlink">isSymlink</a></td>
-<td>Public method to check, if the items is a symbolic link.</td>
+<td>Public method to check, if the item is a symbolic link.</td>
 </tr>
 <tr>
 <td><a href="#BrowserItem.lessThan">lessThan</a></td>
@@ -2243,6 +2286,25 @@
 QIcon
 </dd>
 </dl>
+<a NAME="BrowserItem.getRemoteInfo" ID="BrowserItem.getRemoteInfo"></a>
+<h4>BrowserItem.getRemoteInfo</h4>
+<b>getRemoteInfo</b>(<i></i>)
+<p>
+        Public method to get data about the remote connection.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+string describing the remote connection
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="BrowserItem.isLazyPopulated" ID="BrowserItem.isLazyPopulated"></a>
 <h4>BrowserItem.isLazyPopulated</h4>
 <b>isLazyPopulated</b>(<i></i>)
@@ -2300,11 +2362,30 @@
 bool
 </dd>
 </dl>
+<a NAME="BrowserItem.isRemote" ID="BrowserItem.isRemote"></a>
+<h4>BrowserItem.isRemote</h4>
+<b>isRemote</b>(<i></i>)
+<p>
+        Public method to check, if the item is a remote path item.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating a remote path item
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
 <a NAME="BrowserItem.isSymlink" ID="BrowserItem.isSymlink"></a>
 <h4>BrowserItem.isSymlink</h4>
 <b>isSymlink</b>(<i></i>)
 <p>
-        Public method to check, if the items is a symbolic link.
+        Public method to check, if the item is a symbolic link.
 </p>
 
 <dl>
@@ -2893,6 +2974,10 @@
 <td>Public method to change the entry for the directory of file being debugged.</td>
 </tr>
 <tr>
+<td><a href="#BrowserModel.refreshDirectory">refreshDirectory</a></td>
+<td>Public method to refresh the directory with the given index.</td>
+</tr>
+<tr>
 <td><a href="#BrowserModel.removeToplevelDir">removeToplevelDir</a></td>
 <td>Public method to remove a toplevel directory.</td>
 </tr>
@@ -3021,6 +3106,10 @@
 <p>
         Public method to add a new toplevel directory.
 </p>
+<p>
+        If the directory does not contain a host connection info but is a remote
+        directory, this info is added.
+</p>
 
 <dl>
 
@@ -3486,6 +3575,20 @@
 name of the directory containing the file
 </dd>
 </dl>
+<a NAME="BrowserModel.refreshDirectory" ID="BrowserModel.refreshDirectory"></a>
+<h4>BrowserModel.refreshDirectory</h4>
+<b>refreshDirectory</b>(<i>index</i>)
+<p>
+        Public method to refresh the directory with the given index.
+</p>
+
+<dl>
+
+<dt><i>index</i> (QModelIndex)</dt>
+<dd>
+index of the directory item
+</dd>
+</dl>
 <a NAME="BrowserModel.removeToplevelDir" ID="BrowserModel.removeToplevelDir"></a>
 <h4>BrowserModel.removeToplevelDir</h4>
 <b>removeToplevelDir</b>(<i>index</i>)

eric ide

mercurial