Documentation/Source/eric5.Debugger.CallTraceViewer.html

changeset 2173
c21d1e99015a
child 2367
78f6c8193d37
equal deleted inserted replaced
2172:6d8eb5736925 2173:c21d1e99015a
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.CallTraceViewer</title>
6 <style>
7 body {
8 background: #EDECE6;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #85774A; }
14 h2 { color: white; background: #85774A; }
15 h3 { color: white; background: #9D936E; }
16 h4 { color: white; background: #9D936E; }
17
18 a { color: #BA6D36; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric5.Debugger.CallTraceViewer</h1>
24 <p>
25 Module implementing the Call Trace viewer widget.
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="#CallTraceViewer">CallTraceViewer</a></td>
35 <td>Class implementing the Call Trace viewer widget.</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="CallTraceViewer" ID="CallTraceViewer"></a>
44 <h2>CallTraceViewer</h2>
45 <p>
46 Class implementing the Call Trace viewer widget.
47 </p><h3>Signals</h3>
48 <dl>
49 <dt>sourceFile(str, int)</dt>
50 <dd>
51 emitted to show the source of a call/return point
52 </dd>
53 </dl>
54 <h3>Derived from</h3>
55 QWidget, Ui_CallTraceViewer
56 <h3>Class Attributes</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Class Methods</h3>
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Methods</h3>
65 <table>
66 <tr>
67 <td><a href="#CallTraceViewer.__init__">CallTraceViewer</a></td>
68 <td>Constructor</td>
69 </tr><tr>
70 <td><a href="#CallTraceViewer.__addCallTraceInfo">__addCallTraceInfo</a></td>
71 <td>Private method to add an entry to the call trace viewer.</td>
72 </tr><tr>
73 <td><a href="#CallTraceViewer.__setCallTraceEnabled">__setCallTraceEnabled</a></td>
74 <td>Private slot to set the call trace enabled status.</td>
75 </tr><tr>
76 <td><a href="#CallTraceViewer.clear">clear</a></td>
77 <td>Public slot to clear the call trace info.</td>
78 </tr><tr>
79 <td><a href="#CallTraceViewer.isCallTraceEnabled">isCallTraceEnabled</a></td>
80 <td>Public method to get the state of the call trace function.</td>
81 </tr><tr>
82 <td><a href="#CallTraceViewer.on_callTrace_itemDoubleClicked">on_callTrace_itemDoubleClicked</a></td>
83 <td>Private slot to open the double clicked file in an editor.</td>
84 </tr><tr>
85 <td><a href="#CallTraceViewer.on_clearButton_clicked">on_clearButton_clicked</a></td>
86 <td>Private slot to clear the call trace.</td>
87 </tr><tr>
88 <td><a href="#CallTraceViewer.on_resizeButton_clicked">on_resizeButton_clicked</a></td>
89 <td>Private slot to resize the columns of the call trace to their contents.</td>
90 </tr><tr>
91 <td><a href="#CallTraceViewer.on_saveButton_clicked">on_saveButton_clicked</a></td>
92 <td>Private slot to save the call trace info to a file.</td>
93 </tr><tr>
94 <td><a href="#CallTraceViewer.on_startTraceButton_clicked">on_startTraceButton_clicked</a></td>
95 <td>Private slot to start call tracing.</td>
96 </tr><tr>
97 <td><a href="#CallTraceViewer.on_stopTraceButton_clicked">on_stopTraceButton_clicked</a></td>
98 <td>Private slot to start call tracing.</td>
99 </tr><tr>
100 <td><a href="#CallTraceViewer.setProjectMode">setProjectMode</a></td>
101 <td>Public slot to set the call trace viewer to project mode.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105 <table>
106 <tr><td>None</td></tr>
107 </table>
108 <a NAME="CallTraceViewer.__init__" ID="CallTraceViewer.__init__"></a>
109 <h4>CallTraceViewer (Constructor)</h4>
110 <b>CallTraceViewer</b>(<i>debugServer, parent=None</i>)
111 <p>
112 Constructor
113 </p><dl>
114 <dt><i>parent</i></dt>
115 <dd>
116 reference to the parent widget (QWidget)
117 </dd>
118 </dl><a NAME="CallTraceViewer.__addCallTraceInfo" ID="CallTraceViewer.__addCallTraceInfo"></a>
119 <h4>CallTraceViewer.__addCallTraceInfo</h4>
120 <b>__addCallTraceInfo</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction</i>)
121 <p>
122 Private method to add an entry to the call trace viewer.
123 </p><dl>
124 <dt><i>isCall</i></dt>
125 <dd>
126 flag indicating a 'call' (boolean)
127 </dd><dt><i>fromFile</i></dt>
128 <dd>
129 name of the originating file (string)
130 </dd><dt><i>fromLine</i></dt>
131 <dd>
132 line number in the originating file (string)
133 </dd><dt><i>fromFunction</i></dt>
134 <dd>
135 name of the originating function (string)
136 </dd><dt><i>toFile</i></dt>
137 <dd>
138 name of the target file (string)
139 </dd><dt><i>toLine</i></dt>
140 <dd>
141 line number in the target file (string)
142 </dd><dt><i>toFunction</i></dt>
143 <dd>
144 name of the target function (string)
145 </dd>
146 </dl><a NAME="CallTraceViewer.__setCallTraceEnabled" ID="CallTraceViewer.__setCallTraceEnabled"></a>
147 <h4>CallTraceViewer.__setCallTraceEnabled</h4>
148 <b>__setCallTraceEnabled</b>(<i>enabled</i>)
149 <p>
150 Private slot to set the call trace enabled status.
151 </p><dl>
152 <dt><i>enabled</i></dt>
153 <dd>
154 flag indicating the new state (boolean)
155 </dd>
156 </dl><a NAME="CallTraceViewer.clear" ID="CallTraceViewer.clear"></a>
157 <h4>CallTraceViewer.clear</h4>
158 <b>clear</b>(<i></i>)
159 <p>
160 Public slot to clear the call trace info.
161 </p><a NAME="CallTraceViewer.isCallTraceEnabled" ID="CallTraceViewer.isCallTraceEnabled"></a>
162 <h4>CallTraceViewer.isCallTraceEnabled</h4>
163 <b>isCallTraceEnabled</b>(<i></i>)
164 <p>
165 Public method to get the state of the call trace function.
166 </p><dl>
167 <dt>Returns:</dt>
168 <dd>
169 flag indicating the state of the call trace function (boolean)
170 </dd>
171 </dl><a NAME="CallTraceViewer.on_callTrace_itemDoubleClicked" ID="CallTraceViewer.on_callTrace_itemDoubleClicked"></a>
172 <h4>CallTraceViewer.on_callTrace_itemDoubleClicked</h4>
173 <b>on_callTrace_itemDoubleClicked</b>(<i>item, column</i>)
174 <p>
175 Private slot to open the double clicked file in an editor.
176 </p><dl>
177 <dt><i>item</i></dt>
178 <dd>
179 reference to the double clicked item (QTreeWidgetItem)
180 </dd><dt><i>column</i></dt>
181 <dd>
182 column that was double clicked (integer)
183 </dd>
184 </dl><a NAME="CallTraceViewer.on_clearButton_clicked" ID="CallTraceViewer.on_clearButton_clicked"></a>
185 <h4>CallTraceViewer.on_clearButton_clicked</h4>
186 <b>on_clearButton_clicked</b>(<i></i>)
187 <p>
188 Private slot to clear the call trace.
189 </p><a NAME="CallTraceViewer.on_resizeButton_clicked" ID="CallTraceViewer.on_resizeButton_clicked"></a>
190 <h4>CallTraceViewer.on_resizeButton_clicked</h4>
191 <b>on_resizeButton_clicked</b>(<i></i>)
192 <p>
193 Private slot to resize the columns of the call trace to their contents.
194 </p><a NAME="CallTraceViewer.on_saveButton_clicked" ID="CallTraceViewer.on_saveButton_clicked"></a>
195 <h4>CallTraceViewer.on_saveButton_clicked</h4>
196 <b>on_saveButton_clicked</b>(<i></i>)
197 <p>
198 Private slot to save the call trace info to a file.
199 </p><a NAME="CallTraceViewer.on_startTraceButton_clicked" ID="CallTraceViewer.on_startTraceButton_clicked"></a>
200 <h4>CallTraceViewer.on_startTraceButton_clicked</h4>
201 <b>on_startTraceButton_clicked</b>(<i></i>)
202 <p>
203 Private slot to start call tracing.
204 </p><a NAME="CallTraceViewer.on_stopTraceButton_clicked" ID="CallTraceViewer.on_stopTraceButton_clicked"></a>
205 <h4>CallTraceViewer.on_stopTraceButton_clicked</h4>
206 <b>on_stopTraceButton_clicked</b>(<i></i>)
207 <p>
208 Private slot to start call tracing.
209 </p><a NAME="CallTraceViewer.setProjectMode" ID="CallTraceViewer.setProjectMode"></a>
210 <h4>CallTraceViewer.setProjectMode</h4>
211 <b>setProjectMode</b>(<i>enabled</i>)
212 <p>
213 Public slot to set the call trace viewer to project mode.
214 </p><p>
215 In project mode the call trace info is shown with project relative
216 path names.
217 </p><dl>
218 <dt><i>enabled</i></dt>
219 <dd>
220 flag indicating to enable the project mode (boolean)
221 </dd>
222 </dl>
223 <div align="right"><a href="#top">Up</a></div>
224 <hr />
225 </body></html>

eric ide

mercurial