Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html
src/eric7/Documentation/Source/eric7.Project.ProjectBrowserModel.html
- branch
- eric7
- changeset 10430
- e440aaf179ce
- parent 10399
- 48014775ad31
- child 10472
- 3aecfec97f7c
equal
deleted
inserted
replaced
| 10429:643989a1e2bd | 10430:e440aaf179ce |
|---|---|
| 88 <p> | 88 <p> |
| 89 Constructor | 89 Constructor |
| 90 </p> | 90 </p> |
| 91 <dl> | 91 <dl> |
| 92 | 92 |
| 93 <dt><i>parent</i></dt> | 93 <dt><i>parent</i> (BrowserItem)</dt> |
| 94 <dd> | 94 <dd> |
| 95 parent item | 95 parent item |
| 96 </dd> | 96 </dd> |
| 97 <dt><i>dinfo</i></dt> | 97 <dt><i>dinfo</i> (str)</dt> |
| 98 <dd> | 98 <dd> |
| 99 dinfo is the string for the directory (string) | 99 dinfo is the string for the directory |
| 100 </dd> | 100 </dd> |
| 101 <dt><i>projectType</i></dt> | 101 <dt><i>projectType</i> (str)</dt> |
| 102 <dd> | 102 <dd> |
| 103 type of file/directory in the project | 103 type of file/directory in the project |
| 104 </dd> | 104 </dd> |
| 105 <dt><i>full</i></dt> | 105 <dt><i>full</i> (bool)</dt> |
| 106 <dd> | 106 <dd> |
| 107 flag indicating full pathname should be displayed (boolean) | 107 flag indicating full pathname should be displayed |
| 108 </dd> | 108 </dd> |
| 109 <dt><i>bold</i></dt> | 109 <dt><i>bold</i> (bool)</dt> |
| 110 <dd> | 110 <dd> |
| 111 flag indicating a highlighted font (boolean) | 111 flag indicating a highlighted font |
| 112 </dd> | 112 </dd> |
| 113 </dl> | 113 </dl> |
| 114 <div align="right"><a href="#top">Up</a></div> | 114 <div align="right"><a href="#top">Up</a></div> |
| 115 <hr /> | 115 <hr /> |
| 116 <hr /> | 116 <hr /> |
| 154 <p> | 154 <p> |
| 155 Constructor | 155 Constructor |
| 156 </p> | 156 </p> |
| 157 <dl> | 157 <dl> |
| 158 | 158 |
| 159 <dt><i>parent</i></dt> | 159 <dt><i>parent</i> (BrowserItem)</dt> |
| 160 <dd> | 160 <dd> |
| 161 parent item | 161 parent item |
| 162 </dd> | 162 </dd> |
| 163 <dt><i>finfo</i></dt> | 163 <dt><i>finfo</i> (str)</dt> |
| 164 <dd> | 164 <dd> |
| 165 the string for the file (string) | 165 the string for the file |
| 166 </dd> | 166 </dd> |
| 167 <dt><i>projectType</i></dt> | 167 <dt><i>projectType</i> (str)</dt> |
| 168 <dd> | 168 <dd> |
| 169 type of file/directory in the project | 169 type of file/directory in the project |
| 170 </dd> | 170 </dd> |
| 171 <dt><i>full</i></dt> | 171 <dt><i>full</i> (bool)</dt> |
| 172 <dd> | 172 <dd> |
| 173 flag indicating full pathname should be displayed (boolean) | 173 flag indicating full pathname should be displayed |
| 174 </dd> | 174 </dd> |
| 175 <dt><i>bold</i></dt> | 175 <dt><i>bold</i> (bool)</dt> |
| 176 <dd> | 176 <dd> |
| 177 flag indicating a highlighted font (boolean) | 177 flag indicating a highlighted font |
| 178 </dd> | 178 </dd> |
| 179 <dt><i>sourceLanguage</i></dt> | 179 <dt><i>sourceLanguage</i> (str)</dt> |
| 180 <dd> | 180 <dd> |
| 181 source code language of the project (string) | 181 source code language of the project |
| 182 </dd> | 182 </dd> |
| 183 </dl> | 183 </dl> |
| 184 <div align="right"><a href="#top">Up</a></div> | 184 <div align="right"><a href="#top">Up</a></div> |
| 185 <hr /> | 185 <hr /> |
| 186 <hr /> | 186 <hr /> |
| 251 <p> | 251 <p> |
| 252 Constructor | 252 Constructor |
| 253 </p> | 253 </p> |
| 254 <dl> | 254 <dl> |
| 255 | 255 |
| 256 <dt><i>type_</i></dt> | 256 <dt><i>type_</i> (str)</dt> |
| 257 <dd> | 257 <dd> |
| 258 type of file/directory in the project | 258 type of file/directory in the project |
| 259 </dd> | 259 </dd> |
| 260 <dt><i>bold</i></dt> | 260 <dt><i>bold</i> (bool)</dt> |
| 261 <dd> | 261 <dd> |
| 262 flag indicating a highlighted font | 262 flag indicating a highlighted font |
| 263 </dd> | 263 </dd> |
| 264 </dl> | 264 </dl> |
| 265 <a NAME="ProjectBrowserItemMixin.addProjectType" ID="ProjectBrowserItemMixin.addProjectType"></a> | 265 <a NAME="ProjectBrowserItemMixin.addProjectType" ID="ProjectBrowserItemMixin.addProjectType"></a> |
| 269 <p> | 269 <p> |
| 270 Public method to add a type to the list. | 270 Public method to add a type to the list. |
| 271 </p> | 271 </p> |
| 272 <dl> | 272 <dl> |
| 273 | 273 |
| 274 <dt><i>type_</i></dt> | 274 <dt><i>type_</i> (str)</dt> |
| 275 <dd> | 275 <dd> |
| 276 type to add to the list | 276 type to add to the list |
| 277 </dd> | 277 </dd> |
| 278 </dl> | 278 </dl> |
| 279 <a NAME="ProjectBrowserItemMixin.addVcsStatus" ID="ProjectBrowserItemMixin.addVcsStatus"></a> | 279 <a NAME="ProjectBrowserItemMixin.addVcsStatus" ID="ProjectBrowserItemMixin.addVcsStatus"></a> |
| 283 <p> | 283 <p> |
| 284 Public method to add the VCS status. | 284 Public method to add the VCS status. |
| 285 </p> | 285 </p> |
| 286 <dl> | 286 <dl> |
| 287 | 287 |
| 288 <dt><i>vcsStatus</i></dt> | 288 <dt><i>vcsStatus</i> (str)</dt> |
| 289 <dd> | 289 <dd> |
| 290 VCS status text (string) | 290 VCS status text |
| 291 </dd> | 291 </dd> |
| 292 </dl> | 292 </dl> |
| 293 <a NAME="ProjectBrowserItemMixin.getProjectTypes" ID="ProjectBrowserItemMixin.getProjectTypes"></a> | 293 <a NAME="ProjectBrowserItemMixin.getProjectTypes" ID="ProjectBrowserItemMixin.getProjectTypes"></a> |
| 294 <h4>ProjectBrowserItemMixin.getProjectTypes</h4> | 294 <h4>ProjectBrowserItemMixin.getProjectTypes</h4> |
| 295 <b>getProjectTypes</b>(<i></i>) | 295 <b>getProjectTypes</b>(<i></i>) |
| 301 <dt>Return:</dt> | 301 <dt>Return:</dt> |
| 302 <dd> | 302 <dd> |
| 303 project type | 303 project type |
| 304 </dd> | 304 </dd> |
| 305 </dl> | 305 </dl> |
| 306 <dl> | |
| 307 <dt>Return Type:</dt> | |
| 308 <dd> | |
| 309 str | |
| 310 </dd> | |
| 311 </dl> | |
| 306 <a NAME="ProjectBrowserItemMixin.getTextColor" ID="ProjectBrowserItemMixin.getTextColor"></a> | 312 <a NAME="ProjectBrowserItemMixin.getTextColor" ID="ProjectBrowserItemMixin.getTextColor"></a> |
| 307 <h4>ProjectBrowserItemMixin.getTextColor</h4> | 313 <h4>ProjectBrowserItemMixin.getTextColor</h4> |
| 308 <b>getTextColor</b>(<i></i>) | 314 <b>getTextColor</b>(<i></i>) |
| 309 | 315 |
| 310 <p> | 316 <p> |
| 311 Public method to get the items text color. | 317 Public method to get the items text color. |
| 312 </p> | 318 </p> |
| 313 <dl> | 319 <dl> |
| 314 <dt>Return:</dt> | 320 <dt>Return:</dt> |
| 315 <dd> | 321 <dd> |
| 316 text color (QColor) | 322 text color |
| 323 </dd> | |
| 324 </dl> | |
| 325 <dl> | |
| 326 <dt>Return Type:</dt> | |
| 327 <dd> | |
| 328 QColor | |
| 317 </dd> | 329 </dd> |
| 318 </dl> | 330 </dl> |
| 319 <a NAME="ProjectBrowserItemMixin.setVcsState" ID="ProjectBrowserItemMixin.setVcsState"></a> | 331 <a NAME="ProjectBrowserItemMixin.setVcsState" ID="ProjectBrowserItemMixin.setVcsState"></a> |
| 320 <h4>ProjectBrowserItemMixin.setVcsState</h4> | 332 <h4>ProjectBrowserItemMixin.setVcsState</h4> |
| 321 <b>setVcsState</b>(<i>state</i>) | 333 <b>setVcsState</b>(<i>state</i>) |
| 323 <p> | 335 <p> |
| 324 Public method to set the items VCS state. | 336 Public method to set the items VCS state. |
| 325 </p> | 337 </p> |
| 326 <dl> | 338 <dl> |
| 327 | 339 |
| 328 <dt><i>state</i></dt> | 340 <dt><i>state</i> (str)</dt> |
| 329 <dd> | 341 <dd> |
| 330 VCS state (one of A, C, M, U or " ") (string) | 342 VCS state (one of A, C, M, U or " ") |
| 331 </dd> | 343 </dd> |
| 332 </dl> | 344 </dl> |
| 333 <a NAME="ProjectBrowserItemMixin.setVcsStatus" ID="ProjectBrowserItemMixin.setVcsStatus"></a> | 345 <a NAME="ProjectBrowserItemMixin.setVcsStatus" ID="ProjectBrowserItemMixin.setVcsStatus"></a> |
| 334 <h4>ProjectBrowserItemMixin.setVcsStatus</h4> | 346 <h4>ProjectBrowserItemMixin.setVcsStatus</h4> |
| 335 <b>setVcsStatus</b>(<i>vcsStatus</i>) | 347 <b>setVcsStatus</b>(<i>vcsStatus</i>) |
| 337 <p> | 349 <p> |
| 338 Public method to set the VCS status. | 350 Public method to set the VCS status. |
| 339 </p> | 351 </p> |
| 340 <dl> | 352 <dl> |
| 341 | 353 |
| 342 <dt><i>vcsStatus</i></dt> | 354 <dt><i>vcsStatus</i> (str)</dt> |
| 343 <dd> | 355 <dd> |
| 344 VCS status text (string) | 356 VCS status text |
| 345 </dd> | 357 </dd> |
| 346 </dl> | 358 </dl> |
| 347 <div align="right"><a href="#top">Up</a></div> | 359 <div align="right"><a href="#top">Up</a></div> |
| 348 <hr /> | 360 <hr /> |
| 349 <hr /> | 361 <hr /> |
| 495 <p> | 507 <p> |
| 496 Constructor | 508 Constructor |
| 497 </p> | 509 </p> |
| 498 <dl> | 510 <dl> |
| 499 | 511 |
| 500 <dt><i>parent</i></dt> | 512 <dt><i>parent</i> (Project.Project)</dt> |
| 501 <dd> | 513 <dd> |
| 502 reference to parent object (Project.Project) | 514 reference to parent object |
| 503 </dd> | 515 </dd> |
| 504 </dl> | 516 </dl> |
| 505 <a NAME="ProjectBrowserModel.__addVCSStatus" ID="ProjectBrowserModel.__addVCSStatus"></a> | 517 <a NAME="ProjectBrowserModel.__addVCSStatus" ID="ProjectBrowserModel.__addVCSStatus"></a> |
| 506 <h4>ProjectBrowserModel.__addVCSStatus</h4> | 518 <h4>ProjectBrowserModel.__addVCSStatus</h4> |
| 507 <b>__addVCSStatus</b>(<i>item, name</i>) | 519 <b>__addVCSStatus</b>(<i>item, name</i>) |
| 509 <p> | 521 <p> |
| 510 Private method used to set the vcs status of a node. | 522 Private method used to set the vcs status of a node. |
| 511 </p> | 523 </p> |
| 512 <dl> | 524 <dl> |
| 513 | 525 |
| 514 <dt><i>item</i></dt> | 526 <dt><i>item</i> (BrowserItem)</dt> |
| 515 <dd> | 527 <dd> |
| 516 item to work on | 528 item to work on |
| 517 </dd> | 529 </dd> |
| 518 <dt><i>name</i></dt> | 530 <dt><i>name</i> (str)</dt> |
| 519 <dd> | 531 <dd> |
| 520 filename belonging to this item (string) | 532 filename belonging to this item |
| 521 </dd> | 533 </dd> |
| 522 </dl> | 534 </dl> |
| 523 <a NAME="ProjectBrowserModel.__changeParentsVCSState" ID="ProjectBrowserModel.__changeParentsVCSState"></a> | 535 <a NAME="ProjectBrowserModel.__changeParentsVCSState" ID="ProjectBrowserModel.__changeParentsVCSState"></a> |
| 524 <h4>ProjectBrowserModel.__changeParentsVCSState</h4> | 536 <h4>ProjectBrowserModel.__changeParentsVCSState</h4> |
| 525 <b>__changeParentsVCSState</b>(<i>path, itemCache</i>) | 537 <b>__changeParentsVCSState</b>(<i>path, itemCache</i>) |
| 527 <p> | 539 <p> |
| 528 Private method to recursively change the parents VCS state. | 540 Private method to recursively change the parents VCS state. |
| 529 </p> | 541 </p> |
| 530 <dl> | 542 <dl> |
| 531 | 543 |
| 532 <dt><i>path</i></dt> | 544 <dt><i>path</i> (str)</dt> |
| 533 <dd> | 545 <dd> |
| 534 pathname of parent item (string) | 546 pathname of parent item |
| 535 </dd> | 547 </dd> |
| 536 <dt><i>itemCache</i></dt> | 548 <dt><i>itemCache</i> (dict)</dt> |
| 537 <dd> | 549 <dd> |
| 538 reference to the item cache used to store | 550 reference to the item cache used to store |
| 539 references to named items | 551 references to named items |
| 540 </dd> | 552 </dd> |
| 541 </dl> | 553 </dl> |
| 546 <p> | 558 <p> |
| 547 Private method used to update the vcs status of a node. | 559 Private method used to update the vcs status of a node. |
| 548 </p> | 560 </p> |
| 549 <dl> | 561 <dl> |
| 550 | 562 |
| 551 <dt><i>item</i></dt> | 563 <dt><i>item</i> (BrowserItem)</dt> |
| 552 <dd> | 564 <dd> |
| 553 item to work on | 565 item to work on |
| 554 </dd> | 566 </dd> |
| 555 <dt><i>name</i></dt> | 567 <dt><i>name</i> (str)</dt> |
| 556 <dd> | 568 <dd> |
| 557 filename belonging to this item (string) | 569 filename belonging to this item |
| 558 </dd> | 570 </dd> |
| 559 <dt><i>recursive</i></dt> | 571 <dt><i>recursive</i> (bool)</dt> |
| 560 <dd> | 572 <dd> |
| 561 flag indicating a recursive update (boolean) | 573 flag indicating a recursive update |
| 562 </dd> | 574 </dd> |
| 563 </dl> | 575 </dl> |
| 564 <a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a> | 576 <a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a> |
| 565 <h4>ProjectBrowserModel.addNewItem</h4> | 577 <h4>ProjectBrowserModel.addNewItem</h4> |
| 566 <b>addNewItem</b>(<i>typeString, name, additionalTypeStrings=None</i>) | 578 <b>addNewItem</b>(<i>typeString, name, additionalTypeStrings=None</i>) |
| 568 <p> | 580 <p> |
| 569 Public method to add a new item to the model. | 581 Public method to add a new item to the model. |
| 570 </p> | 582 </p> |
| 571 <dl> | 583 <dl> |
| 572 | 584 |
| 573 <dt><i>typeString</i></dt> | 585 <dt><i>typeString</i> (str)</dt> |
| 574 <dd> | 586 <dd> |
| 575 string denoting the type of the new item (string) | 587 string denoting the type of the new item |
| 576 </dd> | 588 </dd> |
| 577 <dt><i>name</i></dt> | 589 <dt><i>name</i> (str)</dt> |
| 578 <dd> | 590 <dd> |
| 579 name of the new item (string) | 591 name of the new item |
| 580 </dd> | 592 </dd> |
| 581 <dt><i>additionalTypeStrings</i></dt> | 593 <dt><i>additionalTypeStrings</i> (list of str)</dt> |
| 582 <dd> | 594 <dd> |
| 583 names of additional types (list of string) | 595 names of additional types |
| 584 </dd> | 596 </dd> |
| 585 </dl> | 597 </dl> |
| 586 <a NAME="ProjectBrowserModel.changeVCSStates" ID="ProjectBrowserModel.changeVCSStates"></a> | 598 <a NAME="ProjectBrowserModel.changeVCSStates" ID="ProjectBrowserModel.changeVCSStates"></a> |
| 587 <h4>ProjectBrowserModel.changeVCSStates</h4> | 599 <h4>ProjectBrowserModel.changeVCSStates</h4> |
| 588 <b>changeVCSStates</b>(<i>statesList</i>) | 600 <b>changeVCSStates</b>(<i>statesList</i>) |
| 590 <p> | 602 <p> |
| 591 Public slot to record the (non normal) VCS states. | 603 Public slot to record the (non normal) VCS states. |
| 592 </p> | 604 </p> |
| 593 <dl> | 605 <dl> |
| 594 | 606 |
| 595 <dt><i>statesList</i></dt> | 607 <dt><i>statesList</i> (list of str)</dt> |
| 596 <dd> | 608 <dd> |
| 597 list of VCS state entries (list of strings) giving | 609 list of VCS state entries giving the states in the |
| 598 the states in the first column and the path relative to the project | 610 first column and the path relative to the project directory starting |
| 599 directory starting with the third column. The allowed status flags | 611 with the third column. The allowed status flags are: |
| 600 are: | |
| 601 <ul> | 612 <ul> |
| 602 <li>"A" path was added but not yet comitted</li> | 613 <li>"A" path was added but not yet comitted</li> |
| 603 <li>"M" path has local changes</li> | 614 <li>"M" path has local changes</li> |
| 604 <li>"O" path was removed</li> | 615 <li>"O" path was removed</li> |
| 605 <li>"R" path was deleted and then re-added</li> | 616 <li>"R" path was deleted and then re-added</li> |
| 616 <p> | 627 <p> |
| 617 Public method to get data of an item. | 628 Public method to get data of an item. |
| 618 </p> | 629 </p> |
| 619 <dl> | 630 <dl> |
| 620 | 631 |
| 621 <dt><i>index</i></dt> | 632 <dt><i>index</i> (QModelIndex)</dt> |
| 622 <dd> | 633 <dd> |
| 623 index of the data to retrieve (QModelIndex) | 634 index of the data to retrieve |
| 624 </dd> | 635 </dd> |
| 625 <dt><i>role</i></dt> | 636 <dt><i>role</i> (Qt.ItemDataRole)</dt> |
| 626 <dd> | 637 <dd> |
| 627 role of data (Qt.ItemDataRole) | 638 role of data |
| 628 </dd> | 639 </dd> |
| 629 </dl> | 640 </dl> |
| 630 <dl> | 641 <dl> |
| 631 <dt>Return:</dt> | 642 <dt>Return:</dt> |
| 632 <dd> | 643 <dd> |
| 633 requested data | 644 requested data |
| 645 </dd> | |
| 646 </dl> | |
| 647 <dl> | |
| 648 <dt>Return Type:</dt> | |
| 649 <dd> | |
| 650 Any | |
| 634 </dd> | 651 </dd> |
| 635 </dl> | 652 </dl> |
| 636 <a NAME="ProjectBrowserModel.directoryChanged" ID="ProjectBrowserModel.directoryChanged"></a> | 653 <a NAME="ProjectBrowserModel.directoryChanged" ID="ProjectBrowserModel.directoryChanged"></a> |
| 637 <h4>ProjectBrowserModel.directoryChanged</h4> | 654 <h4>ProjectBrowserModel.directoryChanged</h4> |
| 638 <b>directoryChanged</b>(<i>path</i>) | 655 <b>directoryChanged</b>(<i>path</i>) |
| 640 <p> | 657 <p> |
| 641 Public slot to handle the directoryChanged signal of the watcher. | 658 Public slot to handle the directoryChanged signal of the watcher. |
| 642 </p> | 659 </p> |
| 643 <dl> | 660 <dl> |
| 644 | 661 |
| 645 <dt><i>path</i></dt> | 662 <dt><i>path</i> (str)</dt> |
| 646 <dd> | 663 <dd> |
| 647 path of the directory (string) | 664 path of the directory |
| 648 </dd> | 665 </dd> |
| 649 </dl> | 666 </dl> |
| 650 <a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a> | 667 <a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a> |
| 651 <h4>ProjectBrowserModel.findChildItem</h4> | 668 <h4>ProjectBrowserModel.findChildItem</h4> |
| 652 <b>findChildItem</b>(<i>text, column, parentItem=None</i>) | 669 <b>findChildItem</b>(<i>text, column, parentItem=None</i>) |
| 654 <p> | 671 <p> |
| 655 Public method to find a child item given some text. | 672 Public method to find a child item given some text. |
| 656 </p> | 673 </p> |
| 657 <dl> | 674 <dl> |
| 658 | 675 |
| 659 <dt><i>text</i></dt> | 676 <dt><i>text</i> (str)</dt> |
| 660 <dd> | 677 <dd> |
| 661 text to search for (string) | 678 text to search for |
| 662 </dd> | 679 </dd> |
| 663 <dt><i>column</i></dt> | 680 <dt><i>column</i> (int)</dt> |
| 664 <dd> | 681 <dd> |
| 665 column to search in (integer) | 682 column to search in |
| 666 </dd> | 683 </dd> |
| 667 <dt><i>parentItem</i></dt> | 684 <dt><i>parentItem</i> (BrowserItem)</dt> |
| 668 <dd> | 685 <dd> |
| 669 reference to parent item | 686 reference to parent item |
| 670 </dd> | 687 </dd> |
| 671 </dl> | 688 </dl> |
| 672 <dl> | 689 <dl> |
| 673 <dt>Return:</dt> | 690 <dt>Return:</dt> |
| 674 <dd> | 691 <dd> |
| 675 reference to the item found | 692 reference to the item found |
| 693 </dd> | |
| 694 </dl> | |
| 695 <dl> | |
| 696 <dt>Return Type:</dt> | |
| 697 <dd> | |
| 698 BrowserItem | |
| 676 </dd> | 699 </dd> |
| 677 </dl> | 700 </dl> |
| 678 <a NAME="ProjectBrowserModel.findItem" ID="ProjectBrowserModel.findItem"></a> | 701 <a NAME="ProjectBrowserModel.findItem" ID="ProjectBrowserModel.findItem"></a> |
| 679 <h4>ProjectBrowserModel.findItem</h4> | 702 <h4>ProjectBrowserModel.findItem</h4> |
| 680 <b>findItem</b>(<i>name</i>) | 703 <b>findItem</b>(<i>name</i>) |
| 682 <p> | 705 <p> |
| 683 Public method to find an item given its name. | 706 Public method to find an item given its name. |
| 684 </p> | 707 </p> |
| 685 <dl> | 708 <dl> |
| 686 | 709 |
| 687 <dt><i>name</i></dt> | 710 <dt><i>name</i> (str)</dt> |
| 688 <dd> | 711 <dd> |
| 689 name of the item (string) | 712 name of the item |
| 690 </dd> | 713 </dd> |
| 691 </dl> | 714 </dl> |
| 692 <dl> | 715 <dl> |
| 693 <dt>Return:</dt> | 716 <dt>Return:</dt> |
| 694 <dd> | 717 <dd> |
| 695 reference to the item found | 718 reference to the item found |
| 719 </dd> | |
| 720 </dl> | |
| 721 <dl> | |
| 722 <dt>Return Type:</dt> | |
| 723 <dd> | |
| 724 BrowserItem | |
| 696 </dd> | 725 </dd> |
| 697 </dl> | 726 </dl> |
| 698 <a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a> | 727 <a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a> |
| 699 <h4>ProjectBrowserModel.findParentItemByName</h4> | 728 <h4>ProjectBrowserModel.findParentItemByName</h4> |
| 700 <b>findParentItemByName</b>(<i>type_, name, dontSplit=False</i>) | 729 <b>findParentItemByName</b>(<i>type_, name, dontSplit=False</i>) |
| 706 <b>Note</b>: This method creates all necessary parent items, if they | 735 <b>Note</b>: This method creates all necessary parent items, if they |
| 707 don't exist. | 736 don't exist. |
| 708 </p> | 737 </p> |
| 709 <dl> | 738 <dl> |
| 710 | 739 |
| 711 <dt><i>type_</i></dt> | 740 <dt><i>type_</i> (str)</dt> |
| 712 <dd> | 741 <dd> |
| 713 type of the item | 742 type of the item |
| 714 </dd> | 743 </dd> |
| 715 <dt><i>name</i></dt> | 744 <dt><i>name</i> (str)</dt> |
| 716 <dd> | 745 <dd> |
| 717 name of the item (string) | 746 name of the item |
| 718 </dd> | 747 </dd> |
| 719 <dt><i>dontSplit</i></dt> | 748 <dt><i>dontSplit</i> (bool)</dt> |
| 720 <dd> | 749 <dd> |
| 721 flag indicating the name should not be split (boolean) | 750 flag indicating the name should not be split |
| 722 </dd> | 751 </dd> |
| 723 </dl> | 752 </dl> |
| 724 <dl> | 753 <dl> |
| 725 <dt>Return:</dt> | 754 <dt>Return:</dt> |
| 726 <dd> | 755 <dd> |
| 727 reference to the item found and the new display name (string) | 756 reference to the item found and the new display name |
| 757 </dd> | |
| 758 </dl> | |
| 759 <dl> | |
| 760 <dt>Return Type:</dt> | |
| 761 <dd> | |
| 762 str | |
| 728 </dd> | 763 </dd> |
| 729 </dl> | 764 </dl> |
| 730 <a NAME="ProjectBrowserModel.itemIndexByName" ID="ProjectBrowserModel.itemIndexByName"></a> | 765 <a NAME="ProjectBrowserModel.itemIndexByName" ID="ProjectBrowserModel.itemIndexByName"></a> |
| 731 <h4>ProjectBrowserModel.itemIndexByName</h4> | 766 <h4>ProjectBrowserModel.itemIndexByName</h4> |
| 732 <b>itemIndexByName</b>(<i>name</i>) | 767 <b>itemIndexByName</b>(<i>name</i>) |
| 734 <p> | 769 <p> |
| 735 Public method to find an item's index given its name. | 770 Public method to find an item's index given its name. |
| 736 </p> | 771 </p> |
| 737 <dl> | 772 <dl> |
| 738 | 773 |
| 739 <dt><i>name</i></dt> | 774 <dt><i>name</i> (str)</dt> |
| 740 <dd> | 775 <dd> |
| 741 name of the item (string) | 776 name of the item |
| 742 </dd> | 777 </dd> |
| 743 </dl> | 778 </dl> |
| 744 <dl> | 779 <dl> |
| 745 <dt>Return:</dt> | 780 <dt>Return:</dt> |
| 746 <dd> | 781 <dd> |
| 747 index of the item found (QModelIndex) | 782 index of the item found |
| 783 </dd> | |
| 784 </dl> | |
| 785 <dl> | |
| 786 <dt>Return Type:</dt> | |
| 787 <dd> | |
| 788 QModelIndex | |
| 748 </dd> | 789 </dd> |
| 749 </dl> | 790 </dl> |
| 750 <a NAME="ProjectBrowserModel.itemIndexByNameAndLine" ID="ProjectBrowserModel.itemIndexByNameAndLine"></a> | 791 <a NAME="ProjectBrowserModel.itemIndexByNameAndLine" ID="ProjectBrowserModel.itemIndexByNameAndLine"></a> |
| 751 <h4>ProjectBrowserModel.itemIndexByNameAndLine</h4> | 792 <h4>ProjectBrowserModel.itemIndexByNameAndLine</h4> |
| 752 <b>itemIndexByNameAndLine</b>(<i>name, lineno</i>) | 793 <b>itemIndexByNameAndLine</b>(<i>name, lineno</i>) |
| 754 <p> | 795 <p> |
| 755 Public method to find an item's index given its name. | 796 Public method to find an item's index given its name. |
| 756 </p> | 797 </p> |
| 757 <dl> | 798 <dl> |
| 758 | 799 |
| 759 <dt><i>name</i></dt> | 800 <dt><i>name</i> (str)</dt> |
| 760 <dd> | 801 <dd> |
| 761 name of the item (string) | 802 name of the item |
| 762 </dd> | 803 </dd> |
| 763 <dt><i>lineno</i></dt> | 804 <dt><i>lineno</i> (int)</dt> |
| 764 <dd> | 805 <dd> |
| 765 one based line number of the item (integer) | 806 one based line number of the item |
| 766 </dd> | 807 </dd> |
| 767 </dl> | 808 </dl> |
| 768 <dl> | 809 <dl> |
| 769 <dt>Return:</dt> | 810 <dt>Return:</dt> |
| 770 <dd> | 811 <dd> |
| 771 index of the item found (QModelIndex) | 812 index of the item found |
| 813 </dd> | |
| 814 </dl> | |
| 815 <dl> | |
| 816 <dt>Return Type:</dt> | |
| 817 <dd> | |
| 818 QModelIndex | |
| 772 </dd> | 819 </dd> |
| 773 </dl> | 820 </dl> |
| 774 <a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a> | 821 <a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a> |
| 775 <h4>ProjectBrowserModel.populateItem</h4> | 822 <h4>ProjectBrowserModel.populateItem</h4> |
| 776 <b>populateItem</b>(<i>parentItem, repopulate=False</i>) | 823 <b>populateItem</b>(<i>parentItem, repopulate=False</i>) |
| 778 <p> | 825 <p> |
| 779 Public method to populate an item's subtree. | 826 Public method to populate an item's subtree. |
| 780 </p> | 827 </p> |
| 781 <dl> | 828 <dl> |
| 782 | 829 |
| 783 <dt><i>parentItem</i></dt> | 830 <dt><i>parentItem</i> (BrowserItem)</dt> |
| 784 <dd> | 831 <dd> |
| 785 reference to the item to be populated | 832 reference to the item to be populated |
| 786 </dd> | 833 </dd> |
| 787 <dt><i>repopulate</i></dt> | 834 <dt><i>repopulate</i> (bool)</dt> |
| 788 <dd> | 835 <dd> |
| 789 flag indicating a repopulation (boolean) | 836 flag indicating a repopulation |
| 790 </dd> | 837 </dd> |
| 791 </dl> | 838 </dl> |
| 792 <a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a> | 839 <a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a> |
| 793 <h4>ProjectBrowserModel.populateProjectDirectoryItem</h4> | 840 <h4>ProjectBrowserModel.populateProjectDirectoryItem</h4> |
| 794 <b>populateProjectDirectoryItem</b>(<i>parentItem, repopulate=False</i>) | 841 <b>populateProjectDirectoryItem</b>(<i>parentItem, repopulate=False</i>) |
| 796 <p> | 843 <p> |
| 797 Public method to populate a directory item's subtree. | 844 Public method to populate a directory item's subtree. |
| 798 </p> | 845 </p> |
| 799 <dl> | 846 <dl> |
| 800 | 847 |
| 801 <dt><i>parentItem</i></dt> | 848 <dt><i>parentItem</i> (BrowserItem)</dt> |
| 802 <dd> | 849 <dd> |
| 803 reference to the directory item to be populated | 850 reference to the directory item to be populated |
| 804 </dd> | 851 </dd> |
| 805 <dt><i>repopulate</i></dt> | 852 <dt><i>repopulate</i> (bool)</dt> |
| 806 <dd> | 853 <dd> |
| 807 flag indicating a repopulation (boolean) | 854 flag indicating a repopulation |
| 808 </dd> | 855 </dd> |
| 809 </dl> | 856 </dl> |
| 810 <a NAME="ProjectBrowserModel.preferencesChanged" ID="ProjectBrowserModel.preferencesChanged"></a> | 857 <a NAME="ProjectBrowserModel.preferencesChanged" ID="ProjectBrowserModel.preferencesChanged"></a> |
| 811 <h4>ProjectBrowserModel.preferencesChanged</h4> | 858 <h4>ProjectBrowserModel.preferencesChanged</h4> |
| 812 <b>preferencesChanged</b>(<i></i>) | 859 <b>preferencesChanged</b>(<i></i>) |
| 843 <p> | 890 <p> |
| 844 Public method to remove a named item. | 891 Public method to remove a named item. |
| 845 </p> | 892 </p> |
| 846 <dl> | 893 <dl> |
| 847 | 894 |
| 848 <dt><i>name</i></dt> | 895 <dt><i>name</i> (str)</dt> |
| 849 <dd> | 896 <dd> |
| 850 file or directory name of the item (string). | 897 file or directory name of the item |
| 851 </dd> | 898 </dd> |
| 852 </dl> | 899 </dl> |
| 853 <a NAME="ProjectBrowserModel.renameItem" ID="ProjectBrowserModel.renameItem"></a> | 900 <a NAME="ProjectBrowserModel.renameItem" ID="ProjectBrowserModel.renameItem"></a> |
| 854 <h4>ProjectBrowserModel.renameItem</h4> | 901 <h4>ProjectBrowserModel.renameItem</h4> |
| 855 <b>renameItem</b>(<i>name, newFilename</i>) | 902 <b>renameItem</b>(<i>name, newFilename</i>) |
| 857 <p> | 904 <p> |
| 858 Public method to rename an item. | 905 Public method to rename an item. |
| 859 </p> | 906 </p> |
| 860 <dl> | 907 <dl> |
| 861 | 908 |
| 862 <dt><i>name</i></dt> | 909 <dt><i>name</i> (str)</dt> |
| 863 <dd> | 910 <dd> |
| 864 the old display name (string) | 911 the old display name |
| 865 </dd> | 912 </dd> |
| 866 <dt><i>newFilename</i></dt> | 913 <dt><i>newFilename</i> (str)</dt> |
| 867 <dd> | 914 <dd> |
| 868 new filename of the item (string) | 915 new filename of the item |
| 869 </dd> | 916 </dd> |
| 870 </dl> | 917 </dl> |
| 871 <a NAME="ProjectBrowserModel.repopulateItem" ID="ProjectBrowserModel.repopulateItem"></a> | 918 <a NAME="ProjectBrowserModel.repopulateItem" ID="ProjectBrowserModel.repopulateItem"></a> |
| 872 <h4>ProjectBrowserModel.repopulateItem</h4> | 919 <h4>ProjectBrowserModel.repopulateItem</h4> |
| 873 <b>repopulateItem</b>(<i>name</i>) | 920 <b>repopulateItem</b>(<i>name</i>) |
| 875 <p> | 922 <p> |
| 876 Public method to repopulate an item. | 923 Public method to repopulate an item. |
| 877 </p> | 924 </p> |
| 878 <dl> | 925 <dl> |
| 879 | 926 |
| 880 <dt><i>name</i></dt> | 927 <dt><i>name</i> (str)</dt> |
| 881 <dd> | 928 <dd> |
| 882 name of the file relative to the project root (string) | 929 name of the file relative to the project root |
| 883 </dd> | 930 </dd> |
| 884 </dl> | 931 </dl> |
| 885 <a NAME="ProjectBrowserModel.setProjectBrowserReference" ID="ProjectBrowserModel.setProjectBrowserReference"></a> | 932 <a NAME="ProjectBrowserModel.setProjectBrowserReference" ID="ProjectBrowserModel.setProjectBrowserReference"></a> |
| 886 <h4>ProjectBrowserModel.setProjectBrowserReference</h4> | 933 <h4>ProjectBrowserModel.setProjectBrowserReference</h4> |
| 887 <b>setProjectBrowserReference</b>(<i>projectBrowser</i>) | 934 <b>setProjectBrowserReference</b>(<i>projectBrowser</i>) |
| 917 <p> | 964 <p> |
| 918 Public method used to update the vcs status of a node. | 965 Public method used to update the vcs status of a node. |
| 919 </p> | 966 </p> |
| 920 <dl> | 967 <dl> |
| 921 | 968 |
| 922 <dt><i>name</i></dt> | 969 <dt><i>name</i> (str)</dt> |
| 923 <dd> | 970 <dd> |
| 924 filename belonging to this item (string) | 971 filename belonging to this item |
| 925 </dd> | 972 </dd> |
| 926 <dt><i>recursive</i></dt> | 973 <dt><i>recursive</i> (bool)</dt> |
| 927 <dd> | 974 <dd> |
| 928 flag indicating a recursive update (boolean) | 975 flag indicating a recursive update |
| 929 </dd> | 976 </dd> |
| 930 </dl> | 977 </dl> |
| 931 <div align="right"><a href="#top">Up</a></div> | 978 <div align="right"><a href="#top">Up</a></div> |
| 932 <hr /> | 979 <hr /> |
| 933 <hr /> | 980 <hr /> |
| 972 <p> | 1019 <p> |
| 973 Constructor | 1020 Constructor |
| 974 </p> | 1021 </p> |
| 975 <dl> | 1022 <dl> |
| 976 | 1023 |
| 977 <dt><i>parent</i></dt> | 1024 <dt><i>parent</i> (BrowserItem)</dt> |
| 978 <dd> | 1025 <dd> |
| 979 parent item | 1026 parent item |
| 980 </dd> | 1027 </dd> |
| 981 <dt><i>projectType</i></dt> | 1028 <dt><i>projectType</i> (str)</dt> |
| 982 <dd> | 1029 <dd> |
| 983 type of file/directory in the project | 1030 type of file/directory in the project |
| 984 </dd> | 1031 </dd> |
| 985 <dt><i>text</i></dt> | 1032 <dt><i>text</i> (str)</dt> |
| 986 <dd> | 1033 <dd> |
| 987 text to be displayed (string) | 1034 text to be displayed |
| 988 </dd> | 1035 </dd> |
| 989 <dt><i>path</i></dt> | 1036 <dt><i>path</i> (str)</dt> |
| 990 <dd> | 1037 <dd> |
| 991 path of the directory (string) | 1038 path of the directory |
| 992 </dd> | 1039 </dd> |
| 993 </dl> | 1040 </dl> |
| 994 <div align="right"><a href="#top">Up</a></div> | 1041 <div align="right"><a href="#top">Up</a></div> |
| 995 <hr /> | 1042 <hr /> |
| 996 </body></html> | 1043 </body></html> |
