src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsMercurial.HgAnnotateDialog</h1>

<p>
Module implementing a dialog to show the output of the hg annotate command.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#HgAnnotateDialog">HgAnnotateDialog</a></td>
<td>Class implementing a dialog to show the output of the hg annotate command.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class implementing a dialog to show the output of the hg annotate command.
</p>
<h3>Derived from</h3>
QDialog, Ui_HgAnnotateDialog
<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="#HgAnnotateDialog.__init__">HgAnnotateDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HgAnnotateDialog.__buildSkipList">__buildSkipList</a></td>
<td>Private method to build a program arguments list of changesets to be skipped.</td>
</tr>
<tr>
<td><a href="#HgAnnotateDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished or the user pressed the button.</td>
</tr>
<tr>
<td><a href="#HgAnnotateDialog.__generateItem">__generateItem</a></td>
<td>Private method to generate an annotate item in the annotation list.</td>
</tr>
<tr>
<td><a href="#HgAnnotateDialog.__processOutputLine">__processOutputLine</a></td>
<td>Private method to process the lines of output.</td>
</tr>
<tr>
<td><a href="#HgAnnotateDialog.__resizeColumns">__resizeColumns</a></td>
<td>Private method to resize the list columns.</td>
</tr>
<tr>
<td><a href="#HgAnnotateDialog.__showError">__showError</a></td>
<td>Private slot to show some error.</td>
</tr>
<tr>
<td><a href="#HgAnnotateDialog.closeEvent">closeEvent</a></td>
<td>Protected slot implementing a close event handler.</td>
</tr>
<tr>
<td><a href="#HgAnnotateDialog.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="#HgAnnotateDialog.start">start</a></td>
<td>Public slot to start the annotate command.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="HgAnnotateDialog.__init__" ID="HgAnnotateDialog.__init__"></a>
<h4>HgAnnotateDialog (Constructor)</h4>
<b>HgAnnotateDialog</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="HgAnnotateDialog.__buildSkipList" ID="HgAnnotateDialog.__buildSkipList"></a>
<h4>HgAnnotateDialog.__buildSkipList</h4>
<b>__buildSkipList</b>(<i>skiplist</i>)

<p>
        Private method to build a program arguments list of changesets to be skipped.
</p>
<dl>

<dt><i>skiplist</i> (str)</dt>
<dd>
name of a skip list file
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
list of arguments
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
list of str
</dd>
</dl>
<a NAME="HgAnnotateDialog.__finish" ID="HgAnnotateDialog.__finish"></a>
<h4>HgAnnotateDialog.__finish</h4>
<b>__finish</b>(<i></i>)

<p>
        Private slot called when the process finished or the user pressed
        the button.
</p>
<a NAME="HgAnnotateDialog.__generateItem" ID="HgAnnotateDialog.__generateItem"></a>
<h4>HgAnnotateDialog.__generateItem</h4>
<b>__generateItem</b>(<i>marker, revision, changeset, author, date, text</i>)

<p>
        Private method to generate an annotate item in the annotation list.
</p>
<dl>

<dt><i>marker</i></dt>
<dd>
marker character for skipped revisions (string)
</dd>
<dt><i>revision</i></dt>
<dd>
revision string (string)
</dd>
<dt><i>changeset</i></dt>
<dd>
changeset string (string)
</dd>
<dt><i>author</i></dt>
<dd>
author of the change (string)
</dd>
<dt><i>date</i></dt>
<dd>
date of the change (string)
</dd>
<dt><i>text</i></dt>
<dd>
text of the change (string)
</dd>
</dl>
<a NAME="HgAnnotateDialog.__processOutputLine" ID="HgAnnotateDialog.__processOutputLine"></a>
<h4>HgAnnotateDialog.__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="HgAnnotateDialog.__resizeColumns" ID="HgAnnotateDialog.__resizeColumns"></a>
<h4>HgAnnotateDialog.__resizeColumns</h4>
<b>__resizeColumns</b>(<i></i>)

<p>
        Private method to resize the list columns.
</p>
<a NAME="HgAnnotateDialog.__showError" ID="HgAnnotateDialog.__showError"></a>
<h4>HgAnnotateDialog.__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="HgAnnotateDialog.closeEvent" ID="HgAnnotateDialog.closeEvent"></a>
<h4>HgAnnotateDialog.closeEvent</h4>
<b>closeEvent</b>(<i>e</i>)

<p>
        Protected slot implementing a close event handler.
</p>
<dl>

<dt><i>e</i></dt>
<dd>
close event (QCloseEvent)
</dd>
</dl>
<a NAME="HgAnnotateDialog.on_buttonBox_clicked" ID="HgAnnotateDialog.on_buttonBox_clicked"></a>
<h4>HgAnnotateDialog.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="HgAnnotateDialog.start" ID="HgAnnotateDialog.start"></a>
<h4>HgAnnotateDialog.start</h4>
<b>start</b>(<i>fn, skiplist=""</i>)

<p>
        Public slot to start the annotate command.
</p>
<dl>

<dt><i>fn</i> (str)</dt>
<dd>
filename to show the annotation for
</dd>
<dt><i>skiplist</i> (str)</dt>
<dd>
name of a skip list file
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>