src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPicker.html

branch
eric7
changeset 9238
a7cbf3d61498
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPicker.html	Sat Jul 16 18:09:30 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPicker.html	Sat Jul 16 18:14:30 2022 +0200
@@ -75,6 +75,10 @@
 <td><a href="#EricComboPathPicker.getPathItems">getPathItems</a></td>
 <td>Public method to get the list of remembered paths.</td>
 </tr>
+<tr>
+<td><a href="#EricComboPathPicker.getPathLibItems">getPathLibItems</a></td>
+<td>Public method to get the list of remembered paths.</td>
+</tr>
 </table>
 <h3>Static Methods</h3>
 
@@ -106,7 +110,7 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list od remembered paths
+list of remembered paths
 </dd>
 </dl>
 <dl>
@@ -115,6 +119,25 @@
 list of str
 </dd>
 </dl>
+<a NAME="EricComboPathPicker.getPathLibItems" ID="EricComboPathPicker.getPathLibItems"></a>
+<h4>EricComboPathPicker.getPathLibItems</h4>
+<b>getPathLibItems</b>(<i></i>)
+
+<p>
+        Public method to get the list of remembered paths.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of remembered paths
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of pathlib.Path
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -269,6 +292,10 @@
 <td>Public method to get the default directory.</td>
 </tr>
 <tr>
+<td><a href="#EricPathPickerBase.defaultDirectoryPath">defaultDirectoryPath</a></td>
+<td>Public method to get the default directory as a pathlib.Path object.</td>
+</tr>
+<tr>
 <td><a href="#EricPathPickerBase.editorEnabled">editorEnabled</a></td>
 <td>Public method to get the path editor's enabled state.</td>
 </tr>
@@ -317,6 +344,10 @@
 <td>Public slot to set the current index.</td>
 </tr>
 <tr>
+<td><a href="#EricPathPickerBase.setCurrentPath">setCurrentPath</a></td>
+<td>Public method to set the current path.</td>
+</tr>
+<tr>
 <td><a href="#EricPathPickerBase.setCurrentText">setCurrentText</a></td>
 <td>Public slot to set the current text.</td>
 </tr>
@@ -476,7 +507,7 @@
 </p>
 <dl>
 
-<dt><i>fpath</i> (str)</dt>
+<dt><i>fpath</i> (str or pathlib.Path)</dt>
 <dd>
 path to add
 </dd>
@@ -490,9 +521,9 @@
 </p>
 <dl>
 
-<dt><i>pathsList</i> (list of str)</dt>
+<dt><i>pathsList</i> (list of str or pathlib.Path)</dt>
 <dd>
-list of paths to add
+list of paths
 </dd>
 </dl>
 <a NAME="EricPathPickerBase.buttonToolTip" ID="EricPathPickerBase.buttonToolTip"></a>
@@ -574,6 +605,25 @@
 str
 </dd>
 </dl>
+<a NAME="EricPathPickerBase.defaultDirectoryPath" ID="EricPathPickerBase.defaultDirectoryPath"></a>
+<h4>EricPathPickerBase.defaultDirectoryPath</h4>
+<b>defaultDirectoryPath</b>(<i></i>)
+
+<p>
+        Public method to get the default directory as a pathlib.Path object.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+default directory
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+pathlib.Path
+</dd>
+</dl>
 <a NAME="EricPathPickerBase.editorEnabled" ID="EricPathPickerBase.editorEnabled"></a>
 <h4>EricPathPickerBase.editorEnabled</h4>
 <b>editorEnabled</b>(<i></i>)
@@ -633,20 +683,12 @@
 </dl>
 <a NAME="EricPathPickerBase.firstPath" ID="EricPathPickerBase.firstPath"></a>
 <h4>EricPathPickerBase.firstPath</h4>
-<b>firstPath</b>(<i>toNative=True</i>)
+<b>firstPath</b>(<i></i>)
 
 <p>
         Public method to get the first path of a list of entered paths.
 </p>
 <dl>
-
-<dt><i>toNative</i> (bool)</dt>
-<dd>
-flag indicating to convert the path into
-            a native format
-</dd>
-</dl>
-<dl>
 <dt>Return:</dt>
 <dd>
 first path
@@ -655,7 +697,7 @@
 <dl>
 <dt>Return Type:</dt>
 <dd>
-str
+pathlib.Path
 </dd>
 </dl>
 <a NAME="EricPathPickerBase.isPickerEnabled" ID="EricPathPickerBase.isPickerEnabled"></a>
@@ -698,20 +740,12 @@
 </dl>
 <a NAME="EricPathPickerBase.lastPath" ID="EricPathPickerBase.lastPath"></a>
 <h4>EricPathPickerBase.lastPath</h4>
