--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/PyInstaller/Documentation/source/Plugin_Packager_PyInstaller.PyInstaller.PyInstallerExecDialog.html Sat Jan 20 17:06:15 2018 +0100 @@ -0,0 +1,190 @@ +<!DOCTYPE html> +<html><head> +<title>Plugin_Packager_PyInstaller.PyInstaller.PyInstallerExecDialog</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.PyInstallerExecDialog</h1> +<p> +Module implementing a dialog to show the output of the pyinstaller/pyi-makespec +process. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#PyInstallerExecDialog">PyInstallerExecDialog</a></td> +<td>Class implementing a dialog to show the output of the pyinstaller/pyi-makespec process.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="PyInstallerExecDialog" ID="PyInstallerExecDialog"></a> +<h2>PyInstallerExecDialog</h2> +<p> + Class implementing a dialog to show the output of the + pyinstaller/pyi-makespec process. +</p><p> + This class starts a QProcess and displays a dialog that + shows the output of the packager command process. +</p> +<h3>Derived from</h3> +QDialog, Ui_PyInstallerExecDialog +<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="#PyInstallerExecDialog.__init__">PyInstallerExecDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__enableButtons">__enableButtons</a></td> +<td>Private slot called when all processes finished.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__finish">__finish</a></td> +<td>Private slot called when the process was canceled by the user.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__finishedProcess">__finishedProcess</a></td> +<td>Private slot called when the process finished.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> +<td>Private slot called by a button of the button box clicked.</td> +</tr><tr> +<td><a href="#PyInstallerExecDialog.start">start</a></td> +<td>Public slot to start the packager command.</td> +</tr> +</table> +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> +<a NAME="PyInstallerExecDialog.__init__" ID="PyInstallerExecDialog.__init__"></a> +<h4>PyInstallerExecDialog (Constructor)</h4> +<b>PyInstallerExecDialog</b>(<i>cmdname, parent=None</i>) +<p> + Constructor +</p><dl> +<dt><i>cmdname</i> (str)</dt> +<dd> +name of the packager +</dd><dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl><a NAME="PyInstallerExecDialog.__enableButtons" ID="PyInstallerExecDialog.__enableButtons"></a> +<h4>PyInstallerExecDialog.__enableButtons</h4> +<b>__enableButtons</b>(<i></i>) +<p> + Private slot called when all processes finished. +</p><p> + It is called when the process finished or + the user pressed the cancel button. +</p><a NAME="PyInstallerExecDialog.__finish" ID="PyInstallerExecDialog.__finish"></a> +<h4>PyInstallerExecDialog.__finish</h4> +<b>__finish</b>(<i></i>) +<p> + Private slot called when the process was canceled by the user. +</p><p> + It is called when the process finished or + the user pressed the cancel button. +</p><a NAME="PyInstallerExecDialog.__finishedProcess" ID="PyInstallerExecDialog.__finishedProcess"></a> +<h4>PyInstallerExecDialog.__finishedProcess</h4> +<b>__finishedProcess</b>(<i></i>) +<p> + Private slot called when the process finished. +</p><p> + It is called when the process finished or + the user pressed the cancel button. +</p><a NAME="PyInstallerExecDialog.__readStderr" ID="PyInstallerExecDialog.__readStderr"></a> +<h4>PyInstallerExecDialog.__readStderr</h4> +<b>__readStderr</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardError signal. +</p><p> + It reads the error output of the process and inserts it into the + error pane. +</p><a NAME="PyInstallerExecDialog.__readStdout" ID="PyInstallerExecDialog.__readStdout"></a> +<h4>PyInstallerExecDialog.__readStdout</h4> +<b>__readStdout</b>(<i></i>) +<p> + Private slot to handle the readyReadStandardOutput signal. +</p><p> + It reads the output of the process, formats it and inserts it into + the contents pane. +</p><a NAME="PyInstallerExecDialog.on_buttonBox_clicked" ID="PyInstallerExecDialog.on_buttonBox_clicked"></a> +<h4>PyInstallerExecDialog.on_buttonBox_clicked</h4> +<b>on_buttonBox_clicked</b>(<i>button</i>) +<p> + Private slot called by a button of the button box clicked. +</p><dl> +<dt><i>button</i> (QAbstractButton)</dt> +<dd> +button that was clicked +</dd> +</dl><a NAME="PyInstallerExecDialog.start" ID="PyInstallerExecDialog.start"></a> +<h4>PyInstallerExecDialog.start</h4> +<b>start</b>(<i>args, parms, project, script</i>) +<p> + Public slot to start the packager command. +</p><dl> +<dt><i>args</i> (list of str)</dt> +<dd> +command line arguments for packager program +</dd><dt><i>parms</i> (dict)</dt> +<dd> +parameters got from the config dialog +</dd><dt><i>project</i> (Project)</dt> +<dd> +reference to the project object +</dd><dt><i>script</i> (str)</dt> +<dd> +script or spec file name to be processed by by the + packager +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating the successful start of the process +</dd> +</dl><dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file