tip/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgDiffDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.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.__generatorFinished">__generatorFinished</a></td>
<td>Private slot connected to the finished signal.</td>
</tr>
<tr>
<td><a href="#HgDiffDialog.closeEvent">closeEvent</a></td>
<td>Protected slot implementing a close event handler.</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_filesCombo_activated">on_filesCombo_activated</a></td>
<td>Private slot to handle the selection of a file.</td>
</tr>
<tr>
<td><a href="#HgDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
<td>Private slot to refresh the display.</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.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> (Hg)</dt>
<dd>
reference to the vcs object
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget
</dd>
</dl>
<a NAME="HgDiffDialog.__generatorFinished" ID="HgDiffDialog.__generatorFinished"></a>
<h4>HgDiffDialog.__generatorFinished</h4>
<b>__generatorFinished</b>(<i></i>)
<p>
        Private slot connected to the finished signal.
</p>

<a NAME="HgDiffDialog.closeEvent" ID="HgDiffDialog.closeEvent"></a>
<h4>HgDiffDialog.closeEvent</h4>
<b>closeEvent</b>(<i>e</i>)
<p>
        Protected slot implementing a close event handler.
</p>

<dl>

<dt><i>e</i> (QCloseEvent)</dt>
<dd>
close event
</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> (QAbstractButton)</dt>
<dd>
button that was clicked
</dd>
</dl>
<a NAME="HgDiffDialog.on_filesCombo_activated" ID="HgDiffDialog.on_filesCombo_activated"></a>
<h4>HgDiffDialog.on_filesCombo_activated</h4>
<b>on_filesCombo_activated</b>(<i>index</i>)
<p>
        Private slot to handle the selection of a file.
</p>

<dl>

<dt><i>index</i> (int)</dt>
<dd>
activated row
</dd>
</dl>
<a NAME="HgDiffDialog.on_refreshButton_clicked" ID="HgDiffDialog.on_refreshButton_clicked"></a>
<h4>HgDiffDialog.on_refreshButton_clicked</h4>
<b>on_refreshButton_clicked</b>(<i></i>)
<p>
        Private slot to refresh the display.
</p>

<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.start" ID="HgDiffDialog.start"></a>
<h4>HgDiffDialog.start</h4>
<b>start</b>(<i>fn, versions=None, bundle=None, qdiff=False, refreshable=False</i>)
<p>
        Public slot to start the hg diff command.
</p>

<dl>

<dt><i>fn</i> (str)</dt>
<dd>
filename to be diffed
</dd>
<dt><i>versions</i> (list of [str, str])</dt>
<dd>
list of versions to be diffed or None
</dd>
<dt><i>bundle</i> (str)</dt>
<dd>
name of a bundle file
</dd>
<dt><i>qdiff</i> (bool)</dt>
<dd>
flag indicating qdiff command shall be used
</dd>
<dt><i>refreshable</i> (bool)</dt>
<dd>
flag indicating a refreshable diff
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>