Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Debugger.DebugViewer.html
src/eric7/Documentation/Source/eric7.Debugger.DebugViewer.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9382
- fb89c1dc9825
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Debugger.DebugViewer</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.DebugViewer</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a widget containing various debug related views. | |
| 13 </p> | |
| 14 <p> | |
| 15 The views avaliable are: | |
| 16 <ul> | |
| 17 <li>selector showing all connected debugger backends with associated | |
| 18 threads</li> | |
| 19 <li>variables viewer for global variables for the selected debug client</li> | |
| 20 <li>variables viewer for local variables for the selected debug client</li> | |
| 21 <li>call stack viewer for the selected debug client</li> | |
| 22 <li>call trace viewer</li> | |
| 23 <li>viewer for breakpoints</li> | |
| 24 <li>viewer for watch expressions</li> | |
| 25 <li>viewer for exceptions</li> | |
| 26 <li>viewer for a code disassembly for an exception<li> | |
| 27 </ul> | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 | |
| 36 <table> | |
| 37 | |
| 38 <tr> | |
| 39 <td><a href="#DebugViewer">DebugViewer</a></td> | |
| 40 <td>Class implementing a widget containing various debug related views.</td> | |
| 41 </tr> | |
| 42 </table> | |
| 43 <h3>Functions</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <hr /> | |
| 49 <hr /> | |
| 50 <a NAME="DebugViewer" ID="DebugViewer"></a> | |
| 51 <h2>DebugViewer</h2> | |
| 52 | |
| 53 <p> | |
| 54 Class implementing a widget containing various debug related views. | |
| 55 </p> | |
| 56 <p> | |
| 57 The individual tabs contain the interpreter shell (optional), | |
| 58 the filesystem browser (optional), the two variables viewers | |
| 59 (global and local), a breakpoint viewer, a watch expression viewer and | |
| 60 the exception logger. Additionally a list of all threads is shown. | |
| 61 </p> | |
| 62 <h3>Signals</h3> | |
| 63 <dl> | |
| 64 | |
| 65 <dt>preferencesChanged()</dt> | |
| 66 <dd> | |
| 67 emitted to react on changed preferences | |
| 68 </dd> | |
| 69 <dt>sourceFile(string, int)</dt> | |
| 70 <dd> | |
| 71 emitted to open a source file at a line | |
| 72 </dd> | |
| 73 </dl> | |
| 74 <h3>Derived from</h3> | |
| 75 QWidget | |
| 76 <h3>Class Attributes</h3> | |
| 77 | |
| 78 <table> | |
| 79 <tr><td>DebuggerStateRole</td></tr><tr><td>StateIcon</td></tr><tr><td>StateMessage</td></tr><tr><td>ThreadIdRole</td></tr> | |
| 80 </table> | |
| 81 <h3>Class Methods</h3> | |
| 82 | |
| 83 <table> | |
| 84 <tr><td>None</td></tr> | |
| 85 </table> | |
| 86 <h3>Methods</h3> | |
| 87 | |
| 88 <table> | |
| 89 | |
| 90 <tr> | |
| 91 <td><a href="#DebugViewer.__init__">DebugViewer</a></td> | |
| 92 <td>Constructor</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#DebugViewer.__addThreadList">__addThreadList</a></td> | |
| 96 <td>Private method to add the list of threads to a debugger entry.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#DebugViewer.__callStackFrameSelected">__callStackFrameSelected</a></td> | |
| 100 <td>Private slot to handle the selection of a call stack entry of the call stack viewer.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#DebugViewer.__clientDebuggerId">__clientDebuggerId</a></td> | |
| 104 <td>Private slot to receive the ID of a newly connected debugger backend.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#DebugViewer.__clientException">__clientException</a></td> | |
| 108 <td>Private method to handle an exception of the debugged program.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#DebugViewer.__clientExit">__clientExit</a></td> | |
| 112 <td>Private method to handle the debugged program terminating.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#DebugViewer.__clientLine">__clientLine</a></td> | |
| 116 <td>Private method to handle a change to the current line.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#DebugViewer.__clientSyntaxError">__clientSyntaxError</a></td> | |
| 120 <td>Private method to handle a syntax error in the debugged program.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#DebugViewer.__debuggerSelected">__debuggerSelected</a></td> | |
| 124 <td>Private slot to handle the selection of a debugger backend in the debuggers list.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#DebugViewer.__frameSelected">__frameSelected</a></td> | |
| 128 <td>Private slot to handle the selection of a new stack frame number.</td> | |
| 129 </tr> | |
| 130 <tr> | |
| 131 <td><a href="#DebugViewer.__removeDebugger">__removeDebugger</a></td> | |
| 132 <td>Private method to remove a debugger given its ID.</td> | |
| 133 </tr> | |
| 134 <tr> | |
| 135 <td><a href="#DebugViewer.__setCurrentDebugger">__setCurrentDebugger</a></td> | |
| 136 <td>Private method to set the current debugger based on the given ID.</td> | |
| 137 </tr> | |
| 138 <tr> | |
| 139 <td><a href="#DebugViewer.__setDebuggerIconAndState">__setDebuggerIconAndState</a></td> | |
| 140 <td>Private method to set the icon for a specific debugger ID.</td> | |
| 141 </tr> | |
| 142 <tr> | |
| 143 <td><a href="#DebugViewer.__setThreadIconAndState">__setThreadIconAndState</a></td> | |
| 144 <td>Private method to set the icon for a specific thread name and debugger ID.</td> | |
| 145 </tr> | |
| 146 <tr> | |
| 147 <td><a href="#DebugViewer.__showSource">__showSource</a></td> | |
| 148 <td>Private slot to handle the source button press to show the selected file.</td> | |
| 149 </tr> | |
| 150 <tr> | |
| 151 <td><a href="#DebugViewer.clearCallTrace">clearCallTrace</a></td> | |
| 152 <td>Public method to clear the recorded call trace.</td> | |
| 153 </tr> | |
| 154 <tr> | |
| 155 <td><a href="#DebugViewer.currentWidget">currentWidget</a></td> | |
| 156 <td>Public method to get a reference to the current widget.</td> | |
| 157 </tr> | |
| 158 <tr> | |
| 159 <td><a href="#DebugViewer.getSelectedDebuggerId">getSelectedDebuggerId</a></td> | |
| 160 <td>Public method to get the currently selected debugger ID.</td> | |
| 161 </tr> | |
| 162 <tr> | |
| 163 <td><a href="#DebugViewer.getSelectedDebuggerState">getSelectedDebuggerState</a></td> | |
| 164 <td>Public method to get the currently selected debugger's state.</td> | |
| 165 </tr> | |
| 166 <tr> | |
| 167 <td><a href="#DebugViewer.handleClientStack">handleClientStack</a></td> | |
| 168 <td>Public slot to show the call stack of the program being debugged.</td> | |
| 169 </tr> | |
| 170 <tr> | |
| 171 <td><a href="#DebugViewer.handleDebuggingStarted">handleDebuggingStarted</a></td> | |
| 172 <td>Public slot to handle the start of a debugging session.</td> | |
| 173 </tr> | |
| 174 <tr> | |
| 175 <td><a href="#DebugViewer.handlePreferencesChanged">handlePreferencesChanged</a></td> | |
| 176 <td>Public slot to handle the preferencesChanged signal.</td> | |
| 177 </tr> | |
| 178 <tr> | |
| 179 <td><a href="#DebugViewer.handleResetUI">handleResetUI</a></td> | |
| 180 <td>Public method to reset the viewer.</td> | |
| 181 </tr> | |
| 182 <tr> | |
| 183 <td><a href="#DebugViewer.initCallStackViewer">initCallStackViewer</a></td> | |
| 184 <td>Public method to initialize the call stack viewer.</td> | |
| 185 </tr> | |
| 186 <tr> | |
| 187 <td><a href="#DebugViewer.isCallTraceEnabled">isCallTraceEnabled</a></td> | |
| 188 <td>Public method to get the state of the call trace function.</td> | |
| 189 </tr> | |
| 190 <tr> | |
| 191 <td><a href="#DebugViewer.isOnlyDebugger">isOnlyDebugger</a></td> | |
| 192 <td>Public method to test, if only one debugger is connected.</td> | |
| 193 </tr> | |
| 194 <tr> | |
| 195 <td><a href="#DebugViewer.setCallTraceToProjectMode">setCallTraceToProjectMode</a></td> | |
| 196 <td>Public slot to set the call trace viewer to project mode.</td> | |
| 197 </tr> | |
| 198 <tr> | |
| 199 <td><a href="#DebugViewer.setCurrentWidget">setCurrentWidget</a></td> | |
| 200 <td>Public slot to set the current page based on the given widget.</td> | |
| 201 </tr> | |
| 202 <tr> | |
| 203 <td><a href="#DebugViewer.setDebugger">setDebugger</a></td> | |
| 204 <td>Public method to set a reference to the Debug UI.</td> | |
| 205 </tr> | |
| 206 <tr> | |
| 207 <td><a href="#DebugViewer.setGlobalsFilter">setGlobalsFilter</a></td> | |
| 208 <td>Public slot to set the global variable filter.</td> | |
| 209 </tr> | |
| 210 <tr> | |
| 211 <td><a href="#DebugViewer.setLocalsFilter">setLocalsFilter</a></td> | |
| 212 <td>Public slot to set the local variable filter.</td> | |
| 213 </tr> | |
| 214 <tr> | |
| 215 <td><a href="#DebugViewer.setVariablesFilter">setVariablesFilter</a></td> | |
| 216 <td>Public slot to set the local variables filter.</td> | |
| 217 </tr> | |
| 218 <tr> | |
| 219 <td><a href="#DebugViewer.showVariable">showVariable</a></td> | |
| 220 <td>Public method to show the variables in the respective window.</td> | |
| 221 </tr> | |
| 222 <tr> | |
| 223 <td><a href="#DebugViewer.showVariables">showVariables</a></td> | |
| 224 <td>Public method to show the variables in the respective window.</td> | |
| 225 </tr> | |
| 226 <tr> | |
| 227 <td><a href="#DebugViewer.showVariablesTab">showVariablesTab</a></td> | |
| 228 <td>Public method to make a variables tab visible.</td> | |
| 229 </tr> | |
| 230 </table> | |
| 231 <h3>Static Methods</h3> | |
| 232 | |
| 233 <table> | |
| 234 <tr><td>None</td></tr> | |
| 235 </table> | |
| 236 | |
| 237 <a NAME="DebugViewer.__init__" ID="DebugViewer.__init__"></a> | |
| 238 <h4>DebugViewer (Constructor)</h4> | |
| 239 <b>DebugViewer</b>(<i>debugServer, parent=None</i>) | |
| 240 | |
| 241 <p> | |
| 242 Constructor | |
| 243 </p> | |
| 244 <dl> | |
| 245 | |
| 246 <dt><i>debugServer</i> (DebugServer)</dt> | |
| 247 <dd> | |
| 248 reference to the debug server object | |
| 249 </dd> | |
| 250 <dt><i>parent</i> (QWidget)</dt> | |
| 251 <dd> | |
| 252 parent widget | |
| 253 </dd> | |
| 254 </dl> | |
| 255 <a NAME="DebugViewer.__addThreadList" ID="DebugViewer.__addThreadList"></a> | |
| 256 <h4>DebugViewer.__addThreadList</h4> | |
| 257 <b>__addThreadList</b>(<i>currentID, threadList, debuggerId</i>) | |
| 258 | |
| 259 <p> | |
| 260 Private method to add the list of threads to a debugger entry. | |
| 261 </p> | |
| 262 <dl> | |
| 263 | |
| 264 <dt><i>currentID</i> (int)</dt> | |
| 265 <dd> | |
| 266 id of the current thread | |
| 267 </dd> | |
| 268 <dt><i>threadList</i> (list of dict)</dt> | |
| 269 <dd> | |
| 270 list of dictionaries containing the thread data | |
| 271 </dd> | |
| 272 <dt><i>debuggerId</i> (str)</dt> | |
| 273 <dd> | |
| 274 ID of the debugger backend | |
| 275 </dd> | |
| 276 </dl> | |
| 277 <a NAME="DebugViewer.__callStackFrameSelected" ID="DebugViewer.__callStackFrameSelected"></a> | |
| 278 <h4>DebugViewer.__callStackFrameSelected</h4> | |
| 279 <b>__callStackFrameSelected</b>(<i>frameNo</i>) | |
| 280 | |
| 281 <p> | |
| 282 Private slot to handle the selection of a call stack entry of the | |
| 283 call stack viewer. | |
| 284 </p> | |
| 285 <dl> | |
| 286 | |
| 287 <dt><i>frameNo</i> (int)</dt> | |
| 288 <dd> | |
| 289 frame number (index) of the selected entry | |
| 290 </dd> | |
| 291 </dl> | |
| 292 <a NAME="DebugViewer.__clientDebuggerId" ID="DebugViewer.__clientDebuggerId"></a> | |
| 293 <h4>DebugViewer.__clientDebuggerId</h4> | |
| 294 <b>__clientDebuggerId</b>(<i>debuggerId</i>) | |
| 295 | |
| 296 <p> | |
| 297 Private slot to receive the ID of a newly connected debugger backend. | |
| 298 </p> | |
| 299 <dl> | |
| 300 | |
| 301 <dt><i>debuggerId</i> (str)</dt> | |
| 302 <dd> | |
| 303 ID of a newly connected debugger backend | |
| 304 </dd> | |
| 305 </dl> | |
| 306 <a NAME="DebugViewer.__clientException" ID="DebugViewer.__clientException"></a> | |
| 307 <h4>DebugViewer.__clientException</h4> | |
| 308 <b>__clientException</b>(<i>exceptionType, exceptionMessage, stackTrace, debuggerId, threadName</i>) | |
| 309 | |
| 310 <p> | |
| 311 Private method to handle an exception of the debugged program. | |
| 312 </p> | |
| 313 <dl> | |
| 314 | |
| 315 <dt><i>exceptionType</i> (str)</dt> | |
| 316 <dd> | |
| 317 type of exception raised | |
| 318 </dd> | |
| 319 <dt><i>exceptionMessage</i> ((str)</dt> | |
| 320 <dd> | |
| 321 message given by the exception | |
| 322 </dd> | |
| 323 <dt><i>stackTrace</i> (list of str)</dt> | |
| 324 <dd> | |
| 325 list of stack entries | |
| 326 </dd> | |
| 327 <dt><i>debuggerId</i> (str)</dt> | |
| 328 <dd> | |
| 329 ID of the debugger backend | |
| 330 </dd> | |
| 331 <dt><i>threadName</i> (str)</dt> | |
| 332 <dd> | |
| 333 name of the thread signaling the event | |
| 334 </dd> | |
| 335 </dl> | |
| 336 <a NAME="DebugViewer.__clientExit" ID="DebugViewer.__clientExit"></a> | |
| 337 <h4>DebugViewer.__clientExit</h4> | |
| 338 <b>__clientExit</b>(<i>program, status, message, quiet, debuggerId</i>) | |
| 339 | |
| 340 <p> | |
| 341 Private method to handle the debugged program terminating. | |
| 342 </p> | |
| 343 <dl> | |
| 344 | |
| 345 <dt><i>program</i> (str)</dt> | |
| 346 <dd> | |
| 347 name of the exited program | |
| 348 </dd> | |
| 349 <dt><i>status</i> (int)</dt> | |
| 350 <dd> | |
| 351 exit code of the debugged program | |
| 352 </dd> | |
| 353 <dt><i>message</i> (str)</dt> | |
| 354 <dd> | |
| 355 exit message of the debugged program | |
| 356 </dd> | |
| 357 <dt><i>quiet</i> (bool)</dt> | |
| 358 <dd> | |
| 359 flag indicating to suppress exit info display | |
| 360 </dd> | |
| 361 <dt><i>debuggerId</i> (str)</dt> | |
| 362 <dd> | |
| 363 ID of the debugger backend | |
| 364 </dd> | |
| 365 </dl> | |
| 366 <a NAME="DebugViewer.__clientLine" ID="DebugViewer.__clientLine"></a> | |
| 367 <h4>DebugViewer.__clientLine</h4> | |
| 368 <b>__clientLine</b>(<i>fn, line, debuggerId, threadName</i>) | |
| 369 | |
| 370 <p> | |
| 371 Private method to handle a change to the current line. | |
| 372 </p> | |
| 373 <dl> | |
| 374 | |
| 375 <dt><i>fn</i> (str)</dt> | |
| 376 <dd> | |
| 377 filename | |
| 378 </dd> | |
| 379 <dt><i>line</i> (int)</dt> | |
| 380 <dd> | |
| 381 linenumber | |
| 382 </dd> | |
| 383 <dt><i>debuggerId</i> (str)</dt> | |
| 384 <dd> | |
| 385 ID of the debugger backend | |
| 386 </dd> | |
| 387 <dt><i>threadName</i> (str)</dt> | |
| 388 <dd> | |
| 389 name of the thread signaling the event | |
| 390 </dd> | |
| 391 </dl> | |
| 392 <a NAME="DebugViewer.__clientSyntaxError" ID="DebugViewer.__clientSyntaxError"></a> | |
| 393 <h4>DebugViewer.__clientSyntaxError</h4> | |
| 394 <b>__clientSyntaxError</b>(<i>message, filename, lineNo, characterNo, debuggerId, threadName</i>) | |
| 395 | |
| 396 <p> | |
| 397 Private method to handle a syntax error in the debugged program. | |
| 398 </p> | |
| 399 <dl> | |
| 400 | |
| 401 <dt><i>message</i> (str)</dt> | |
| 402 <dd> | |
| 403 message of the syntax error | |
| 404 </dd> | |
| 405 <dt><i>filename</i> (str)</dt> | |
| 406 <dd> | |
| 407 translated filename of the syntax error position | |
| 408 </dd> | |
| 409 <dt><i>lineNo</i> (int)</dt> | |
| 410 <dd> | |
| 411 line number of the syntax error position | |
| 412 </dd> | |
| 413 <dt><i>characterNo</i> (int)</dt> | |
| 414 <dd> | |
| 415 character number of the syntax error position | |
| 416 </dd> | |
| 417 <dt><i>debuggerId</i> (str)</dt> | |
| 418 <dd> | |
| 419 ID of the debugger backend | |
| 420 </dd> | |
| 421 <dt><i>threadName</i> (str)</dt> | |
| 422 <dd> | |
| 423 name of the thread signaling the event | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <a NAME="DebugViewer.__debuggerSelected" ID="DebugViewer.__debuggerSelected"></a> | |
| 427 <h4>DebugViewer.__debuggerSelected</h4> | |
| 428 <b>__debuggerSelected</b>(<i>current, previous</i>) | |
| 429 | |
| 430 <p> | |
| 431 Private slot to handle the selection of a debugger backend in the | |
| 432 debuggers list. | |
| 433 </p> | |
| 434 <dl> | |
| 435 | |
| 436 <dt><i>current</i> (QTreeWidgetItem)</dt> | |
| 437 <dd> | |
| 438 reference to the new current item | |
| 439 </dd> | |
| 440 <dt><i>previous</i> (QTreeWidgetItem)</dt> | |
| 441 <dd> | |
| 442 reference to the previous current item | |
| 443 </dd> | |
| 444 </dl> | |
| 445 <a NAME="DebugViewer.__frameSelected" ID="DebugViewer.__frameSelected"></a> | |
| 446 <h4>DebugViewer.__frameSelected</h4> | |
| 447 <b>__frameSelected</b>(<i>frmnr</i>) | |
| 448 | |
| 449 <p> | |
| 450 Private slot to handle the selection of a new stack frame number. | |
| 451 </p> | |
| 452 <dl> | |
| 453 | |
| 454 <dt><i>frmnr</i> (int)</dt> | |
| 455 <dd> | |
| 456 frame number (0 is the current frame) | |
| 457 </dd> | |
| 458 </dl> | |
| 459 <a NAME="DebugViewer.__removeDebugger" ID="DebugViewer.__removeDebugger"></a> | |
| 460 <h4>DebugViewer.__removeDebugger</h4> | |
| 461 <b>__removeDebugger</b>(<i>debuggerId</i>) | |
| 462 | |
| 463 <p> | |
| 464 Private method to remove a debugger given its ID. | |
| 465 </p> | |
| 466 <dl> | |
| 467 | |
| 468 <dt><i>debuggerId</i> (str)</dt> | |
| 469 <dd> | |
| 470 ID of the debugger to be removed from the list | |
| 471 </dd> | |
| 472 </dl> | |
| 473 <a NAME="DebugViewer.__setCurrentDebugger" ID="DebugViewer.__setCurrentDebugger"></a> | |
| 474 <h4>DebugViewer.__setCurrentDebugger</h4> | |
| 475 <b>__setCurrentDebugger</b>(<i>debuggerId</i>) | |
| 476 | |
| 477 <p> | |
| 478 Private method to set the current debugger based on the given ID. | |
| 479 </p> | |
| 480 <dl> | |
| 481 | |
| 482 <dt><i>debuggerId</i> (str)</dt> | |
| 483 <dd> | |
| 484 ID of the debugger to set as current debugger | |
| 485 </dd> | |
| 486 </dl> | |
| 487 <a NAME="DebugViewer.__setDebuggerIconAndState" ID="DebugViewer.__setDebuggerIconAndState"></a> | |
| 488 <h4>DebugViewer.__setDebuggerIconAndState</h4> | |
| 489 <b>__setDebuggerIconAndState</b>(<i>debuggerId, state</i>) | |
| 490 | |
| 491 <p> | |
| 492 Private method to set the icon for a specific debugger ID. | |
| 493 </p> | |
| 494 <dl> | |
| 495 | |
| 496 <dt><i>debuggerId</i> (str)</dt> | |
| 497 <dd> | |
| 498 ID of the debugger backend (empty ID means the | |
| 499 currently selected one) | |
| 500 </dd> | |
| 501 <dt><i>state</i> (str)</dt> | |
| 502 <dd> | |
| 503 state of the debugger (broken, exception, running) | |
| 504 </dd> | |
| 505 </dl> | |
| 506 <a NAME="DebugViewer.__setThreadIconAndState" ID="DebugViewer.__setThreadIconAndState"></a> | |
| 507 <h4>DebugViewer.__setThreadIconAndState</h4> | |
| 508 <b>__setThreadIconAndState</b>(<i>debuggerId, threadName, state</i>) | |
| 509 | |
| 510 <p> | |
| 511 Private method to set the icon for a specific thread name and | |
| 512 debugger ID. | |
| 513 </p> | |
| 514 <dl> | |
| 515 | |
| 516 <dt><i>debuggerId</i> (str)</dt> | |
| 517 <dd> | |
| 518 ID of the debugger backend (empty ID means the | |
| 519 currently selected one) | |
| 520 </dd> | |
| 521 <dt><i>threadName</i> (str)</dt> | |
| 522 <dd> | |
| 523 name of the thread signaling the event | |
| 524 </dd> | |
| 525 <dt><i>state</i> (str)</dt> | |
| 526 <dd> | |
| 527 state of the debugger (broken, exception, running) | |
| 528 </dd> | |
| 529 </dl> | |
| 530 <a NAME="DebugViewer.__showSource" ID="DebugViewer.__showSource"></a> | |
| 531 <h4>DebugViewer.__showSource</h4> | |
| 532 <b>__showSource</b>(<i></i>) | |
| 533 | |
| 534 <p> | |
| 535 Private slot to handle the source button press to show the selected | |
| 536 file. | |
| 537 </p> | |
| 538 <a NAME="DebugViewer.clearCallTrace" ID="DebugViewer.clearCallTrace"></a> | |
| 539 <h4>DebugViewer.clearCallTrace</h4> | |
| 540 <b>clearCallTrace</b>(<i></i>) | |
| 541 | |
| 542 <p> | |
| 543 Public method to clear the recorded call trace. | |
| 544 </p> | |
| 545 <a NAME="DebugViewer.currentWidget" ID="DebugViewer.currentWidget"></a> | |
| 546 <h4>DebugViewer.currentWidget</h4> | |
| 547 <b>currentWidget</b>(<i></i>) | |
| 548 | |
| 549 <p> | |
| 550 Public method to get a reference to the current widget. | |
| 551 </p> | |
| 552 <dl> | |
| 553 <dt>Return:</dt> | |
| 554 <dd> | |
| 555 reference to the current widget | |
| 556 </dd> | |
| 557 </dl> | |
| 558 <dl> | |
| 559 <dt>Return Type:</dt> | |
| 560 <dd> | |
| 561 QWidget | |
| 562 </dd> | |
| 563 </dl> | |
| 564 <a NAME="DebugViewer.getSelectedDebuggerId" ID="DebugViewer.getSelectedDebuggerId"></a> | |
| 565 <h4>DebugViewer.getSelectedDebuggerId</h4> | |
| 566 <b>getSelectedDebuggerId</b>(<i></i>) | |
| 567 | |
| 568 <p> | |
| 569 Public method to get the currently selected debugger ID. | |
| 570 </p> | |
| 571 <dl> | |
| 572 <dt>Return:</dt> | |
| 573 <dd> | |
| 574 selected debugger ID | |
| 575 </dd> | |
| 576 </dl> | |
| 577 <dl> | |
| 578 <dt>Return Type:</dt> | |
| 579 <dd> | |
| 580 str | |
| 581 </dd> | |
| 582 </dl> | |
| 583 <a NAME="DebugViewer.getSelectedDebuggerState" ID="DebugViewer.getSelectedDebuggerState"></a> | |
| 584 <h4>DebugViewer.getSelectedDebuggerState</h4> | |
| 585 <b>getSelectedDebuggerState</b>(<i></i>) | |
| 586 | |
| 587 <p> | |
| 588 Public method to get the currently selected debugger's state. | |
| 589 </p> | |
| 590 <dl> | |
| 591 <dt>Return:</dt> | |
| 592 <dd> | |
| 593 selected debugger's state (broken, exception, running) | |
| 594 </dd> | |
| 595 </dl> | |
| 596 <dl> | |
| 597 <dt>Return Type:</dt> | |
| 598 <dd> | |
| 599 str | |
| 600 </dd> | |
| 601 </dl> | |
| 602 <a NAME="DebugViewer.handleClientStack" ID="DebugViewer.handleClientStack"></a> | |
| 603 <h4>DebugViewer.handleClientStack</h4> | |
| 604 <b>handleClientStack</b>(<i>stack, debuggerId</i>) | |
| 605 | |
| 606 <p> | |
| 607 Public slot to show the call stack of the program being debugged. | |
| 608 </p> | |
| 609 <dl> | |
| 610 | |
| 611 <dt><i>stack</i> (list of tuples of (str, str, str, str))</dt> | |
| 612 <dd> | |
| 613 list of tuples with call stack data (file name, | |
| 614 line number, function name, formatted argument/values list) | |
| 615 </dd> | |
| 616 <dt><i>debuggerId</i> (str)</dt> | |
| 617 <dd> | |
| 618 ID of the debugger backend | |
| 619 </dd> | |
| 620 </dl> | |
| 621 <a NAME="DebugViewer.handleDebuggingStarted" ID="DebugViewer.handleDebuggingStarted"></a> | |
| 622 <h4>DebugViewer.handleDebuggingStarted</h4> | |
| 623 <b>handleDebuggingStarted</b>(<i></i>) | |
| 624 | |
| 625 <p> | |
| 626 Public slot to handle the start of a debugging session. | |
| 627 </p> | |
| 628 <p> | |
| 629 This slot sets the variables filter expressions. | |
| 630 </p> | |
| 631 <a NAME="DebugViewer.handlePreferencesChanged" ID="DebugViewer.handlePreferencesChanged"></a> | |
| 632 <h4>DebugViewer.handlePreferencesChanged</h4> | |
| 633 <b>handlePreferencesChanged</b>(<i></i>) | |
| 634 | |
| 635 <p> | |
| 636 Public slot to handle the preferencesChanged signal. | |
| 637 </p> | |
| 638 <a NAME="DebugViewer.handleResetUI" ID="DebugViewer.handleResetUI"></a> | |
| 639 <h4>DebugViewer.handleResetUI</h4> | |
| 640 <b>handleResetUI</b>(<i>fullReset</i>) | |
| 641 | |
| 642 <p> | |
| 643 Public method to reset the viewer. | |
| 644 </p> | |
| 645 <dl> | |
| 646 | |
| 647 <dt><i>fullReset</i> (bool)</dt> | |
| 648 <dd> | |
| 649 flag indicating a full reset is required | |
| 650 </dd> | |
| 651 </dl> | |
| 652 <a NAME="DebugViewer.initCallStackViewer" ID="DebugViewer.initCallStackViewer"></a> | |
| 653 <h4>DebugViewer.initCallStackViewer</h4> | |
| 654 <b>initCallStackViewer</b>(<i>projectMode</i>) | |
| 655 | |
| 656 <p> | |
| 657 Public method to initialize the call stack viewer. | |
| 658 </p> | |
| 659 <dl> | |
| 660 | |
| 661 <dt><i>projectMode</i> (bool)</dt> | |
| 662 <dd> | |
| 663 flag indicating to enable the project mode | |
| 664 </dd> | |
| 665 </dl> | |
| 666 <a NAME="DebugViewer.isCallTraceEnabled" ID="DebugViewer.isCallTraceEnabled"></a> | |
| 667 <h4>DebugViewer.isCallTraceEnabled</h4> | |
| 668 <b>isCallTraceEnabled</b>(<i></i>) | |
| 669 | |
| 670 <p> | |
| 671 Public method to get the state of the call trace function. | |
| 672 </p> | |
| 673 <dl> | |
| 674 <dt>Return:</dt> | |
| 675 <dd> | |
| 676 flag indicating the state of the call trace function | |
| 677 </dd> | |
| 678 </dl> | |
| 679 <dl> | |
| 680 <dt>Return Type:</dt> | |
| 681 <dd> | |
| 682 bool | |
| 683 </dd> | |
| 684 </dl> | |
| 685 <a NAME="DebugViewer.isOnlyDebugger" ID="DebugViewer.isOnlyDebugger"></a> | |
| 686 <h4>DebugViewer.isOnlyDebugger</h4> | |
| 687 <b>isOnlyDebugger</b>(<i></i>) | |
| 688 | |
| 689 <p> | |
| 690 Public method to test, if only one debugger is connected. | |
| 691 </p> | |
| 692 <dl> | |
| 693 <dt>Return:</dt> | |
| 694 <dd> | |
| 695 flag indicating that only one debugger is connected | |
| 696 </dd> | |
| 697 </dl> | |
| 698 <dl> | |
| 699 <dt>Return Type:</dt> | |
| 700 <dd> | |
| 701 bool | |
| 702 </dd> | |
| 703 </dl> | |
| 704 <a NAME="DebugViewer.setCallTraceToProjectMode" ID="DebugViewer.setCallTraceToProjectMode"></a> | |
| 705 <h4>DebugViewer.setCallTraceToProjectMode</h4> | |
| 706 <b>setCallTraceToProjectMode</b>(<i>enabled</i>) | |
| 707 | |
| 708 <p> | |
| 709 Public slot to set the call trace viewer to project mode. | |
| 710 </p> | |
| 711 <p> | |
| 712 In project mode the call trace info is shown with project relative | |
| 713 path names. | |
| 714 </p> | |
| 715 <dl> | |
| 716 | |
| 717 <dt><i>enabled</i> (bool)</dt> | |
| 718 <dd> | |
| 719 flag indicating to enable the project mode | |
| 720 </dd> | |
| 721 </dl> | |
| 722 <a NAME="DebugViewer.setCurrentWidget" ID="DebugViewer.setCurrentWidget"></a> | |
| 723 <h4>DebugViewer.setCurrentWidget</h4> | |
| 724 <b>setCurrentWidget</b>(<i>widget</i>) | |
| 725 | |
| 726 <p> | |
| 727 Public slot to set the current page based on the given widget. | |
| 728 </p> | |
| 729 <dl> | |
| 730 | |
| 731 <dt><i>widget</i> (QWidget)</dt> | |
| 732 <dd> | |
| 733 reference to the widget | |
| 734 </dd> | |
| 735 </dl> | |
| 736 <a NAME="DebugViewer.setDebugger" ID="DebugViewer.setDebugger"></a> | |
| 737 <h4>DebugViewer.setDebugger</h4> | |
| 738 <b>setDebugger</b>(<i>debugUI</i>) | |
| 739 | |
| 740 <p> | |
| 741 Public method to set a reference to the Debug UI. | |
| 742 </p> | |
| 743 <dl> | |
| 744 | |
| 745 <dt><i>debugUI</i> (DebugUI)</dt> | |
| 746 <dd> | |
| 747 reference to the DebugUI object | |
| 748 </dd> | |
| 749 </dl> | |
| 750 <a NAME="DebugViewer.setGlobalsFilter" ID="DebugViewer.setGlobalsFilter"></a> | |
| 751 <h4>DebugViewer.setGlobalsFilter</h4> | |
| 752 <b>setGlobalsFilter</b>(<i></i>) | |
| 753 | |
| 754 <p> | |
| 755 Public slot to set the global variable filter. | |
| 756 </p> | |
| 757 <a NAME="DebugViewer.setLocalsFilter" ID="DebugViewer.setLocalsFilter"></a> | |
| 758 <h4>DebugViewer.setLocalsFilter</h4> | |
| 759 <b>setLocalsFilter</b>(<i></i>) | |
| 760 | |
| 761 <p> | |
| 762 Public slot to set the local variable filter. | |
| 763 </p> | |
| 764 <a NAME="DebugViewer.setVariablesFilter" ID="DebugViewer.setVariablesFilter"></a> | |
| 765 <h4>DebugViewer.setVariablesFilter</h4> | |
| 766 <b>setVariablesFilter</b>(<i>globalsFilter, localsFilter</i>) | |
| 767 | |
| 768 <p> | |
| 769 Public slot to set the local variables filter. | |
| 770 </p> | |
| 771 <dl> | |
| 772 | |
| 773 <dt><i>globalsFilter</i> (list of str)</dt> | |
| 774 <dd> | |
| 775 filter list for global variable types | |
| 776 </dd> | |
| 777 <dt><i>localsFilter</i> (list of str)</dt> | |
| 778 <dd> | |
| 779 filter list for local variable types | |
| 780 </dd> | |
| 781 </dl> | |
| 782 <a NAME="DebugViewer.showVariable" ID="DebugViewer.showVariable"></a> | |
| 783 <h4>DebugViewer.showVariable</h4> | |
| 784 <b>showVariable</b>(<i>vlist, showGlobals</i>) | |
| 785 | |
| 786 <p> | |
| 787 Public method to show the variables in the respective window. | |
| 788 </p> | |
| 789 <dl> | |
| 790 | |
| 791 <dt><i>vlist</i> (list)</dt> | |
| 792 <dd> | |
| 793 list of variables to display | |
| 794 </dd> | |
| 795 <dt><i>showGlobals</i> (bool)</dt> | |
| 796 <dd> | |
| 797 flag indicating global/local state | |
| 798 </dd> | |
| 799 </dl> | |
| 800 <a NAME="DebugViewer.showVariables" ID="DebugViewer.showVariables"></a> | |
| 801 <h4>DebugViewer.showVariables</h4> | |
| 802 <b>showVariables</b>(<i>vlist, showGlobals</i>) | |
| 803 | |
| 804 <p> | |
| 805 Public method to show the variables in the respective window. | |
| 806 </p> | |
| 807 <dl> | |
| 808 | |
| 809 <dt><i>vlist</i> (list)</dt> | |
| 810 <dd> | |
| 811 list of variables to display | |
| 812 </dd> | |
| 813 <dt><i>showGlobals</i> (bool)</dt> | |
| 814 <dd> | |
| 815 flag indicating global/local state | |
| 816 </dd> | |
| 817 </dl> | |
| 818 <a NAME="DebugViewer.showVariablesTab" ID="DebugViewer.showVariablesTab"></a> | |
| 819 <h4>DebugViewer.showVariablesTab</h4> | |
| 820 <b>showVariablesTab</b>(<i>showGlobals</i>) | |
| 821 | |
| 822 <p> | |
| 823 Public method to make a variables tab visible. | |
| 824 </p> | |
| 825 <dl> | |
| 826 | |
| 827 <dt><i>showGlobals</i> (bool)</dt> | |
| 828 <dd> | |
| 829 flag indicating global/local state | |
| 830 </dd> | |
| 831 </dl> | |
| 832 <div align="right"><a href="#top">Up</a></div> | |
| 833 <hr /> | |
| 834 </body></html> |
