--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPicker.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricPathPicker.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.EricWidgets.EricPathPicker</h1>
-
<p>
Module implementing a path picker widget.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#EricComboPathPicker">EricComboPathPicker</a></td>
<td>Class implementing a path picker widget consisting of a combobox and a tool button to open a file dialog.</td>
@@ -37,36 +35,35 @@
<td>Class implementing the path picker modes.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="EricComboPathPicker" ID="EricComboPathPicker"></a>
<h2>EricComboPathPicker</h2>
-
<p>
Class implementing a path picker widget consisting of a combobox and a
tool button to open a file dialog.
</p>
+
<h3>Derived from</h3>
EricPathPickerBase
<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="#EricComboPathPicker.__init__">EricComboPathPicker</a></td>
<td>Constructor</td>
@@ -80,19 +77,20 @@
<td>Public method to get the list of remembered paths.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricComboPathPicker.__init__" ID="EricComboPathPicker.__init__"></a>
<h4>EricComboPathPicker (Constructor)</h4>
<b>EricComboPathPicker</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -103,10 +101,10 @@
<a NAME="EricComboPathPicker.getPathItems" ID="EricComboPathPicker.getPathItems"></a>
<h4>EricComboPathPicker.getPathItems</h4>
<b>getPathItems</b>(<i></i>)
-
<p>
Public method to get the list of remembered paths.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -122,10 +120,10 @@
<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>
@@ -143,45 +141,44 @@
<hr />
<a NAME="EricPathPicker" ID="EricPathPicker"></a>
<h2>EricPathPicker</h2>
-
<p>
Class implementing a path picker widget consisting of a line edit and a
tool button to open a file dialog.
</p>
+
<h3>Derived from</h3>
EricPathPickerBase
<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="#EricPathPicker.__init__">EricPathPicker</a></td>
<td>Constructor</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricPathPicker.__init__" ID="EricPathPicker.__init__"></a>
<h4>EricPathPicker (Constructor)</h4>
<b>EricPathPicker</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -194,11 +191,11 @@
<hr />
<a NAME="EricPathPickerBase" ID="EricPathPickerBase"></a>
<h2>EricPathPickerBase</h2>
-
<p>
Class implementing the base of a path picker widget consisting of a
line edit or combo box and a tool button to open a file dialog.
</p>
+
<h3>Signals</h3>
<dl>
@@ -230,19 +227,17 @@
<h3>Derived from</h3>
QWidget
<h3>Class Attributes</h3>
-
<table>
<tr><td>DefaultMode</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#EricPathPickerBase.__init__">EricPathPickerBase</a></td>
<td>Constructor</td>
@@ -420,19 +415,20 @@
<td>Public method to get the path picker dialog's window title.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="EricPathPickerBase.__init__" ID="EricPathPickerBase.__init__"></a>
<h4>EricPathPickerBase (Constructor)</h4>
<b>EricPathPickerBase</b>(<i>parent=None, useLineEdit=True</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -447,10 +443,10 @@
<a NAME="EricPathPickerBase.__pathEdited" ID="EricPathPickerBase.__pathEdited"></a>
<h4>EricPathPickerBase.__pathEdited</h4>
<b>__pathEdited</b>(<i>fpath</i>)
-
<p>
Private slot handling editing of the path.
</p>
+
<dl>
<dt><i>fpath</i> (str)</dt>
@@ -461,17 +457,17 @@
<a NAME="EricPathPickerBase.__showPathPickerDialog" ID="EricPathPickerBase.__showPathPickerDialog"></a>
<h4>EricPathPickerBase.__showPathPickerDialog</h4>
<b>__showPathPickerDialog</b>(<i></i>)
-
<p>
Private slot to show the path picker dialog.
</p>
+
<a NAME="EricPathPickerBase._editorText" ID="EricPathPickerBase._editorText"></a>
<h4>EricPathPickerBase._editorText</h4>
<b>_editorText</b>(<i></i>)
-
<p>
Protected method to get the text of the editor.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -487,10 +483,10 @@
<a NAME="EricPathPickerBase._setEditorText" ID="EricPathPickerBase._setEditorText"></a>
<h4>EricPathPickerBase._setEditorText</h4>
<b>_setEditorText</b>(<i>text</i>)
-
<p>
Protected method to set the text of the editor.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -501,10 +497,10 @@
<a NAME="EricPathPickerBase.addItem" ID="EricPathPickerBase.addItem"></a>
<h4>EricPathPickerBase.addItem</h4>
<b>addItem</b>(<i>fpath</i>)
-
<p>
Public method to add a paths to the current list.
</p>
+
<dl>
<dt><i>fpath</i> (str or pathlib.Path)</dt>
@@ -515,10 +511,10 @@
<a NAME="EricPathPickerBase.addItems" ID="EricPathPickerBase.addItems"></a>
<h4>EricPathPickerBase.addItems</h4>
<b>addItems</b>(<i>pathsList</i>)
-
<p>
Public method to add paths to the current list.
</p>
+
<dl>
<dt><i>pathsList</i> (list of str or pathlib.Path)</dt>
@@ -529,10 +525,10 @@
<a NAME="EricPathPickerBase.buttonToolTip" ID="EricPathPickerBase.buttonToolTip"></a>
<h4>EricPathPickerBase.buttonToolTip</h4>
<b>buttonToolTip</b>(<i></i>)
-
<p>
Public method to get the tool button tool tip.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -548,24 +544,24 @@
<a NAME="EricPathPickerBase.clear" ID="EricPathPickerBase.clear"></a>
<h4>EricPathPickerBase.clear</h4>
<b>clear</b>(<i></i>)
-
<p>
Public method to clear the current path or list of paths.
</p>
+
<a NAME="EricPathPickerBase.clearEditText" ID="EricPathPickerBase.clearEditText"></a>
<h4>EricPathPickerBase.clearEditText</h4>
<b>clearEditText</b>(<i></i>)
-
<p>
Public method to clear the current path.
</p>
+
<a NAME="EricPathPickerBase.currentText" ID="EricPathPickerBase.currentText"></a>
<h4>EricPathPickerBase.currentText</h4>
<b>currentText</b>(<i>toNative=True</i>)
-
<p>
Public method to get the current path.
</p>
+
<dl>
<dt><i>toNative</i> (bool)</dt>
@@ -589,10 +585,10 @@
<a NAME="EricPathPickerBase.defaultDirectory" ID="EricPathPickerBase.defaultDirectory"></a>
<h4>EricPathPickerBase.defaultDirectory</h4>
<b>defaultDirectory</b>(<i></i>)
-
<p>
Public method to get the default directory.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -608,10 +604,10 @@
<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>
@@ -627,10 +623,10 @@
<a NAME="EricPathPickerBase.editorEnabled" ID="EricPathPickerBase.editorEnabled"></a>
<h4>EricPathPickerBase.editorEnabled</h4>
<b>editorEnabled</b>(<i></i>)
-
<p>
Public method to get the path editor's enabled state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -646,10 +642,10 @@
<a NAME="EricPathPickerBase.editorToolTip" ID="EricPathPickerBase.editorToolTip"></a>
<h4>EricPathPickerBase.editorToolTip</h4>
<b>editorToolTip</b>(<i></i>)
-
<p>
Public method to get the editor tool tip.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -665,10 +661,10 @@
<a NAME="EricPathPickerBase.filters" ID="EricPathPickerBase.filters"></a>
<h4>EricPathPickerBase.filters</h4>
<b>filters</b>(<i></i>)
-
<p>
Public methods to get the filter string.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -684,10 +680,10 @@
<a NAME="EricPathPickerBase.firstPath" ID="EricPathPickerBase.firstPath"></a>
<h4>EricPathPickerBase.firstPath</h4>
<b>firstPath</b>(<i></i>)
-
<p>
Public method to get the first path of a list of entered paths.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -703,10 +699,10 @@
<a NAME="EricPathPickerBase.isPickerEnabled" ID="EricPathPickerBase.isPickerEnabled"></a>
<h4>EricPathPickerBase.isPickerEnabled</h4>
<b>isPickerEnabled</b>(<i></i>)
-
<p>
Public method to get the file dialog button enabled state.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -722,10 +718,10 @@
<a NAME="EricPathPickerBase.isReadOnly" ID="EricPathPickerBase.isReadOnly"></a>
<h4>EricPathPickerBase.isReadOnly</h4>
<b>isReadOnly</b>(<i></i>)
-
<p>
Public method to check the path picker for read only mode.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -741,10 +737,10 @@
<a NAME="EricPathPickerBase.lastPath" ID="EricPathPickerBase.lastPath"></a>
<h4>EricPathPickerBase.lastPath</h4>
<b>lastPath</b>(<i></i>)
-
<p>
Public method to get the last path of a list of entered paths.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -760,10 +756,10 @@
<a NAME="EricPathPickerBase.mode" ID="EricPathPickerBase.mode"></a>
<h4>EricPathPickerBase.mode</h4>
<b>mode</b>(<i></i>)
-
<p>
Public method to get the path picker mode.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -779,10 +775,10 @@
<a NAME="EricPathPickerBase.path" ID="EricPathPickerBase.path"></a>
<h4>EricPathPickerBase.path</h4>
<b>path</b>(<i></i>)
-
<p>
Public method to get the current path.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -798,10 +794,10 @@
<a NAME="EricPathPickerBase.paths" ID="EricPathPickerBase.paths"></a>
<h4>EricPathPickerBase.paths</h4>
<b>paths</b>(<i></i>)
-
<p>
Public method to get the list of entered paths.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -817,10 +813,10 @@
<a NAME="EricPathPickerBase.setButtonToolTip" ID="EricPathPickerBase.setButtonToolTip"></a>
<h4>EricPathPickerBase.setButtonToolTip</h4>
<b>setButtonToolTip</b>(<i>tooltip</i>)
-
<p>
Public method to set the tool button tool tip.
</p>
+
<dl>
<dt><i>tooltip</i> (str)</dt>
@@ -831,10 +827,10 @@
<a NAME="EricPathPickerBase.setCurrentIndex" ID="EricPathPickerBase.setCurrentIndex"></a>
<h4>EricPathPickerBase.setCurrentIndex</h4>
<b>setCurrentIndex</b>(<i>index</i>)
-
<p>
Public slot to set the current index.
</p>
+
<dl>
<dt><i>index</i> (int)</dt>
@@ -845,10 +841,10 @@
<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>
@@ -859,10 +855,10 @@
<a NAME="EricPathPickerBase.setCurrentText" ID="EricPathPickerBase.setCurrentText"></a>
<h4>EricPathPickerBase.setCurrentText</h4>
<b>setCurrentText</b>(<i>text</i>)
-
<p>
Public slot to set the current text.
</p>
+
<dl>
<dt><i>text</i> (str)</dt>
@@ -873,10 +869,10 @@
<a NAME="EricPathPickerBase.setDefaultDirectory" ID="EricPathPickerBase.setDefaultDirectory"></a>
<h4>EricPathPickerBase.setDefaultDirectory</h4>
<b>setDefaultDirectory</b>(<i>directory</i>)
-
<p>
Public method to set the default directory.
</p>
+
<dl>
<dt><i>directory</i> (str or pathlib.Path)</dt>
@@ -887,10 +883,10 @@
<a NAME="EricPathPickerBase.setEditText" ID="EricPathPickerBase.setEditText"></a>
<h4>EricPathPickerBase.setEditText</h4>
<b>setEditText</b>(<i>fpath, toNative=True</i>)
-
<p>
Public method to set the current path.
</p>
+
<dl>
<dt><i>fpath</i> (str)</dt>
@@ -906,10 +902,10 @@
<a NAME="EricPathPickerBase.setEditorEnabled" ID="EricPathPickerBase.setEditorEnabled"></a>
<h4>EricPathPickerBase.setEditorEnabled</h4>
<b>setEditorEnabled</b>(<i>enable</i>)
-
<p>
Public method to set the path editor's enabled state.
</p>
+
<dl>
<dt><i>enable</i> (bool)</dt>
@@ -920,10 +916,10 @@
<a NAME="EricPathPickerBase.setEditorToolTip" ID="EricPathPickerBase.setEditorToolTip"></a>
<h4>EricPathPickerBase.setEditorToolTip</h4>
<b>setEditorToolTip</b>(<i>tooltip</i>)
-
<p>
Public method to set the editor tool tip.
</p>
+
<dl>
<dt><i>tooltip</i> (str)</dt>
@@ -934,13 +930,13 @@
<a NAME="EricPathPickerBase.setFilters" ID="EricPathPickerBase.setFilters"></a>
<h4>EricPathPickerBase.setFilters</h4>
<b>setFilters</b>(<i>filters</i>)
-
<p>
Public method to set the filters for the path picker dialog.
</p>
<p>
Note: Multiple filters must be separated by ';;'.
</p>
+
<dl>
<dt><i>filters</i> (str)</dt>
@@ -951,10 +947,10 @@
<a NAME="EricPathPickerBase.setInsertPolicy" ID="EricPathPickerBase.setInsertPolicy"></a>
<h4>EricPathPickerBase.setInsertPolicy</h4>
<b>setInsertPolicy</b>(<i>policy</i>)
-
<p>
Public method to set the insertion policy of the combo box.
</p>
+
<dl>
<dt><i>policy</i> (QComboBox.InsertPolicy)</dt>
@@ -965,10 +961,10 @@
<a NAME="EricPathPickerBase.setMode" ID="EricPathPickerBase.setMode"></a>
<h4>EricPathPickerBase.setMode</h4>
<b>setMode</b>(<i>mode</i>)
-
<p>
Public method to set the path picker mode.
</p>
+
<dl>
<dt><i>mode</i> (EricPathPickerModes)</dt>
@@ -986,10 +982,10 @@
<a NAME="EricPathPickerBase.setNameFilters" ID="EricPathPickerBase.setNameFilters"></a>
<h4>EricPathPickerBase.setNameFilters</h4>
<b>setNameFilters</b>(<i>filters</i>)
-
<p>
Public method to set the name filters for the completer.
</p>
+
<dl>
<dt><i>filters</i> (list of str)</dt>
@@ -1000,10 +996,10 @@
<a NAME="EricPathPickerBase.setPath" ID="EricPathPickerBase.setPath"></a>
<h4>EricPathPickerBase.setPath</h4>
<b>setPath</b>(<i>fpath</i>)
-
<p>
Public method to set the current path.
</p>
+
<dl>
<dt><i>fpath</i> (str or pathlib.Path)</dt>
@@ -1014,10 +1010,10 @@
<a NAME="EricPathPickerBase.setPathsList" ID="EricPathPickerBase.setPathsList"></a>
<h4>EricPathPickerBase.setPathsList</h4>
<b>setPathsList</b>(<i>pathsList</i>)
-
<p>
Public method to set the paths list.
</p>
+
<dl>
<dt><i>pathsList</i> (list of str or pathlib.Path)</dt>
@@ -1028,10 +1024,10 @@
<a NAME="EricPathPickerBase.setPickerEnabled" ID="EricPathPickerBase.setPickerEnabled"></a>
<h4>EricPathPickerBase.setPickerEnabled</h4>
<b>setPickerEnabled</b>(<i>enable</i>)
-
<p>
Public method to set the enabled state of the file dialog button.
</p>
+
<dl>
<dt><i>enable</i> (bool)</dt>
@@ -1042,10 +1038,10 @@
<a NAME="EricPathPickerBase.setReadOnly" ID="EricPathPickerBase.setReadOnly"></a>
<h4>EricPathPickerBase.setReadOnly</h4>
<b>setReadOnly</b>(<i>readOnly</i>)
-
<p>
Public method to set the path picker to read only mode.
</p>
+
<dl>
<dt><i>readOnly</i> (bool)</dt>
@@ -1056,10 +1052,10 @@
<a NAME="EricPathPickerBase.setSizeAdjustPolicy" ID="EricPathPickerBase.setSizeAdjustPolicy"></a>
<h4>EricPathPickerBase.setSizeAdjustPolicy</h4>
<b>setSizeAdjustPolicy</b>(<i>policy</i>)
-
<p>
Public method to set the size adjust policy of the combo box.
</p>
+
<dl>
<dt><i>policy</i> (QComboBox.SizeAdjustPolicy)</dt>
@@ -1070,10 +1066,10 @@
<a NAME="EricPathPickerBase.setText" ID="EricPathPickerBase.setText"></a>
<h4>EricPathPickerBase.setText</h4>
<b>setText</b>(<i>fpath, toNative=True</i>)
-
<p>
Public method to set the current path.
</p>
+
<dl>
<dt><i>fpath</i> (str)</dt>
@@ -1089,10 +1085,10 @@
<a NAME="EricPathPickerBase.setWindowTitle" ID="EricPathPickerBase.setWindowTitle"></a>
<h4>EricPathPickerBase.setWindowTitle</h4>
<b>setWindowTitle</b>(<i>title</i>)
-
<p>
Public method to set the path picker dialog window title.
</p>
+
<dl>
<dt><i>title</i> (str)</dt>
@@ -1103,10 +1099,10 @@
<a NAME="EricPathPickerBase.text" ID="EricPathPickerBase.text"></a>
<h4>EricPathPickerBase.text</h4>
<b>text</b>(<i>toNative=True</i>)
-
<p>
Public method to get the current path.
</p>
+
<dl>
<dt><i>toNative</i> (bool)</dt>
@@ -1130,10 +1126,10 @@
<a NAME="EricPathPickerBase.windowTitle" ID="EricPathPickerBase.windowTitle"></a>
<h4>EricPathPickerBase.windowTitle</h4>
<b>windowTitle</b>(<i></i>)
-
<p>
Public method to get the path picker dialog's window title.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1151,33 +1147,42 @@
<hr />
<a NAME="EricPathPickerModes" ID="EricPathPickerModes"></a>
<h2>EricPathPickerModes</h2>
-
<p>
Class implementing the path picker modes.
</p>
+
<h3>Derived from</h3>
enum.Enum
<h3>Class Attributes</h3>
-
<table>
-<tr><td>CUSTOM_MODE</td></tr><tr><td>DIRECTORY_MODE</td></tr><tr><td>DIRECTORY_SHOW_FILES_MODE</td></tr><tr><td>NO_MODE</td></tr><tr><td>OPEN_FILES_AND_DIRS_MODE</td></tr><tr><td>OPEN_FILES_MODE</td></tr><tr><td>OPEN_FILE_MODE</td></tr><tr><td>SAVE_FILE_ENSURE_EXTENSION_MODE</td></tr><tr><td>SAVE_FILE_MODE</td></tr><tr><td>SAVE_FILE_OVERWRITE_MODE</td></tr>
+<tr><td>CUSTOM_MODE</td></tr>
+<tr><td>DIRECTORY_MODE</td></tr>
+<tr><td>DIRECTORY_SHOW_FILES_MODE</td></tr>
+<tr><td>NO_MODE</td></tr>
+<tr><td>OPEN_FILES_AND_DIRS_MODE</td></tr>
+<tr><td>OPEN_FILES_MODE</td></tr>
+<tr><td>OPEN_FILE_MODE</td></tr>
+<tr><td>SAVE_FILE_ENSURE_EXTENSION_MODE</td></tr>
+<tr><td>SAVE_FILE_MODE</td></tr>
+<tr><td>SAVE_FILE_OVERWRITE_MODE</td></tr>
</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Static Methods</h3>
-
+<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
