Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDialog.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitDialog.html

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

Mercurial Repository: eric

eric ide

mercurial