Mercurial Repositories > eric / file comparison

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

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

changeset 3673
e26d7d0c1088
child 5283
06423d65a2b8
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Plugins.VcsPlugins.vcsMercurial.HgDialog</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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsMercurial.HgDialog</h1>
23 <p>
24 Module implementing a dialog starting a process and showing its output.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#HgDialog">HgDialog</a></td>
34 <td>Class implementing a dialog starting a process and showing its output.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="HgDialog" ID="HgDialog"></a>
43 <h2>HgDialog</h2>
44 <p>
45 Class implementing a dialog starting a process and showing its output.
46 </p><p>
47 It starts a QProcess and displays a dialog that
48 shows the output of the process. The dialog is modal,
49 which causes a synchronized execution of the process.
50 </p>
51 <h3>Derived from</h3>
52 QDialog, Ui_HgDialog
53 <h3>Class Attributes</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Class Methods</h3>
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62 <table>
63 <tr>
64 <td><a href="#HgDialog.__init__">HgDialog</a></td>
65 <td>Constructor</td>
66 </tr><tr>
67 <td><a href="#HgDialog.__finish">__finish</a></td>
68 <td>Private slot called when the process finished or the user pressed the button.</td>
69 </tr><tr>
70 <td><a href="#HgDialog.__procFinished">__procFinished</a></td>
71 <td>Private slot connected to the finished signal.</td>
72 </tr><tr>
73 <td><a href="#HgDialog.__readStderr">__readStderr</a></td>
74 <td>Private slot to handle the readyReadStandardError signal.</td>
75 </tr><tr>
76 <td><a href="#HgDialog.__readStdout">__readStdout</a></td>
77 <td>Private slot to handle the readyReadStandardOutput signal.</td>
78 </tr><tr>
79 <td><a href="#HgDialog.__showError">__showError</a></td>
80 <td>Private slot to show some error.</td>
81 </tr><tr>
82 <td><a href="#HgDialog.__showOutput">__showOutput</a></td>
83 <td>Private slot to show some output.</td>
84 </tr><tr>
85 <td><a href="#HgDialog.hasAddOrDelete">hasAddOrDelete</a></td>
86 <td>Public method to check, if the last action contained an add or delete.</td>
87 </tr><tr>
88 <td><a href="#HgDialog.keyPressEvent">keyPressEvent</a></td>
89 <td>Protected slot to handle a key press event.</td>
90 </tr><tr>
91 <td><a href="#HgDialog.normalExit">normalExit</a></td>
92 <td>Public method to check for a normal process termination.</td>
93 </tr><tr>
94 <td><a href="#HgDialog.normalExitWithoutErrors">normalExitWithoutErrors</a></td>
95 <td>Public method to check for a normal process termination without error messages.</td>
96 </tr><tr>
97 <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>
99 </tr><tr>
100 <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>
102 </tr><tr>
103 <td><a href="#HgDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
104 <td>Private slot to handle the password checkbox toggled.</td>
105 </tr><tr>
106 <td><a href="#HgDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
107 <td>Private slot to send the input to the subversion process.</td>
108 </tr><tr>
109 <td><a href="#HgDialog.startProcess">startProcess</a></td>
110 <td>Public slot used to start the process.</td>
111 </tr>
112 </table>
113 <h3>Static Methods</h3>
114 <table>
115 <tr><td>None</td></tr>
116 </table>
117 <a NAME="HgDialog.__init__" ID="HgDialog.__init__"></a>
118 <h4>HgDialog (Constructor)</h4>
119 <b>HgDialog</b>(<i>text, hg=None, useClient=True, parent=None</i>)
120 <p>
121 Constructor
122 </p><dl>
123 <dt><i>text</i></dt>
124 <dd>
125 text to be shown by the label (string)
126 </dd><dt><i>hg</i></dt>
127 <dd>
128 reference to the Mercurial interface object (Hg)
129 </dd><dt><i>useClient</i></dt>
130 <dd>
131 flag indicating to use the command server client
132 if possible (boolean)
133 </dd><dt><i>parent</i></dt>
134 <dd>
135 parent widget (QWidget)
136 </dd>
137 </dl><a NAME="HgDialog.__finish" ID="HgDialog.__finish"></a>
138 <h4>HgDialog.__finish</h4>
139 <b>__finish</b>(<i></i>)
140 <p>
141 Private slot called when the process finished or the user pressed
142 the button.
143 </p><a NAME="HgDialog.__procFinished" ID="HgDialog.__procFinished"></a>
144 <h4>HgDialog.__procFinished</h4>
145 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
146 <p>
147 Private slot connected to the finished signal.
148 </p><dl>
149 <dt><i>exitCode</i></dt>
150 <dd>
151 exit code of the process (integer)
152 </dd><dt><i>exitStatus</i></dt>
153 <dd>
154 exit status of the process (QProcess.ExitStatus)
155 </dd>
156 </dl><a NAME="HgDialog.__readStderr" ID="HgDialog.__readStderr"></a>
157 <h4>HgDialog.__readStderr</h4>
158 <b>__readStderr</b>(<i></i>)
159 <p>
160 Private slot to handle the readyReadStandardError signal.
161 </p><p>
162 It reads the error output of the process and inserts it into the
163 error pane.
164 </p><a NAME="HgDialog.__readStdout" ID="HgDialog.__readStdout"></a>
165 <h4>HgDialog.__readStdout</h4>
166 <b>__readStdout</b>(<i></i>)
167 <p>
168 Private slot to handle the readyReadStandardOutput signal.
169 </p><p>
170 It reads the output of the process, formats it and inserts it into
171 the contents pane.
172 </p><a NAME="HgDialog.__showError" ID="HgDialog.__showError"></a>
173 <h4>HgDialog.__showError</h4>
174 <b>__showError</b>(<i>out</i>)
175 <p>
176 Private slot to show some error.
177 </p><dl>
178 <dt><i>out</i></dt>
179 <dd>
180 error to be shown (string)
181 </dd>
182 </dl><a NAME="HgDialog.__showOutput" ID="HgDialog.__showOutput"></a>
183 <h4>HgDialog.__showOutput</h4>
184 <b>__showOutput</b>(<i>out</i>)
185 <p>
186 Private slot to show some output.
187 </p><dl>
188 <dt><i>out</i></dt>
189 <dd>
190 output to be shown (string)
191 </dd>
192 </dl><a NAME="HgDialog.hasAddOrDelete" ID="HgDialog.hasAddOrDelete"></a>
193 <h4>HgDialog.hasAddOrDelete</h4>
194 <b>hasAddOrDelete</b>(<i></i>)
195 <p>
196 Public method to check, if the last action contained an add or delete.
197 </p><dl>
198 <dt>Returns:</dt>
199 <dd>
200 flag indicating the presence of an add or delete (boolean)
201 </dd>
202 </dl><a NAME="HgDialog.keyPressEvent" ID="HgDialog.keyPressEvent"></a>
203 <h4>HgDialog.keyPressEvent</h4>
204 <b>keyPressEvent</b>(<i>evt</i>)
205 <p>
206 Protected slot to handle a key press event.
207 </p><dl>
208 <dt><i>evt</i></dt>
209 <dd>
210 the key press event (QKeyEvent)
211 </dd>
212 </dl><a NAME="HgDialog.normalExit" ID="HgDialog.normalExit"></a>
213 <h4>HgDialog.normalExit</h4>
214 <b>normalExit</b>(<i></i>)
215 <p>
216 Public method to check for a normal process termination.
217 </p><dl>
218 <dt>Returns:</dt>
219 <dd>
220 flag indicating normal process termination (boolean)
221 </dd>
222 </dl><a NAME="HgDialog.normalExitWithoutErrors" ID="HgDialog.normalExitWithoutErrors"></a>
223 <h4>HgDialog.normalExitWithoutErrors</h4>
224 <b>normalExitWithoutErrors</b>(<i></i>)
225 <p>
226 Public method to check for a normal process termination without
227 error messages.
228 </p><dl>
229 <dt>Returns:</dt>
230 <dd>
231 flag indicating normal process termination (boolean)
232 </dd>
233 </dl><a NAME="HgDialog.on_buttonBox_clicked" ID="HgDialog.on_buttonBox_clicked"></a>
234 <h4>HgDialog.on_buttonBox_clicked</h4>
235 <b>on_buttonBox_clicked</b>(<i>button</i>)
236 <p>
237 Private slot called by a button of the button box clicked.
238 </p><dl>
239 <dt><i>button</i></dt>
240 <dd>
241 button that was clicked (QAbstractButton)
242 </dd>
243 </dl><a NAME="HgDialog.on_input_returnPressed" ID="HgDialog.on_input_returnPressed"></a>
244 <h4>HgDialog.on_input_returnPressed</h4>
245 <b>on_input_returnPressed</b>(<i></i>)
246 <p>
247 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>
249 <h4>HgDialog.on_passwordCheckBox_toggled</h4>
250 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
251 <p>
252 Private slot to handle the password checkbox toggled.
253 </p><dl>
254 <dt><i>isOn</i></dt>
255 <dd>
256 flag indicating the status of the check box (boolean)
257 </dd>
258 </dl><a NAME="HgDialog.on_sendButton_clicked" ID="HgDialog.on_sendButton_clicked"></a>
259 <h4>HgDialog.on_sendButton_clicked</h4>
260 <b>on_sendButton_clicked</b>(<i></i>)
261 <p>
262 Private slot to send the input to the subversion process.
263 </p><a NAME="HgDialog.startProcess" ID="HgDialog.startProcess"></a>
264 <h4>HgDialog.startProcess</h4>
265 <b>startProcess</b>(<i>args, workingDir=None, showArgs=True</i>)
266 <p>
267 Public slot used to start the process.
268 </p><dl>
269 <dt><i>args</i></dt>
270 <dd>
271 list of arguments for the process (list of strings)
272 </dd><dt><i>workingDir=</i></dt>
273 <dd>
274 working directory for the process (string)
275 </dd><dt><i>showArgs=</i></dt>
276 <dd>
277 flag indicating to show the arguments (boolean)
278 </dd>
279 </dl><dl>
280 <dt>Returns:</dt>
281 <dd>
282 flag indicating a successful start of the process
283 </dd>
284 </dl>
285 <div align="right"><a href="#top">Up</a></div>
286 <hr />
287 </body></html>

Mercurial Repository: eric

eric ide

mercurial