Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPickerDialog.html	Sat Jul 16 18:09:30 2022 +0200
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPickerDialog.html	Sat Jul 16 18:14:30 2022 +0200
@@ -33,6 +33,10 @@
 <td><a href="#getPath">getPath</a></td>
 <td>Function to get a file or directory path from the user.</td>
 </tr>
+<tr>
+<td><a href="#getStrPath">getStrPath</a></td>
+<td>Function to get a file or directory path from the user.</td>
+</tr>
 </table>
 <hr />
 <hr />
@@ -65,7 +69,11 @@
 </tr>
 <tr>
 <td><a href="#EricPathPickerDialog.getPath">getPath</a></td>
-<td>Public method to get the current path.</td>
+<td>Public method to get the current path as a pathlib.Path object.</td>
+</tr>
+<tr>
+<td><a href="#EricPathPickerDialog.getText">getText</a></td>
+<td>Public method to get the current path as text.</td>
 </tr>
 <tr>
 <td><a href="#EricPathPickerDialog.setDefaultDirectory">setDefaultDirectory</a></td>
@@ -117,7 +125,26 @@
 <b>getPath</b>(<i></i>)
 
 <p>
-        Public method to get the current path.
+        Public method to get the current path as a pathlib.Path object.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+current path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+pathlib.Path
+</dd>
+</dl>
+<a NAME="EricPathPickerDialog.getText" ID="EricPathPickerDialog.getText"></a>
+<h4>EricPathPickerDialog.getText</h4>
+<b>getText</b>(<i></i>)
+
+<p>
+        Public method to get the current path as text.
 </p>
 <dl>
 <dt>Return:</dt>
@@ -140,7 +167,7 @@
 </p>
 <dl>
 
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str or pathlib.Path)</dt>
 <dd>
 default directory
 </dd>
@@ -192,14 +219,14 @@
 </dl>
 <a NAME="EricPathPickerDialog.setPickerPath" ID="EricPathPickerDialog.setPickerPath"></a>
 <h4>EricPathPickerDialog.setPickerPath</h4>
-<b>setPickerPath</b>(<i>path</i>)
+<b>setPickerPath</b>(<i>fpath</i>)
 
 <p>
         Public method to set the path of the path picker.
 </p>
 <dl>
 
-<dt><i>path</i> (str)</dt>
+<dt><i>fpath</i> (str or pathlib.Path)</dt>
 <dd>
 path to be set
 </dd>
@@ -223,7 +250,7 @@
 <hr />
 <a NAME="getPath" ID="getPath"></a>
 <h2>getPath</h2>
-<b>getPath</b>(<i>parent, title, label, mode=EricPathPickerModes.OPEN_FILE_MODE, path="", defaultDirectory="", filters=None, </i>)
+<b>getPath</b>(<i>parent, title, label, mode=EricPathPickerModes.OPEN_FILE_MODE, pathlibPath=None, defaultDirectory=None, filters=None, </i>)
 
 <p>
     Function to get a file or directory path from the user.
@@ -242,22 +269,77 @@
 <dd>
 text to be shown above the path picker
 </dd>
-<dt><i>mode</i> (EricPathPickerModes)</dt>
+<dt><i>mode</i> (EricPathPickerModes (optional))</dt>
 <dd>
-mode of the path picker
+mode of the path picker (defaults to EricPathPickerModes.OPEN_FILE_MODE)
 </dd>
-<dt><i>path</i> (str)</dt>
+<dt><i>pathlibPath</i> (pathlib.Path (optional))</dt>
 <dd>
-initial path to be shown
+initial path to be shown (defaults to None)
 </dd>
-<dt><i>defaultDirectory</i> (str)</dt>
+<dt><i>defaultDirectory</i> (pathlib.Path (optional))</dt>
 <dd>
 default directory of the path picker selection
-        dialog
+        dialog (defaults to None)
+</dd>
+<dt><i>filters</i> (list of str (optional))</dt>
+<dd>
+list of file filters (defaults to None)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing the entered path and a flag indicating that the
+        user pressed the OK button
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (pathlib.Path, bool)
 </dd>
-<dt><i>filters</i> (list of str)</dt>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getStrPath" ID="getStrPath"></a>
+<h2>getStrPath</h2>
+<b>getStrPath</b>(<i>parent, title, label, mode=EricPathPickerModes.OPEN_FILE_MODE, strPath=None, defaultDirectory=None, filters=None, </i>)
+
+<p>
+    Function to get a file or directory path from the user.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+reference to the parent widget
+</dd>
+<dt><i>title</i> (str)</dt>
 <dd>
-list of file filters
+title of the dialog
+</dd>
+<dt><i>label</i> (str)</dt>
+<dd>
+text to be shown above the path picker
+</dd>
+<dt><i>mode</i> (EricPathPickerModes (optional))</dt>
+<dd>
+mode of the path picker (defaults to EricPathPickerModes.OPEN_FILE_MODE)
+</dd>
+<dt><i>strPath</i> (str (optional))</dt>
+<dd>
+initial path to be shown (defaults to None)
+</dd>
+<dt><i>defaultDirectory</i> (str (optional))</dt>
+<dd>
+default directory of the path picker selection
+        dialog (defaults to None)
+</dd>
+<dt><i>filters</i> (list of str (optional))</dt>
+<dd>
+list of file filters (defaults to None)
 </dd>
 </dl>
 <dl>