ProjectDjango/Documentation/source/Plugin_Project_Django.ProjectDjango.DjangoDialog.html

branch
eric7
changeset 198
dd36f90e77ee
parent 192
a4b66a1acea6
equal deleted inserted replaced
197:2667e16a3379 198:dd36f90e77ee
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>Plugin_Project_Django.ProjectDjango.DjangoDialog</h1> 9 <h1>Plugin_Project_Django.ProjectDjango.DjangoDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog starting a process and showing its output. 11 Module implementing a dialog starting a process and showing its output.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#DjangoDialog">DjangoDialog</a></td> 22 <td><a href="#DjangoDialog">DjangoDialog</a></td>
25 <td>Class implementing a dialog starting a process and showing its output.</td> 23 <td>Class implementing a dialog starting a process and showing its output.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="DjangoDialog" ID="DjangoDialog"></a> 34 <a NAME="DjangoDialog" ID="DjangoDialog"></a>
36 <h2>DjangoDialog</h2> 35 <h2>DjangoDialog</h2>
37
38 <p> 36 <p>
39 Class implementing a dialog starting a process and showing its output. 37 Class implementing a dialog starting a process and showing its output.
40 </p> 38 </p>
41 <p> 39 <p>
42 It starts a QProcess and displays a dialog that 40 It starts a QProcess and displays a dialog that
43 shows the output of the process. The dialog is modal, 41 shows the output of the process. The dialog is modal,
44 which causes a synchronized execution of the process. 42 which causes a synchronized execution of the process.
45 </p> 43 </p>
44
46 <h3>Derived from</h3> 45 <h3>Derived from</h3>
47 QDialog, Ui_DjangoDialog 46 QDialog, Ui_DjangoDialog
48 <h3>Class Attributes</h3> 47 <h3>Class Attributes</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Class Methods</h3> 52 <h3>Class Methods</h3>
54 53 <table>
55 <table> 54 <tr><td>None</td></tr>
56 <tr><td>None</td></tr> 55 </table>
57 </table> 56
58 <h3>Methods</h3> 57 <h3>Methods</h3>
59 58 <table>
60 <table>
61
62 <tr> 59 <tr>
63 <td><a href="#DjangoDialog.__init__">DjangoDialog</a></td> 60 <td><a href="#DjangoDialog.__init__">DjangoDialog</a></td>
64 <td>Constructor</td> 61 <td>Constructor</td>
65 </tr> 62 </tr>
66 <tr> 63 <tr>
118 <tr> 115 <tr>
119 <td><a href="#DjangoDialog.startProcess">startProcess</a></td> 116 <td><a href="#DjangoDialog.startProcess">startProcess</a></td>
120 <td>Public slot used to start the process.</td> 117 <td>Public slot used to start the process.</td>
121 </tr> 118 </tr>
122 </table> 119 </table>
120
123 <h3>Static Methods</h3> 121 <h3>Static Methods</h3>
124 122 <table>
125 <table> 123 <tr><td>None</td></tr>
126 <tr><td>None</td></tr> 124 </table>
127 </table> 125
128 126
129 <a NAME="DjangoDialog.__init__" ID="DjangoDialog.__init__"></a> 127 <a NAME="DjangoDialog.__init__" ID="DjangoDialog.__init__"></a>
130 <h4>DjangoDialog (Constructor)</h4> 128 <h4>DjangoDialog (Constructor)</h4>
131 <b>DjangoDialog</b>(<i>text, fixed=False, linewrap=True, msgSuccess=None, msgError=None, saveFilters=None, showInput=False, parent=None, </i>) 129 <b>DjangoDialog</b>(<i>text, fixed=False, linewrap=True, msgSuccess=None, msgError=None, saveFilters=None, showInput=False, parent=None, </i>)
132
133 <p> 130 <p>
134 Constructor 131 Constructor
135 </p> 132 </p>
133
136 <dl> 134 <dl>
137 135
138 <dt><i>text</i> (str)</dt> 136 <dt><i>text</i> (str)</dt>
139 <dd> 137 <dd>
140 text to be shown by the label 138 text to be shown by the label
169 </dd> 167 </dd>
170 </dl> 168 </dl>
171 <a NAME="DjangoDialog.__finish" ID="DjangoDialog.__finish"></a> 169 <a NAME="DjangoDialog.__finish" ID="DjangoDialog.__finish"></a>
172 <h4>DjangoDialog.__finish</h4> 170 <h4>DjangoDialog.__finish</h4>
173 <b>__finish</b>(<i></i>) 171 <b>__finish</b>(<i></i>)
174
175 <p> 172 <p>
176 Private slot called when the process finished or the user pressed the 173 Private slot called when the process finished or the user pressed the
177 button. 174 button.
178 </p> 175 </p>
176
179 <a NAME="DjangoDialog.__procFinished" ID="DjangoDialog.__procFinished"></a> 177 <a NAME="DjangoDialog.__procFinished" ID="DjangoDialog.__procFinished"></a>
180 <h4>DjangoDialog.__procFinished</h4> 178 <h4>DjangoDialog.__procFinished</h4>
181 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 179 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
182
183 <p> 180 <p>
184 Private slot connected to the finished signal. 181 Private slot connected to the finished signal.
185 </p> 182 </p>
183
186 <dl> 184 <dl>
187 185
188 <dt><i>exitCode</i> (int)</dt> 186 <dt><i>exitCode</i> (int)</dt>
189 <dd> 187 <dd>
190 exit code of the process 188 exit code of the process
195 </dd> 193 </dd>
196 </dl> 194 </dl>
197 <a NAME="DjangoDialog.__readStderr" ID="DjangoDialog.__readStderr"></a> 195 <a NAME="DjangoDialog.__readStderr" ID="DjangoDialog.__readStderr"></a>
198 <h4>DjangoDialog.__readStderr</h4> 196 <h4>DjangoDialog.__readStderr</h4>
199 <b>__readStderr</b>(<i></i>) 197 <b>__readStderr</b>(<i></i>)
200
201 <p> 198 <p>
202 Private slot to handle the readyReadStderr signal. 199 Private slot to handle the readyReadStderr signal.
203 </p> 200 </p>
204 <p> 201 <p>
205 It reads the error output of the process and inserts it into the 202 It reads the error output of the process and inserts it into the
206 error pane. 203 error pane.
207 </p> 204 </p>
205
208 <a NAME="DjangoDialog.__readStdout" ID="DjangoDialog.__readStdout"></a> 206 <a NAME="DjangoDialog.__readStdout" ID="DjangoDialog.__readStdout"></a>
209 <h4>DjangoDialog.__readStdout</h4> 207 <h4>DjangoDialog.__readStdout</h4>
210 <b>__readStdout</b>(<i></i>) 208 <b>__readStdout</b>(<i></i>)
211
212 <p> 209 <p>
213 Private slot to handle the readyReadStdout signal. 210 Private slot to handle the readyReadStdout signal.
214 </p> 211 </p>
215 <p> 212 <p>
216 It reads the output of the process, formats it and inserts it into 213 It reads the output of the process, formats it and inserts it into
217 the contents pane. 214 the contents pane.
218 </p> 215 </p>
216
219 <a NAME="DjangoDialog.__saveData" ID="DjangoDialog.__saveData"></a> 217 <a NAME="DjangoDialog.__saveData" ID="DjangoDialog.__saveData"></a>
220 <h4>DjangoDialog.__saveData</h4> 218 <h4>DjangoDialog.__saveData</h4>
221 <b>__saveData</b>(<i></i>) 219 <b>__saveData</b>(<i></i>)
222
223 <p> 220 <p>
224 Private slot to save the output to a file. 221 Private slot to save the output to a file.
225 </p> 222 </p>
223
226 <a NAME="DjangoDialog.keyPressEvent" ID="DjangoDialog.keyPressEvent"></a> 224 <a NAME="DjangoDialog.keyPressEvent" ID="DjangoDialog.keyPressEvent"></a>
227 <h4>DjangoDialog.keyPressEvent</h4> 225 <h4>DjangoDialog.keyPressEvent</h4>
228 <b>keyPressEvent</b>(<i>evt</i>) 226 <b>keyPressEvent</b>(<i>evt</i>)
229
230 <p> 227 <p>
231 Protected slot to handle a key press event. 228 Protected slot to handle a key press event.
232 </p> 229 </p>
230
233 <dl> 231 <dl>
234 232
235 <dt><i>evt</i> (QKeyEvent)</dt> 233 <dt><i>evt</i> (QKeyEvent)</dt>
236 <dd> 234 <dd>
237 the key press event 235 the key press event
238 </dd> 236 </dd>
239 </dl> 237 </dl>
240 <a NAME="DjangoDialog.normalExit" ID="DjangoDialog.normalExit"></a> 238 <a NAME="DjangoDialog.normalExit" ID="DjangoDialog.normalExit"></a>
241 <h4>DjangoDialog.normalExit</h4> 239 <h4>DjangoDialog.normalExit</h4>
242 <b>normalExit</b>(<i></i>) 240 <b>normalExit</b>(<i></i>)
243
244 <p> 241 <p>
245 Public method to check for a normal process termination. 242 Public method to check for a normal process termination.
246 </p> 243 </p>
244
247 <dl> 245 <dl>
248 <dt>Return:</dt> 246 <dt>Return:</dt>
249 <dd> 247 <dd>
250 flag indicating normal process termination 248 flag indicating normal process termination
251 </dd> 249 </dd>
257 </dd> 255 </dd>
258 </dl> 256 </dl>
259 <a NAME="DjangoDialog.normalExitWithoutErrors" ID="DjangoDialog.normalExitWithoutErrors"></a> 257 <a NAME="DjangoDialog.normalExitWithoutErrors" ID="DjangoDialog.normalExitWithoutErrors"></a>
260 <h4>DjangoDialog.normalExitWithoutErrors</h4> 258 <h4>DjangoDialog.normalExitWithoutErrors</h4>
261 <b>normalExitWithoutErrors</b>(<i></i>) 259 <b>normalExitWithoutErrors</b>(<i></i>)
262
263 <p> 260 <p>
264 Public method to check for a normal process termination without 261 Public method to check for a normal process termination without
265 error messages. 262 error messages.
266 </p> 263 </p>
264
267 <dl> 265 <dl>
268 <dt>Return:</dt> 266 <dt>Return:</dt>
269 <dd> 267 <dd>
270 flag indicating normal process termination 268 flag indicating normal process termination
271 </dd> 269 </dd>
277 </dd> 275 </dd>
278 </dl> 276 </dl>
279 <a NAME="DjangoDialog.on_buttonBox_clicked" ID="DjangoDialog.on_buttonBox_clicked"></a> 277 <a NAME="DjangoDialog.on_buttonBox_clicked" ID="DjangoDialog.on_buttonBox_clicked"></a>
280 <h4>DjangoDialog.on_buttonBox_clicked</h4> 278 <h4>DjangoDialog.on_buttonBox_clicked</h4>
281 <b>on_buttonBox_clicked</b>(<i>button</i>) 279 <b>on_buttonBox_clicked</b>(<i>button</i>)
282
283 <p> 280 <p>
284 Private slot called by a button of the button box clicked. 281 Private slot called by a button of the button box clicked.
285 </p> 282 </p>
283
286 <dl> 284 <dl>
287 285
288 <dt><i>button</i> (QAbstractButton)</dt> 286 <dt><i>button</i> (QAbstractButton)</dt>
289 <dd> 287 <dd>
290 button that was clicked 288 button that was clicked
291 </dd> 289 </dd>
292 </dl> 290 </dl>
293 <a NAME="DjangoDialog.on_input_returnPressed" ID="DjangoDialog.on_input_returnPressed"></a> 291 <a NAME="DjangoDialog.on_input_returnPressed" ID="DjangoDialog.on_input_returnPressed"></a>
294 <h4>DjangoDialog.on_input_returnPressed</h4> 292 <h4>DjangoDialog.on_input_returnPressed</h4>
295 <b>on_input_returnPressed</b>(<i></i>) 293 <b>on_input_returnPressed</b>(<i></i>)
296
297 <p> 294 <p>
298 Private slot to handle the press of the return key in the input field. 295 Private slot to handle the press of the return key in the input field.
299 </p> 296 </p>
297
300 <a NAME="DjangoDialog.on_passwordCheckBox_toggled" ID="DjangoDialog.on_passwordCheckBox_toggled"></a> 298 <a NAME="DjangoDialog.on_passwordCheckBox_toggled" ID="DjangoDialog.on_passwordCheckBox_toggled"></a>
301 <h4>DjangoDialog.on_passwordCheckBox_toggled</h4> 299 <h4>DjangoDialog.on_passwordCheckBox_toggled</h4>
302 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 300 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
303
304 <p> 301 <p>
305 Private slot to handle the password checkbox toggled. 302 Private slot to handle the password checkbox toggled.
306 </p> 303 </p>
304
307 <dl> 305 <dl>
308 306
309 <dt><i>isOn</i> (bool)</dt> 307 <dt><i>isOn</i> (bool)</dt>
310 <dd> 308 <dd>
311 flag indicating the status of the check box 309 flag indicating the status of the check box
312 </dd> 310 </dd>
313 </dl> 311 </dl>
314 <a NAME="DjangoDialog.on_sendButton_clicked" ID="DjangoDialog.on_sendButton_clicked"></a> 312 <a NAME="DjangoDialog.on_sendButton_clicked" ID="DjangoDialog.on_sendButton_clicked"></a>
315 <h4>DjangoDialog.on_sendButton_clicked</h4> 313 <h4>DjangoDialog.on_sendButton_clicked</h4>
316 <b>on_sendButton_clicked</b>(<i></i>) 314 <b>on_sendButton_clicked</b>(<i></i>)
317
318 <p> 315 <p>
319 Private slot to send the input to the manage.py process. 316 Private slot to send the input to the manage.py process.
320 </p> 317 </p>
318
321 <a NAME="DjangoDialog.startBatchProcesses" ID="DjangoDialog.startBatchProcesses"></a> 319 <a NAME="DjangoDialog.startBatchProcesses" ID="DjangoDialog.startBatchProcesses"></a>
322 <h4>DjangoDialog.startBatchProcesses</h4> 320 <h4>DjangoDialog.startBatchProcesses</h4>
323 <b>startBatchProcesses</b>(<i>argsLists, workingDir=None, mergedOutput=False</i>) 321 <b>startBatchProcesses</b>(<i>argsLists, workingDir=None, mergedOutput=False</i>)
324
325 <p> 322 <p>
326 Public slot used to start a batch of processes. 323 Public slot used to start a batch of processes.
327 </p> 324 </p>
325
328 <dl> 326 <dl>
329 327
330 <dt><i>argsLists</i> (list of list of str)</dt> 328 <dt><i>argsLists</i> (list of list of str)</dt>
331 <dd> 329 <dd>
332 list of lists of arguments for the processes 330 list of lists of arguments for the processes
353 </dd> 351 </dd>
354 </dl> 352 </dl>
355 <a NAME="DjangoDialog.startProcess" ID="DjangoDialog.startProcess"></a> 353 <a NAME="DjangoDialog.startProcess" ID="DjangoDialog.startProcess"></a>
356 <h4>DjangoDialog.startProcess</h4> 354 <h4>DjangoDialog.startProcess</h4>
357 <b>startProcess</b>(<i>args, workingDir=None, showCommand=True, mergedOutput=False</i>) 355 <b>startProcess</b>(<i>args, workingDir=None, showCommand=True, mergedOutput=False</i>)
358
359 <p> 356 <p>
360 Public slot used to start the process. 357 Public slot used to start the process.
361 </p> 358 </p>
359
362 <dl> 360 <dl>
363 361
364 <dt><i>args</i> (list of str)</dt> 362 <dt><i>args</i> (list of str)</dt>
365 <dd> 363 <dd>
366 list of arguments for the process 364 list of arguments for the process

eric ide

mercurial