Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.DataViews.CodeMetricsDialog.html
src/eric7/Documentation/Source/eric7.DataViews.CodeMetricsDialog.html
- branch
- eric7
- changeset 10479
- 856476537696
- parent 10423
- 299802979277
- child 10689
- 3ede487187f2
equal
deleted
inserted
replaced
| 10478:de9106c55c3d | 10479:856476537696 |
|---|---|
| 5 <link rel="stylesheet" href="styles.css"> | 5 <link rel="stylesheet" href="styles.css"> |
| 6 </head> | 6 </head> |
| 7 <body> | 7 <body> |
| 8 <a NAME="top" ID="top"></a> | 8 <a NAME="top" ID="top"></a> |
| 9 <h1>eric7.DataViews.CodeMetricsDialog</h1> | 9 <h1>eric7.DataViews.CodeMetricsDialog</h1> |
| 10 | |
| 11 <p> | 10 <p> |
| 12 Module implementing a code metrics dialog. | 11 Module implementing a code metrics dialog. |
| 13 </p> | 12 </p> |
| 13 | |
| 14 <h3>Global Attributes</h3> | 14 <h3>Global Attributes</h3> |
| 15 | 15 <table> |
| 16 <table> | 16 <tr><td>None</td></tr> |
| 17 <tr><td>None</td></tr> | 17 </table> |
| 18 </table> | 18 |
| 19 <h3>Classes</h3> | 19 <h3>Classes</h3> |
| 20 | 20 <table> |
| 21 <table> | |
| 22 | |
| 23 <tr> | 21 <tr> |
| 24 <td><a href="#CodeMetricsDialog">CodeMetricsDialog</a></td> | 22 <td><a href="#CodeMetricsDialog">CodeMetricsDialog</a></td> |
| 25 <td>Class implementing a dialog to display the code metrics.</td> | 23 <td>Class implementing a dialog to display the code metrics.</td> |
| 26 </tr> | 24 </tr> |
| 27 </table> | 25 </table> |
| 26 | |
| 28 <h3>Functions</h3> | 27 <h3>Functions</h3> |
| 29 | 28 <table> |
| 30 <table> | 29 <tr><td>None</td></tr> |
| 31 <tr><td>None</td></tr> | 30 </table> |
| 32 </table> | 31 |
| 33 <hr /> | 32 <hr /> |
| 34 <hr /> | 33 <hr /> |
| 35 <a NAME="CodeMetricsDialog" ID="CodeMetricsDialog"></a> | 34 <a NAME="CodeMetricsDialog" ID="CodeMetricsDialog"></a> |
| 36 <h2>CodeMetricsDialog</h2> | 35 <h2>CodeMetricsDialog</h2> |
| 37 | |
| 38 <p> | 36 <p> |
| 39 Class implementing a dialog to display the code metrics. | 37 Class implementing a dialog to display the code metrics. |
| 40 </p> | 38 </p> |
| 39 | |
| 41 <h3>Derived from</h3> | 40 <h3>Derived from</h3> |
| 42 QDialog, Ui_CodeMetricsDialog | 41 QDialog, Ui_CodeMetricsDialog |
| 43 <h3>Class Attributes</h3> | 42 <h3>Class Attributes</h3> |
| 44 | 43 <table> |
| 45 <table> | 44 <tr><td>None</td></tr> |
| 46 <tr><td>None</td></tr> | 45 </table> |
| 47 </table> | 46 |
| 48 <h3>Class Methods</h3> | 47 <h3>Class Methods</h3> |
| 49 | 48 <table> |
| 50 <table> | 49 <tr><td>None</td></tr> |
| 51 <tr><td>None</td></tr> | 50 </table> |
| 52 </table> | 51 |
| 53 <h3>Methods</h3> | 52 <h3>Methods</h3> |
| 54 | 53 <table> |
| 55 <table> | |
| 56 | |
| 57 <tr> | 54 <tr> |
| 58 <td><a href="#CodeMetricsDialog.__init__">CodeMetricsDialog</a></td> | 55 <td><a href="#CodeMetricsDialog.__init__">CodeMetricsDialog</a></td> |
| 59 <td>Constructor</td> | 56 <td>Constructor</td> |
| 60 </tr> | 57 </tr> |
| 61 <tr> | 58 <tr> |
| 113 <tr> | 110 <tr> |
| 114 <td><a href="#CodeMetricsDialog.start">start</a></td> | 111 <td><a href="#CodeMetricsDialog.start">start</a></td> |
| 115 <td>Public slot to start the code metrics determination.</td> | 112 <td>Public slot to start the code metrics determination.</td> |
| 116 </tr> | 113 </tr> |
| 117 </table> | 114 </table> |
| 115 | |
| 118 <h3>Static Methods</h3> | 116 <h3>Static Methods</h3> |
| 119 | 117 <table> |
| 120 <table> | 118 <tr><td>None</td></tr> |
| 121 <tr><td>None</td></tr> | 119 </table> |
| 122 </table> | 120 |
| 123 | 121 |
| 124 <a NAME="CodeMetricsDialog.__init__" ID="CodeMetricsDialog.__init__"></a> | 122 <a NAME="CodeMetricsDialog.__init__" ID="CodeMetricsDialog.__init__"></a> |
| 125 <h4>CodeMetricsDialog (Constructor)</h4> | 123 <h4>CodeMetricsDialog (Constructor)</h4> |
| 126 <b>CodeMetricsDialog</b>(<i>parent=None</i>) | 124 <b>CodeMetricsDialog</b>(<i>parent=None</i>) |
| 127 | |
| 128 <p> | 125 <p> |
| 129 Constructor | 126 Constructor |
| 130 </p> | 127 </p> |
| 128 | |
| 131 <dl> | 129 <dl> |
| 132 | 130 |
| 133 <dt><i>parent</i> (QWidget)</dt> | 131 <dt><i>parent</i> (QWidget)</dt> |
| 134 <dd> | 132 <dd> |
| 135 parent widget | 133 parent widget |
| 136 </dd> | 134 </dd> |
| 137 </dl> | 135 </dl> |
| 138 <a NAME="CodeMetricsDialog.__createResultItem" ID="CodeMetricsDialog.__createResultItem"></a> | 136 <a NAME="CodeMetricsDialog.__createResultItem" ID="CodeMetricsDialog.__createResultItem"></a> |
| 139 <h4>CodeMetricsDialog.__createResultItem</h4> | 137 <h4>CodeMetricsDialog.__createResultItem</h4> |
| 140 <b>__createResultItem</b>(<i>parent, values</i>) | 138 <b>__createResultItem</b>(<i>parent, values</i>) |
| 141 | |
| 142 <p> | 139 <p> |
| 143 Private slot to create a new item in the result list. | 140 Private slot to create a new item in the result list. |
| 144 </p> | 141 </p> |
| 142 | |
| 145 <dl> | 143 <dl> |
| 146 | 144 |
| 147 <dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt> | 145 <dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt> |
| 148 <dd> | 146 <dd> |
| 149 parent of the new item | 147 parent of the new item |
| 166 </dd> | 164 </dd> |
| 167 </dl> | 165 </dl> |
| 168 <a NAME="CodeMetricsDialog.__createSummaryItem" ID="CodeMetricsDialog.__createSummaryItem"></a> | 166 <a NAME="CodeMetricsDialog.__createSummaryItem" ID="CodeMetricsDialog.__createSummaryItem"></a> |
| 169 <h4>CodeMetricsDialog.__createSummaryItem</h4> | 167 <h4>CodeMetricsDialog.__createSummaryItem</h4> |
| 170 <b>__createSummaryItem</b>(<i>col0, col1</i>) | 168 <b>__createSummaryItem</b>(<i>col0, col1</i>) |
| 171 | |
| 172 <p> | 169 <p> |
| 173 Private slot to create a new item in the summary list. | 170 Private slot to create a new item in the summary list. |
| 174 </p> | 171 </p> |
| 172 | |
| 175 <dl> | 173 <dl> |
| 176 | 174 |
| 177 <dt><i>col0</i> (str)</dt> | 175 <dt><i>col0</i> (str)</dt> |
| 178 <dd> | 176 <dd> |
| 179 string for column 0 | 177 string for column 0 |
| 184 </dd> | 182 </dd> |
| 185 </dl> | 183 </dl> |
| 186 <a NAME="CodeMetricsDialog.__finish" ID="CodeMetricsDialog.__finish"></a> | 184 <a NAME="CodeMetricsDialog.__finish" ID="CodeMetricsDialog.__finish"></a> |
| 187 <h4>CodeMetricsDialog.__finish</h4> | 185 <h4>CodeMetricsDialog.__finish</h4> |
| 188 <b>__finish</b>(<i></i>) | 186 <b>__finish</b>(<i></i>) |
| 189 | |
| 190 <p> | 187 <p> |
| 191 Private slot called when the action finished or the user pressed the | 188 Private slot called when the action finished or the user pressed the |
| 192 button. | 189 button. |
| 193 </p> | 190 </p> |
| 191 | |
| 194 <a NAME="CodeMetricsDialog.__getValues" ID="CodeMetricsDialog.__getValues"></a> | 192 <a NAME="CodeMetricsDialog.__getValues" ID="CodeMetricsDialog.__getValues"></a> |
| 195 <h4>CodeMetricsDialog.__getValues</h4> | 193 <h4>CodeMetricsDialog.__getValues</h4> |
| 196 <b>__getValues</b>(<i>loc, stats, identifier</i>) | 194 <b>__getValues</b>(<i>loc, stats, identifier</i>) |
| 197 | |
| 198 <p> | 195 <p> |
| 199 Private method to extract the code metric values. | 196 Private method to extract the code metric values. |
| 200 </p> | 197 </p> |
| 198 | |
| 201 <dl> | 199 <dl> |
| 202 | 200 |
| 203 <dt><i>loc</i> (QLocale)</dt> | 201 <dt><i>loc</i> (QLocale)</dt> |
| 204 <dd> | 202 <dd> |
| 205 reference to the locale object | 203 reference to the locale object |
| 226 </dd> | 224 </dd> |
| 227 </dl> | 225 </dl> |
| 228 <a NAME="CodeMetricsDialog.__resizeResultColumns" ID="CodeMetricsDialog.__resizeResultColumns"></a> | 226 <a NAME="CodeMetricsDialog.__resizeResultColumns" ID="CodeMetricsDialog.__resizeResultColumns"></a> |
| 229 <h4>CodeMetricsDialog.__resizeResultColumns</h4> | 227 <h4>CodeMetricsDialog.__resizeResultColumns</h4> |
| 230 <b>__resizeResultColumns</b>(<i></i>) | 228 <b>__resizeResultColumns</b>(<i></i>) |
| 231 | |
| 232 <p> | 229 <p> |
| 233 Private method to resize the list columns. | 230 Private method to resize the list columns. |
| 234 </p> | 231 </p> |
| 232 | |
| 235 <a NAME="CodeMetricsDialog.__resizeSummaryColumns" ID="CodeMetricsDialog.__resizeSummaryColumns"></a> | 233 <a NAME="CodeMetricsDialog.__resizeSummaryColumns" ID="CodeMetricsDialog.__resizeSummaryColumns"></a> |
| 236 <h4>CodeMetricsDialog.__resizeSummaryColumns</h4> | 234 <h4>CodeMetricsDialog.__resizeSummaryColumns</h4> |
| 237 <b>__resizeSummaryColumns</b>(<i></i>) | 235 <b>__resizeSummaryColumns</b>(<i></i>) |
| 238 | |
| 239 <p> | 236 <p> |
| 240 Private method to resize the list columns. | 237 Private method to resize the list columns. |
| 241 </p> | 238 </p> |
| 239 | |
| 242 <a NAME="CodeMetricsDialog.__resultCollapse" ID="CodeMetricsDialog.__resultCollapse"></a> | 240 <a NAME="CodeMetricsDialog.__resultCollapse" ID="CodeMetricsDialog.__resultCollapse"></a> |
| 243 <h4>CodeMetricsDialog.__resultCollapse</h4> | 241 <h4>CodeMetricsDialog.__resultCollapse</h4> |
| 244 <b>__resultCollapse</b>(<i></i>) | 242 <b>__resultCollapse</b>(<i></i>) |
| 245 | |
| 246 <p> | 243 <p> |
| 247 Private slot to collapse all entries of the resultlist. | 244 Private slot to collapse all entries of the resultlist. |
| 248 </p> | 245 </p> |
| 246 | |
| 249 <a NAME="CodeMetricsDialog.__resultExpand" ID="CodeMetricsDialog.__resultExpand"></a> | 247 <a NAME="CodeMetricsDialog.__resultExpand" ID="CodeMetricsDialog.__resultExpand"></a> |
| 250 <h4>CodeMetricsDialog.__resultExpand</h4> | 248 <h4>CodeMetricsDialog.__resultExpand</h4> |
| 251 <b>__resultExpand</b>(<i></i>) | 249 <b>__resultExpand</b>(<i></i>) |
| 252 | |
| 253 <p> | 250 <p> |
| 254 Private slot to expand all entries of the resultlist. | 251 Private slot to expand all entries of the resultlist. |
| 255 </p> | 252 </p> |
| 253 | |
| 256 <a NAME="CodeMetricsDialog.__showContextMenu" ID="CodeMetricsDialog.__showContextMenu"></a> | 254 <a NAME="CodeMetricsDialog.__showContextMenu" ID="CodeMetricsDialog.__showContextMenu"></a> |
| 257 <h4>CodeMetricsDialog.__showContextMenu</h4> | 255 <h4>CodeMetricsDialog.__showContextMenu</h4> |
| 258 <b>__showContextMenu</b>(<i>coord</i>) | 256 <b>__showContextMenu</b>(<i>coord</i>) |
| 259 | |
| 260 <p> | 257 <p> |
| 261 Private slot to show the context menu of the listview. | 258 Private slot to show the context menu of the listview. |
| 262 </p> | 259 </p> |
| 260 | |
| 263 <dl> | 261 <dl> |
| 264 | 262 |
| 265 <dt><i>coord</i> (QPoint)</dt> | 263 <dt><i>coord</i> (QPoint)</dt> |
| 266 <dd> | 264 <dd> |
| 267 the position of the mouse pointer | 265 the position of the mouse pointer |
| 268 </dd> | 266 </dd> |
| 269 </dl> | 267 </dl> |
| 270 <a NAME="CodeMetricsDialog.closeEvent" ID="CodeMetricsDialog.closeEvent"></a> | 268 <a NAME="CodeMetricsDialog.closeEvent" ID="CodeMetricsDialog.closeEvent"></a> |
| 271 <h4>CodeMetricsDialog.closeEvent</h4> | 269 <h4>CodeMetricsDialog.closeEvent</h4> |
| 272 <b>closeEvent</b>(<i>evt</i>) | 270 <b>closeEvent</b>(<i>evt</i>) |
| 273 | |
| 274 <p> | 271 <p> |
| 275 Protected method to handle the close event. | 272 Protected method to handle the close event. |
| 276 </p> | 273 </p> |
| 274 | |
| 277 <dl> | 275 <dl> |
| 278 | 276 |
| 279 <dt><i>evt</i> (QCloseEvent)</dt> | 277 <dt><i>evt</i> (QCloseEvent)</dt> |
| 280 <dd> | 278 <dd> |
| 281 reference to the close event | 279 reference to the close event |
| 282 </dd> | 280 </dd> |
| 283 </dl> | 281 </dl> |
| 284 <a NAME="CodeMetricsDialog.on_buttonBox_clicked" ID="CodeMetricsDialog.on_buttonBox_clicked"></a> | 282 <a NAME="CodeMetricsDialog.on_buttonBox_clicked" ID="CodeMetricsDialog.on_buttonBox_clicked"></a> |
| 285 <h4>CodeMetricsDialog.on_buttonBox_clicked</h4> | 283 <h4>CodeMetricsDialog.on_buttonBox_clicked</h4> |
| 286 <b>on_buttonBox_clicked</b>(<i>button</i>) | 284 <b>on_buttonBox_clicked</b>(<i>button</i>) |
| 287 | |
| 288 <p> | 285 <p> |
| 289 Private slot called by a button of the button box clicked. | 286 Private slot called by a button of the button box clicked. |
| 290 </p> | 287 </p> |
| 288 | |
| 291 <dl> | 289 <dl> |
| 292 | 290 |
| 293 <dt><i>button</i> (QAbstractButton)</dt> | 291 <dt><i>button</i> (QAbstractButton)</dt> |
| 294 <dd> | 292 <dd> |
| 295 button that was clicked | 293 button that was clicked |
| 296 </dd> | 294 </dd> |
| 297 </dl> | 295 </dl> |
| 298 <a NAME="CodeMetricsDialog.on_startButton_clicked" ID="CodeMetricsDialog.on_startButton_clicked"></a> | 296 <a NAME="CodeMetricsDialog.on_startButton_clicked" ID="CodeMetricsDialog.on_startButton_clicked"></a> |
| 299 <h4>CodeMetricsDialog.on_startButton_clicked</h4> | 297 <h4>CodeMetricsDialog.on_startButton_clicked</h4> |
| 300 <b>on_startButton_clicked</b>(<i></i>) | 298 <b>on_startButton_clicked</b>(<i></i>) |
| 301 | |
| 302 <p> | 299 <p> |
| 303 Private slot to start a code metrics run. | 300 Private slot to start a code metrics run. |
| 304 </p> | 301 </p> |
| 302 | |
| 305 <a NAME="CodeMetricsDialog.prepare" ID="CodeMetricsDialog.prepare"></a> | 303 <a NAME="CodeMetricsDialog.prepare" ID="CodeMetricsDialog.prepare"></a> |
| 306 <h4>CodeMetricsDialog.prepare</h4> | 304 <h4>CodeMetricsDialog.prepare</h4> |
| 307 <b>prepare</b>(<i>fileList</i>) | 305 <b>prepare</b>(<i>fileList</i>) |
| 308 | |
| 309 <p> | 306 <p> |
| 310 Public method to prepare the dialog with a list of filenames. | 307 Public method to prepare the dialog with a list of filenames. |
| 311 </p> | 308 </p> |
| 309 | |
| 312 <dl> | 310 <dl> |
| 313 | 311 |
| 314 <dt><i>fileList</i> (list of str)</dt> | 312 <dt><i>fileList</i> (list of str)</dt> |
| 315 <dd> | 313 <dd> |
| 316 list of filenames | 314 list of filenames |
| 317 </dd> | 315 </dd> |
| 318 </dl> | 316 </dl> |
| 319 <a NAME="CodeMetricsDialog.start" ID="CodeMetricsDialog.start"></a> | 317 <a NAME="CodeMetricsDialog.start" ID="CodeMetricsDialog.start"></a> |
| 320 <h4>CodeMetricsDialog.start</h4> | 318 <h4>CodeMetricsDialog.start</h4> |
| 321 <b>start</b>(<i>fn</i>) | 319 <b>start</b>(<i>fn</i>) |
| 322 | |
| 323 <p> | 320 <p> |
| 324 Public slot to start the code metrics determination. | 321 Public slot to start the code metrics determination. |
| 325 </p> | 322 </p> |
| 323 | |
| 326 <dl> | 324 <dl> |
| 327 | 325 |
| 328 <dt><i>fn</i> (str or list of str)</dt> | 326 <dt><i>fn</i> (str or list of str)</dt> |
| 329 <dd> | 327 <dd> |
| 330 file or list of files or directory to show | 328 file or list of files or directory to show |
