Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.Debugger.StartDialog.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Debugger.StartDialog</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.StartDialog</h1>
23 <p>
24 Module implementing the Start Program dialog.
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="#StartDialog">StartDialog</a></td>
34 <td>Class implementing the Start Program dialog.</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="StartDialog" ID="StartDialog"></a>
43 <h2>StartDialog</h2>
44 <p>
45 Class implementing the Start Program dialog.
46 </p><p>
47 It implements a dialog that is used to start an
48 application for debugging. It asks the user to enter
49 the commandline parameters, the working directory and
50 whether exception reporting should be disabled.
51 </p>
52 <h3>Derived from</h3>
53 QDialog
54 <h3>Class Attributes</h3>
55 <table>
56 <tr><td>None</td></tr>
57 </table>
58 <h3>Class Methods</h3>
59 <table>
60 <tr><td>None</td></tr>
61 </table>
62 <h3>Methods</h3>
63 <table>
64 <tr>
65 <td><a href="#StartDialog.__init__">StartDialog</a></td>
66 <td>Constructor</td>
67 </tr><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><tr>
71 <td><a href="#StartDialog.__editHistory">__editHistory</a></td>
72 <td>Private slot to edit a history list.</td>
73 </tr><tr>
74 <td><a href="#StartDialog.clearHistories">clearHistories</a></td>
75 <td>Public method to test, if histories shall be cleared.</td>
76 </tr><tr>
77 <td><a href="#StartDialog.getCoverageData">getCoverageData</a></td>
78 <td>Public method to retrieve the coverage related data entered into this dialog.</td>
79 </tr><tr>
80 <td><a href="#StartDialog.getData">getData</a></td>
81 <td>Public method to retrieve the data entered into this dialog.</td>
82 </tr><tr>
83 <td><a href="#StartDialog.getDebugData">getDebugData</a></td>
84 <td>Public method to retrieve the debug related data entered into this dialog.</td>
85 </tr><tr>
86 <td><a href="#StartDialog.getHistories">getHistories</a></td>
87 <td>Public method to get the lists of histories.</td>
88 </tr><tr>
89 <td><a href="#StartDialog.getProfilingData">getProfilingData</a></td>
90 <td>Public method to retrieve the profiling related data entered into this dialog.</td>
91 </tr><tr>
92 <td><a href="#StartDialog.getRunData">getRunData</a></td>
93 <td>Public method to retrieve the debug related data entered into this dialog.</td>
94 </tr><tr>
95 <td><a href="#StartDialog.historiesModified">historiesModified</a></td>
96 <td>Public method to test for modified histories.</td>
97 </tr><tr>
98 <td><a href="#StartDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
99 <td>Private slot called by a button of the button box clicked.</td>
100 </tr><tr>
101 <td><a href="#StartDialog.on_modFuncCombo_editTextChanged">on_modFuncCombo_editTextChanged</a></td>
102 <td>Private slot to enable/disable the OK button.</td>
103 </tr>
104 </table>
105 <h3>Static Methods</h3>
106 <table>
107 <tr><td>None</td></tr>
108 </table>
109 <a NAME="StartDialog.__init__" ID="StartDialog.__init__"></a>
110 <h4>StartDialog (Constructor)</h4>
111 <b>StartDialog</b>(<i>caption, lastUsedVenvName, argvList, wdList, envList, exceptions, parent=None, dialogType=0, modfuncList=None, tracePython=False, autoClearShell=True, autoContinue=True, autoFork=False, forkChild=False</i>)
112 <p>
113 Constructor
114 </p><dl>
115 <dt><i>caption</i> (str)</dt>
116 <dd>
117 the caption to be displayed
118 </dd><dt><i>lastUsedVenvName</i> (str)</dt>
119 <dd>
120 name of the most recently used virtual
121 environment
122 </dd><dt><i>argvList</i> (list of str)</dt>
123 <dd>
124 history list of command line arguments
125 </dd><dt><i>wdList</i> (list of str)</dt>
126 <dd>
127 history list of working directories
128 </dd><dt><i>envList</i> (list of str)</dt>
129 <dd>
130 history list of environment parameter settings
131 </dd><dt><i>exceptions</i> (bool)</dt>
132 <dd>
133 exception reporting flag
134 </dd><dt><i>parent</i> (QWidget)</dt>
135 <dd>
136 parent widget of this dialog
137 </dd><dt><i>dialogType</i> (int (0 to 3))</dt>
138 <dd>
139 type of the start dialog
140 <ul>
141 <li>0 = start debug dialog</li>
142 <li>1 = start run dialog</li>
143 <li>2 = start coverage dialog</li>
144 <li>3 = start profile dialog</li>
145 </ul>
146 </dd><dt><i>modfuncList=</i> (list of str)</dt>
147 <dd>
148 history list of module functions
149 </dd><dt><i>tracePython=</i> (bool)</dt>
150 <dd>
151 flag indicating if the Python library should
152 be traced as well
153 </dd><dt><i>autoClearShell=</i> (bool)</dt>
154 <dd>
155 flag indicating, that the interpreter window
156 should be cleared automatically
157 </dd><dt><i>autoContinue=</i> (bool)</dt>
158 <dd>
159 flag indicating, that the debugger should not
160 stop at the first executable line
161 </dd><dt><i>autoFork=</i> (bool)</dt>
162 <dd>
163 flag indicating the automatic fork mode
164 </dd><dt><i>forkChild=</i> (bool)</dt>
165 <dd>
166 flag indicating to debug the child after forking
167 </dd>
168 </dl><a NAME="StartDialog.__clearHistories" ID="StartDialog.__clearHistories"></a>
169 <h4>StartDialog.__clearHistories</h4>
170 <b>__clearHistories</b>(<i></i>)
171 <p>
172 Private slot to clear the combo boxes lists and record a flag to
173 clear the lists.
174 </p><a NAME="StartDialog.__editHistory" ID="StartDialog.__editHistory"></a>
175 <h4>StartDialog.__editHistory</h4>
176 <b>__editHistory</b>(<i></i>)
177 <p>
178 Private slot to edit a history list.
179 </p><a NAME="StartDialog.clearHistories" ID="StartDialog.clearHistories"></a>
180 <h4>StartDialog.clearHistories</h4>
181 <b>clearHistories</b>(<i></i>)
182 <p>
183 Public method to test, if histories shall be cleared.
184 </p><dl>
185 <dt>Returns:</dt>
186 <dd>
187 flag indicating histories shall be cleared
188 </dd>
189 </dl><dl>
190 <dt>Return Type:</dt>
191 <dd>
192 bool
193 </dd>
194 </dl><a NAME="StartDialog.getCoverageData" ID="StartDialog.getCoverageData"></a>
195 <h4>StartDialog.getCoverageData</h4>
196 <b>getCoverageData</b>(<i></i>)
197 <p>
198 Public method to retrieve the coverage related data entered into this
199 dialog.
200 </p><dl>
201 <dt>Returns:</dt>
202 <dd>
203 flag indicating erasure of coverage info (boolean)
204 </dd>
205 </dl><a NAME="StartDialog.getData" ID="StartDialog.getData"></a>
206 <h4>StartDialog.getData</h4>
207 <b>getData</b>(<i></i>)
208 <p>
209 Public method to retrieve the data entered into this dialog.
210 </p><dl>
211 <dt>Returns:</dt>
212 <dd>
213 a tuple of interpreter (string), argv (string), workdir
214 (string), environment (string), exceptions flag (boolean),
215 clear interpreter flag (boolean) and run in console flag (boolean)
216 </dd>
217 </dl><a NAME="StartDialog.getDebugData" ID="StartDialog.getDebugData"></a>
218 <h4>StartDialog.getDebugData</h4>
219 <b>getDebugData</b>(<i></i>)
220 <p>
221 Public method to retrieve the debug related data entered into this
222 dialog.
223 </p><dl>
224 <dt>Returns:</dt>
225 <dd>
226 a tuple of a flag indicating, if the Python library should be
227 traced as well, a flag indicating, that the debugger should not
228 stop at the first executable line (boolean), a flag indicating,
229 that the debugger should fork automatically (boolean) and a flag
230 indicating, that the debugger should debug the child process after
231 forking automatically (boolean)
232 </dd>
233 </dl><a NAME="StartDialog.getHistories" ID="StartDialog.getHistories"></a>
234 <h4>StartDialog.getHistories</h4>
235 <b>getHistories</b>(<i></i>)
236 <p>
237 Public method to get the lists of histories.
238 </p><dl>
239 <dt>Returns:</dt>
240 <dd>
241 tuple containing the histories of command line arguments,
242 working directories, environment settings and interpreters
243 </dd>
244 </dl><dl>
245 <dt>Return Type:</dt>
246 <dd>
247 tuple of four list of str
248 </dd>
249 </dl><a NAME="StartDialog.getProfilingData" ID="StartDialog.getProfilingData"></a>
250 <h4>StartDialog.getProfilingData</h4>
251 <b>getProfilingData</b>(<i></i>)
252 <p>
253 Public method to retrieve the profiling related data entered into this
254 dialog.
255 </p><dl>
256 <dt>Returns:</dt>
257 <dd>
258 flag indicating erasure of profiling info (boolean)
259 </dd>
260 </dl><a NAME="StartDialog.getRunData" ID="StartDialog.getRunData"></a>
261 <h4>StartDialog.getRunData</h4>
262 <b>getRunData</b>(<i></i>)
263 <p>
264 Public method to retrieve the debug related data entered into this
265 dialog.
266 </p><dl>
267 <dt>Returns:</dt>
268 <dd>
269 a tuple of a flag indicating, that the debugger should fork
270 automatically (boolean) and a flag indicating, that the debugger
271 should debug the child process after forking automatically
272 (boolean)
273 </dd>
274 </dl><a NAME="StartDialog.historiesModified" ID="StartDialog.historiesModified"></a>
275 <h4>StartDialog.historiesModified</h4>
276 <b>historiesModified</b>(<i></i>)
277 <p>
278 Public method to test for modified histories.
279 </p><dl>
280 <dt>Returns:</dt>
281 <dd>
282 flag indicating modified histories
283 </dd>
284 </dl><dl>
285 <dt>Return Type:</dt>
286 <dd>
287 bool
288 </dd>
289 </dl><a NAME="StartDialog.on_buttonBox_clicked" ID="StartDialog.on_buttonBox_clicked"></a>
290 <h4>StartDialog.on_buttonBox_clicked</h4>
291 <b>on_buttonBox_clicked</b>(<i>button</i>)
292 <p>
293 Private slot called by a button of the button box clicked.
294 </p><dl>
295 <dt><i>button</i></dt>
296 <dd>
297 button that was clicked (QAbstractButton)
298 </dd>
299 </dl><a NAME="StartDialog.on_modFuncCombo_editTextChanged" ID="StartDialog.on_modFuncCombo_editTextChanged"></a>
300 <h4>StartDialog.on_modFuncCombo_editTextChanged</h4>
301 <b>on_modFuncCombo_editTextChanged</b>(<i></i>)
302 <p>
303 Private slot to enable/disable the OK button.
304 </p>
305 <div align="right"><a href="#top">Up</a></div>
306 <hr />
307 </body></html>

Mercurial Repository: eric

eric ide

mercurial