Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Debugger.DebugViewer.html

eric6/Documentation/Source/eric6.Debugger.DebugViewer.html

changeset 6942
2602857055c5
parent 6416
a915f8dd1ca6
child 6987
3371a03ed0a7
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Debugger.DebugViewer</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Debugger.DebugViewer</h1>
23 <p>
24 Module implementing a widget containing various debug related views.
25 </p><p>
26 The views avaliable are:
27 <ul>
28 <li>variables viewer for global variables</li>
29 <li>variables viewer for local variables</li>
30 <li>call trace viewer</li>
31 <li>viewer for breakpoints</li>
32 <li>viewer for watch expressions</li>
33 <li>viewer for exceptions</li>
34 <li>viewer for threads</li>
35 <li>a file browser (optional)</li>
36 <li>an interpreter shell (optional)</li>
37 </ul>
38 </p>
39 <h3>Global Attributes</h3>
40 <table>
41 <tr><td>None</td></tr>
42 </table>
43 <h3>Classes</h3>
44 <table>
45 <tr>
46 <td><a href="#DebugViewer">DebugViewer</a></td>
47 <td>Class implementing a widget containing various debug related views.</td>
48 </tr>
49 </table>
50 <h3>Functions</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <hr /><hr />
55 <a NAME="DebugViewer" ID="DebugViewer"></a>
56 <h2>DebugViewer</h2>
57 <p>
58 Class implementing a widget containing various debug related views.
59 </p><p>
60 The individual tabs contain the interpreter shell (optional),
61 the filesystem browser (optional), the two variables viewers
62 (global and local), a breakpoint viewer, a watch expression viewer and
63 the exception logger. Additionally a list of all threads is shown.
64 </p><h3>Signals</h3>
65 <dl>
66 <dt>sourceFile(string, int)</dt>
67 <dd>
68 emitted to open a source file at a line
69 </dd>
70 </dl>
71 <h3>Derived from</h3>
72 QWidget
73 <h3>Class Attributes</h3>
74 <table>
75 <tr><td>None</td></tr>
76 </table>
77 <h3>Class Methods</h3>
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81 <h3>Methods</h3>
82 <table>
83 <tr>
84 <td><a href="#DebugViewer.__init__">DebugViewer</a></td>
85 <td>Constructor</td>
86 </tr><tr>
87 <td><a href="#DebugViewer.__callStackFrameSelected">__callStackFrameSelected</a></td>
88 <td>Private slot to handle the selection of a call stack entry of the call stack viewer.</td>
89 </tr><tr>
90 <td><a href="#DebugViewer.__frameSelected">__frameSelected</a></td>
91 <td>Private slot to handle the selection of a new stack frame number.</td>
92 </tr><tr>
93 <td><a href="#DebugViewer.__showSource">__showSource</a></td>
94 <td>Private slot to handle the source button press to show the selected file.</td>
95 </tr><tr>
96 <td><a href="#DebugViewer.__threadSelected">__threadSelected</a></td>
97 <td>Private slot to handle the selection of a thread in the thread list.</td>
98 </tr><tr>
99 <td><a href="#DebugViewer.clearCallTrace">clearCallTrace</a></td>
100 <td>Public method to clear the recorded call trace.</td>
101 </tr><tr>
102 <td><a href="#DebugViewer.currentWidget">currentWidget</a></td>
103 <td>Public method to get a reference to the current widget.</td>
104 </tr><tr>
105 <td><a href="#DebugViewer.handleClientStack">handleClientStack</a></td>
106 <td>Public slot to show the call stack of the program being debugged.</td>
107 </tr><tr>
108 <td><a href="#DebugViewer.handleDebuggingStarted">handleDebuggingStarted</a></td>
109 <td>Public slot to handle the start of a debugging session.</td>
110 </tr><tr>
111 <td><a href="#DebugViewer.handleResetUI">handleResetUI</a></td>
112 <td>Public method to reset the SBVviewer.</td>
113 </tr><tr>
114 <td><a href="#DebugViewer.initCallStackViewer">initCallStackViewer</a></td>
115 <td>Public method to initialize the call stack viewer.</td>
116 </tr><tr>
117 <td><a href="#DebugViewer.isCallTraceEnabled">isCallTraceEnabled</a></td>
118 <td>Public method to get the state of the call trace function.</td>
119 </tr><tr>
120 <td><a href="#DebugViewer.preferencesChanged">preferencesChanged</a></td>
121 <td>Public slot to handle the preferencesChanged signal.</td>
122 </tr><tr>
123 <td><a href="#DebugViewer.setCallTraceToProjectMode">setCallTraceToProjectMode</a></td>
124 <td>Public slot to set the call trace viewer to project mode.</td>
125 </tr><tr>
126 <td><a href="#DebugViewer.setCurrentWidget">setCurrentWidget</a></td>
127 <td>Public slot to set the current page based on the given widget.</td>
128 </tr><tr>
129 <td><a href="#DebugViewer.setDebugger">setDebugger</a></td>
130 <td>Public method to set a reference to the Debug UI.</td>
131 </tr><tr>
132 <td><a href="#DebugViewer.setGlobalsFilter">setGlobalsFilter</a></td>
133 <td>Public slot to set the global variable filter.</td>
134 </tr><tr>
135 <td><a href="#DebugViewer.setLocalsFilter">setLocalsFilter</a></td>
136 <td>Public slot to set the local variable filter.</td>
137 </tr><tr>
138 <td><a href="#DebugViewer.setVariablesFilter">setVariablesFilter</a></td>
139 <td>Public slot to set the local variables filter.</td>
140 </tr><tr>
141 <td><a href="#DebugViewer.showThreadList">showThreadList</a></td>
142 <td>Public method to show the thread list.</td>
143 </tr><tr>
144 <td><a href="#DebugViewer.showVariable">showVariable</a></td>
145 <td>Public method to show the variables in the respective window.</td>
146 </tr><tr>
147 <td><a href="#DebugViewer.showVariables">showVariables</a></td>
148 <td>Public method to show the variables in the respective window.</td>
149 </tr><tr>
150 <td><a href="#DebugViewer.showVariablesTab">showVariablesTab</a></td>
151 <td>Public method to make a variables tab visible.</td>
152 </tr>
153 </table>
154 <h3>Static Methods</h3>
155 <table>
156 <tr><td>None</td></tr>
157 </table>
158 <a NAME="DebugViewer.__init__" ID="DebugViewer.__init__"></a>
159 <h4>DebugViewer (Constructor)</h4>
160 <b>DebugViewer</b>(<i>debugServer, docked, vm, parent=None</i>)
161 <p>
162 Constructor
163 </p><dl>
164 <dt><i>debugServer</i></dt>
165 <dd>
166 reference to the debug server object (DebugServer)
167 </dd><dt><i>docked</i></dt>
168 <dd>
169 flag indicating a dock window
170 </dd><dt><i>vm</i></dt>
171 <dd>
172 reference to the viewmanager object
173 </dd><dt><i>parent</i></dt>
174 <dd>
175 parent widget (QWidget)
176 </dd>
177 </dl><a NAME="DebugViewer.__callStackFrameSelected" ID="DebugViewer.__callStackFrameSelected"></a>
178 <h4>DebugViewer.__callStackFrameSelected</h4>
179 <b>__callStackFrameSelected</b>(<i>frameNo</i>)
180 <p>
181 Private slot to handle the selection of a call stack entry of the
182 call stack viewer.
183 </p><dl>
184 <dt><i>frameNo</i></dt>
185 <dd>
186 frame number (index) of the selected entry (integer)
187 </dd>
188 </dl><a NAME="DebugViewer.__frameSelected" ID="DebugViewer.__frameSelected"></a>
189 <h4>DebugViewer.__frameSelected</h4>
190 <b>__frameSelected</b>(<i>frmnr</i>)
191 <p>
192 Private slot to handle the selection of a new stack frame number.
193 </p><dl>
194 <dt><i>frmnr</i></dt>
195 <dd>
196 frame number (0 is the current frame) (int)
197 </dd>
198 </dl><a NAME="DebugViewer.__showSource" ID="DebugViewer.__showSource"></a>
199 <h4>DebugViewer.__showSource</h4>
200 <b>__showSource</b>(<i></i>)
201 <p>
202 Private slot to handle the source button press to show the selected
203 file.
204 </p><a NAME="DebugViewer.__threadSelected" ID="DebugViewer.__threadSelected"></a>
205 <h4>DebugViewer.__threadSelected</h4>
206 <b>__threadSelected</b>(<i>current, previous</i>)
207 <p>
208 Private slot to handle the selection of a thread in the thread list.
209 </p><dl>
210 <dt><i>current</i></dt>
211 <dd>
212 reference to the new current item (QTreeWidgetItem)
213 </dd><dt><i>previous</i></dt>
214 <dd>
215 reference to the previous current item
216 (QTreeWidgetItem)
217 </dd>
218 </dl><a NAME="DebugViewer.clearCallTrace" ID="DebugViewer.clearCallTrace"></a>
219 <h4>DebugViewer.clearCallTrace</h4>
220 <b>clearCallTrace</b>(<i></i>)
221 <p>
222 Public method to clear the recorded call trace.
223 </p><a NAME="DebugViewer.currentWidget" ID="DebugViewer.currentWidget"></a>
224 <h4>DebugViewer.currentWidget</h4>
225 <b>currentWidget</b>(<i></i>)
226 <p>
227 Public method to get a reference to the current widget.
228 </p><dl>
229 <dt>Returns:</dt>
230 <dd>
231 reference to the current widget (QWidget)
232 </dd>
233 </dl><a NAME="DebugViewer.handleClientStack" ID="DebugViewer.handleClientStack"></a>
234 <h4>DebugViewer.handleClientStack</h4>
235 <b>handleClientStack</b>(<i>stack</i>)
236 <p>
237 Public slot to show the call stack of the program being debugged.
238 </p><dl>
239 <dt><i>stack</i></dt>
240 <dd>
241 list of tuples with call stack data (file name,
242 line number, function name, formatted argument/values list)
243 </dd>
244 </dl><a NAME="DebugViewer.handleDebuggingStarted" ID="DebugViewer.handleDebuggingStarted"></a>
245 <h4>DebugViewer.handleDebuggingStarted</h4>
246 <b>handleDebuggingStarted</b>(<i></i>)
247 <p>
248 Public slot to handle the start of a debugging session.
249 </p><p>
250 This slot sets the variables filter expressions.
251 </p><a NAME="DebugViewer.handleResetUI" ID="DebugViewer.handleResetUI"></a>
252 <h4>DebugViewer.handleResetUI</h4>
253 <b>handleResetUI</b>(<i></i>)
254 <p>
255 Public method to reset the SBVviewer.
256 </p><a NAME="DebugViewer.initCallStackViewer" ID="DebugViewer.initCallStackViewer"></a>
257 <h4>DebugViewer.initCallStackViewer</h4>
258 <b>initCallStackViewer</b>(<i>projectMode</i>)
259 <p>
260 Public method to initialize the call stack viewer.
261 </p><dl>
262 <dt><i>projectMode</i></dt>
263 <dd>
264 flag indicating to enable the project mode (boolean)
265 </dd>
266 </dl><a NAME="DebugViewer.isCallTraceEnabled" ID="DebugViewer.isCallTraceEnabled"></a>
267 <h4>DebugViewer.isCallTraceEnabled</h4>
268 <b>isCallTraceEnabled</b>(<i></i>)
269 <p>
270 Public method to get the state of the call trace function.
271 </p><dl>
272 <dt>Returns:</dt>
273 <dd>
274 flag indicating the state of the call trace function (boolean)
275 </dd>
276 </dl><a NAME="DebugViewer.preferencesChanged" ID="DebugViewer.preferencesChanged"></a>
277 <h4>DebugViewer.preferencesChanged</h4>
278 <b>preferencesChanged</b>(<i></i>)
279 <p>
280 Public slot to handle the preferencesChanged signal.
281 </p><a NAME="DebugViewer.setCallTraceToProjectMode" ID="DebugViewer.setCallTraceToProjectMode"></a>
282 <h4>DebugViewer.setCallTraceToProjectMode</h4>
283 <b>setCallTraceToProjectMode</b>(<i>enabled</i>)
284 <p>
285 Public slot to set the call trace viewer to project mode.
286 </p><p>
287 In project mode the call trace info is shown with project relative
288 path names.
289 </p><dl>
290 <dt><i>enabled</i></dt>
291 <dd>
292 flag indicating to enable the project mode (boolean)
293 </dd>
294 </dl><a NAME="DebugViewer.setCurrentWidget" ID="DebugViewer.setCurrentWidget"></a>
295 <h4>DebugViewer.setCurrentWidget</h4>
296 <b>setCurrentWidget</b>(<i>widget</i>)
297 <p>
298 Public slot to set the current page based on the given widget.
299 </p><dl>
300 <dt><i>widget</i></dt>
301 <dd>
302 reference to the widget (QWidget)
303 </dd>
304 </dl><a NAME="DebugViewer.setDebugger" ID="DebugViewer.setDebugger"></a>
305 <h4>DebugViewer.setDebugger</h4>
306 <b>setDebugger</b>(<i>debugUI</i>)
307 <p>
308 Public method to set a reference to the Debug UI.
309 </p><dl>
310 <dt><i>debugUI</i></dt>
311 <dd>
312 reference to the DebugUI object (DebugUI)
313 </dd>
314 </dl><a NAME="DebugViewer.setGlobalsFilter" ID="DebugViewer.setGlobalsFilter"></a>
315 <h4>DebugViewer.setGlobalsFilter</h4>
316 <b>setGlobalsFilter</b>(<i></i>)
317 <p>
318 Public slot to set the global variable filter.
319 </p><a NAME="DebugViewer.setLocalsFilter" ID="DebugViewer.setLocalsFilter"></a>
320 <h4>DebugViewer.setLocalsFilter</h4>
321 <b>setLocalsFilter</b>(<i></i>)
322 <p>
323 Public slot to set the local variable filter.
324 </p><a NAME="DebugViewer.setVariablesFilter" ID="DebugViewer.setVariablesFilter"></a>
325 <h4>DebugViewer.setVariablesFilter</h4>
326 <b>setVariablesFilter</b>(<i>globalsFilter, localsFilter</i>)
327 <p>
328 Public slot to set the local variables filter.
329 </p><dl>
330 <dt><i>globalsFilter</i></dt>
331 <dd>
332 filter list for global variable types
333 (list of int)
334 </dd><dt><i>localsFilter</i></dt>
335 <dd>
336 filter list for local variable types (list of int)
337 </dd>
338 </dl><a NAME="DebugViewer.showThreadList" ID="DebugViewer.showThreadList"></a>
339 <h4>DebugViewer.showThreadList</h4>
340 <b>showThreadList</b>(<i>currentID, threadList</i>)
341 <p>
342 Public method to show the thread list.
343 </p><dl>
344 <dt><i>currentID</i></dt>
345 <dd>
346 id of the current thread (integer)
347 </dd><dt><i>threadList</i></dt>
348 <dd>
349 list of dictionaries containing the thread data
350 </dd>
351 </dl><a NAME="DebugViewer.showVariable" ID="DebugViewer.showVariable"></a>
352 <h4>DebugViewer.showVariable</h4>
353 <b>showVariable</b>(<i>vlist, showGlobals</i>)
354 <p>
355 Public method to show the variables in the respective window.
356 </p><dl>
357 <dt><i>vlist</i></dt>
358 <dd>
359 list of variables to display
360 </dd><dt><i>showGlobals</i></dt>
361 <dd>
362 flag indicating global/local state
363 </dd>
364 </dl><a NAME="DebugViewer.showVariables" ID="DebugViewer.showVariables"></a>
365 <h4>DebugViewer.showVariables</h4>
366 <b>showVariables</b>(<i>vlist, showGlobals</i>)
367 <p>
368 Public method to show the variables in the respective window.
369 </p><dl>
370 <dt><i>vlist</i></dt>
371 <dd>
372 list of variables to display
373 </dd><dt><i>showGlobals</i></dt>
374 <dd>
375 flag indicating global/local state
376 </dd>
377 </dl><a NAME="DebugViewer.showVariablesTab" ID="DebugViewer.showVariablesTab"></a>
378 <h4>DebugViewer.showVariablesTab</h4>
379 <b>showVariablesTab</b>(<i>showGlobals</i>)
380 <p>
381 Public method to make a variables tab visible.
382 </p><dl>
383 <dt><i>showGlobals</i></dt>
384 <dd>
385 flag indicating global/local state
386 </dd>
387 </dl>
388 <div align="right"><a href="#top">Up</a></div>
389 <hr />
390 </body></html>

Mercurial Repository: eric

eric ide

mercurial