Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgDialog.html

eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgDialog.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7370
5fb53279f2df
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.vcsMercurial.HgDialog</h1> 23 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgDialog</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="#HgDialog">HgDialog</a></td> 38 <td><a href="#HgDialog">HgDialog</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="HgDialog" ID="HgDialog"></a> 49 <a NAME="HgDialog" ID="HgDialog"></a>
43 <h2>HgDialog</h2> 50 <h2>HgDialog</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_HgDialog 61 QDialog, Ui_HgDialog
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="#HgDialog.__init__">HgDialog</a></td> 77 <td><a href="#HgDialog.__init__">HgDialog</a></td>
65 <td>Constructor</td> 78 <td>Constructor</td>
66 </tr><tr> 79 </tr>
80 <tr>
67 <td><a href="#HgDialog.__finish">__finish</a></td> 81 <td><a href="#HgDialog.__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="#HgDialog.__procFinished">__procFinished</a></td> 85 <td><a href="#HgDialog.__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="#HgDialog.__readStderr">__readStderr</a></td> 89 <td><a href="#HgDialog.__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="#HgDialog.__readStdout">__readStdout</a></td> 93 <td><a href="#HgDialog.__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="#HgDialog.__showError">__showError</a></td> 97 <td><a href="#HgDialog.__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="#HgDialog.__showOutput">__showOutput</a></td> 101 <td><a href="#HgDialog.__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="#HgDialog.hasAddOrDelete">hasAddOrDelete</a></td> 105 <td><a href="#HgDialog.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="#HgDialog.keyPressEvent">keyPressEvent</a></td> 109 <td><a href="#HgDialog.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="#HgDialog.normalExit">normalExit</a></td> 113 <td><a href="#HgDialog.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="#HgDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td> 117 <td><a href="#HgDialog.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="#HgDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td> 121 <td><a href="#HgDialog.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="#HgDialog.on_input_returnPressed">on_input_returnPressed</a></td> 125 <td><a href="#HgDialog.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="#HgDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td> 129 <td><a href="#HgDialog.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="#HgDialog.on_sendButton_clicked">on_sendButton_clicked</a></td> 133 <td><a href="#HgDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
107 <td>Private slot to send the input to the Mercurial process.</td> 134 <td>Private slot to send the input to the Mercurial process.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#HgDialog.startProcess">startProcess</a></td> 137 <td><a href="#HgDialog.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="HgDialog.__init__" ID="HgDialog.__init__"></a> 147 <a NAME="HgDialog.__init__" ID="HgDialog.__init__"></a>
118 <h4>HgDialog (Constructor)</h4> 148 <h4>HgDialog (Constructor)</h4>
119 <b>HgDialog</b>(<i>text, hg=None, useClient=True, parent=None</i>) 149 <b>HgDialog</b>(<i>text, hg=None, useClient=True, 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>hg</i></dt> 159 </dd>
160 <dt><i>hg</i></dt>
127 <dd> 161 <dd>
128 reference to the Mercurial interface object (Hg) 162 reference to the Mercurial interface object (Hg)
129 </dd><dt><i>useClient</i></dt> 163 </dd>
164 <dt><i>useClient</i></dt>
130 <dd> 165 <dd>
131 flag indicating to use the command server client 166 flag indicating to use the command server client
132 if possible (boolean) 167 if possible (boolean)
133 </dd><dt><i>parent</i></dt> 168 </dd>
169 <dt><i>parent</i></dt>
134 <dd> 170 <dd>
135 parent widget (QWidget) 171 parent widget (QWidget)
136 </dd> 172 </dd>
137 </dl><a NAME="HgDialog.__finish" ID="HgDialog.__finish"></a> 173 </dl>
174 <a NAME="HgDialog.__finish" ID="HgDialog.__finish"></a>
138 <h4>HgDialog.__finish</h4> 175 <h4>HgDialog.__finish</h4>
139 <b>__finish</b>(<i></i>) 176 <b>__finish</b>(<i></i>)
177
140 <p> 178 <p>
141 Private slot called when the process finished or the user pressed 179 Private slot called when the process finished or the user pressed
142 the button. 180 the button.
143 </p><a NAME="HgDialog.__procFinished" ID="HgDialog.__procFinished"></a> 181 </p>
182 <a NAME="HgDialog.__procFinished" ID="HgDialog.__procFinished"></a>
144 <h4>HgDialog.__procFinished</h4> 183 <h4>HgDialog.__procFinished</h4>
145 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 184 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
185
146 <p> 186 <p>
147 Private slot connected to the finished signal. 187 Private slot connected to the finished signal.
148 </p><dl> 188 </p>
189 <dl>
190
149 <dt><i>exitCode</i></dt> 191 <dt><i>exitCode</i></dt>
150 <dd> 192 <dd>
151 exit code of the process (integer) 193 exit code of the process (integer)
152 </dd><dt><i>exitStatus</i></dt> 194 </dd>
195 <dt><i>exitStatus</i></dt>
153 <dd> 196 <dd>
154 exit status of the process (QProcess.ExitStatus) 197 exit status of the process (QProcess.ExitStatus)
155 </dd> 198 </dd>
156 </dl><a NAME="HgDialog.__readStderr" ID="HgDialog.__readStderr"></a> 199 </dl>
200 <a NAME="HgDialog.__readStderr" ID="HgDialog.__readStderr"></a>
157 <h4>HgDialog.__readStderr</h4> 201 <h4>HgDialog.__readStderr</h4>
158 <b>__readStderr</b>(<i></i>) 202 <b>__readStderr</b>(<i></i>)
203
159 <p> 204 <p>
160 Private slot to handle the readyReadStandardError signal. 205 Private slot to handle the readyReadStandardError signal.
161 </p><p> 206 </p>
207 <p>
162 It reads the error output of the process and inserts it into the 208 It reads the error output of the process and inserts it into the
163 error pane. 209 error pane.
164 </p><a NAME="HgDialog.__readStdout" ID="HgDialog.__readStdout"></a> 210 </p>
211 <a NAME="HgDialog.__readStdout" ID="HgDialog.__readStdout"></a>
165 <h4>HgDialog.__readStdout</h4> 212 <h4>HgDialog.__readStdout</h4>
166 <b>__readStdout</b>(<i></i>) 213 <b>__readStdout</b>(<i></i>)
214
167 <p> 215 <p>
168 Private slot to handle the readyReadStandardOutput signal. 216 Private slot to handle the readyReadStandardOutput signal.
169 </p><p> 217 </p>
218 <p>
170 It reads the output of the process, formats it and inserts it into 219 It reads the output of the process, formats it and inserts it into
171 the contents pane. 220 the contents pane.
172 </p><a NAME="HgDialog.__showError" ID="HgDialog.__showError"></a> 221 </p>
222 <a NAME="HgDialog.__showError" ID="HgDialog.__showError"></a>
173 <h4>HgDialog.__showError</h4> 223 <h4>HgDialog.__showError</h4>
174 <b>__showError</b>(<i>out</i>) 224 <b>__showError</b>(<i>out</i>)
225
175 <p> 226 <p>
176 Private slot to show some error. 227 Private slot to show some error.
177 </p><dl> 228 </p>
229 <dl>
230
178 <dt><i>out</i></dt> 231 <dt><i>out</i></dt>
179 <dd> 232 <dd>
180 error to be shown (string) 233 error to be shown (string)
181 </dd> 234 </dd>
182 </dl><a NAME="HgDialog.__showOutput" ID="HgDialog.__showOutput"></a> 235 </dl>
236 <a NAME="HgDialog.__showOutput" ID="HgDialog.__showOutput"></a>
183 <h4>HgDialog.__showOutput</h4> 237 <h4>HgDialog.__showOutput</h4>
184 <b>__showOutput</b>(<i>out</i>) 238 <b>__showOutput</b>(<i>out</i>)
239
185 <p> 240 <p>
186 Private slot to show some output. 241 Private slot to show some output.
187 </p><dl> 242 </p>
243 <dl>
244
188 <dt><i>out</i></dt> 245 <dt><i>out</i></dt>
189 <dd> 246 <dd>
190 output to be shown (string) 247 output to be shown (string)
191 </dd> 248 </dd>
192 </dl><a NAME="HgDialog.hasAddOrDelete" ID="HgDialog.hasAddOrDelete"></a> 249 </dl>
250 <a NAME="HgDialog.hasAddOrDelete" ID="HgDialog.hasAddOrDelete"></a>
193 <h4>HgDialog.hasAddOrDelete</h4> 251 <h4>HgDialog.hasAddOrDelete</h4>
194 <b>hasAddOrDelete</b>(<i></i>) 252 <b>hasAddOrDelete</b>(<i></i>)
253
195 <p> 254 <p>
196 Public method to check, if the last action contained an add or delete. 255 Public method to check, if the last action contained an add or delete.
197 </p><dl> 256 </p>
257 <dl>
198 <dt>Returns:</dt> 258 <dt>Returns:</dt>
199 <dd> 259 <dd>
200 flag indicating the presence of an add or delete (boolean) 260 flag indicating the presence of an add or delete (boolean)
201 </dd> 261 </dd>
202 </dl><a NAME="HgDialog.keyPressEvent" ID="HgDialog.keyPressEvent"></a> 262 </dl>
263 <a NAME="HgDialog.keyPressEvent" ID="HgDialog.keyPressEvent"></a>
203 <h4>HgDialog.keyPressEvent</h4> 264 <h4>HgDialog.keyPressEvent</h4>
204 <b>keyPressEvent</b>(<i>evt</i>) 265 <b>keyPressEvent</b>(<i>evt</i>)
266
205 <p> 267 <p>
206 Protected slot to handle a key press event. 268 Protected slot to handle a key press event.
207 </p><dl> 269 </p>
270 <dl>
271
208 <dt><i>evt</i></dt> 272 <dt><i>evt</i></dt>
209 <dd> 273 <dd>
210 the key press event (QKeyEvent) 274 the key press event (QKeyEvent)
211 </dd> 275 </dd>
212 </dl><a NAME="HgDialog.normalExit" ID="HgDialog.normalExit"></a> 276 </dl>
277 <a NAME="HgDialog.normalExit" ID="HgDialog.normalExit"></a>
213 <h4>HgDialog.normalExit</h4> 278 <h4>HgDialog.normalExit</h4>
214 <b>normalExit</b>(<i></i>) 279 <b>normalExit</b>(<i></i>)
280
215 <p> 281 <p>
216 Public method to check for a normal process termination. 282 Public method to check for a normal process termination.
217 </p><dl> 283 </p>
284 <dl>
218 <dt>Returns:</dt> 285 <dt>Returns:</dt>
219 <dd> 286 <dd>
220 flag indicating normal process termination (boolean) 287 flag indicating normal process termination (boolean)
221 </dd> 288 </dd>
222 </dl><a NAME="HgDialog.normalExitWithoutErrors" ID="HgDialog.normalExitWithoutErrors"></a> 289 </dl>
290 <a NAME="HgDialog.normalExitWithoutErrors" ID="HgDialog.normalExitWithoutErrors"></a>
223 <h4>HgDialog.normalExitWithoutErrors</h4> 291 <h4>HgDialog.normalExitWithoutErrors</h4>
224 <b>normalExitWithoutErrors</b>(<i></i>) 292 <b>normalExitWithoutErrors</b>(<i></i>)
293
225 <p> 294 <p>
226 Public method to check for a normal process termination without 295 Public method to check for a normal process termination without
227 error messages. 296 error messages.
228 </p><dl> 297 </p>
298 <dl>
229 <dt>Returns:</dt> 299 <dt>Returns:</dt>
230 <dd> 300 <dd>
231 flag indicating normal process termination (boolean) 301 flag indicating normal process termination (boolean)
232 </dd> 302 </dd>
233 </dl><a NAME="HgDialog.on_buttonBox_clicked" ID="HgDialog.on_buttonBox_clicked"></a> 303 </dl>
304 <a NAME="HgDialog.on_buttonBox_clicked" ID="HgDialog.on_buttonBox_clicked"></a>
234 <h4>HgDialog.on_buttonBox_clicked</h4> 305 <h4>HgDialog.on_buttonBox_clicked</h4>
235 <b>on_buttonBox_clicked</b>(<i>button</i>) 306 <b>on_buttonBox_clicked</b>(<i>button</i>)
307
236 <p> 308 <p>
237 Private slot called by a button of the button box clicked. 309 Private slot called by a button of the button box clicked.
238 </p><dl> 310 </p>
311 <dl>
312
239 <dt><i>button</i></dt> 313 <dt><i>button</i></dt>
240 <dd> 314 <dd>
241 button that was clicked (QAbstractButton) 315 button that was clicked (QAbstractButton)
242 </dd> 316 </dd>
243 </dl><a NAME="HgDialog.on_input_returnPressed" ID="HgDialog.on_input_returnPressed"></a> 317 </dl>
318 <a NAME="HgDialog.on_input_returnPressed" ID="HgDialog.on_input_returnPressed"></a>
244 <h4>HgDialog.on_input_returnPressed</h4> 319 <h4>HgDialog.on_input_returnPressed</h4>
245 <b>on_input_returnPressed</b>(<i></i>) 320 <b>on_input_returnPressed</b>(<i></i>)
321
246 <p> 322 <p>
247 Private slot to handle the press of the return key in the input field. 323 Private slot to handle the press of the return key in the input field.
248 </p><a NAME="HgDialog.on_passwordCheckBox_toggled" ID="HgDialog.on_passwordCheckBox_toggled"></a> 324 </p>
325 <a NAME="HgDialog.on_passwordCheckBox_toggled" ID="HgDialog.on_passwordCheckBox_toggled"></a>
249 <h4>HgDialog.on_passwordCheckBox_toggled</h4> 326 <h4>HgDialog.on_passwordCheckBox_toggled</h4>
250 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 327 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
328
251 <p> 329 <p>
252 Private slot to handle the password checkbox toggled. 330 Private slot to handle the password checkbox toggled.
253 </p><dl> 331 </p>
332 <dl>
333
254 <dt><i>isOn</i></dt> 334 <dt><i>isOn</i></dt>
255 <dd> 335 <dd>
256 flag indicating the status of the check box (boolean) 336 flag indicating the status of the check box (boolean)
257 </dd> 337 </dd>
258 </dl><a NAME="HgDialog.on_sendButton_clicked" ID="HgDialog.on_sendButton_clicked"></a> 338 </dl>
339 <a NAME="HgDialog.on_sendButton_clicked" ID="HgDialog.on_sendButton_clicked"></a>
259 <h4>HgDialog.on_sendButton_clicked</h4> 340 <h4>HgDialog.on_sendButton_clicked</h4>
260 <b>on_sendButton_clicked</b>(<i></i>) 341 <b>on_sendButton_clicked</b>(<i></i>)
342
261 <p> 343 <p>
262 Private slot to send the input to the Mercurial process. 344 Private slot to send the input to the Mercurial process.
263 </p><a NAME="HgDialog.startProcess" ID="HgDialog.startProcess"></a> 345 </p>
346 <a NAME="HgDialog.startProcess" ID="HgDialog.startProcess"></a>
264 <h4>HgDialog.startProcess</h4> 347 <h4>HgDialog.startProcess</h4>
265 <b>startProcess</b>(<i>args, workingDir=None, showArgs=True, environment=None</i>) 348 <b>startProcess</b>(<i>args, workingDir=None, showArgs=True, environment=None</i>)
349
266 <p> 350 <p>
267 Public slot used to start the process. 351 Public slot used to start the process.
268 </p><dl> 352 </p>
353 <dl>
354
269 <dt><i>args</i></dt> 355 <dt><i>args</i></dt>
270 <dd> 356 <dd>
271 list of arguments for the process (list of strings) 357 list of arguments for the process (list of strings)
272 </dd><dt><i>workingDir=</i></dt> 358 </dd>
359 <dt><i>workingDir=</i></dt>
273 <dd> 360 <dd>
274 working directory for the process (string) 361 working directory for the process (string)
275 </dd><dt><i>showArgs=</i></dt> 362 </dd>
363 <dt><i>showArgs=</i></dt>
276 <dd> 364 <dd>
277 flag indicating to show the arguments (boolean) 365 flag indicating to show the arguments (boolean)
278 </dd><dt><i>environment=</i></dt> 366 </dd>
367 <dt><i>environment=</i></dt>
279 <dd> 368 <dd>
280 dictionary of environment settings to add 369 dictionary of environment settings to add
281 or change for the git process (dict of string and string) 370 or change for the git process (dict of string and string)
282 </dd> 371 </dd>
283 </dl><dl> 372 </dl>
373 <dl>
284 <dt>Returns:</dt> 374 <dt>Returns:</dt>
285 <dd> 375 <dd>
286 flag indicating a successful start of the process 376 flag indicating a successful start of the process
287 </dd> 377 </dd>
288 </dl> 378 </dl>

Mercurial Repository: eric

eric ide

mercurial