src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog.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.vcsPySvn.SvnDiffDialog</h1> 9 <h1>eric7.Plugins.VcsPlugins.vcsPySvn.SvnDiffDialog</h1>
10
11 <p> 10 <p>
12 Module implementing a dialog to show the output of the svn diff command 11 Module implementing a dialog to show the output of the svn diff command
13 process. 12 process.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16 16 <table>
17 <table> 17 <tr><td>None</td></tr>
18 <tr><td>None</td></tr> 18 </table>
19 </table> 19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21 21 <table>
22 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#SvnDiffDialog">SvnDiffDialog</a></td> 23 <td><a href="#SvnDiffDialog">SvnDiffDialog</a></td>
26 <td>Class implementing a dialog to show the output of the svn diff command.</td> 24 <td>Class implementing a dialog to show the output of the svn diff command.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30 29 <table>
31 <table> 30 <tr><td>None</td></tr>
32 <tr><td>None</td></tr> 31 </table>
33 </table> 32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a> 35 <a NAME="SvnDiffDialog" ID="SvnDiffDialog"></a>
37 <h2>SvnDiffDialog</h2> 36 <h2>SvnDiffDialog</h2>
38
39 <p> 37 <p>
40 Class implementing a dialog to show the output of the svn diff command. 38 Class implementing a dialog to show the output of the svn diff command.
41 </p> 39 </p>
40
42 <h3>Derived from</h3> 41 <h3>Derived from</h3>
43 QWidget, SvnDialogMixin, Ui_SvnDiffDialog 42 QWidget, SvnDialogMixin, Ui_SvnDiffDialog
44 <h3>Class Attributes</h3> 43 <h3>Class Attributes</h3>
45 44 <table>
46 <table> 45 <tr><td>None</td></tr>
47 <tr><td>None</td></tr> 46 </table>
48 </table> 47
49 <h3>Class Methods</h3> 48 <h3>Class Methods</h3>
50 49 <table>
51 <table> 50 <tr><td>None</td></tr>
52 <tr><td>None</td></tr> 51 </table>
53 </table> 52
54 <h3>Methods</h3> 53 <h3>Methods</h3>
55 54 <table>
56 <table>
57
58 <tr> 55 <tr>
59 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td> 56 <td><a href="#SvnDiffDialog.__init__">SvnDiffDialog</a></td>
60 <td>Constructor</td> 57 <td>Constructor</td>
61 </tr> 58 </tr>
62 <tr> 59 <tr>
106 <tr> 103 <tr>
107 <td><a href="#SvnDiffDialog.start">start</a></td> 104 <td><a href="#SvnDiffDialog.start">start</a></td>
108 <td>Public slot to start the svn diff command.</td> 105 <td>Public slot to start the svn diff command.</td>
109 </tr> 106 </tr>
110 </table> 107 </table>
108
111 <h3>Static Methods</h3> 109 <h3>Static Methods</h3>
112 110 <table>
113 <table> 111 <tr><td>None</td></tr>
114 <tr><td>None</td></tr> 112 </table>
115 </table> 113
116 114
117 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a> 115 <a NAME="SvnDiffDialog.__init__" ID="SvnDiffDialog.__init__"></a>
118 <h4>SvnDiffDialog (Constructor)</h4> 116 <h4>SvnDiffDialog (Constructor)</h4>
119 <b>SvnDiffDialog</b>(<i>vcs, parent=None</i>) 117 <b>SvnDiffDialog</b>(<i>vcs, parent=None</i>)
120
121 <p> 118 <p>
122 Constructor 119 Constructor
123 </p> 120 </p>
121
124 <dl> 122 <dl>
125 123
126 <dt><i>vcs</i> (Subversion)</dt> 124 <dt><i>vcs</i> (Subversion)</dt>
127 <dd> 125 <dd>
128 reference to the vcs object 126 reference to the vcs object
133 </dd> 131 </dd>
134 </dl> 132 </dl>
135 <a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a> 133 <a NAME="SvnDiffDialog.__appendText" ID="SvnDiffDialog.__appendText"></a>
136 <h4>SvnDiffDialog.__appendText</h4> 134 <h4>SvnDiffDialog.__appendText</h4>
137 <b>__appendText</b>(<i>line</i>) 135 <b>__appendText</b>(<i>line</i>)
138
139 <p> 136 <p>
140 Private method to append text to the end of the contents pane. 137 Private method to append text to the end of the contents pane.
141 </p> 138 </p>
139
142 <dl> 140 <dl>
143 141
144 <dt><i>line</i> (str)</dt> 142 <dt><i>line</i> (str)</dt>
145 <dd> 143 <dd>
146 line of text to insert 144 line of text to insert
147 </dd> 145 </dd>
148 </dl> 146 </dl>
149 <a NAME="SvnDiffDialog.__extractFileName" ID="SvnDiffDialog.__extractFileName"></a> 147 <a NAME="SvnDiffDialog.__extractFileName" ID="SvnDiffDialog.__extractFileName"></a>
150 <h4>SvnDiffDialog.__extractFileName</h4> 148 <h4>SvnDiffDialog.__extractFileName</h4>
151 <b>__extractFileName</b>(<i>line</i>) 149 <b>__extractFileName</b>(<i>line</i>)
152
153 <p> 150 <p>
154 Private method to extract the file name out of a file separator line. 151 Private method to extract the file name out of a file separator line.
155 </p> 152 </p>
153
156 <dl> 154 <dl>
157 155
158 <dt><i>line</i> (str)</dt> 156 <dt><i>line</i> (str)</dt>
159 <dd> 157 <dd>
160 line to be processed 158 line to be processed
173 </dd> 171 </dd>
174 </dl> 172 </dl>
175 <a NAME="SvnDiffDialog.__finish" ID="SvnDiffDialog.__finish"></a> 173 <a NAME="SvnDiffDialog.__finish" ID="SvnDiffDialog.__finish"></a>
176 <h4>SvnDiffDialog.__finish</h4> 174 <h4>SvnDiffDialog.__finish</h4>
177 <b>__finish</b>(<i></i>) 175 <b>__finish</b>(<i></i>)
178
179 <p> 176 <p>
180 Private slot called when the user pressed the button. 177 Private slot called when the user pressed the button.
181 </p> 178 </p>
179
182 <a NAME="SvnDiffDialog.__getDiffSummaryKind" ID="SvnDiffDialog.__getDiffSummaryKind"></a> 180 <a NAME="SvnDiffDialog.__getDiffSummaryKind" ID="SvnDiffDialog.__getDiffSummaryKind"></a>
183 <h4>SvnDiffDialog.__getDiffSummaryKind</h4> 181 <h4>SvnDiffDialog.__getDiffSummaryKind</h4>
184 <b>__getDiffSummaryKind</b>(<i>summaryKind</i>) 182 <b>__getDiffSummaryKind</b>(<i>summaryKind</i>)
185
186 <p> 183 <p>
187 Private method to get a string descripion of the diff summary. 184 Private method to get a string descripion of the diff summary.
188 </p> 185 </p>
186
189 <dl> 187 <dl>
190 188
191 <dt><i>summaryKind</i> (pysvn.diff_summarize.summarize_kind)</dt> 189 <dt><i>summaryKind</i> (pysvn.diff_summarize.summarize_kind)</dt>
192 <dd> 190 <dd>
193 191
206 </dd> 204 </dd>
207 </dl> 205 </dl>
208 <a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a> 206 <a NAME="SvnDiffDialog.__getVersionArg" ID="SvnDiffDialog.__getVersionArg"></a>
209 <h4>SvnDiffDialog.__getVersionArg</h4> 207 <h4>SvnDiffDialog.__getVersionArg</h4>
210 <b>__getVersionArg</b>(<i>version</i>) 208 <b>__getVersionArg</b>(<i>version</i>)
211
212 <p> 209 <p>
213 Private method to get a pysvn revision object for the given version 210 Private method to get a pysvn revision object for the given version
214 number. 211 number.
215 </p> 212 </p>
213
216 <dl> 214 <dl>
217 215
218 <dt><i>version</i> (int or str)</dt> 216 <dt><i>version</i> (int or str)</dt>
219 <dd> 217 <dd>
220 revision 218 revision
233 </dd> 231 </dd>
234 </dl> 232 </dl>
235 <a NAME="SvnDiffDialog.__processFileLine" ID="SvnDiffDialog.__processFileLine"></a> 233 <a NAME="SvnDiffDialog.__processFileLine" ID="SvnDiffDialog.__processFileLine"></a>
236 <h4>SvnDiffDialog.__processFileLine</h4> 234 <h4>SvnDiffDialog.__processFileLine</h4>
237 <b>__processFileLine</b>(<i>line</i>) 235 <b>__processFileLine</b>(<i>line</i>)
238
239 <p> 236 <p>
240 Private slot to process a line giving the old/new file. 237 Private slot to process a line giving the old/new file.
241 </p> 238 </p>
239
242 <dl> 240 <dl>
243 241
244 <dt><i>line</i> (str)</dt> 242 <dt><i>line</i> (str)</dt>
245 <dd> 243 <dd>
246 line to be processed 244 line to be processed
247 </dd> 245 </dd>
248 </dl> 246 </dl>
249 <a NAME="SvnDiffDialog.__showError" ID="SvnDiffDialog.__showError"></a> 247 <a NAME="SvnDiffDialog.__showError" ID="SvnDiffDialog.__showError"></a>
250 <h4>SvnDiffDialog.__showError</h4> 248 <h4>SvnDiffDialog.__showError</h4>
251 <b>__showError</b>(<i>msg</i>) 249 <b>__showError</b>(<i>msg</i>)
252
253 <p> 250 <p>
254 Private slot to show an error message. 251 Private slot to show an error message.
255 </p> 252 </p>
253
256 <dl> 254 <dl>
257 255
258 <dt><i>msg</i> (str)</dt> 256 <dt><i>msg</i> (str)</dt>
259 <dd> 257 <dd>
260 error message to show 258 error message to show
261 </dd> 259 </dd>
262 </dl> 260 </dl>
263 <a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a> 261 <a NAME="SvnDiffDialog.on_buttonBox_clicked" ID="SvnDiffDialog.on_buttonBox_clicked"></a>
264 <h4>SvnDiffDialog.on_buttonBox_clicked</h4> 262 <h4>SvnDiffDialog.on_buttonBox_clicked</h4>
265 <b>on_buttonBox_clicked</b>(<i>button</i>) 263 <b>on_buttonBox_clicked</b>(<i>button</i>)
266
267 <p> 264 <p>
268 Private slot called by a button of the button box clicked. 265 Private slot called by a button of the button box clicked.
269 </p> 266 </p>
267
270 <dl> 268 <dl>
271 269
272 <dt><i>button</i> (QAbstractButton)</dt> 270 <dt><i>button</i> (QAbstractButton)</dt>
273 <dd> 271 <dd>
274 button that was clicked 272 button that was clicked
275 </dd> 273 </dd>
276 </dl> 274 </dl>
277 <a NAME="SvnDiffDialog.on_filesCombo_activated" ID="SvnDiffDialog.on_filesCombo_activated"></a> 275 <a NAME="SvnDiffDialog.on_filesCombo_activated" ID="SvnDiffDialog.on_filesCombo_activated"></a>
278 <h4>SvnDiffDialog.on_filesCombo_activated</h4> 276 <h4>SvnDiffDialog.on_filesCombo_activated</h4>
279 <b>on_filesCombo_activated</b>(<i>index</i>) 277 <b>on_filesCombo_activated</b>(<i>index</i>)
280
281 <p> 278 <p>
282 Private slot to handle the selection of a file. 279 Private slot to handle the selection of a file.
283 </p> 280 </p>
281
284 <dl> 282 <dl>
285 283
286 <dt><i>index</i> (int)</dt> 284 <dt><i>index</i> (int)</dt>
287 <dd> 285 <dd>
288 activated row 286 activated row
289 </dd> 287 </dd>
290 </dl> 288 </dl>
291 <a NAME="SvnDiffDialog.on_refreshButton_clicked" ID="SvnDiffDialog.on_refreshButton_clicked"></a> 289 <a NAME="SvnDiffDialog.on_refreshButton_clicked" ID="SvnDiffDialog.on_refreshButton_clicked"></a>
292 <h4>SvnDiffDialog.on_refreshButton_clicked</h4> 290 <h4>SvnDiffDialog.on_refreshButton_clicked</h4>
293 <b>on_refreshButton_clicked</b>(<i></i>) 291 <b>on_refreshButton_clicked</b>(<i></i>)
294
295 <p> 292 <p>
296 Private slot to refresh the display. 293 Private slot to refresh the display.
297 </p> 294 </p>
295
298 <a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a> 296 <a NAME="SvnDiffDialog.on_saveButton_clicked" ID="SvnDiffDialog.on_saveButton_clicked"></a>
299 <h4>SvnDiffDialog.on_saveButton_clicked</h4> 297 <h4>SvnDiffDialog.on_saveButton_clicked</h4>
300 <b>on_saveButton_clicked</b>(<i></i>) 298 <b>on_saveButton_clicked</b>(<i></i>)
301
302 <p> 299 <p>
303 Private slot to handle the Save button press. 300 Private slot to handle the Save button press.
304 </p> 301 </p>
305 <p> 302 <p>
306 It saves the diff shown in the dialog to a file in the local 303 It saves the diff shown in the dialog to a file in the local
307 filesystem. 304 filesystem.
308 </p> 305 </p>
306
309 <a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a> 307 <a NAME="SvnDiffDialog.start" ID="SvnDiffDialog.start"></a>
310 <h4>SvnDiffDialog.start</h4> 308 <h4>SvnDiffDialog.start</h4>
311 <b>start</b>(<i>fn, versions=None, urls=None, summary=False, pegRev=None, refreshable=False, </i>) 309 <b>start</b>(<i>fn, versions=None, urls=None, summary=False, pegRev=None, refreshable=False, </i>)
312
313 <p> 310 <p>
314 Public slot to start the svn diff command. 311 Public slot to start the svn diff command.
315 </p> 312 </p>
313
316 <dl> 314 <dl>
317 315
318 <dt><i>fn</i> (str)</dt> 316 <dt><i>fn</i> (str)</dt>
319 <dd> 317 <dd>
320 filename to be diffed 318 filename to be diffed

eric ide

mercurial