Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Debugger.CallTraceViewer.html

eric7/Documentation/Source/eric7.Debugger.CallTraceViewer.html

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

Mercurial Repository: eric

eric ide

mercurial