Mercurial Repositories > eric / file comparison

comparison: eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog.html

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog.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.Plugins.VcsPlugins.vcsSubversion.SvnDialog</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.Plugins.VcsPlugins.vcsSubversion.SvnDialog</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="#SvnDialog">SvnDialog</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="SvnDialog" ID="SvnDialog"></a>
50 <h2>SvnDialog</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
57 shows the output of the process. The dialog is modal,
58 which causes a synchronized execution of the process.
59 </p>
60 <h3>Derived from</h3>
61 QDialog, Ui_SvnDialog
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="#SvnDialog.__init__">SvnDialog</a></td>
78 <td>Constructor</td>
79 </tr>
80 <tr>
81 <td><a href="#SvnDialog.__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="#SvnDialog.__procFinished">__procFinished</a></td>
86 <td>Private slot connected to the finished signal.</td>
87 </tr>
88 <tr>
89 <td><a href="#SvnDialog.__readStderr">__readStderr</a></td>
90 <td>Private slot to handle the readyReadStderr signal.</td>
91 </tr>
92 <tr>
93 <td><a href="#SvnDialog.__readStdout">__readStdout</a></td>
94 <td>Private slot to handle the readyReadStdout signal.</td>
95 </tr>
96 <tr>
97 <td><a href="#SvnDialog.hasAddOrDelete">hasAddOrDelete</a></td>
98 <td>Public method to check, if the last action contained an add or delete.</td>
99 </tr>
100 <tr>
101 <td><a href="#SvnDialog.keyPressEvent">keyPressEvent</a></td>
102 <td>Protected slot to handle a key press event.</td>
103 </tr>
104 <tr>
105 <td><a href="#SvnDialog.normalExit">normalExit</a></td>
106 <td>Public method to check for a normal process termination.</td>
107 </tr>
108 <tr>
109 <td><a href="#SvnDialog.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="#SvnDialog.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="#SvnDialog.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="#SvnDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
122 <td>Private slot to send the input to the subversion process.</td>
123 </tr>
124 <tr>
125 <td><a href="#SvnDialog.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="SvnDialog.__init__" ID="SvnDialog.__init__"></a>
136 <h4>SvnDialog (Constructor)</h4>
137 <b>SvnDialog</b>(<i>text, parent=None</i>)
138
139 <p>
140 Constructor
141 </p>
142 <dl>
143
144 <dt><i>text</i></dt>
145 <dd>
146 text to be shown by the label (string)
147 </dd>
148 <dt><i>parent</i></dt>
149 <dd>
150 parent widget (QWidget)
151 </dd>
152 </dl>
153 <a NAME="SvnDialog.__finish" ID="SvnDialog.__finish"></a>
154 <h4>SvnDialog.__finish</h4>
155 <b>__finish</b>(<i></i>)
156
157 <p>
158 Private slot called when the process finished or the user pressed the
159 button.
160 </p>
161 <a NAME="SvnDialog.__procFinished" ID="SvnDialog.__procFinished"></a>
162 <h4>SvnDialog.__procFinished</h4>
163 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
164
165 <p>
166 Private slot connected to the finished signal.
167 </p>
168 <dl>
169
170 <dt><i>exitCode</i></dt>
171 <dd>
172 exit code of the process (integer)
173 </dd>
174 <dt><i>exitStatus</i></dt>
175 <dd>
176 exit status of the process (QProcess.ExitStatus)
177 </dd>
178 </dl>
179 <a NAME="SvnDialog.__readStderr" ID="SvnDialog.__readStderr"></a>
180 <h4>SvnDialog.__readStderr</h4>
181 <b>__readStderr</b>(<i></i>)
182
183 <p>
184 Private slot to handle the readyReadStderr signal.
185 </p>
186 <p>
187 It reads the error output of the process and inserts it into the
188 error pane.
189 </p>
190 <a NAME="SvnDialog.__readStdout" ID="SvnDialog.__readStdout"></a>
191 <h4>SvnDialog.__readStdout</h4>
192 <b>__readStdout</b>(<i></i>)
193
194 <p>
195 Private slot to handle the readyReadStdout signal.
196 </p>
197 <p>
198 It reads the output of the process, formats it and inserts it into
199 the contents pane.
200 </p>
201 <a NAME="SvnDialog.hasAddOrDelete" ID="SvnDialog.hasAddOrDelete"></a>
202 <h4>SvnDialog.hasAddOrDelete</h4>
203 <b>hasAddOrDelete</b>(<i></i>)
204
205 <p>
206 Public method to check, if the last action contained an add or delete.
207 </p>
208 <dl>
209 <dt>Return:</dt>
210 <dd>
211 flag indicating the presence of an add or delete (boolean)
212 </dd>
213 </dl>
214 <a NAME="SvnDialog.keyPressEvent" ID="SvnDialog.keyPressEvent"></a>
215 <h4>SvnDialog.keyPressEvent</h4>
216 <b>keyPressEvent</b>(<i>evt</i>)
217
218 <p>
219 Protected slot to handle a key press event.
220 </p>
221 <dl>
222
223 <dt><i>evt</i></dt>
224 <dd>
225 the key press event (QKeyEvent)
226 </dd>
227 </dl>
228 <a NAME="SvnDialog.normalExit" ID="SvnDialog.normalExit"></a>
229 <h4>SvnDialog.normalExit</h4>
230 <b>normalExit</b>(<i></i>)
231
232 <p>
233 Public method to check for a normal process termination.
234 </p>
235 <dl>
236 <dt>Return:</dt>
237 <dd>
238 flag indicating normal process termination (boolean)
239 </dd>
240 </dl>
241 <a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a>
242 <h4>SvnDialog.on_buttonBox_clicked</h4>
243 <b>on_buttonBox_clicked</b>(<i>button</i>)
244
245 <p>
246 Private slot called by a button of the button box clicked.
247 </p>
248 <dl>
249
250 <dt><i>button</i></dt>
251 <dd>
252 button that was clicked (QAbstractButton)
253 </dd>
254 </dl>
255 <a NAME="SvnDialog.on_input_returnPressed" ID="SvnDialog.on_input_returnPressed"></a>
256 <h4>SvnDialog.on_input_returnPressed</h4>
257 <b>on_input_returnPressed</b>(<i></i>)
258
259 <p>
260 Private slot to handle the press of the return key in the input field.
261 </p>
262 <a NAME="SvnDialog.on_passwordCheckBox_toggled" ID="SvnDialog.on_passwordCheckBox_toggled"></a>
263 <h4>SvnDialog.on_passwordCheckBox_toggled</h4>
264 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
265
266 <p>
267 Private slot to handle the password checkbox toggled.
268 </p>
269 <dl>
270
271 <dt><i>isOn</i></dt>
272 <dd>
273 flag indicating the status of the check box (boolean)
274 </dd>
275 </dl>
276 <a NAME="SvnDialog.on_sendButton_clicked" ID="SvnDialog.on_sendButton_clicked"></a>
277 <h4>SvnDialog.on_sendButton_clicked</h4>
278 <b>on_sendButton_clicked</b>(<i></i>)
279
280 <p>
281 Private slot to send the input to the subversion process.
282 </p>
283 <a NAME="SvnDialog.startProcess" ID="SvnDialog.startProcess"></a>
284 <h4>SvnDialog.startProcess</h4>
285 <b>startProcess</b>(<i>args, workingDir=None, setLanguage=False</i>)
286
287 <p>
288 Public slot used to start the process.
289 </p>
290 <dl>
291
292 <dt><i>args</i></dt>
293 <dd>
294 list of arguments for the process (list of strings)
295 </dd>
296 <dt><i>workingDir</i></dt>
297 <dd>
298 working directory for the process (string)
299 </dd>
300 <dt><i>setLanguage</i></dt>
301 <dd>
302 flag indicating to set the language to "C" (boolean)
303 </dd>
304 </dl>
305 <dl>
306 <dt>Return:</dt>
307 <dd>
308 flag indicating a successful start of the process
309 </dd>
310 </dl>
311 <div align="right"><a href="#top">Up</a></div>
312 <hr />
313 </body></html>

Mercurial Repository: eric

eric ide

mercurial