src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9236
db53a9efe7ef
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog</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.vcsGit.GitLogBrowserDialog</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>COLORNAMES</td></tr><tr><td>COLORS</td></tr><tr><td>LIGHTCOLORS</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#GitLogBrowserDialog">GitLogBrowserDialog</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="GitLogBrowserDialog" ID="GitLogBrowserDialog"></a>
36 <h2>GitLogBrowserDialog</h2>
37
38 <p>
39 Class implementing a dialog to browse the log history.
40 </p>
41 <h3>Derived from</h3>
42 QWidget, Ui_GitLogBrowserDialog
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>AuthorColumn</td></tr><tr><td>BranchColumn</td></tr><tr><td>CommitDateColumn</td></tr><tr><td>CommitIdColumn</td></tr><tr><td>CommitterColumn</td></tr><tr><td>DateColumn</td></tr><tr><td>IconColumn</td></tr><tr><td>SubjectColumn</td></tr><tr><td>TagsColumn</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="#GitLogBrowserDialog.__init__">GitLogBrowserDialog</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#GitLogBrowserDialog.__actionMode">__actionMode</a></td>
63 <td>Private method to get the selected action mode.</td>
64 </tr>
65 <tr>
66 <td><a href="#GitLogBrowserDialog.__addFinishCallback">__addFinishCallback</a></td>
67 <td>Private method to add a method to be called once the process finished.</td>
68 </tr>
69 <tr>
70 <td><a href="#GitLogBrowserDialog.__branchActTriggered">__branchActTriggered</a></td>
71 <td>Private slot to create a new branch starting at the selected commit.</td>
72 </tr>
73 <tr>
74 <td><a href="#GitLogBrowserDialog.__branchSwitchActTriggered">__branchSwitchActTriggered</a></td>
75 <td>Private slot to create a new branch starting at the selected commit and switch the work tree to it.</td>
76 </tr>
77 <tr>
78 <td><a href="#GitLogBrowserDialog.__cherryActTriggered">__cherryActTriggered</a></td>
79 <td>Private slot to handle the Copy Commits action.</td>
80 </tr>
81 <tr>
82 <td><a href="#GitLogBrowserDialog.__commitIdClicked">__commitIdClicked</a></td>
83 <td>Private slot to handle the anchorClicked signal of the changeset details pane.</td>
84 </tr>
85 <tr>
86 <td><a href="#GitLogBrowserDialog.__describeActTriggered">__describeActTriggered</a></td>
87 <td>Private slot to show the most recent tag reachable from a commit.</td>
88 </tr>
89 <tr>
90 <td><a href="#GitLogBrowserDialog.__filterLogs">__filterLogs</a></td>
91 <td>Private method to filter the log entries.</td>
92 </tr>
93 <tr>
94 <td><a href="#GitLogBrowserDialog.__findItem">__findItem</a></td>
95 <td>Private slot to find an item matching the entered criteria.</td>
96 </tr>
97 <tr>
98 <td><a href="#GitLogBrowserDialog.__finish">__finish</a></td>
99 <td>Private slot called when the process finished or the user pressed the button.</td>
100 </tr>
101 <tr>
102 <td><a href="#GitLogBrowserDialog.__generateDetailsTableText">__generateDetailsTableText</a></td>
103 <td>Private method to generate an HTML table with the details of the given changeset.</td>
104 </tr>
105 <tr>
106 <td><a href="#GitLogBrowserDialog.__generateDiffs">__generateDiffs</a></td>
107 <td>Private slot to generate diff outputs for the selected item.</td>
108 </tr>
109 <tr>
110 <td><a href="#GitLogBrowserDialog.__generateEdges">__generateEdges</a></td>
111 <td>Private method to generate edge info for the give data.</td>
112 </tr>
113 <tr>
114 <td><a href="#GitLogBrowserDialog.__generateFileItem">__generateFileItem</a></td>
115 <td>Private method to generate a changed files tree entry.</td>
116 </tr>
117 <tr>
118 <td><a href="#GitLogBrowserDialog.__generateIcon">__generateIcon</a></td>
119 <td>Private method to generate an icon containing the revision tree for the given data.</td>
120 </tr>
121 <tr>
122 <td><a href="#GitLogBrowserDialog.__generateLogItem">__generateLogItem</a></td>
123 <td>Private method to generate a log tree entry.</td>
124 </tr>
125 <tr>
126 <td><a href="#GitLogBrowserDialog.__generatorFinished">__generatorFinished</a></td>
127 <td>Private slot connected to the finished signal of the diff generator.</td>
128 </tr>
129 <tr>
130 <td><a href="#GitLogBrowserDialog.__getBranchesForCommit">__getBranchesForCommit</a></td>
131 <td>Private method to get all branches reachable from a commit ID.</td>
132 </tr>
133 <tr>
134 <td><a href="#GitLogBrowserDialog.__getColor">__getColor</a></td>
135 <td>Private method to get the (rotating) name of the color given an index.</td>
136 </tr>
137 <tr>
138 <td><a href="#GitLogBrowserDialog.__getCommitForTag">__getCommitForTag</a></td>
139 <td>Private method to get the commit id for a tag.</td>
140 </tr>
141 <tr>
142 <td><a href="#GitLogBrowserDialog.__getLogEntries">__getLogEntries</a></td>
143 <td>Private method to retrieve log entries from the repository.</td>
144 </tr>
145 <tr>
146 <td><a href="#GitLogBrowserDialog.__getTagsForCommit">__getTagsForCommit</a></td>
147 <td>Private method to get all tags reachable from a commit ID.</td>
148 </tr>
149 <tr>
150 <td><a href="#GitLogBrowserDialog.__identifyProject">__identifyProject</a></td>
151 <td>Private method to determine the revision of the project directory.</td>
152 </tr>
153 <tr>
154 <td><a href="#GitLogBrowserDialog.__initActionsMenu">__initActionsMenu</a></td>
155 <td>Private method to initialize the actions menu.</td>
156 </tr>
157 <tr>
158 <td><a href="#GitLogBrowserDialog.__initData">__initData</a></td>
159 <td>Private method to (re-)initialize some data.</td>
160 </tr>
161 <tr>
162 <td><a href="#GitLogBrowserDialog.__initLogTreeContextMenu">__initLogTreeContextMenu</a></td>
163 <td>Private method to initialize the log tree context menu.</td>
164 </tr>
165 <tr>
166 <td><a href="#GitLogBrowserDialog.__mergeFileSeparators">__mergeFileSeparators</a></td>
167 <td>Private method to merge the file separator entries.</td>
168 </tr>
169 <tr>
170 <td><a href="#GitLogBrowserDialog.__prepareFieldSearch">__prepareFieldSearch</a></td>
171 <td>Private slot to prepare the filed search data.</td>
172 </tr>
173 <tr>
174 <td><a href="#GitLogBrowserDialog.__procFinished">__procFinished</a></td>
175 <td>Private slot connected to the finished signal.</td>
176 </tr>
177 <tr>
178 <td><a href="#GitLogBrowserDialog.__processBuffer">__processBuffer</a></td>
179 <td>Private method to process the buffered output of the git log command.</td>
180 </tr>
181 <tr>
182 <td><a href="#GitLogBrowserDialog.__processBufferItem">__processBufferItem</a></td>
183 <td>Private method to process a log entry.</td>
184 </tr>
185 <tr>
186 <td><a href="#GitLogBrowserDialog.__readStderr">__readStderr</a></td>
187 <td>Private slot to handle the readyReadStandardError signal.</td>
188 </tr>
189 <tr>
190 <td><a href="#GitLogBrowserDialog.__readStdout">__readStdout</a></td>
191 <td>Private slot to handle the readyReadStandardOutput signal.</td>
192 </tr>
193 <tr>
194 <td><a href="#GitLogBrowserDialog.__reloadGeometry">__reloadGeometry</a></td>
195 <td>Private method to restore the geometry.</td>
196 </tr>
197 <tr>
198 <td><a href="#GitLogBrowserDialog.__resetUI">__resetUI</a></td>
199 <td>Private method to reset the user interface.</td>
200 </tr>
201 <tr>
202 <td><a href="#GitLogBrowserDialog.__resizeColumnsFiles">__resizeColumnsFiles</a></td>
203 <td>Private method to resize the changed files tree columns.</td>
204 </tr>
205 <tr>
206 <td><a href="#GitLogBrowserDialog.__resizeColumnsLog">__resizeColumnsLog</a></td>
207 <td>Private method to resize the log tree columns.</td>
208 </tr>
209 <tr>
210 <td><a href="#GitLogBrowserDialog.__resortFiles">__resortFiles</a></td>
211 <td>Private method to resort the changed files tree.</td>
212 </tr>
213 <tr>
214 <td><a href="#GitLogBrowserDialog.__restoreSplitterStates">__restoreSplitterStates</a></td>
215 <td>Private method to restore the state of the various splitters.</td>
216 </tr>
217 <tr>
218 <td><a href="#GitLogBrowserDialog.__shortlogActTriggered">__shortlogActTriggered</a></td>
219 <td>Private slot to show a short log suitable for release announcements.</td>
220 </tr>
221 <tr>
222 <td><a href="#GitLogBrowserDialog.__showAuthorColumns">__showAuthorColumns</a></td>
223 <td>Private slot to show/hide the committer columns.</td>
224 </tr>
225 <tr>
226 <td><a href="#GitLogBrowserDialog.__showBranchesColumn">__showBranchesColumn</a></td>
227 <td>Private slot to show/hide the branches column.</td>
228 </tr>
229 <tr>
230 <td><a href="#GitLogBrowserDialog.__showCommitIdColumn">__showCommitIdColumn</a></td>
231 <td>Private slot to show/hide the commit ID column.</td>
232 </tr>
233 <tr>
234 <td><a href="#GitLogBrowserDialog.__showCommitterColumns">__showCommitterColumns</a></td>
235 <td>Private slot to show/hide the committer columns.</td>
236 </tr>
237 <tr>
238 <td><a href="#GitLogBrowserDialog.__showError">__showError</a></td>
239 <td>Private slot to show some error.</td>
240 </tr>
241 <tr>
242 <td><a href="#GitLogBrowserDialog.__showTagsColumn">__showTagsColumn</a></td>
243 <td>Private slot to show/hide the tags column.</td>
244 </tr>
245 <tr>
246 <td><a href="#GitLogBrowserDialog.__switchActTriggered">__switchActTriggered</a></td>
247 <td>Private slot to switch the working directory to the selected commit.</td>
248 </tr>
249 <tr>
250 <td><a href="#GitLogBrowserDialog.__tagActTriggered">__tagActTriggered</a></td>
251 <td>Private slot to tag the selected commit.</td>
252 </tr>
253 <tr>
254 <td><a href="#GitLogBrowserDialog.__updateDetailsAndFiles">__updateDetailsAndFiles</a></td>
255 <td>Private slot to update the details and file changes panes.</td>
256 </tr>
257 <tr>
258 <td><a href="#GitLogBrowserDialog.__updateFilesTree">__updateFilesTree</a></td>
259 <td>Private method to update the files tree with changes of the given item.</td>
260 </tr>
261 <tr>
262 <td><a href="#GitLogBrowserDialog.__updateSbsSelectLabel">__updateSbsSelectLabel</a></td>
263 <td>Private slot to update the enabled status of the diff buttons.</td>
264 </tr>
265 <tr>
266 <td><a href="#GitLogBrowserDialog.__updateToolMenuActions">__updateToolMenuActions</a></td>
267 <td>Private slot to update the status of the tool menu actions and the tool menu button.</td>
268 </tr>
269 <tr>
270 <td><a href="#GitLogBrowserDialog.closeEvent">closeEvent</a></td>
271 <td>Protected slot implementing a close event handler.</td>
272 </tr>
273 <tr>
274 <td><a href="#GitLogBrowserDialog.col2x">col2x</a></td>
275 <td>Local function to calculate a x-position for a column.</td>
276 </tr>
277 <tr>
278 <td><a href="#GitLogBrowserDialog.keyPressEvent">keyPressEvent</a></td>
279 <td>Protected slot to handle a key press event.</td>
280 </tr>
281 <tr>
282 <td><a href="#GitLogBrowserDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
283 <td>Private slot called by a button of the button box clicked.</td>
284 </tr>
285 <tr>
286 <td><a href="#GitLogBrowserDialog.on_diffSelectLabel_linkActivated">on_diffSelectLabel_linkActivated</a></td>
287 <td>Private slot to handle the selection of a diff target.</td>
288 </tr>
289 <tr>
290 <td><a href="#GitLogBrowserDialog.on_downButton_clicked">on_downButton_clicked</a></td>
291 <td>Private slot to move the current item down one entry.</td>
292 </tr>
293 <tr>
294 <td><a href="#GitLogBrowserDialog.on_fieldCombo_activated">on_fieldCombo_activated</a></td>
295 <td>Private slot called, when a new filter field is selected.</td>
296 </tr>
297 <tr>
298 <td><a href="#GitLogBrowserDialog.on_filesTree_currentItemChanged">on_filesTree_currentItemChanged</a></td>
299 <td>Private slot called, when the current item of the files tree changes.</td>
300 </tr>
301 <tr>
302 <td><a href="#GitLogBrowserDialog.on_findNextButton_clicked">on_findNextButton_clicked</a></td>
303 <td>Private slot to find the next item matching the entered criteria.</td>
304 </tr>
305 <tr>
306 <td><a href="#GitLogBrowserDialog.on_findPrevButton_clicked">on_findPrevButton_clicked</a></td>
307 <td>Private slot to find the previous item matching the entered criteria.</td>
308 </tr>
309 <tr>
310 <td><a href="#GitLogBrowserDialog.on_fromDate_dateChanged">on_fromDate_dateChanged</a></td>
311 <td>Private slot called, when the from date changes.</td>
312 </tr>
313 <tr>
314 <td><a href="#GitLogBrowserDialog.on_input_returnPressed">on_input_returnPressed</a></td>
315 <td>Private slot to handle the press of the return key in the input field.</td>
316 </tr>
317 <tr>
318 <td><a href="#GitLogBrowserDialog.on_logTree_currentItemChanged">on_logTree_currentItemChanged</a></td>
319 <td>Private slot called, when the current item of the log tree changes.</td>
320 </tr>
321 <tr>
322 <td><a href="#GitLogBrowserDialog.on_logTree_customContextMenuRequested">on_logTree_customContextMenuRequested</a></td>
323 <td>Private slot to show the context menu of the log tree.</td>
324 </tr>
325 <tr>
326 <td><a href="#GitLogBrowserDialog.on_logTree_itemSelectionChanged">on_logTree_itemSelectionChanged</a></td>
327 <td>Private slot called, when the selection has changed.</td>
328 </tr>
329 <tr>
330 <td><a href="#GitLogBrowserDialog.on_modeComboBox_currentIndexChanged">on_modeComboBox_currentIndexChanged</a></td>
331 <td>Private slot to react on mode changes.</td>
332 </tr>
333 <tr>
334 <td><a href="#GitLogBrowserDialog.on_nextButton_clicked">on_nextButton_clicked</a></td>
335 <td>Private slot to handle the Next button.</td>
336 </tr>
337 <tr>
338 <td><a href="#GitLogBrowserDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
339 <td>Private slot to handle the password checkbox toggled.</td>
340 </tr>
341 <tr>
342 <td><a href="#GitLogBrowserDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
343 <td>Private slot to refresh the log.</td>
344 </tr>
345 <tr>
346 <td><a href="#GitLogBrowserDialog.on_rxEdit_returnPressed">on_rxEdit_returnPressed</a></td>
347 <td>Private slot handling a press of the Return key in the rxEdit input.</td>
348 </tr>
349 <tr>
350 <td><a href="#GitLogBrowserDialog.on_rxEdit_textChanged">on_rxEdit_textChanged</a></td>
351 <td>Private slot called, when a filter expression is entered.</td>
352 </tr>
353 <tr>
354 <td><a href="#GitLogBrowserDialog.on_saveLabel_linkActivated">on_saveLabel_linkActivated</a></td>
355 <td>Private slot to handle the selection of the save link.</td>
356 </tr>
357 <tr>
358 <td><a href="#GitLogBrowserDialog.on_sbsSelectLabel_linkActivated">on_sbsSelectLabel_linkActivated</a></td>
359 <td>Private slot to handle selection of a side-by-side link.</td>
360 </tr>
361 <tr>
362 <td><a href="#GitLogBrowserDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
363 <td>Private slot to send the input to the git process.</td>
364 </tr>
365 <tr>
366 <td><a href="#GitLogBrowserDialog.on_stopCheckBox_clicked">on_stopCheckBox_clicked</a></td>
367 <td>Private slot called, when the stop on copy/move checkbox is clicked.</td>
368 </tr>
369 <tr>
370 <td><a href="#GitLogBrowserDialog.on_toDate_dateChanged">on_toDate_dateChanged</a></td>
371 <td>Private slot called, when the from date changes.</td>
372 </tr>
373 <tr>
374 <td><a href="#GitLogBrowserDialog.on_upButton_clicked">on_upButton_clicked</a></td>
375 <td>Private slot to move the current item up one entry.</td>
376 </tr>
377 <tr>
378 <td><a href="#GitLogBrowserDialog.show">show</a></td>
379 <td>Public slot to show the dialog.</td>
380 </tr>
381 <tr>
382 <td><a href="#GitLogBrowserDialog.start">start</a></td>
383 <td>Public slot to start the git log command.</td>
384 </tr>
385 </table>
386 <h3>Static Methods</h3>
387
388 <table>
389 <tr><td>None</td></tr>
390 </table>
391
392 <a NAME="GitLogBrowserDialog.__init__" ID="GitLogBrowserDialog.__init__"></a>
393 <h4>GitLogBrowserDialog (Constructor)</h4>
394 <b>GitLogBrowserDialog</b>(<i>vcs, parent=None</i>)
395
396 <p>
397 Constructor
398 </p>
399 <dl>
400
401 <dt><i>vcs</i></dt>
402 <dd>
403 reference to the vcs object
404 </dd>
405 <dt><i>parent</i></dt>
406 <dd>
407 parent widget (QWidget)
408 </dd>
409 </dl>
410 <a NAME="GitLogBrowserDialog.__actionMode" ID="GitLogBrowserDialog.__actionMode"></a>
411 <h4>GitLogBrowserDialog.__actionMode</h4>
412 <b>__actionMode</b>(<i></i>)
413
414 <p>
415 Private method to get the selected action mode.
416 </p>
417 <dl>
418 <dt>Return:</dt>
419 <dd>
420 selected action mode (string, one of filter or find)
421 </dd>
422 </dl>
423 <a NAME="GitLogBrowserDialog.__addFinishCallback" ID="GitLogBrowserDialog.__addFinishCallback"></a>
424 <h4>GitLogBrowserDialog.__addFinishCallback</h4>
425 <b>__addFinishCallback</b>(<i>callback</i>)
426
427 <p>
428 Private method to add a method to be called once the process finished.
429 </p>
430 <p>
431 The callback methods are invoke in a FIFO style and are consumed. If
432 a callback method needs to be called again, it must be added again.
433 </p>
434 <dl>
435
436 <dt><i>callback</i> (function)</dt>
437 <dd>
438 callback method
439 </dd>
440 </dl>
441 <a NAME="GitLogBrowserDialog.__branchActTriggered" ID="GitLogBrowserDialog.__branchActTriggered"></a>
442 <h4>GitLogBrowserDialog.__branchActTriggered</h4>
443 <b>__branchActTriggered</b>(<i></i>)
444
445 <p>
446 Private slot to create a new branch starting at the selected commit.
447 </p>
448 <a NAME="GitLogBrowserDialog.__branchSwitchActTriggered" ID="GitLogBrowserDialog.__branchSwitchActTriggered"></a>
449 <h4>GitLogBrowserDialog.__branchSwitchActTriggered</h4>
450 <b>__branchSwitchActTriggered</b>(<i></i>)
451
452 <p>
453 Private slot to create a new branch starting at the selected commit
454 and switch the work tree to it.
455 </p>
456 <a NAME="GitLogBrowserDialog.__cherryActTriggered" ID="GitLogBrowserDialog.__cherryActTriggered"></a>
457 <h4>GitLogBrowserDialog.__cherryActTriggered</h4>
458 <b>__cherryActTriggered</b>(<i></i>)
459
460 <p>
461 Private slot to handle the Copy Commits action.
462 </p>
463 <a NAME="GitLogBrowserDialog.__commitIdClicked" ID="GitLogBrowserDialog.__commitIdClicked"></a>
464 <h4>GitLogBrowserDialog.__commitIdClicked</h4>
465 <b>__commitIdClicked</b>(<i>url</i>)
466
467 <p>
468 Private slot to handle the anchorClicked signal of the changeset
469 details pane.
470 </p>
471 <dl>
472
473 <dt><i>url</i> (QUrl)</dt>
474 <dd>
475 URL that was clicked
476 </dd>
477 </dl>
478 <a NAME="GitLogBrowserDialog.__describeActTriggered" ID="GitLogBrowserDialog.__describeActTriggered"></a>
479 <h4>GitLogBrowserDialog.__describeActTriggered</h4>
480 <b>__describeActTriggered</b>(<i></i>)
481
482 <p>
483 Private slot to show the most recent tag reachable from a commit.
484 </p>
485 <a NAME="GitLogBrowserDialog.__filterLogs" ID="GitLogBrowserDialog.__filterLogs"></a>
486 <h4>GitLogBrowserDialog.__filterLogs</h4>
487 <b>__filterLogs</b>(<i></i>)
488
489 <p>
490 Private method to filter the log entries.
491 </p>
492 <a NAME="GitLogBrowserDialog.__findItem" ID="GitLogBrowserDialog.__findItem"></a>
493 <h4>GitLogBrowserDialog.__findItem</h4>
494 <b>__findItem</b>(<i>backwards=False, interactive=False</i>)
495
496 <p>
497 Private slot to find an item matching the entered criteria.
498 </p>
499 <dl>
500
501 <dt><i>backwards</i></dt>
502 <dd>
503 flag indicating to search backwards (boolean)
504 </dd>
505 <dt><i>interactive</i></dt>
506 <dd>
507 flag indicating an interactive search (boolean)
508 </dd>
509 </dl>
510 <a NAME="GitLogBrowserDialog.__finish" ID="GitLogBrowserDialog.__finish"></a>
511 <h4>GitLogBrowserDialog.__finish</h4>
512 <b>__finish</b>(<i></i>)
513
514 <p>
515 Private slot called when the process finished or the user pressed
516 the button.
517 </p>
518 <a NAME="GitLogBrowserDialog.__generateDetailsTableText" ID="GitLogBrowserDialog.__generateDetailsTableText"></a>
519 <h4>GitLogBrowserDialog.__generateDetailsTableText</h4>
520 <b>__generateDetailsTableText</b>(<i>itm</i>)
521
522 <p>
523 Private method to generate an HTML table with the details of the given
524 changeset.
525 </p>
526 <dl>
527
528 <dt><i>itm</i> (QTreeWidgetItem)</dt>
529 <dd>
530 reference to the item the table should be based on
531 </dd>
532 </dl>
533 <dl>
534 <dt>Return:</dt>
535 <dd>
536 HTML table containing details
537 </dd>
538 </dl>
539 <dl>
540 <dt>Return Type:</dt>
541 <dd>
542 str
543 </dd>
544 </dl>
545 <a NAME="GitLogBrowserDialog.__generateDiffs" ID="GitLogBrowserDialog.__generateDiffs"></a>
546 <h4>GitLogBrowserDialog.__generateDiffs</h4>
547 <b>__generateDiffs</b>(<i>parent=1</i>)
548
549 <p>
550 Private slot to generate diff outputs for the selected item.
551 </p>
552 <dl>
553
554 <dt><i>parent</i> (int)</dt>
555 <dd>
556 number of parent to diff against
557 </dd>
558 </dl>
559 <a NAME="GitLogBrowserDialog.__generateEdges" ID="GitLogBrowserDialog.__generateEdges"></a>
560 <h4>GitLogBrowserDialog.__generateEdges</h4>
561 <b>__generateEdges</b>(<i>commitId, parents</i>)
562
563 <p>
564 Private method to generate edge info for the give data.
565 </p>
566 <dl>
567
568 <dt><i>commitId</i></dt>
569 <dd>
570 commit id to calculate edge info for (string)
571 </dd>
572 <dt><i>parents</i></dt>
573 <dd>
574 list of parent commits (list of strings)
575 </dd>
576 </dl>
577 <dl>
578 <dt>Return:</dt>
579 <dd>
580 tuple containing the column and color index for
581 the given node and a list of tuples indicating the edges
582 between the given node and its parents
583 (integer, integer, [(integer, integer, integer), ...])
584 </dd>
585 </dl>
586 <a NAME="GitLogBrowserDialog.__generateFileItem" ID="GitLogBrowserDialog.__generateFileItem"></a>
587 <h4>GitLogBrowserDialog.__generateFileItem</h4>
588 <b>__generateFileItem</b>(<i>action, path, copyfrom, additions, deletions</i>)
589
590 <p>
591 Private method to generate a changed files tree entry.
592 </p>
593 <dl>
594
595 <dt><i>action</i></dt>
596 <dd>
597 indicator for the change action ("A", "C", "D", "M",
598 "R", "T", "U", "X")
599 </dd>
600 <dt><i>path</i></dt>
601 <dd>
602 path of the file in the repository (string)
603 </dd>
604 <dt><i>copyfrom</i></dt>
605 <dd>
606 path the file was copied from (string)
607 </dd>
608 <dt><i>additions</i></dt>
609 <dd>
610 number of added lines (int)
611 </dd>
612 <dt><i>deletions</i></dt>
613 <dd>
614 number of deleted lines (int)
615 </dd>
616 </dl>
617 <dl>
618 <dt>Return:</dt>
619 <dd>
620 reference to the generated item (QTreeWidgetItem)
621 </dd>
622 </dl>
623 <a NAME="GitLogBrowserDialog.__generateIcon" ID="GitLogBrowserDialog.__generateIcon"></a>
624 <h4>GitLogBrowserDialog.__generateIcon</h4>
625 <b>__generateIcon</b>(<i>column, color, bottomedges, topedges, dotColor, currentCommit</i>)
626
627 <p>
628 Private method to generate an icon containing the revision tree for the
629 given data.
630 </p>
631 <dl>
632
633 <dt><i>column</i></dt>
634 <dd>
635 column index of the revision (integer)
636 </dd>
637 <dt><i>color</i></dt>
638 <dd>
639 color of the node (integer)
640 </dd>
641 <dt><i>bottomedges</i></dt>
642 <dd>
643 list of edges for the bottom of the node
644 (list of tuples of three integers)
645 </dd>
646 <dt><i>topedges</i></dt>
647 <dd>
648 list of edges for the top of the node
649 (list of tuples of three integers)
650 </dd>
651 <dt><i>dotColor</i></dt>
652 <dd>
653 color to be used for the dot (QColor)
654 </dd>
655 <dt><i>currentCommit</i></dt>
656 <dd>
657 flag indicating to draw the icon for the
658 current commit (boolean)
659 </dd>
660 </dl>
661 <dl>
662 <dt>Return:</dt>
663 <dd>
664 icon for the node (QIcon)
665 </dd>
666 </dl>
667 <a NAME="GitLogBrowserDialog.__generateLogItem" ID="GitLogBrowserDialog.__generateLogItem"></a>
668 <h4>GitLogBrowserDialog.__generateLogItem</h4>
669 <b>__generateLogItem</b>(<i>author, date, committer, commitDate, subject, message, commitId, changedPaths, parents, refnames, authorMail, committerMail</i>)
670
671 <p>
672 Private method to generate a log tree entry.
673 </p>
674 <dl>
675
676 <dt><i>author</i></dt>
677 <dd>
678 author info (string)
679 </dd>
680 <dt><i>date</i></dt>
681 <dd>
682 date info (string)
683 </dd>
684 <dt><i>committer</i></dt>
685 <dd>
686 committer info (string)
687 </dd>
688 <dt><i>commitDate</i></dt>
689 <dd>
690 commit date info (string)
691 </dd>
692 <dt><i>subject</i></dt>
693 <dd>
694 subject of the log entry (string)
695 </dd>
696 <dt><i>message</i></dt>
697 <dd>
698 text of the log message (list of strings)
699 </dd>
700 <dt><i>commitId</i></dt>
701 <dd>
702 commit id info (string)
703 </dd>
704 <dt><i>changedPaths</i></dt>
705 <dd>
706 list of dictionary objects containing
707 info about the changed files/directories
708 </dd>
709 <dt><i>parents</i></dt>
710 <dd>
711 list of parent revisions (list of integers)
712 </dd>
713 <dt><i>refnames</i></dt>
714 <dd>
715 tags and branches of the commit (string)
716 </dd>
717 <dt><i>authorMail</i></dt>
718 <dd>
719 author's email address (string)
720 </dd>
721 <dt><i>committerMail</i></dt>
722 <dd>
723 committer's email address (string)
724 </dd>
725 </dl>
726 <dl>
727 <dt>Return:</dt>
728 <dd>
729 reference to the generated item (QTreeWidgetItem)
730 </dd>
731 </dl>
732 <a NAME="GitLogBrowserDialog.__generatorFinished" ID="GitLogBrowserDialog.__generatorFinished"></a>
733 <h4>GitLogBrowserDialog.__generatorFinished</h4>
734 <b>__generatorFinished</b>(<i></i>)
735
736 <p>
737 Private slot connected to the finished signal of the diff generator.
738 </p>
739 <a NAME="GitLogBrowserDialog.__getBranchesForCommit" ID="GitLogBrowserDialog.__getBranchesForCommit"></a>
740 <h4>GitLogBrowserDialog.__getBranchesForCommit</h4>
741 <b>__getBranchesForCommit</b>(<i>commitId</i>)
742
743 <p>
744 Private method to get all branches reachable from a commit ID.
745 </p>
746 <dl>
747
748 <dt><i>commitId</i> (str)</dt>
749 <dd>
750 commit ID to get the branches for
751 </dd>
752 </dl>
753 <dl>
754 <dt>Return:</dt>
755 <dd>
756 list of tuples containing the branch name and the associated
757 commit ID of its branch head
758 </dd>
759 </dl>
760 <dl>
761 <dt>Return Type:</dt>
762 <dd>
763 tuple of (str, str)
764 </dd>
765 </dl>
766 <a NAME="GitLogBrowserDialog.__getColor" ID="GitLogBrowserDialog.__getColor"></a>
767 <h4>GitLogBrowserDialog.__getColor</h4>
768 <b>__getColor</b>(<i>n</i>)
769
770 <p>
771 Private method to get the (rotating) name of the color given an index.
772 </p>
773 <dl>
774
775 <dt><i>n</i> (int)</dt>
776 <dd>
777 color index
778 </dd>
779 </dl>
780 <dl>
781 <dt>Return:</dt>
782 <dd>
783 color name
784 </dd>
785 </dl>
786 <dl>
787 <dt>Return Type:</dt>
788 <dd>
789 str
790 </dd>
791 </dl>
792 <a NAME="GitLogBrowserDialog.__getCommitForTag" ID="GitLogBrowserDialog.__getCommitForTag"></a>
793 <h4>GitLogBrowserDialog.__getCommitForTag</h4>
794 <b>__getCommitForTag</b>(<i>tag</i>)
795
796 <p>
797 Private method to get the commit id for a tag.
798 </p>
799 <dl>
800
801 <dt><i>tag</i></dt>
802 <dd>
803 tag name (string)
804 </dd>
805 </dl>
806 <dl>
807 <dt>Return:</dt>
808 <dd>
809 commit id shortened to 10 characters (string)
810 </dd>
811 </dl>
812 <a NAME="GitLogBrowserDialog.__getLogEntries" ID="GitLogBrowserDialog.__getLogEntries"></a>
813 <h4>GitLogBrowserDialog.__getLogEntries</h4>
814 <b>__getLogEntries</b>(<i>skip=0, noEntries=0</i>)
815
816 <p>
817 Private method to retrieve log entries from the repository.
818 </p>
819 <dl>
820
821 <dt><i>skip</i></dt>
822 <dd>
823 number of log entries to skip (integer)
824 </dd>
825 <dt><i>noEntries</i></dt>
826 <dd>
827 number of entries to get (0 = default) (int)
828 </dd>
829 </dl>
830 <a NAME="GitLogBrowserDialog.__getTagsForCommit" ID="GitLogBrowserDialog.__getTagsForCommit"></a>
831 <h4>GitLogBrowserDialog.__getTagsForCommit</h4>
832 <b>__getTagsForCommit</b>(<i>commitId</i>)
833
834 <p>
835 Private method to get all tags reachable from a commit ID.
836 </p>
837 <dl>
838
839 <dt><i>commitId</i> (str)</dt>
840 <dd>
841 commit ID to get the tags for
842 </dd>
843 </dl>
844 <dl>
845 <dt>Return:</dt>
846 <dd>
847 list of tuples containing the tag name and the associated
848 commit ID
849 </dd>
850 </dl>
851 <dl>
852 <dt>Return Type:</dt>
853 <dd>
854 tuple of (str, str)
855 </dd>
856 </dl>
857 <a NAME="GitLogBrowserDialog.__identifyProject" ID="GitLogBrowserDialog.__identifyProject"></a>
858 <h4>GitLogBrowserDialog.__identifyProject</h4>
859 <b>__identifyProject</b>(<i></i>)
860
861 <p>
862 Private method to determine the revision of the project directory.
863 </p>
864 <a NAME="GitLogBrowserDialog.__initActionsMenu" ID="GitLogBrowserDialog.__initActionsMenu"></a>
865 <h4>GitLogBrowserDialog.__initActionsMenu</h4>
866 <b>__initActionsMenu</b>(<i></i>)
867
868 <p>
869 Private method to initialize the actions menu.
870 </p>
871 <a NAME="GitLogBrowserDialog.__initData" ID="GitLogBrowserDialog.__initData"></a>
872 <h4>GitLogBrowserDialog.__initData</h4>
873 <b>__initData</b>(<i></i>)
874
875 <p>
876 Private method to (re-)initialize some data.
877 </p>
878 <a NAME="GitLogBrowserDialog.__initLogTreeContextMenu" ID="GitLogBrowserDialog.__initLogTreeContextMenu"></a>
879 <h4>GitLogBrowserDialog.__initLogTreeContextMenu</h4>
880 <b>__initLogTreeContextMenu</b>(<i></i>)
881
882 <p>
883 Private method to initialize the log tree context menu.
884 </p>
885 <a NAME="GitLogBrowserDialog.__mergeFileSeparators" ID="GitLogBrowserDialog.__mergeFileSeparators"></a>
886 <h4>GitLogBrowserDialog.__mergeFileSeparators</h4>
887 <b>__mergeFileSeparators</b>(<i>fileSeparators</i>)
888
889 <p>
890 Private method to merge the file separator entries.
891 </p>
892 <dl>
893
894 <dt><i>fileSeparators</i></dt>
895 <dd>
896 list of file separator entries to be merged
897 </dd>
898 </dl>
899 <dl>
900 <dt>Return:</dt>
901 <dd>
902 merged list of file separator entries
903 </dd>
904 </dl>
905 <a NAME="GitLogBrowserDialog.__prepareFieldSearch" ID="GitLogBrowserDialog.__prepareFieldSearch"></a>
906 <h4>GitLogBrowserDialog.__prepareFieldSearch</h4>
907 <b>__prepareFieldSearch</b>(<i></i>)
908
909 <p>
910 Private slot to prepare the filed search data.
911 </p>
912 <dl>
913 <dt>Return:</dt>
914 <dd>
915 tuple of field index, search expression and flag indicating
916 that the field index is a data role (integer, string, boolean)
917 </dd>
918 </dl>
919 <a NAME="GitLogBrowserDialog.__procFinished" ID="GitLogBrowserDialog.__procFinished"></a>
920 <h4>GitLogBrowserDialog.__procFinished</h4>
921 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
922
923 <p>
924 Private slot connected to the finished signal.
925 </p>
926 <dl>
927
928 <dt><i>exitCode</i></dt>
929 <dd>
930 exit code of the process (integer)
931 </dd>
932 <dt><i>exitStatus</i></dt>
933 <dd>
934 exit status of the process (QProcess.ExitStatus)
935 </dd>
936 </dl>
937 <a NAME="GitLogBrowserDialog.__processBuffer" ID="GitLogBrowserDialog.__processBuffer"></a>
938 <h4>GitLogBrowserDialog.__processBuffer</h4>
939 <b>__processBuffer</b>(<i></i>)
940
941 <p>
942 Private method to process the buffered output of the git log command.
943 </p>
944 <a NAME="GitLogBrowserDialog.__processBufferItem" ID="GitLogBrowserDialog.__processBufferItem"></a>
945 <h4>GitLogBrowserDialog.__processBufferItem</h4>
946 <b>__processBufferItem</b>(<i>logEntry</i>)
947
948 <p>
949 Private method to process a log entry.
950 </p>
951 <dl>
952
953 <dt><i>logEntry</i></dt>
954 <dd>
955 dictionary as generated by __processBuffer
956 </dd>
957 </dl>
958 <a NAME="GitLogBrowserDialog.__readStderr" ID="GitLogBrowserDialog.__readStderr"></a>
959 <h4>GitLogBrowserDialog.__readStderr</h4>
960 <b>__readStderr</b>(<i></i>)
961
962 <p>
963 Private slot to handle the readyReadStandardError signal.
964 </p>
965 <p>
966 It reads the error output of the process and inserts it into the
967 error pane.
968 </p>
969 <a NAME="GitLogBrowserDialog.__readStdout" ID="GitLogBrowserDialog.__readStdout"></a>
970 <h4>GitLogBrowserDialog.__readStdout</h4>
971 <b>__readStdout</b>(<i></i>)
972
973 <p>
974 Private slot to handle the readyReadStandardOutput signal.
975 </p>
976 <p>
977 It reads the output of the process and inserts it into a buffer.
978 </p>
979 <a NAME="GitLogBrowserDialog.__reloadGeometry" ID="GitLogBrowserDialog.__reloadGeometry"></a>
980 <h4>GitLogBrowserDialog.__reloadGeometry</h4>
981 <b>__reloadGeometry</b>(<i></i>)
982
983 <p>
984 Private method to restore the geometry.
985 </p>
986 <a NAME="GitLogBrowserDialog.__resetUI" ID="GitLogBrowserDialog.__resetUI"></a>
987 <h4>GitLogBrowserDialog.__resetUI</h4>
988 <b>__resetUI</b>(<i></i>)
989
990 <p>
991 Private method to reset the user interface.
992 </p>
993 <a NAME="GitLogBrowserDialog.__resizeColumnsFiles" ID="GitLogBrowserDialog.__resizeColumnsFiles"></a>
994 <h4>GitLogBrowserDialog.__resizeColumnsFiles</h4>
995 <b>__resizeColumnsFiles</b>(<i></i>)
996
997 <p>
998 Private method to resize the changed files tree columns.
999 </p>
1000 <a NAME="GitLogBrowserDialog.__resizeColumnsLog" ID="GitLogBrowserDialog.__resizeColumnsLog"></a>
1001 <h4>GitLogBrowserDialog.__resizeColumnsLog</h4>
1002 <b>__resizeColumnsLog</b>(<i></i>)
1003
1004 <p>
1005 Private method to resize the log tree columns.
1006 </p>
1007 <a NAME="GitLogBrowserDialog.__resortFiles" ID="GitLogBrowserDialog.__resortFiles"></a>
1008 <h4>GitLogBrowserDialog.__resortFiles</h4>
1009 <b>__resortFiles</b>(<i></i>)
1010
1011 <p>
1012 Private method to resort the changed files tree.
1013 </p>
1014 <a NAME="GitLogBrowserDialog.__restoreSplitterStates" ID="GitLogBrowserDialog.__restoreSplitterStates"></a>
1015 <h4>GitLogBrowserDialog.__restoreSplitterStates</h4>
1016 <b>__restoreSplitterStates</b>(<i></i>)
1017
1018 <p>
1019 Private method to restore the state of the various splitters.
1020 </p>
1021 <a NAME="GitLogBrowserDialog.__shortlogActTriggered" ID="GitLogBrowserDialog.__shortlogActTriggered"></a>
1022 <h4>GitLogBrowserDialog.__shortlogActTriggered</h4>
1023 <b>__shortlogActTriggered</b>(<i></i>)
1024
1025 <p>
1026 Private slot to show a short log suitable for release announcements.
1027 </p>
1028 <a NAME="GitLogBrowserDialog.__showAuthorColumns" ID="GitLogBrowserDialog.__showAuthorColumns"></a>
1029 <h4>GitLogBrowserDialog.__showAuthorColumns</h4>
1030 <b>__showAuthorColumns</b>(<i>on</i>)
1031
1032 <p>
1033 Private slot to show/hide the committer columns.
1034 </p>
1035 <dl>
1036
1037 <dt><i>on</i></dt>
1038 <dd>
1039 flag indicating the selection state (boolean)
1040 </dd>
1041 </dl>
1042 <a NAME="GitLogBrowserDialog.__showBranchesColumn" ID="GitLogBrowserDialog.__showBranchesColumn"></a>
1043 <h4>GitLogBrowserDialog.__showBranchesColumn</h4>
1044 <b>__showBranchesColumn</b>(<i>on</i>)
1045
1046 <p>
1047 Private slot to show/hide the branches column.
1048 </p>
1049 <dl>
1050
1051 <dt><i>on</i></dt>
1052 <dd>
1053 flag indicating the selection state (boolean)
1054 </dd>
1055 </dl>
1056 <a NAME="GitLogBrowserDialog.__showCommitIdColumn" ID="GitLogBrowserDialog.__showCommitIdColumn"></a>
1057 <h4>GitLogBrowserDialog.__showCommitIdColumn</h4>
1058 <b>__showCommitIdColumn</b>(<i>on</i>)
1059
1060 <p>
1061 Private slot to show/hide the commit ID column.
1062 </p>
1063 <dl>
1064
1065 <dt><i>on</i></dt>
1066 <dd>
1067 flag indicating the selection state (boolean)
1068 </dd>
1069 </dl>
1070 <a NAME="GitLogBrowserDialog.__showCommitterColumns" ID="GitLogBrowserDialog.__showCommitterColumns"></a>
1071 <h4>GitLogBrowserDialog.__showCommitterColumns</h4>
1072 <b>__showCommitterColumns</b>(<i>on</i>)
1073
1074 <p>
1075 Private slot to show/hide the committer columns.
1076 </p>
1077 <dl>
1078
1079 <dt><i>on</i></dt>
1080 <dd>
1081 flag indicating the selection state (boolean)
1082 </dd>
1083 </dl>
1084 <a NAME="GitLogBrowserDialog.__showError" ID="GitLogBrowserDialog.__showError"></a>
1085 <h4>GitLogBrowserDialog.__showError</h4>
1086 <b>__showError</b>(<i>out</i>)
1087
1088 <p>
1089 Private slot to show some error.
1090 </p>
1091 <dl>
1092
1093 <dt><i>out</i></dt>
1094 <dd>
1095 error to be shown (string)
1096 </dd>
1097 </dl>
1098 <a NAME="GitLogBrowserDialog.__showTagsColumn" ID="GitLogBrowserDialog.__showTagsColumn"></a>
1099 <h4>GitLogBrowserDialog.__showTagsColumn</h4>
1100 <b>__showTagsColumn</b>(<i>on</i>)
1101
1102 <p>
1103 Private slot to show/hide the tags column.
1104 </p>
1105 <dl>
1106
1107 <dt><i>on</i></dt>
1108 <dd>
1109 flag indicating the selection state (boolean)
1110 </dd>
1111 </dl>
1112 <a NAME="GitLogBrowserDialog.__switchActTriggered" ID="GitLogBrowserDialog.__switchActTriggered"></a>
1113 <h4>GitLogBrowserDialog.__switchActTriggered</h4>
1114 <b>__switchActTriggered</b>(<i></i>)
1115
1116 <p>
1117 Private slot to switch the working directory to the
1118 selected commit.
1119 </p>
1120 <a NAME="GitLogBrowserDialog.__tagActTriggered" ID="GitLogBrowserDialog.__tagActTriggered"></a>
1121 <h4>GitLogBrowserDialog.__tagActTriggered</h4>
1122 <b>__tagActTriggered</b>(<i></i>)
1123
1124 <p>
1125 Private slot to tag the selected commit.
1126 </p>
1127 <a NAME="GitLogBrowserDialog.__updateDetailsAndFiles" ID="GitLogBrowserDialog.__updateDetailsAndFiles"></a>
1128 <h4>GitLogBrowserDialog.__updateDetailsAndFiles</h4>
1129 <b>__updateDetailsAndFiles</b>(<i></i>)
1130
1131 <p>
1132 Private slot to update the details and file changes panes.
1133 </p>
1134 <a NAME="GitLogBrowserDialog.__updateFilesTree" ID="GitLogBrowserDialog.__updateFilesTree"></a>
1135 <h4>GitLogBrowserDialog.__updateFilesTree</h4>
1136 <b>__updateFilesTree</b>(<i>parent, itm</i>)
1137
1138 <p>
1139 Private method to update the files tree with changes of the given item.
1140 </p>
1141 <dl>
1142
1143 <dt><i>parent</i> (QTreeWidget or QTreeWidgetItem)</dt>
1144 <dd>
1145 parent for the items to be added
1146 </dd>
1147 <dt><i>itm</i> (QTreeWidgetItem)</dt>
1148 <dd>
1149 reference to the item the update should be based on
1150 </dd>
1151 </dl>
1152 <a NAME="GitLogBrowserDialog.__updateSbsSelectLabel" ID="GitLogBrowserDialog.__updateSbsSelectLabel"></a>
1153 <h4>GitLogBrowserDialog.__updateSbsSelectLabel</h4>
1154 <b>__updateSbsSelectLabel</b>(<i></i>)
1155
1156 <p>
1157 Private slot to update the enabled status of the diff buttons.
1158 </p>
1159 <a NAME="GitLogBrowserDialog.__updateToolMenuActions" ID="GitLogBrowserDialog.__updateToolMenuActions"></a>
1160 <h4>GitLogBrowserDialog.__updateToolMenuActions</h4>
1161 <b>__updateToolMenuActions</b>(<i></i>)
1162
1163 <p>
1164 Private slot to update the status of the tool menu actions and
1165 the tool menu button.
1166 </p>
1167 <a NAME="GitLogBrowserDialog.closeEvent" ID="GitLogBrowserDialog.closeEvent"></a>
1168 <h4>GitLogBrowserDialog.closeEvent</h4>
1169 <b>closeEvent</b>(<i>e</i>)
1170
1171 <p>
1172 Protected slot implementing a close event handler.
1173 </p>
1174 <dl>
1175
1176 <dt><i>e</i></dt>
1177 <dd>
1178 close event (QCloseEvent)
1179 </dd>
1180 </dl>
1181 <a NAME="GitLogBrowserDialog.col2x" ID="GitLogBrowserDialog.col2x"></a>
1182 <h4>GitLogBrowserDialog.col2x</h4>
1183 <b>col2x</b>(<i>radius</i>)
1184
1185 <p>
1186 Local function to calculate a x-position for a column.
1187 </p>
1188 <dl>
1189
1190 <dt><i>col</i></dt>
1191 <dd>
1192 column number (integer)
1193 </dd>
1194 <dt><i>radius</i></dt>
1195 <dd>
1196 radius of the indicator circle (integer)
1197 </dd>
1198 </dl>
1199 <a NAME="GitLogBrowserDialog.keyPressEvent" ID="GitLogBrowserDialog.keyPressEvent"></a>
1200 <h4>GitLogBrowserDialog.keyPressEvent</h4>
1201 <b>keyPressEvent</b>(<i>evt</i>)
1202
1203 <p>
1204 Protected slot to handle a key press event.
1205 </p>
1206 <dl>
1207
1208 <dt><i>evt</i></dt>
1209 <dd>
1210 the key press event (QKeyEvent)
1211 </dd>
1212 </dl>
1213 <a NAME="GitLogBrowserDialog.on_buttonBox_clicked" ID="GitLogBrowserDialog.on_buttonBox_clicked"></a>
1214 <h4>GitLogBrowserDialog.on_buttonBox_clicked</h4>
1215 <b>on_buttonBox_clicked</b>(<i>button</i>)
1216
1217 <p>
1218 Private slot called by a button of the button box clicked.
1219 </p>
1220 <dl>
1221
1222 <dt><i>button</i></dt>
1223 <dd>
1224 button that was clicked (QAbstractButton)
1225 </dd>
1226 </dl>
1227 <a NAME="GitLogBrowserDialog.on_diffSelectLabel_linkActivated" ID="GitLogBrowserDialog.on_diffSelectLabel_linkActivated"></a>
1228 <h4>GitLogBrowserDialog.on_diffSelectLabel_linkActivated</h4>
1229 <b>on_diffSelectLabel_linkActivated</b>(<i>link</i>)
1230
1231 <p>
1232 Private slot to handle the selection of a diff target.
1233 </p>
1234 <dl>
1235
1236 <dt><i>link</i> (str)</dt>
1237 <dd>
1238 activated link
1239 </dd>
1240 </dl>
1241 <a NAME="GitLogBrowserDialog.on_downButton_clicked" ID="GitLogBrowserDialog.on_downButton_clicked"></a>
1242 <h4>GitLogBrowserDialog.on_downButton_clicked</h4>
1243 <b>on_downButton_clicked</b>(<i></i>)
1244
1245 <p>
1246 Private slot to move the current item down one entry.
1247 </p>
1248 <a NAME="GitLogBrowserDialog.on_fieldCombo_activated" ID="GitLogBrowserDialog.on_fieldCombo_activated"></a>
1249 <h4>GitLogBrowserDialog.on_fieldCombo_activated</h4>
1250 <b>on_fieldCombo_activated</b>(<i>index</i>)
1251
1252 <p>
1253 Private slot called, when a new filter field is selected.
1254 </p>
1255 <dl>
1256
1257 <dt><i>index</i> (int)</dt>
1258 <dd>
1259 index of the selected entry
1260 </dd>
1261 </dl>
1262 <a NAME="GitLogBrowserDialog.on_filesTree_currentItemChanged" ID="GitLogBrowserDialog.on_filesTree_currentItemChanged"></a>
1263 <h4>GitLogBrowserDialog.on_filesTree_currentItemChanged</h4>
1264 <b>on_filesTree_currentItemChanged</b>(<i>current, previous</i>)
1265
1266 <p>
1267 Private slot called, when the current item of the files tree changes.
1268 </p>
1269 <dl>
1270
1271 <dt><i>current</i></dt>
1272 <dd>
1273 reference to the new current item (QTreeWidgetItem)
1274 </dd>
1275 <dt><i>previous</i></dt>
1276 <dd>
1277 reference to the old current item (QTreeWidgetItem)
1278 </dd>
1279 </dl>
1280 <a NAME="GitLogBrowserDialog.on_findNextButton_clicked" ID="GitLogBrowserDialog.on_findNextButton_clicked"></a>
1281 <h4>GitLogBrowserDialog.on_findNextButton_clicked</h4>
1282 <b>on_findNextButton_clicked</b>(<i></i>)
1283
1284 <p>
1285 Private slot to find the next item matching the entered criteria.
1286 </p>
1287 <a NAME="GitLogBrowserDialog.on_findPrevButton_clicked" ID="GitLogBrowserDialog.on_findPrevButton_clicked"></a>
1288 <h4>GitLogBrowserDialog.on_findPrevButton_clicked</h4>
1289 <b>on_findPrevButton_clicked</b>(<i></i>)
1290
1291 <p>
1292 Private slot to find the previous item matching the entered criteria.
1293 </p>
1294 <a NAME="GitLogBrowserDialog.on_fromDate_dateChanged" ID="GitLogBrowserDialog.on_fromDate_dateChanged"></a>
1295 <h4>GitLogBrowserDialog.on_fromDate_dateChanged</h4>
1296 <b>on_fromDate_dateChanged</b>(<i>date</i>)
1297
1298 <p>
1299 Private slot called, when the from date changes.
1300 </p>
1301 <dl>
1302
1303 <dt><i>date</i></dt>
1304 <dd>
1305 new date (QDate)
1306 </dd>
1307 </dl>
1308 <a NAME="GitLogBrowserDialog.on_input_returnPressed" ID="GitLogBrowserDialog.on_input_returnPressed"></a>
1309 <h4>GitLogBrowserDialog.on_input_returnPressed</h4>
1310 <b>on_input_returnPressed</b>(<i></i>)
1311
1312 <p>
1313 Private slot to handle the press of the return key in the input field.
1314 </p>
1315 <a NAME="GitLogBrowserDialog.on_logTree_currentItemChanged" ID="GitLogBrowserDialog.on_logTree_currentItemChanged"></a>
1316 <h4>GitLogBrowserDialog.on_logTree_currentItemChanged</h4>
1317 <b>on_logTree_currentItemChanged</b>(<i>current, previous</i>)
1318
1319 <p>
1320 Private slot called, when the current item of the log tree changes.
1321 </p>
1322 <dl>
1323
1324 <dt><i>current</i></dt>
1325 <dd>
1326 reference to the new current item (QTreeWidgetItem)
1327 </dd>
1328 <dt><i>previous</i></dt>
1329 <dd>
1330 reference to the old current item (QTreeWidgetItem)
1331 </dd>
1332 </dl>
1333 <a NAME="GitLogBrowserDialog.on_logTree_customContextMenuRequested" ID="GitLogBrowserDialog.on_logTree_customContextMenuRequested"></a>
1334 <h4>GitLogBrowserDialog.on_logTree_customContextMenuRequested</h4>
1335 <b>on_logTree_customContextMenuRequested</b>(<i>pos</i>)
1336
1337 <p>
1338 Private slot to show the context menu of the log tree.
1339 </p>
1340 <dl>
1341
1342 <dt><i>pos</i></dt>
1343 <dd>
1344 position of the mouse pointer (QPoint)
1345 </dd>
1346 </dl>
1347 <a NAME="GitLogBrowserDialog.on_logTree_itemSelectionChanged" ID="GitLogBrowserDialog.on_logTree_itemSelectionChanged"></a>
1348 <h4>GitLogBrowserDialog.on_logTree_itemSelectionChanged</h4>
1349 <b>on_logTree_itemSelectionChanged</b>(<i></i>)
1350
1351 <p>
1352 Private slot called, when the selection has changed.
1353 </p>
1354 <a NAME="GitLogBrowserDialog.on_modeComboBox_currentIndexChanged" ID="GitLogBrowserDialog.on_modeComboBox_currentIndexChanged"></a>
1355 <h4>GitLogBrowserDialog.on_modeComboBox_currentIndexChanged</h4>
1356 <b>on_modeComboBox_currentIndexChanged</b>(<i>index</i>)
1357
1358 <p>
1359 Private slot to react on mode changes.
1360 </p>
1361 <dl>
1362
1363 <dt><i>index</i></dt>
1364 <dd>
1365 index of the selected entry (integer)
1366 </dd>
1367 </dl>
1368 <a NAME="GitLogBrowserDialog.on_nextButton_clicked" ID="GitLogBrowserDialog.on_nextButton_clicked"></a>
1369 <h4>GitLogBrowserDialog.on_nextButton_clicked</h4>
1370 <b>on_nextButton_clicked</b>(<i></i>)
1371
1372 <p>
1373 Private slot to handle the Next button.
1374 </p>
1375 <a NAME="GitLogBrowserDialog.on_passwordCheckBox_toggled" ID="GitLogBrowserDialog.on_passwordCheckBox_toggled"></a>
1376 <h4>GitLogBrowserDialog.on_passwordCheckBox_toggled</h4>
1377 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
1378
1379 <p>
1380 Private slot to handle the password checkbox toggled.
1381 </p>
1382 <dl>
1383
1384 <dt><i>isOn</i></dt>
1385 <dd>
1386 flag indicating the status of the check box (boolean)
1387 </dd>
1388 </dl>
1389 <a NAME="GitLogBrowserDialog.on_refreshButton_clicked" ID="GitLogBrowserDialog.on_refreshButton_clicked"></a>
1390 <h4>GitLogBrowserDialog.on_refreshButton_clicked</h4>
1391 <b>on_refreshButton_clicked</b>(<i></i>)
1392
1393 <p>
1394 Private slot to refresh the log.
1395 </p>
1396 <a NAME="GitLogBrowserDialog.on_rxEdit_returnPressed" ID="GitLogBrowserDialog.on_rxEdit_returnPressed"></a>
1397 <h4>GitLogBrowserDialog.on_rxEdit_returnPressed</h4>
1398 <b>on_rxEdit_returnPressed</b>(<i></i>)
1399
1400 <p>
1401 Private slot handling a press of the Return key in the rxEdit input.
1402 </p>
1403 <a NAME="GitLogBrowserDialog.on_rxEdit_textChanged" ID="GitLogBrowserDialog.on_rxEdit_textChanged"></a>
1404 <h4>GitLogBrowserDialog.on_rxEdit_textChanged</h4>
1405 <b>on_rxEdit_textChanged</b>(<i>txt</i>)
1406
1407 <p>
1408 Private slot called, when a filter expression is entered.
1409 </p>
1410 <dl>
1411
1412 <dt><i>txt</i></dt>
1413 <dd>
1414 filter expression (string)
1415 </dd>
1416 </dl>
1417 <a NAME="GitLogBrowserDialog.on_saveLabel_linkActivated" ID="GitLogBrowserDialog.on_saveLabel_linkActivated"></a>
1418 <h4>GitLogBrowserDialog.on_saveLabel_linkActivated</h4>
1419 <b>on_saveLabel_linkActivated</b>(<i>link</i>)
1420
1421 <p>
1422 Private slot to handle the selection of the save link.
1423 </p>
1424 <dl>
1425
1426 <dt><i>link</i> (str)</dt>
1427 <dd>
1428 activated link
1429 </dd>
1430 </dl>
1431 <a NAME="GitLogBrowserDialog.on_sbsSelectLabel_linkActivated" ID="GitLogBrowserDialog.on_sbsSelectLabel_linkActivated"></a>
1432 <h4>GitLogBrowserDialog.on_sbsSelectLabel_linkActivated</h4>
1433 <b>on_sbsSelectLabel_linkActivated</b>(<i>link</i>)
1434
1435 <p>
1436 Private slot to handle selection of a side-by-side link.
1437 </p>
1438 <dl>
1439
1440 <dt><i>link</i> (str)</dt>
1441 <dd>
1442 text of the selected link
1443 </dd>
1444 </dl>
1445 <a NAME="GitLogBrowserDialog.on_sendButton_clicked" ID="GitLogBrowserDialog.on_sendButton_clicked"></a>
1446 <h4>GitLogBrowserDialog.on_sendButton_clicked</h4>
1447 <b>on_sendButton_clicked</b>(<i></i>)
1448
1449 <p>
1450 Private slot to send the input to the git process.
1451 </p>
1452 <a NAME="GitLogBrowserDialog.on_stopCheckBox_clicked" ID="GitLogBrowserDialog.on_stopCheckBox_clicked"></a>
1453 <h4>GitLogBrowserDialog.on_stopCheckBox_clicked</h4>
1454 <b>on_stopCheckBox_clicked</b>(<i>checked</i>)
1455
1456 <p>
1457 Private slot called, when the stop on copy/move checkbox is clicked.
1458 </p>
1459 <dl>
1460
1461 <dt><i>checked</i></dt>
1462 <dd>
1463 flag indicating the state of the check box (boolean)
1464 </dd>
1465 </dl>
1466 <a NAME="GitLogBrowserDialog.on_toDate_dateChanged" ID="GitLogBrowserDialog.on_toDate_dateChanged"></a>
1467 <h4>GitLogBrowserDialog.on_toDate_dateChanged</h4>
1468 <b>on_toDate_dateChanged</b>(<i>date</i>)
1469
1470 <p>
1471 Private slot called, when the from date changes.
1472 </p>
1473 <dl>
1474
1475 <dt><i>date</i></dt>
1476 <dd>
1477 new date (QDate)
1478 </dd>
1479 </dl>
1480 <a NAME="GitLogBrowserDialog.on_upButton_clicked" ID="GitLogBrowserDialog.on_upButton_clicked"></a>
1481 <h4>GitLogBrowserDialog.on_upButton_clicked</h4>
1482 <b>on_upButton_clicked</b>(<i></i>)
1483
1484 <p>
1485 Private slot to move the current item up one entry.
1486 </p>
1487 <a NAME="GitLogBrowserDialog.show" ID="GitLogBrowserDialog.show"></a>
1488 <h4>GitLogBrowserDialog.show</h4>
1489 <b>show</b>(<i></i>)
1490
1491 <p>
1492 Public slot to show the dialog.
1493 </p>
1494 <a NAME="GitLogBrowserDialog.start" ID="GitLogBrowserDialog.start"></a>
1495 <h4>GitLogBrowserDialog.start</h4>
1496 <b>start</b>(<i>fn, isFile=False, noEntries=0</i>)
1497
1498 <p>
1499 Public slot to start the git log command.
1500 </p>
1501 <dl>
1502
1503 <dt><i>fn</i></dt>
1504 <dd>
1505 filename to show the log for (string)
1506 </dd>
1507 <dt><i>isFile</i></dt>
1508 <dd>
1509 flag indicating log for a file is to be shown
1510 (boolean)
1511 </dd>
1512 <dt><i>noEntries</i></dt>
1513 <dd>
1514 number of entries to get (0 = default) (int)
1515 </dd>
1516 </dl>
1517 <div align="right"><a href="#top">Up</a></div>
1518 <hr />
1519 </body></html>

eric ide

mercurial