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

changeset 6020
baf6da1ae288
equal deleted inserted replaced
6019:58ecdaf0b789 6020:baf6da1ae288
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsGit.GitPatchStatisticsDialog</h1>
23 <p>
24 Module implementing a dialog to show some patch file statistics.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#GitPatchStatisticsDialog">GitPatchStatisticsDialog</a></td>
34 <td>Class implementing a dialog to show some patch file statistics.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="GitPatchStatisticsDialog" ID="GitPatchStatisticsDialog"></a>
43 <h2>GitPatchStatisticsDialog</h2>
44 <p>
45 Class implementing a dialog to show some patch file statistics.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_GitPatchStatisticsDialog
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#GitPatchStatisticsDialog.__init__">GitPatchStatisticsDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#GitPatchStatisticsDialog.__createStatisticsItem">__createStatisticsItem</a></td>
64 <td>Private method to create a file statistics entry.</td>
65 </tr><tr>
66 <td><a href="#GitPatchStatisticsDialog.__resizeColumns">__resizeColumns</a></td>
67 <td>Private method to resize the list columns.</td>
68 </tr><tr>
69 <td><a href="#GitPatchStatisticsDialog.getData">getData</a></td>
70 <td>Public method to get the data used to generate the statistics.</td>
71 </tr><tr>
72 <td><a href="#GitPatchStatisticsDialog.start">start</a></td>
73 <td>Public method to start the statistics process.</td>
74 </tr>
75 </table>
76 <h3>Static Methods</h3>
77 <table>
78 <tr><td>None</td></tr>
79 </table>
80 <a NAME="GitPatchStatisticsDialog.__init__" ID="GitPatchStatisticsDialog.__init__"></a>
81 <h4>GitPatchStatisticsDialog (Constructor)</h4>
82 <b>GitPatchStatisticsDialog</b>(<i>vcs, parent=None</i>)
83 <p>
84 Constructor
85 </p><dl>
86 <dt><i>vcs</i></dt>
87 <dd>
88 reference to the VCS object (Git)
89 </dd><dt><i>parent</i></dt>
90 <dd>
91 reference to the parent widget (QWidget)
92 </dd>
93 </dl><a NAME="GitPatchStatisticsDialog.__createStatisticsItem" ID="GitPatchStatisticsDialog.__createStatisticsItem"></a>
94 <h4>GitPatchStatisticsDialog.__createStatisticsItem</h4>
95 <b>__createStatisticsItem</b>(<i>line</i>)
96 <p>
97 Private method to create a file statistics entry.
98 </p><dl>
99 <dt><i>line</i></dt>
100 <dd>
101 string with file statistics data (string)
102 </dd>
103 </dl><a NAME="GitPatchStatisticsDialog.__resizeColumns" ID="GitPatchStatisticsDialog.__resizeColumns"></a>
104 <h4>GitPatchStatisticsDialog.__resizeColumns</h4>
105 <b>__resizeColumns</b>(<i></i>)
106 <p>
107 Private method to resize the list columns.
108 </p><a NAME="GitPatchStatisticsDialog.getData" ID="GitPatchStatisticsDialog.getData"></a>
109 <h4>GitPatchStatisticsDialog.getData</h4>
110 <b>getData</b>(<i></i>)
111 <p>
112 Public method to get the data used to generate the statistics.
113 </p><dl>
114 <dt>Returns:</dt>
115 <dd>
116 tuple of list of patch files, strip count, flag indicating
117 that the patch has inaccurate end-of-file marker and a flag
118 indicating to not trust the line count information
119 (list of string, integer, boolean, boolean)
120 </dd>
121 </dl><a NAME="GitPatchStatisticsDialog.start" ID="GitPatchStatisticsDialog.start"></a>
122 <h4>GitPatchStatisticsDialog.start</h4>
123 <b>start</b>(<i>projectDir, patchCheckData</i>)
124 <p>
125 Public method to start the statistics process.
126 </p><dl>
127 <dt><i>projectDir</i></dt>
128 <dd>
129 directory name of the project (string)
130 </dd><dt><i>patchCheckData</i></dt>
131 <dd>
132 tuple of data as returned by the
133 GitPatchFilesDialog.getData() method
134 </dd>
135 </dl>
136 <div align="right"><a href="#top">Up</a></div>
137 <hr />
138 </body></html>

eric ide

mercurial