Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.EricWidgets.EricProcessDialog.html

eric7/Documentation/Source/eric7.EricWidgets.EricProcessDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.EricWidgets.EricProcessDialog</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.EricWidgets.EricProcessDialog</h1>
24
25 <p>
26 Module implementing a dialog starting a process and showing its output.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#EricProcessDialog">EricProcessDialog</a></td>
39 <td>Class implementing a dialog starting a process and showing its output.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="EricProcessDialog" ID="EricProcessDialog"></a>
50 <h2>EricProcessDialog</h2>
51
52 <p>
53 Class implementing a dialog starting a process and showing its output.
54 </p>
55 <p>
56 It starts a QProcess and displays a dialog that shows the output of the
57 process. The dialog is modal, which causes a synchronized execution of
58 the process.
59 </p>
60 <h3>Derived from</h3>
61 QDialog, Ui_EricProcessDialog
62 <h3>Class Attributes</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Class Methods</h3>
68
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72 <h3>Methods</h3>
73
74 <table>
75
76 <tr>
77 <td><a href="#EricProcessDialog.__init__">EricProcessDialog</a></td>
78 <td>Constructor</td>
79 </tr>
80 <tr>
81 <td><a href="#EricProcessDialog.__finish">__finish</a></td>
82 <td>Private slot called when the process finished or the user pressed the button.</td>
83 </tr>
84 <tr>
85 <td><a href="#EricProcessDialog.__procFinished">__procFinished</a></td>
86 <td>Private slot connected to the finished signal.</td>
87 </tr>
88 <tr>
89 <td><a href="#EricProcessDialog.__readStderr">__readStderr</a></td>
90 <td>Private slot to handle the readyReadStandardError signal.</td>
91 </tr>
92 <tr>
93 <td><a href="#EricProcessDialog.__readStdout">__readStdout</a></td>
94 <td>Private slot to handle the readyReadStandardOutput signal.</td>
95 </tr>
96 <tr>
97 <td><a href="#EricProcessDialog.keyPressEvent">keyPressEvent</a></td>
98 <td>Protected slot to handle a key press event.</td>
99 </tr>
100 <tr>
101 <td><a href="#EricProcessDialog.normalExit">normalExit</a></td>
102 <td>Public method to check for a normal process termination.</td>
103 </tr>
104 <tr>
105 <td><a href="#EricProcessDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td>
106 <td>Public method to check for a normal process termination without error messages.</td>
107 </tr>
108 <tr>
109 <td><a href="#EricProcessDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
110 <td>Private slot called by a button of the button box clicked.</td>
111 </tr>
112 <tr>
113 <td><a href="#EricProcessDialog.on_input_returnPressed">on_input_returnPressed</a></td>
114 <td>Private slot to handle the press of the return key in the input field.</td>
115 </tr>
116 <tr>
117 <td><a href="#EricProcessDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
118 <td>Private slot to handle the password checkbox toggled.</td>
119 </tr>
120 <tr>
121 <td><a href="#EricProcessDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
122 <td>Private slot to send the input to the git process.</td>
123 </tr>
124 <tr>
125 <td><a href="#EricProcessDialog.startProcess">startProcess</a></td>
126 <td>Public slot used to start the process.</td>
127 </tr>
128 </table>
129 <h3>Static Methods</h3>
130
131 <table>
132 <tr><td>None</td></tr>
133 </table>
134
135 <a NAME="EricProcessDialog.__init__" ID="EricProcessDialog.__init__"></a>
136 <h4>EricProcessDialog (Constructor)</h4>
137 <b>EricProcessDialog</b>(<i>outputTitle="", windowTitle="", showProgress=False, parent=None</i>)
138
139 <p>
140 Constructor
141 </p>
142 <dl>
143
144 <dt><i>outputTitle</i> (str)</dt>
145 <dd>
146 title for the output group
147 </dd>
148 <dt><i>windowTitle</i> (str)</dt>
149 <dd>
150 title of the dialog
151 </dd>
152 <dt><i>showProgress</i> (bool)</dt>
153 <dd>
154 flag indicating to show a progress bar
155 </dd>
156 <dt><i>parent</i> (QWidget)</dt>
157 <dd>
158 reference to the parent widget
159 </dd>
160 </dl>
161 <a NAME="EricProcessDialog.__finish" ID="EricProcessDialog.__finish"></a>
162 <h4>EricProcessDialog.__finish</h4>
163 <b>__finish</b>(<i></i>)
164
165 <p>
166 Private slot called when the process finished or the user pressed
167 the button.
168 </p>
169 <a NAME="EricProcessDialog.__procFinished" ID="EricProcessDialog.__procFinished"></a>
170 <h4>EricProcessDialog.__procFinished</h4>
171 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
172
173 <p>
174 Private slot connected to the finished signal.
175 </p>
176 <dl>
177
178 <dt><i>exitCode</i> (int)</dt>
179 <dd>
180 exit code of the process
181 </dd>
182 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
183 <dd>
184 exit status of the process
185 </dd>
186 </dl>
187 <a NAME="EricProcessDialog.__readStderr" ID="EricProcessDialog.__readStderr"></a>
188 <h4>EricProcessDialog.__readStderr</h4>
189 <b>__readStderr</b>(<i></i>)
190
191 <p>
192 Private slot to handle the readyReadStandardError signal.
193 </p>
194 <p>
195 It reads the error output of the process and inserts it into the
196 error pane.
197 </p>
198 <a NAME="EricProcessDialog.__readStdout" ID="EricProcessDialog.__readStdout"></a>
199 <h4>EricProcessDialog.__readStdout</h4>
200 <b>__readStdout</b>(<i></i>)
201
202 <p>
203 Private slot to handle the readyReadStandardOutput signal.
204 </p>
205 <p>
206 It reads the output of the process and inserts it into the
207 output pane.
208 </p>
209 <a NAME="EricProcessDialog.keyPressEvent" ID="EricProcessDialog.keyPressEvent"></a>
210 <h4>EricProcessDialog.keyPressEvent</h4>
211 <b>keyPressEvent</b>(<i>evt</i>)
212
213 <p>
214 Protected slot to handle a key press event.
215 </p>
216 <dl>
217
218 <dt><i>evt</i></dt>
219 <dd>
220 the key press event (QKeyEvent)
221 </dd>
222 </dl>
223 <a NAME="EricProcessDialog.normalExit" ID="EricProcessDialog.normalExit"></a>
224 <h4>EricProcessDialog.normalExit</h4>
225 <b>normalExit</b>(<i></i>)
226
227 <p>
228 Public method to check for a normal process termination.
229 </p>
230 <dl>
231 <dt>Return:</dt>
232 <dd>
233 flag indicating normal process termination
234 </dd>
235 </dl>
236 <dl>
237 <dt>Return Type:</dt>
238 <dd>
239 bool
240 </dd>
241 </dl>
242 <a NAME="EricProcessDialog.normalExitWithoutErrors" ID="EricProcessDialog.normalExitWithoutErrors"></a>
243 <h4>EricProcessDialog.normalExitWithoutErrors</h4>
244 <b>normalExitWithoutErrors</b>(<i></i>)
245
246 <p>
247 Public method to check for a normal process termination without
248 error messages.
249 </p>
250 <dl>
251 <dt>Return:</dt>
252 <dd>
253 flag indicating normal process termination
254 </dd>
255 </dl>
256 <dl>
257 <dt>Return Type:</dt>
258 <dd>
259 bool
260 </dd>
261 </dl>
262 <a NAME="EricProcessDialog.on_buttonBox_clicked" ID="EricProcessDialog.on_buttonBox_clicked"></a>
263 <h4>EricProcessDialog.on_buttonBox_clicked</h4>
264 <b>on_buttonBox_clicked</b>(<i>button</i>)
265
266 <p>
267 Private slot called by a button of the button box clicked.
268 </p>
269 <dl>
270
271 <dt><i>button</i> (QAbstractButton)</dt>
272 <dd>
273 button that was clicked
274 </dd>
275 </dl>
276 <a NAME="EricProcessDialog.on_input_returnPressed" ID="EricProcessDialog.on_input_returnPressed"></a>
277 <h4>EricProcessDialog.on_input_returnPressed</h4>
278 <b>on_input_returnPressed</b>(<i></i>)
279
280 <p>
281 Private slot to handle the press of the return key in the input field.
282 </p>
283 <a NAME="EricProcessDialog.on_passwordCheckBox_toggled" ID="EricProcessDialog.on_passwordCheckBox_toggled"></a>
284 <h4>EricProcessDialog.on_passwordCheckBox_toggled</h4>
285 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
286
287 <p>
288 Private slot to handle the password checkbox toggled.
289 </p>
290 <dl>
291
292 <dt><i>isOn</i> (bool)</dt>
293 <dd>
294 flag indicating the status of the check box
295 </dd>
296 </dl>
297 <a NAME="EricProcessDialog.on_sendButton_clicked" ID="EricProcessDialog.on_sendButton_clicked"></a>
298 <h4>EricProcessDialog.on_sendButton_clicked</h4>
299 <b>on_sendButton_clicked</b>(<i></i>)
300
301 <p>
302 Private slot to send the input to the git process.
303 </p>
304 <a NAME="EricProcessDialog.startProcess" ID="EricProcessDialog.startProcess"></a>
305 <h4>EricProcessDialog.startProcess</h4>
306 <b>startProcess</b>(<i>program, args, workingDir=None, showArgs=True, environment=None</i>)
307
308 <p>
309 Public slot used to start the process.
310 </p>
311 <dl>
312
313 <dt><i>program</i> (str)</dt>
314 <dd>
315 path of the program to be executed
316 </dd>
317 <dt><i>args</i> (list of str)</dt>
318 <dd>
319 list of arguments for the process
320 </dd>
321 <dt><i>workingDir</i> (str)</dt>
322 <dd>
323 working directory for the process
324 </dd>
325 <dt><i>showArgs</i> (bool)</dt>
326 <dd>
327 flag indicating to show the arguments
328 </dd>
329 <dt><i>environment</i> (dict)</dt>
330 <dd>
331 dictionary of environment settings to add
332 or change for the process
333 </dd>
334 </dl>
335 <dl>
336 <dt>Return:</dt>
337 <dd>
338 flag indicating a successful start of the process
339 </dd>
340 </dl>
341 <dl>
342 <dt>Return Type:</dt>
343 <dd>
344 bool
345 </dd>
346 </dl>
347 <div align="right"><a href="#top">Up</a></div>
348 <hr />
349 </body></html>

Mercurial Repository: eric

eric ide

mercurial