Mercurial Repositories > eric / changeset

changeset

Updated source code documentation. eric7

Thu, 01 Feb 2024 15:44:59 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 01 Feb 2024 15:44:59 +0100
branch
eric7
changeset 10538
decb03459cd4
parent 10537
cd0fd14d09d5
child 10540
7631c0ba2877

Updated source code documentation.

src/eric7/APIs/Python3/eric7.api file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
src/eric7/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.EricNetwork.EricJsonClient.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.EricWidgets.EricFileDialog.html file | annotate | diff | comparison | revisions
src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQFileDialog.html file | annotate | diff | comparison | revisions 
--- a/src/eric7/APIs/Python3/eric7.api	Thu Feb 01 15:44:36 2024 +0100
+++ b/src/eric7/APIs/Python3/eric7.api	Thu Feb 01 15:44:59 2024 +0100
@@ -1384,16 +1384,16 @@
 eric7.EricWidgets.EricFileDialog.getOpenFilPathsAndFilter?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
 eric7.EricWidgets.EricFileDialog.getOpenFileAndDirNames?4(parent=None, caption="", directory="", filterStr="", options=None)
 eric7.EricWidgets.EricFileDialog.getOpenFileAndDirPaths?4(parent=None, caption="", directory="", filterStr="", options=None)
-eric7.EricWidgets.EricFileDialog.getOpenFileName?4(parent=None, caption="", directory="", filterStr="", options=None)
+eric7.EricWidgets.EricFileDialog.getOpenFileName?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
 eric7.EricWidgets.EricFileDialog.getOpenFileNameAndFilter?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
-eric7.EricWidgets.EricFileDialog.getOpenFileNames?4(parent=None, caption="", directory="", filterStr="", options=None)
+eric7.EricWidgets.EricFileDialog.getOpenFileNames?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
 eric7.EricWidgets.EricFileDialog.getOpenFileNamesAndFilter?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
-eric7.EricWidgets.EricFileDialog.getOpenFilePath?4(parent=None, caption="", directory="", filterStr="", options=None)
+eric7.EricWidgets.EricFileDialog.getOpenFilePath?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
 eric7.EricWidgets.EricFileDialog.getOpenFilePathAndFilter?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
-eric7.EricWidgets.EricFileDialog.getOpenFilePaths?4(parent=None, caption="", directory="", filterStr="", options=None)
-eric7.EricWidgets.EricFileDialog.getSaveFileName?4(parent=None, caption="", directory="", filterStr="", options=None)
+eric7.EricWidgets.EricFileDialog.getOpenFilePaths?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
+eric7.EricWidgets.EricFileDialog.getSaveFileName?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
 eric7.EricWidgets.EricFileDialog.getSaveFileNameAndFilter?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
-eric7.EricWidgets.EricFileDialog.getSaveFilePath?4(parent=None, caption="", directory="", filterStr="", options=None)
+eric7.EricWidgets.EricFileDialog.getSaveFilePath?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
 eric7.EricWidgets.EricFileDialog.getSaveFilePathAndFilter?4(parent=None, caption="", directory="", filterStr="", initialFilter="", options=None)
 eric7.EricWidgets.EricFileSaveConfirmDialog.EricFileSaveConfirmDialog.selectedAction?4()
 eric7.EricWidgets.EricFileSaveConfirmDialog.EricFileSaveConfirmDialog?1(filename, title, message="", picker=True, parent=None)
Binary file src/eric7/Documentation/Help/source.qch has changed
--- a/src/eric7/Documentation/Help/source.qhp	Thu Feb 01 15:44:36 2024 +0100
+++ b/src/eric7/Documentation/Help/source.qhp	Thu Feb 01 15:44:59 2024 +0100
@@ -5580,6 +5580,7 @@
       <keyword name="EricJsonClient" id="EricJsonClient" ref="eric7.EricNetwork.EricJsonClient.html#EricJsonClient" />
       <keyword name="EricJsonClient (Constructor)" id="EricJsonClient (Constructor)" ref="eric7.EricNetwork.EricJsonClient.html#EricJsonClient.__init__" />
       <keyword name="EricJsonClient (Module)" id="EricJsonClient (Module)" ref="eric7.EricNetwork.EricJsonClient.html" />
+      <keyword name="EricJsonClient.__receiveBytes" id="EricJsonClient.__receiveBytes" ref="eric7.EricNetwork.EricJsonClient.html#EricJsonClient.__receiveBytes" />
       <keyword name="EricJsonClient.__receiveJson" id="EricJsonClient.__receiveJson" ref="eric7.EricNetwork.EricJsonClient.html#EricJsonClient.__receiveJson" />
       <keyword name="EricJsonClient.handleCall" id="EricJsonClient.handleCall" ref="eric7.EricNetwork.EricJsonClient.html#EricJsonClient.handleCall" />
       <keyword name="EricJsonClient.poll" id="EricJsonClient.poll" ref="eric7.EricNetwork.EricJsonClient.html#EricJsonClient.poll" />
