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

branch
eric7
changeset 10438
4cd7e5a8b3cf
parent 9209
b99e7fd55fd3
child 10479
856476537696
equal deleted inserted replaced
10437:2f70ca07f0af 10438:4cd7e5a8b3cf
290 <p> 290 <p>
291 Constructor 291 Constructor
292 </p> 292 </p>
293 <dl> 293 <dl>
294 294
295 <dt><i>vcs</i></dt> 295 <dt><i>vcs</i> (Git)</dt>
296 <dd> 296 <dd>
297 reference to the vcs object 297 reference to the vcs object
298 </dd> 298 </dd>
299 <dt><i>parent</i></dt> 299 <dt><i>parent</i> (QWidget)</dt>
300 <dd> 300 <dd>
301 parent widget (QWidget) 301 parent widget
302 </dd> 302 </dd>
303 </dl> 303 </dl>
304 <a NAME="GitStatusDialog.__add" ID="GitStatusDialog.__add"></a> 304 <a NAME="GitStatusDialog.__add" ID="GitStatusDialog.__add"></a>
305 <h4>GitStatusDialog.__add</h4> 305 <h4>GitStatusDialog.__add</h4>
306 <b>__add</b>(<i></i>) 306 <b>__add</b>(<i></i>)
322 <p> 322 <p>
323 Private slot to handle the Commit context menu entry. 323 Private slot to handle the Commit context menu entry.
324 </p> 324 </p>
325 <dl> 325 <dl>
326 326
327 <dt><i>amend</i></dt> 327 <dt><i>amend</i> (bool)</dt>
328 <dd> 328 <dd>
329 flag indicating to perform an amend operation (boolean) 329 flag indicating to perform an amend operation
330 </dd> 330 </dd>
331 </dl> 331 </dl>
332 <a NAME="GitStatusDialog.__commitDeselectAll" ID="GitStatusDialog.__commitDeselectAll"></a> 332 <a NAME="GitStatusDialog.__commitDeselectAll" ID="GitStatusDialog.__commitDeselectAll"></a>
333 <h4>GitStatusDialog.__commitDeselectAll</h4> 333 <h4>GitStatusDialog.__commitDeselectAll</h4>
334 <b>__commitDeselectAll</b>(<i></i>) 334 <b>__commitDeselectAll</b>(<i></i>)
343 <p> 343 <p>
344 Private slot to select or deselect all entries. 344 Private slot to select or deselect all entries.
345 </p> 345 </p>
346 <dl> 346 <dl>
347 347
348 <dt><i>selected</i></dt> 348 <dt><i>selected</i> (bool)</dt>
349 <dd> 349 <dd>
350 commit selection state to be set (boolean) 350 commit selection state to be set
351 </dd> 351 </dd>
352 </dl> 352 </dl>
353 <a NAME="GitStatusDialog.__commitSelectAll" ID="GitStatusDialog.__commitSelectAll"></a> 353 <a NAME="GitStatusDialog.__commitSelectAll" ID="GitStatusDialog.__commitSelectAll"></a>
354 <h4>GitStatusDialog.__commitSelectAll</h4> 354 <h4>GitStatusDialog.__commitSelectAll</h4>
355 <b>__commitSelectAll</b>(<i></i>) 355 <b>__commitSelectAll</b>(<i></i>)
407 <p> 407 <p>
408 Private method to generate a status item in the status list. 408 Private method to generate a status item in the status list.
409 </p> 409 </p>
410 <dl> 410 <dl>
411 411
412 <dt><i>status</i></dt> 412 <dt><i>status</i> (str)</dt>
413 <dd> 413 <dd>
414 status indicator (string) 414 status indicator
415 </dd> 415 </dd>
416 <dt><i>path</i></dt> 416 <dt><i>path</i> (str)</dt>
417 <dd> 417 <dd>
418 path of the file or directory (string) 418 path of the file or directory
419 </dd> 419 </dd>
420 </dl> 420 </dl>
421 <a NAME="GitStatusDialog.__generatorFinished" ID="GitStatusDialog.__generatorFinished"></a> 421 <a NAME="GitStatusDialog.__generatorFinished" ID="GitStatusDialog.__generatorFinished"></a>
422 <h4>GitStatusDialog.__generatorFinished</h4> 422 <h4>GitStatusDialog.__generatorFinished</h4>
423 <b>__generatorFinished</b>(<i></i>) 423 <b>__generatorFinished</b>(<i></i>)
436 <dt>Return:</dt> 436 <dt>Return:</dt>
437 <dd> 437 <dd>
438 list of all items, the user has checked 438 list of all items, the user has checked
439 </dd> 439 </dd>
440 </dl> 440 </dl>
441 <dl>
442 <dt>Return Type:</dt>
443 <dd>
444 list of QTreeWidgetItem
445 </dd>
446 </dl>
441 <a NAME="GitStatusDialog.__getCommitableUnselectedItems" ID="GitStatusDialog.__getCommitableUnselectedItems"></a> 447 <a NAME="GitStatusDialog.__getCommitableUnselectedItems" ID="GitStatusDialog.__getCommitableUnselectedItems"></a>
442 <h4>GitStatusDialog.__getCommitableUnselectedItems</h4> 448 <h4>GitStatusDialog.__getCommitableUnselectedItems</h4>
443 <b>__getCommitableUnselectedItems</b>(<i></i>) 449 <b>__getCommitableUnselectedItems</b>(<i></i>)
444 450
445 <p> 451 <p>
450 <dt>Return:</dt> 456 <dt>Return:</dt>
451 <dd> 457 <dd>
452 list of all items, the user has not checked 458 list of all items, the user has not checked
453 </dd> 459 </dd>
454 </dl> 460 </dl>
461 <dl>
462 <dt>Return Type:</dt>
463 <dd>
464 list of QTreeWidgetItem
465 </dd>
466 </dl>
455 <a NAME="GitStatusDialog.__getConflictingItems" ID="GitStatusDialog.__getConflictingItems"></a> 467 <a NAME="GitStatusDialog.__getConflictingItems" ID="GitStatusDialog.__getConflictingItems"></a>
456 <h4>GitStatusDialog.__getConflictingItems</h4> 468 <h4>GitStatusDialog.__getConflictingItems</h4>
457 <b>__getConflictingItems</b>(<i></i>) 469 <b>__getConflictingItems</b>(<i></i>)
458 470
459 <p> 471 <p>
463 <dt>Return:</dt> 475 <dt>Return:</dt>
464 <dd> 476 <dd>
465 list of all items with a conflict status 477 list of all items with a conflict status
466 </dd> 478 </dd>
467 </dl> 479 </dl>
480 <dl>
481 <dt>Return Type:</dt>
482 <dd>
483 list of QTreeWidgetItem
484 </dd>
485 </dl>
468 <a NAME="GitStatusDialog.__getMissingItems" ID="GitStatusDialog.__getMissingItems"></a> 486 <a NAME="GitStatusDialog.__getMissingItems" ID="GitStatusDialog.__getMissingItems"></a>
469 <h4>GitStatusDialog.__getMissingItems</h4> 487 <h4>GitStatusDialog.__getMissingItems</h4>
470 <b>__getMissingItems</b>(<i></i>) 488 <b>__getMissingItems</b>(<i></i>)
471 489
472 <p> 490 <p>
476 <dt>Return:</dt> 494 <dt>Return:</dt>
477 <dd> 495 <dd>
478 list of all items with a missing status 496 list of all items with a missing status
479 </dd> 497 </dd>
480 </dl> 498 </dl>
499 <dl>
500 <dt>Return Type:</dt>
501 <dd>
502 list of QTreeWidgetItem
503 </dd>
504 </dl>
481 <a NAME="GitStatusDialog.__getModifiedItems" ID="GitStatusDialog.__getModifiedItems"></a> 505 <a NAME="GitStatusDialog.__getModifiedItems" ID="GitStatusDialog.__getModifiedItems"></a>
482 <h4>GitStatusDialog.__getModifiedItems</h4> 506 <h4>GitStatusDialog.__getModifiedItems</h4>
483 <b>__getModifiedItems</b>(<i></i>) 507 <b>__getModifiedItems</b>(<i></i>)
484 508
485 <p> 509 <p>
489 <dt>Return:</dt> 513 <dt>Return:</dt>
490 <dd> 514 <dd>
491 list of all items with a modified status 515 list of all items with a modified status
492 </dd> 516 </dd>
493 </dl> 517 </dl>
518 <dl>
519 <dt>Return Type:</dt>
520 <dd>
521 list of QTreeWidgetItem
522 </dd>
523 </dl>
494 <a NAME="GitStatusDialog.__getModifiedOnlyItems" ID="GitStatusDialog.__getModifiedOnlyItems"></a> 524 <a NAME="GitStatusDialog.__getModifiedOnlyItems" ID="GitStatusDialog.__getModifiedOnlyItems"></a>
495 <h4>GitStatusDialog.__getModifiedOnlyItems</h4> 525 <h4>GitStatusDialog.__getModifiedOnlyItems</h4>
496 <b>__getModifiedOnlyItems</b>(<i></i>) 526 <b>__getModifiedOnlyItems</b>(<i></i>)
497 527
498 <p> 528 <p>
502 <dt>Return:</dt> 532 <dt>Return:</dt>
503 <dd> 533 <dd>
504 list of all items with a modified status 534 list of all items with a modified status
505 </dd> 535 </dd>
506 </dl> 536 </dl>
537 <dl>
538 <dt>Return Type:</dt>
539 <dd>
540 list of QTreeWidgetItem
541 </dd>
542 </dl>
507 <a NAME="GitStatusDialog.__getStageableItems" ID="GitStatusDialog.__getStageableItems"></a> 543 <a NAME="GitStatusDialog.__getStageableItems" ID="GitStatusDialog.__getStageableItems"></a>
508 <h4>GitStatusDialog.__getStageableItems</h4> 544 <h4>GitStatusDialog.__getStageableItems</h4>
509 <b>__getStageableItems</b>(<i></i>) 545 <b>__getStageableItems</b>(<i></i>)
510 546
511 <p> 547 <p>
516 <dt>Return:</dt> 552 <dt>Return:</dt>
517 <dd> 553 <dd>
518 list of all items with a stageable status 554 list of all items with a stageable status
519 </dd> 555 </dd>
520 </dl> 556 </dl>
557 <dl>
558 <dt>Return Type:</dt>
559 <dd>
560 list of QTreeWidgetItem
561 </dd>
562 </dl>
521 <a NAME="GitStatusDialog.__getUnstageableItems" ID="GitStatusDialog.__getUnstageableItems"></a> 563 <a NAME="GitStatusDialog.__getUnstageableItems" ID="GitStatusDialog.__getUnstageableItems"></a>
522 <h4>GitStatusDialog.__getUnstageableItems</h4> 564 <h4>GitStatusDialog.__getUnstageableItems</h4>
523 <b>__getUnstageableItems</b>(<i></i>) 565 <b>__getUnstageableItems</b>(<i></i>)
524 566
525 <p> 567 <p>
530 <dt>Return:</dt> 572 <dt>Return:</dt>
531 <dd> 573 <dd>
532 list of all items with an unstageable status 574 list of all items with an unstageable status
533 </dd> 575 </dd>
534 </dl> 576 </dl>
577 <dl>
578 <dt>Return Type:</dt>
579 <dd>
580 list of QTreeWidgetItem
581 </dd>
582 </dl>
535 <a NAME="GitStatusDialog.__getUnversionedItems" ID="GitStatusDialog.__getUnversionedItems"></a> 583 <a NAME="GitStatusDialog.__getUnversionedItems" ID="GitStatusDialog.__getUnversionedItems"></a>
536 <h4>GitStatusDialog.__getUnversionedItems</h4> 584 <h4>GitStatusDialog.__getUnversionedItems</h4>
537 <b>__getUnversionedItems</b>(<i></i>) 585 <b>__getUnversionedItems</b>(<i></i>)
538 586
539 <p> 587 <p>
544 <dt>Return:</dt> 592 <dt>Return:</dt>
545 <dd> 593 <dd>
546 list of all items with an unversioned status 594 list of all items with an unversioned status
547 </dd> 595 </dd>
548 </dl> 596 </dl>
597 <dl>
598 <dt>Return Type:</dt>
599 <dd>
600 list of QTreeWidgetItem
601 </dd>
602 </dl>
549 <a NAME="GitStatusDialog.__initActionsMenu" ID="GitStatusDialog.__initActionsMenu"></a> 603 <a NAME="GitStatusDialog.__initActionsMenu" ID="GitStatusDialog.__initActionsMenu"></a>
550 <h4>GitStatusDialog.__initActionsMenu</h4> 604 <h4>GitStatusDialog.__initActionsMenu</h4>
551 <b>__initActionsMenu</b>(<i></i>) 605 <b>__initActionsMenu</b>(<i></i>)
552 606
553 <p> 607 <p>
560 <p> 614 <p>
561 Private slot connected to the finished signal. 615 Private slot connected to the finished signal.
562 </p> 616 </p>
563 <dl> 617 <dl>
564 618
565 <dt><i>exitCode</i></dt> 619 <dt><i>exitCode</i> (int)</dt>
566 <dd> 620 <dd>
567 exit code of the process (integer) 621 exit code of the process
568 </dd> 622 </dd>
569 <dt><i>exitStatus</i></dt> 623 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
570 <dd> 624 <dd>
571 exit status of the process (QProcess.ExitStatus) 625 exit status of the process
572 </dd> 626 </dd>
573 </dl> 627 </dl>
574 <a NAME="GitStatusDialog.__readStderr" ID="GitStatusDialog.__readStderr"></a> 628 <a NAME="GitStatusDialog.__readStderr" ID="GitStatusDialog.__readStderr"></a>
575 <h4>GitStatusDialog.__readStderr</h4> 629 <h4>GitStatusDialog.__readStderr</h4>
576 <b>__readStderr</b>(<i></i>) 630 <b>__readStderr</b>(<i></i>)
649 <p> 703 <p>
650 Private method to extract the indexes of the selected lines. 704 Private method to extract the indexes of the selected lines.
651 </p> 705 </p>
652 <dl> 706 <dl>
653 707
654 <dt><i>diffEdit</i></dt> 708 <dt><i>diffEdit</i> (QTextEdit)</dt>
655 <dd> 709 <dd>
656 reference to the edit widget (QTextEdit) 710 reference to the edit widget
657 </dd> 711 </dd>
658 </dl> 712 </dl>
659 <dl> 713 <dl>
660 <dt>Return:</dt> 714 <dt>Return:</dt>
661 <dd> 715 <dd>
662 tuple of start and end indexes (integer, integer) 716 tuple of start and end indexes
717 </dd>
718 </dl>
719 <dl>
720 <dt>Return Type:</dt>
721 <dd>
722 tuple of (int, int)
663 </dd> 723 </dd>
664 </dl> 724 </dl>
665 <a NAME="GitStatusDialog.__showActionsMenu" ID="GitStatusDialog.__showActionsMenu"></a> 725 <a NAME="GitStatusDialog.__showActionsMenu" ID="GitStatusDialog.__showActionsMenu"></a>
666 <h4>GitStatusDialog.__showActionsMenu</h4> 726 <h4>GitStatusDialog.__showActionsMenu</h4>
667 <b>__showActionsMenu</b>(<i></i>) 727 <b>__showActionsMenu</b>(<i></i>)
676 <p> 736 <p>
677 Private slot to show the context menu of the status list. 737 Private slot to show the context menu of the status list.
678 </p> 738 </p>
679 <dl> 739 <dl>
680 740
681 <dt><i>coord</i></dt> 741 <dt><i>coord</i> (QPoint)</dt>
682 <dd> 742 <dd>
683 position of the mouse pointer (QPoint) 743 position of the mouse pointer
684 </dd> 744 </dd>
685 </dl> 745 </dl>
686 <a NAME="GitStatusDialog.__showRDiffContextMenu" ID="GitStatusDialog.__showRDiffContextMenu"></a> 746 <a NAME="GitStatusDialog.__showRDiffContextMenu" ID="GitStatusDialog.__showRDiffContextMenu"></a>
687 <h4>GitStatusDialog.__showRDiffContextMenu</h4> 747 <h4>GitStatusDialog.__showRDiffContextMenu</h4>
688 <b>__showRDiffContextMenu</b>(<i>coord</i>) 748 <b>__showRDiffContextMenu</b>(<i>coord</i>)
690 <p> 750 <p>
691 Private slot to show the context menu of the status list. 751 Private slot to show the context menu of the status list.
692 </p> 752 </p>
693 <dl> 753 <dl>
694 754
695 <dt><i>coord</i></dt> 755 <dt><i>coord</i> (QPoint)</dt>
696 <dd> 756 <dd>
697 position of the mouse pointer (QPoint) 757 position of the mouse pointer
698 </dd> 758 </dd>
699 </dl> 759 </dl>
700 <a NAME="GitStatusDialog.__stage" ID="GitStatusDialog.__stage"></a> 760 <a NAME="GitStatusDialog.__stage" ID="GitStatusDialog.__stage"></a>
701 <h4>GitStatusDialog.__stage</h4> 761 <h4>GitStatusDialog.__stage</h4>
702 <b>__stage</b>(<i></i>) 762 <b>__stage</b>(<i></i>)
719 Private method to generate a temporary patch file. 779 Private method to generate a temporary patch file.
720 </p> 780 </p>
721 <dl> 781 <dl>
722 <dt>Return:</dt> 782 <dt>Return:</dt>
723 <dd> 783 <dd>
724 name of the temporary file (string) 784 name of the temporary file
785 </dd>
786 </dl>
787 <dl>
788 <dt>Return Type:</dt>
789 <dd>
790 str
725 </dd> 791 </dd>
726 </dl> 792 </dl>
727 <a NAME="GitStatusDialog.__unstage" ID="GitStatusDialog.__unstage"></a> 793 <a NAME="GitStatusDialog.__unstage" ID="GitStatusDialog.__unstage"></a>
728 <h4>GitStatusDialog.__unstage</h4> 794 <h4>GitStatusDialog.__unstage</h4>
729 <b>__unstage</b>(<i></i>) 795 <b>__unstage</b>(<i></i>)
745 <p> 811 <p>
746 Protected slot implementing a close event handler. 812 Protected slot implementing a close event handler.
747 </p> 813 </p>
748 <dl> 814 <dl>
749 815
750 <dt><i>e</i></dt> 816 <dt><i>e</i> (QCloseEvent)</dt>
751 <dd> 817 <dd>
752 close event (QCloseEvent) 818 close event
753 </dd> 819 </dd>
754 </dl> 820 </dl>
755 <a NAME="GitStatusDialog.keyPressEvent" ID="GitStatusDialog.keyPressEvent"></a> 821 <a NAME="GitStatusDialog.keyPressEvent" ID="GitStatusDialog.keyPressEvent"></a>
756 <h4>GitStatusDialog.keyPressEvent</h4> 822 <h4>GitStatusDialog.keyPressEvent</h4>
757 <b>keyPressEvent</b>(<i>evt</i>) 823 <b>keyPressEvent</b>(<i>evt</i>)
759 <p> 825 <p>
760 Protected slot to handle a key press event. 826 Protected slot to handle a key press event.
761 </p> 827 </p>
762 <dl> 828 <dl>
763 829
764 <dt><i>evt</i></dt> 830 <dt><i>evt</i> (QKeyEvent)</dt>
765 <dd> 831 <dd>
766 the key press event (QKeyEvent) 832 the key press event
767 </dd> 833 </dd>
768 </dl> 834 </dl>
769 <a NAME="GitStatusDialog.on_buttonBox_clicked" ID="GitStatusDialog.on_buttonBox_clicked"></a> 835 <a NAME="GitStatusDialog.on_buttonBox_clicked" ID="GitStatusDialog.on_buttonBox_clicked"></a>
770 <h4>GitStatusDialog.on_buttonBox_clicked</h4> 836 <h4>GitStatusDialog.on_buttonBox_clicked</h4>
771 <b>on_buttonBox_clicked</b>(<i>button</i>) 837 <b>on_buttonBox_clicked</b>(<i>button</i>)
773 <p> 839 <p>
774 Private slot called by a button of the button box clicked. 840 Private slot called by a button of the button box clicked.
775 </p> 841 </p>
776 <dl> 842 <dl>
777 843
778 <dt><i>button</i></dt> 844 <dt><i>button</i> (QAbstractButton)</dt>
779 <dd> 845 <dd>
780 button that was clicked (QAbstractButton) 846 button that was clicked
781 </dd> 847 </dd>
782 </dl> 848 </dl>
783 <a NAME="GitStatusDialog.on_input_returnPressed" ID="GitStatusDialog.on_input_returnPressed"></a> 849 <a NAME="GitStatusDialog.on_input_returnPressed" ID="GitStatusDialog.on_input_returnPressed"></a>
784 <h4>GitStatusDialog.on_input_returnPressed</h4> 850 <h4>GitStatusDialog.on_input_returnPressed</h4>
785 <b>on_input_returnPressed</b>(<i></i>) 851 <b>on_input_returnPressed</b>(<i></i>)
794 <p> 860 <p>
795 Private slot to handle the password checkbox toggled. 861 Private slot to handle the password checkbox toggled.
796 </p> 862 </p>
797 <dl> 863 <dl>
798 864
799 <dt><i>isOn</i></dt> 865 <dt><i>isOn</i> (bool)</dt>
800 <dd> 866 <dd>
801 flag indicating the status of the check box (boolean) 867 flag indicating the status of the check box
802 </dd> 868 </dd>
803 </dl> 869 </dl>
804 <a NAME="GitStatusDialog.on_refreshButton_clicked" ID="GitStatusDialog.on_refreshButton_clicked"></a> 870 <a NAME="GitStatusDialog.on_refreshButton_clicked" ID="GitStatusDialog.on_refreshButton_clicked"></a>
805 <h4>GitStatusDialog.on_refreshButton_clicked</h4> 871 <h4>GitStatusDialog.on_refreshButton_clicked</h4>
806 <b>on_refreshButton_clicked</b>(<i></i>) 872 <b>on_refreshButton_clicked</b>(<i></i>)
850 <p> 916 <p>
851 Public slot to start the git status command. 917 Public slot to start the git status command.
852 </p> 918 </p>
853 <dl> 919 <dl>
854 920
855 <dt><i>fn</i></dt> 921 <dt><i>fn</i> (str or list of str)</dt>
856 <dd> 922 <dd>
857 filename(s)/directoryname(s) to show the status of 923 filename(s)/directoryname(s) to show the status of
858 (string or list of strings)
859 </dd> 924 </dd>
860 </dl> 925 </dl>
861 <div align="right"><a href="#top">Up</a></div> 926 <div align="right"><a href="#top">Up</a></div>
862 <hr /> 927 <hr />
863 </body></html> 928 </body></html>

eric ide

mercurial