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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9239
3c605ab5a8c7
diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,471 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.EricWidgets.EricFileDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.EricWidgets.EricFileDialog</h1>
+
+<p>
+Module implementing alternative functions for the QFileDialog static methods.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>DontConfirmOverwrite</td></tr><tr><td>DontResolveSymlinks</td></tr><tr><td>DontUseCustomDirectoryIcons</td></tr><tr><td>DontUseNativeDialog</td></tr><tr><td>HideNameFilterDetails</td></tr><tr><td>Option</td></tr><tr><td>ReadOnly</td></tr><tr><td>ShowDirsOnly</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#__reorderFilter">__reorderFilter</a></td>
+<td>Private function to reorder the file filter to cope with a KDE issue introduced by distributor's usage of KDE file dialogs.</td>
+</tr>
+<tr>
+<td><a href="#getExistingDirectory">getExistingDirectory</a></td>
+<td>Module function to get the name of a directory.</td>
+</tr>
+<tr>
+<td><a href="#getOpenFileAndDirNames">getOpenFileAndDirNames</a></td>
+<td>Module function to get the names of files and directories for opening.</td>
+</tr>
+<tr>
+<td><a href="#getOpenFileName">getOpenFileName</a></td>
+<td>Module function to get the name of a file for opening it.</td>
+</tr>
+<tr>
+<td><a href="#getOpenFileNameAndFilter">getOpenFileNameAndFilter</a></td>
+<td>Module function to get the name of a file for opening it and the selected file name filter.</td>
+</tr>
+<tr>
+<td><a href="#getOpenFileNames">getOpenFileNames</a></td>
+<td>Module function to get a list of names of files for opening.</td>
+</tr>
+<tr>
+<td><a href="#getOpenFileNamesAndFilter">getOpenFileNamesAndFilter</a></td>
+<td>Module function to get a list of names of files for opening and the selected file name filter.</td>
+</tr>
+<tr>
+<td><a href="#getSaveFileName">getSaveFileName</a></td>
+<td>Module function to get the name of a file for saving it.</td>
+</tr>
+<tr>
+<td><a href="#getSaveFileNameAndFilter">getSaveFileNameAndFilter</a></td>
+<td>Module function to get the name of a file for saving it and the selected file name filter.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="__reorderFilter" ID="__reorderFilter"></a>
+<h2>__reorderFilter</h2>
+<b>__reorderFilter</b>(<i>filterStr, initialFilter=""</i>)
+
+<p>
+    Private function to reorder the file filter to cope with a KDE issue
+    introduced by distributor's usage of KDE file dialogs.
+</p>
+<dl>
+
+<dt><i>filterStr</i> (str)</dt>
+<dd>
+Qt file filter
+</dd>
+<dt><i>initialFilter</i> (str)</dt>
+<dd>
+initial filter
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the rearranged Qt file filter
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getExistingDirectory" ID="getExistingDirectory"></a>
+<h2>getExistingDirectory</h2>
+<b>getExistingDirectory</b>(<i>parent=None, caption="", directory="", options=QFileDialog.Option.ShowDirsOnly</i>)
+
+<p>
+    Module function to get the name of a directory.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget of the dialog
+</dd>
+<dt><i>caption</i> (str)</dt>
+<dd>
+window title of the dialog
+</dd>
+<dt><i>directory</i> (str)</dt>
+<dd>
+working directory of the dialog
+</dd>
+<dt><i>options</i> (QFileDialog.Options)</dt>
+<dd>
+various options for the dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+name of selected directory
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getOpenFileAndDirNames" ID="getOpenFileAndDirNames"></a>
+<h2>getOpenFileAndDirNames</h2>
+<b>getOpenFileAndDirNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+
+<p>
+    Module function to get the names of files and directories for opening.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget of the dialog
+</dd>
+<dt><i>caption</i> (str)</dt>
+<dd>
+window title of the dialog
+</dd>
+<dt><i>directory</i> (str)</dt>
+<dd>
+working directory of the dialog
+</dd>
+<dt><i>filterStr</i> (str)</dt>
+<dd>
+filter string for the dialog
+</dd>
+<dt><i>options</i> (QFileDialog.Options)</dt>
+<dd>
+various options for the dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+names of the selected files and folders
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getOpenFileName" ID="getOpenFileName"></a>
+<h2>getOpenFileName</h2>
+<b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+
+<p>
+    Module function to get the name of a file for opening it.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget of the dialog
+</dd>
+<dt><i>caption</i> (str)</dt>
+<dd>
+window title of the dialog
+</dd>
+<dt><i>directory</i> (str)</dt>
+<dd>
+working directory of the dialog
+</dd>
+<dt><i>filterStr</i> (str)</dt>
+<dd>
+filter string for the dialog
+</dd>
+<dt><i>options</i> (QFileDialog.Options)</dt>
+<dd>
+various options for the dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+name of file to be opened
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getOpenFileNameAndFilter" ID="getOpenFileNameAndFilter"></a>
+<h2>getOpenFileNameAndFilter</h2>
+<b>getOpenFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
+
+<p>
+    Module function to get the name of a file for opening it and the selected
+    file name filter.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget of the dialog
+</dd>
+<dt><i>caption</i> (str)</dt>
+<dd>
+window title of the dialog
+</dd>
+<dt><i>directory</i> (str)</dt>
+<dd>
+working directory of the dialog
+</dd>
+<dt><i>filterStr</i> (str)</dt>
+<dd>
+filter string for the dialog
+</dd>
+<dt><i>initialFilter</i> (str)</dt>
+<dd>
+initial filter for the dialog
+</dd>
+<dt><i>options</i> (QFileDialog.Options)</dt>
+<dd>
+various options for the dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+name of file to be opened and selected filter
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getOpenFileNames" ID="getOpenFileNames"></a>
+<h2>getOpenFileNames</h2>
+<b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+
+<p>
+    Module function to get a list of names of files for opening.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget of the dialog
+</dd>
+<dt><i>caption</i> (str)</dt>
+<dd>
+window title of the dialog
+</dd>
+<dt><i>directory</i> (str)</dt>
+<dd>
+working directory of the dialog
+</dd>
+<dt><i>filterStr</i> (str)</dt>
+<dd>
+filter string for the dialog
+</dd>
+<dt><i>options</i> (QFileDialog.Options)</dt>
+<dd>
+various options for the dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of file names to be opened
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getOpenFileNamesAndFilter" ID="getOpenFileNamesAndFilter"></a>
+<h2>getOpenFileNamesAndFilter</h2>
+<b>getOpenFileNamesAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
+
+<p>
+    Module function to get a list of names of files for opening and the
+    selected file name filter.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget of the dialog
+</dd>
+<dt><i>caption</i> (str)</dt>
+<dd>
+window title of the dialog
+</dd>
+<dt><i>directory</i> (str)</dt>
+<dd>
+working directory of the dialog
+</dd>
+<dt><i>filterStr</i> (str)</dt>
+<dd>
+filter string for the dialog
+</dd>
+<dt><i>initialFilter</i> (str)</dt>
+<dd>
+initial filter for the dialog
+</dd>
+<dt><i>options</i> (QFileDialog.Options)</dt>
+<dd>
+various options for the dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of file names to be opened and selected filter
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (list of str, str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getSaveFileName" ID="getSaveFileName"></a>
+<h2>getSaveFileName</h2>
+<b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+
+<p>
+    Module function to get the name of a file for saving it.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget of the dialog
+</dd>
+<dt><i>caption</i> (str)</dt>
+<dd>
+window title of the dialog
+</dd>
+<dt><i>directory</i> (str)</dt>
+<dd>
+working directory of the dialog
+</dd>
+<dt><i>filterStr</i> (str)</dt>
+<dd>
+filter string for the dialog
+</dd>
+<dt><i>options</i> (QFileDialog.Options)</dt>
+<dd>
+various options for the dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+name of file to be saved
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getSaveFileNameAndFilter" ID="getSaveFileNameAndFilter"></a>
+<h2>getSaveFileNameAndFilter</h2>
+<b>getSaveFileNameAndFilter</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
+
+<p>
+    Module function to get the name of a file for saving it and the selected
+    file name filter.
+</p>
+<dl>
+
+<dt><i>parent</i> (QWidget)</dt>
+<dd>
+parent widget of the dialog
+</dd>
+<dt><i>caption</i> (str)</dt>
+<dd>
+window title of the dialog
+</dd>
+<dt><i>directory</i> (str)</dt>
+<dd>
+working directory of the dialog
+</dd>
+<dt><i>filterStr</i> (str)</dt>
+<dd>
+filter string for the dialog
+</dd>
+<dt><i>initialFilter</i> (str)</dt>
+<dd>
+initial filter for the dialog
+</dd>
+<dt><i>options</i> (QFileDialog.Options)</dt>
+<dd>
+various options for the dialog
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+name of file to be saved and selected filte
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial