ProjectPyramid/Documentation/source/Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Project_Pyramid.ProjectPyramid.PyramidDialog</h1>

<p>
Module implementing a dialog starting a process and showing its output.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#PyramidDialog">PyramidDialog</a></td>
<td>Class implementing a dialog starting a process and showing its output.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="PyramidDialog" ID="PyramidDialog"></a>
<h2>PyramidDialog</h2>

<p>
    Class implementing a dialog starting a process and showing its output.
</p>
<p>
    It starts a QProcess and displays a dialog that
    shows the output of the process. The dialog is modal,
    which causes a synchronized execution of the process.
</p>
<h3>Derived from</h3>
QDialog, Ui_PyramidDialog
<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="#PyramidDialog.__init__">PyramidDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PyramidDialog.__procFinished">__procFinished</a></td>
<td>Private slot connected to the finished signal.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.finish">finish</a></td>
<td>Public slot called when the process finished or the user pressed the button.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.keyPressEvent">keyPressEvent</a></td>
<td>Protected slot to handle a key press event.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.normalExit">normalExit</a></td>
<td>Public method to check for a normal process termination.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td>
<td>Public method to check for a normal process termination without error messages.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.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="#PyramidDialog.on_input_returnPressed">on_input_returnPressed</a></td>
<td>Private slot to handle the press of the return key in the input field.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
<td>Private slot to handle the password checkbox toggled.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
<td>Private slot to send the input to the subversion process.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.startBatchProcesses">startBatchProcesses</a></td>
<td>Public slot used to start a batch of processes.</td>
</tr>
<tr>
<td><a href="#PyramidDialog.startProcess">startProcess</a></td>
<td>Public slot used to start the process.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="PyramidDialog.__init__" ID="PyramidDialog.__init__"></a>
<h4>PyramidDialog (Constructor)</h4>
<b>PyramidDialog</b>(<i>text, fixed=False, linewrap=True, msgSuccess=None, msgError=None, combinedOutput=False, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>text</i> (str)</dt>
<dd>
text to be shown by the label
</dd>
<dt><i>fixed</i> (bool)</dt>
<dd>
flag indicating a fixed font should be used
</dd>
<dt><i>linewrap</i> (bool)</dt>
<dd>
flag indicating to wrap long lines
</dd>
<dt><i>msgSuccess</i> (str)</dt>
<dd>
optional string to show upon successful execution
</dd>
<dt><i>msgError</i> (str)</dt>
<dd>
optional string to show upon unsuccessful execution
</dd>
<dt><i>combinedOutput</i> (bool)</dt>
<dd>
flag indicating to combine the output into the
            output pane
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget
</dd>
</dl>
<a NAME="PyramidDialog.__procFinished" ID="PyramidDialog.__procFinished"></a>
<h4>PyramidDialog.__procFinished</h4>
<b>__procFinished</b>(<i>exitCode, exitStatus</i>)

<p>
        Private slot connected to the finished signal.
</p>
<dl>

<dt><i>exitCode</i> (int)</dt>
<dd>
exit code of the process
</dd>
<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
<dd>
exit status of the process
</dd>
</dl>
<a NAME="PyramidDialog.__readStderr" ID="PyramidDialog.__readStderr"></a>
<h4>PyramidDialog.__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="PyramidDialog.__readStdout" ID="PyramidDialog.__readStdout"></a>
<h4>PyramidDialog.__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="PyramidDialog.finish" ID="PyramidDialog.finish"></a>
<h4>PyramidDialog.finish</h4>
<b>finish</b>(<i></i>)

<p>
        Public slot called when the process finished or the user pressed the
        button.
</p>
<a NAME="PyramidDialog.keyPressEvent" ID="PyramidDialog.keyPressEvent"></a>
<h4>PyramidDialog.keyPressEvent</h4>
<b>keyPressEvent</b>(<i>evt</i>)

<p>
        Protected slot to handle a key press event.
</p>
<dl>

<dt><i>evt</i> (QKeyEvent)</dt>
<dd>
the key press event
</dd>
</dl>
<a NAME="PyramidDialog.normalExit" ID="PyramidDialog.normalExit"></a>
<h4>PyramidDialog.normalExit</h4>
<b>normalExit</b>(<i></i>)

<p>
        Public method to check for a normal process termination.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating normal process termination
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="PyramidDialog.normalExitWithoutErrors" ID="PyramidDialog.normalExitWithoutErrors"></a>
<h4>PyramidDialog.normalExitWithoutErrors</h4>
<b>normalExitWithoutErrors</b>(<i></i>)

<p>
        Public method to check for a normal process termination without
        error messages.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating normal process termination
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="PyramidDialog.on_buttonBox_clicked" ID="PyramidDialog.on_buttonBox_clicked"></a>
<h4>PyramidDialog.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="PyramidDialog.on_input_returnPressed" ID="PyramidDialog.on_input_returnPressed"></a>
<h4>PyramidDialog.on_input_returnPressed</h4>
<b>on_input_returnPressed</b>(<i></i>)

<p>
        Private slot to handle the press of the return key in the input field.
</p>
<a NAME="PyramidDialog.on_passwordCheckBox_toggled" ID="PyramidDialog.on_passwordCheckBox_toggled"></a>
<h4>PyramidDialog.on_passwordCheckBox_toggled</h4>
<b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)

<p>
        Private slot to handle the password checkbox toggled.
</p>
<dl>

<dt><i>isOn</i> (bool)</dt>
<dd>
flag indicating the status of the check box
</dd>
</dl>
<a NAME="PyramidDialog.on_sendButton_clicked" ID="PyramidDialog.on_sendButton_clicked"></a>
<h4>PyramidDialog.on_sendButton_clicked</h4>
<b>on_sendButton_clicked</b>(<i></i>)

<p>
        Private slot to send the input to the subversion process.
</p>
<a NAME="PyramidDialog.startBatchProcesses" ID="PyramidDialog.startBatchProcesses"></a>
<h4>PyramidDialog.startBatchProcesses</h4>
<b>startBatchProcesses</b>(<i>argsLists, workingDir=None</i>)

<p>
        Public slot used to start a batch of processes.
</p>
<dl>

<dt><i>argsLists</i> (list of list of str)</dt>
<dd>
list of lists of arguments for the processes
</dd>
<dt><i>workingDir</i> (str)</dt>
<dd>
working directory for the process
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a successful start of the first process
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="PyramidDialog.startProcess" ID="PyramidDialog.startProcess"></a>
<h4>PyramidDialog.startProcess</h4>
<b>startProcess</b>(<i>command, args, workingDir=None, showArgs=True</i>)

<p>
        Public slot used to start the process.
</p>
<dl>

<dt><i>command</i> (str)</dt>
<dd>
command to start
</dd>
<dt><i>args</i> (list of str)</dt>
<dd>
list of arguments for the process
</dd>
<dt><i>workingDir</i> (str)</dt>
<dd>
working directory for the process
</dd>
<dt><i>showArgs</i> (bool)</dt>
<dd>
flag indicating to show the arguments
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a 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>