Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Debugger.CallTraceViewer.html
src/eric7/Documentation/Source/eric7.Debugger.CallTraceViewer.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Debugger.CallTraceViewer</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Debugger.CallTraceViewer</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the Call Trace viewer widget. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#CallTraceViewer">CallTraceViewer</a></td> | |
| 25 <td>Class implementing the Call Trace viewer widget.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="CallTraceViewer" ID="CallTraceViewer"></a> | |
| 36 <h2>CallTraceViewer</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the Call Trace viewer widget. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>sourceFile(str, int)</dt> | |
| 45 <dd> | |
| 46 emitted to show the source of a call/return | |
| 47 point | |
| 48 </dd> | |
| 49 </dl> | |
| 50 <h3>Derived from</h3> | |
| 51 QWidget, Ui_CallTraceViewer | |
| 52 <h3>Class Attributes</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Class Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 | |
| 66 <tr> | |
| 67 <td><a href="#CallTraceViewer.__init__">CallTraceViewer</a></td> | |
| 68 <td>Constructor</td> | |
| 69 </tr> | |
| 70 <tr> | |
| 71 <td><a href="#CallTraceViewer.__addCallTraceInfo">__addCallTraceInfo</a></td> | |
| 72 <td>Private method to add an entry to the call trace viewer.</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#CallTraceViewer.__clientExit">__clientExit</a></td> | |
| 76 <td>Private slot to handle a debug client terminating.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#CallTraceViewer.__setCallTraceEnabled">__setCallTraceEnabled</a></td> | |
| 80 <td>Private slot to set the call trace enabled status.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#CallTraceViewer.clear">clear</a></td> | |
| 84 <td>Public slot to clear the call trace info.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#CallTraceViewer.isCallTraceEnabled">isCallTraceEnabled</a></td> | |
| 88 <td>Public method to get the state of the call trace function.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#CallTraceViewer.on_callTrace_itemDoubleClicked">on_callTrace_itemDoubleClicked</a></td> | |
| 92 <td>Private slot to open the double clicked file in an editor.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#CallTraceViewer.on_clearButton_clicked">on_clearButton_clicked</a></td> | |
| 96 <td>Private slot to clear the call trace.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#CallTraceViewer.on_resizeButton_clicked">on_resizeButton_clicked</a></td> | |
| 100 <td>Private slot to resize the columns of the call trace to their contents.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#CallTraceViewer.on_saveButton_clicked">on_saveButton_clicked</a></td> | |
| 104 <td>Private slot to save the call trace info to a file.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#CallTraceViewer.on_startTraceButton_clicked">on_startTraceButton_clicked</a></td> | |
| 108 <td>Private slot to start call tracing.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#CallTraceViewer.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td> | |
| 112 <td>Private slot to handle a click on the stop check box.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#CallTraceViewer.on_stopTraceButton_clicked">on_stopTraceButton_clicked</a></td> | |
| 116 <td>Private slot to start call tracing.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#CallTraceViewer.setProjectMode">setProjectMode</a></td> | |
| 120 <td>Public slot to set the call trace viewer to project mode.</td> | |
| 121 </tr> | |
| 122 </table> | |
| 123 <h3>Static Methods</h3> | |
| 124 | |
| 125 <table> | |
| 126 <tr><td>None</td></tr> | |
| 127 </table> | |
| 128 | |
| 129 <a NAME="CallTraceViewer.__init__" ID="CallTraceViewer.__init__"></a> | |
| 130 <h4>CallTraceViewer (Constructor)</h4> | |
| 131 <b>CallTraceViewer</b>(<i>debugServer, debugViewer, parent=None</i>) | |
| 132 | |
| 133 <p> | |
| 134 Constructor | |
| 135 </p> | |
| 136 <dl> | |
| 137 | |
| 138 <dt><i>debugServer</i> (DebugServer)</dt> | |
| 139 <dd> | |
| 140 reference to the debug server object | |
| 141 </dd> | |
| 142 <dt><i>debugViewer</i> (DebugViewer)</dt> | |
| 143 <dd> | |
| 144 reference to the debug viewer object | |
| 145 </dd> | |
| 146 <dt><i>parent</i> (QWidget)</dt> | |
| 147 <dd> | |
| 148 reference to the parent widget | |
| 149 </dd> | |
| 150 </dl> | |
| 151 <a NAME="CallTraceViewer.__addCallTraceInfo" ID="CallTraceViewer.__addCallTraceInfo"></a> | |
| 152 <h4>CallTraceViewer.__addCallTraceInfo</h4> | |
| 153 <b>__addCallTraceInfo</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction, debuggerId</i>) | |
| 154 | |
| 155 <p> | |
| 156 Private method to add an entry to the call trace viewer. | |
| 157 </p> | |
| 158 <dl> | |
| 159 | |
| 160 <dt><i>isCall</i> (bool)</dt> | |
| 161 <dd> | |
| 162 flag indicating a 'call' | |
| 163 </dd> | |
| 164 <dt><i>fromFile</i> (str)</dt> | |
| 165 <dd> | |
| 166 name of the originating file | |
| 167 </dd> | |
| 168 <dt><i>fromLine</i> (str)</dt> | |
| 169 <dd> | |
| 170 line number in the originating file | |
| 171 </dd> | |
| 172 <dt><i>fromFunction</i> (str)</dt> | |
| 173 <dd> | |
| 174 name of the originating function | |
| 175 </dd> | |
| 176 <dt><i>toFile</i> (str)</dt> | |
| 177 <dd> | |
| 178 name of the target file | |
| 179 </dd> | |
| 180 <dt><i>toLine</i> (str)</dt> | |
| 181 <dd> | |
| 182 line number in the target file | |
| 183 </dd> | |
| 184 <dt><i>toFunction</i> (str)</dt> | |
| 185 <dd> | |
| 186 name of the target function | |
| 187 </dd> | |
| 188 <dt><i>debuggerId</i> (str)</dt> | |
| 189 <dd> | |
| 190 ID of the debugger backend | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <a NAME="CallTraceViewer.__clientExit" ID="CallTraceViewer.__clientExit"></a> | |
| 194 <h4>CallTraceViewer.__clientExit</h4> | |
| 195 <b>__clientExit</b>(<i>program, status, message, quiet, debuggerId</i>) | |
| 196 | |
| 197 <p> | |
| 198 Private slot to handle a debug client terminating. | |
| 199 </p> | |
| 200 <dl> | |
| 201 | |
| 202 <dt><i>program</i> (str)</dt> | |
| 203 <dd> | |
| 204 name of the exited program | |
| 205 </dd> | |
| 206 <dt><i>status</i> (int)</dt> | |
| 207 <dd> | |
| 208 exit code of the debugged program | |
| 209 </dd> | |
| 210 <dt><i>message</i> (str)</dt> | |
| 211 <dd> | |
| 212 exit message of the debugged program | |
| 213 </dd> | |
| 214 <dt><i>quiet</i> (bool)</dt> | |
| 215 <dd> | |
| 216 flag indicating to suppress exit info display | |
| 217 </dd> | |
| 218 <dt><i>debuggerId</i> (str)</dt> | |
| 219 <dd> | |
| 220 ID of the debugger backend | |
| 221 </dd> | |
| 222 </dl> | |
| 223 <a NAME="CallTraceViewer.__setCallTraceEnabled" ID="CallTraceViewer.__setCallTraceEnabled"></a> | |
| 224 <h4>CallTraceViewer.__setCallTraceEnabled</h4> | |
| 225 <b>__setCallTraceEnabled</b>(<i>enabled</i>) | |
| 226 | |
| 227 <p> | |
| 228 Private slot to set the call trace enabled status. | |
| 229 </p> | |
| 230 <dl> | |
| 231 | |
| 232 <dt><i>enabled</i> (bool)</dt> | |
| 233 <dd> | |
| 234 flag indicating the new state | |
| 235 </dd> | |
| 236 </dl> | |
| 237 <a NAME="CallTraceViewer.clear" ID="CallTraceViewer.clear"></a> | |
| 238 <h4>CallTraceViewer.clear</h4> | |
| 239 <b>clear</b>(<i></i>) | |
| 240 | |
| 241 <p> | |
| 242 Public slot to clear the call trace info. | |
| 243 </p> | |
| 244 <a NAME="CallTraceViewer.isCallTraceEnabled" ID="CallTraceViewer.isCallTraceEnabled"></a> | |
| 245 <h4>CallTraceViewer.isCallTraceEnabled</h4> | |
| 246 <b>isCallTraceEnabled</b>(<i></i>) | |
| 247 | |
| 248 <p> | |
| 249 Public method to get the state of the call trace function. | |
| 250 </p> | |
| 251 <dl> | |
| 252 <dt>Return:</dt> | |
| 253 <dd> | |
| 254 flag indicating the state of the call trace function | |
| 255 </dd> | |
| 256 </dl> | |
| 257 <dl> | |
| 258 <dt>Return Type:</dt> | |
| 259 <dd> | |
| 260 bool | |
| 261 </dd> | |
| 262 </dl> | |
| 263 <a NAME="CallTraceViewer.on_callTrace_itemDoubleClicked" ID="CallTraceViewer.on_callTrace_itemDoubleClicked"></a> | |
| 264 <h4>CallTraceViewer.on_callTrace_itemDoubleClicked</h4> | |
| 265 <b>on_callTrace_itemDoubleClicked</b>(<i>item, column</i>) | |
| 266 | |
| 267 <p> | |
| 268 Private slot to open the double clicked file in an editor. | |
| 269 </p> | |
| 270 <dl> | |
| 271 | |
| 272 <dt><i>item</i> (QTreeWidgetItem)</dt> | |
| 273 <dd> | |
| 274 reference to the double clicked item | |
| 275 </dd> | |
| 276 <dt><i>column</i> (int)</dt> | |
| 277 <dd> | |
| 278 column that was double clicked | |
| 279 </dd> | |
| 280 </dl> | |
| 281 <a NAME="CallTraceViewer.on_clearButton_clicked" ID="CallTraceViewer.on_clearButton_clicked"></a> | |
| 282 <h4>CallTraceViewer.on_clearButton_clicked</h4> | |
| 283 <b>on_clearButton_clicked</b>(<i></i>) | |
| 284 | |
| 285 <p> | |
| 286 Private slot to clear the call trace. | |
| 287 </p> | |
| 288 <a NAME="CallTraceViewer.on_resizeButton_clicked" ID="CallTraceViewer.on_resizeButton_clicked"></a> | |
| 289 <h4>CallTraceViewer.on_resizeButton_clicked</h4> | |
| 290 <b>on_resizeButton_clicked</b>(<i></i>) | |
| 291 | |
| 292 <p> | |
| 293 Private slot to resize the columns of the call trace to their contents. | |
| 294 </p> | |
| 295 <a NAME="CallTraceViewer.on_saveButton_clicked" ID="CallTraceViewer.on_saveButton_clicked"></a> | |
| 296 <h4>CallTraceViewer.on_saveButton_clicked</h4> | |
| 297 <b>on_saveButton_clicked</b>(<i></i>) | |
| 298 | |
| 299 <p> | |
| 300 Private slot to save the call trace info to a file. | |
| 301 </p> | |
| 302 <a NAME="CallTraceViewer.on_startTraceButton_clicked" ID="CallTraceViewer.on_startTraceButton_clicked"></a> | |
| 303 <h4>CallTraceViewer.on_startTraceButton_clicked</h4> | |
| 304 <b>on_startTraceButton_clicked</b>(<i></i>) | |
| 305 | |
| 306 <p> | |
| 307 Private slot to start call tracing. | |
| 308 </p> | |
| 309 <a NAME="CallTraceViewer.on_stopCheckBox_clicked" ID="CallTraceViewer.on_stopCheckBox_clicked"></a> | |
| 310 <h4>CallTraceViewer.on_stopCheckBox_clicked</h4> | |
| 311 <b>on_stopCheckBox_clicked</b>(<i>checked</i>) | |
| 312 | |
| 313 <p> | |
| 314 Private slot to handle a click on the stop check box. | |
| 315 </p> | |
| 316 <dl> | |
| 317 | |
| 318 <dt><i>checked</i> (bool)</dt> | |
| 319 <dd> | |
| 320 state of the check box | |
| 321 </dd> | |
| 322 </dl> | |
| 323 <a NAME="CallTraceViewer.on_stopTraceButton_clicked" ID="CallTraceViewer.on_stopTraceButton_clicked"></a> | |
| 324 <h4>CallTraceViewer.on_stopTraceButton_clicked</h4> | |
| 325 <b>on_stopTraceButton_clicked</b>(<i></i>) | |
| 326 | |
| 327 <p> | |
| 328 Private slot to start call tracing. | |
| 329 </p> | |
| 330 <a NAME="CallTraceViewer.setProjectMode" ID="CallTraceViewer.setProjectMode"></a> | |
| 331 <h4>CallTraceViewer.setProjectMode</h4> | |
| 332 <b>setProjectMode</b>(<i>enabled</i>) | |
| 333 | |
| 334 <p> | |
| 335 Public slot to set the call trace viewer to project mode. | |
| 336 </p> | |
| 337 <p> | |
| 338 In project mode the call trace info is shown with project relative | |
| 339 path names. | |
| 340 </p> | |
| 341 <dl> | |
| 342 | |
| 343 <dt><i>enabled</i> (bool)</dt> | |
| 344 <dd> | |
| 345 flag indicating to enable the project mode | |
| 346 </dd> | |
| 347 </dl> | |
| 348 <div align="right"><a href="#top">Up</a></div> | |
| 349 <hr /> | |
| 350 </body></html> |