-<b>lastPath</b>(<i>toNative=True</i>)
+<b>lastPath</b>(<i></i>)
 
 <p>
         Public method to get the last path of a list of entered paths.
 </p>
 <dl>
-
-<dt><i>toNative</i> (bool)</dt>
-<dd>
-flag indicating to convert the path into
-            a native format
-</dd>
-</dl>
-<dl>
 <dt>Return:</dt>
 <dd>
 last path
@@ -720,7 +754,7 @@
 <dl>
 <dt>Return Type:</dt>
 <dd>
-str
+pathlib.Path
 </dd>
 </dl>
 <a NAME="EricPathPickerBase.mode" ID="EricPathPickerBase.mode"></a>
@@ -744,20 +778,12 @@
 </dl>
 <a NAME="EricPathPickerBase.path" ID="EricPathPickerBase.path"></a>
 <h4>EricPathPickerBase.path</h4>
-<b>path</b>(<i>toNative=True</i>)
+<b>path</b>(<i></i>)
 
 <p>
         Public method to get the current path.
 </p>
 <dl>
-
-<dt><i>toNative</i> (bool)</dt>
-<dd>
-flag indicating to convert the path into
-            a native format
-</dd>
-</dl>
-<dl>
 <dt>Return:</dt>
 <dd>
 current path
@@ -766,25 +792,17 @@
 <dl>
 <dt>Return Type:</dt>
 <dd>
-str
+pathlib.Path
 </dd>
 </dl>
 <a NAME="EricPathPickerBase.paths" ID="EricPathPickerBase.paths"></a>
 <h4>EricPathPickerBase.paths</h4>
-<b>paths</b>(<i>toNative=True</i>)
+<b>paths</b>(<i></i>)
 
 <p>
         Public method to get the list of entered paths.
 </p>
 <dl>
-
-<dt><i>toNative</i> (bool)</dt>
-<dd>
-flag indicating to convert the path into
-            a native format
-</dd>
-</dl>
-<dl>
 <dt>Return:</dt>
 <dd>
 entered paths
@@ -793,7 +811,7 @@
 <dl>
 <dt>Return Type:</dt>
 <dd>
-list of str
+list of pathlib.Path
 </dd>
 </dl>
 <a NAME="EricPathPickerBase.setButtonToolTip" ID="EricPathPickerBase.setButtonToolTip"></a>
@@ -824,6 +842,20 @@
 index of the item to set current
 </dd>
 </dl>
+<a NAME="EricPathPickerBase.setCurrentPath" ID="EricPathPickerBase.setCurrentPath"></a>
+<h4>EricPathPickerBase.setCurrentPath</h4>
+<b>setCurrentPath</b>(<i>fpath</i>)
+
+<p>
+        Public method to set the current path.
+</p>
+<dl>
+
+<dt><i>fpath</i> (pathlib.Path)</dt>
+<dd>
+current path
+</dd>
+</dl>
 <a NAME="EricPathPickerBase.setCurrentText" ID="EricPathPickerBase.setCurrentText"></a>
 <h4>EricPathPickerBase.setCurrentText</h4>
 <b>setCurrentText</b>(<i>text</i>)
@@ -847,7 +879,7 @@
 </p>
 <dl>
 
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str or pathlib.Path)</dt>
 <dd>
 default directory
 </dd>
@@ -967,22 +999,17 @@
 </dl>
 <a NAME="EricPathPickerBase.setPath" ID="EricPathPickerBase.setPath"></a>
 <h4>EricPathPickerBase.setPath</h4>
-<b>setPath</b>(<i>fpath, toNative=True</i>)
+<b>setPath</b>(<i>fpath</i>)
 
 <p>
         Public method to set the current path.
 </p>
 <dl>
 
-<dt><i>fpath</i> (str)</dt>
+<dt><i>fpath</i> (str or pathlib.Path)</dt>
 <dd>
 path to be set
 </dd>
-<dt><i>toNative</i> (bool)</dt>
-<dd>
-flag indicating to convert the path into
-            a native format
-</dd>
 </dl>
 <a NAME="EricPathPickerBase.setPathsList" ID="EricPathPickerBase.setPathsList"></a>
 <h4>EricPathPickerBase.setPathsList</h4>
@@ -993,7 +1020,7 @@
 </p>
 <dl>
 
-<dt><i>pathsList</i> (list of str)</dt>
+<dt><i>pathsList</i> (list of str or pathlib.Path)</dt>
 <dd>
 list of paths
 </dd>

eric ide

mercurial