Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Debugger.DebugViewer.html
Documentation/Source/eric5.Debugger.DebugViewer.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.Debugger.DebugViewer</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.Debugger.DebugViewer</h1> | |
| 12 <p> | |
| 13 Module implementing a widget containing various debug related views. | |
| 14 </p><p> | |
| 15 The views avaliable are: | |
| 16 <ul> | |
| 17 <li>variables viewer for global variables</li> | |
| 18 <li>variables viewer for local variables</li> | |
| 19 <li>viewer for breakpoints</li> | |
| 20 <li>viewer for watch expressions</li> | |
| 21 <li>viewer for exceptions</li> | |
| 22 <li>viewer for threads</li> | |
| 23 <li>a file browser (optional)</li> | |
| 24 <li>an interpreter shell (optional)</li> | |
| 25 </ul> | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#DebugViewer">DebugViewer</a></td> | |
| 35 <td>Class implementing a widget conatining various debug related views.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="DebugViewer" ID="DebugViewer"></a> | |
| 44 <h2>DebugViewer</h2> | |
| 45 <p> | |
| 46 Class implementing a widget conatining various debug related views. | |
| 47 </p><p> | |
| 48 The individual tabs contain the interpreter shell (optional), | |
| 49 the filesystem browser (optional), the two variables viewers (global and local), | |
| 50 a breakpoint viewer, a watch expression viewer and the exception logger. Additionally | |
| 51 a list of all threads is shown. | |
| 52 </p><h4>Signals</h4> | |
| 53 <dl> | |
| 54 <dt>sourceFile(string, int)</dt> | |
| 55 <dd> | |
| 56 emitted to open a source file at a line | |
| 57 </dd> | |
| 58 </dl> | |
| 59 <h3>Derived from</h3> | |
| 60 QWidget | |
| 61 <h3>Class Attributes</h3> | |
| 62 <table> | |
| 63 <tr><td>None</td></tr> | |
| 64 </table> | |
| 65 <h3>Methods</h3> | |
| 66 <table> | |
| 67 <tr> | |
| 68 <td><a href="#DebugViewer.__init__">DebugViewer</a></td> | |
| 69 <td>Constructor</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#DebugViewer.__frameSelected">__frameSelected</a></td> | |
| 72 <td>Private slot to handle the selection of a new stack frame number.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#DebugViewer.__setGlobalsFilter">__setGlobalsFilter</a></td> | |
| 75 <td>Private slot to set the global variable filter</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#DebugViewer.__setLocalsFilter">__setLocalsFilter</a></td> | |
| 78 <td>Private slot to set the local variable filter</td> | |
| 79 </tr><tr> | |
| 80 <td><a href="#DebugViewer.__showSource">__showSource</a></td> | |
| 81 <td>Private slot to handle the source button press to show the selected file.</td> | |
| 82 </tr><tr> | |
| 83 <td><a href="#DebugViewer.__threadSelected">__threadSelected</a></td> | |
| 84 <td>Private slot to handle the selection of a thread in the thread list.</td> | |
| 85 </tr><tr> | |
| 86 <td><a href="#DebugViewer.currentWidget">currentWidget</a></td> | |
| 87 <td>Public method to get a reference to the current widget.</td> | |
| 88 </tr><tr> | |
| 89 <td><a href="#DebugViewer.handleClientStack">handleClientStack</a></td> | |
| 90 <td>Public slot to show the call stack of the program being debugged.</td> | |
| 91 </tr><tr> | |
| 92 <td><a href="#DebugViewer.handleDebuggingStarted">handleDebuggingStarted</a></td> | |
| 93 <td>Public slot to handle the start of a debugging session.</td> | |
| 94 </tr><tr> | |
| 95 <td><a href="#DebugViewer.handleRawInput">handleRawInput</a></td> | |
| 96 <td>Pulic slot to handle the switch to the shell in raw input mode.</td> | |
| 97 </tr><tr> | |
| 98 <td><a href="#DebugViewer.handleResetUI">handleResetUI</a></td> | |
| 99 <td>Public method to reset the SBVviewer.</td> | |
| 100 </tr><tr> | |
| 101 <td><a href="#DebugViewer.restoreCurrentPage">restoreCurrentPage</a></td> | |
| 102 <td>Public slot to restore the previously saved page.</td> | |
| 103 </tr><tr> | |
| 104 <td><a href="#DebugViewer.saveCurrentPage">saveCurrentPage</a></td> | |
| 105 <td>Public slot to save the current page.</td> | |
| 106 </tr><tr> | |
| 107 <td><a href="#DebugViewer.setDebugger">setDebugger</a></td> | |
| 108 <td>Public method to set a reference to the Debug UI.</td> | |
| 109 </tr><tr> | |
| 110 <td><a href="#DebugViewer.setVariablesFilter">setVariablesFilter</a></td> | |
| 111 <td>Public slot to set the local variables filter.</td> | |
| 112 </tr><tr> | |
| 113 <td><a href="#DebugViewer.showThreadList">showThreadList</a></td> | |
| 114 <td>Public method to show the thread list.</td> | |
| 115 </tr><tr> | |
| 116 <td><a href="#DebugViewer.showVariable">showVariable</a></td> | |
| 117 <td>Public method to show the variables in the respective window.</td> | |
| 118 </tr><tr> | |
| 119 <td><a href="#DebugViewer.showVariables">showVariables</a></td> | |
| 120 <td>Public method to show the variables in the respective window.</td> | |
| 121 </tr><tr> | |
| 122 <td><a href="#DebugViewer.showVariablesTab">showVariablesTab</a></td> | |
| 123 <td>Public method to make a variables tab visible.</td> | |
| 124 </tr> | |
| 125 </table> | |
| 126 <a NAME="DebugViewer.__init__" ID="DebugViewer.__init__"></a> | |
| 127 <h4>DebugViewer (Constructor)</h4> | |
| 128 <b>DebugViewer</b>(<i>debugServer, docked, vm, parent = None, embeddedShell = True, embeddedBrowser = True</i>) | |
| 129 <p> | |
| 130 Constructor | |
| 131 </p><dl> | |
| 132 <dt><i>debugServer</i></dt> | |
| 133 <dd> | |
| 134 reference to the debug server object | |
| 135 </dd><dt><i>docked</i></dt> | |
| 136 <dd> | |
| 137 flag indicating a dock window | |
| 138 </dd><dt><i>vm</i></dt> | |
| 139 <dd> | |
| 140 reference to the viewmanager object | |
| 141 </dd><dt><i>parent</i></dt> | |
| 142 <dd> | |
| 143 parent widget (QWidget) | |
| 144 </dd><dt><i>embeddedShell</i></dt> | |
| 145 <dd> | |
| 146 flag indicating whether the shell should be included. | |
| 147 This flag is set to False by those layouts, that have the interpreter | |
| 148 shell in a separate window. | |
| 149 </dd><dt><i>embeddedBrowser</i></dt> | |
| 150 <dd> | |
| 151 flag indicating whether the file browser should | |
| 152 be included. This flag is set to False by those layouts, that | |
| 153 have the file browser in a separate window or embedded | |
| 154 in the project browser instead. | |
| 155 </dd> | |
| 156 </dl><a NAME="DebugViewer.__frameSelected" ID="DebugViewer.__frameSelected"></a> | |
| 157 <h4>DebugViewer.__frameSelected</h4> | |
| 158 <b>__frameSelected</b>(<i>frmnr</i>) | |
| 159 <p> | |
| 160 Private slot to handle the selection of a new stack frame number. | |
| 161 </p><dl> | |
| 162 <dt><i>frmnr</i></dt> | |
| 163 <dd> | |
| 164 frame number (0 is the current frame) (int) | |
| 165 </dd> | |
| 166 </dl><a NAME="DebugViewer.__setGlobalsFilter" ID="DebugViewer.__setGlobalsFilter"></a> | |
| 167 <h4>DebugViewer.__setGlobalsFilter</h4> | |
| 168 <b>__setGlobalsFilter</b>(<i></i>) | |
| 169 <p> | |
| 170 Private slot to set the global variable filter | |
| 171 </p><a NAME="DebugViewer.__setLocalsFilter" ID="DebugViewer.__setLocalsFilter"></a> | |
| 172 <h4>DebugViewer.__setLocalsFilter</h4> | |
| 173 <b>__setLocalsFilter</b>(<i></i>) | |
| 174 <p> | |
| 175 Private slot to set the local variable filter | |
| 176 </p><a NAME="DebugViewer.__showSource" ID="DebugViewer.__showSource"></a> | |
| 177 <h4>DebugViewer.__showSource</h4> | |
| 178 <b>__showSource</b>(<i></i>) | |
| 179 <p> | |
| 180 Private slot to handle the source button press to show the selected file. | |
| 181 </p><a NAME="DebugViewer.__threadSelected" ID="DebugViewer.__threadSelected"></a> | |
| 182 <h4>DebugViewer.__threadSelected</h4> | |
| 183 <b>__threadSelected</b>(<i>current, previous</i>) | |
| 184 <p> | |
| 185 Private slot to handle the selection of a thread in the thread list. | |
| 186 </p><dl> | |
| 187 <dt><i>current</i></dt> | |
| 188 <dd> | |
| 189 reference to the new current item (QTreeWidgetItem) | |
| 190 </dd><dt><i>previous</i></dt> | |
| 191 <dd> | |
| 192 reference to the previous current item (QTreeWidgetItem) | |
| 193 </dd> | |
| 194 </dl><a NAME="DebugViewer.currentWidget" ID="DebugViewer.currentWidget"></a> | |
| 195 <h4>DebugViewer.currentWidget</h4> | |
| 196 <b>currentWidget</b>(<i></i>) | |
| 197 <p> | |
| 198 Public method to get a reference to the current widget. | |
| 199 </p><dl> | |
| 200 <dt>Returns:</dt> | |
| 201 <dd> | |
| 202 reference to the current widget (QWidget) | |
| 203 </dd> | |
| 204 </dl><a NAME="DebugViewer.handleClientStack" ID="DebugViewer.handleClientStack"></a> | |
| 205 <h4>DebugViewer.handleClientStack</h4> | |
| 206 <b>handleClientStack</b>(<i>stack</i>) | |
| 207 <p> | |
| 208 Public slot to show the call stack of the program being debugged. | |
| 209 </p><a NAME="DebugViewer.handleDebuggingStarted" ID="DebugViewer.handleDebuggingStarted"></a> | |
| 210 <h4>DebugViewer.handleDebuggingStarted</h4> | |
| 211 <b>handleDebuggingStarted</b>(<i></i>) | |
| 212 <p> | |
| 213 Public slot to handle the start of a debugging session. | |
| 214 </p><p> | |
| 215 This slot sets the variables filter expressions. | |
| 216 </p><a NAME="DebugViewer.handleRawInput" ID="DebugViewer.handleRawInput"></a> | |
| 217 <h4>DebugViewer.handleRawInput</h4> | |
| 218 <b>handleRawInput</b>(<i></i>) | |
| 219 <p> | |
| 220 Pulic slot to handle the switch to the shell in raw input mode. | |
| 221 </p><a NAME="DebugViewer.handleResetUI" ID="DebugViewer.handleResetUI"></a> | |
| 222 <h4>DebugViewer.handleResetUI</h4> | |
| 223 <b>handleResetUI</b>(<i></i>) | |
| 224 <p> | |
| 225 Public method to reset the SBVviewer. | |
| 226 </p><a NAME="DebugViewer.restoreCurrentPage" ID="DebugViewer.restoreCurrentPage"></a> | |
| 227 <h4>DebugViewer.restoreCurrentPage</h4> | |
| 228 <b>restoreCurrentPage</b>(<i></i>) | |
| 229 <p> | |
| 230 Public slot to restore the previously saved page. | |
| 231 </p><a NAME="DebugViewer.saveCurrentPage" ID="DebugViewer.saveCurrentPage"></a> | |
| 232 <h4>DebugViewer.saveCurrentPage</h4> | |
| 233 <b>saveCurrentPage</b>(<i></i>) | |
| 234 <p> | |
| 235 Public slot to save the current page. | |
| 236 </p><a NAME="DebugViewer.setDebugger" ID="DebugViewer.setDebugger"></a> | |
| 237 <h4>DebugViewer.setDebugger</h4> | |
| 238 <b>setDebugger</b>(<i>debugUI</i>) | |
| 239 <p> | |
| 240 Public method to set a reference to the Debug UI. | |
| 241 </p><dl> | |
| 242 <dt><i>debugUI</i></dt> | |
| 243 <dd> | |
| 244 reference to the DebugUI objectTrees | |
| 245 </dd> | |
| 246 </dl><a NAME="DebugViewer.setVariablesFilter" ID="DebugViewer.setVariablesFilter"></a> | |
| 247 <h4>DebugViewer.setVariablesFilter</h4> | |
| 248 <b>setVariablesFilter</b>(<i>globalsFilter, localsFilter</i>) | |
| 249 <p> | |
| 250 Public slot to set the local variables filter. | |
| 251 </p><dl> | |
| 252 <dt><i>globalsFilter</i></dt> | |
| 253 <dd> | |
| 254 filter list for global variable types (list of int) | |
| 255 </dd><dt><i>localsFilter</i></dt> | |
| 256 <dd> | |
| 257 filter list for local variable types (list of int) | |
| 258 </dd> | |
| 259 </dl><a NAME="DebugViewer.showThreadList" ID="DebugViewer.showThreadList"></a> | |
| 260 <h4>DebugViewer.showThreadList</h4> | |
| 261 <b>showThreadList</b>(<i>currentID, threadList</i>) | |
| 262 <p> | |
| 263 Public method to show the thread list. | |
| 264 </p><dl> | |
| 265 <dt><i>currentID</i></dt> | |
| 266 <dd> | |
| 267 id of the current thread (integer) | |
| 268 </dd><dt><i>threadList</i></dt> | |
| 269 <dd> | |
| 270 list of dictionaries containing the thread data | |
| 271 </dd> | |
| 272 </dl><a NAME="DebugViewer.showVariable" ID="DebugViewer.showVariable"></a> | |
| 273 <h4>DebugViewer.showVariable</h4> | |
| 274 <b>showVariable</b>(<i>vlist, globals</i>) | |
| 275 <p> | |
| 276 Public method to show the variables in the respective window. | |
| 277 </p><dl> | |
| 278 <dt><i>vlist</i></dt> | |
| 279 <dd> | |
| 280 list of variables to display | |
| 281 </dd><dt><i>globals</i></dt> | |
| 282 <dd> | |
| 283 flag indicating global/local state | |
| 284 </dd> | |
| 285 </dl><a NAME="DebugViewer.showVariables" ID="DebugViewer.showVariables"></a> | |
| 286 <h4>DebugViewer.showVariables</h4> | |
| 287 <b>showVariables</b>(<i>vlist, globals</i>) | |
| 288 <p> | |
| 289 Public method to show the variables in the respective window. | |
| 290 </p><dl> | |
| 291 <dt><i>vlist</i></dt> | |
| 292 <dd> | |
| 293 list of variables to display | |
| 294 </dd><dt><i>globals</i></dt> | |
| 295 <dd> | |
| 296 flag indicating global/local state | |
| 297 </dd> | |
| 298 </dl><a NAME="DebugViewer.showVariablesTab" ID="DebugViewer.showVariablesTab"></a> | |
| 299 <h4>DebugViewer.showVariablesTab</h4> | |
| 300 <b>showVariablesTab</b>(<i>globals</i>) | |
| 301 <p> | |
| 302 Public method to make a variables tab visible. | |
| 303 </p><dl> | |
| 304 <dt><i>globals</i></dt> | |
| 305 <dd> | |
| 306 flag indicating global/local state | |
| 307 </dd> | |
| 308 </dl> | |
| 309 <div align="right"><a href="#top">Up</a></div> | |
| 310 <hr /> | |
| 311 </body></html> |
