Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric4.Debugger.DebugViewer.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
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>eric4.Debugger.DebugViewer</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Debugger.DebugViewer</h1>
24 <p>
25 Module implementing a widget containing various debug related views.
26 </p><p>
27 The views avaliable are:
28 <ul>
29 <li>variables viewer for global variables</li>
30 <li>variables viewer for local variables</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 conatining 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 conatining 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 (global and local),
62 a breakpoint viewer, a watch expression viewer and the exception logger. Additionally
63 a list of all threads is shown.
64 </p><h4>Signals</h4>
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>Methods</h3>
78 <table>
79 <tr>
80 <td><a href="#DebugViewer.__init__">DebugViewer</a></td>
81 <td>Constructor</td>
82 </tr><tr>
83 <td><a href="#DebugViewer.__frameSelected">__frameSelected</a></td>
84 <td>Private slot to handle the selection of a new stack frame number.</td>
85 </tr><tr>
86 <td><a href="#DebugViewer.__setGlobalsFilter">__setGlobalsFilter</a></td>
87 <td>Private slot to set the global variable filter</td>
88 </tr><tr>
89 <td><a href="#DebugViewer.__setLocalsFilter">__setLocalsFilter</a></td>
90 <td>Private slot to set the local variable filter</td>
91 </tr><tr>
92 <td><a href="#DebugViewer.__showSource">__showSource</a></td>
93 <td>Private slot to handle the source button press to show the selected file.</td>
94 </tr><tr>
95 <td><a href="#DebugViewer.__threadSelected">__threadSelected</a></td>
96 <td>Private slot to handle the selection of a thread in the thread list.</td>
97 </tr><tr>
98 <td><a href="#DebugViewer.currentWidget">currentWidget</a></td>
99 <td>Public method to get a reference to the current widget.</td>
100 </tr><tr>
101 <td><a href="#DebugViewer.handleClientStack">handleClientStack</a></td>
102 <td>Public slot to show the call stack of the program being debugged.</td>
103 </tr><tr>
104 <td><a href="#DebugViewer.handleDebuggingStarted">handleDebuggingStarted</a></td>
105 <td>Public slot to handle the start of a debugging session.</td>
106 </tr><tr>
107 <td><a href="#DebugViewer.handleRawInput">handleRawInput</a></td>
108 <td>Pulic slot to handle the switch to the shell in raw input mode.</td>
109 </tr><tr>
110 <td><a href="#DebugViewer.handleResetUI">handleResetUI</a></td>
111 <td>Public method to reset the SBVviewer.</td>
112 </tr><tr>
113 <td><a href="#DebugViewer.restoreCurrentPage">restoreCurrentPage</a></td>
114 <td>Public slot to restore the previously saved page.</td>
115 </tr><tr>
116 <td><a href="#DebugViewer.saveCurrentPage">saveCurrentPage</a></td>
117 <td>Public slot to save the current page.</td>
118 </tr><tr>
119 <td><a href="#DebugViewer.setDebugger">setDebugger</a></td>
120 <td>Public method to set a reference to the Debug UI.</td>
121 </tr><tr>
122 <td><a href="#DebugViewer.setVariablesFilter">setVariablesFilter</a></td>
123 <td>Public slot to set the local variables filter.</td>
124 </tr><tr>
125 <td><a href="#DebugViewer.showThreadList">showThreadList</a></td>
126 <td>Public method to show the thread list.</td>
127 </tr><tr>
128 <td><a href="#DebugViewer.showVariable">showVariable</a></td>
129 <td>Public method to show the variables in the respective window.</td>
130 </tr><tr>
131 <td><a href="#DebugViewer.showVariables">showVariables</a></td>
132 <td>Public method to show the variables in the respective window.</td>
133 </tr><tr>
134 <td><a href="#DebugViewer.showVariablesTab">showVariablesTab</a></td>
135 <td>Public method to make a variables tab visible.</td>
136 </tr>
137 </table>
138 <a NAME="DebugViewer.__init__" ID="DebugViewer.__init__"></a>
139 <h4>DebugViewer (Constructor)</h4>
140 <b>DebugViewer</b>(<i>debugServer, docked, vm, parent = None, embeddedShell = True, embeddedBrowser = True</i>)
141 <p>
142 Constructor
143 </p><dl>
144 <dt><i>debugServer</i></dt>
145 <dd>
146 reference to the debug server object
147 </dd><dt><i>docked</i></dt>
148 <dd>
149 flag indicating a dock window
150 </dd><dt><i>vm</i></dt>
151 <dd>
152 reference to the viewmanager object
153 </dd><dt><i>parent</i></dt>
154 <dd>
155 parent widget (QWidget)
156 </dd><dt><i>embeddedShell</i></dt>
157 <dd>
158 flag indicating whether the shell should be included.
159 This flag is set to False by those layouts, that have the interpreter
160 shell in a separate window.
161 </dd><dt><i>embeddedBrowser</i></dt>
162 <dd>
163 flag indicating whether the file browser should
164 be included. This flag is set to False by those layouts, that
165 have the file browser in a separate window or embedded
166 in the project browser instead.
167 </dd>
168 </dl><a NAME="DebugViewer.__frameSelected" ID="DebugViewer.__frameSelected"></a>
169 <h4>DebugViewer.__frameSelected</h4>
170 <b>__frameSelected</b>(<i>frmnr</i>)
171 <p>
172 Private slot to handle the selection of a new stack frame number.
173 </p><dl>
174 <dt><i>frmnr</i></dt>
175 <dd>
176 frame number (0 is the current frame) (int)
177 </dd>
178 </dl><a NAME="DebugViewer.__setGlobalsFilter" ID="DebugViewer.__setGlobalsFilter"></a>
179 <h4>DebugViewer.__setGlobalsFilter</h4>
180 <b>__setGlobalsFilter</b>(<i></i>)
181 <p>
182 Private slot to set the global variable filter
183 </p><a NAME="DebugViewer.__setLocalsFilter" ID="DebugViewer.__setLocalsFilter"></a>
184 <h4>DebugViewer.__setLocalsFilter</h4>
185 <b>__setLocalsFilter</b>(<i></i>)
186 <p>
187 Private slot to set the local variable filter
188 </p><a NAME="DebugViewer.__showSource" ID="DebugViewer.__showSource"></a>
189 <h4>DebugViewer.__showSource</h4>
190 <b>__showSource</b>(<i></i>)
191 <p>
192 Private slot to handle the source button press to show the selected file.
193 </p><a NAME="DebugViewer.__threadSelected" ID="DebugViewer.__threadSelected"></a>
194 <h4>DebugViewer.__threadSelected</h4>
195 <b>__threadSelected</b>(<i>current, previous</i>)
196 <p>
197 Private slot to handle the selection of a thread in the thread list.
198 </p><dl>
199 <dt><i>current</i></dt>
200 <dd>
201 reference to the new current item (QTreeWidgetItem)
202 </dd><dt><i>previous</i></dt>
203 <dd>
204 reference to the previous current item (QTreeWidgetItem)
205 </dd>
206 </dl><a NAME="DebugViewer.currentWidget" ID="DebugViewer.currentWidget"></a>
207 <h4>DebugViewer.currentWidget</h4>
208 <b>currentWidget</b>(<i></i>)
209 <p>
210 Public method to get a reference to the current widget.
211 </p><dl>
212 <dt>Returns:</dt>
213 <dd>
214 reference to the current widget (QWidget)
215 </dd>
216 </dl><a NAME="DebugViewer.handleClientStack" ID="DebugViewer.handleClientStack"></a>
217 <h4>DebugViewer.handleClientStack</h4>
218 <b>handleClientStack</b>(<i>stack</i>)
219 <p>
220 Public slot to show the call stack of the program being debugged.
221 </p><a NAME="DebugViewer.handleDebuggingStarted" ID="DebugViewer.handleDebuggingStarted"></a>
222 <h4>DebugViewer.handleDebuggingStarted</h4>
223 <b>handleDebuggingStarted</b>(<i></i>)
224 <p>
225 Public slot to handle the start of a debugging session.
226 </p><p>
227 This slot sets the variables filter expressions.
228 </p><a NAME="DebugViewer.handleRawInput" ID="DebugViewer.handleRawInput"></a>
229 <h4>DebugViewer.handleRawInput</h4>
230 <b>handleRawInput</b>(<i></i>)
231 <p>
232 Pulic slot to handle the switch to the shell in raw input mode.
233 </p><a NAME="DebugViewer.handleResetUI" ID="DebugViewer.handleResetUI"></a>
234 <h4>DebugViewer.handleResetUI</h4>
235 <b>handleResetUI</b>(<i></i>)
236 <p>
237 Public method to reset the SBVviewer.
238 </p><a NAME="DebugViewer.restoreCurrentPage" ID="DebugViewer.restoreCurrentPage"></a>
239 <h4>DebugViewer.restoreCurrentPage</h4>
240 <b>restoreCurrentPage</b>(<i></i>)
241 <p>
242 Public slot to restore the previously saved page.
243 </p><a NAME="DebugViewer.saveCurrentPage" ID="DebugViewer.saveCurrentPage"></a>
244 <h4>DebugViewer.saveCurrentPage</h4>
245 <b>saveCurrentPage</b>(<i></i>)
246 <p>
247 Public slot to save the current page.
248 </p><a NAME="DebugViewer.setDebugger" ID="DebugViewer.setDebugger"></a>
249 <h4>DebugViewer.setDebugger</h4>
250 <b>setDebugger</b>(<i>debugUI</i>)
251 <p>
252 Public method to set a reference to the Debug UI.
253 </p><dl>
254 <dt><i>debugUI</i></dt>
255 <dd>
256 reference to the DebugUI objectTrees
257 </dd>
258 </dl><a NAME="DebugViewer.setVariablesFilter" ID="DebugViewer.setVariablesFilter"></a>
259 <h4>DebugViewer.setVariablesFilter</h4>
260 <b>setVariablesFilter</b>(<i>globalsFilter, localsFilter</i>)
261 <p>
262 Public slot to set the local variables filter.
263 </p><dl>
264 <dt><i>globalsFilter</i></dt>
265 <dd>
266 filter list for global variable types (list of int)
267 </dd><dt><i>localsFilter</i></dt>
268 <dd>
269 filter list for local variable types (list of int)
270 </dd>
271 </dl><a NAME="DebugViewer.showThreadList" ID="DebugViewer.showThreadList"></a>
272 <h4>DebugViewer.showThreadList</h4>
273 <b>showThreadList</b>(<i>currentID, threadList</i>)
274 <p>
275 Public method to show the thread list.
276 </p><dl>
277 <dt><i>currentID</i></dt>
278 <dd>
279 id of the current thread (integer)
280 </dd><dt><i>threadList</i></dt>
281 <dd>
282 list of dictionaries containing the thread data
283 </dd>
284 </dl><a NAME="DebugViewer.showVariable" ID="DebugViewer.showVariable"></a>
285 <h4>DebugViewer.showVariable</h4>
286 <b>showVariable</b>(<i>vlist, globals</i>)
287 <p>
288 Public method to show the variables in the respective window.
289 </p><dl>
290 <dt><i>vlist</i></dt>
291 <dd>
292 list of variables to display
293 </dd><dt><i>globals</i></dt>
294 <dd>
295 flag indicating global/local state
296 </dd>
297 </dl><a NAME="DebugViewer.showVariables" ID="DebugViewer.showVariables"></a>
298 <h4>DebugViewer.showVariables</h4>
299 <b>showVariables</b>(<i>vlist, globals</i>)
300 <p>
301 Public method to show the variables in the respective window.
302 </p><dl>
303 <dt><i>vlist</i></dt>
304 <dd>
305 list of variables to display
306 </dd><dt><i>globals</i></dt>
307 <dd>
308 flag indicating global/local state
309 </dd>
310 </dl><a NAME="DebugViewer.showVariablesTab" ID="DebugViewer.showVariablesTab"></a>
311 <h4>DebugViewer.showVariablesTab</h4>
312 <b>showVariablesTab</b>(<i>globals</i>)
313 <p>
314 Public method to make a variables tab visible.
315 </p><dl>
316 <dt><i>globals</i></dt>
317 <dd>
318 flag indicating global/local state
319 </dd>
320 </dl>
321 <div align="right"><a href="#top">Up</a></div>
322 <hr />
323 </body></html>

Mercurial Repository: eric

eric ide

mercurial