Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.DataViews.CodeMetricsDialog.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.DataViews.CodeMetricsDialog</h1>
23 <p>
24 Module implementing a code metrics dialog.
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="#CodeMetricsDialog">CodeMetricsDialog</a></td>
34 <td>Class implementing a dialog to display the code metrics.</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="CodeMetricsDialog" ID="CodeMetricsDialog"></a>
43 <h2>CodeMetricsDialog</h2>
44 <p>
45 Class implementing a dialog to display the code metrics.
46 </p>
47 <h3>Derived from</h3>
48 QDialog, Ui_CodeMetricsDialog
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="#CodeMetricsDialog.__init__">CodeMetricsDialog</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#CodeMetricsDialog.__createResultItem">__createResultItem</a></td>
64 <td>Private slot to create a new item in the result list.</td>
65 </tr><tr>
66 <td><a href="#CodeMetricsDialog.__createSummaryItem">__createSummaryItem</a></td>
67 <td>Private slot to create a new item in the summary list.</td>
68 </tr><tr>
69 <td><a href="#CodeMetricsDialog.__finish">__finish</a></td>
70 <td>Private slot called when the action finished or the user pressed the button.</td>
71 </tr><tr>
72 <td><a href="#CodeMetricsDialog.__getValues">__getValues</a></td>
73 <td>Private method to extract the code metric values.</td>
74 </tr><tr>
75 <td><a href="#CodeMetricsDialog.__resizeResultColumns">__resizeResultColumns</a></td>
76 <td>Private method to resize the list columns.</td>
77 </tr><tr>
78 <td><a href="#CodeMetricsDialog.__resizeSummaryColumns">__resizeSummaryColumns</a></td>
79 <td>Private method to resize the list columns.</td>
80 </tr><tr>
81 <td><a href="#CodeMetricsDialog.__resultCollapse">__resultCollapse</a></td>
82 <td>Private slot to collapse all entries of the resultlist.</td>
83 </tr><tr>
84 <td><a href="#CodeMetricsDialog.__resultExpand">__resultExpand</a></td>
85 <td>Private slot to expand all entries of the resultlist.</td>
86 </tr><tr>
87 <td><a href="#CodeMetricsDialog.__showContextMenu">__showContextMenu</a></td>
88 <td>Private slot to show the context menu of the listview.</td>
89 </tr><tr>
90 <td><a href="#CodeMetricsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
91 <td>Private slot called by a button of the button box clicked.</td>
92 </tr><tr>
93 <td><a href="#CodeMetricsDialog.on_startButton_clicked">on_startButton_clicked</a></td>
94 <td>Private slot to start a code metrics run.</td>
95 </tr><tr>
96 <td><a href="#CodeMetricsDialog.prepare">prepare</a></td>
97 <td>Public method to prepare the dialog with a list of filenames.</td>
98 </tr><tr>
99 <td><a href="#CodeMetricsDialog.start">start</a></td>
100 <td>Public slot to start the code metrics determination.</td>
101 </tr>
102 </table>
103 <h3>Static Methods</h3>
104 <table>
105 <tr><td>None</td></tr>
106 </table>
107 <a NAME="CodeMetricsDialog.__init__" ID="CodeMetricsDialog.__init__"></a>
108 <h4>CodeMetricsDialog (Constructor)</h4>
109 <b>CodeMetricsDialog</b>(<i>parent=None</i>)
110 <p>
111 Constructor
112 </p><dl>
113 <dt><i>parent</i></dt>
114 <dd>
115 parent widget (QWidget)
116 </dd>
117 </dl><a NAME="CodeMetricsDialog.__createResultItem" ID="CodeMetricsDialog.__createResultItem"></a>
118 <h4>CodeMetricsDialog.__createResultItem</h4>
119 <b>__createResultItem</b>(<i>parent, values</i>)
120 <p>
121 Private slot to create a new item in the result list.
122 </p><dl>
123 <dt><i>parent</i></dt>
124 <dd>
125 parent of the new item (QTreeWidget or QTreeWidgetItem)
126 </dd><dt><i>values</i></dt>
127 <dd>
128 values to be displayed (list)
129 </dd>
130 </dl><dl>
131 <dt>Returns:</dt>
132 <dd>
133 the generated item
134 </dd>
135 </dl><a NAME="CodeMetricsDialog.__createSummaryItem" ID="CodeMetricsDialog.__createSummaryItem"></a>
136 <h4>CodeMetricsDialog.__createSummaryItem</h4>
137 <b>__createSummaryItem</b>(<i>col0, col1</i>)
138 <p>
139 Private slot to create a new item in the summary list.
140 </p><dl>
141 <dt><i>col0</i></dt>
142 <dd>
143 string for column 0 (string)
144 </dd><dt><i>col1</i></dt>
145 <dd>
146 string for column 1 (string)
147 </dd>
148 </dl><a NAME="CodeMetricsDialog.__finish" ID="CodeMetricsDialog.__finish"></a>
149 <h4>CodeMetricsDialog.__finish</h4>
150 <b>__finish</b>(<i></i>)
151 <p>
152 Private slot called when the action finished or the user pressed the
153 button.
154 </p><a NAME="CodeMetricsDialog.__getValues" ID="CodeMetricsDialog.__getValues"></a>
155 <h4>CodeMetricsDialog.__getValues</h4>
156 <b>__getValues</b>(<i>loc, stats, identifier</i>)
157 <p>
158 Private method to extract the code metric values.
159 </p><dl>
160 <dt><i>loc</i></dt>
161 <dd>
162 reference to the locale object (QLocale)
163 </dd><dt><i>stats</i></dt>
164 <dd>
165 reference to the code metric statistics object
166 </dd><dt><i>identifier</i></dt>
167 <dd>
168 identifier to get values for
169 </dd>
170 </dl><dl>
171 <dt>Returns:</dt>
172 <dd>
173 list of values suitable for display (list of strings)
174 </dd>
175 </dl><a NAME="CodeMetricsDialog.__resizeResultColumns" ID="CodeMetricsDialog.__resizeResultColumns"></a>
176 <h4>CodeMetricsDialog.__resizeResultColumns</h4>
177 <b>__resizeResultColumns</b>(<i></i>)
178 <p>
179 Private method to resize the list columns.
180 </p><a NAME="CodeMetricsDialog.__resizeSummaryColumns" ID="CodeMetricsDialog.__resizeSummaryColumns"></a>
181 <h4>CodeMetricsDialog.__resizeSummaryColumns</h4>
182 <b>__resizeSummaryColumns</b>(<i></i>)
183 <p>
184 Private method to resize the list columns.
185 </p><a NAME="CodeMetricsDialog.__resultCollapse" ID="CodeMetricsDialog.__resultCollapse"></a>
186 <h4>CodeMetricsDialog.__resultCollapse</h4>
187 <b>__resultCollapse</b>(<i></i>)
188 <p>
189 Private slot to collapse all entries of the resultlist.
190 </p><a NAME="CodeMetricsDialog.__resultExpand" ID="CodeMetricsDialog.__resultExpand"></a>
191 <h4>CodeMetricsDialog.__resultExpand</h4>
192 <b>__resultExpand</b>(<i></i>)
193 <p>
194 Private slot to expand all entries of the resultlist.
195 </p><a NAME="CodeMetricsDialog.__showContextMenu" ID="CodeMetricsDialog.__showContextMenu"></a>
196 <h4>CodeMetricsDialog.__showContextMenu</h4>
197 <b>__showContextMenu</b>(<i>coord</i>)
198 <p>
199 Private slot to show the context menu of the listview.
200 </p><dl>
201 <dt><i>coord</i></dt>
202 <dd>
203 the position of the mouse pointer (QPoint)
204 </dd>
205 </dl><a NAME="CodeMetricsDialog.on_buttonBox_clicked" ID="CodeMetricsDialog.on_buttonBox_clicked"></a>
206 <h4>CodeMetricsDialog.on_buttonBox_clicked</h4>
207 <b>on_buttonBox_clicked</b>(<i>button</i>)
208 <p>
209 Private slot called by a button of the button box clicked.
210 </p><dl>
211 <dt><i>button</i></dt>
212 <dd>
213 button that was clicked (QAbstractButton)
214 </dd>
215 </dl><a NAME="CodeMetricsDialog.on_startButton_clicked" ID="CodeMetricsDialog.on_startButton_clicked"></a>
216 <h4>CodeMetricsDialog.on_startButton_clicked</h4>
217 <b>on_startButton_clicked</b>(<i></i>)
218 <p>
219 Private slot to start a code metrics run.
220 </p><a NAME="CodeMetricsDialog.prepare" ID="CodeMetricsDialog.prepare"></a>
221 <h4>CodeMetricsDialog.prepare</h4>
222 <b>prepare</b>(<i>fileList, project</i>)
223 <p>
224 Public method to prepare the dialog with a list of filenames.
225 </p><dl>
226 <dt><i>fileList</i></dt>
227 <dd>
228 list of filenames (list of strings)
229 </dd><dt><i>project</i></dt>
230 <dd>
231 reference to the project object (Project)
232 </dd>
233 </dl><a NAME="CodeMetricsDialog.start" ID="CodeMetricsDialog.start"></a>
234 <h4>CodeMetricsDialog.start</h4>
235 <b>start</b>(<i>fn</i>)
236 <p>
237 Public slot to start the code metrics determination.
238 </p><dl>
239 <dt><i>fn</i></dt>
240 <dd>
241 file or list of files or directory to show
242 the code metrics for (string or list of strings)
243 </dd>
244 </dl>
245 <div align="right"><a href="#top">Up</a></div>
246 <hr />
247 </body></html>

Mercurial Repository: eric

eric ide

mercurial