Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.Debugger.CallTraceViewer.html

changeset 3673
e26d7d0c1088
child 5150
72a053e1c440
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Debugger.CallTraceViewer</h1>
23 <p>
24 Module implementing the Call Trace viewer widget.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#CallTraceViewer">CallTraceViewer</a></td>
34 <td>Class implementing the Call Trace viewer widget.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="CallTraceViewer" ID="CallTraceViewer"></a>
43 <h2>CallTraceViewer</h2>
44 <p>
45 Class implementing the Call Trace viewer widget.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>sourceFile(str, int)</dt>
49 <dd>
50 emitted to show the source of a call/return
51 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>debugServer</i></dt>
115 <dd>
116 reference to the debug server object (DebugServer)
117 </dd><dt><i>parent</i></dt>
118 <dd>
119 reference to the parent widget (QWidget)
120 </dd>
121 </dl><a NAME="CallTraceViewer.__addCallTraceInfo" ID="CallTraceViewer.__addCallTraceInfo"></a>
122 <h4>CallTraceViewer.__addCallTraceInfo</h4>
123 <b>__addCallTraceInfo</b>(<i>isCall, fromFile, fromLine, fromFunction, toFile, toLine, toFunction</i>)
124 <p>
125 Private method to add an entry to the call trace viewer.
126 </p><dl>
127 <dt><i>isCall</i></dt>
128 <dd>
129 flag indicating a 'call' (boolean)
130 </dd><dt><i>fromFile</i></dt>
131 <dd>
132 name of the originating file (string)
133 </dd><dt><i>fromLine</i></dt>
134 <dd>
135 line number in the originating file (string)
136 </dd><dt><i>fromFunction</i></dt>
137 <dd>
138 name of the originating function (string)
139 </dd><dt><i>toFile</i></dt>
140 <dd>
141 name of the target file (string)
142 </dd><dt><i>toLine</i></dt>
143 <dd>
144 line number in the target file (string)
145 </dd><dt><i>toFunction</i></dt>
146 <dd>
147 name of the target function (string)
148 </dd>
149 </dl><a NAME="CallTraceViewer.__setCallTraceEnabled" ID="CallTraceViewer.__setCallTraceEnabled"></a>
150 <h4>CallTraceViewer.__setCallTraceEnabled</h4>
151 <b>__setCallTraceEnabled</b>(<i>enabled</i>)
152 <p>
153 Private slot to set the call trace enabled status.
154 </p><dl>
155 <dt><i>enabled</i></dt>
156 <dd>
157 flag indicating the new state (boolean)
158 </dd>
159 </dl><a NAME="CallTraceViewer.clear" ID="CallTraceViewer.clear"></a>
160 <h4>CallTraceViewer.clear</h4>
161 <b>clear</b>(<i></i>)
162 <p>
163 Public slot to clear the call trace info.
164 </p><a NAME="CallTraceViewer.isCallTraceEnabled" ID="CallTraceViewer.isCallTraceEnabled"></a>
165 <h4>CallTraceViewer.isCallTraceEnabled</h4>
166 <b>isCallTraceEnabled</b>(<i></i>)
167 <p>
168 Public method to get the state of the call trace function.
169 </p><dl>
170 <dt>Returns:</dt>
171 <dd>
172 flag indicating the state of the call trace function (boolean)
173 </dd>
174 </dl><a NAME="CallTraceViewer.on_callTrace_itemDoubleClicked" ID="CallTraceViewer.on_callTrace_itemDoubleClicked"></a>
175 <h4>CallTraceViewer.on_callTrace_itemDoubleClicked</h4>
176 <b>on_callTrace_itemDoubleClicked</b>(<i>item, column</i>)
177 <p>
178 Private slot to open the double clicked file in an editor.
179 </p><dl>
180 <dt><i>item</i></dt>
181 <dd>
182 reference to the double clicked item (QTreeWidgetItem)
183 </dd><dt><i>column</i></dt>
184 <dd>
185 column that was double clicked (integer)
186 </dd>
187 </dl><a NAME="CallTraceViewer.on_clearButton_clicked" ID="CallTraceViewer.on_clearButton_clicked"></a>
188 <h4>CallTraceViewer.on_clearButton_clicked</h4>
189 <b>on_clearButton_clicked</b>(<i></i>)
190 <p>
191 Private slot to clear the call trace.
192 </p><a NAME="CallTraceViewer.on_resizeButton_clicked" ID="CallTraceViewer.on_resizeButton_clicked"></a>
193 <h4>CallTraceViewer.on_resizeButton_clicked</h4>
194 <b>on_resizeButton_clicked</b>(<i></i>)
195 <p>
196 Private slot to resize the columns of the call trace to their contents.
197 </p><a NAME="CallTraceViewer.on_saveButton_clicked" ID="CallTraceViewer.on_saveButton_clicked"></a>
198 <h4>CallTraceViewer.on_saveButton_clicked</h4>
199 <b>on_saveButton_clicked</b>(<i></i>)
200 <p>
201 Private slot to save the call trace info to a file.
202 </p><a NAME="CallTraceViewer.on_startTraceButton_clicked" ID="CallTraceViewer.on_startTraceButton_clicked"></a>
203 <h4>CallTraceViewer.on_startTraceButton_clicked</h4>
204 <b>on_startTraceButton_clicked</b>(<i></i>)
205 <p>
206 Private slot to start call tracing.
207 </p><a NAME="CallTraceViewer.on_stopTraceButton_clicked" ID="CallTraceViewer.on_stopTraceButton_clicked"></a>
208 <h4>CallTraceViewer.on_stopTraceButton_clicked</h4>
209 <b>on_stopTraceButton_clicked</b>(<i></i>)
210 <p>
211 Private slot to start call tracing.
212 </p><a NAME="CallTraceViewer.setProjectMode" ID="CallTraceViewer.setProjectMode"></a>
213 <h4>CallTraceViewer.setProjectMode</h4>
214 <b>setProjectMode</b>(<i>enabled</i>)
215 <p>
216 Public slot to set the call trace viewer to project mode.
217 </p><p>
218 In project mode the call trace info is shown with project relative
219 path names.
220 </p><dl>
221 <dt><i>enabled</i></dt>
222 <dd>
223 flag indicating to enable the project mode (boolean)
224 </dd>
225 </dl>
226 <div align="right"><a href="#top">Up</a></div>
227 <hr />
228 </body></html>

Mercurial Repository: eric

eric ide

mercurial