--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPickerDialog.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPickerDialog.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,28 +7,25 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricPathPickerDialog</h1>
-
<p>
Module implementing a dialog to enter a file system path using a file picker.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EricPathPickerDialog">EricPathPickerDialog</a></td>
<td>Class implementing a dialog to enter a file system path using a file picker.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
-
<tr>
<td><a href="#getPath">getPath</a></td>
<td>Function to get a file or directory path from the user.</td>
@@ -38,31 +35,30 @@
<td>Function to get a file or directory path from the user.</td>
</tr>
</table>
+
<hr />
<hr />
<a NAME="EricPathPickerDialog" ID="EricPathPickerDialog"></a>
<h2>EricPathPickerDialog</h2>
-
<p>
Class implementing a dialog to enter a file system path using a file
picker.
</p>
+
<h3>Derived from</h3>
QDialog
<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="#EricPathPickerDialog.__init__">EricPathPickerDialog</a></td>
<td>Constructor</td>
@@ -100,19 +96,20 @@
<td>Public method to set the window title.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricPathPickerDialog.__init__" ID="EricPathPickerDialog.__init__"></a>
<h4>EricPathPickerDialog (Constructor)</h4>
<b>EricPathPickerDialog</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -123,10 +120,10 @@
<a NAME="EricPathPickerDialog.getPath" ID="EricPathPickerDialog.getPath"></a>
<h4>EricPathPickerDialog.getPath</h4>
<b>getPath</b>(<i></i>)
-
<p>
Public method to get the current path as a pathlib.Path object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -142,10 +139,10 @@
<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>
<dd>
@@ -161,10 +158,10 @@
<a NAME="EricPathPickerDialog.setDefaultDirectory" ID="EricPathPickerDialog.setDefaultDirectory"></a>
<h4>EricPathPickerDialog.setDefaultDirectory</h4>
<b>setDefaultDirectory</b>(<i>directory</i>)
-
<p>
Public method to set the default directory of the path picker.
</p>
+
<dl>
<dt><i>directory</i> (str or pathlib.Path)</dt>
@@ -175,10 +172,10 @@
<a NAME="EricPathPickerDialog.setLabelText" ID="EricPathPickerDialog.setLabelText"></a>
<h4>EricPathPickerDialog.setLabelText</h4>
<b>setLabelText</b>(<i>text</i>)
-
<p>
Public method to set the label text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -189,13 +186,13 @@
<a NAME="EricPathPickerDialog.setPickerFilters" ID="EricPathPickerDialog.setPickerFilters"></a>
<h4>EricPathPickerDialog.setPickerFilters</h4>
<b>setPickerFilters</b>(<i>filters</i>)
-
<p>
Public method to set the filters of the path picker.
</p>
<p>
Note: Multiple filters must be separated by ';;'.
</p>
+
<dl>
<dt><i>filters</i> (str)</dt>
@@ -206,10 +203,10 @@
<a NAME="EricPathPickerDialog.setPickerMode" ID="EricPathPickerDialog.setPickerMode"></a>
<h4>EricPathPickerDialog.setPickerMode</h4>
<b>setPickerMode</b>(<i>mode</i>)
-
<p>
Public method to set the mode of the path picker.
</p>
+
<dl>
<dt><i>mode</i> (EricPathPickerModes)</dt>
@@ -220,10 +217,10 @@
<a NAME="EricPathPickerDialog.setPickerPath" ID="EricPathPickerDialog.setPickerPath"></a>
<h4>EricPathPickerDialog.setPickerPath</h4>
<b>setPickerPath</b>(<i>fpath</i>)
-
<p>
Public method to set the path of the path picker.
</p>
+
<dl>
<dt><i>fpath</i> (str or pathlib.Path)</dt>
@@ -234,10 +231,10 @@
<a NAME="EricPathPickerDialog.setTitle" ID="EricPathPickerDialog.setTitle"></a>
<h4>EricPathPickerDialog.setTitle</h4>
<b>setTitle</b>(<i>title</i>)
-
<p>
Public method to set the window title.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -251,10 +248,10 @@
<a NAME="getPath" ID="getPath"></a>
<h2>getPath</h2>
<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.
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -306,10 +303,10 @@
<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>
@@ -357,4 +354,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