@@ -6695,8 +6696,6 @@
       <keyword name="FileDialogWizard (Package)" id="FileDialogWizard (Package)" ref="index-eric7.Plugins.WizardPlugins.FileDialogWizard.html" />
       <keyword name="FileDialogWizard.__callForm" id="FileDialogWizard.__callForm" ref="eric7.Plugins.PluginWizardQFileDialog.html#FileDialogWizard.__callForm" />
       <keyword name="FileDialogWizard.__handle" id="FileDialogWizard.__handle" ref="eric7.Plugins.PluginWizardQFileDialog.html#FileDialogWizard.__handle" />
-      <keyword name="FileDialogWizard.__handleEricFileDialog" id="FileDialogWizard.__handleEricFileDialog" ref="eric7.Plugins.PluginWizardQFileDialog.html#FileDialogWizard.__handleEricFileDialog" />
-      <keyword name="FileDialogWizard.__handleQFileDialog" id="FileDialogWizard.__handleQFileDialog" ref="eric7.Plugins.PluginWizardQFileDialog.html#FileDialogWizard.__handleQFileDialog" />
       <keyword name="FileDialogWizard.__initActions" id="FileDialogWizard.__initActions" ref="eric7.Plugins.PluginWizardQFileDialog.html#FileDialogWizard.__initActions" />
       <keyword name="FileDialogWizard.__initMenu" id="FileDialogWizard.__initMenu" ref="eric7.Plugins.PluginWizardQFileDialog.html#FileDialogWizard.__initMenu" />
       <keyword name="FileDialogWizard.activate" id="FileDialogWizard.activate" ref="eric7.Plugins.PluginWizardQFileDialog.html#FileDialogWizard.activate" />
--- a/src/eric7/Documentation/Source/eric7.EricNetwork.EricJsonClient.html	Thu Feb 01 15:44:36 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.EricNetwork.EricJsonClient.html	Thu Feb 01 15:44:59 2024 +0100
@@ -56,6 +56,10 @@
 <td>Constructor</td>
 </tr>
 <tr>
+<td><a href="#EricJsonClient.__receiveBytes">__receiveBytes</a></td>
+<td>Private method to receive the given length of bytes.</td>
+</tr>
+<tr>
 <td><a href="#EricJsonClient.__receiveJson">__receiveJson</a></td>
 <td>Private method to receive a JSON encoded command and data from the server.</td>
 </tr>
@@ -106,6 +110,32 @@
             order to identify the connection
 </dd>
 </dl>
+<a NAME="EricJsonClient.__receiveBytes" ID="EricJsonClient.__receiveBytes"></a>
+<h4>EricJsonClient.__receiveBytes</h4>
+<b>__receiveBytes</b>(<i>length</i>)
+<p>
+        Private method to receive the given length of bytes.
+</p>
+
+<dl>
+
+<dt><i>length</i> (int)</dt>
+<dd>
+bytes to receive
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+received bytes or None if connection closed
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bytes
+</dd>
+</dl>
 <a NAME="EricJsonClient.__receiveJson" ID="EricJsonClient.__receiveJson"></a>
 <h4>EricJsonClient.__receiveJson</h4>
 <b>__receiveJson</b>(<i></i>)
--- 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>
--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQFileDialog.html	Thu Feb 01 15:44:36 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginWizardQFileDialog.html	Thu Feb 01 15:44:59 2024 +0100
@@ -65,14 +65,6 @@
 <td>Private method to handle the wizards action.</td>
 </tr>
 <tr>
-<td><a href="#FileDialogWizard.__handleEricFileDialog">__handleEricFileDialog</a></td>
-<td>Private slot to handle the wizard EricFileDialog action.</td>
-</tr>
-<tr>
-<td><a href="#FileDialogWizard.__handleQFileDialog">__handleQFileDialog</a></td>
-<td>Private slot to handle the wizard QFileDialog action.</td>
-</tr>
-<tr>
 <td><a href="#FileDialogWizard.__initActions">__initActions</a></td>
 <td>Private method to initialize the actions.</td>
 </tr>
@@ -163,20 +155,6 @@
 raised to indicate an illegal file dialog variant
 </dd>
 </dl>
-<a NAME="FileDialogWizard.__handleEricFileDialog" ID="FileDialogWizard.__handleEricFileDialog"></a>
-<h4>FileDialogWizard.__handleEricFileDialog</h4>
-<b>__handleEricFileDialog</b>(<i></i>)
-<p>
-        Private slot to handle the wizard EricFileDialog action.
-</p>
-
-<a NAME="FileDialogWizard.__handleQFileDialog" ID="FileDialogWizard.__handleQFileDialog"></a>
-<h4>FileDialogWizard.__handleQFileDialog</h4>
-<b>__handleQFileDialog</b>(<i></i>)
-<p>
-        Private slot to handle the wizard QFileDialog action.
-</p>
-
 <a NAME="FileDialogWizard.__initActions" ID="FileDialogWizard.__initActions"></a>
 <h4>FileDialogWizard.__initActions</h4>
 <b>__initActions</b>(<i></i>)

Mercurial Repository: eric

eric ide

mercurial