Mercurial Repositories > eric / file comparison

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

eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.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.vcsPySvn.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.vcsPySvn.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.</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 </p>
56 <h3>Derived from</h3>
57 QWidget, SvnDialogMixin, Ui_SvnDiffDialog
58 <h3>Class Attributes</h3>
59
60 <table>
61 <tr><td>None</td></tr>
62 </table>
63 <h3>Class Methods</h3>
64
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Methods</h3>
69
70 <table>
71
72 <tr>
73 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td>
74 <td>Constructor</td>
75 </tr>
76 <tr>
77 <td><a href="#SvnDiffDialog.__appendText">__appendText</a></td>
78 <td>Private method to append text to the end of the contents pane.</td>
79 </tr>
80 <tr>
81 <td><a href="#SvnDiffDialog.__extractFileName">__extractFileName</a></td>
82 <td>Private method to extract the file name out of a file separator line.</td>
83 </tr>
84 <tr>
85 <td><a href="#SvnDiffDialog.__finish">__finish</a></td>
86 <td>Private slot called when the user pressed the button.</td>
87 </tr>
88 <tr>
89 <td><a href="#SvnDiffDialog.__getDiffSummaryKind">__getDiffSummaryKind</a></td>
90 <td>Private method to get a string descripion of the diff summary.</td>
91 </tr>
92 <tr>
93 <td><a href="#SvnDiffDialog.__getVersionArg">__getVersionArg</a></td>
94 <td>Private method to get a pysvn revision object for the given version number.</td>
95 </tr>
96 <tr>
97 <td><a href="#SvnDiffDialog.__processFileLine">__processFileLine</a></td>
98 <td>Private slot to process a line giving the old/new file.</td>
99 </tr>
100 <tr>
101 <td><a href="#SvnDiffDialog.__showError">__showError</a></td>
102 <td>Private slot to show an error message.</td>
103 </tr>
104 <tr>
105 <td><a href="#SvnDiffDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
106 <td>Private slot called by a button of the button box clicked.</td>
107 </tr>
108 <tr>
109 <td><a href="#SvnDiffDialog.on_filesCombo_activated">on_filesCombo_activated</a></td>
110 <td>Private slot to handle the selection of a file.</td>
111 </tr>
112 <tr>
113 <td><a href="#SvnDiffDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
114 <td>Private slot to refresh the display.</td>
115 </tr>
116 <tr>
117 <td><a href="#SvnDiffDialog.on_saveButton_clicked">on_saveButton_clicked</a></td>
118 <td>Private slot to handle the Save button press.</td>
119 </tr>
120 <tr>
121 <td><a href="#SvnDiffDialog.start">start</a></td>
122 <td>Public slot to start the svn diff command.</td>
123 </tr>
124 </table>
125 <h3>Static Methods</h3>
126
127 <table>
128 <tr><td>None</td></tr>
129 </table>
130
131 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a>
132 <h4>SvnDiffDialog (Constructor)</h4>
133 <b>SvnDiffDialog</b>(<i>vcs, parent=None</i>)
134
135 <p>
136 Constructor
137 </p>
138 <dl>
139
140 <dt><i>vcs</i></dt>
141 <dd>
142 reference to the vcs object
143 </dd>
144 <dt><i>parent</i></dt>
145 <dd>
146 parent widget (QWidget)
147 </dd>
148 </dl>
149 <a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a>
150 <h4>SvnDiffDialog.__appendText</h4>
151 <b>__appendText</b>(<i>line</i>)
152
153 <p>
154 Private method to append text to the end of the contents pane.
155 </p>
156 <dl>
157
158 <dt><i>line</i></dt>
159 <dd>
160 line of text to insert (string)
161 </dd>
162 </dl>
163 <a NAME="SvnDiffDialog.__extractFileName" ID="SvnDiffDialog.__extractFileName"></a>
164 <h4>SvnDiffDialog.__extractFileName</h4>
165 <b>__extractFileName</b>(<i>line</i>)
166
167 <p>
168 Private method to extract the file name out of a file separator line.
169 </p>
170 <dl>
171
172 <dt><i>line</i></dt>
173 <dd>
174 line to be processed (string)
175 </dd>
176 </dl>
177 <dl>
178 <dt>Return:</dt>
179 <dd>
180 extracted file name (string)
181 </dd>
182 </dl>
183 <a NAME="SvnDiffDialog.__finish" ID="SvnDiffDialog.__finish"></a>
184 <h4>SvnDiffDialog.__finish</h4>
185 <b>__finish</b>(<i></i>)
186
187 <p>
188 Private slot called when the user pressed the button.
189 </p>
190 <a NAME="SvnDiffDialog.__getDiffSummaryKind" ID="SvnDiffDialog.__getDiffSummaryKind"></a>
191 <h4>SvnDiffDialog.__getDiffSummaryKind</h4>
192 <b>__getDiffSummaryKind</b>(<i>summaryKind</i>)
193
194 <p>
195 Private method to get a string descripion of the diff summary.
196 </p>
197 <dl>
198
199 <dt><i>summaryKind</i></dt>
200 <dd>
201 (pysvn.diff_summarize.summarize_kind)
202 </dd>
203 </dl>
204 <dl>
205 <dt>Return:</dt>
206 <dd>
207 one letter string indicating the change type (string)
208 </dd>
209 </dl>
210 <a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a>
211 <h4>SvnDiffDialog.__getVersionArg</h4>
212 <b>__getVersionArg</b>(<i>version</i>)
213
214 <p>
215 Private method to get a pysvn revision object for the given version
216 number.
217 </p>
218 <dl>
219
220 <dt><i>version</i></dt>
221 <dd>
222 revision (integer or string)
223 </dd>
224 </dl>
225 <dl>
226 <dt>Return:</dt>
227 <dd>
228 revision object (pysvn.Revision)
229 </dd>
230 </dl>
231 <a NAME="SvnDiffDialog.__processFileLine" ID="SvnDiffDialog.__processFileLine"></a>
232 <h4>SvnDiffDialog.__processFileLine</h4>
233 <b>__processFileLine</b>(<i>line</i>)
234
235 <p>
236 Private slot to process a line giving the old/new file.
237 </p>
238 <dl>
239
240 <dt><i>line</i></dt>
241 <dd>
242 line to be processed (string)
243 </dd>
244 </dl>
245 <a NAME="SvnDiffDialog.__showError" ID="SvnDiffDialog.__showError"></a>
246 <h4>SvnDiffDialog.__showError</h4>
247 <b>__showError</b>(<i>msg</i>)
248
249 <p>
250 Private slot to show an error message.
251 </p>
252 <dl>
253
254 <dt><i>msg</i></dt>
255 <dd>
256 error message to show (string)
257 </dd>
258 </dl>
259 <a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a>
260 <h4>SvnDiffDialog.on_buttonBox_clicked</h4>
261 <b>on_buttonBox_clicked</b>(<i>button</i>)
262
263 <p>
264 Private slot called by a button of the button box clicked.
265 </p>
266 <dl>
267
268 <dt><i>button</i></dt>
269 <dd>
270 button that was clicked (QAbstractButton)
271 </dd>
272 </dl>
273 <a NAME="SvnDiffDialog.on_filesCombo_activated" ID="SvnDiffDialog.on_filesCombo_activated"></a>
274 <h4>SvnDiffDialog.on_filesCombo_activated</h4>
275 <b>on_filesCombo_activated</b>(<i>index</i>)
276
277 <p>
278 Private slot to handle the selection of a file.
279 </p>
280 <dl>
281
282 <dt><i>index</i></dt>
283 <dd>
284 activated row (integer)
285 </dd>
286 </dl>
287 <a NAME="SvnDiffDialog.on_refreshButton_clicked" ID="SvnDiffDialog.on_refreshButton_clicked"></a>
288 <h4>SvnDiffDialog.on_refreshButton_clicked</h4>
289 <b>on_refreshButton_clicked</b>(<i></i>)
290
291 <p>
292 Private slot to refresh the display.
293 </p>
294 <a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a>
295 <h4>SvnDiffDialog.on_saveButton_clicked</h4>
296 <b>on_saveButton_clicked</b>(<i></i>)
297
298 <p>
299 Private slot to handle the Save button press.
300 </p>
301 <p>
302 It saves the diff shown in the dialog to a file in the local
303 filesystem.
304 </p>
305 <a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a>
306 <h4>SvnDiffDialog.start</h4>
307 <b>start</b>(<i>fn, versions=None, urls=None, summary=False, pegRev=None, refreshable=False</i>)
308
309 <p>
310 Public slot to start the svn diff command.
311 </p>
312 <dl>
313
314 <dt><i>fn</i></dt>
315 <dd>
316 filename to be diffed (string)
317 </dd>
318 <dt><i>versions</i></dt>
319 <dd>
320 list of versions to be diffed (list of up to 2 integer
321 or None)
322 </dd>
323 <dt><i>urls</i></dt>
324 <dd>
325 list of repository URLs (list of 2 strings)
326 </dd>
327 <dt><i>summary</i></dt>
328 <dd>
329 flag indicating a summarizing diff
330 (only valid for URL diffs) (boolean)
331 </dd>
332 <dt><i>pegRev</i></dt>
333 <dd>
334 revision number the filename is valid (integer)
335 </dd>
336 <dt><i>refreshable</i></dt>
337 <dd>
338 flag indicating a refreshable diff (boolean)
339 </dd>
340 </dl>
341 <div align="right"><a href="#top">Up</a></div>
342 <hr />
343 </body></html>

Mercurial Repository: eric

eric ide

mercurial