Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.DataViews.CodeMetricsDialog.html
Documentation/Source/eric5.DataViews.CodeMetricsDialog.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.DataViews.CodeMetricsDialog</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.DataViews.CodeMetricsDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a code metrics dialog. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#CodeMetricsDialog">CodeMetricsDialog</a></td> | |
| 23 <td>Class implementing a dialog to display the code metrics.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="CodeMetricsDialog" ID="CodeMetricsDialog"></a> | |
| 32 <h2>CodeMetricsDialog</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog to display the code metrics. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QDialog, Ui_CodeMetricsDialog | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#CodeMetricsDialog.__init__">CodeMetricsDialog</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#CodeMetricsDialog.__createResultItem">__createResultItem</a></td> | |
| 49 <td>Private slot to create a new item in the result list.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#CodeMetricsDialog.__createSummaryItem">__createSummaryItem</a></td> | |
| 52 <td>Private slot to create a new item in the summary list.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#CodeMetricsDialog.__finish">__finish</a></td> | |
| 55 <td>Private slot called when the action finished or the user pressed the button.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#CodeMetricsDialog.__getValues">__getValues</a></td> | |
| 58 <td>Private method to extract the code metric values.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#CodeMetricsDialog.__resizeResultColumns">__resizeResultColumns</a></td> | |
| 61 <td>Private method to resize the list columns.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#CodeMetricsDialog.__resizeSummaryColumns">__resizeSummaryColumns</a></td> | |
| 64 <td>Private method to resize the list columns.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#CodeMetricsDialog.__resultCollapse">__resultCollapse</a></td> | |
| 67 <td>Private slot to collapse all entries of the resultlist.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#CodeMetricsDialog.__resultExpand">__resultExpand</a></td> | |
| 70 <td>Private slot to expand all entries of the resultlist.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#CodeMetricsDialog.__showContextMenu">__showContextMenu</a></td> | |
| 73 <td>Private slot to show the context menu of the listview.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#CodeMetricsDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> | |
| 76 <td>Private slot called by a button of the button box clicked.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#CodeMetricsDialog.start">start</a></td> | |
| 79 <td>Public slot to start the code metrics determination.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <a NAME="CodeMetricsDialog.__init__" ID="CodeMetricsDialog.__init__"></a> | |
| 83 <h4>CodeMetricsDialog (Constructor)</h4> | |
| 84 <b>CodeMetricsDialog</b>(<i>parent = None</i>) | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p><dl> | |
| 88 <dt><i>parent</i></dt> | |
| 89 <dd> | |
| 90 parent widget (QWidget) | |
| 91 </dd> | |
| 92 </dl><a NAME="CodeMetricsDialog.__createResultItem" ID="CodeMetricsDialog.__createResultItem"></a> | |
| 93 <h4>CodeMetricsDialog.__createResultItem</h4> | |
| 94 <b>__createResultItem</b>(<i>parent, strings</i>) | |
| 95 <p> | |
| 96 Private slot to create a new item in the result list. | |
| 97 </p><dl> | |
| 98 <dt><i>parent</i></dt> | |
| 99 <dd> | |
| 100 parent of the new item (QTreeWidget or QTreeWidgetItem) | |
| 101 </dd><dt><i>strings</i></dt> | |
| 102 <dd> | |
| 103 strings to be displayed (list of strings) | |
| 104 </dd> | |
| 105 </dl><dl> | |
| 106 <dt>Returns:</dt> | |
| 107 <dd> | |
| 108 the generated item | |
| 109 </dd> | |
| 110 </dl><a NAME="CodeMetricsDialog.__createSummaryItem" ID="CodeMetricsDialog.__createSummaryItem"></a> | |
| 111 <h4>CodeMetricsDialog.__createSummaryItem</h4> | |
| 112 <b>__createSummaryItem</b>(<i>col0, col1</i>) | |
| 113 <p> | |
| 114 Private slot to create a new item in the summary list. | |
| 115 </p><dl> | |
| 116 <dt><i>col0</i></dt> | |
| 117 <dd> | |
| 118 string for column 0 (string) | |
| 119 </dd><dt><i>col1</i></dt> | |
| 120 <dd> | |
| 121 string for column 1 (string) | |
| 122 </dd> | |
| 123 </dl><a NAME="CodeMetricsDialog.__finish" ID="CodeMetricsDialog.__finish"></a> | |
| 124 <h4>CodeMetricsDialog.__finish</h4> | |
| 125 <b>__finish</b>(<i></i>) | |
| 126 <p> | |
| 127 Private slot called when the action finished or the user pressed the button. | |
| 128 </p><a NAME="CodeMetricsDialog.__getValues" ID="CodeMetricsDialog.__getValues"></a> | |
| 129 <h4>CodeMetricsDialog.__getValues</h4> | |
| 130 <b>__getValues</b>(<i>loc, stats, identifier</i>) | |
| 131 <p> | |
| 132 Private method to extract the code metric values. | |
| 133 </p><dl> | |
| 134 <dt><i>loc</i></dt> | |
| 135 <dd> | |
| 136 reference to the locale object (QLocale) | |
| 137 </dd><dt><i>stats</i></dt> | |
| 138 <dd> | |
| 139 reference to the code metric statistics object | |
| 140 </dd><dt><i>identifier</i></dt> | |
| 141 <dd> | |
| 142 identifier to get values for | |
| 143 </dd> | |
| 144 </dl><dl> | |
| 145 <dt>Returns:</dt> | |
| 146 <dd> | |
| 147 list of values suitable for display (list of strings) | |
| 148 </dd> | |
| 149 </dl><a NAME="CodeMetricsDialog.__resizeResultColumns" ID="CodeMetricsDialog.__resizeResultColumns"></a> | |
| 150 <h4>CodeMetricsDialog.__resizeResultColumns</h4> | |
| 151 <b>__resizeResultColumns</b>(<i></i>) | |
| 152 <p> | |
| 153 Private method to resize the list columns. | |
| 154 </p><a NAME="CodeMetricsDialog.__resizeSummaryColumns" ID="CodeMetricsDialog.__resizeSummaryColumns"></a> | |
| 155 <h4>CodeMetricsDialog.__resizeSummaryColumns</h4> | |
| 156 <b>__resizeSummaryColumns</b>(<i></i>) | |
| 157 <p> | |
| 158 Private method to resize the list columns. | |
| 159 </p><a NAME="CodeMetricsDialog.__resultCollapse" ID="CodeMetricsDialog.__resultCollapse"></a> | |
| 160 <h4>CodeMetricsDialog.__resultCollapse</h4> | |
| 161 <b>__resultCollapse</b>(<i></i>) | |
| 162 <p> | |
| 163 Private slot to collapse all entries of the resultlist. | |
| 164 </p><a NAME="CodeMetricsDialog.__resultExpand" ID="CodeMetricsDialog.__resultExpand"></a> | |
| 165 <h4>CodeMetricsDialog.__resultExpand</h4> | |
| 166 <b>__resultExpand</b>(<i></i>) | |
| 167 <p> | |
| 168 Private slot to expand all entries of the resultlist. | |
| 169 </p><a NAME="CodeMetricsDialog.__showContextMenu" ID="CodeMetricsDialog.__showContextMenu"></a> | |
| 170 <h4>CodeMetricsDialog.__showContextMenu</h4> | |
| 171 <b>__showContextMenu</b>(<i>coord</i>) | |
| 172 <p> | |
| 173 Private slot to show the context menu of the listview. | |
| 174 </p><dl> | |
| 175 <dt><i>coord</i></dt> | |
| 176 <dd> | |
| 177 the position of the mouse pointer (QPoint) | |
| 178 </dd> | |
| 179 </dl><a NAME="CodeMetricsDialog.on_buttonBox_clicked" ID="CodeMetricsDialog.on_buttonBox_clicked"></a> | |
| 180 <h4>CodeMetricsDialog.on_buttonBox_clicked</h4> | |
| 181 <b>on_buttonBox_clicked</b>(<i>button</i>) | |
| 182 <p> | |
| 183 Private slot called by a button of the button box clicked. | |
| 184 </p><dl> | |
| 185 <dt><i>button</i></dt> | |
| 186 <dd> | |
| 187 button that was clicked (QAbstractButton) | |
| 188 </dd> | |
| 189 </dl><a NAME="CodeMetricsDialog.start" ID="CodeMetricsDialog.start"></a> | |
| 190 <h4>CodeMetricsDialog.start</h4> | |
| 191 <b>start</b>(<i>fn</i>) | |
| 192 <p> | |
| 193 Public slot to start the code metrics determination. | |
| 194 </p><dl> | |
| 195 <dt><i>fn</i></dt> | |
| 196 <dd> | |
| 197 file or list of files or directory to be show | |
| 198 the code metrics for (string or list of strings) | |
| 199 </dd> | |
| 200 </dl> | |
| 201 <div align="right"><a href="#top">Up</a></div> | |
| 202 <hr /> | |
| 203 </body></html> |
