eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog.html

changeset 6942
2602857055c5
parent 4110
5a106c734527
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.VcsPlugins.vcsSubversion.SvnDiffDialog</h1>
23 <p>
24 Module implementing a dialog to show the output of the svn diff command
25 process.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#SvnDiffDialog">SvnDiffDialog</a></td>
35 <td>Class implementing a dialog to show the output of the svn diff command process.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a>
44 <h2>SvnDiffDialog</h2>
45 <p>
46 Class implementing a dialog to show the output of the svn diff command
47 process.
48 </p>
49 <h3>Derived from</h3>
50 QWidget, Ui_SvnDiffDialog
51 <h3>Class Attributes</h3>
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Class Methods</h3>
56 <table>
57 <tr><td>None</td></tr>
58 </table>
59 <h3>Methods</h3>
60 <table>
61 <tr>
62 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td>
63 <td>Constructor</td>
64 </tr><tr>
65 <td><a href="#SvnDiffDialog.__appendText">__appendText</a></td>
66 <td>Private method to append text to the end of the contents pane.</td>
67 </tr><tr>
68 <td><a href="#SvnDiffDialog.__extractFileName">__extractFileName</a></td>
69 <td>Private method to extract the file name out of a file separator line.</td>
70 </tr><tr>
71 <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td>
72 <td>Private method to get a svn revision argument for the given revision.</td>
73 </tr><tr>
74 <td><a href="#SvnDiffDialog.__procFinished">__procFinished</a></td>
75 <td>Private slot connected to the finished signal.</td>
76 </tr><tr>
77 <td><a href="#SvnDiffDialog.__processFileLine">__processFileLine</a></td>
78 <td>Private slot to process a line giving the old/new file.</td>
79 </tr><tr>
80 <td><a href="#SvnDiffDialog.__readStderr">__readStderr</a></td>
81 <td>Private slot to handle the readyReadStandardError signal.</td>
82 </tr><tr>
83 <td><a href="#SvnDiffDialog.__readStdout">__readStdout</a></td>
84 <td>Private slot to handle the readyReadStandardOutput signal.</td>
85 </tr><tr>
86 <td><a href="#SvnDiffDialog.closeEvent">closeEvent</a></td>
87 <td>Protected slot implementing a close event handler.</td>
88 </tr><tr>
89 <td><a href="#SvnDiffDialog.keyPressEvent">keyPressEvent</a></td>
90 <td>Protected slot to handle a key press event.</td>
91 </tr><tr>
92 <td><a href="#SvnDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
93 <td>Private slot called by a button of the button box clicked.</td>
94 </tr><tr>
95 <td><a href="#SvnDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td>
96 <td>Private slot to handle the selection of a file.</td>
97 </tr><tr>
98 <td><a href="#SvnDiffDialog.on_input_returnPressed">on_input_returnPressed</a></td>
99 <td>Private slot to handle the press of the return key in the input field.</td>
100 </tr><tr>
101 <td><a href="#SvnDiffDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
102 <td>Private slot to handle the password checkbox toggled.</td>
103 </tr><tr>
104 <td><a href="#SvnDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
105 <td>Private slot to refresh the display.</td>
106 </tr><tr>
107 <td><a href="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
108 <td>Private slot to handle the Save button press.</td>
109 </tr><tr>
110 <td><a href="#SvnDiffDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
111 <td>Private slot to send the input to the subversion process.</td>
112 </tr><tr>
113 <td><a href="#SvnDiffDialog.start">start</a></td>
114 <td>Public slot to start the svn diff command.</td>
115 </tr>
116 </table>
117 <h3>Static Methods</h3>
118 <table>
119 <tr><td>None</td></tr>
120 </table>
121 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a>
122 <h4>SvnDiffDialog (Constructor)</h4>
123 <b>SvnDiffDialog</b>(<i>vcs, parent=None</i>)
124 <p>
125 Constructor
126 </p><dl>
127 <dt><i>vcs</i></dt>
128 <dd>
129 reference to the vcs object
130 </dd><dt><i>parent</i></dt>
131 <dd>
132 parent widget (QWidget)
133 </dd>
134 </dl><a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a>
135 <h4>SvnDiffDialog.__appendText</h4>
136 <b>__appendText</b>(<i>txt</i>)
137 <p>
138 Private method to append text to the end of the contents pane.
139 </p><dl>
140 <dt><i>txt</i></dt>
141 <dd>
142 text to insert (string)
143 </dd>
144 </dl><a NAME="SvnDiffDialog.__extractFileName" ID="SvnDiffDialog.__extractFileName"></a>
145 <h4>SvnDiffDialog.__extractFileName</h4>
146 <b>__extractFileName</b>(<i>line</i>)
147 <p>
148 Private method to extract the file name out of a file separator line.
149 </p><dl>
150 <dt><i>line</i></dt>
151 <dd>
152 line to be processed (string)
153 </dd>
154 </dl><dl>
155 <dt>Returns:</dt>
156 <dd>
157 extracted file name (string)
158 </dd>
159 </dl><a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a>
160 <h4>SvnDiffDialog.__getVersionArg</h4>
161 <b>__getVersionArg</b>(<i>version</i>)
162 <p>
163 Private method to get a svn revision argument for the given revision.
164 </p><dl>
165 <dt><i>version</i></dt>
166 <dd>
167 revision (integer or string)
168 </dd>
169 </dl><dl>
170 <dt>Returns:</dt>
171 <dd>
172 version argument (string)
173 </dd>
174 </dl><a NAME="SvnDiffDialog.__procFinished" ID="SvnDiffDialog.__procFinished"></a>
175 <h4>SvnDiffDialog.__procFinished</h4>
176 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
177 <p>
178 Private slot connected to the finished signal.
179 </p><dl>
180 <dt><i>exitCode</i></dt>
181 <dd>
182 exit code of the process (integer)
183 </dd><dt><i>exitStatus</i></dt>
184 <dd>
185 exit status of the process (QProcess.ExitStatus)
186 </dd>
187 </dl><a NAME="SvnDiffDialog.__processFileLine" ID="SvnDiffDialog.__processFileLine"></a>
188 <h4>SvnDiffDialog.__processFileLine</h4>
189 <b>__processFileLine</b>(<i>line</i>)
190 <p>
191 Private slot to process a line giving the old/new file.
192 </p><dl>
193 <dt><i>line</i></dt>
194 <dd>
195 line to be processed (string)
196 </dd>
197 </dl><a NAME="SvnDiffDialog.__readStderr" ID="SvnDiffDialog.__readStderr"></a>
198 <h4>SvnDiffDialog.__readStderr</h4>
199 <b>__readStderr</b>(<i></i>)
200 <p>
201 Private slot to handle the readyReadStandardError signal.
202 </p><p>
203 It reads the error output of the process and inserts it into the
204 error pane.
205 </p><a NAME="SvnDiffDialog.__readStdout" ID="SvnDiffDialog.__readStdout"></a>
206 <h4>SvnDiffDialog.__readStdout</h4>
207 <b>__readStdout</b>(<i></i>)
208 <p>
209 Private slot to handle the readyReadStandardOutput signal.
210 </p><p>
211 It reads the output of the process, formats it and inserts it into
212 the contents pane.
213 </p><a NAME="SvnDiffDialog.closeEvent" ID="SvnDiffDialog.closeEvent"></a>
214 <h4>SvnDiffDialog.closeEvent</h4>
215 <b>closeEvent</b>(<i>e</i>)
216 <p>
217 Protected slot implementing a close event handler.
218 </p><dl>
219 <dt><i>e</i></dt>
220 <dd>
221 close event (QCloseEvent)
222 </dd>
223 </dl><a NAME="SvnDiffDialog.keyPressEvent" ID="SvnDiffDialog.keyPressEvent"></a>
224 <h4>SvnDiffDialog.keyPressEvent</h4>
225 <b>keyPressEvent</b>(<i>evt</i>)
226 <p>
227 Protected slot to handle a key press event.
228 </p><dl>
229 <dt><i>evt</i></dt>
230 <dd>
231 the key press event (QKeyEvent)
232 </dd>
233 </dl><a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a>
234 <h4>SvnDiffDialog.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="SvnDiffDialog.on_filesCombo_activated" ID="SvnDiffDialog.on_filesCombo_activated"></a>
244 <h4>SvnDiffDialog.on_filesCombo_activated</h4>
245 <b>on_filesCombo_activated</b>(<i>index</i>)
246 <p>
247 Private slot to handle the selection of a file.
248 </p><dl>
249 <dt><i>index</i></dt>
250 <dd>
251 activated row (integer)
252 </dd>
253 </dl><a NAME="SvnDiffDialog.on_input_returnPressed" ID="SvnDiffDialog.on_input_returnPressed"></a>
254 <h4>SvnDiffDialog.on_input_returnPressed</h4>
255 <b>on_input_returnPressed</b>(<i></i>)
256 <p>
257 Private slot to handle the press of the return key in the input field.
258 </p><a NAME="SvnDiffDialog.on_passwordCheckBox_toggled" ID="SvnDiffDialog.on_passwordCheckBox_toggled"></a>
259 <h4>SvnDiffDialog.on_passwordCheckBox_toggled</h4>
260 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
261 <p>
262 Private slot to handle the password checkbox toggled.
263 </p><dl>
264 <dt><i>isOn</i></dt>
265 <dd>
266 flag indicating the status of the check box (boolean)
267 </dd>
268 </dl><a NAME="SvnDiffDialog.on_refreshButton_clicked" ID="SvnDiffDialog.on_refreshButton_clicked"></a>
269 <h4>SvnDiffDialog.on_refreshButton_clicked</h4>
270 <b>on_refreshButton_clicked</b>(<i></i>)
271 <p>
272 Private slot to refresh the display.
273 </p><a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a>
274 <h4>SvnDiffDialog.on_saveButton_clicked</h4>
275 <b>on_saveButton_clicked</b>(<i></i>)
276 <p>
277 Private slot to handle the Save button press.
278 </p><p>
279 It saves the diff shown in the dialog to a file in the local
280 filesystem.
281 </p><a NAME="SvnDiffDialog.on_sendButton_clicked" ID="SvnDiffDialog.on_sendButton_clicked"></a>
282 <h4>SvnDiffDialog.on_sendButton_clicked</h4>
283 <b>on_sendButton_clicked</b>(<i></i>)
284 <p>
285 Private slot to send the input to the subversion process.
286 </p><a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a>
287 <h4>SvnDiffDialog.start</h4>
288 <b>start</b>(<i>fn, versions=None, urls=None, summary=False, refreshable=False</i>)
289 <p>
290 Public slot to start the svn diff command.
291 </p><dl>
292 <dt><i>fn</i></dt>
293 <dd>
294 filename to be diffed (string)
295 </dd><dt><i>versions</i></dt>
296 <dd>
297 list of versions to be diffed (list of up to 2 strings
298 or None)
299 </dd><dt><i>urls=</i></dt>
300 <dd>
301 list of repository URLs (list of 2 strings)
302 </dd><dt><i>summary=</i></dt>
303 <dd>
304 flag indicating a summarizing diff
305 (only valid for URL diffs) (boolean)
306 </dd><dt><i>refreshable=</i></dt>
307 <dd>
308 flag indicating a refreshable diff (boolean)
309 </dd>
310 </dl>
311 <div align="right"><a href="#top">Up</a></div>
312 <hr />
313 </body></html>

eric ide

mercurial