--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnDialog.html Sat Jan 02 18:19:35 2010 +0000
@@ -0,0 +1,212 @@
+<?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>eric5.Plugins.VcsPlugins.vcsSubversion.SvnDialog</title>
+<style>
+b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n'
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Plugins.VcsPlugins.vcsSubversion.SvnDialog</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="#SvnDialog">SvnDialog</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="SvnDialog" ID="SvnDialog"></a>
+<h2>SvnDialog</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_SvnDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#SvnDialog.__init__">SvnDialog</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#SvnDialog.__finish">__finish</a></td>
+<td>Private slot called when the process finished or the user pressed the button.</td>
+</tr><tr>
+<td><a href="#SvnDialog.__procFinished">__procFinished</a></td>
+<td>Private slot connected to the finished signal.</td>
+</tr><tr>
+<td><a href="#SvnDialog.__readStderr">__readStderr</a></td>
+<td>Private slot to handle the readyReadStderr signal.</td>
+</tr><tr>
+<td><a href="#SvnDialog.__readStdout">__readStdout</a></td>
+<td>Private slot to handle the readyReadStdout signal.</td>
+</tr><tr>
+<td><a href="#SvnDialog.hasAddOrDelete">hasAddOrDelete</a></td>
+<td>Public method to check, if the last action contained an add or delete.</td>
+</tr><tr>
+<td><a href="#SvnDialog.keyPressEvent">keyPressEvent</a></td>
+<td>Protected slot to handle a key press event.</td>
+</tr><tr>
+<td><a href="#SvnDialog.normalExit">normalExit</a></td>
+<td>Public method to check for a normal process termination.</td>
+</tr><tr>
+<td><a href="#SvnDialog.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="#SvnDialog.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="#SvnDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
+<td>Private slot to handle the password checkbox toggled.</td>
+</tr><tr>
+<td><a href="#SvnDialog.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="#SvnDialog.startProcess">startProcess</a></td>
+<td>Public slot used to start the process.</td>
+</tr>
+</table>
+<a NAME="SvnDialog.__init__" ID="SvnDialog.__init__"></a>
+<h4>SvnDialog (Constructor)</h4>
+<b>SvnDialog</b>(<i>text, parent = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>text</i></dt>
+<dd>
+text to be shown by the label (string)
+</dd><dt><i>parent</i></dt>
+<dd>
+parent widget (QWidget)
+</dd>
+</dl><a NAME="SvnDialog.__finish" ID="SvnDialog.__finish"></a>
+<h4>SvnDialog.__finish</h4>
+<b>__finish</b>(<i></i>)
+<p>
+ Private slot called when the process finished or the user pressed the button.
+</p><a NAME="SvnDialog.__procFinished" ID="SvnDialog.__procFinished"></a>
+<h4>SvnDialog.__procFinished</h4>
+<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
+<p>
+ Private slot connected to the finished signal.
+</p><dl>
+<dt><i>exitCode</i></dt>
+<dd>
+exit code of the process (integer)
+</dd><dt><i>exitStatus</i></dt>
+<dd>
+exit status of the process (QProcess.ExitStatus)
+</dd>
+</dl><a NAME="SvnDialog.__readStderr" ID="SvnDialog.__readStderr"></a>
+<h4>SvnDialog.__readStderr</h4>
+<b>__readStderr</b>(<i></i>)
+<p>
+ Private slot to handle the readyReadStderr signal.
+</p><p>
+ It reads the error output of the process and inserts it into the
+ error pane.
+</p><a NAME="SvnDialog.__readStdout" ID="SvnDialog.__readStdout"></a>
+<h4>SvnDialog.__readStdout</h4>
+<b>__readStdout</b>(<i></i>)
+<p>
+ Private slot to handle the readyReadStdout signal.
+</p><p>
+ It reads the output of the process, formats it and inserts it into
+ the contents pane.
+</p><a NAME="SvnDialog.hasAddOrDelete" ID="SvnDialog.hasAddOrDelete"></a>
+<h4>SvnDialog.hasAddOrDelete</h4>
+<b>hasAddOrDelete</b>(<i></i>)
+<p>
+ Public method to check, if the last action contained an add or delete.
+</p><a NAME="SvnDialog.keyPressEvent" ID="SvnDialog.keyPressEvent"></a>
+<h4>SvnDialog.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>evt</i>)
+<p>
+ Protected slot to handle a key press event.
+</p><dl>
+<dt><i>evt</i></dt>
+<dd>
+the key press event (QKeyEvent)
+</dd>
+</dl><a NAME="SvnDialog.normalExit" ID="SvnDialog.normalExit"></a>
+<h4>SvnDialog.normalExit</h4>
+<b>normalExit</b>(<i></i>)
+<p>
+ Public method to check for a normal process termination.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating normal process termination (boolean)
+</dd>
+</dl><a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a>
+<h4>SvnDialog.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="SvnDialog.on_input_returnPressed" ID="SvnDialog.on_input_returnPressed"></a>
+<h4>SvnDialog.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="SvnDialog.on_passwordCheckBox_toggled" ID="SvnDialog.on_passwordCheckBox_toggled"></a>
+<h4>SvnDialog.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></dt>
+<dd>
+flag indicating the status of the check box (boolean)
+</dd>
+</dl><a NAME="SvnDialog.on_sendButton_clicked" ID="SvnDialog.on_sendButton_clicked"></a>
+<h4>SvnDialog.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="SvnDialog.startProcess" ID="SvnDialog.startProcess"></a>
+<h4>SvnDialog.startProcess</h4>
+<b>startProcess</b>(<i>args, workingDir = None</i>)
+<p>
+ Public slot used to start the process.
+</p><dl>
+<dt><i>args</i></dt>
+<dd>
+list of arguments for the process (list of strings)
+</dd><dt><i>workingDir</i></dt>
+<dd>
+working directory for the process (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating a 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
