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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitPatchStatisticsDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitPatchStatisticsDialog</h1>
10
11 <p>
12 Module implementing a dialog to show some patch file statistics.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#GitPatchStatisticsDialog">GitPatchStatisticsDialog</a></td>
25 <td>Class implementing a dialog to show some patch file statistics.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="GitPatchStatisticsDialog" ID="GitPatchStatisticsDialog"></a>
36 <h2>GitPatchStatisticsDialog</h2>
37
38 <p>
39 Class implementing a dialog to show some patch file statistics.
40 </p>
41 <h3>Derived from</h3>
42 QDialog, Ui_GitPatchStatisticsDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#GitPatchStatisticsDialog.__init__">GitPatchStatisticsDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#GitPatchStatisticsDialog.__createStatisticsItem">__createStatisticsItem</a></td>
63 <td>Private method to create a file statistics entry.</td>
64 </tr>
65 <tr>
66 <td><a href="#GitPatchStatisticsDialog.__resizeColumns">__resizeColumns</a></td>
67 <td>Private method to resize the list columns.</td>
68 </tr>
69 <tr>
70 <td><a href="#GitPatchStatisticsDialog.getData">getData</a></td>
71 <td>Public method to get the data used to generate the statistics.</td>
72 </tr>
73 <tr>
74 <td><a href="#GitPatchStatisticsDialog.start">start</a></td>
75 <td>Public method to start the statistics process.</td>
76 </tr>
77 </table>
78 <h3>Static Methods</h3>
79
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83
84 <a NAME="GitPatchStatisticsDialog.__init__" ID="GitPatchStatisticsDialog.__init__"></a>
85 <h4>GitPatchStatisticsDialog (Constructor)</h4>
86 <b>GitPatchStatisticsDialog</b>(<i>vcs, parent=None</i>)
87
88 <p>
89 Constructor
90 </p>
91 <dl>
92
93 <dt><i>vcs</i></dt>
94 <dd>
95 reference to the VCS object (Git)
96 </dd>
97 <dt><i>parent</i></dt>
98 <dd>
99 reference to the parent widget (QWidget)
100 </dd>
101 </dl>
102 <a NAME="GitPatchStatisticsDialog.__createStatisticsItem" ID="GitPatchStatisticsDialog.__createStatisticsItem"></a>
103 <h4>GitPatchStatisticsDialog.__createStatisticsItem</h4>
104 <b>__createStatisticsItem</b>(<i>line</i>)
105
106 <p>
107 Private method to create a file statistics entry.
108 </p>
109 <dl>
110
111 <dt><i>line</i></dt>
112 <dd>
113 string with file statistics data (string)
114 </dd>
115 </dl>
116 <a NAME="GitPatchStatisticsDialog.__resizeColumns" ID="GitPatchStatisticsDialog.__resizeColumns"></a>
117 <h4>GitPatchStatisticsDialog.__resizeColumns</h4>
118 <b>__resizeColumns</b>(<i></i>)
119
120 <p>
121 Private method to resize the list columns.
122 </p>
123 <a NAME="GitPatchStatisticsDialog.getData" ID="GitPatchStatisticsDialog.getData"></a>
124 <h4>GitPatchStatisticsDialog.getData</h4>
125 <b>getData</b>(<i></i>)
126
127 <p>
128 Public method to get the data used to generate the statistics.
129 </p>
130 <dl>
131 <dt>Return:</dt>
132 <dd>
133 tuple of list of patch files, strip count, flag indicating
134 that the patch has inaccurate end-of-file marker and a flag
135 indicating to not trust the line count information
136 (list of string, integer, boolean, boolean)
137 </dd>
138 </dl>
139 <a NAME="GitPatchStatisticsDialog.start" ID="GitPatchStatisticsDialog.start"></a>
140 <h4>GitPatchStatisticsDialog.start</h4>
141 <b>start</b>(<i>projectDir, patchCheckData</i>)
142
143 <p>
144 Public method to start the statistics process.
145 </p>
146 <dl>
147
148 <dt><i>projectDir</i></dt>
149 <dd>
150 directory name of the project (string)
151 </dd>
152 <dt><i>patchCheckData</i></dt>
153 <dd>
154 tuple of data as returned by the
155 GitPatchFilesDialog.getData() method
156 </dd>
157 </dl>
158 <div align="right"><a href="#top">Up</a></div>
159 <hr />
160 </body></html>

eric ide

mercurial