src/eric7/Documentation/Source/eric7.Project.ProjectBaseBrowser.html

branch
eric7
changeset 10430
e440aaf179ce
parent 10399
48014775ad31
child 10479
856476537696
equal deleted inserted replaced
10429:643989a1e2bd 10430:e440aaf179ce
287 <p> 287 <p>
288 Private method to check a hook key. 288 Private method to check a hook key.
289 </p> 289 </p>
290 <dl> 290 <dl>
291 291
292 <dt><i>key</i></dt> 292 <dt><i>key</i> (str)</dt>
293 <dd> 293 <dd>
294 key of the hook to check (string) 294 key of the hook to check
295 </dd> 295 </dd>
296 </dl> 296 </dl>
297 <dl> 297 <dl>
298 298
299 <dt>Raises <b>KeyError</b>:</dt> 299 <dt>Raises <b>KeyError</b>:</dt>
308 <p> 308 <p>
309 Private slot called after rows have been inserted into the model. 309 Private slot called after rows have been inserted into the model.
310 </p> 310 </p>
311 <dl> 311 <dl>
312 312
313 <dt><i>parent</i></dt> 313 <dt><i>parent</i> (QModelIndex)</dt>
314 <dd> 314 <dd>
315 parent index of inserted rows (QModelIndex) 315 parent index of inserted rows
316 </dd> 316 </dd>
317 <dt><i>start</i></dt> 317 <dt><i>start</i> (int)</dt>
318 <dd> 318 <dd>
319 start row number (integer) 319 start row number
320 </dd> 320 </dd>
321 <dt><i>end</i></dt> 321 <dt><i>end</i> (int)</dt>
322 <dd> 322 <dd>
323 end row number (integer) 323 end row number
324 </dd> 324 </dd>
325 </dl> 325 </dl>
326 <a NAME="ProjectBaseBrowser._collapseAllDirs" ID="ProjectBaseBrowser._collapseAllDirs"></a> 326 <a NAME="ProjectBaseBrowser._collapseAllDirs" ID="ProjectBaseBrowser._collapseAllDirs"></a>
327 <h4>ProjectBaseBrowser._collapseAllDirs</h4> 327 <h4>ProjectBaseBrowser._collapseAllDirs</h4>
328 <b>_collapseAllDirs</b>(<i></i>) 328 <b>_collapseAllDirs</b>(<i></i>)
344 <p> 344 <p>
345 Protected slot to handle the completeRepopulateItem signal. 345 Protected slot to handle the completeRepopulateItem signal.
346 </p> 346 </p>
347 <dl> 347 <dl>
348 348
349 <dt><i>name</i></dt> 349 <dt><i>name</i> (str)</dt>
350 <dd> 350 <dd>
351 relative name of file item to be repopulated (string) 351 relative name of file item to be repopulated
352 </dd> 352 </dd>
353 </dl> 353 </dl>
354 <a NAME="ProjectBaseBrowser._configure" ID="ProjectBaseBrowser._configure"></a> 354 <a NAME="ProjectBaseBrowser._configure" ID="ProjectBaseBrowser._configure"></a>
355 <h4>ProjectBaseBrowser._configure</h4> 355 <h4>ProjectBaseBrowser._configure</h4>
356 <b>_configure</b>(<i></i>) 356 <b>_configure</b>(<i></i>)
372 <p> 372 <p>
373 Protected slot to show the context menu. 373 Protected slot to show the context menu.
374 </p> 374 </p>
375 <dl> 375 <dl>
376 376
377 <dt><i>coord</i></dt> 377 <dt><i>coord</i> (QPoint)</dt>
378 <dd> 378 <dd>
379 the position of the mouse pointer (QPoint) 379 the position of the mouse pointer
380 </dd> 380 </dd>
381 </dl> 381 </dl>
382 <a NAME="ProjectBaseBrowser._copyToClipboard" ID="ProjectBaseBrowser._copyToClipboard"></a> 382 <a NAME="ProjectBaseBrowser._copyToClipboard" ID="ProjectBaseBrowser._copyToClipboard"></a>
383 <h4>ProjectBaseBrowser._copyToClipboard</h4> 383 <h4>ProjectBaseBrowser._copyToClipboard</h4>
384 <b>_copyToClipboard</b>(<i></i>) 384 <b>_copyToClipboard</b>(<i></i>)
474 <p> 474 <p>
475 Protected slot to handle the prepareRepopulateItem signal. 475 Protected slot to handle the prepareRepopulateItem signal.
476 </p> 476 </p>
477 <dl> 477 <dl>
478 478
479 <dt><i>name</i></dt> 479 <dt><i>name</i> (str)</dt>
480 <dd> 480 <dd>
481 relative name of file item to be repopulated (string) 481 relative name of file item to be repopulated
482 </dd> 482 </dd>
483 </dl> 483 </dl>
484 <a NAME="ProjectBaseBrowser._projectClosed" ID="ProjectBaseBrowser._projectClosed"></a> 484 <a NAME="ProjectBaseBrowser._projectClosed" ID="ProjectBaseBrowser._projectClosed"></a>
485 <h4>ProjectBaseBrowser._projectClosed</h4> 485 <h4>ProjectBaseBrowser._projectClosed</h4>
486 <b>_projectClosed</b>(<i></i>) 486 <b>_projectClosed</b>(<i></i>)
523 <p> 523 <p>
524 Protected method to select entries based on their VCS status. 524 Protected method to select entries based on their VCS status.
525 </p> 525 </p>
526 <dl> 526 <dl>
527 527
528 <dt><i>local</i></dt> 528 <dt><i>local</i> (boolean))</dt>
529 <dd> 529 <dd>
530 flag indicating local (i.e. non VCS controlled) 530 flag indicating local (i.e. non VCS controlled)
531 file/directory entries should be selected (boolean) 531 file/directory entries should be selected
532 </dd> 532 </dd>
533 <dt><i>filterList</i></dt> 533 <dt><i>filterList</i> (Class)</dt>
534 <dd> 534 <dd>
535 list of classes to check against 535 list of classes to check against
536 </dd> 536 </dd>
537 </dl> 537 </dl>
538 <a NAME="ProjectBaseBrowser._selectSingleItem" ID="ProjectBaseBrowser._selectSingleItem"></a> 538 <a NAME="ProjectBaseBrowser._selectSingleItem" ID="ProjectBaseBrowser._selectSingleItem"></a>
542 <p> 542 <p>
543 Protected method to select a single item. 543 Protected method to select a single item.
544 </p> 544 </p>
545 <dl> 545 <dl>
546 546
547 <dt><i>index</i></dt> 547 <dt><i>index</i> (QModelIndex)</dt>
548 <dd> 548 <dd>
549 index of item to be selected (QModelIndex) 549 index of item to be selected
550 </dd> 550 </dd>
551 </dl> 551 </dl>
552 <a NAME="ProjectBaseBrowser._setItemRangeSelected" ID="ProjectBaseBrowser._setItemRangeSelected"></a> 552 <a NAME="ProjectBaseBrowser._setItemRangeSelected" ID="ProjectBaseBrowser._setItemRangeSelected"></a>
553 <h4>ProjectBaseBrowser._setItemRangeSelected</h4> 553 <h4>ProjectBaseBrowser._setItemRangeSelected</h4>
554 <b>_setItemRangeSelected</b>(<i>startIndex, endIndex, selected</i>) 554 <b>_setItemRangeSelected</b>(<i>startIndex, endIndex, selected</i>)
556 <p> 556 <p>
557 Protected method to set the selection status of a range of items. 557 Protected method to set the selection status of a range of items.
558 </p> 558 </p>
559 <dl> 559 <dl>
560 560
561 <dt><i>startIndex</i></dt> 561 <dt><i>startIndex</i> (QModelIndex)</dt>
562 <dd> 562 <dd>
563 start index of range of items to set (QModelIndex) 563 start index of range of items to set
564 </dd> 564 </dd>
565 <dt><i>endIndex</i></dt> 565 <dt><i>endIndex</i> (QModelIndex)</dt>
566 <dd> 566 <dd>
567 end index of range of items to set (QModelIndex) 567 end index of range of items to set
568 </dd> 568 </dd>
569 <dt><i>selected</i></dt> 569 <dt><i>selected</i> (bool)</dt>
570 <dd> 570 <dd>
571 flag giving the new selection status (boolean) 571 flag giving the new selection status
572 </dd> 572 </dd>
573 </dl> 573 </dl>
574 <a NAME="ProjectBaseBrowser._setItemSelected" ID="ProjectBaseBrowser._setItemSelected"></a> 574 <a NAME="ProjectBaseBrowser._setItemSelected" ID="ProjectBaseBrowser._setItemSelected"></a>
575 <h4>ProjectBaseBrowser._setItemSelected</h4> 575 <h4>ProjectBaseBrowser._setItemSelected</h4>
576 <b>_setItemSelected</b>(<i>index, selected</i>) 576 <b>_setItemSelected</b>(<i>index, selected</i>)
578 <p> 578 <p>
579 Protected method to set the selection status of an item. 579 Protected method to set the selection status of an item.
580 </p> 580 </p>
581 <dl> 581 <dl>
582 582
583 <dt><i>index</i></dt> 583 <dt><i>index</i> (QModelIndex)</dt>
584 <dd> 584 <dd>
585 index of item to set (QModelIndex) 585 index of item to set
586 </dd> 586 </dd>
587 <dt><i>selected</i></dt> 587 <dt><i>selected</i> (bool)</dt>
588 <dd> 588 <dd>
589 flag giving the new selection status (boolean) 589 flag giving the new selection status
590 </dd> 590 </dd>
591 </dl> 591 </dl>
592 <a NAME="ProjectBaseBrowser._showContextMenu" ID="ProjectBaseBrowser._showContextMenu"></a> 592 <a NAME="ProjectBaseBrowser._showContextMenu" ID="ProjectBaseBrowser._showContextMenu"></a>
593 <h4>ProjectBaseBrowser._showContextMenu</h4> 593 <h4>ProjectBaseBrowser._showContextMenu</h4>
594 <b>_showContextMenu</b>(<i>menu</i>) 594 <b>_showContextMenu</b>(<i>menu</i>)
600 It enables/disables the VCS menu entries depending on the overall 600 It enables/disables the VCS menu entries depending on the overall
601 VCS status and the file status. 601 VCS status and the file status.
602 </p> 602 </p>
603 <dl> 603 <dl>
604 604
605 <dt><i>menu</i></dt> 605 <dt><i>menu</i> (QMenu)</dt>
606 <dd> 606 <dd>
607 reference to the menu to be shown (QMenu) 607 reference to the menu to be shown
608 </dd> 608 </dd>
609 </dl> 609 </dl>
610 <a NAME="ProjectBaseBrowser._showContextMenuBack" ID="ProjectBaseBrowser._showContextMenuBack"></a> 610 <a NAME="ProjectBaseBrowser._showContextMenuBack" ID="ProjectBaseBrowser._showContextMenuBack"></a>
611 <h4>ProjectBaseBrowser._showContextMenuBack</h4> 611 <h4>ProjectBaseBrowser._showContextMenuBack</h4>
612 <b>_showContextMenuBack</b>(<i>menu</i>) 612 <b>_showContextMenuBack</b>(<i>menu</i>)
614 <p> 614 <p>
615 Protected slot called before the context menu is shown. 615 Protected slot called before the context menu is shown.
616 </p> 616 </p>
617 <dl> 617 <dl>
618 618
619 <dt><i>menu</i></dt> 619 <dt><i>menu</i> (QMenu)</dt>
620 <dd> 620 <dd>
621 reference to the menu to be shown (QMenu) 621 reference to the menu to be shown
622 </dd> 622 </dd>
623 </dl> 623 </dl>
624 <a NAME="ProjectBaseBrowser._showContextMenuDir" ID="ProjectBaseBrowser._showContextMenuDir"></a> 624 <a NAME="ProjectBaseBrowser._showContextMenuDir" ID="ProjectBaseBrowser._showContextMenuDir"></a>
625 <h4>ProjectBaseBrowser._showContextMenuDir</h4> 625 <h4>ProjectBaseBrowser._showContextMenuDir</h4>
626 <b>_showContextMenuDir</b>(<i>menu</i>) 626 <b>_showContextMenuDir</b>(<i>menu</i>)
632 It enables/disables the VCS menu entries depending on the overall 632 It enables/disables the VCS menu entries depending on the overall
633 VCS status and the directory status. 633 VCS status and the directory status.
634 </p> 634 </p>
635 <dl> 635 <dl>
636 636
637 <dt><i>menu</i></dt> 637 <dt><i>menu</i> (QMenu)</dt>
638 <dd> 638 <dd>
639 reference to the menu to be shown (QMenu) 639 reference to the menu to be shown
640 </dd> 640 </dd>
641 </dl> 641 </dl>
642 <a NAME="ProjectBaseBrowser._showContextMenuDirMulti" ID="ProjectBaseBrowser._showContextMenuDirMulti"></a> 642 <a NAME="ProjectBaseBrowser._showContextMenuDirMulti" ID="ProjectBaseBrowser._showContextMenuDirMulti"></a>
643 <h4>ProjectBaseBrowser._showContextMenuDirMulti</h4> 643 <h4>ProjectBaseBrowser._showContextMenuDirMulti</h4>
644 <b>_showContextMenuDirMulti</b>(<i>menu</i>) 644 <b>_showContextMenuDirMulti</b>(<i>menu</i>)
650 It enables/disables the VCS menu entries depending on the overall 650 It enables/disables the VCS menu entries depending on the overall
651 VCS status and the directory status. 651 VCS status and the directory status.
652 </p> 652 </p>
653 <dl> 653 <dl>
654 654
655 <dt><i>menu</i></dt> 655 <dt><i>menu</i> (QMenu)</dt>
656 <dd> 656 <dd>
657 reference to the menu to be shown (QMenu) 657 reference to the menu to be shown
658 </dd> 658 </dd>
659 </dl> 659 </dl>
660 <a NAME="ProjectBaseBrowser._showContextMenuMulti" ID="ProjectBaseBrowser._showContextMenuMulti"></a> 660 <a NAME="ProjectBaseBrowser._showContextMenuMulti" ID="ProjectBaseBrowser._showContextMenuMulti"></a>
661 <h4>ProjectBaseBrowser._showContextMenuMulti</h4> 661 <h4>ProjectBaseBrowser._showContextMenuMulti</h4>
662 <b>_showContextMenuMulti</b>(<i>menu</i>) 662 <b>_showContextMenuMulti</b>(<i>menu</i>)
669 It enables/disables the VCS menu entries depending on the overall 669 It enables/disables the VCS menu entries depending on the overall
670 VCS status and the files status. 670 VCS status and the files status.
671 </p> 671 </p>
672 <dl> 672 <dl>
673 673
674 <dt><i>menu</i></dt> 674 <dt><i>menu</i> (QMenu)</dt>
675 <dd> 675 <dd>
676 reference to the menu to be shown (QMenu) 676 reference to the menu to be shown
677 </dd> 677 </dd>
678 </dl> 678 </dl>
679 <a NAME="ProjectBaseBrowser._showProjectInFileManager" ID="ProjectBaseBrowser._showProjectInFileManager"></a> 679 <a NAME="ProjectBaseBrowser._showProjectInFileManager" ID="ProjectBaseBrowser._showProjectInFileManager"></a>
680 <h4>ProjectBaseBrowser._showProjectInFileManager</h4> 680 <h4>ProjectBaseBrowser._showProjectInFileManager</h4>
681 <b>_showProjectInFileManager</b>(<i></i>) 681 <b>_showProjectInFileManager</b>(<i></i>)
690 <p> 690 <p>
691 Public method to add a hook method to the dictionary. 691 Public method to add a hook method to the dictionary.
692 </p> 692 </p>
693 <dl> 693 <dl>
694 694
695 <dt><i>key</i></dt> 695 <dt><i>key</i> (str)</dt>
696 <dd> 696 <dd>
697 for the hook method (string) 697 for the hook method
698 </dd> 698 </dd>
699 <dt><i>method</i></dt> 699 <dt><i>method</i> (function)</dt>
700 <dd> 700 <dd>
701 reference to the hook method (method object) 701 reference to the hook method
702 </dd> 702 </dd>
703 </dl> 703 </dl>
704 <a NAME="ProjectBaseBrowser.addHookMethodAndMenuEntry" ID="ProjectBaseBrowser.addHookMethodAndMenuEntry"></a> 704 <a NAME="ProjectBaseBrowser.addHookMethodAndMenuEntry" ID="ProjectBaseBrowser.addHookMethodAndMenuEntry"></a>
705 <h4>ProjectBaseBrowser.addHookMethodAndMenuEntry</h4> 705 <h4>ProjectBaseBrowser.addHookMethodAndMenuEntry</h4>
706 <b>addHookMethodAndMenuEntry</b>(<i>key, method, menuEntry</i>) 706 <b>addHookMethodAndMenuEntry</b>(<i>key, method, menuEntry</i>)
708 <p> 708 <p>
709 Public method to add a hook method to the dictionary. 709 Public method to add a hook method to the dictionary.
710 </p> 710 </p>
711 <dl> 711 <dl>
712 712
713 <dt><i>key</i></dt> 713 <dt><i>key</i> (str)</dt>
714 <dd> 714 <dd>
715 for the hook method (string) 715 for the hook method
716 </dd> 716 </dd>
717 <dt><i>method</i></dt> 717 <dt><i>method</i> (function)</dt>
718 <dd> 718 <dd>
719 reference to the hook method (method object) 719 reference to the hook method
720 </dd> 720 </dd>
721 <dt><i>menuEntry</i></dt> 721 <dt><i>menuEntry</i> (str)</dt>
722 <dd> 722 <dd>
723 entry to be shown in the context menu (string) 723 entry to be shown in the context menu
724 </dd> 724 </dd>
725 </dl> 725 </dl>
726 <a NAME="ProjectBaseBrowser.currentDirectory" ID="ProjectBaseBrowser.currentDirectory"></a> 726 <a NAME="ProjectBaseBrowser.currentDirectory" ID="ProjectBaseBrowser.currentDirectory"></a>
727 <h4>ProjectBaseBrowser.currentDirectory</h4> 727 <h4>ProjectBaseBrowser.currentDirectory</h4>
728 <b>currentDirectory</b>(<i>relative=False</i>) 728 <b>currentDirectory</b>(<i>relative=False</i>)
760 <dt>Return:</dt> 760 <dt>Return:</dt>
761 <dd> 761 <dd>
762 reference to the current item 762 reference to the current item
763 </dd> 763 </dd>
764 </dl> 764 </dl>
765 <dl>
766 <dt>Return Type:</dt>
767 <dd>
768 BrowserItem
769 </dd>
770 </dl>
765 <a NAME="ProjectBaseBrowser.expandItemsByName" ID="ProjectBaseBrowser.expandItemsByName"></a> 771 <a NAME="ProjectBaseBrowser.expandItemsByName" ID="ProjectBaseBrowser.expandItemsByName"></a>
766 <h4>ProjectBaseBrowser.expandItemsByName</h4> 772 <h4>ProjectBaseBrowser.expandItemsByName</h4>
767 <b>expandItemsByName</b>(<i>names</i>) 773 <b>expandItemsByName</b>(<i>names</i>)
768 774
769 <p> 775 <p>
770 Public method to expand items given their names. 776 Public method to expand items given their names.
771 </p> 777 </p>
772 <dl> 778 <dl>
773 779
774 <dt><i>names</i></dt> 780 <dt><i>names</i> (list of str)</dt>
775 <dd> 781 <dd>
776 list of item names to be expanded (list of string) 782 list of item names to be expanded
777 </dd> 783 </dd>
778 </dl> 784 </dl>
779 <a NAME="ProjectBaseBrowser.getExpandedItemNames" ID="ProjectBaseBrowser.getExpandedItemNames"></a> 785 <a NAME="ProjectBaseBrowser.getExpandedItemNames" ID="ProjectBaseBrowser.getExpandedItemNames"></a>
780 <h4>ProjectBaseBrowser.getExpandedItemNames</h4> 786 <h4>ProjectBaseBrowser.getExpandedItemNames</h4>
781 <b>getExpandedItemNames</b>(<i></i>) 787 <b>getExpandedItemNames</b>(<i></i>)
784 Public method to get the file/directory names of all expanded items. 790 Public method to get the file/directory names of all expanded items.
785 </p> 791 </p>
786 <dl> 792 <dl>
787 <dt>Return:</dt> 793 <dt>Return:</dt>
788 <dd> 794 <dd>
789 list of expanded items names (list of string) 795 list of expanded items names
796 </dd>
797 </dl>
798 <dl>
799 <dt>Return Type:</dt>
800 <dd>
801 list of str
790 </dd> 802 </dd>
791 </dl> 803 </dl>
792 <a NAME="ProjectBaseBrowser.removeHookMethod" ID="ProjectBaseBrowser.removeHookMethod"></a> 804 <a NAME="ProjectBaseBrowser.removeHookMethod" ID="ProjectBaseBrowser.removeHookMethod"></a>
793 <h4>ProjectBaseBrowser.removeHookMethod</h4> 805 <h4>ProjectBaseBrowser.removeHookMethod</h4>
794 <b>removeHookMethod</b>(<i>key</i>) 806 <b>removeHookMethod</b>(<i>key</i>)
796 <p> 808 <p>
797 Public method to remove a hook method from the dictionary. 809 Public method to remove a hook method from the dictionary.
798 </p> 810 </p>
799 <dl> 811 <dl>
800 812
801 <dt><i>key</i></dt> 813 <dt><i>key</i> (str)</dt>
802 <dd> 814 <dd>
803 for the hook method (string) 815 for the hook method
804 </dd> 816 </dd>
805 </dl> 817 </dl>
806 <a NAME="ProjectBaseBrowser.selectFile" ID="ProjectBaseBrowser.selectFile"></a> 818 <a NAME="ProjectBaseBrowser.selectFile" ID="ProjectBaseBrowser.selectFile"></a>
807 <h4>ProjectBaseBrowser.selectFile</h4> 819 <h4>ProjectBaseBrowser.selectFile</h4>
808 <b>selectFile</b>(<i>fn</i>) 820 <b>selectFile</b>(<i>fn</i>)
810 <p> 822 <p>
811 Public method to highlight a node given its filename. 823 Public method to highlight a node given its filename.
812 </p> 824 </p>
813 <dl> 825 <dl>
814 826
815 <dt><i>fn</i></dt> 827 <dt><i>fn</i> (str)</dt>
816 <dd> 828 <dd>
817 filename of file to be highlighted (string) 829 filename of file to be highlighted
818 </dd> 830 </dd>
819 </dl> 831 </dl>
820 <a NAME="ProjectBaseBrowser.selectFileLine" ID="ProjectBaseBrowser.selectFileLine"></a> 832 <a NAME="ProjectBaseBrowser.selectFileLine" ID="ProjectBaseBrowser.selectFileLine"></a>
821 <h4>ProjectBaseBrowser.selectFileLine</h4> 833 <h4>ProjectBaseBrowser.selectFileLine</h4>
822 <b>selectFileLine</b>(<i>fn, lineno</i>) 834 <b>selectFileLine</b>(<i>fn, lineno</i>)
824 <p> 836 <p>
825 Public method to highlight a node given its filename. 837 Public method to highlight a node given its filename.
826 </p> 838 </p>
827 <dl> 839 <dl>
828 840
829 <dt><i>fn</i></dt> 841 <dt><i>fn</i> (str)</dt>
830 <dd> 842 <dd>
831 filename of file to be highlighted (string) 843 filename of file to be highlighted
832 </dd> 844 </dd>
833 <dt><i>lineno</i></dt> 845 <dt><i>lineno</i> (int)</dt>
834 <dd> 846 <dd>
835 one based line number of the item (integer) 847 one based line number of the item
836 </dd> 848 </dd>
837 </dl> 849 </dl>
838 <a NAME="ProjectBaseBrowser.selectLocalDirEntries" ID="ProjectBaseBrowser.selectLocalDirEntries"></a> 850 <a NAME="ProjectBaseBrowser.selectLocalDirEntries" ID="ProjectBaseBrowser.selectLocalDirEntries"></a>
839 <h4>ProjectBaseBrowser.selectLocalDirEntries</h4> 851 <h4>ProjectBaseBrowser.selectLocalDirEntries</h4>
840 <b>selectLocalDirEntries</b>(<i></i>) 852 <b>selectLocalDirEntries</b>(<i></i>)

eric ide

mercurial