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

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

eric ide

mercurial