--- a/CxFreeze/Documentation/source/Plugin_Packager_CxFreeze.CxFreeze.CxfreezeConfigDialog.html Mon May 04 18:04:16 2020 +0200
+++ b/CxFreeze/Documentation/source/Plugin_Packager_CxFreeze.CxFreeze.CxfreezeConfigDialog.html Tue Jun 23 19:23:24 2020 +0200
@@ -18,377 +18,503 @@
</style>
</head>
-<body><a NAME="top" ID="top"></a>
+<body>
+<a NAME="top" ID="top"></a>
<h1>Plugin_Packager_CxFreeze.CxFreeze.CxfreezeConfigDialog</h1>
+
<p>
Module implementing a dialog to enter the parameters for cxfreeze.
</p>
<h3>Global Attributes</h3>
+
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
+
<table>
+
<tr>
<td><a href="#CxfreezeConfigDialog">CxfreezeConfigDialog</a></td>
<td>Class implementing a dialog to enter the parameters for cxfreeze.</td>
-</tr><tr>
+</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>
+
<table>
<tr><td>None</td></tr>
</table>
-<hr /><hr />
+<hr />
+<hr />
<a NAME="CxfreezeConfigDialog" ID="CxfreezeConfigDialog"></a>
<h2>CxfreezeConfigDialog</h2>
+
<p>
Class implementing a dialog to enter the parameters for cxfreeze.
</p>
<h3>Derived from</h3>
QDialog, Ui_CxfreezeConfigDialog
<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="#CxfreezeConfigDialog.__init__">CxfreezeConfigDialog</a></td>
<td>Constructor</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.__initializeDefaults">__initializeDefaults</a></td>
<td>Private method to set the default values.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.__splitIt">__splitIt</a></td>
<td>Private method to split a string observing various conditions.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.accept">accept</a></td>
<td>Public method called by the Ok button.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.generateParameters">generateParameters</a></td>
<td>Public method that generates the commandline parameters.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.on_addFileOrFolderButton_clicked">on_addFileOrFolderButton_clicked</a></td>
<td>Private slot to add the entered file or directory to the list view.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.on_cxfreezeExecCombo_currentIndexChanged">on_cxfreezeExecCombo_currentIndexChanged</a></td>
<td>Private slot to handle the selection of a cxfreeze executable.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.on_deleteSelectedButton_clicked">on_deleteSelectedButton_clicked</a></td>
<td>Private slot to delete the selected entry from the list view.</td>
-</tr><tr>
+</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>
+</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><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.on_fileOrFolderList_currentRowChanged">on_fileOrFolderList_currentRowChanged</a></td>
<td>Private slot to handle the currentRowChanged signal of the fileOrFolderList.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.on_fileOrFolderList_itemDoubleClicked">on_fileOrFolderList_itemDoubleClicked</a></td>
<td>Private slot to handle the itemDoubleClicked signal of the fileOrFolderList.</td>
-</tr><tr>
+</tr>
+<tr>
<td><a href="#CxfreezeConfigDialog.on_iconFileButton_clicked">on_iconFileButton_clicked</a></td>
<td>Private slot to select an icon.</td>
-</tr><tr>
+</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>
+</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>
+
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="CxfreezeConfigDialog.__init__" ID="CxfreezeConfigDialog.__init__"></a>
<h4>CxfreezeConfigDialog (Constructor)</h4>
<b>CxfreezeConfigDialog</b>(<i>project, exe, parms=None, parent=None</i>)
+
<p>
Constructor
-</p><dl>
+</p>
+<dl>
+
<dt><i>project</i></dt>
<dd>
reference to the project object (Project.Project)
-</dd><dt><i>exe</i></dt>
+</dd>
+<dt><i>exe</i></dt>
<dd>
name of the cxfreeze executable (string)
-</dd><dt><i>parms</i></dt>
+</dd>
+<dt><i>parms</i></dt>
<dd>
parameters to set in the dialog
-</dd><dt><i>parent</i></dt>
+</dd>
+<dt><i>parent</i></dt>
<dd>
parent widget of this dialog (QWidget)
</dd>
-</dl><a NAME="CxfreezeConfigDialog.__initializeDefaults" ID="CxfreezeConfigDialog.__initializeDefaults"></a>
+</dl>
+<a NAME="CxfreezeConfigDialog.__initializeDefaults" ID="CxfreezeConfigDialog.__initializeDefaults"></a>
<h4>CxfreezeConfigDialog.__initializeDefaults</h4>
<b>__initializeDefaults</b>(<i></i>)
+
<p>
Private method to set the default values.
-</p><p>
+</p>
+<p>
These are needed later on to generate the commandline parameters.
-</p><a NAME="CxfreezeConfigDialog.__splitIt" ID="CxfreezeConfigDialog.__splitIt"></a>
+</p>
+<a NAME="CxfreezeConfigDialog.__splitIt" ID="CxfreezeConfigDialog.__splitIt"></a>
<h4>CxfreezeConfigDialog.__splitIt</h4>
<b>__splitIt</b>(<i>s, sep</i>)
+
<p>
Private method to split a string observing various conditions.
-</p><dl>
+</p>
+<dl>
+
<dt><i>s</i></dt>
<dd>
string to split (string)
-</dd><dt><i>sep</i></dt>
+</dd>
+<dt><i>sep</i></dt>
<dd>
separator string (string)
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
list of split values
</dd>
-</dl><a NAME="CxfreezeConfigDialog.accept" ID="CxfreezeConfigDialog.accept"></a>
+</dl>
+<a NAME="CxfreezeConfigDialog.accept" ID="CxfreezeConfigDialog.accept"></a>
<h4>CxfreezeConfigDialog.accept</h4>
<b>accept</b>(<i></i>)
+
<p>
Public method called by the Ok button.
-</p><p>
+</p>
+<p>
It saves the values in the parameters dictionary.
-</p><a NAME="CxfreezeConfigDialog.generateParameters" ID="CxfreezeConfigDialog.generateParameters"></a>
+</p>
+<a NAME="CxfreezeConfigDialog.generateParameters" ID="CxfreezeConfigDialog.generateParameters"></a>
<h4>CxfreezeConfigDialog.generateParameters</h4>
<b>generateParameters</b>(<i></i>)
+
<p>
Public method that generates the commandline parameters.
-</p><p>
+</p>
+<p>
It generates a list of strings to be used to set the QProcess arguments
for the cxfreeze call and a list containing the non default parameters.
The second list can be passed back upon object generation to overwrite
the default settings.
-</p><dl>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
a tuple of the commandline parameters and non default
parameters (list of strings, dictionary)
</dd>
-</dl><a NAME="CxfreezeConfigDialog.on_addFileOrFolderButton_clicked" ID="CxfreezeConfigDialog.on_addFileOrFolderButton_clicked"></a>
+</dl>
+<a NAME="CxfreezeConfigDialog.on_addFileOrFolderButton_clicked" ID="CxfreezeConfigDialog.on_addFileOrFolderButton_clicked"></a>
<h4>CxfreezeConfigDialog.on_addFileOrFolderButton_clicked</h4>
<b>on_addFileOrFolderButton_clicked</b>(<i></i>)
+
<p>
Private slot to add the entered file or directory to the list view.
-</p><a NAME="CxfreezeConfigDialog.on_cxfreezeExecCombo_currentIndexChanged" ID="CxfreezeConfigDialog.on_cxfreezeExecCombo_currentIndexChanged"></a>
+</p>
+<a NAME="CxfreezeConfigDialog.on_cxfreezeExecCombo_currentIndexChanged" ID="CxfreezeConfigDialog.on_cxfreezeExecCombo_currentIndexChanged"></a>
<h4>CxfreezeConfigDialog.on_cxfreezeExecCombo_currentIndexChanged</h4>
<b>on_cxfreezeExecCombo_currentIndexChanged</b>(<i>text</i>)
+
<p>
Private slot to handle the selection of a cxfreeze executable.
-</p><dl>
+</p>
+<dl>
+
<dt><i>text</i></dt>
<dd>
selected cxfreeze executable (string)
</dd>
-</dl><a NAME="CxfreezeConfigDialog.on_deleteSelectedButton_clicked" ID="CxfreezeConfigDialog.on_deleteSelectedButton_clicked"></a>
+</dl>
+<a NAME="CxfreezeConfigDialog.on_deleteSelectedButton_clicked" ID="CxfreezeConfigDialog.on_deleteSelectedButton_clicked"></a>
<h4>CxfreezeConfigDialog.on_deleteSelectedButton_clicked</h4>
<b>on_deleteSelectedButton_clicked</b>(<i></i>)
+
<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>
+</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>
+</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>
+</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>)
+
<p>
Private slot to handle the textChanged signal of the directory edit.
-</p><dl>
+</p>
+<dl>
+
<dt><i>txt</i></dt>
<dd>
the text of the directory edit (string)
</dd>
-</dl><a NAME="CxfreezeConfigDialog.on_fileOrFolderList_currentRowChanged" ID="CxfreezeConfigDialog.on_fileOrFolderList_currentRowChanged"></a>
+</dl>
+<a NAME="CxfreezeConfigDialog.on_fileOrFolderList_currentRowChanged" ID="CxfreezeConfigDialog.on_fileOrFolderList_currentRowChanged"></a>
<h4>CxfreezeConfigDialog.on_fileOrFolderList_currentRowChanged</h4>
<b>on_fileOrFolderList_currentRowChanged</b>(<i>row</i>)
+
<p>
Private slot to handle the currentRowChanged signal of the
fileOrFolderList.
-</p><dl>
+</p>
+<dl>
+
<dt><i>row</i></dt>
<dd>
the current row (integer)
</dd>
-</dl><a NAME="CxfreezeConfigDialog.on_fileOrFolderList_itemDoubleClicked" ID="CxfreezeConfigDialog.on_fileOrFolderList_itemDoubleClicked"></a>
+</dl>
+<a NAME="CxfreezeConfigDialog.on_fileOrFolderList_itemDoubleClicked" ID="CxfreezeConfigDialog.on_fileOrFolderList_itemDoubleClicked"></a>
<h4>CxfreezeConfigDialog.on_fileOrFolderList_itemDoubleClicked</h4>
<b>on_fileOrFolderList_itemDoubleClicked</b>(<i>itm</i>)
+
<p>
Private slot to handle the itemDoubleClicked signal of the
fileOrFolderList.
-</p><dl>
+</p>
+<dl>
+
<dt><i>itm</i></dt>
<dd>
the selected row (QListWidgetItem)
</dd>
-</dl><a NAME="CxfreezeConfigDialog.on_iconFileButton_clicked" ID="CxfreezeConfigDialog.on_iconFileButton_clicked"></a>
+</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>
+</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>
+</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>)
+
<p>
Private slot to select files or folders.
-</p><p>
+</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>
+</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>
+</p>
+<p>
It displays a directory selection dialog to
select the directory the files are written to.
</p>
<div align="right"><a href="#top">Up</a></div>
-<hr /><hr />
+<hr />
+<hr />
<a NAME="DirFileDialog" ID="DirFileDialog"></a>
<h2>DirFileDialog</h2>
+
<p>
Derived QFileDialog to select files and folders at once.
-</p><p>
+</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>
+</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>
+</tr>
+<tr>
<td><a href="#DirFileDialog.exec_">exec_</a></td>
<td>Public slot to finalize initialisation and start the event loop.</td>
-</tr><tr>
+</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>
+</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>
+</p>
+<dl>
+
<dt><i>parent</i></dt>
<dd>
parent widget of the dialog (QWidget)
-</dd><dt><i>caption</i></dt>
+</dd>
+<dt><i>caption</i></dt>
<dd>
window title of the dialog (string)
-</dd><dt><i>directory</i></dt>
+</dd>
+<dt><i>directory</i></dt>
<dd>
working directory of the dialog (string)
-</dd><dt><i>fileFilter</i></dt>
+</dd>
+<dt><i>fileFilter</i></dt>
<dd>
filter string for the dialog (string)
</dd>
-</dl><a NAME="DirFileDialog.accept" ID="DirFileDialog.accept"></a>
+</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>
+</p>
+<a NAME="DirFileDialog.exec_" ID="DirFileDialog.exec_"></a>
<h4>DirFileDialog.exec_</h4>
<b>exec_</b>(<i></i>)
+
<p>
Public slot to finalize initialisation and start the event loop.
-</p><dl>
+</p>
+<dl>
<dt>Returns:</dt>
<dd>
accepted or rejected (QDialog.DialogCode)
</dd>
-</dl><a NAME="DirFileDialog.on_directoryEntered" ID="DirFileDialog.on_directoryEntered"></a>
+</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>
+</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>
+</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>
+</p>
+<dl>
+
<dt><i>selected</i></dt>
<dd>
newly selected entries (QItemSelection)
-</dd><dt><i>deselected</i></dt>
+</dd>
+<dt><i>deselected</i></dt>
<dd>
deselected entries (QItemSelection)
</dd>
-</dl><a NAME="DirFileDialog.getOpenFileNames" ID="DirFileDialog.getOpenFileNames"></a>
+</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>
+</p>
+<dl>
+
<dt><i>parent</i></dt>
<dd>
parent widget of the dialog (QWidget)
-</dd><dt><i>caption</i></dt>
+</dd>
+<dt><i>caption</i></dt>
<dd>
window title of the dialog (string)
-</dd><dt><i>directory</i></dt>
+</dd>
+<dt><i>directory</i></dt>
<dd>
working directory of the dialog (string)
-</dd><dt><i>fileFilter</i></dt>
+</dd>
+<dt><i>fileFilter</i></dt>
<dd>
filter string for the dialog (string)
-</dd><dt><i>options</i></dt>
+</dd>
+<dt><i>options</i></dt>
<dd>
various options for the dialog (QFileDialog.Options)
</dd>
-</dl><dl>
+</dl>
+<dl>
<dt>Returns:</dt>
<dd>
names of the selected files and folders (list of strings)
