Mercurial Repositories > eric / file comparison

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

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog.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.SvnDiffDialog</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.SvnDiffDialog</h1>
24
25 <p>
26 Module implementing a dialog to show the output of the svn diff command
27 process.
28 </p>
29 <h3>Global Attributes</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <h3>Classes</h3>
35
36 <table>
37
38 <tr>
39 <td><a href="#SvnDiffDialog">SvnDiffDialog</a></td>
40 <td>Class implementing a dialog to show the output of the svn diff command process.</td>
41 </tr>
42 </table>
43 <h3>Functions</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <hr />
49 <hr />
50 <a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a>
51 <h2>SvnDiffDialog</h2>
52
53 <p>
54 Class implementing a dialog to show the output of the svn diff command
55 process.
56 </p>
57 <h3>Derived from</h3>
58 QWidget, Ui_SvnDiffDialog
59 <h3>Class Attributes</h3>
60
61 <table>
62 <tr><td>None</td></tr>
63 </table>
64 <h3>Class Methods</h3>
65
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <h3>Methods</h3>
70
71 <table>
72
73 <tr>
74 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td>
75 <td>Constructor</td>
76 </tr>
77 <tr>
78 <td><a href="#SvnDiffDialog.__appendText">__appendText</a></td>
79 <td>Private method to append text to the end of the contents pane.</td>
80 </tr>
81 <tr>
82 <td><a href="#SvnDiffDialog.__extractFileName">__extractFileName</a></td>
83 <td>Private method to extract the file name out of a file separator line.</td>
84 </tr>
85 <tr>
86 <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td>
87 <td>Private method to get a svn revision argument for the given revision.</td>
88 </tr>
89 <tr>
90 <td><a href="#SvnDiffDialog.__procFinished">__procFinished</a></td>
91 <td>Private slot connected to the finished signal.</td>
92 </tr>
93 <tr>
94 <td><a href="#SvnDiffDialog.__processFileLine">__processFileLine</a></td>
95 <td>Private slot to process a line giving the old/new file.</td>
96 </tr>
97 <tr>
98 <td><a href="#SvnDiffDialog.__readStderr">__readStderr</a></td>
99 <td>Private slot to handle the readyReadStandardError signal.</td>
100 </tr>
101 <tr>
102 <td><a href="#SvnDiffDialog.__readStdout">__readStdout</a></td>
103 <td>Private slot to handle the readyReadStandardOutput signal.</td>
104 </tr>
105 <tr>
106 <td><a href="#SvnDiffDialog.closeEvent">closeEvent</a></td>
107 <td>Protected slot implementing a close event handler.</td>
108 </tr>
109 <tr>
110 <td><a href="#SvnDiffDialog.keyPressEvent">keyPressEvent</a></td>
111 <td>Protected slot to handle a key press event.</td>
112 </tr>
113 <tr>
114 <td><a href="#SvnDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
115 <td>Private slot called by a button of the button box clicked.</td>
116 </tr>
117 <tr>
118 <td><a href="#SvnDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td>
119 <td>Private slot to handle the selection of a file.</td>
120 </tr>
121 <tr>
122 <td><a href="#SvnDiffDialog.on_input_returnPressed">on_input_returnPressed</a></td>
123 <td>Private slot to handle the press of the return key in the input field.</td>
124 </tr>
125 <tr>
126 <td><a href="#SvnDiffDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
127 <td>Private slot to handle the password checkbox toggled.</td>
128 </tr>
129 <tr>
130 <td><a href="#SvnDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
131 <td>Private slot to refresh the display.</td>
132 </tr>
133 <tr>
134 <td><a href="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
135 <td>Private slot to handle the Save button press.</td>
136 </tr>
137 <tr>
138 <td><a href="#SvnDiffDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
139 <td>Private slot to send the input to the subversion process.</td>
140 </tr>
141 <tr>
142 <td><a href="#SvnDiffDialog.start">start</a></td>
143 <td>Public slot to start the svn diff command.</td>
144 </tr>
145 </table>
146 <h3>Static Methods</h3>
147
148 <table>
149 <tr><td>None</td></tr>
150 </table>
151
152 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a>
153 <h4>SvnDiffDialog (Constructor)</h4>
154 <b>SvnDiffDialog</b>(<i>vcs, parent=None</i>)
155
156 <p>
157 Constructor
158 </p>
159 <dl>
160
161 <dt><i>vcs</i></dt>
162 <dd>
163 reference to the vcs object
164 </dd>
165 <dt><i>parent</i></dt>
166 <dd>
167 parent widget (QWidget)
168 </dd>
169 </dl>
170 <a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a>
171 <h4>SvnDiffDialog.__appendText</h4>
172 <b>__appendText</b>(<i>txt</i>)
173
174 <p>
175 Private method to append text to the end of the contents pane.
176 </p>
177 <dl>
178
179 <dt><i>txt</i></dt>
180 <dd>
181 text to insert (string)
182 </dd>
183 </dl>
184 <a NAME="SvnDiffDialog.__extractFileName" ID="SvnDiffDialog.__extractFileName"></a>
185 <h4>SvnDiffDialog.__extractFileName</h4>
186 <b>__extractFileName</b>(<i>line</i>)
187
188 <p>
189 Private method to extract the file name out of a file separator line.
190 </p>
191 <dl>
192
193 <dt><i>line</i></dt>
194 <dd>
195 line to be processed (string)
196 </dd>
197 </dl>
198 <dl>
199 <dt>Return:</dt>
200 <dd>
201 extracted file name (string)
202 </dd>
203 </dl>
204 <a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a>
205 <h4>SvnDiffDialog.__getVersionArg</h4>
206 <b>__getVersionArg</b>(<i>version</i>)
207
208 <p>
209 Private method to get a svn revision argument for the given revision.
210 </p>
211 <dl>
212
213 <dt><i>version</i></dt>
214 <dd>
215 revision (integer or string)
216 </dd>
217 </dl>
218 <dl>
219 <dt>Return:</dt>
220 <dd>
221 version argument (string)
222 </dd>
223 </dl>
224 <a NAME="SvnDiffDialog.__procFinished" ID="SvnDiffDialog.__procFinished"></a>
225 <h4>SvnDiffDialog.__procFinished</h4>
226 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
227
228 <p>
229 Private slot connected to the finished signal.
230 </p>
231 <dl>
232
233 <dt><i>exitCode</i></dt>
234 <dd>
235 exit code of the process (integer)
236 </dd>
237 <dt><i>exitStatus</i></dt>
238 <dd>
239 exit status of the process (QProcess.ExitStatus)
240 </dd>
241 </dl>
242 <a NAME="SvnDiffDialog.__processFileLine" ID="SvnDiffDialog.__processFileLine"></a>
243 <h4>SvnDiffDialog.__processFileLine</h4>
244 <b>__processFileLine</b>(<i>line</i>)
245
246 <p>
247 Private slot to process a line giving the old/new file.
248 </p>
249 <dl>
250
251 <dt><i>line</i></dt>
252 <dd>
253 line to be processed (string)
254 </dd>
255 </dl>
256 <a NAME="SvnDiffDialog.__readStderr" ID="SvnDiffDialog.__readStderr"></a>
257 <h4>SvnDiffDialog.__readStderr</h4>
258 <b>__readStderr</b>(<i></i>)
259
260 <p>
261 Private slot to handle the readyReadStandardError signal.
262 </p>
263 <p>
264 It reads the error output of the process and inserts it into the
265 error pane.
266 </p>
267 <a NAME="SvnDiffDialog.__readStdout" ID="SvnDiffDialog.__readStdout"></a>
268 <h4>SvnDiffDialog.__readStdout</h4>
269 <b>__readStdout</b>(<i></i>)
270
271 <p>
272 Private slot to handle the readyReadStandardOutput signal.
273 </p>
274 <p>
275 It reads the output of the process, formats it and inserts it into
276 the contents pane.
277 </p>
278 <a NAME="SvnDiffDialog.closeEvent" ID="SvnDiffDialog.closeEvent"></a>
279 <h4>SvnDiffDialog.closeEvent</h4>
280 <b>closeEvent</b>(<i>e</i>)
281
282 <p>
283 Protected slot implementing a close event handler.
284 </p>
285 <dl>
286
287 <dt><i>e</i></dt>
288 <dd>
289 close event (QCloseEvent)
290 </dd>
291 </dl>
292 <a NAME="SvnDiffDialog.keyPressEvent" ID="SvnDiffDialog.keyPressEvent"></a>
293 <h4>SvnDiffDialog.keyPressEvent</h4>
294 <b>keyPressEvent</b>(<i>evt</i>)
295
296 <p>
297 Protected slot to handle a key press event.
298 </p>
299 <dl>
300
301 <dt><i>evt</i></dt>
302 <dd>
303 the key press event (QKeyEvent)
304 </dd>
305 </dl>
306 <a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a>
307 <h4>SvnDiffDialog.on_buttonBox_clicked</h4>
308 <b>on_buttonBox_clicked</b>(<i>button</i>)
309
310 <p>
311 Private slot called by a button of the button box clicked.
312 </p>
313 <dl>
314
315 <dt><i>button</i></dt>
316 <dd>
317 button that was clicked (QAbstractButton)
318 </dd>
319 </dl>
320 <a NAME="SvnDiffDialog.on_filesCombo_activated" ID="SvnDiffDialog.on_filesCombo_activated"></a>
321 <h4>SvnDiffDialog.on_filesCombo_activated</h4>
322 <b>on_filesCombo_activated</b>(<i>index</i>)
323
324 <p>
325 Private slot to handle the selection of a file.
326 </p>
327 <dl>
328
329 <dt><i>index</i></dt>
330 <dd>
331 activated row (integer)
332 </dd>
333 </dl>
334 <a NAME="SvnDiffDialog.on_input_returnPressed" ID="SvnDiffDialog.on_input_returnPressed"></a>
335 <h4>SvnDiffDialog.on_input_returnPressed</h4>
336 <b>on_input_returnPressed</b>(<i></i>)
337
338 <p>
339 Private slot to handle the press of the return key in the input field.
340 </p>
341 <a NAME="SvnDiffDialog.on_passwordCheckBox_toggled" ID="SvnDiffDialog.on_passwordCheckBox_toggled"></a>
342 <h4>SvnDiffDialog.on_passwordCheckBox_toggled</h4>
343 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
344
345 <p>
346 Private slot to handle the password checkbox toggled.
347 </p>
348 <dl>
349
350 <dt><i>isOn</i></dt>
351 <dd>
352 flag indicating the status of the check box (boolean)
353 </dd>
354 </dl>
355 <a NAME="SvnDiffDialog.on_refreshButton_clicked" ID="SvnDiffDialog.on_refreshButton_clicked"></a>
356 <h4>SvnDiffDialog.on_refreshButton_clicked</h4>
357 <b>on_refreshButton_clicked</b>(<i></i>)
358
359 <p>
360 Private slot to refresh the display.
361 </p>
362 <a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a>
363 <h4>SvnDiffDialog.on_saveButton_clicked</h4>
364 <b>on_saveButton_clicked</b>(<i></i>)
365
366 <p>
367 Private slot to handle the Save button press.
368 </p>
369 <p>
370 It saves the diff shown in the dialog to a file in the local
371 filesystem.
372 </p>
373 <a NAME="SvnDiffDialog.on_sendButton_clicked" ID="SvnDiffDialog.on_sendButton_clicked"></a>
374 <h4>SvnDiffDialog.on_sendButton_clicked</h4>
375 <b>on_sendButton_clicked</b>(<i></i>)
376
377 <p>
378 Private slot to send the input to the subversion process.
379 </p>
380 <a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a>
381 <h4>SvnDiffDialog.start</h4>
382 <b>start</b>(<i>fn, versions=None, urls=None, summary=False, refreshable=False</i>)
383
384 <p>
385 Public slot to start the svn diff command.
386 </p>
387 <dl>
388
389 <dt><i>fn</i></dt>
390 <dd>
391 filename to be diffed (string)
392 </dd>
393 <dt><i>versions</i></dt>
394 <dd>
395 list of versions to be diffed (list of up to 2 strings
396 or None)
397 </dd>
398 <dt><i>urls</i></dt>
399 <dd>
400 list of repository URLs (list of 2 strings)
401 </dd>
402 <dt><i>summary</i></dt>
403 <dd>
404 flag indicating a summarizing diff
405 (only valid for URL diffs) (boolean)
406 </dd>
407 <dt><i>refreshable</i></dt>
408 <dd>
409 flag indicating a refreshable diff (boolean)
410 </dd>
411 </dl>
412 <div align="right"><a href="#top">Up</a></div>
413 <hr />
414 </body></html>

Mercurial Repository: eric

eric ide

mercurial