src/eric7/Documentation/Source/eric7.Debugger.CallStackViewer.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Debugger.CallStackViewer</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Debugger.CallStackViewer</h1>
10
11 <p>
12 Module implementing the Call Stack viewer widget.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#CallStackViewer">CallStackViewer</a></td>
25 <td>Class implementing the Call Stack viewer widget.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="CallStackViewer" ID="CallStackViewer"></a>
36 <h2>CallStackViewer</h2>
37
38 <p>
39 Class implementing the Call Stack viewer widget.
40 </p>
41 <h3>Signals</h3>
42 <dl>
43
44 <dt>frameSelected(int)</dt>
45 <dd>
46 emitted to signal the selection of a frame entry
47 </dd>
48 <dt>sourceFile(str, int)</dt>
49 <dd>
50 emitted to show the source of a stack entry
51 </dd>
52 </dl>
53 <h3>Derived from</h3>
54 QWidget
55 <h3>Class Attributes</h3>
56
57 <table>
58 <tr><td>FilenameRole</td></tr><tr><td>LinenoRole</td></tr>
59 </table>
60 <h3>Class Methods</h3>
61
62 <table>
63 <tr><td>None</td></tr>
64 </table>
65 <h3>Methods</h3>
66
67 <table>
68
69 <tr>
70 <td><a href="#CallStackViewer.__init__">CallStackViewer</a></td>
71 <td>Constructor</td>
72 </tr>
73 <tr>
74 <td><a href="#CallStackViewer.__itemDoubleClicked">__itemDoubleClicked</a></td>
75 <td>Private slot to handle a double click of a stack entry.</td>
76 </tr>
77 <tr>
78 <td><a href="#CallStackViewer.__openSource">__openSource</a></td>
79 <td>Private slot to show the source for the selected stack entry.</td>
80 </tr>
81 <tr>
82 <td><a href="#CallStackViewer.__saveStackTrace">__saveStackTrace</a></td>
83 <td>Private slot to save the stack trace info to a file.</td>
84 </tr>
85 <tr>
86 <td><a href="#CallStackViewer.__showCallStack">__showCallStack</a></td>
87 <td>Private slot to show the call stack of the program being debugged.</td>
88 </tr>
89 <tr>
90 <td><a href="#CallStackViewer.__showContextMenu">__showContextMenu</a></td>
91 <td>Private slot to show the context menu.</td>
92 </tr>
93 <tr>
94 <td><a href="#CallStackViewer.clear">clear</a></td>
95 <td>Public method to clear the stack viewer data.</td>
96 </tr>
97 <tr>
98 <td><a href="#CallStackViewer.setDebugger">setDebugger</a></td>
99 <td>Public method to set a reference to the Debug UI.</td>
100 </tr>
101 <tr>
102 <td><a href="#CallStackViewer.setProjectMode">setProjectMode</a></td>
103 <td>Public slot to set the call trace viewer to project mode.</td>
104 </tr>
105 </table>
106 <h3>Static Methods</h3>
107
108 <table>
109 <tr><td>None</td></tr>
110 </table>
111
112 <a NAME="CallStackViewer.__init__" ID="CallStackViewer.__init__"></a>
113 <h4>CallStackViewer (Constructor)</h4>
114 <b>CallStackViewer</b>(<i>debugServer, parent=None</i>)
115
116 <p>
117 Constructor
118 </p>
119 <dl>
120
121 <dt><i>debugServer</i> (DebugServer)</dt>
122 <dd>
123 reference to the debug server object
124 </dd>
125 <dt><i>parent</i> (QWidget)</dt>
126 <dd>
127 reference to the parent widget
128 </dd>
129 </dl>
130 <a NAME="CallStackViewer.__itemDoubleClicked" ID="CallStackViewer.__itemDoubleClicked"></a>
131 <h4>CallStackViewer.__itemDoubleClicked</h4>
132 <b>__itemDoubleClicked</b>(<i>itm</i>)
133
134 <p>
135 Private slot to handle a double click of a stack entry.
136 </p>
137 <dl>
138
139 <dt><i>itm</i> (QTreeWidgetItem)</dt>
140 <dd>
141 reference to the double clicked item
142 </dd>
143 </dl>
144 <a NAME="CallStackViewer.__openSource" ID="CallStackViewer.__openSource"></a>
145 <h4>CallStackViewer.__openSource</h4>
146 <b>__openSource</b>(<i></i>)
147
148 <p>
149 Private slot to show the source for the selected stack entry.
150 </p>
151 <a NAME="CallStackViewer.__saveStackTrace" ID="CallStackViewer.__saveStackTrace"></a>
152 <h4>CallStackViewer.__saveStackTrace</h4>
153 <b>__saveStackTrace</b>(<i></i>)
154
155 <p>
156 Private slot to save the stack trace info to a file.
157 </p>
158 <a NAME="CallStackViewer.__showCallStack" ID="CallStackViewer.__showCallStack"></a>
159 <h4>CallStackViewer.__showCallStack</h4>
160 <b>__showCallStack</b>(<i>stack, debuggerId</i>)
161
162 <p>
163 Private slot to show the call stack of the program being debugged.
164 </p>
165 <dl>
166
167 <dt><i>stack</i> (list of tuples of (str, str, str, str))</dt>
168 <dd>
169 list of tuples with call stack data (file name,
170 line number, function name, formatted argument/values list)
171 </dd>
172 <dt><i>debuggerId</i> (str)</dt>
173 <dd>
174 ID of the debugger backend
175 </dd>
176 </dl>
177 <a NAME="CallStackViewer.__showContextMenu" ID="CallStackViewer.__showContextMenu"></a>
178 <h4>CallStackViewer.__showContextMenu</h4>
179 <b>__showContextMenu</b>(<i>coord</i>)
180
181 <p>
182 Private slot to show the context menu.
183 </p>
184 <dl>
185
186 <dt><i>coord</i> (QPoint)</dt>
187 <dd>
188 the position of the mouse pointer
189 </dd>
190 </dl>
191 <a NAME="CallStackViewer.clear" ID="CallStackViewer.clear"></a>
192 <h4>CallStackViewer.clear</h4>
193 <b>clear</b>(<i></i>)
194
195 <p>
196 Public method to clear the stack viewer data.
197 </p>
198 <a NAME="CallStackViewer.setDebugger" ID="CallStackViewer.setDebugger"></a>
199 <h4>CallStackViewer.setDebugger</h4>
200 <b>setDebugger</b>(<i>debugUI</i>)
201
202 <p>
203 Public method to set a reference to the Debug UI.
204 </p>
205 <dl>
206
207 <dt><i>debugUI</i> (DebugUI)</dt>
208 <dd>
209 reference to the DebugUI object
210 </dd>
211 </dl>
212 <a NAME="CallStackViewer.setProjectMode" ID="CallStackViewer.setProjectMode"></a>
213 <h4>CallStackViewer.setProjectMode</h4>
214 <b>setProjectMode</b>(<i>enabled</i>)
215
216 <p>
217 Public slot to set the call trace viewer to project mode.
218 </p>
219 <p>
220 In project mode the call trace info is shown with project relative
221 path names.
222 </p>
223 <dl>
224
225 <dt><i>enabled</i> (bool)</dt>
226 <dd>
227 flag indicating to enable the project mode
228 </dd>
229 </dl>
230 <div align="right"><a href="#top">Up</a></div>
231 <hr />
232 </body></html>

eric ide

mercurial