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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9236
db53a9efe7ef
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPickerDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,278 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricWidgets.EricPathPickerDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<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>
+</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>
+</tr>
+<tr>
+<td><a href="#EricPathPickerDialog.getPath">getPath</a></td>
+<td>Public method to get the current path.</td>
+</tr>
+<tr>
+<td><a href="#EricPathPickerDialog.setDefaultDirectory">setDefaultDirectory</a></td>
+<td>Public method to set the default directory of the path picker.</td>
+</tr>
+<tr>
+<td><a href="#EricPathPickerDialog.setLabelText">setLabelText</a></td>
+<td>Public method to set the label text.</td>
+</tr>
+<tr>
+<td><a href="#EricPathPickerDialog.setPickerFilters">setPickerFilters</a></td>
+<td>Public method to set the filters of the path picker.</td>
+</tr>
+<tr>
+<td><a href="#EricPathPickerDialog.setPickerMode">setPickerMode</a></td>
+<td>Public method to set the mode of the path picker.</td>
+</tr>
+<tr>
+<td><a href="#EricPathPickerDialog.setPickerPath">setPickerPath</a></td>
+<td>Public method to set the path of the path picker.</td>
+</tr>
+<tr>
+<td><a href="#EricPathPickerDialog.setTitle">setTitle</a></td>
+<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>
+<dd>
+reference to the parent widget
+</dd>
+</dl>
+<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.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+current path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<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)</dt>
+<dd>
+default directory
+</dd>
+</dl>
+<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>
+<dd>
+label text
+</dd>
+</dl>
+<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>
+<dd>
+string containing the file filters
+</dd>
+</dl>
+<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>
+<dd>
+picker mode
+</dd>
+</dl>
+<a NAME="EricPathPickerDialog.setPickerPath" ID="EricPathPickerDialog.setPickerPath"></a>
+<h4>EricPathPickerDialog.setPickerPath</h4>
+<b>setPickerPath</b>(<i>path</i>)
+
+<p>
+        Public method to set the path of the path picker.
+</p>
+<dl>
+
+<dt><i>path</i> (str)</dt>
+<dd>
+path to be set
+</dd>
+</dl>
+<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>
+<dd>
+window title
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<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>)
+
+<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>
+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)</dt>
+<dd>
+mode of the path picker
+</dd>
+<dt><i>path</i> (str)</dt>
+<dd>
+initial path to be shown
+</dd>
+<dt><i>defaultDirectory</i> (str)</dt>
+<dd>
+default directory of the path picker selection
+        dialog
+</dd>
+<dt><i>filters</i> (list of str)</dt>
+<dd>
+list of file filters
+</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 (str, bool)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial