Documentation/Source/eric5.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog.html

<?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.vcsMercurial.HgDiffDialog</title>
<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>eric5.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</h1>
<p>
Module implementing a dialog to show the output of the hg diff command process.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#HgDiffDialog">HgDiffDialog</a></td>
<td>Class implementing a dialog to show the output of the hg diff command process.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="HgDiffDialog" ID="HgDiffDialog"></a>
<h2>HgDiffDialog</h2>
<p>
    Class implementing a dialog to show the output of the hg diff command process.
</p>
<h3>Derived from</h3>
QWidget, Ui_HgDiffDialog
<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="#HgDiffDialog.__init__">HgDiffDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#HgDiffDialog.__appendText">__appendText</a></td>
<td>Private method to append text to the end of the contents pane.</td>
</tr><tr>
<td><a href="#HgDiffDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished or the user pressed the button.</td>
</tr><tr>
<td><a href="#HgDiffDialog.__getVersionArg">__getVersionArg</a></td>
<td>Private method to get a hg revision argument for the given revision.</td>
</tr><tr>
<td><a href="#HgDiffDialog.__procFinished">__procFinished</a></td>
<td>Private slot connected to the finished signal.</td>
</tr><tr>
<td><a href="#HgDiffDialog.__processOutputLine">__processOutputLine</a></td>
<td>Private method to process the lines of output.</td>
</tr><tr>
<td><a href="#HgDiffDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal.</td>
</tr><tr>
<td><a href="#HgDiffDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal.</td>
</tr><tr>
<td><a href="#HgDiffDialog.__showError">__showError</a></td>
<td>Private slot to show some error.</td>
</tr><tr>
<td><a href="#HgDiffDialog.closeEvent">closeEvent</a></td>
<td>Private slot implementing a close event handler.</td>
</tr><tr>
<td><a href="#HgDiffDialog.keyPressEvent">keyPressEvent</a></td>
<td>Protected slot to handle a key press event.</td>
</tr><tr>
<td><a href="#HgDiffDialog.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="#HgDiffDialog.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="#HgDiffDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
<td>Private slot to handle the password checkbox toggled.</td>
</tr><tr>
<td><a href="#HgDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
<td>Private slot to handle the Save button press.</td>
</tr><tr>
<td><a href="#HgDiffDialog.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="#HgDiffDialog.start">start</a></td>
<td>Public slot to start the hg diff command.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="HgDiffDialog.__init__" ID="HgDiffDialog.__init__"></a>
<h4>HgDiffDialog (Constructor)</h4>
<b>HgDiffDialog</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="HgDiffDialog.__appendText" ID="HgDiffDialog.__appendText"></a>
<h4>HgDiffDialog.__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="HgDiffDialog.__finish" ID="HgDiffDialog.__finish"></a>
<h4>HgDiffDialog.__finish</h4>
<b>__finish</b>(<i></i>)
<p>
        Private slot called when the process finished or the user pressed the button.
</p><a NAME="HgDiffDialog.__getVersionArg" ID="HgDiffDialog.__getVersionArg"></a>
<h4>HgDiffDialog.__getVersionArg</h4>
<b>__getVersionArg</b>(<i>version</i>)
<p>
        Private method to get a hg 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="HgDiffDialog.__procFinished" ID="HgDiffDialog.__procFinished"></a>
<h4>HgDiffDialog.__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="HgDiffDialog.__processOutputLine" ID="HgDiffDialog.__processOutputLine"></a>
<h4>HgDiffDialog.__processOutputLine</h4>
<b>__processOutputLine</b>(<i>line</i>)
<p>
        Private method to process the lines of output.
</p><dl>
<dt><i>line</i></dt>
<dd>
output line to be processed (string)
</dd>
</dl><a NAME="HgDiffDialog.__readStderr" ID="HgDiffDialog.__readStderr"></a>
<h4>HgDiffDialog.__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="HgDiffDialog.__readStdout" ID="HgDiffDialog.__readStdout"></a>
<h4>HgDiffDialog.__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="HgDiffDialog.__showError" ID="HgDiffDialog.__showError"></a>
<h4>HgDiffDialog.__showError</h4>
<b>__showError</b>(<i>out</i>)
<p>
        Private slot to show some error.
</p><dl>
<dt><i>out</i></dt>
<dd>
error to be shown (string)
</dd>
</dl><a NAME="HgDiffDialog.closeEvent" ID="HgDiffDialog.closeEvent"></a>
<h4>HgDiffDialog.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="HgDiffDialog.keyPressEvent" ID="HgDiffDialog.keyPressEvent"></a>
<h4>HgDiffDialog.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="HgDiffDialog.on_buttonBox_clicked" ID="HgDiffDialog.on_buttonBox_clicked"></a>
<h4>HgDiffDialog.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="HgDiffDialog.on_input_returnPressed" ID="HgDiffDialog.on_input_returnPressed"></a>
<h4>HgDiffDialog.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="HgDiffDialog.on_passwordCheckBox_toggled" ID="HgDiffDialog.on_passwordCheckBox_toggled"></a>
<h4>HgDiffDialog.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="HgDiffDialog.on_saveButton_clicked" ID="HgDiffDialog.on_saveButton_clicked"></a>
<h4>HgDiffDialog.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="HgDiffDialog.on_sendButton_clicked" ID="HgDiffDialog.on_sendButton_clicked"></a>
<h4>HgDiffDialog.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="HgDiffDialog.start" ID="HgDiffDialog.start"></a>
<h4>HgDiffDialog.start</h4>
<b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False</i>)
<p>
        Public slot to start the hg 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>bundle</i></dt>
<dd>
name of a bundle file (string)
</dd><dt><i>qdiff</i></dt>
<dd>
flag indicating qdiff command shall be used (boolean)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>