--- a/CxFreeze/Documentation/source/Plugin_Packager_CxFreeze.CxFreeze.CxfreezeConfigDialog.html Thu Jun 03 14:27:52 2021 +0200
+++ b/CxFreeze/Documentation/source/Plugin_Packager_CxFreeze.CxFreeze.CxfreezeConfigDialog.html Thu Jun 03 17:51:56 2021 +0200
@@ -38,10 +38,6 @@
<td><a href="#CxfreezeConfigDialog">CxfreezeConfigDialog</a></td>
<td>Class implementing a dialog to enter the parameters for cxfreeze.</td>
</tr>
-<tr>
-<td><a href="#DirFileDialog">DirFileDialog</a></td>
-<td>Derived QFileDialog to select files and folders at once.</td>
-</tr>
</table>
<h3>Functions</h3>
@@ -90,7 +86,7 @@
</tr>
<tr>
<td><a href="#CxfreezeConfigDialog.generateParameters">generateParameters</a></td>
-<td>Public method that generates the commandline parameters.</td>
+<td>Public method that generates the command line parameters.</td>
</tr>
<tr>
<td><a href="#CxfreezeConfigDialog.on_addFileOrFolderButton_clicked">on_addFileOrFolderButton_clicked</a></td>
@@ -105,10 +101,6 @@
<td>Private slot to delete the selected entry from the list view.</td>
</tr>
<tr>
-<td><a href="#CxfreezeConfigDialog.on_extListFileButton_clicked">on_extListFileButton_clicked</a></td>
-<td>Private slot to select the external list file.</td>
-</tr>
-<tr>
<td><a href="#CxfreezeConfigDialog.on_fileOrFolderEdit_textChanged">on_fileOrFolderEdit_textChanged</a></td>
<td>Private slot to handle the textChanged signal of the directory edit.</td>
</tr>
@@ -121,17 +113,9 @@
<td>Private slot to handle the itemDoubleClicked signal of the fileOrFolderList.</td>
</tr>
<tr>
-<td><a href="#CxfreezeConfigDialog.on_iconFileButton_clicked">on_iconFileButton_clicked</a></td>
-<td>Private slot to select an icon.</td>
-</tr>
-<tr>
<td><a href="#CxfreezeConfigDialog.on_selectFileOrFolderButton_clicked">on_selectFileOrFolderButton_clicked</a></td>
<td>Private slot to select files or folders.</td>
</tr>
-<tr>
-<td><a href="#CxfreezeConfigDialog.on_targetDirButton_clicked">on_targetDirButton_clicked</a></td>
-<td>Private slot to select the target directory.</td>
-</tr>
</table>
<h3>Static Methods</h3>
@@ -148,21 +132,21 @@
</p>
<dl>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
-reference to the project object (Project.Project)
+reference to the project object
</dd>
-<dt><i>exe</i></dt>
+<dt><i>exe</i> (str)</dt>
<dd>
-name of the cxfreeze executable (string)
+name of the cxfreeze executable
</dd>
-<dt><i>parms</i></dt>
+<dt><i>parms</i> (dict)</dt>
<dd>
parameters to set in the dialog
</dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
<dd>
-parent widget of this dialog (QWidget)
+parent widget of this dialog
</dd>
</dl>
<a NAME="CxfreezeConfigDialog.__initializeDefaults" ID="CxfreezeConfigDialog.__initializeDefaults"></a>
@@ -173,7 +157,7 @@
Private method to set the default values.
</p>
<p>
- These are needed later on to generate the commandline parameters.
+ These are needed later on to generate the command line parameters.
</p>
<a NAME="CxfreezeConfigDialog.__splitIt" ID="CxfreezeConfigDialog.__splitIt"></a>
<h4>CxfreezeConfigDialog.__splitIt</h4>
@@ -184,13 +168,13 @@
</p>
<dl>
-<dt><i>s</i></dt>
+<dt><i>s</i> (str)</dt>
<dd>
-string to split (string)
+string to split
</dd>
-<dt><i>sep</i></dt>
+<dt><i>sep</i> (str)</dt>
<dd>
-separator string (string)
+separator string
</dd>
</dl>
<dl>
@@ -199,6 +183,12 @@
list of split values
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl>
<a NAME="CxfreezeConfigDialog.accept" ID="CxfreezeConfigDialog.accept"></a>
<h4>CxfreezeConfigDialog.accept</h4>
<b>accept</b>(<i></i>)
@@ -214,7 +204,7 @@
<b>generateParameters</b>(<i></i>)
<p>
- Public method that generates the commandline parameters.
+ Public method that generates the command line parameters.
</p>
<p>
It generates a list of strings to be used to set the QProcess arguments
@@ -225,8 +215,14 @@
<dl>
<dt>Return:</dt>
<dd>
-a tuple of the commandline parameters and non default
- parameters (list of strings, dictionary)
+a tuple of the command line parameters and non default
+ parameters
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (list of str, dict)
</dd>
</dl>
<a NAME="CxfreezeConfigDialog.on_addFileOrFolderButton_clicked" ID="CxfreezeConfigDialog.on_addFileOrFolderButton_clicked"></a>
@@ -245,9 +241,9 @@
</p>
<dl>
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
<dd>
-selected cxfreeze executable (string)
+selected cxfreeze executable
</dd>
</dl>
<a NAME="CxfreezeConfigDialog.on_deleteSelectedButton_clicked" ID="CxfreezeConfigDialog.on_deleteSelectedButton_clicked"></a>
@@ -257,17 +253,6 @@
<p>
Private slot to delete the selected entry from the list view.
</p>
-<a NAME="CxfreezeConfigDialog.on_extListFileButton_clicked" ID="CxfreezeConfigDialog.on_extListFileButton_clicked"></a>
-<h4>CxfreezeConfigDialog.on_extListFileButton_clicked</h4>
-<b>on_extListFileButton_clicked</b>(<i></i>)
-
-<p>
- Private slot to select the external list file.
-</p>
-<p>
- It displays a file selection dialog to select the external list file,
- the list of include modules is written to.
-</p>
<a NAME="CxfreezeConfigDialog.on_fileOrFolderEdit_textChanged" ID="CxfreezeConfigDialog.on_fileOrFolderEdit_textChanged"></a>
<h4>CxfreezeConfigDialog.on_fileOrFolderEdit_textChanged</h4>
<b>on_fileOrFolderEdit_textChanged</b>(<i>txt</i>)
@@ -277,9 +262,9 @@
</p>
<dl>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
<dd>
-the text of the directory edit (string)
+the text of the directory edit
</dd>
</dl>
<a NAME="CxfreezeConfigDialog.on_fileOrFolderList_currentRowChanged" ID="CxfreezeConfigDialog.on_fileOrFolderList_currentRowChanged"></a>
@@ -292,9 +277,9 @@
</p>
<dl>
-<dt><i>row</i></dt>
+<dt><i>row</i> (int)</dt>
<dd>
-the current row (integer)
+the current row
</dd>
</dl>
<a NAME="CxfreezeConfigDialog.on_fileOrFolderList_itemDoubleClicked" ID="CxfreezeConfigDialog.on_fileOrFolderList_itemDoubleClicked"></a>
@@ -307,22 +292,11 @@
</p>
<dl>
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QListWidgetItem)</dt>
<dd>
-the selected row (QListWidgetItem)
+the selected row
</dd>
</dl>
-<a NAME="CxfreezeConfigDialog.on_iconFileButton_clicked" ID="CxfreezeConfigDialog.on_iconFileButton_clicked"></a>
-<h4>CxfreezeConfigDialog.on_iconFileButton_clicked</h4>
-<b>on_iconFileButton_clicked</b>(<i></i>)
-
-<p>
- Private slot to select an icon.
-</p>
-<p>
- It displays a file selection dialog to select an icon to
- include into the executable.
-</p>
<a NAME="CxfreezeConfigDialog.on_selectFileOrFolderButton_clicked" ID="CxfreezeConfigDialog.on_selectFileOrFolderButton_clicked"></a>
<h4>CxfreezeConfigDialog.on_selectFileOrFolderButton_clicked</h4>
<b>on_selectFileOrFolderButton_clicked</b>(<i></i>)
@@ -332,194 +306,9 @@
</p>
<p>
It displays a file and directory selection dialog to
- select the files and directorys which should copied into
- the distribution folder..
-</p>
-<a NAME="CxfreezeConfigDialog.on_targetDirButton_clicked" ID="CxfreezeConfigDialog.on_targetDirButton_clicked"></a>
-<h4>CxfreezeConfigDialog.on_targetDirButton_clicked</h4>
-<b>on_targetDirButton_clicked</b>(<i></i>)
-
-<p>
- Private slot to select the target directory.
-</p>
-<p>
- It displays a directory selection dialog to
- select the directory the files are written to.
+ select the files and directories which should be copied
+ into the distribution folder.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
-<hr />
-<a NAME="DirFileDialog" ID="DirFileDialog"></a>
-<h2>DirFileDialog</h2>
-
-<p>
- Derived QFileDialog to select files and folders at once.
-</p>
-<p>
- For this purpose the none native filedialog is used.
-</p>
-<h3>Derived from</h3>
-QFileDialog
-<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="#DirFileDialog.__init__">DirFileDialog</a></td>
-<td>Constructor</td>
-</tr>
-<tr>
-<td><a href="#DirFileDialog.accept">accept</a></td>
-<td>Public method to update the list with the selected files and folders.</td>
-</tr>
-<tr>
-<td><a href="#DirFileDialog.exec">exec</a></td>
-<td>Public slot to finalize initialization and start the event loop.</td>
-</tr>
-<tr>
-<td><a href="#DirFileDialog.on_directoryEntered">on_directoryEntered</a></td>
-<td>Private method to reset selections if another directory was entered.</td>
-</tr>
-<tr>
-<td><a href="#DirFileDialog.on_selectionChanged">on_selectionChanged</a></td>
-<td>Private method to determine the selected files and folders and update the line edit.</td>
-</tr>
-</table>
-<h3>Static Methods</h3>
-
-<table>
-
-<tr>
-<td><a href="#DirFileDialog.getOpenFileNames">getOpenFileNames</a></td>
-<td>Static method to get the names of files and folders for opening it.</td>
-</tr>
-</table>
-
-<a NAME="DirFileDialog.__init__" ID="DirFileDialog.__init__"></a>
-<h4>DirFileDialog (Constructor)</h4>
-<b>DirFileDialog</b>(<i>parent=None, caption="", directory="", fileFilter=""</i>)
-
-<p>
- Constructor
-</p>
-<dl>
-
-<dt><i>parent</i></dt>
-<dd>
-parent widget of the dialog (QWidget)
-</dd>
-<dt><i>caption</i></dt>
-<dd>
-window title of the dialog (string)
-</dd>
-<dt><i>directory</i></dt>
-<dd>
-working directory of the dialog (string)
-</dd>
-<dt><i>fileFilter</i></dt>
-<dd>
-filter string for the dialog (string)
-</dd>
-</dl>
-<a NAME="DirFileDialog.accept" ID="DirFileDialog.accept"></a>
-<h4>DirFileDialog.accept</h4>
-<b>accept</b>(<i></i>)
-
-<p>
- Public method to update the list with the selected files and folders.
-</p>
-<a NAME="DirFileDialog.exec" ID="DirFileDialog.exec"></a>
-<h4>DirFileDialog.exec</h4>
-<b>exec</b>(<i></i>)
-
-<p>
- Public slot to finalize initialization and start the event loop.
-</p>
-<dl>
-<dt>Return:</dt>
-<dd>
-accepted or rejected (QDialog.DialogCode)
-</dd>
-</dl>
-<a NAME="DirFileDialog.on_directoryEntered" ID="DirFileDialog.on_directoryEntered"></a>
-<h4>DirFileDialog.on_directoryEntered</h4>
-<b>on_directoryEntered</b>(<i>directory</i>)
-
-<p>
- Private method to reset selections if another directory was entered.
-</p>
-<dl>
-
-<dt><i>directory</i></dt>
-<dd>
-name of the directory entered (string)
-</dd>
-</dl>
-<a NAME="DirFileDialog.on_selectionChanged" ID="DirFileDialog.on_selectionChanged"></a>
-<h4>DirFileDialog.on_selectionChanged</h4>
-<b>on_selectionChanged</b>(<i>selected, deselected</i>)
-
-<p>
- Private method to determine the selected files and folders and update
- the line edit.
-</p>
-<dl>
-
-<dt><i>selected</i></dt>
-<dd>
-newly selected entries (QItemSelection)
-</dd>
-<dt><i>deselected</i></dt>
-<dd>
-deselected entries (QItemSelection)
-</dd>
-</dl>
-<a NAME="DirFileDialog.getOpenFileNames" ID="DirFileDialog.getOpenFileNames"></a>
-<h4>DirFileDialog.getOpenFileNames (static)</h4>
-<b>getOpenFileNames</b>(<i>caption="", directory="", fileFilter="", options=None</i>)
-
-<p>
- Static method to get the names of files and folders for opening it.
-</p>
-<dl>
-
-<dt><i>parent</i></dt>
-<dd>
-parent widget of the dialog (QWidget)
-</dd>
-<dt><i>caption</i></dt>
-<dd>
-window title of the dialog (string)
-</dd>
-<dt><i>directory</i></dt>
-<dd>
-working directory of the dialog (string)
-</dd>
-<dt><i>fileFilter</i></dt>
-<dd>
-filter string for the dialog (string)
-</dd>
-<dt><i>options</i></dt>
-<dd>
-various options for the dialog (QFileDialog.Options)
-</dd>
-</dl>
-<dl>
-<dt>Return:</dt>
-<dd>
-names of the selected files and folders (list of strings)
-</dd>
-</dl>
-<div align="right"><a href="#top">Up</a></div>
-<hr />
</body></html>
\ No newline at end of file
