src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.SvnLogBrowserDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsPySvn.SvnLogBrowserDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.VcsPlugins.vcsPySvn.SvnLogBrowserDialog</h1>
10
11 <p>
12 Module implementing a dialog to browse the log history.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#SvnLogBrowserDialog">SvnLogBrowserDialog</a></td>
25 <td>Class implementing a dialog to browse the log history.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="SvnLogBrowserDialog" ID="SvnLogBrowserDialog"></a>
36 <h2>SvnLogBrowserDialog</h2>
37
38 <p>
39 Class implementing a dialog to browse the log history.
40 </p>
41 <h3>Derived from</h3>
42 QWidget, SvnDialogMixin, Ui_SvnLogBrowserDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>None</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#SvnLogBrowserDialog.__init__">SvnLogBrowserDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#SvnLogBrowserDialog.__diffRevisions">__diffRevisions</a></td>
63 <td>Private method to do a diff of two revisions.</td>
64 </tr>
65 <tr>
66 <td><a href="#SvnLogBrowserDialog.__filterLogs">__filterLogs</a></td>
67 <td>Private method to filter the log entries.</td>
68 </tr>
69 <tr>
70 <td><a href="#SvnLogBrowserDialog.__finish">__finish</a></td>
71 <td>Private slot called when the user pressed the button.</td>
72 </tr>
73 <tr>
74 <td><a href="#SvnLogBrowserDialog.__generateFileItem">__generateFileItem</a></td>
75 <td>Private method to generate a changed files tree entry.</td>
76 </tr>
77 <tr>
78 <td><a href="#SvnLogBrowserDialog.__generateLogItem">__generateLogItem</a></td>
79 <td>Private method to generate a log tree entry.</td>
80 </tr>
81 <tr>
82 <td><a href="#SvnLogBrowserDialog.__getLogEntries">__getLogEntries</a></td>
83 <td>Private method to retrieve log entries from the repository.</td>
84 </tr>
85 <tr>
86 <td><a href="#SvnLogBrowserDialog.__initData">__initData</a></td>
87 <td>Private method to (re-)initialize some data.</td>
88 </tr>
89 <tr>
90 <td><a href="#SvnLogBrowserDialog.__resetUI">__resetUI</a></td>
91 <td>Private method to reset the user interface.</td>
92 </tr>
93 <tr>
94 <td><a href="#SvnLogBrowserDialog.__resizeColumnsFiles">__resizeColumnsFiles</a></td>
95 <td>Private method to resize the changed files tree columns.</td>
96 </tr>
97 <tr>
98 <td><a href="#SvnLogBrowserDialog.__resizeColumnsLog">__resizeColumnsLog</a></td>
99 <td>Private method to resize the log tree columns.</td>
100 </tr>
101 <tr>
102 <td><a href="#SvnLogBrowserDialog.__resortFiles">__resortFiles</a></td>
103 <td>Private method to resort the changed files tree.</td>
104 </tr>
105 <tr>
106 <td><a href="#SvnLogBrowserDialog.__resortLog">__resortLog</a></td>
107 <td>Private method to resort the log tree.</td>
108 </tr>
109 <tr>
110 <td><a href="#SvnLogBrowserDialog.__showError">__showError</a></td>
111 <td>Private slot to show an error message.</td>
112 </tr>
113 <tr>
114 <td><a href="#SvnLogBrowserDialog._reset">_reset</a></td>
115 <td>Protected method to reset the internal state of the dialog.</td>
116 </tr>
117 <tr>
118 <td><a href="#SvnLogBrowserDialog.closeEvent">closeEvent</a></td>
119 <td>Protected slot implementing a close event handler.</td>
120 </tr>
121 <tr>
122 <td><a href="#SvnLogBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
123 <td>Private slot called by a button of the button box clicked.</td>
124 </tr>
125 <tr>
126 <td><a href="#SvnLogBrowserDialog.on_diffPreviousButton_clicked">on_diffPreviousButton_clicked</a></td>
127 <td>Private slot to handle the Diff to Previous button.</td>
128 </tr>
129 <tr>
130 <td><a href="#SvnLogBrowserDialog.on_diffRevisionsButton_clicked">on_diffRevisionsButton_clicked</a></td>
131 <td>Private slot to handle the Compare Revisions button.</td>
132 </tr>
133 <tr>
134 <td><a href="#SvnLogBrowserDialog.on_downButton_clicked">on_downButton_clicked</a></td>
135 <td>Private slot to move the current item down one entry.</td>
136 </tr>
137 <tr>
138 <td><a href="#SvnLogBrowserDialog.on_fieldCombo_activated">on_fieldCombo_activated</a></td>
139 <td>Private slot called, when a new filter field is selected.</td>
140 </tr>
141 <tr>
142 <td><a href="#SvnLogBrowserDialog.on_fromDate_dateChanged">on_fromDate_dateChanged</a></td>
143 <td>Private slot called, when the from date changes.</td>
144 </tr>
145 <tr>
146 <td><a href="#SvnLogBrowserDialog.on_logTree_currentItemChanged">on_logTree_currentItemChanged</a></td>
147 <td>Private slot called, when the current item of the log tree changes.</td>
148 </tr>
149 <tr>
150 <td><a href="#SvnLogBrowserDialog.on_logTree_itemSelectionChanged">on_logTree_itemSelectionChanged</a></td>
151 <td>Private slot called, when the selection has changed.</td>
152 </tr>
153 <tr>
154 <td><a href="#SvnLogBrowserDialog.on_nextButton_clicked">on_nextButton_clicked</a></td>
155 <td>Private slot to handle the Next button.</td>
156 </tr>
157 <tr>
158 <td><a href="#SvnLogBrowserDialog.on_rxEdit_textChanged">on_rxEdit_textChanged</a></td>
159 <td>Private slot called, when a filter expression is entered.</td>
160 </tr>
161 <tr>
162 <td><a href="#SvnLogBrowserDialog.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td>
163 <td>Private slot called, when the stop on copy/move checkbox is clicked.</td>
164 </tr>
165 <tr>
166 <td><a href="#SvnLogBrowserDialog.on_toDate_dateChanged">on_toDate_dateChanged</a></td>
167 <td>Private slot called, when the from date changes.</td>
168 </tr>
169 <tr>
170 <td><a href="#SvnLogBrowserDialog.on_upButton_clicked">on_upButton_clicked</a></td>
171 <td>Private slot to move the current item up one entry.</td>
172 </tr>
173 <tr>
174 <td><a href="#SvnLogBrowserDialog.show">show</a></td>
175 <td>Public slot to show the dialog.</td>
176 </tr>
177 <tr>
178 <td><a href="#SvnLogBrowserDialog.start">start</a></td>
179 <td>Public slot to start the svn log command.</td>
180 </tr>
181 </table>
182 <h3>Static Methods</h3>
183
184 <table>
185 <tr><td>None</td></tr>
186 </table>
187
188 <a NAME="SvnLogBrowserDialog.__init__" ID="SvnLogBrowserDialog.__init__"></a>
189 <h4>SvnLogBrowserDialog (Constructor)</h4>
190 <b>SvnLogBrowserDialog</b>(<i>vcs, parent=None</i>)
191
192 <p>
193 Constructor
194 </p>
195 <dl>
196
197 <dt><i>vcs</i></dt>
198 <dd>
199 reference to the vcs object
200 </dd>
201 <dt><i>parent</i></dt>
202 <dd>
203 parent widget (QWidget)
204 </dd>
205 </dl>
206 <a NAME="SvnLogBrowserDialog.__diffRevisions" ID="SvnLogBrowserDialog.__diffRevisions"></a>
207 <h4>SvnLogBrowserDialog.__diffRevisions</h4>
208 <b>__diffRevisions</b>(<i>rev1, rev2, peg_rev</i>)
209
210 <p>
211 Private method to do a diff of two revisions.
212 </p>
213 <dl>
214
215 <dt><i>rev1</i></dt>
216 <dd>
217 first revision number (integer)
218 </dd>
219 <dt><i>rev2</i></dt>
220 <dd>
221 second revision number (integer)
222 </dd>
223 <dt><i>peg_rev</i></dt>
224 <dd>
225 revision number to use as a reference (integer)
226 </dd>
227 </dl>
228 <a NAME="SvnLogBrowserDialog.__filterLogs" ID="SvnLogBrowserDialog.__filterLogs"></a>
229 <h4>SvnLogBrowserDialog.__filterLogs</h4>
230 <b>__filterLogs</b>(<i></i>)
231
232 <p>
233 Private method to filter the log entries.
234 </p>
235 <a NAME="SvnLogBrowserDialog.__finish" ID="SvnLogBrowserDialog.__finish"></a>
236 <h4>SvnLogBrowserDialog.__finish</h4>
237 <b>__finish</b>(<i></i>)
238
239 <p>
240 Private slot called when the user pressed the button.
241 </p>
242 <a NAME="SvnLogBrowserDialog.__generateFileItem" ID="SvnLogBrowserDialog.__generateFileItem"></a>
243 <h4>SvnLogBrowserDialog.__generateFileItem</h4>
244 <b>__generateFileItem</b>(<i>action, path, copyFrom, copyRev</i>)
245
246 <p>
247 Private method to generate a changed files tree entry.
248 </p>
249 <dl>
250
251 <dt><i>action</i></dt>
252 <dd>
253 indicator for the change action ("A", "D" or "M")
254 </dd>
255 <dt><i>path</i></dt>
256 <dd>
257 path of the file in the repository (string)
258 </dd>
259 <dt><i>copyFrom</i></dt>
260 <dd>
261 path the file was copied from (None, string)
262 </dd>
263 <dt><i>copyRev</i></dt>
264 <dd>
265 revision the file was copied from (None, string)
266 </dd>
267 </dl>
268 <dl>
269 <dt>Return:</dt>
270 <dd>
271 reference to the generated item (QTreeWidgetItem)
272 </dd>
273 </dl>
274 <a NAME="SvnLogBrowserDialog.__generateLogItem" ID="SvnLogBrowserDialog.__generateLogItem"></a>
275 <h4>SvnLogBrowserDialog.__generateLogItem</h4>
276 <b>__generateLogItem</b>(<i>author, date, message, revision, changedPaths</i>)
277
278 <p>
279 Private method to generate a log tree entry.
280 </p>
281 <dl>
282
283 <dt><i>author</i></dt>
284 <dd>
285 author info (string)
286 </dd>
287 <dt><i>date</i></dt>
288 <dd>
289 date info (integer)
290 </dd>
291 <dt><i>message</i></dt>
292 <dd>
293 text of the log message (string)
294 </dd>
295 <dt><i>revision</i></dt>
296 <dd>
297 revision info (string or pysvn.opt_revision_kind)
298 </dd>
299 <dt><i>changedPaths</i></dt>
300 <dd>
301 list of pysvn dictionary like objects containing
302 info about the changed files/directories
303 </dd>
304 </dl>
305 <dl>
306 <dt>Return:</dt>
307 <dd>
308 reference to the generated item (QTreeWidgetItem)
309 </dd>
310 </dl>
311 <a NAME="SvnLogBrowserDialog.__getLogEntries" ID="SvnLogBrowserDialog.__getLogEntries"></a>
312 <h4>SvnLogBrowserDialog.__getLogEntries</h4>
313 <b>__getLogEntries</b>(<i>startRev=None</i>)
314
315 <p>
316 Private method to retrieve log entries from the repository.
317 </p>
318 <dl>
319
320 <dt><i>startRev</i></dt>
321 <dd>
322 revision number to start from (integer, string)
323 </dd>
324 </dl>
325 <a NAME="SvnLogBrowserDialog.__initData" ID="SvnLogBrowserDialog.__initData"></a>
326 <h4>SvnLogBrowserDialog.__initData</h4>
327 <b>__initData</b>(<i></i>)
328
329 <p>
330 Private method to (re-)initialize some data.
331 </p>
332 <a NAME="SvnLogBrowserDialog.__resetUI" ID="SvnLogBrowserDialog.__resetUI"></a>
333 <h4>SvnLogBrowserDialog.__resetUI</h4>
334 <b>__resetUI</b>(<i></i>)
335
336 <p>
337 Private method to reset the user interface.
338 </p>
339 <a NAME="SvnLogBrowserDialog.__resizeColumnsFiles" ID="SvnLogBrowserDialog.__resizeColumnsFiles"></a>
340 <h4>SvnLogBrowserDialog.__resizeColumnsFiles</h4>
341 <b>__resizeColumnsFiles</b>(<i></i>)
342
343 <p>
344 Private method to resize the changed files tree columns.
345 </p>
346 <a NAME="SvnLogBrowserDialog.__resizeColumnsLog" ID="SvnLogBrowserDialog.__resizeColumnsLog"></a>
347 <h4>SvnLogBrowserDialog.__resizeColumnsLog</h4>
348 <b>__resizeColumnsLog</b>(<i></i>)
349
350 <p>
351 Private method to resize the log tree columns.
352 </p>
353 <a NAME="SvnLogBrowserDialog.__resortFiles" ID="SvnLogBrowserDialog.__resortFiles"></a>
354 <h4>SvnLogBrowserDialog.__resortFiles</h4>
355 <b>__resortFiles</b>(<i></i>)
356
357 <p>
358 Private method to resort the changed files tree.
359 </p>
360 <a NAME="SvnLogBrowserDialog.__resortLog" ID="SvnLogBrowserDialog.__resortLog"></a>
361 <h4>SvnLogBrowserDialog.__resortLog</h4>
362 <b>__resortLog</b>(<i></i>)
363
364 <p>
365 Private method to resort the log tree.
366 </p>
367 <a NAME="SvnLogBrowserDialog.__showError" ID="SvnLogBrowserDialog.__showError"></a>
368 <h4>SvnLogBrowserDialog.__showError</h4>
369 <b>__showError</b>(<i>msg</i>)
370
371 <p>
372 Private slot to show an error message.
373 </p>
374 <dl>
375
376 <dt><i>msg</i></dt>
377 <dd>
378 error message to show (string)
379 </dd>
380 </dl>
381 <a NAME="SvnLogBrowserDialog._reset" ID="SvnLogBrowserDialog._reset"></a>
382 <h4>SvnLogBrowserDialog._reset</h4>
383 <b>_reset</b>(<i></i>)
384
385 <p>
386 Protected method to reset the internal state of the dialog.
387 </p>
388 <a NAME="SvnLogBrowserDialog.closeEvent" ID="SvnLogBrowserDialog.closeEvent"></a>
389 <h4>SvnLogBrowserDialog.closeEvent</h4>
390 <b>closeEvent</b>(<i>e</i>)
391
392 <p>
393 Protected slot implementing a close event handler.
394 </p>
395 <dl>
396
397 <dt><i>e</i></dt>
398 <dd>
399 close event (QCloseEvent)
400 </dd>
401 </dl>
402 <a NAME="SvnLogBrowserDialog.on_buttonBox_clicked" ID="SvnLogBrowserDialog.on_buttonBox_clicked"></a>
403 <h4>SvnLogBrowserDialog.on_buttonBox_clicked</h4>
404 <b>on_buttonBox_clicked</b>(<i>button</i>)
405
406 <p>
407 Private slot called by a button of the button box clicked.
408 </p>
409 <dl>
410
411 <dt><i>button</i></dt>
412 <dd>
413 button that was clicked (QAbstractButton)
414 </dd>
415 </dl>
416 <a NAME="SvnLogBrowserDialog.on_diffPreviousButton_clicked" ID="SvnLogBrowserDialog.on_diffPreviousButton_clicked"></a>
417 <h4>SvnLogBrowserDialog.on_diffPreviousButton_clicked</h4>
418 <b>on_diffPreviousButton_clicked</b>(<i></i>)
419
420 <p>
421 Private slot to handle the Diff to Previous button.
422 </p>
423 <a NAME="SvnLogBrowserDialog.on_diffRevisionsButton_clicked" ID="SvnLogBrowserDialog.on_diffRevisionsButton_clicked"></a>
424 <h4>SvnLogBrowserDialog.on_diffRevisionsButton_clicked</h4>
425 <b>on_diffRevisionsButton_clicked</b>(<i></i>)
426
427 <p>
428 Private slot to handle the Compare Revisions button.
429 </p>
430 <a NAME="SvnLogBrowserDialog.on_downButton_clicked" ID="SvnLogBrowserDialog.on_downButton_clicked"></a>
431 <h4>SvnLogBrowserDialog.on_downButton_clicked</h4>
432 <b>on_downButton_clicked</b>(<i></i>)
433
434 <p>
435 Private slot to move the current item down one entry.
436 </p>
437 <a NAME="SvnLogBrowserDialog.on_fieldCombo_activated" ID="SvnLogBrowserDialog.on_fieldCombo_activated"></a>
438 <h4>SvnLogBrowserDialog.on_fieldCombo_activated</h4>
439 <b>on_fieldCombo_activated</b>(<i>index</i>)
440
441 <p>
442 Private slot called, when a new filter field is selected.
443 </p>
444 <dl>
445
446 <dt><i>index</i> (int)</dt>
447 <dd>
448 index of the selected entry
449 </dd>
450 </dl>
451 <a NAME="SvnLogBrowserDialog.on_fromDate_dateChanged" ID="SvnLogBrowserDialog.on_fromDate_dateChanged"></a>
452 <h4>SvnLogBrowserDialog.on_fromDate_dateChanged</h4>
453 <b>on_fromDate_dateChanged</b>(<i>date</i>)
454
455 <p>
456 Private slot called, when the from date changes.
457 </p>
458 <dl>
459
460 <dt><i>date</i></dt>
461 <dd>
462 new date (QDate)
463 </dd>
464 </dl>
465 <a NAME="SvnLogBrowserDialog.on_logTree_currentItemChanged" ID="SvnLogBrowserDialog.on_logTree_currentItemChanged"></a>
466 <h4>SvnLogBrowserDialog.on_logTree_currentItemChanged</h4>
467 <b>on_logTree_currentItemChanged</b>(<i>current, previous</i>)
468
469 <p>
470 Private slot called, when the current item of the log tree changes.
471 </p>
472 <dl>
473
474 <dt><i>current</i></dt>
475 <dd>
476 reference to the new current item (QTreeWidgetItem)
477 </dd>
478 <dt><i>previous</i></dt>
479 <dd>
480 reference to the old current item (QTreeWidgetItem)
481 </dd>
482 </dl>
483 <a NAME="SvnLogBrowserDialog.on_logTree_itemSelectionChanged" ID="SvnLogBrowserDialog.on_logTree_itemSelectionChanged"></a>
484 <h4>SvnLogBrowserDialog.on_logTree_itemSelectionChanged</h4>
485 <b>on_logTree_itemSelectionChanged</b>(<i></i>)
486
487 <p>
488 Private slot called, when the selection has changed.
489 </p>
490 <a NAME="SvnLogBrowserDialog.on_nextButton_clicked" ID="SvnLogBrowserDialog.on_nextButton_clicked"></a>
491 <h4>SvnLogBrowserDialog.on_nextButton_clicked</h4>
492 <b>on_nextButton_clicked</b>(<i></i>)
493
494 <p>
495 Private slot to handle the Next button.
496 </p>
497 <a NAME="SvnLogBrowserDialog.on_rxEdit_textChanged" ID="SvnLogBrowserDialog.on_rxEdit_textChanged"></a>
498 <h4>SvnLogBrowserDialog.on_rxEdit_textChanged</h4>
499 <b>on_rxEdit_textChanged</b>(<i>txt</i>)
500
501 <p>
502 Private slot called, when a filter expression is entered.
503 </p>
504 <dl>
505
506 <dt><i>txt</i></dt>
507 <dd>
508 filter expression (string)
509 </dd>
510 </dl>
511 <a NAME="SvnLogBrowserDialog.on_stopCheckBox_clicked" ID="SvnLogBrowserDialog.on_stopCheckBox_clicked"></a>
512 <h4>SvnLogBrowserDialog.on_stopCheckBox_clicked</h4>
513 <b>on_stopCheckBox_clicked</b>(<i>checked</i>)
514
515 <p>
516 Private slot called, when the stop on copy/move checkbox is clicked.
517 </p>
518 <dl>
519
520 <dt><i>checked</i></dt>
521 <dd>
522 flag indicating the check box state (boolean)
523 </dd>
524 </dl>
525 <a NAME="SvnLogBrowserDialog.on_toDate_dateChanged" ID="SvnLogBrowserDialog.on_toDate_dateChanged"></a>
526 <h4>SvnLogBrowserDialog.on_toDate_dateChanged</h4>
527 <b>on_toDate_dateChanged</b>(<i>date</i>)
528
529 <p>
530 Private slot called, when the from date changes.
531 </p>
532 <dl>
533
534 <dt><i>date</i></dt>
535 <dd>
536 new date (QDate)
537 </dd>
538 </dl>
539 <a NAME="SvnLogBrowserDialog.on_upButton_clicked" ID="SvnLogBrowserDialog.on_upButton_clicked"></a>
540 <h4>SvnLogBrowserDialog.on_upButton_clicked</h4>
541 <b>on_upButton_clicked</b>(<i></i>)
542
543 <p>
544 Private slot to move the current item up one entry.
545 </p>
546 <a NAME="SvnLogBrowserDialog.show" ID="SvnLogBrowserDialog.show"></a>
547 <h4>SvnLogBrowserDialog.show</h4>
548 <b>show</b>(<i></i>)
549
550 <p>
551 Public slot to show the dialog.
552 </p>
553 <a NAME="SvnLogBrowserDialog.start" ID="SvnLogBrowserDialog.start"></a>
554 <h4>SvnLogBrowserDialog.start</h4>
555 <b>start</b>(<i>fn, isFile=False</i>)
556
557 <p>
558 Public slot to start the svn log command.
559 </p>
560 <dl>
561
562 <dt><i>fn</i></dt>
563 <dd>
564 filename to show the log for (string)
565 </dd>
566 <dt><i>isFile</i></dt>
567 <dd>
568 flag indicating log for a file is to be shown
569 (boolean)
570 </dd>
571 </dl>
572 <div align="right"><a href="#top">Up</a></div>
573 <hr />
574 </body></html>

eric ide

mercurial