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

branch
eric7
changeset 10538
decb03459cd4
parent 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.html	Thu Feb 01 15:44:36 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.html	Thu Feb 01 15:44:59 2024 +0100
@@ -116,9 +116,9 @@
 <dd>
 Qt file filter
 </dd>
-<dt><i>initialFilter</i> (str)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-initial filter
+initial filter (defaults to "")
 </dd>
 </dl>
 <dl>
@@ -145,21 +145,22 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to
+        QFileDialog.Option.ShowDirsOnly)
 </dd>
 </dl>
 <dl>
@@ -186,21 +187,22 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str or pathlib.Path)</dt>
+<dt><i>directory</i> (str or pathlib.Path (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to
+        QFileDialog.Option.ShowDirsOnly)
 </dd>
 </dl>
 <dl>
@@ -228,29 +230,29 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str or pathlib.Path)</dt>
+<dt><i>directory</i> (str or pathlib.Path (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>initialFilter</i> (str)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-initial filter for the dialog
+initial filter for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -277,25 +279,25 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -322,25 +324,25 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str or pathlib.Path)</dt>
+<dt><i>directory</i> (str or pathlib.Path (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -360,32 +362,36 @@
 <hr />
 <a NAME="getOpenFileName" ID="getOpenFileName"></a>
 <h2>getOpenFileName</h2>
-<b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+<b>getOpenFileName</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
 <p>
     Module function to get the name of a file for opening it.
 </p>
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-various options for the dialog
+initial filter for the dialog (defaults to "")
+</dd>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
+<dd>
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -413,29 +419,29 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>initialFilter</i> (str)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-initial filter for the dialog
+initial filter for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -455,32 +461,36 @@
 <hr />
 <a NAME="getOpenFileNames" ID="getOpenFileNames"></a>
 <h2>getOpenFileNames</h2>
-<b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+<b>getOpenFileNames</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
 <p>
     Module function to get a list of names of files for opening.
 </p>
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-various options for the dialog
+initial filter for the dialog (defaults to "")
+</dd>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
+<dd>
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -508,29 +518,29 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>initialFilter</i> (str)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-initial filter for the dialog
+initial filter for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -550,32 +560,36 @@
 <hr />
 <a NAME="getOpenFilePath" ID="getOpenFilePath"></a>
 <h2>getOpenFilePath</h2>
-<b>getOpenFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+<b>getOpenFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
 <p>
     Module function to get the path of a file for opening it.
 </p>
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str or pathlib.Path)</dt>
+<dt><i>directory</i> (str or pathlib.Path (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-various options for the dialog
+initial filter for the dialog (defaults to "")
+</dd>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
+<dd>
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -603,29 +617,29 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str or pathlib.Path)</dt>
+<dt><i>directory</i> (str or pathlib.Path (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>initialFilter</i> (str)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-initial filter for the dialog
+initial filter for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -645,32 +659,36 @@
 <hr />
 <a NAME="getOpenFilePaths" ID="getOpenFilePaths"></a>
 <h2>getOpenFilePaths</h2>
-<b>getOpenFilePaths</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+<b>getOpenFilePaths</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
 <p>
     Module function to get a list of paths of files for opening.
 </p>
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str or pathlib.Path)</dt>
+<dt><i>directory</i> (str or pathlib.Path (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-various options for the dialog
+initial filter for the dialog (defaults to "")
+</dd>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
+<dd>
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -690,32 +708,36 @@
 <hr />
 <a NAME="getSaveFileName" ID="getSaveFileName"></a>
 <h2>getSaveFileName</h2>
-<b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+<b>getSaveFileName</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
 <p>
     Module function to get the name of a file for saving.
 </p>
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-various options for the dialog
+initial filter for the dialog (defaults to "")
+</dd>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
+<dd>
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -743,29 +765,29 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str)</dt>
+<dt><i>directory</i> (str (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>initialFilter</i> (str)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-initial filter for the dialog
+initial filter for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -785,32 +807,36 @@
 <hr />
 <a NAME="getSaveFilePath" ID="getSaveFilePath"></a>
 <h2>getSaveFilePath</h2>
-<b>getSaveFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", options=None</i>)
+<b>getSaveFilePath</b>(<i>parent=None, caption="", directory="", filterStr="", initialFilter="", options=None</i>)
 <p>
     Module function to get the path of a file for saving.
 </p>
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str or pathlib.Path)</dt>
+<dt><i>directory</i> (str or pathlib.Path (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-various options for the dialog
+initial filter for the dialog (defaults to "")
+</dd>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
+<dd>
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>
@@ -838,29 +864,29 @@
 
 <dl>
 
-<dt><i>parent</i> (QWidget)</dt>
+<dt><i>parent</i> (QWidget (optional))</dt>
 <dd>
-parent widget of the dialog
+parent widget of the dialog (defaults to None)
 </dd>
-<dt><i>caption</i> (str)</dt>
+<dt><i>caption</i> (str (optional))</dt>
 <dd>
-window title of the dialog
+window title of the dialog (defaults to "")
 </dd>
-<dt><i>directory</i> (str or pathlib.Path)</dt>
+<dt><i>directory</i> (str or pathlib.Path (optional))</dt>
 <dd>
-working directory of the dialog
+working directory of the dialog (defaults to "")
 </dd>
-<dt><i>filterStr</i> (str)</dt>
+<dt><i>filterStr</i> (str (optional))</dt>
 <dd>
-filter string for the dialog
+filter string for the dialog (defaults to "")
 </dd>
-<dt><i>initialFilter</i> (str)</dt>
+<dt><i>initialFilter</i> (str (optional))</dt>
 <dd>
-initial filter for the dialog
+initial filter for the dialog (defaults to "")
 </dd>
-<dt><i>options</i> (QFileDialog.Options)</dt>
+<dt><i>options</i> (QFileDialog.Options ((optional))</dt>
 <dd>
-various options for the dialog
+various options for the dialog (defaults to None)
 </dd>
 </dl>
 <dl>

eric ide

mercurial