CxFreeze/Documentation/source/Plugin_Packager_CxFreeze.CxFreeze.CxfreezeConfigDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Packager_CxFreeze.CxFreeze.CxfreezeConfigDialog</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<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>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<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>
<td><a href="#CxfreezeConfigDialog.__initializeDefaults">__initializeDefaults</a></td>
<td>Private method to set the default values.</td>
</tr>
<tr>
<td><a href="#CxfreezeConfigDialog.__splitIt">__splitIt</a></td>
<td>Private method to split a string observing various conditions.</td>
</tr>
<tr>
<td><a href="#CxfreezeConfigDialog.accept">accept</a></td>
<td>Public method called by the Ok button.</td>
</tr>
<tr>
<td><a href="#CxfreezeConfigDialog.generateParameters">generateParameters</a></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>
<td>Private slot to add the entered file or directory to the list view.</td>
</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>
<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>
<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>
<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>
<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>
<td><a href="#CxfreezeConfigDialog.on_selectFileOrFolderButton_clicked">on_selectFileOrFolderButton_clicked</a></td>
<td>Private slot to select files or folders.</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>

<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
<dt><i>exe</i> (str)</dt>
<dd>
name of the cxfreeze executable
</dd>
<dt><i>parms</i> (dict)</dt>
<dd>
parameters to set in the dialog
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget of this dialog
</dd>
</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>
        These are needed later on to generate the command line parameters.
</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>

<dt><i>s</i> (str)</dt>
<dd>
string to split
</dd>
<dt><i>sep</i> (str)</dt>
<dd>
separator string
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
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>)

<p>
        Public method called by the Ok button.
</p>
<p>
        It saves the values in the parameters dictionary.
</p>
<a NAME="CxfreezeConfigDialog.generateParameters" ID="CxfreezeConfigDialog.generateParameters"></a>
<h4>CxfreezeConfigDialog.generateParameters</h4>
<b>generateParameters</b>(<i></i>)

<p>
        Public method that generates the command line parameters.
</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>
<dt>Return:</dt>
<dd>
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>
<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>
<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>

<dt><i>text</i> (str)</dt>
<dd>
selected cxfreeze executable
</dd>
</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_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>

<dt><i>txt</i> (str)</dt>
<dd>
the text of the directory edit
</dd>
</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>

<dt><i>row</i> (int)</dt>
<dd>
the current row
</dd>
</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>

<dt><i>itm</i> (QListWidgetItem)</dt>
<dd>
the selected row
</dd>
</dl>
<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>
        It displays a file and directory selection dialog 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 />
</body></html>