src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog.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.vcsSubversion.SvnDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsSubversion.SvnDialog</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="#SvnDialog">SvnDialog</a></td> 22 <td><a href="#SvnDialog">SvnDialog</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="SvnDialog" ID="SvnDialog"></a> 34 <a NAME="SvnDialog" ID="SvnDialog"></a>
36 <h2>SvnDialog</h2> 35 <h2>SvnDialog</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_SvnDialog 46 QDialog, Ui_SvnDialog
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="#SvnDialog.__init__">SvnDialog</a></td> 60 <td><a href="#SvnDialog.__init__">SvnDialog</a></td>
64 <td>Constructor</td> 61 <td>Constructor</td>
65 </tr> 62 </tr>
66 <tr> 63 <tr>
110 <tr> 107 <tr>
111 <td><a href="#SvnDialog.startProcess">startProcess</a></td> 108 <td><a href="#SvnDialog.startProcess">startProcess</a></td>
112 <td>Public slot used to start the process.</td> 109 <td>Public slot used to start the process.</td>
113 </tr> 110 </tr>
114 </table> 111 </table>
112
115 <h3>Static Methods</h3> 113 <h3>Static Methods</h3>
116 114 <table>
117 <table> 115 <tr><td>None</td></tr>
118 <tr><td>None</td></tr> 116 </table>
119 </table> 117
120 118
121 <a NAME="SvnDialog.__init__" ID="SvnDialog.__init__"></a> 119 <a NAME="SvnDialog.__init__" ID="SvnDialog.__init__"></a>
122 <h4>SvnDialog (Constructor)</h4> 120 <h4>SvnDialog (Constructor)</h4>
123 <b>SvnDialog</b>(<i>text, parent=None</i>) 121 <b>SvnDialog</b>(<i>text, parent=None</i>)
124
125 <p> 122 <p>
126 Constructor 123 Constructor
127 </p> 124 </p>
125
128 <dl> 126 <dl>
129 127
130 <dt><i>text</i> (str)</dt> 128 <dt><i>text</i> (str)</dt>
131 <dd> 129 <dd>
132 text to be shown by the label 130 text to be shown by the label
137 </dd> 135 </dd>
138 </dl> 136 </dl>
139 <a NAME="SvnDialog.__finish" ID="SvnDialog.__finish"></a> 137 <a NAME="SvnDialog.__finish" ID="SvnDialog.__finish"></a>
140 <h4>SvnDialog.__finish</h4> 138 <h4>SvnDialog.__finish</h4>
141 <b>__finish</b>(<i></i>) 139 <b>__finish</b>(<i></i>)
142
143 <p> 140 <p>
144 Private slot called when the process finished or the user pressed the 141 Private slot called when the process finished or the user pressed the
145 button. 142 button.
146 </p> 143 </p>
144
147 <a NAME="SvnDialog.__procFinished" ID="SvnDialog.__procFinished"></a> 145 <a NAME="SvnDialog.__procFinished" ID="SvnDialog.__procFinished"></a>
148 <h4>SvnDialog.__procFinished</h4> 146 <h4>SvnDialog.__procFinished</h4>
149 <b>__procFinished</b>(<i>exitCode, exitStatus</i>) 147 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
150
151 <p> 148 <p>
152 Private slot connected to the finished signal. 149 Private slot connected to the finished signal.
153 </p> 150 </p>
151
154 <dl> 152 <dl>
155 153
156 <dt><i>exitCode</i> (int)</dt> 154 <dt><i>exitCode</i> (int)</dt>
157 <dd> 155 <dd>
158 exit code of the process 156 exit code of the process
163 </dd> 161 </dd>
164 </dl> 162 </dl>
165 <a NAME="SvnDialog.__readStderr" ID="SvnDialog.__readStderr"></a> 163 <a NAME="SvnDialog.__readStderr" ID="SvnDialog.__readStderr"></a>
166 <h4>SvnDialog.__readStderr</h4> 164 <h4>SvnDialog.__readStderr</h4>
167 <b>__readStderr</b>(<i></i>) 165 <b>__readStderr</b>(<i></i>)
168
169 <p> 166 <p>
170 Private slot to handle the readyReadStderr signal. 167 Private slot to handle the readyReadStderr signal.
171 </p> 168 </p>
172 <p> 169 <p>
173 It reads the error output of the process and inserts it into the 170 It reads the error output of the process and inserts it into the
174 error pane. 171 error pane.
175 </p> 172 </p>
173
176 <a NAME="SvnDialog.__readStdout" ID="SvnDialog.__readStdout"></a> 174 <a NAME="SvnDialog.__readStdout" ID="SvnDialog.__readStdout"></a>
177 <h4>SvnDialog.__readStdout</h4> 175 <h4>SvnDialog.__readStdout</h4>
178 <b>__readStdout</b>(<i></i>) 176 <b>__readStdout</b>(<i></i>)
179
180 <p> 177 <p>
181 Private slot to handle the readyReadStdout signal. 178 Private slot to handle the readyReadStdout signal.
182 </p> 179 </p>
183 <p> 180 <p>
184 It reads the output of the process, formats it and inserts it into 181 It reads the output of the process, formats it and inserts it into
185 the contents pane. 182 the contents pane.
186 </p> 183 </p>
184
187 <a NAME="SvnDialog.hasAddOrDelete" ID="SvnDialog.hasAddOrDelete"></a> 185 <a NAME="SvnDialog.hasAddOrDelete" ID="SvnDialog.hasAddOrDelete"></a>
188 <h4>SvnDialog.hasAddOrDelete</h4> 186 <h4>SvnDialog.hasAddOrDelete</h4>
189 <b>hasAddOrDelete</b>(<i></i>) 187 <b>hasAddOrDelete</b>(<i></i>)
190
191 <p> 188 <p>
192 Public method to check, if the last action contained an add or delete. 189 Public method to check, if the last action contained an add or delete.
193 </p> 190 </p>
191
194 <dl> 192 <dl>
195 <dt>Return:</dt> 193 <dt>Return:</dt>
196 <dd> 194 <dd>
197 flag indicating the presence of an add or delete 195 flag indicating the presence of an add or delete
198 </dd> 196 </dd>
204 </dd> 202 </dd>
205 </dl> 203 </dl>
206 <a NAME="SvnDialog.keyPressEvent" ID="SvnDialog.keyPressEvent"></a> 204 <a NAME="SvnDialog.keyPressEvent" ID="SvnDialog.keyPressEvent"></a>
207 <h4>SvnDialog.keyPressEvent</h4> 205 <h4>SvnDialog.keyPressEvent</h4>
208 <b>keyPressEvent</b>(<i>evt</i>) 206 <b>keyPressEvent</b>(<i>evt</i>)
209
210 <p> 207 <p>
211 Protected slot to handle a key press event. 208 Protected slot to handle a key press event.
212 </p> 209 </p>
210
213 <dl> 211 <dl>
214 212
215 <dt><i>evt</i> (QKeyEvent)</dt> 213 <dt><i>evt</i> (QKeyEvent)</dt>
216 <dd> 214 <dd>
217 the key press event 215 the key press event
218 </dd> 216 </dd>
219 </dl> 217 </dl>
220 <a NAME="SvnDialog.normalExit" ID="SvnDialog.normalExit"></a> 218 <a NAME="SvnDialog.normalExit" ID="SvnDialog.normalExit"></a>
221 <h4>SvnDialog.normalExit</h4> 219 <h4>SvnDialog.normalExit</h4>
222 <b>normalExit</b>(<i></i>) 220 <b>normalExit</b>(<i></i>)
223
224 <p> 221 <p>
225 Public method to check for a normal process termination. 222 Public method to check for a normal process termination.
226 </p> 223 </p>
224
227 <dl> 225 <dl>
228 <dt>Return:</dt> 226 <dt>Return:</dt>
229 <dd> 227 <dd>
230 flag indicating normal process termination 228 flag indicating normal process termination
231 </dd> 229 </dd>
237 </dd> 235 </dd>
238 </dl> 236 </dl>
239 <a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a> 237 <a NAME="SvnDialog.on_buttonBox_clicked" ID="SvnDialog.on_buttonBox_clicked"></a>
240 <h4>SvnDialog.on_buttonBox_clicked</h4> 238 <h4>SvnDialog.on_buttonBox_clicked</h4>
241 <b>on_buttonBox_clicked</b>(<i>button</i>) 239 <b>on_buttonBox_clicked</b>(<i>button</i>)
242
243 <p> 240 <p>
244 Private slot called by a button of the button box clicked. 241 Private slot called by a button of the button box clicked.
245 </p> 242 </p>
243
246 <dl> 244 <dl>
247 245
248 <dt><i>button</i> (QAbstractButton)</dt> 246 <dt><i>button</i> (QAbstractButton)</dt>
249 <dd> 247 <dd>
250 button that was clicked 248 button that was clicked
251 </dd> 249 </dd>
252 </dl> 250 </dl>
253 <a NAME="SvnDialog.on_input_returnPressed" ID="SvnDialog.on_input_returnPressed"></a> 251 <a NAME="SvnDialog.on_input_returnPressed" ID="SvnDialog.on_input_returnPressed"></a>
254 <h4>SvnDialog.on_input_returnPressed</h4> 252 <h4>SvnDialog.on_input_returnPressed</h4>
255 <b>on_input_returnPressed</b>(<i></i>) 253 <b>on_input_returnPressed</b>(<i></i>)
256
257 <p> 254 <p>
258 Private slot to handle the press of the return key in the input field. 255 Private slot to handle the press of the return key in the input field.
259 </p> 256 </p>
257
260 <a NAME="SvnDialog.on_passwordCheckBox_toggled" ID="SvnDialog.on_passwordCheckBox_toggled"></a> 258 <a NAME="SvnDialog.on_passwordCheckBox_toggled" ID="SvnDialog.on_passwordCheckBox_toggled"></a>
261 <h4>SvnDialog.on_passwordCheckBox_toggled</h4> 259 <h4>SvnDialog.on_passwordCheckBox_toggled</h4>
262 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>) 260 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
263
264 <p> 261 <p>
265 Private slot to handle the password checkbox toggled. 262 Private slot to handle the password checkbox toggled.
266 </p> 263 </p>
264
267 <dl> 265 <dl>
268 266
269 <dt><i>isOn</i> (bool)</dt> 267 <dt><i>isOn</i> (bool)</dt>
270 <dd> 268 <dd>
271 flag indicating the status of the check box 269 flag indicating the status of the check box
272 </dd> 270 </dd>
273 </dl> 271 </dl>
274 <a NAME="SvnDialog.on_sendButton_clicked" ID="SvnDialog.on_sendButton_clicked"></a> 272 <a NAME="SvnDialog.on_sendButton_clicked" ID="SvnDialog.on_sendButton_clicked"></a>
275 <h4>SvnDialog.on_sendButton_clicked</h4> 273 <h4>SvnDialog.on_sendButton_clicked</h4>
276 <b>on_sendButton_clicked</b>(<i></i>) 274 <b>on_sendButton_clicked</b>(<i></i>)
277
278 <p> 275 <p>
279 Private slot to send the input to the subversion process. 276 Private slot to send the input to the subversion process.
280 </p> 277 </p>
278
281 <a NAME="SvnDialog.startProcess" ID="SvnDialog.startProcess"></a> 279 <a NAME="SvnDialog.startProcess" ID="SvnDialog.startProcess"></a>
282 <h4>SvnDialog.startProcess</h4> 280 <h4>SvnDialog.startProcess</h4>
283 <b>startProcess</b>(<i>args, workingDir=None, setLanguage=False</i>) 281 <b>startProcess</b>(<i>args, workingDir=None, setLanguage=False</i>)
284
285 <p> 282 <p>
286 Public slot used to start the process. 283 Public slot used to start the process.
287 </p> 284 </p>
285
288 <dl> 286 <dl>
289 287
290 <dt><i>args</i> (list of str)</dt> 288 <dt><i>args</i> (list of str)</dt>
291 <dd> 289 <dd>
292 list of arguments for the process 290 list of arguments for the process

eric ide

mercurial