--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PyInstaller.PyInstallerConfigDialog.html Sat Jan 20 17:06:15 2018 +0100 @@ -0,0 +1,198 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Packager_PyInstaller.PyInstaller.PyInstallerConfigDialog</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_PyInstaller.PyInstaller.PyInstallerConfigDialog</h1> +<p> +Module implementing PyInstallerConfigDialog. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PyInstallerConfigDialog">PyInstallerConfigDialog</a></td> +<td>Class implementing a dialog to enter the parameters for pyinstaller and pyi-makespec.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PyInstallerConfigDialog" ID="PyInstallerConfigDialog"></a> +<h2>PyInstallerConfigDialog</h2> +<p> + Class implementing a dialog to enter the parameters for pyinstaller + and pyi-makespec. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyInstallerConfigDialog +<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="#PyInstallerConfigDialog.__init__">PyInstallerConfigDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.__initializeDefaults">__initializeDefaults</a></td> +<td>Private method to set the default values.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.__updateOkButton">__updateOkButton</a></td> +<td>Private method to update the enabled state of the OK button.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.accept">accept</a></td> +<td>Public method called by the Ok button.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.generateParameters">generateParameters</a></td> +<td>Public method that generates the command line parameters.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.on_iconFilePicker_textChanged">on_iconFilePicker_textChanged</a></td> +<td>Private slot to handle changes of the icon file.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.on_iconIdEdit_textChanged">on_iconIdEdit_textChanged</a></td> +<td>Private slot to handle changes of the icon ID.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.on_inputFilePicker_textChanged">on_inputFilePicker_textChanged</a></td> +<td>Private slot to handle changes of the input file.</td> +</tr><tr> +<td><a href="#PyInstallerConfigDialog.on_selectedScriptButton_toggled">on_selectedScriptButton_toggled</a></td> +<td>Private slot to handle changes of the radio button state.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PyInstallerConfigDialog.__init__" ID="PyInstallerConfigDialog.__init__"></a> +<h4>PyInstallerConfigDialog (Constructor)</h4> +<b>PyInstallerConfigDialog</b>(<i>project, executables, params=None, mode="installer", parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>project</i> (Project.Project)</dt> +<dd> +reference to the project object +</dd><dt><i>executables</i> (list of str)</dt> +<dd> +names of the pyinstaller executables +</dd><dt><i>params</i> (dict)</dt> +<dd> +parameters to set in the dialog +</dd><dt><i>mode</i> (str (one of 'installer' or 'spec'))</dt> +<dd> +mode of the dialog +</dd><dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl><a NAME="PyInstallerConfigDialog.__initializeDefaults" ID="PyInstallerConfigDialog.__initializeDefaults"></a> +<h4>PyInstallerConfigDialog.__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="PyInstallerConfigDialog.__updateOkButton" ID="PyInstallerConfigDialog.__updateOkButton"></a> +<h4>PyInstallerConfigDialog.__updateOkButton</h4> +<b>__updateOkButton</b>(<i></i>) +<p> + Private method to update the enabled state of the OK button. +</p><a NAME="PyInstallerConfigDialog.accept" ID="PyInstallerConfigDialog.accept"></a> +<h4>PyInstallerConfigDialog.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="PyInstallerConfigDialog.generateParameters" ID="PyInstallerConfigDialog.generateParameters"></a> +<h4>PyInstallerConfigDialog.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 pyinstaller/pyi-makespec 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>Returns:</dt> +<dd> +a tuple of the command line parameters, non default parameters + and the script path +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +tuple of (list of str, dict, str) +</dd> +</dl><a NAME="PyInstallerConfigDialog.on_iconFilePicker_textChanged" ID="PyInstallerConfigDialog.on_iconFilePicker_textChanged"></a> +<h4>PyInstallerConfigDialog.on_iconFilePicker_textChanged</h4> +<b>on_iconFilePicker_textChanged</b>(<i>txt</i>) +<p> + Private slot to handle changes of the icon file. +</p><dl> +<dt><i>txt</i> (str)</dt> +<dd> +text of the file edit +</dd> +</dl><a NAME="PyInstallerConfigDialog.on_iconIdEdit_textChanged" ID="PyInstallerConfigDialog.on_iconIdEdit_textChanged"></a> +<h4>PyInstallerConfigDialog.on_iconIdEdit_textChanged</h4> +<b>on_iconIdEdit_textChanged</b>(<i>txt</i>) +<p> + Private slot to handle changes of the icon ID. +</p><dl> +<dt><i>txt</i> (str)</dt> +<dd> +iconID +</dd> +</dl><a NAME="PyInstallerConfigDialog.on_inputFilePicker_textChanged" ID="PyInstallerConfigDialog.on_inputFilePicker_textChanged"></a> +<h4>PyInstallerConfigDialog.on_inputFilePicker_textChanged</h4> +<b>on_inputFilePicker_textChanged</b>(<i>txt</i>) +<p> + Private slot to handle changes of the input file. +</p><dl> +<dt><i>txt</i> (str)</dt> +<dd> +text of the file edit +</dd> +</dl><a NAME="PyInstallerConfigDialog.on_selectedScriptButton_toggled" ID="PyInstallerConfigDialog.on_selectedScriptButton_toggled"></a> +<h4>PyInstallerConfigDialog.on_selectedScriptButton_toggled</h4> +<b>on_selectedScriptButton_toggled</b>(<i>checked</i>) +<p> + Private slot to handle changes of the radio button state. +</p><dl> +<dt><i>checked</i> (bool)</dt> +<dd> +state of the radio button +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file