src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitPatchStatisticsDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.Plugins.VcsPlugins.vcsGit.GitPatchStatisticsDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Plugins.VcsPlugins.vcsGit.GitPatchStatisticsDialog</h1>
<p>
Module implementing a dialog to show some patch file statistics.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#GitPatchStatisticsDialog">GitPatchStatisticsDialog</a></td>
<td>Class implementing a dialog to show some patch file statistics.</td>
</tr>
</table>

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

<hr />
<hr />
<a NAME="GitPatchStatisticsDialog" ID="GitPatchStatisticsDialog"></a>
<h2>GitPatchStatisticsDialog</h2>
<p>
    Class implementing a dialog to show some patch file statistics.
</p>

<h3>Derived from</h3>
QDialog, Ui_GitPatchStatisticsDialog
<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="#GitPatchStatisticsDialog.__init__">GitPatchStatisticsDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#GitPatchStatisticsDialog.__createStatisticsItem">__createStatisticsItem</a></td>
<td>Private method to create a file statistics entry.</td>
</tr>
<tr>
<td><a href="#GitPatchStatisticsDialog.__resizeColumns">__resizeColumns</a></td>
<td>Private method to resize the list columns.</td>
</tr>
<tr>
<td><a href="#GitPatchStatisticsDialog.getData">getData</a></td>
<td>Public method to get the data used to generate the statistics.</td>
</tr>
<tr>
<td><a href="#GitPatchStatisticsDialog.start">start</a></td>
<td>Public method to start the statistics process.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="GitPatchStatisticsDialog.__init__" ID="GitPatchStatisticsDialog.__init__"></a>
<h4>GitPatchStatisticsDialog (Constructor)</h4>
<b>GitPatchStatisticsDialog</b>(<i>vcs, parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>vcs</i> (Git)</dt>
<dd>
reference to the VCS object (Git)
</dd>
<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent widget
</dd>
</dl>
<a NAME="GitPatchStatisticsDialog.__createStatisticsItem" ID="GitPatchStatisticsDialog.__createStatisticsItem"></a>
<h4>GitPatchStatisticsDialog.__createStatisticsItem</h4>
<b>__createStatisticsItem</b>(<i>line</i>)
<p>
        Private method to create a file statistics entry.
</p>

<dl>

<dt><i>line</i> (str)</dt>
<dd>
string with file statistics data
</dd>
</dl>
<a NAME="GitPatchStatisticsDialog.__resizeColumns" ID="GitPatchStatisticsDialog.__resizeColumns"></a>
<h4>GitPatchStatisticsDialog.__resizeColumns</h4>
<b>__resizeColumns</b>(<i></i>)
<p>
        Private method to resize the list columns.
</p>

<a NAME="GitPatchStatisticsDialog.getData" ID="GitPatchStatisticsDialog.getData"></a>
<h4>GitPatchStatisticsDialog.getData</h4>
<b>getData</b>(<i></i>)
<p>
        Public method to get the data used to generate the statistics.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple of list of patch files, strip count, flag indicating
            that the patch has inaccurate end-of-file marker and a flag
            indicating to not trust the line count information
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (list of str, int, bool, bool)
</dd>
</dl>
<a NAME="GitPatchStatisticsDialog.start" ID="GitPatchStatisticsDialog.start"></a>
<h4>GitPatchStatisticsDialog.start</h4>
<b>start</b>(<i>projectDir, patchCheckData</i>)
<p>
        Public method to start the statistics process.
</p>

<dl>

<dt><i>projectDir</i> (str)</dt>
<dd>
directory name of the project
</dd>
<dt><i>patchCheckData</i> (tuple of (list of str, int, bool, bool))</dt>
<dd>
tuple of data as returned by the
            GitPatchFilesDialog.getData() method
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>