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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8623
fced5aa98d41
child 10438
4cd7e5a8b3cf
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Plugins.VcsPlugins.vcsGit.GitStatusDialog</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.GitStatusDialog</h1>
10
11 <p>
12 Module implementing a dialog to show the output of the git status command
13 process.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>None</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#GitStatusDialog">GitStatusDialog</a></td>
26 <td>Class implementing a dialog to show the output of the git status command process.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="GitStatusDialog" ID="GitStatusDialog"></a>
37 <h2>GitStatusDialog</h2>
38
39 <p>
40 Class implementing a dialog to show the output of the git status command
41 process.
42 </p>
43 <h3>Derived from</h3>
44 QWidget, Ui_GitStatusDialog
45 <h3>Class Attributes</h3>
46
47 <table>
48 <tr><td>ConflictRole</td></tr><tr><td>ConflictStates</td></tr>
49 </table>
50 <h3>Class Methods</h3>
51
52 <table>
53 <tr><td>None</td></tr>
54 </table>
55 <h3>Methods</h3>
56
57 <table>
58
59 <tr>
60 <td><a href="#GitStatusDialog.__init__">GitStatusDialog</a></td>
61 <td>Constructor</td>
62 </tr>
63 <tr>
64 <td><a href="#GitStatusDialog.__add">__add</a></td>
65 <td>Private slot to handle the Add context menu entry.</td>
66 </tr>
67 <tr>
68 <td><a href="#GitStatusDialog.__amend">__amend</a></td>
69 <td>Private slot to handle the Amend context menu entry.</td>
70 </tr>
71 <tr>
72 <td><a href="#GitStatusDialog.__commit">__commit</a></td>
73 <td>Private slot to handle the Commit context menu entry.</td>
74 </tr>
75 <tr>
76 <td><a href="#GitStatusDialog.__commitDeselectAll">__commitDeselectAll</a></td>
77 <td>Private slot to deselect all entries from commit.</td>
78 </tr>
79 <tr>
80 <td><a href="#GitStatusDialog.__commitSelect">__commitSelect</a></td>
81 <td>Private slot to select or deselect all entries.</td>
82 </tr>
83 <tr>
84 <td><a href="#GitStatusDialog.__commitSelectAll">__commitSelectAll</a></td>
85 <td>Private slot to select all entries for commit.</td>
86 </tr>
87 <tr>
88 <td><a href="#GitStatusDialog.__committed">__committed</a></td>
89 <td>Private slot called after the commit has finished.</td>
90 </tr>
91 <tr>
92 <td><a href="#GitStatusDialog.__diff">__diff</a></td>
93 <td>Private slot to handle the Diff context menu entry.</td>
94 </tr>
95 <tr>
96 <td><a href="#GitStatusDialog.__editConflict">__editConflict</a></td>
97 <td>Private slot to handle the Edit Conflict context menu entry.</td>
98 </tr>
99 <tr>
100 <td><a href="#GitStatusDialog.__finish">__finish</a></td>
101 <td>Private slot called when the process finished or the user pressed the button.</td>
102 </tr>
103 <tr>
104 <td><a href="#GitStatusDialog.__forget">__forget</a></td>
105 <td>Private slot to handle the Forget Missing context menu entry.</td>
106 </tr>
107 <tr>
108 <td><a href="#GitStatusDialog.__generateDiffs">__generateDiffs</a></td>
109 <td>Private slot to generate diff outputs for the selected item.</td>
110 </tr>
111 <tr>
112 <td><a href="#GitStatusDialog.__generateItem">__generateItem</a></td>
113 <td>Private method to generate a status item in the status list.</td>
114 </tr>
115 <tr>
116 <td><a href="#GitStatusDialog.__generatorFinished">__generatorFinished</a></td>
117 <td>Private slot connected to the finished signal of the diff generator.</td>
118 </tr>
119 <tr>
120 <td><a href="#GitStatusDialog.__getCommitableItems">__getCommitableItems</a></td>
121 <td>Private method to retrieve all entries the user wants to commit.</td>
122 </tr>
123 <tr>
124 <td><a href="#GitStatusDialog.__getCommitableUnselectedItems">__getCommitableUnselectedItems</a></td>
125 <td>Private method to retrieve all entries the user may commit but hasn't selected.</td>
126 </tr>
127 <tr>
128 <td><a href="#GitStatusDialog.__getConflictingItems">__getConflictingItems</a></td>
129 <td>Private method to retrieve all entries, that have a conflict status.</td>
130 </tr>
131 <tr>
132 <td><a href="#GitStatusDialog.__getMissingItems">__getMissingItems</a></td>
133 <td>Private method to retrieve all entries, that have a missing status.</td>
134 </tr>
135 <tr>
136 <td><a href="#GitStatusDialog.__getModifiedItems">__getModifiedItems</a></td>
137 <td>Private method to retrieve all entries, that have a modified status.</td>
138 </tr>
139 <tr>
140 <td><a href="#GitStatusDialog.__getModifiedOnlyItems">__getModifiedOnlyItems</a></td>
141 <td>Private method to retrieve all entries, that have a modified status.</td>
142 </tr>
143 <tr>
144 <td><a href="#GitStatusDialog.__getStageableItems">__getStageableItems</a></td>
145 <td>Private method to retrieve all entries, that have a stageable status.</td>
146 </tr>
147 <tr>
148 <td><a href="#GitStatusDialog.__getUnstageableItems">__getUnstageableItems</a></td>
149 <td>Private method to retrieve all entries, that have an unstageable status.</td>
150 </tr>
151 <tr>
152 <td><a href="#GitStatusDialog.__getUnversionedItems">__getUnversionedItems</a></td>
153 <td>Private method to retrieve all entries, that have an unversioned status.</td>
154 </tr>
155 <tr>
156 <td><a href="#GitStatusDialog.__initActionsMenu">__initActionsMenu</a></td>
157 <td>Private method to initialize the actions menu.</td>
158 </tr>
159 <tr>
160 <td><a href="#GitStatusDialog.__procFinished">__procFinished</a></td>
161 <td>Private slot connected to the finished signal.</td>
162 </tr>
163 <tr>
164 <td><a href="#GitStatusDialog.__readStderr">__readStderr</a></td>
165 <td>Private slot to handle the readyReadStandardError signal.</td>
166 </tr>
167 <tr>
168 <td><a href="#GitStatusDialog.__readStdout">__readStdout</a></td>
169 <td>Private slot to handle the readyReadStandardOutput signal.</td>
170 </tr>
171 <tr>
172 <td><a href="#GitStatusDialog.__refreshDiff">__refreshDiff</a></td>
173 <td>Private method to refresh the diff output after a refresh.</td>
174 </tr>
175 <tr>
176 <td><a href="#GitStatusDialog.__resizeColumns">__resizeColumns</a></td>
177 <td>Private method to resize the list columns.</td>
178 </tr>
179 <tr>
180 <td><a href="#GitStatusDialog.__resort">__resort</a></td>
181 <td>Private method to resort the tree.</td>
182 </tr>
183 <tr>
184 <td><a href="#GitStatusDialog.__restoreMissing">__restoreMissing</a></td>
185 <td>Private slot to handle the Restore Missing context menu entry.</td>
186 </tr>
187 <tr>
188 <td><a href="#GitStatusDialog.__revert">__revert</a></td>
189 <td>Private slot to handle the Revert context menu entry.</td>
190 </tr>
191 <tr>
192 <td><a href="#GitStatusDialog.__revertHunkOrLines">__revertHunkOrLines</a></td>
193 <td>Private method to revert the selected lines or hunk.</td>
194 </tr>
195 <tr>
196 <td><a href="#GitStatusDialog.__sbsDiff">__sbsDiff</a></td>
197 <td>Private slot to handle the Side-By-Side Diff context menu entry.</td>
198 </tr>
199 <tr>
200 <td><a href="#GitStatusDialog.__selectedLinesIndexes">__selectedLinesIndexes</a></td>
201 <td>Private method to extract the indexes of the selected lines.</td>
202 </tr>
203 <tr>
204 <td><a href="#GitStatusDialog.__showActionsMenu">__showActionsMenu</a></td>
205 <td>Private slot to prepare the actions button menu before it is shown.</td>
206 </tr>
207 <tr>
208 <td><a href="#GitStatusDialog.__showLDiffContextMenu">__showLDiffContextMenu</a></td>
209 <td>Private slot to show the context menu of the status list.</td>
210 </tr>
211 <tr>
212 <td><a href="#GitStatusDialog.__showRDiffContextMenu">__showRDiffContextMenu</a></td>
213 <td>Private slot to show the context menu of the status list.</td>
214 </tr>
215 <tr>
216 <td><a href="#GitStatusDialog.__stage">__stage</a></td>
217 <td>Private slot to handle the Stage context menu entry.</td>
218 </tr>
219 <tr>
220 <td><a href="#GitStatusDialog.__stageHunkOrLines">__stageHunkOrLines</a></td>
221 <td>Private method to stage the selected lines or hunk.</td>
222 </tr>
223 <tr>
224 <td><a href="#GitStatusDialog.__tmpPatchFileName">__tmpPatchFileName</a></td>
225 <td>Private method to generate a temporary patch file.</td>
226 </tr>
227 <tr>
228 <td><a href="#GitStatusDialog.__unstage">__unstage</a></td>
229 <td>Private slot to handle the Unstage context menu entry.</td>
230 </tr>
231 <tr>
232 <td><a href="#GitStatusDialog.__unstageHunkOrLines">__unstageHunkOrLines</a></td>
233 <td>Private method to unstage the selected lines or hunk.</td>
234 </tr>
235 <tr>
236 <td><a href="#GitStatusDialog.closeEvent">closeEvent</a></td>
237 <td>Protected slot implementing a close event handler.</td>
238 </tr>
239 <tr>
240 <td><a href="#GitStatusDialog.keyPressEvent">keyPressEvent</a></td>
241 <td>Protected slot to handle a key press event.</td>
242 </tr>
243 <tr>
244 <td><a href="#GitStatusDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
245 <td>Private slot called by a button of the button box clicked.</td>
246 </tr>
247 <tr>
248 <td><a href="#GitStatusDialog.on_input_returnPressed">on_input_returnPressed</a></td>
249 <td>Private slot to handle the press of the return key in the input field.</td>
250 </tr>
251 <tr>
252 <td><a href="#GitStatusDialog.on_passwordCheckBox_toggled">on_passwordCheckBox_toggled</a></td>
253 <td>Private slot to handle the password checkbox toggled.</td>
254 </tr>
255 <tr>
256 <td><a href="#GitStatusDialog.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
257 <td>Private slot to refresh the status display.</td>
258 </tr>
259 <tr>
260 <td><a href="#GitStatusDialog.on_sendButton_clicked">on_sendButton_clicked</a></td>
261 <td>Private slot to send the input to the git process.</td>
262 </tr>
263 <tr>
264 <td><a href="#GitStatusDialog.on_statusFilterCombo_activated">on_statusFilterCombo_activated</a></td>
265 <td>Private slot to react to the selection of a status filter.</td>
266 </tr>
267 <tr>
268 <td><a href="#GitStatusDialog.on_statusList_itemSelectionChanged">on_statusList_itemSelectionChanged</a></td>
269 <td>Private slot to act upon changes of selected items.</td>
270 </tr>
271 <tr>
272 <td><a href="#GitStatusDialog.show">show</a></td>
273 <td>Public slot to show the dialog.</td>
274 </tr>
275 <tr>
276 <td><a href="#GitStatusDialog.start">start</a></td>
277 <td>Public slot to start the git status command.</td>
278 </tr>
279 </table>
280 <h3>Static Methods</h3>
281
282 <table>
283 <tr><td>None</td></tr>
284 </table>
285
286 <a NAME="GitStatusDialog.__init__" ID="GitStatusDialog.__init__"></a>
287 <h4>GitStatusDialog (Constructor)</h4>
288 <b>GitStatusDialog</b>(<i>vcs, parent=None</i>)
289
290 <p>
291 Constructor
292 </p>
293 <dl>
294
295 <dt><i>vcs</i></dt>
296 <dd>
297 reference to the vcs object
298 </dd>
299 <dt><i>parent</i></dt>
300 <dd>
301 parent widget (QWidget)
302 </dd>
303 </dl>
304 <a NAME="GitStatusDialog.__add" ID="GitStatusDialog.__add"></a>
305 <h4>GitStatusDialog.__add</h4>
306 <b>__add</b>(<i></i>)
307
308 <p>
309 Private slot to handle the Add context menu entry.
310 </p>
311 <a NAME="GitStatusDialog.__amend" ID="GitStatusDialog.__amend"></a>
312 <h4>GitStatusDialog.__amend</h4>
313 <b>__amend</b>(<i></i>)
314
315 <p>
316 Private slot to handle the Amend context menu entry.
317 </p>
318 <a NAME="GitStatusDialog.__commit" ID="GitStatusDialog.__commit"></a>
319 <h4>GitStatusDialog.__commit</h4>
320 <b>__commit</b>(<i>amend=False</i>)
321
322 <p>
323 Private slot to handle the Commit context menu entry.
324 </p>
325 <dl>
326
327 <dt><i>amend</i></dt>
328 <dd>
329 flag indicating to perform an amend operation (boolean)
330 </dd>
331 </dl>
332 <a NAME="GitStatusDialog.__commitDeselectAll" ID="GitStatusDialog.__commitDeselectAll"></a>
333 <h4>GitStatusDialog.__commitDeselectAll</h4>
334 <b>__commitDeselectAll</b>(<i></i>)
335
336 <p>
337 Private slot to deselect all entries from commit.
338 </p>
339 <a NAME="GitStatusDialog.__commitSelect" ID="GitStatusDialog.__commitSelect"></a>
340 <h4>GitStatusDialog.__commitSelect</h4>
341 <b>__commitSelect</b>(<i>selected</i>)
342
343 <p>
344 Private slot to select or deselect all entries.
345 </p>
346 <dl>
347
348 <dt><i>selected</i></dt>
349 <dd>
350 commit selection state to be set (boolean)
351 </dd>
352 </dl>
353 <a NAME="GitStatusDialog.__commitSelectAll" ID="GitStatusDialog.__commitSelectAll"></a>
354 <h4>GitStatusDialog.__commitSelectAll</h4>
355 <b>__commitSelectAll</b>(<i></i>)
356
357 <p>
358 Private slot to select all entries for commit.
359 </p>
360 <a NAME="GitStatusDialog.__committed" ID="GitStatusDialog.__committed"></a>
361 <h4>GitStatusDialog.__committed</h4>
362 <b>__committed</b>(<i></i>)
363
364 <p>
365 Private slot called after the commit has finished.
366 </p>
367 <a NAME="GitStatusDialog.__diff" ID="GitStatusDialog.__diff"></a>
368 <h4>GitStatusDialog.__diff</h4>
369 <b>__diff</b>(<i></i>)
370
371 <p>
372 Private slot to handle the Diff context menu entry.
373 </p>
374 <a NAME="GitStatusDialog.__editConflict" ID="GitStatusDialog.__editConflict"></a>
375 <h4>GitStatusDialog.__editConflict</h4>
376 <b>__editConflict</b>(<i></i>)
377
378 <p>
379 Private slot to handle the Edit Conflict context menu entry.
380 </p>
381 <a NAME="GitStatusDialog.__finish" ID="GitStatusDialog.__finish"></a>
382 <h4>GitStatusDialog.__finish</h4>
383 <b>__finish</b>(<i></i>)
384
385 <p>
386 Private slot called when the process finished or the user pressed
387 the button.
388 </p>
389 <a NAME="GitStatusDialog.__forget" ID="GitStatusDialog.__forget"></a>
390 <h4>GitStatusDialog.__forget</h4>
391 <b>__forget</b>(<i></i>)
392
393 <p>
394 Private slot to handle the Forget Missing context menu entry.
395 </p>
396 <a NAME="GitStatusDialog.__generateDiffs" ID="GitStatusDialog.__generateDiffs"></a>
397 <h4>GitStatusDialog.__generateDiffs</h4>
398 <b>__generateDiffs</b>(<i></i>)
399
400 <p>
401 Private slot to generate diff outputs for the selected item.
402 </p>
403 <a NAME="GitStatusDialog.__generateItem" ID="GitStatusDialog.__generateItem"></a>
404 <h4>GitStatusDialog.__generateItem</h4>
405 <b>__generateItem</b>(<i>status, path</i>)
406
407 <p>
408 Private method to generate a status item in the status list.
409 </p>
410 <dl>
411
412 <dt><i>status</i></dt>
413 <dd>
414 status indicator (string)
415 </dd>
416 <dt><i>path</i></dt>
417 <dd>
418 path of the file or directory (string)
419 </dd>
420 </dl>
421 <a NAME="GitStatusDialog.__generatorFinished" ID="GitStatusDialog.__generatorFinished"></a>
422 <h4>GitStatusDialog.__generatorFinished</h4>
423 <b>__generatorFinished</b>(<i></i>)
424
425 <p>
426 Private slot connected to the finished signal of the diff generator.
427 </p>
428 <a NAME="GitStatusDialog.__getCommitableItems" ID="GitStatusDialog.__getCommitableItems"></a>
429 <h4>GitStatusDialog.__getCommitableItems</h4>
430 <b>__getCommitableItems</b>(<i></i>)
431
432 <p>
433 Private method to retrieve all entries the user wants to commit.
434 </p>
435 <dl>
436 <dt>Return:</dt>
437 <dd>
438 list of all items, the user has checked
439 </dd>
440 </dl>
441 <a NAME="GitStatusDialog.__getCommitableUnselectedItems" ID="GitStatusDialog.__getCommitableUnselectedItems"></a>
442 <h4>GitStatusDialog.__getCommitableUnselectedItems</h4>
443 <b>__getCommitableUnselectedItems</b>(<i></i>)
444
445 <p>
446 Private method to retrieve all entries the user may commit but hasn't
447 selected.
448 </p>
449 <dl>
450 <dt>Return:</dt>
451 <dd>
452 list of all items, the user has not checked
453 </dd>
454 </dl>
455 <a NAME="GitStatusDialog.__getConflictingItems" ID="GitStatusDialog.__getConflictingItems"></a>
456 <h4>GitStatusDialog.__getConflictingItems</h4>
457 <b>__getConflictingItems</b>(<i></i>)
458
459 <p>
460 Private method to retrieve all entries, that have a conflict status.
461 </p>
462 <dl>
463 <dt>Return:</dt>
464 <dd>
465 list of all items with a conflict status
466 </dd>
467 </dl>
468 <a NAME="GitStatusDialog.__getMissingItems" ID="GitStatusDialog.__getMissingItems"></a>
469 <h4>GitStatusDialog.__getMissingItems</h4>
470 <b>__getMissingItems</b>(<i></i>)
471
472 <p>
473 Private method to retrieve all entries, that have a missing status.
474 </p>
475 <dl>
476 <dt>Return:</dt>
477 <dd>
478 list of all items with a missing status
479 </dd>
480 </dl>
481 <a NAME="GitStatusDialog.__getModifiedItems" ID="GitStatusDialog.__getModifiedItems"></a>
482 <h4>GitStatusDialog.__getModifiedItems</h4>
483 <b>__getModifiedItems</b>(<i></i>)
484
485 <p>
486 Private method to retrieve all entries, that have a modified status.
487 </p>
488 <dl>
489 <dt>Return:</dt>
490 <dd>
491 list of all items with a modified status
492 </dd>
493 </dl>
494 <a NAME="GitStatusDialog.__getModifiedOnlyItems" ID="GitStatusDialog.__getModifiedOnlyItems"></a>
495 <h4>GitStatusDialog.__getModifiedOnlyItems</h4>
496 <b>__getModifiedOnlyItems</b>(<i></i>)
497
498 <p>
499 Private method to retrieve all entries, that have a modified status.
500 </p>
501 <dl>
502 <dt>Return:</dt>
503 <dd>
504 list of all items with a modified status
505 </dd>
506 </dl>
507 <a NAME="GitStatusDialog.__getStageableItems" ID="GitStatusDialog.__getStageableItems"></a>
508 <h4>GitStatusDialog.__getStageableItems</h4>
509 <b>__getStageableItems</b>(<i></i>)
510
511 <p>
512 Private method to retrieve all entries, that have a stageable
513 status.
514 </p>
515 <dl>
516 <dt>Return:</dt>
517 <dd>
518 list of all items with a stageable status
519 </dd>
520 </dl>
521 <a NAME="GitStatusDialog.__getUnstageableItems" ID="GitStatusDialog.__getUnstageableItems"></a>
522 <h4>GitStatusDialog.__getUnstageableItems</h4>
523 <b>__getUnstageableItems</b>(<i></i>)
524
525 <p>
526 Private method to retrieve all entries, that have an unstageable
527 status.
528 </p>
529 <dl>
530 <dt>Return:</dt>
531 <dd>
532 list of all items with an unstageable status
533 </dd>
534 </dl>
535 <a NAME="GitStatusDialog.__getUnversionedItems" ID="GitStatusDialog.__getUnversionedItems"></a>
536 <h4>GitStatusDialog.__getUnversionedItems</h4>
537 <b>__getUnversionedItems</b>(<i></i>)
538
539 <p>
540 Private method to retrieve all entries, that have an unversioned
541 status.
542 </p>
543 <dl>
544 <dt>Return:</dt>
545 <dd>
546 list of all items with an unversioned status
547 </dd>
548 </dl>
549 <a NAME="GitStatusDialog.__initActionsMenu" ID="GitStatusDialog.__initActionsMenu"></a>
550 <h4>GitStatusDialog.__initActionsMenu</h4>
551 <b>__initActionsMenu</b>(<i></i>)
552
553 <p>
554 Private method to initialize the actions menu.
555 </p>
556 <a NAME="GitStatusDialog.__procFinished" ID="GitStatusDialog.__procFinished"></a>
557 <h4>GitStatusDialog.__procFinished</h4>
558 <b>__procFinished</b>(<i>exitCode, exitStatus</i>)
559
560 <p>
561 Private slot connected to the finished signal.
562 </p>
563 <dl>
564
565 <dt><i>exitCode</i></dt>
566 <dd>
567 exit code of the process (integer)
568 </dd>
569 <dt><i>exitStatus</i></dt>
570 <dd>
571 exit status of the process (QProcess.ExitStatus)
572 </dd>
573 </dl>
574 <a NAME="GitStatusDialog.__readStderr" ID="GitStatusDialog.__readStderr"></a>
575 <h4>GitStatusDialog.__readStderr</h4>
576 <b>__readStderr</b>(<i></i>)
577
578 <p>
579 Private slot to handle the readyReadStandardError signal.
580 </p>
581 <p>
582 It reads the error output of the process and inserts it into the
583 error pane.
584 </p>
585 <a NAME="GitStatusDialog.__readStdout" ID="GitStatusDialog.__readStdout"></a>
586 <h4>GitStatusDialog.__readStdout</h4>
587 <b>__readStdout</b>(<i></i>)
588
589 <p>
590 Private slot to handle the readyReadStandardOutput signal.
591 </p>
592 <p>
593 It reads the output of the process, formats it and inserts it into
594 the contents pane.
595 </p>
596 <a NAME="GitStatusDialog.__refreshDiff" ID="GitStatusDialog.__refreshDiff"></a>
597 <h4>GitStatusDialog.__refreshDiff</h4>
598 <b>__refreshDiff</b>(<i></i>)
599
600 <p>
601 Private method to refresh the diff output after a refresh.
602 </p>
603 <a NAME="GitStatusDialog.__resizeColumns" ID="GitStatusDialog.__resizeColumns"></a>
604 <h4>GitStatusDialog.__resizeColumns</h4>
605 <b>__resizeColumns</b>(<i></i>)
606
607 <p>
608 Private method to resize the list columns.
609 </p>
610 <a NAME="GitStatusDialog.__resort" ID="GitStatusDialog.__resort"></a>
611 <h4>GitStatusDialog.__resort</h4>
612 <b>__resort</b>(<i></i>)
613
614 <p>
615 Private method to resort the tree.
616 </p>
617 <a NAME="GitStatusDialog.__restoreMissing" ID="GitStatusDialog.__restoreMissing"></a>
618 <h4>GitStatusDialog.__restoreMissing</h4>
619 <b>__restoreMissing</b>(<i></i>)
620
621 <p>
622 Private slot to handle the Restore Missing context menu entry.
623 </p>
624 <a NAME="GitStatusDialog.__revert" ID="GitStatusDialog.__revert"></a>
625 <h4>GitStatusDialog.__revert</h4>
626 <b>__revert</b>(<i></i>)
627
628 <p>
629 Private slot to handle the Revert context menu entry.
630 </p>
631 <a NAME="GitStatusDialog.__revertHunkOrLines" ID="GitStatusDialog.__revertHunkOrLines"></a>
632 <h4>GitStatusDialog.__revertHunkOrLines</h4>
633 <b>__revertHunkOrLines</b>(<i></i>)
634
635 <p>
636 Private method to revert the selected lines or hunk.
637 </p>
638 <a NAME="GitStatusDialog.__sbsDiff" ID="GitStatusDialog.__sbsDiff"></a>
639 <h4>GitStatusDialog.__sbsDiff</h4>
640 <b>__sbsDiff</b>(<i></i>)
641
642 <p>
643 Private slot to handle the Side-By-Side Diff context menu entry.
644 </p>
645 <a NAME="GitStatusDialog.__selectedLinesIndexes" ID="GitStatusDialog.__selectedLinesIndexes"></a>
646 <h4>GitStatusDialog.__selectedLinesIndexes</h4>
647 <b>__selectedLinesIndexes</b>(<i>diffEdit</i>)
648
649 <p>
650 Private method to extract the indexes of the selected lines.
651 </p>
652 <dl>
653
654 <dt><i>diffEdit</i></dt>
655 <dd>
656 reference to the edit widget (QTextEdit)
657 </dd>
658 </dl>
659 <dl>
660 <dt>Return:</dt>
661 <dd>
662 tuple of start and end indexes (integer, integer)
663 </dd>
664 </dl>
665 <a NAME="GitStatusDialog.__showActionsMenu" ID="GitStatusDialog.__showActionsMenu"></a>
666 <h4>GitStatusDialog.__showActionsMenu</h4>
667 <b>__showActionsMenu</b>(<i></i>)
668
669 <p>
670 Private slot to prepare the actions button menu before it is shown.
671 </p>
672 <a NAME="GitStatusDialog.__showLDiffContextMenu" ID="GitStatusDialog.__showLDiffContextMenu"></a>
673 <h4>GitStatusDialog.__showLDiffContextMenu</h4>
674 <b>__showLDiffContextMenu</b>(<i>coord</i>)
675
676 <p>
677 Private slot to show the context menu of the status list.
678 </p>
679 <dl>
680
681 <dt><i>coord</i></dt>
682 <dd>
683 position of the mouse pointer (QPoint)
684 </dd>
685 </dl>
686 <a NAME="GitStatusDialog.__showRDiffContextMenu" ID="GitStatusDialog.__showRDiffContextMenu"></a>
687 <h4>GitStatusDialog.__showRDiffContextMenu</h4>
688 <b>__showRDiffContextMenu</b>(<i>coord</i>)
689
690 <p>
691 Private slot to show the context menu of the status list.
692 </p>
693 <dl>
694
695 <dt><i>coord</i></dt>
696 <dd>
697 position of the mouse pointer (QPoint)
698 </dd>
699 </dl>
700 <a NAME="GitStatusDialog.__stage" ID="GitStatusDialog.__stage"></a>
701 <h4>GitStatusDialog.__stage</h4>
702 <b>__stage</b>(<i></i>)
703
704 <p>
705 Private slot to handle the Stage context menu entry.
706 </p>
707 <a NAME="GitStatusDialog.__stageHunkOrLines" ID="GitStatusDialog.__stageHunkOrLines"></a>
708 <h4>GitStatusDialog.__stageHunkOrLines</h4>
709 <b>__stageHunkOrLines</b>(<i></i>)
710
711 <p>
712 Private method to stage the selected lines or hunk.
713 </p>
714 <a NAME="GitStatusDialog.__tmpPatchFileName" ID="GitStatusDialog.__tmpPatchFileName"></a>
715 <h4>GitStatusDialog.__tmpPatchFileName</h4>
716 <b>__tmpPatchFileName</b>(<i></i>)
717
718 <p>
719 Private method to generate a temporary patch file.
720 </p>
721 <dl>
722 <dt>Return:</dt>
723 <dd>
724 name of the temporary file (string)
725 </dd>
726 </dl>
727 <a NAME="GitStatusDialog.__unstage" ID="GitStatusDialog.__unstage"></a>
728 <h4>GitStatusDialog.__unstage</h4>
729 <b>__unstage</b>(<i></i>)
730
731 <p>
732 Private slot to handle the Unstage context menu entry.
733 </p>
734 <a NAME="GitStatusDialog.__unstageHunkOrLines" ID="GitStatusDialog.__unstageHunkOrLines"></a>
735 <h4>GitStatusDialog.__unstageHunkOrLines</h4>
736 <b>__unstageHunkOrLines</b>(<i></i>)
737
738 <p>
739 Private method to unstage the selected lines or hunk.
740 </p>
741 <a NAME="GitStatusDialog.closeEvent" ID="GitStatusDialog.closeEvent"></a>
742 <h4>GitStatusDialog.closeEvent</h4>
743 <b>closeEvent</b>(<i>e</i>)
744
745 <p>
746 Protected slot implementing a close event handler.
747 </p>
748 <dl>
749
750 <dt><i>e</i></dt>
751 <dd>
752 close event (QCloseEvent)
753 </dd>
754 </dl>
755 <a NAME="GitStatusDialog.keyPressEvent" ID="GitStatusDialog.keyPressEvent"></a>
756 <h4>GitStatusDialog.keyPressEvent</h4>
757 <b>keyPressEvent</b>(<i>evt</i>)
758
759 <p>
760 Protected slot to handle a key press event.
761 </p>
762 <dl>
763
764 <dt><i>evt</i></dt>
765 <dd>
766 the key press event (QKeyEvent)
767 </dd>
768 </dl>
769 <a NAME="GitStatusDialog.on_buttonBox_clicked" ID="GitStatusDialog.on_buttonBox_clicked"></a>
770 <h4>GitStatusDialog.on_buttonBox_clicked</h4>
771 <b>on_buttonBox_clicked</b>(<i>button</i>)
772
773 <p>
774 Private slot called by a button of the button box clicked.
775 </p>
776 <dl>
777
778 <dt><i>button</i></dt>
779 <dd>
780 button that was clicked (QAbstractButton)
781 </dd>
782 </dl>
783 <a NAME="GitStatusDialog.on_input_returnPressed" ID="GitStatusDialog.on_input_returnPressed"></a>
784 <h4>GitStatusDialog.on_input_returnPressed</h4>
785 <b>on_input_returnPressed</b>(<i></i>)
786
787 <p>
788 Private slot to handle the press of the return key in the input field.
789 </p>
790 <a NAME="GitStatusDialog.on_passwordCheckBox_toggled" ID="GitStatusDialog.on_passwordCheckBox_toggled"></a>
791 <h4>GitStatusDialog.on_passwordCheckBox_toggled</h4>
792 <b>on_passwordCheckBox_toggled</b>(<i>isOn</i>)
793
794 <p>
795 Private slot to handle the password checkbox toggled.
796 </p>
797 <dl>
798
799 <dt><i>isOn</i></dt>
800 <dd>
801 flag indicating the status of the check box (boolean)
802 </dd>
803 </dl>
804 <a NAME="GitStatusDialog.on_refreshButton_clicked" ID="GitStatusDialog.on_refreshButton_clicked"></a>
805 <h4>GitStatusDialog.on_refreshButton_clicked</h4>
806 <b>on_refreshButton_clicked</b>(<i></i>)
807
808 <p>
809 Private slot to refresh the status display.
810 </p>
811 <a NAME="GitStatusDialog.on_sendButton_clicked" ID="GitStatusDialog.on_sendButton_clicked"></a>
812 <h4>GitStatusDialog.on_sendButton_clicked</h4>
813 <b>on_sendButton_clicked</b>(<i></i>)
814
815 <p>
816 Private slot to send the input to the git process.
817 </p>
818 <a NAME="GitStatusDialog.on_statusFilterCombo_activated" ID="GitStatusDialog.on_statusFilterCombo_activated"></a>
819 <h4>GitStatusDialog.on_statusFilterCombo_activated</h4>
820 <b>on_statusFilterCombo_activated</b>(<i>index</i>)
821
822 <p>
823 Private slot to react to the selection of a status filter.
824 </p>
825 <dl>
826
827 <dt><i>index</i> (int)</dt>
828 <dd>
829 index of the selected entry
830 </dd>
831 </dl>
832 <a NAME="GitStatusDialog.on_statusList_itemSelectionChanged" ID="GitStatusDialog.on_statusList_itemSelectionChanged"></a>
833 <h4>GitStatusDialog.on_statusList_itemSelectionChanged</h4>
834 <b>on_statusList_itemSelectionChanged</b>(<i></i>)
835
836 <p>
837 Private slot to act upon changes of selected items.
838 </p>
839 <a NAME="GitStatusDialog.show" ID="GitStatusDialog.show"></a>
840 <h4>GitStatusDialog.show</h4>
841 <b>show</b>(<i></i>)
842
843 <p>
844 Public slot to show the dialog.
845 </p>
846 <a NAME="GitStatusDialog.start" ID="GitStatusDialog.start"></a>
847 <h4>GitStatusDialog.start</h4>
848 <b>start</b>(<i>fn</i>)
849
850 <p>
851 Public slot to start the git status command.
852 </p>
853 <dl>
854
855 <dt><i>fn</i></dt>
856 <dd>
857 filename(s)/directoryname(s) to show the status of
858 (string or list of strings)
859 </dd>
860 </dl>
861 <div align="right"><a href="#top">Up</a></div>
862 <hr />
863 </body></html>

eric ide

mercurial