--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/eric5.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog.html Sat Jan 02 18:19:35 2010 +0000 @@ -0,0 +1,239 @@ +<?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.SvnDiffDialog</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.SvnDiffDialog</h1> +<p> +Module implementing a dialog to show the output of the svn diff command process. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr> +<td><a href="#SvnDiffDialog">SvnDiffDialog</a></td> +<td>Class implementing a dialog to show the output of the svn diff command process.</td> +</tr> +</table> +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> +<hr /><hr /> +<a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a> +<h2>SvnDiffDialog</h2> +<p> + Class implementing a dialog to show the output of the svn diff command process. +</p> +<h3>Derived from</h3> +QWidget, Ui_SvnDiffDialog +<h3>Class Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> +<table> +<tr> +<td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td> +<td>Constructor</td> +</tr><tr> +<td><a href="#SvnDiffDialog.__appendText">__appendText</a></td> +<td>Private method to append text to the end of the contents pane.</td> +</tr><tr> +<td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td> +<td>Private method to get a svn revision argument for the given revision.</td> +</tr><tr> +<td><a href="#SvnDiffDialog.__procFinished">__procFinished</a></td> +<td>Private slot connected to the finished signal.</td> +</tr><tr> +<td><a href="#SvnDiffDialog.__readStderr">__readStderr</a></td> +<td>Private slot to handle the readyReadStandardError signal.</td> +</tr><tr> +<td><a href="#SvnDiffDialog.__readStdout">__readStdout</a></td> +<td>Private slot to handle the readyReadStandardOutput signal.</td> +</tr><tr> +<td><a href="#SvnDiffDialog.closeEvent">closeEvent</a></td> +<td>Private slot implementing a close event handler.</td> +</tr><tr> +<td><a href="#SvnDiffDialog.keyPressEvent">keyPressEvent</a></td> +<td>Protected slot to handle a key press event.</td> +</tr><tr> +<td><a href="#SvnDiffDialog.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="#SvnDiffDialog.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="#SvnDiffDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> +<td>Private slot to handle the password checkbox toggled.</td> +</tr><tr> +<td><a href="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td> +<td>Private slot to handle the Save button press.</td> +</tr><tr> +<td><a href="#SvnDiffDialog.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="#SvnDiffDialog.start">start</a></td> +<td>Public slot to start the svn diff command.</td> +</tr> +</table> +<a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a> +<h4>SvnDiffDialog (Constructor)</h4> +<b>SvnDiffDialog</b>(<i>vcs, parent = None</i>) +<p> + Constructor +</p><dl> +<dt><i>vcs</i></dt> +<dd> +reference to the vcs object +</dd><dt><i>parent</i></dt> +<dd> +parent widget (QWidget) +</dd> +</dl><a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a> +<h4>SvnDiffDialog.__appendText</h4> +<b>__appendText</b>(<i>txt, format</i>) +<p> + Private method to append text to the end of the contents pane. +</p><dl> +<dt><i>txt</i></dt> +<dd> +text to insert (string) +</dd><dt><i>format</i></dt> +<dd> +text format to be used (QTextCharFormat) +</dd> +</dl><a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a> +<h4>SvnDiffDialog.__getVersionArg</h4> +<b>__getVersionArg</b>(<i>version</i>) +<p> + Private method to get a svn revision argument for the given revision. +</p><dl> +<dt><i>version</i></dt> +<dd> +revision (integer or string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +version argument (string) +</dd> +</dl><a NAME="SvnDiffDialog.__procFinished" ID="SvnDiffDialog.__procFinished"></a> +<h4>SvnDiffDialog.__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="SvnDiffDialog.__readStderr" ID="SvnDiffDialog.__readStderr"></a> +<h4>SvnDiffDialog.__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="SvnDiffDialog.__readStdout" ID="SvnDiffDialog.__readStdout"></a> +<h4>SvnDiffDialog.__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="SvnDiffDialog.closeEvent" ID="SvnDiffDialog.closeEvent"></a> +<h4>SvnDiffDialog.closeEvent</h4> +<b>closeEvent</b>(<i>e</i>) +<p> + Private slot implementing a close event handler. +</p><dl> +<dt><i>e</i></dt> +<dd> +close event (QCloseEvent) +</dd> +</dl><a NAME="SvnDiffDialog.keyPressEvent" ID="SvnDiffDialog.keyPressEvent"></a> +<h4>SvnDiffDialog.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="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a> +<h4>SvnDiffDialog.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="SvnDiffDialog.on_input_returnPressed" ID="SvnDiffDialog.on_input_returnPressed"></a> +<h4>SvnDiffDialog.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="SvnDiffDialog.on_passwordCheckBox_toggled" ID="SvnDiffDialog.on_passwordCheckBox_toggled"></a> +<h4>SvnDiffDialog.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="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a> +<h4>SvnDiffDialog.on_saveButton_clicked</h4> +<b>on_saveButton_clicked</b>(<i></i>) +<p> + Private slot to handle the Save button press. +</p><p> + It saves the diff shown in the dialog to a file in the local + filesystem. +</p><a NAME="SvnDiffDialog.on_sendButton_clicked" ID="SvnDiffDialog.on_sendButton_clicked"></a> +<h4>SvnDiffDialog.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="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a> +<h4>SvnDiffDialog.start</h4> +<b>start</b>(<i>fn, versions = None, urls = None, summary = False</i>) +<p> + Public slot to start the svn diff command. +</p><dl> +<dt><i>fn</i></dt> +<dd> +filename to be diffed (string) +</dd><dt><i>versions</i></dt> +<dd> +list of versions to be diffed (list of up to 2 strings or None) +</dd><dt><i>urls=</i></dt> +<dd> +list of repository URLs (list of 2 strings) +</dd><dt><i>summary=</i></dt> +<dd> +flag indicating a summarizing diff + (only valid for URL diffs) (boolean) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file