|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.Debugger.StartDialog</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.StartDialog</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing the Start Program dialog. |
|
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="#StartDialog">StartDialog</a></td> |
|
25 <td>Class implementing the Start Program dialog.</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="StartDialog" ID="StartDialog"></a> |
|
36 <h2>StartDialog</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing the Start Program dialog. |
|
40 </p> |
|
41 <p> |
|
42 It implements a dialog that is used to start an |
|
43 application for debugging. It asks the user to enter |
|
44 the commandline parameters, the working directory and |
|
45 whether exception reporting should be disabled. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QDialog |
|
49 <h3>Class Attributes</h3> |
|
50 |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Class Methods</h3> |
|
55 |
|
56 <table> |
|
57 <tr><td>None</td></tr> |
|
58 </table> |
|
59 <h3>Methods</h3> |
|
60 |
|
61 <table> |
|
62 |
|
63 <tr> |
|
64 <td><a href="#StartDialog.__init__">StartDialog</a></td> |
|
65 <td>Constructor</td> |
|
66 </tr> |
|
67 <tr> |
|
68 <td><a href="#StartDialog.__clearHistories">__clearHistories</a></td> |
|
69 <td>Private slot to clear the combo boxes lists and record a flag to clear the lists.</td> |
|
70 </tr> |
|
71 <tr> |
|
72 <td><a href="#StartDialog.__editHistory">__editHistory</a></td> |
|
73 <td>Private slot to edit a history list.</td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td><a href="#StartDialog.clearHistories">clearHistories</a></td> |
|
77 <td>Public method to test, if histories shall be cleared.</td> |
|
78 </tr> |
|
79 <tr> |
|
80 <td><a href="#StartDialog.getCoverageData">getCoverageData</a></td> |
|
81 <td>Public method to retrieve the coverage related data entered into this dialog.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#StartDialog.getData">getData</a></td> |
|
85 <td>Public method to retrieve the data entered into this dialog.</td> |
|
86 </tr> |
|
87 <tr> |
|
88 <td><a href="#StartDialog.getDebugData">getDebugData</a></td> |
|
89 <td>Public method to retrieve the debug related data entered into this dialog.</td> |
|
90 </tr> |
|
91 <tr> |
|
92 <td><a href="#StartDialog.getGlobalOverrideData">getGlobalOverrideData</a></td> |
|
93 <td>Public method to retrieve the global configuration override data entered into this dialog.</td> |
|
94 </tr> |
|
95 <tr> |
|
96 <td><a href="#StartDialog.getHistories">getHistories</a></td> |
|
97 <td>Public method to get the lists of histories.</td> |
|
98 </tr> |
|
99 <tr> |
|
100 <td><a href="#StartDialog.getProfilingData">getProfilingData</a></td> |
|
101 <td>Public method to retrieve the profiling related data entered into this dialog.</td> |
|
102 </tr> |
|
103 <tr> |
|
104 <td><a href="#StartDialog.historiesModified">historiesModified</a></td> |
|
105 <td>Public method to test for modified histories.</td> |
|
106 </tr> |
|
107 <tr> |
|
108 <td><a href="#StartDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> |
|
109 <td>Private slot called by a button of the button box clicked.</td> |
|
110 </tr> |
|
111 <tr> |
|
112 <td><a href="#StartDialog.on_modFuncCombo_editTextChanged">on_modFuncCombo_editTextChanged</a></td> |
|
113 <td>Private slot to enable/disable the OK button.</td> |
|
114 </tr> |
|
115 </table> |
|
116 <h3>Static Methods</h3> |
|
117 |
|
118 <table> |
|
119 <tr><td>None</td></tr> |
|
120 </table> |
|
121 |
|
122 <a NAME="StartDialog.__init__" ID="StartDialog.__init__"></a> |
|
123 <h4>StartDialog (Constructor)</h4> |
|
124 <b>StartDialog</b>(<i>caption, lastUsedVenvName, argvList, wdList, envList, exceptions, parent=None, dialogType=0, modfuncList=None, tracePython=False, autoClearShell=True, autoContinue=True, enableMultiprocess=False, multiprocessNoDebugHistory=None, configOverride=None, forProject=False, scriptName="", scriptsList=None</i>) |
|
125 |
|
126 <p> |
|
127 Constructor |
|
128 </p> |
|
129 <dl> |
|
130 |
|
131 <dt><i>caption</i> (str)</dt> |
|
132 <dd> |
|
133 the caption to be displayed |
|
134 </dd> |
|
135 <dt><i>lastUsedVenvName</i> (str)</dt> |
|
136 <dd> |
|
137 name of the most recently used virtual |
|
138 environment |
|
139 </dd> |
|
140 <dt><i>argvList</i> (list of str)</dt> |
|
141 <dd> |
|
142 history list of command line arguments |
|
143 </dd> |
|
144 <dt><i>wdList</i> (list of str)</dt> |
|
145 <dd> |
|
146 history list of working directories |
|
147 </dd> |
|
148 <dt><i>envList</i> (list of str)</dt> |
|
149 <dd> |
|
150 history list of environment parameter settings |
|
151 </dd> |
|
152 <dt><i>exceptions</i> (bool)</dt> |
|
153 <dd> |
|
154 exception reporting flag |
|
155 </dd> |
|
156 <dt><i>parent</i> (QWidget)</dt> |
|
157 <dd> |
|
158 parent widget of this dialog |
|
159 </dd> |
|
160 <dt><i>dialogType</i> (int (0 to 3))</dt> |
|
161 <dd> |
|
162 type of the start dialog |
|
163 <ul> |
|
164 <li>0 = start debug dialog</li> |
|
165 <li>1 = start run dialog</li> |
|
166 <li>2 = start coverage dialog</li> |
|
167 <li>3 = start profile dialog</li> |
|
168 </ul> |
|
169 </dd> |
|
170 <dt><i>modfuncList</i> (list of str)</dt> |
|
171 <dd> |
|
172 history list of module functions |
|
173 </dd> |
|
174 <dt><i>tracePython</i> (bool)</dt> |
|
175 <dd> |
|
176 flag indicating if the Python library should |
|
177 be traced as well |
|
178 </dd> |
|
179 <dt><i>autoClearShell</i> (bool)</dt> |
|
180 <dd> |
|
181 flag indicating, that the interpreter window |
|
182 should be cleared automatically |
|
183 </dd> |
|
184 <dt><i>autoContinue</i> (bool)</dt> |
|
185 <dd> |
|
186 flag indicating, that the debugger should not |
|
187 stop at the first executable line |
|
188 </dd> |
|
189 <dt><i>enableMultiprocess</i> (bool)</dt> |
|
190 <dd> |
|
191 flag indicating the support for multi process |
|
192 debugging |
|
193 </dd> |
|
194 <dt><i>multiprocessNoDebugHistory</i> (list of str)</dt> |
|
195 <dd> |
|
196 list of lists with programs not to be |
|
197 debugged |
|
198 </dd> |
|
199 <dt><i>configOverride</i> (dict)</dt> |
|
200 <dd> |
|
201 dictionary containing the global config override |
|
202 data |
|
203 </dd> |
|
204 <dt><i>forProject</i> (bool)</dt> |
|
205 <dd> |
|
206 flag indicating to get the parameters for a |
|
207 run/debug/... action for a project |
|
208 </dd> |
|
209 <dt><i>scriptName</i> (str)</dt> |
|
210 <dd> |
|
211 name of the script |
|
212 </dd> |
|
213 <dt><i>scriptsList</i> (list of str)</dt> |
|
214 <dd> |
|
215 history list of script names |
|
216 </dd> |
|
217 </dl> |
|
218 <a NAME="StartDialog.__clearHistories" ID="StartDialog.__clearHistories"></a> |
|
219 <h4>StartDialog.__clearHistories</h4> |
|
220 <b>__clearHistories</b>(<i></i>) |
|
221 |
|
222 <p> |
|
223 Private slot to clear the combo boxes lists and record a flag to |
|
224 clear the lists. |
|
225 </p> |
|
226 <a NAME="StartDialog.__editHistory" ID="StartDialog.__editHistory"></a> |
|
227 <h4>StartDialog.__editHistory</h4> |
|
228 <b>__editHistory</b>(<i></i>) |
|
229 |
|
230 <p> |
|
231 Private slot to edit a history list. |
|
232 </p> |
|
233 <a NAME="StartDialog.clearHistories" ID="StartDialog.clearHistories"></a> |
|
234 <h4>StartDialog.clearHistories</h4> |
|
235 <b>clearHistories</b>(<i></i>) |
|
236 |
|
237 <p> |
|
238 Public method to test, if histories shall be cleared. |
|
239 </p> |
|
240 <dl> |
|
241 <dt>Return:</dt> |
|
242 <dd> |
|
243 flag indicating histories shall be cleared |
|
244 </dd> |
|
245 </dl> |
|
246 <dl> |
|
247 <dt>Return Type:</dt> |
|
248 <dd> |
|
249 bool |
|
250 </dd> |
|
251 </dl> |
|
252 <a NAME="StartDialog.getCoverageData" ID="StartDialog.getCoverageData"></a> |
|
253 <h4>StartDialog.getCoverageData</h4> |
|
254 <b>getCoverageData</b>(<i></i>) |
|
255 |
|
256 <p> |
|
257 Public method to retrieve the coverage related data entered into this |
|
258 dialog. |
|
259 </p> |
|
260 <dl> |
|
261 <dt>Return:</dt> |
|
262 <dd> |
|
263 flag indicating erasure of coverage info |
|
264 </dd> |
|
265 </dl> |
|
266 <dl> |
|
267 <dt>Return Type:</dt> |
|
268 <dd> |
|
269 bool |
|
270 </dd> |
|
271 </dl> |
|
272 <a NAME="StartDialog.getData" ID="StartDialog.getData"></a> |
|
273 <h4>StartDialog.getData</h4> |
|
274 <b>getData</b>(<i></i>) |
|
275 |
|
276 <p> |
|
277 Public method to retrieve the data entered into this dialog. |
|
278 </p> |
|
279 <dl> |
|
280 <dt>Return:</dt> |
|
281 <dd> |
|
282 a tuple of virtual environment, script name, argv, workdir, |
|
283 environment, exceptions flag, clear interpreter flag and run in |
|
284 console flag |
|
285 </dd> |
|
286 </dl> |
|
287 <dl> |
|
288 <dt>Return Type:</dt> |
|
289 <dd> |
|
290 tuple of (str, str, str, str, str, bool, bool, bool) |
|
291 </dd> |
|
292 </dl> |
|
293 <a NAME="StartDialog.getDebugData" ID="StartDialog.getDebugData"></a> |
|
294 <h4>StartDialog.getDebugData</h4> |
|
295 <b>getDebugData</b>(<i></i>) |
|
296 |
|
297 <p> |
|
298 Public method to retrieve the debug related data entered into this |
|
299 dialog. |
|
300 </p> |
|
301 <dl> |
|
302 <dt>Return:</dt> |
|
303 <dd> |
|
304 a tuple of a flag indicating, if the Python library should be |
|
305 traced as well, a flag indicating, that the debugger should not |
|
306 stop at the first executable line, a flag indicating to support |
|
307 multi process debugging and a space separated list of programs not |
|
308 to be debugged |
|
309 </dd> |
|
310 </dl> |
|
311 <dl> |
|
312 <dt>Return Type:</dt> |
|
313 <dd> |
|
314 tuple of (bool, bool, bool, str) |
|
315 </dd> |
|
316 </dl> |
|
317 <a NAME="StartDialog.getGlobalOverrideData" ID="StartDialog.getGlobalOverrideData"></a> |
|
318 <h4>StartDialog.getGlobalOverrideData</h4> |
|
319 <b>getGlobalOverrideData</b>(<i></i>) |
|
320 |
|
321 <p> |
|
322 Public method to retrieve the global configuration override data |
|
323 entered into this dialog. |
|
324 </p> |
|
325 <dl> |
|
326 <dt>Return:</dt> |
|
327 <dd> |
|
328 dictionary containing a flag indicating to activate the global |
|
329 override and a flag indicating a redirect of stdin/stdout/stderr |
|
330 </dd> |
|
331 </dl> |
|
332 <dl> |
|
333 <dt>Return Type:</dt> |
|
334 <dd> |
|
335 dict |
|
336 </dd> |
|
337 </dl> |
|
338 <a NAME="StartDialog.getHistories" ID="StartDialog.getHistories"></a> |
|
339 <h4>StartDialog.getHistories</h4> |
|
340 <b>getHistories</b>(<i></i>) |
|
341 |
|
342 <p> |
|
343 Public method to get the lists of histories. |
|
344 </p> |
|
345 <dl> |
|
346 <dt>Return:</dt> |
|
347 <dd> |
|
348 tuple containing the histories of script names, command line |
|
349 arguments, working directories, environment settings and no debug |
|
350 programs lists |
|
351 </dd> |
|
352 </dl> |
|
353 <dl> |
|
354 <dt>Return Type:</dt> |
|
355 <dd> |
|
356 tuple of five list of str |
|
357 </dd> |
|
358 </dl> |
|
359 <a NAME="StartDialog.getProfilingData" ID="StartDialog.getProfilingData"></a> |
|
360 <h4>StartDialog.getProfilingData</h4> |
|
361 <b>getProfilingData</b>(<i></i>) |
|
362 |
|
363 <p> |
|
364 Public method to retrieve the profiling related data entered into this |
|
365 dialog. |
|
366 </p> |
|
367 <dl> |
|
368 <dt>Return:</dt> |
|
369 <dd> |
|
370 flag indicating erasure of profiling info |
|
371 </dd> |
|
372 </dl> |
|
373 <dl> |
|
374 <dt>Return Type:</dt> |
|
375 <dd> |
|
376 bool |
|
377 </dd> |
|
378 </dl> |
|
379 <a NAME="StartDialog.historiesModified" ID="StartDialog.historiesModified"></a> |
|
380 <h4>StartDialog.historiesModified</h4> |
|
381 <b>historiesModified</b>(<i></i>) |
|
382 |
|
383 <p> |
|
384 Public method to test for modified histories. |
|
385 </p> |
|
386 <dl> |
|
387 <dt>Return:</dt> |
|
388 <dd> |
|
389 flag indicating modified histories |
|
390 </dd> |
|
391 </dl> |
|
392 <dl> |
|
393 <dt>Return Type:</dt> |
|
394 <dd> |
|
395 bool |
|
396 </dd> |
|
397 </dl> |
|
398 <a NAME="StartDialog.on_buttonBox_clicked" ID="StartDialog.on_buttonBox_clicked"></a> |
|
399 <h4>StartDialog.on_buttonBox_clicked</h4> |
|
400 <b>on_buttonBox_clicked</b>(<i>button</i>) |
|
401 |
|
402 <p> |
|
403 Private slot called by a button of the button box clicked. |
|
404 </p> |
|
405 <dl> |
|
406 |
|
407 <dt><i>button</i> (QAbstractButton)</dt> |
|
408 <dd> |
|
409 button that was clicked |
|
410 </dd> |
|
411 </dl> |
|
412 <a NAME="StartDialog.on_modFuncCombo_editTextChanged" ID="StartDialog.on_modFuncCombo_editTextChanged"></a> |
|
413 <h4>StartDialog.on_modFuncCombo_editTextChanged</h4> |
|
414 <b>on_modFuncCombo_editTextChanged</b>(<i></i>) |
|
415 |
|
416 <p> |
|
417 Private slot to enable/disable the OK button. |
|
418 </p> |
|
419 <div align="right"><a href="#top">Up</a></div> |
|
420 <hr /> |
|
421 </body></html> |