Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDialog.html

src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitDialog.html

branch
eric7
changeset 10479
856476537696
parent 10438
4cd7e5a8b3cf
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
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>eric7.Plugins.VcsPlugins.vcsGit.GitDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsGit.GitDialog</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="#GitDialog">GitDialog</a></td> 22 <td><a href="#GitDialog">GitDialog</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="GitDialog" ID="GitDialog"></a> 34 <a NAME="GitDialog" ID="GitDialog"></a>
36 <h2>GitDialog</h2> 35 <h2>GitDialog</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_GitDialog 46 QDialog, Ui_GitDialog
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="#GitDialog.__init__">GitDialog</a></td> 60 <td><a href="#GitDialog.__init__">GitDialog</a></td>
64 <td>Constructor</td> 61 <td>Constructor</td>
65 </tr> 62 </tr>
66 <tr> 63 <tr>
122 <tr> 119 <tr>
123 <td><a href="#GitDialog.startProcess">startProcess</a></td> 120 <td><a href="#GitDialog.startProcess">startProcess</a></td>
124 <td>Public slot used to start the process.</td> 121 <td>Public slot used to start the process.</td>
125 </tr> 122 </tr>
126 </table> 123 </table>
124
127 <h3>Static Methods</h3> 125 <h3>Static Methods</h3>
128 126 <table>
129 <table> 127 <tr><td>None</td></tr>
130 <tr><td>None</td></tr> 128 </table>
131 </table> 129
132 130
133 <a NAME="GitDialog.__init__" ID="GitDialog.__init__"></a> 131 <a NAME="GitDialog.__init__" ID="GitDialog.__init__"></a>
134 <h4>GitDialog (Constructor)</h4> 132 <h4>GitDialog (Constructor)</h4>
135 <b>GitDialog</b>(<i>text, git=None, parent=None</i>) 133 <b>GitDialog</b>(<i>text, git=None, parent=None</i>)
136
137 <p> 134 <p>
138 Constructor 135 Constructor
139 </p> 136 </p>
137
140 <dl> 138 <dl>
141 139
142 <dt><i>text</i> (str)</dt> 140 <dt><i>text</i> (str)</dt>
143 <dd> 141 <dd>
144 text to be shown by the label 142 text to be shown by the label
153 </dd> 151 </dd>
154 </dl> 152 </dl>
155 <a NAME="GitDialog.__finish" ID="GitDialog.__finish"></a> 153 <a NAME="GitDialog.__finish" ID="GitDialog.__finish"></a>
156 <h4>GitDialog.__finish</h4> 154 <h4>GitDialog.__finish</h4>
157 <b>__finish</b>(<i></i>) 155 <b>__finish</b>(<i></i>)
158
159 <p> 156 <p>
160 Private slot called when the process finished or the user pressed 157 Private slot called when the process finished or the user pressed
161 the button. 158 the button.
162 </p> 159 </p>
160
163 <a NAME="GitDialog.__procFinished" ID="GitDialog.__procFinished"></a> 161 <a NAME="GitDialog.__procFinished" ID="GitDialog.__procFinished"></a>
164 <h4>GitDialog.__procFinished</h4> 162 <h4>GitDialog.__procFinished</h4>
165 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 163 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
166
167 <p> 164 <p>
168 Private slot connected to the finished signal. 165 Private slot connected to the finished signal.
169 </p> 166 </p>
167
170 <dl> 168 <dl>
171 169
172 <dt><i>exitCode</i> (int)</dt> 170 <dt><i>exitCode</i> (int)</dt>
173 <dd> 171 <dd>
174 exit code of the process 172 exit code of the process
179 </dd> 177 </dd>
180 </dl> 178 </dl>
181 <a NAME="GitDialog.__readStderr" ID="GitDialog.__readStderr"></a> 179 <a NAME="GitDialog.__readStderr" ID="GitDialog.__readStderr"></a>
182 <h4>GitDialog.__readStderr</h4> 180 <h4>GitDialog.__readStderr</h4>
183 <b>__readStderr</b>(<i></i>) 181 <b>__readStderr</b>(<i></i>)
184
185 <p> 182 <p>
186 Private slot to handle the readyReadStandardError signal. 183 Private slot to handle the readyReadStandardError signal.
187 </p> 184 </p>
188 <p> 185 <p>
189 It reads the error output of the process and inserts it into the 186 It reads the error output of the process and inserts it into the
190 error pane. 187 error pane.
191 </p> 188 </p>
189
192 <a NAME="GitDialog.__readStdout" ID="GitDialog.__readStdout"></a> 190 <a NAME="GitDialog.__readStdout" ID="GitDialog.__readStdout"></a>
193 <h4>GitDialog.__readStdout</h4> 191 <h4>GitDialog.__readStdout</h4>
194 <b>__readStdout</b>(<i></i>) 192 <b>__readStdout</b>(<i></i>)
195
196 <p> 193 <p>
197 Private slot to handle the readyReadStandardOutput signal. 194 Private slot to handle the readyReadStandardOutput signal.
198 </p> 195 </p>
199 <p> 196 <p>
200 It reads the output of the process, formats it and inserts it into 197 It reads the output of the process, formats it and inserts it into
201 the contents pane. 198 the contents pane.
202 </p> 199 </p>
200
203 <a NAME="GitDialog.__showError" ID="GitDialog.__showError"></a> 201 <a NAME="GitDialog.__showError" ID="GitDialog.__showError"></a>
204 <h4>GitDialog.__showError</h4> 202 <h4>GitDialog.__showError</h4>
205 <b>__showError</b>(<i>out</i>) 203 <b>__showError</b>(<i>out</i>)
206
207 <p> 204 <p>
208 Private slot to show some error. 205 Private slot to show some error.
209 </p> 206 </p>
207
210 <dl> 208 <dl>
211 209
212 <dt><i>out</i> (str)</dt> 210 <dt><i>out</i> (str)</dt>
213 <dd> 211 <dd>
214 error to be shown 212 error to be shown
215 </dd> 213 </dd>
216 </dl> 214 </dl>
217 <a NAME="GitDialog.__showOutput" ID="GitDialog.__showOutput"></a> 215 <a NAME="GitDialog.__showOutput" ID="GitDialog.__showOutput"></a>
218 <h4>GitDialog.__showOutput</h4> 216 <h4>GitDialog.__showOutput</h4>
219 <b>__showOutput</b>(<i>out</i>) 217 <b>__showOutput</b>(<i>out</i>)
220
221 <p> 218 <p>
222 Private slot to show some output. 219 Private slot to show some output.
223 </p> 220 </p>
221
224 <dl> 222 <dl>
225 223
226 <dt><i>out</i> (str)</dt> 224 <dt><i>out</i> (str)</dt>
227 <dd> 225 <dd>
228 output to be shown 226 output to be shown
229 </dd> 227 </dd>
230 </dl> 228 </dl>
231 <a NAME="GitDialog.hasAddOrDelete" ID="GitDialog.hasAddOrDelete"></a> 229 <a NAME="GitDialog.hasAddOrDelete" ID="GitDialog.hasAddOrDelete"></a>
232 <h4>GitDialog.hasAddOrDelete</h4> 230 <h4>GitDialog.hasAddOrDelete</h4>
233 <b>hasAddOrDelete</b>(<i></i>) 231 <b>hasAddOrDelete</b>(<i></i>)
234
235 <p> 232 <p>
236 Public method to check, if the last action contained an add or delete. 233 Public method to check, if the last action contained an add or delete.
237 </p> 234 </p>
235
238 <dl> 236 <dl>
239 <dt>Return:</dt> 237 <dt>Return:</dt>
240 <dd> 238 <dd>
241 flag indicating the presence of an add or delete 239 flag indicating the presence of an add or delete
242 </dd> 240 </dd>
248 </dd> 246 </dd>
249 </dl> 247 </dl>
250 <a NAME="GitDialog.keyPressEvent" ID="GitDialog.keyPressEvent"></a> 248 <a NAME="GitDialog.keyPressEvent" ID="GitDialog.keyPressEvent"></a>
251 <h4>GitDialog.keyPressEvent</h4> 249 <h4>GitDialog.keyPressEvent</h4>
252 <b>keyPressEvent</b>(<i>evt</i>) 250 <b>keyPressEvent</b>(<i>evt</i>)
253
254 <p> 251 <p>
255 Protected slot to handle a key press event. 252 Protected slot to handle a key press event.
256 </p> 253 </p>
254
257 <dl> 255 <dl>
258 256
259 <dt><i>evt</i> (QKeyEvent)</dt> 257 <dt><i>evt</i> (QKeyEvent)</dt>
260 <dd> 258 <dd>
261 the key press event 259 the key press event
262 </dd> 260 </dd>
263 </dl> 261 </dl>
264 <a NAME="GitDialog.normalExit" ID="GitDialog.normalExit"></a> 262 <a NAME="GitDialog.normalExit" ID="GitDialog.normalExit"></a>
265 <h4>GitDialog.normalExit</h4> 263 <h4>GitDialog.normalExit</h4>
266 <b>normalExit</b>(<i></i>) 264 <b>normalExit</b>(<i></i>)
267
268 <p> 265 <p>
269 Public method to check for a normal process termination. 266 Public method to check for a normal process termination.
270 </p> 267 </p>
268
271 <dl> 269 <dl>
272 <dt>Return:</dt> 270 <dt>Return:</dt>
273 <dd> 271 <dd>
274 flag indicating normal process termination 272 flag indicating normal process termination
275 </dd> 273 </dd>
281 </dd> 279 </dd>
282 </dl> 280 </dl>
283 <a NAME="GitDialog.normalExitWithoutErrors" ID="GitDialog.normalExitWithoutErrors"></a> 281 <a NAME="GitDialog.normalExitWithoutErrors" ID="GitDialog.normalExitWithoutErrors"></a>
284 <h4>GitDialog.normalExitWithoutErrors</h4> 282 <h4>GitDialog.normalExitWithoutErrors</h4>
285 <b>normalExitWithoutErrors</b>(<i></i>) 283 <b>normalExitWithoutErrors</b>(<i></i>)
286
287 <p> 284 <p>
288 Public method to check for a normal process termination without 285 Public method to check for a normal process termination without
289 error messages. 286 error messages.
290 </p> 287 </p>
288
291 <dl> 289 <dl>
292 <dt>Return:</dt> 290 <dt>Return:</dt>
293 <dd> 291 <dd>
294 flag indicating normal process termination 292 flag indicating normal process termination
295 </dd> 293 </dd>
301 </dd> 299 </dd>
302 </dl> 300 </dl>
303 <a NAME="GitDialog.on_buttonBox_clicked" ID="GitDialog.on_buttonBox_clicked"></a> 301 <a NAME="GitDialog.on_buttonBox_clicked" ID="GitDialog.on_buttonBox_clicked"></a>
304 <h4>GitDialog.on_buttonBox_clicked</h4> 302 <h4>GitDialog.on_buttonBox_clicked</h4>
305 <b>on_buttonBox_clicked</b>(<i>button</i>) 303 <b>on_buttonBox_clicked</b>(<i>button</i>)
306
307 <p> 304 <p>
308 Private slot called by a button of the button box clicked. 305 Private slot called by a button of the button box clicked.
309 </p> 306 </p>
307
310 <dl> 308 <dl>
311 309
312 <dt><i>button</i> (QAbstractButton)</dt> 310 <dt><i>button</i> (QAbstractButton)</dt>
313 <dd> 311 <dd>
314 button that was clicked 312 button that was clicked
315 </dd> 313 </dd>
316 </dl> 314 </dl>
317 <a NAME="GitDialog.on_input_returnPressed" ID="GitDialog.on_input_returnPressed"></a> 315 <a NAME="GitDialog.on_input_returnPressed" ID="GitDialog.on_input_returnPressed"></a>
318 <h4>GitDialog.on_input_returnPressed</h4> 316 <h4>GitDialog.on_input_returnPressed</h4>
319 <b>on_input_returnPressed</b>(<i></i>) 317 <b>on_input_returnPressed</b>(<i></i>)
320
321 <p> 318 <p>
322 Private slot to handle the press of the return key in the input field. 319 Private slot to handle the press of the return key in the input field.
323 </p> 320 </p>
321
324 <a NAME="GitDialog.on_passwordCheckBox_toggled" ID="GitDialog.on_passwordCheckBox_toggled"></a> 322 <a NAME="GitDialog.on_passwordCheckBox_toggled" ID="GitDialog.on_passwordCheckBox_toggled"></a>
325 <h4>GitDialog.on_passwordCheckBox_toggled</h4> 323 <h4>GitDialog.on_passwordCheckBox_toggled</h4>
326 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 324 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
327
328 <p> 325 <p>
329 Private slot to handle the password checkbox toggled. 326 Private slot to handle the password checkbox toggled.
330 </p> 327 </p>
328
331 <dl> 329 <dl>
332 330
333 <dt><i>isOn</i> (bool)</dt> 331 <dt><i>isOn</i> (bool)</dt>
334 <dd> 332 <dd>
335 flag indicating the status of the check box 333 flag indicating the status of the check box
336 </dd> 334 </dd>
337 </dl> 335 </dl>
338 <a NAME="GitDialog.on_sendButton_clicked" ID="GitDialog.on_sendButton_clicked"></a> 336 <a NAME="GitDialog.on_sendButton_clicked" ID="GitDialog.on_sendButton_clicked"></a>
339 <h4>GitDialog.on_sendButton_clicked</h4> 337 <h4>GitDialog.on_sendButton_clicked</h4>
340 <b>on_sendButton_clicked</b>(<i></i>) 338 <b>on_sendButton_clicked</b>(<i></i>)
341
342 <p> 339 <p>
343 Private slot to send the input to the git process. 340 Private slot to send the input to the git process.
344 </p> 341 </p>
342
345 <a NAME="GitDialog.startProcess" ID="GitDialog.startProcess"></a> 343 <a NAME="GitDialog.startProcess" ID="GitDialog.startProcess"></a>
346 <h4>GitDialog.startProcess</h4> 344 <h4>GitDialog.startProcess</h4>
347 <b>startProcess</b>(<i>args, workingDir=None, showArgs=True, environment=None</i>) 345 <b>startProcess</b>(<i>args, workingDir=None, showArgs=True, environment=None</i>)
348
349 <p> 346 <p>
350 Public slot used to start the process. 347 Public slot used to start the process.
351 </p> 348 </p>
349
352 <dl> 350 <dl>
353 351
354 <dt><i>args</i> (list of str)</dt> 352 <dt><i>args</i> (list of str)</dt>
355 <dd> 353 <dd>
356 list of arguments for the process 354 list of arguments for the process

Mercurial Repository: eric

eric ide

mercurial