--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/CxFreeze/Documentation/source/Plugin_Packager_CxFreeze.CxFreeze.CxfreezeExecDialog.html Sat Jul 24 17:42:12 2010 +0200 @@ -0,0 +1,147 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' +'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> +<html><head> +<title>Plugin_Packager_CxFreeze.CxFreeze.CxfreezeExecDialog</title> +<style> +body { + background:white; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #4FA4FF; } +h2 { color: white; background: #4FA4FF; } +h3 { color: white; background: #00557F; } +h4 { color: white; background: #00557F; } + +a { color: #AA5500; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Plugin_Packager_CxFreeze.CxFreeze.CxfreezeExecDialog</h1> +<p> +Module implementing a dialog to show the output of the packager process. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#CxfreezeExecDialog">CxfreezeExecDialog</a></td> +<td>Module implementing a dialog to show the output of the cxfreeze process.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="CxfreezeExecDialog" ID="CxfreezeExecDialog"></a> +<h2>CxfreezeExecDialog</h2> +<p> + Module implementing a dialog to show the output of the cxfreeze 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_CxfreezeExecDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#CxfreezeExecDialog.__init__">CxfreezeExecDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#CxfreezeExecDialog.__finish">__finish</a></td> +<td>Private slot called when the process finished.</td> +</tr><tr> +<td><a href="#CxfreezeExecDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr><tr> +<td><a href="#CxfreezeExecDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr><tr> +<td><a href="#CxfreezeExecDialog.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="#CxfreezeExecDialog.start">start</a></td> +<td>Public slot to start the packager command.</td> +</tr> +</table> +<a NAME="CxfreezeExecDialog.__init__" ID="CxfreezeExecDialog.__init__"></a> +<h4>CxfreezeExecDialog (Constructor)</h4> +<b>CxfreezeExecDialog</b>(<i>cmdname, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>cmdname</i></dt> +<dd> +name of the packager (string) +</dd><dt><i>parent</i></dt> +<dd> +parent widget of this dialog (QWidget) +</dd> +</dl><a NAME="CxfreezeExecDialog.__finish" ID="CxfreezeExecDialog.__finish"></a> +<h4>CxfreezeExecDialog.__finish</h4> +<b>__finish</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="CxfreezeExecDialog.__readStderr" ID="CxfreezeExecDialog.__readStderr"></a> +<h4>CxfreezeExecDialog.__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="CxfreezeExecDialog.__readStdout" ID="CxfreezeExecDialog.__readStdout"></a> +<h4>CxfreezeExecDialog.__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="CxfreezeExecDialog.on_buttonBox_clicked" ID="CxfreezeExecDialog.on_buttonBox_clicked"></a> +<h4>CxfreezeExecDialog.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></dt> +<dd> +button that was clicked (QAbstractButton) +</dd> +</dl><a NAME="CxfreezeExecDialog.start" ID="CxfreezeExecDialog.start"></a> +<h4>CxfreezeExecDialog.start</h4> +<b>start</b>(<i>args, script</i>) +<p> + Public slot to start the packager command. +</p><dl> +<dt><i>args</i></dt> +<dd> +commandline arguments for packager program (list of strings) +</dd><dt><i>script</i></dt> +<dd> +main script name to be processed by by the packager (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +flag indicating the successful start of the process +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file