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

eric ide

mercurial