Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.DataViews.CodeMetricsDialog.html

eric7/Documentation/Source/eric7.DataViews.CodeMetricsDialog.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.DataViews.CodeMetricsDialog</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.DataViews.CodeMetricsDialog</h1>
24
25 <p>
26 Module implementing a code metrics dialog.
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="#CodeMetricsDialog">CodeMetricsDialog</a></td>
39 <td>Class implementing a dialog to display the code metrics.</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="CodeMetricsDialog" ID="CodeMetricsDialog"></a>
50 <h2>CodeMetricsDialog</h2>
51
52 <p>
53 Class implementing a dialog to display the code metrics.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_CodeMetricsDialog
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="#CodeMetricsDialog.__init__">CodeMetricsDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#CodeMetricsDialog.__createResultItem">__createResultItem</a></td>
77 <td>Private slot to create a new item in the result list.</td>
78 </tr>
79 <tr>
80 <td><a href="#CodeMetricsDialog.__createSummaryItem">__createSummaryItem</a></td>
81 <td>Private slot to create a new item in the summary list.</td>
82 </tr>
83 <tr>
84 <td><a href="#CodeMetricsDialog.__finish">__finish</a></td>
85 <td>Private slot called when the action finished or the user pressed the button.</td>
86 </tr>
87 <tr>
88 <td><a href="#CodeMetricsDialog.__getValues">__getValues</a></td>
89 <td>Private method to extract the code metric values.</td>
90 </tr>
91 <tr>
92 <td><a href="#CodeMetricsDialog.__resizeResultColumns">__resizeResultColumns</a></td>
93 <td>Private method to resize the list columns.</td>
94 </tr>
95 <tr>
96 <td><a href="#CodeMetricsDialog.__resizeSummaryColumns">__resizeSummaryColumns</a></td>
97 <td>Private method to resize the list columns.</td>
98 </tr>
99 <tr>
100 <td><a href="#CodeMetricsDialog.__resultCollapse">__resultCollapse</a></td>
101 <td>Private slot to collapse all entries of the resultlist.</td>
102 </tr>
103 <tr>
104 <td><a href="#CodeMetricsDialog.__resultExpand">__resultExpand</a></td>
105 <td>Private slot to expand all entries of the resultlist.</td>
106 </tr>
107 <tr>
108 <td><a href="#CodeMetricsDialog.__showContextMenu">__showContextMenu</a></td>
109 <td>Private slot to show the context menu of the listview.</td>
110 </tr>
111 <tr>
112 <td><a href="#CodeMetricsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
113 <td>Private slot called by a button of the button box clicked.</td>
114 </tr>
115 <tr>
116 <td><a href="#CodeMetricsDialog.on_startButton_clicked">on_startButton_clicked</a></td>
117 <td>Private slot to start a code metrics run.</td>
118 </tr>
119 <tr>
120 <td><a href="#CodeMetricsDialog.prepare">prepare</a></td>
121 <td>Public method to prepare the dialog with a list of filenames.</td>
122 </tr>
123 <tr>
124 <td><a href="#CodeMetricsDialog.start">start</a></td>
125 <td>Public slot to start the code metrics determination.</td>
126 </tr>
127 </table>
128 <h3>Static Methods</h3>
129
130 <table>
131 <tr><td>None</td></tr>
132 </table>
133
134 <a NAME="CodeMetricsDialog.__init__" ID="CodeMetricsDialog.__init__"></a>
135 <h4>CodeMetricsDialog (Constructor)</h4>
136 <b>CodeMetricsDialog</b>(<i>parent=None</i>)
137
138 <p>
139 Constructor
140 </p>
141 <dl>
142
143 <dt><i>parent</i></dt>
144 <dd>
145 parent widget (QWidget)
146 </dd>
147 </dl>
148 <a NAME="CodeMetricsDialog.__createResultItem" ID="CodeMetricsDialog.__createResultItem"></a>
149 <h4>CodeMetricsDialog.__createResultItem</h4>
150 <b>__createResultItem</b>(<i>parent, values</i>)
151
152 <p>
153 Private slot to create a new item in the result list.
154 </p>
155 <dl>
156
157 <dt><i>parent</i></dt>
158 <dd>
159 parent of the new item (QTreeWidget or QTreeWidgetItem)
160 </dd>
161 <dt><i>values</i></dt>
162 <dd>
163 values to be displayed (list)
164 </dd>
165 </dl>
166 <dl>
167 <dt>Return:</dt>
168 <dd>
169 the generated item
170 </dd>
171 </dl>
172 <a NAME="CodeMetricsDialog.__createSummaryItem" ID="CodeMetricsDialog.__createSummaryItem"></a>
173 <h4>CodeMetricsDialog.__createSummaryItem</h4>
174 <b>__createSummaryItem</b>(<i>col0, col1</i>)
175
176 <p>
177 Private slot to create a new item in the summary list.
178 </p>
179 <dl>
180
181 <dt><i>col0</i></dt>
182 <dd>
183 string for column 0 (string)
184 </dd>
185 <dt><i>col1</i></dt>
186 <dd>
187 string for column 1 (string)
188 </dd>
189 </dl>
190 <a NAME="CodeMetricsDialog.__finish" ID="CodeMetricsDialog.__finish"></a>
191 <h4>CodeMetricsDialog.__finish</h4>
192 <b>__finish</b>(<i></i>)
193
194 <p>
195 Private slot called when the action finished or the user pressed the
196 button.
197 </p>
198 <a NAME="CodeMetricsDialog.__getValues" ID="CodeMetricsDialog.__getValues"></a>
199 <h4>CodeMetricsDialog.__getValues</h4>
200 <b>__getValues</b>(<i>loc, stats, identifier</i>)
201
202 <p>
203 Private method to extract the code metric values.
204 </p>
205 <dl>
206
207 <dt><i>loc</i></dt>
208 <dd>
209 reference to the locale object (QLocale)
210 </dd>
211 <dt><i>stats</i></dt>
212 <dd>
213 reference to the code metric statistics object
214 </dd>
215 <dt><i>identifier</i></dt>
216 <dd>
217 identifier to get values for
218 </dd>
219 </dl>
220 <dl>
221 <dt>Return:</dt>
222 <dd>
223 list of values suitable for display (list of strings)
224 </dd>
225 </dl>
226 <a NAME="CodeMetricsDialog.__resizeResultColumns" ID="CodeMetricsDialog.__resizeResultColumns"></a>
227 <h4>CodeMetricsDialog.__resizeResultColumns</h4>
228 <b>__resizeResultColumns</b>(<i></i>)
229
230 <p>
231 Private method to resize the list columns.
232 </p>
233 <a NAME="CodeMetricsDialog.__resizeSummaryColumns" ID="CodeMetricsDialog.__resizeSummaryColumns"></a>
234 <h4>CodeMetricsDialog.__resizeSummaryColumns</h4>
235 <b>__resizeSummaryColumns</b>(<i></i>)
236
237 <p>
238 Private method to resize the list columns.
239 </p>
240 <a NAME="CodeMetricsDialog.__resultCollapse" ID="CodeMetricsDialog.__resultCollapse"></a>
241 <h4>CodeMetricsDialog.__resultCollapse</h4>
242 <b>__resultCollapse</b>(<i></i>)
243
244 <p>
245 Private slot to collapse all entries of the resultlist.
246 </p>
247 <a NAME="CodeMetricsDialog.__resultExpand" ID="CodeMetricsDialog.__resultExpand"></a>
248 <h4>CodeMetricsDialog.__resultExpand</h4>
249 <b>__resultExpand</b>(<i></i>)
250
251 <p>
252 Private slot to expand all entries of the resultlist.
253 </p>
254 <a NAME="CodeMetricsDialog.__showContextMenu" ID="CodeMetricsDialog.__showContextMenu"></a>
255 <h4>CodeMetricsDialog.__showContextMenu</h4>
256 <b>__showContextMenu</b>(<i>coord</i>)
257
258 <p>
259 Private slot to show the context menu of the listview.
260 </p>
261 <dl>
262
263 <dt><i>coord</i></dt>
264 <dd>
265 the position of the mouse pointer (QPoint)
266 </dd>
267 </dl>
268 <a NAME="CodeMetricsDialog.on_buttonBox_clicked" ID="CodeMetricsDialog.on_buttonBox_clicked"></a>
269 <h4>CodeMetricsDialog.on_buttonBox_clicked</h4>
270 <b>on_buttonBox_clicked</b>(<i>button</i>)
271
272 <p>
273 Private slot called by a button of the button box clicked.
274 </p>
275 <dl>
276
277 <dt><i>button</i></dt>
278 <dd>
279 button that was clicked (QAbstractButton)
280 </dd>
281 </dl>
282 <a NAME="CodeMetricsDialog.on_startButton_clicked" ID="CodeMetricsDialog.on_startButton_clicked"></a>
283 <h4>CodeMetricsDialog.on_startButton_clicked</h4>
284 <b>on_startButton_clicked</b>(<i></i>)
285
286 <p>
287 Private slot to start a code metrics run.
288 </p>
289 <a NAME="CodeMetricsDialog.prepare" ID="CodeMetricsDialog.prepare"></a>
290 <h4>CodeMetricsDialog.prepare</h4>
291 <b>prepare</b>(<i>fileList, project</i>)
292
293 <p>
294 Public method to prepare the dialog with a list of filenames.
295 </p>
296 <dl>
297
298 <dt><i>fileList</i></dt>
299 <dd>
300 list of filenames (list of strings)
301 </dd>
302 <dt><i>project</i></dt>
303 <dd>
304 reference to the project object (Project)
305 </dd>
306 </dl>
307 <a NAME="CodeMetricsDialog.start" ID="CodeMetricsDialog.start"></a>
308 <h4>CodeMetricsDialog.start</h4>
309 <b>start</b>(<i>fn</i>)
310
311 <p>
312 Public slot to start the code metrics determination.
313 </p>
314 <dl>
315
316 <dt><i>fn</i></dt>
317 <dd>
318 file or list of files or directory to show
319 the code metrics for (string or list of strings)
320 </dd>
321 </dl>
322 <div align="right"><a href="#top">Up</a></div>
323 <hr />
324 </body></html>

Mercurial Repository: eric

eric ide

mercurial