Documentation/Source/eric5.Project.ProjectBrowserModel.html

changeset 945
8cd4d08fa9f6
parent 767
27554f80d08f
child 1228
7afaf2fca55b
equal deleted inserted replaced
944:1b59c4ba121e 945:8cd4d08fa9f6
70 <td>Constructor</td> 70 <td>Constructor</td>
71 </tr> 71 </tr>
72 </table> 72 </table>
73 <a NAME="ProjectBrowserDirectoryItem.__init__" ID="ProjectBrowserDirectoryItem.__init__"></a> 73 <a NAME="ProjectBrowserDirectoryItem.__init__" ID="ProjectBrowserDirectoryItem.__init__"></a>
74 <h4>ProjectBrowserDirectoryItem (Constructor)</h4> 74 <h4>ProjectBrowserDirectoryItem (Constructor)</h4>
75 <b>ProjectBrowserDirectoryItem</b>(<i>parent, dinfo, projectType, full = True, bold = False</i>) 75 <b>ProjectBrowserDirectoryItem</b>(<i>parent, dinfo, projectType, full=True, bold=False</i>)
76 <p> 76 <p>
77 Constructor 77 Constructor
78 </p><dl> 78 </p><dl>
79 <dt><i>parent</i></dt> 79 <dt><i>parent</i></dt>
80 <dd> 80 <dd>
113 <td>Constructor</td> 113 <td>Constructor</td>
114 </tr> 114 </tr>
115 </table> 115 </table>
116 <a NAME="ProjectBrowserFileItem.__init__" ID="ProjectBrowserFileItem.__init__"></a> 116 <a NAME="ProjectBrowserFileItem.__init__" ID="ProjectBrowserFileItem.__init__"></a>
117 <h4>ProjectBrowserFileItem (Constructor)</h4> 117 <h4>ProjectBrowserFileItem (Constructor)</h4>
118 <b>ProjectBrowserFileItem</b>(<i>parent, finfo, projectType, full = True, bold = False, sourceLanguage = ""</i>) 118 <b>ProjectBrowserFileItem</b>(<i>parent, finfo, projectType, full=True, bold=False, sourceLanguage=""</i>)
119 <p> 119 <p>
120 Constructor 120 Constructor
121 </p><dl> 121 </p><dl>
122 <dt><i>parent</i></dt> 122 <dt><i>parent</i></dt>
123 <dd> 123 <dd>
179 <td>Public method to set the VCS status.</td> 179 <td>Public method to set the VCS status.</td>
180 </tr> 180 </tr>
181 </table> 181 </table>
182 <a NAME="ProjectBrowserItemMixin.__init__" ID="ProjectBrowserItemMixin.__init__"></a> 182 <a NAME="ProjectBrowserItemMixin.__init__" ID="ProjectBrowserItemMixin.__init__"></a>
183 <h4>ProjectBrowserItemMixin (Constructor)</h4> 183 <h4>ProjectBrowserItemMixin (Constructor)</h4>
184 <b>ProjectBrowserItemMixin</b>(<i>type_, bold = False</i>) 184 <b>ProjectBrowserItemMixin</b>(<i>type_, bold=False</i>)
185 <p> 185 <p>
186 Constructor 186 Constructor
187 </p><dl> 187 </p><dl>
188 <dt><i>type_</i></dt> 188 <dt><i>type_</i></dt>
189 <dd> 189 <dd>
379 reference to the item cache used to store 379 reference to the item cache used to store
380 references to named items 380 references to named items
381 </dd> 381 </dd>
382 </dl><a NAME="ProjectBrowserModel.__updateVCSStatus" ID="ProjectBrowserModel.__updateVCSStatus"></a> 382 </dl><a NAME="ProjectBrowserModel.__updateVCSStatus" ID="ProjectBrowserModel.__updateVCSStatus"></a>
383 <h4>ProjectBrowserModel.__updateVCSStatus</h4> 383 <h4>ProjectBrowserModel.__updateVCSStatus</h4>
384 <b>__updateVCSStatus</b>(<i>item, name, recursive = True</i>) 384 <b>__updateVCSStatus</b>(<i>item, name, recursive=True</i>)
385 <p> 385 <p>
386 Private method used to update the vcs status of a node. 386 Private method used to update the vcs status of a node.
387 </p><dl> 387 </p><dl>
388 <dt><i>item</i></dt> 388 <dt><i>item</i></dt>
389 <dd> 389 <dd>
395 <dd> 395 <dd>
396 flag indicating a recursive update (boolean) 396 flag indicating a recursive update (boolean)
397 </dd> 397 </dd>
398 </dl><a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a> 398 </dl><a NAME="ProjectBrowserModel.addNewItem" ID="ProjectBrowserModel.addNewItem"></a>
399 <h4>ProjectBrowserModel.addNewItem</h4> 399 <h4>ProjectBrowserModel.addNewItem</h4>
400 <b>addNewItem</b>(<i>typeString, name, additionalTypeStrings = []</i>) 400 <b>addNewItem</b>(<i>typeString, name, additionalTypeStrings=[]</i>)
401 <p> 401 <p>
402 Public method to add a new item to the model. 402 Public method to add a new item to the model.
403 </p><dl> 403 </p><dl>
404 <dt><i>typeString</i></dt> 404 <dt><i>typeString</i></dt>
405 <dd> 405 <dd>
418 Public slot to record the (non normal) VCS states. 418 Public slot to record the (non normal) VCS states.
419 </p><dl> 419 </p><dl>
420 <dt><i>statesList</i></dt> 420 <dt><i>statesList</i></dt>
421 <dd> 421 <dd>
422 list of VCS state entries (list of strings) giving the 422 list of VCS state entries (list of strings) giving the
423 states in the first column and the path relative to the project 423 states in the first column and the path relative to the project
424 directory starting with the third column. The allowed status flags 424 directory starting with the third column. The allowed status flags
425 are: 425 are:
426 <ul> 426 <ul>
427 <li>"A" path was added but not yet comitted</li> 427 <li>"A" path was added but not yet comitted</li>
428 <li>"M" path has local changes</li> 428 <li>"M" path has local changes</li>
429 <li>"O" path was removed</li> 429 <li>"O" path was removed</li>
461 <dd> 461 <dd>
462 path of the directory (string) 462 path of the directory (string)
463 </dd> 463 </dd>
464 </dl><a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a> 464 </dl><a NAME="ProjectBrowserModel.findChildItem" ID="ProjectBrowserModel.findChildItem"></a>
465 <h4>ProjectBrowserModel.findChildItem</h4> 465 <h4>ProjectBrowserModel.findChildItem</h4>
466 <b>findChildItem</b>(<i>text, column, parentItem = None</i>) 466 <b>findChildItem</b>(<i>text, column, parentItem=None</i>)
467 <p> 467 <p>
468 Public method to find a child item given some text. 468 Public method to find a child item given some text.
469 </p><dl> 469 </p><dl>
470 <dt><i>text</i></dt> 470 <dt><i>text</i></dt>
471 <dd> 471 <dd>
497 <dd> 497 <dd>
498 reference to the item found 498 reference to the item found
499 </dd> 499 </dd>
500 </dl><a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a> 500 </dl><a NAME="ProjectBrowserModel.findParentItemByName" ID="ProjectBrowserModel.findParentItemByName"></a>
501 <h4>ProjectBrowserModel.findParentItemByName</h4> 501 <h4>ProjectBrowserModel.findParentItemByName</h4>
502 <b>findParentItemByName</b>(<i>type_, name, dontSplit = False</i>) 502 <b>findParentItemByName</b>(<i>type_, name, dontSplit=False</i>)
503 <p> 503 <p>
504 Public method to find an item given it's name. 504 Public method to find an item given it's name.
505 </p><p> 505 </p><p>
506 <b>Note</b>: This method creates all necessary parent items, if they 506 <b>Note</b>: This method creates all necessary parent items, if they
507 don't exist. 507 don't exist.
536 <dd> 536 <dd>
537 index of the item found (QModelIndex) 537 index of the item found (QModelIndex)
538 </dd> 538 </dd>
539 </dl><a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a> 539 </dl><a NAME="ProjectBrowserModel.populateItem" ID="ProjectBrowserModel.populateItem"></a>
540 <h4>ProjectBrowserModel.populateItem</h4> 540 <h4>ProjectBrowserModel.populateItem</h4>
541 <b>populateItem</b>(<i>parentItem, repopulate = False</i>) 541 <b>populateItem</b>(<i>parentItem, repopulate=False</i>)
542 <p> 542 <p>
543 Public method to populate an item's subtree. 543 Public method to populate an item's subtree.
544 </p><dl> 544 </p><dl>
545 <dt><i>parentItem</i></dt> 545 <dt><i>parentItem</i></dt>
546 <dd> 546 <dd>
549 <dd> 549 <dd>
550 flag indicating a repopulation (boolean) 550 flag indicating a repopulation (boolean)
551 </dd> 551 </dd>
552 </dl><a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a> 552 </dl><a NAME="ProjectBrowserModel.populateProjectDirectoryItem" ID="ProjectBrowserModel.populateProjectDirectoryItem"></a>
553 <h4>ProjectBrowserModel.populateProjectDirectoryItem</h4> 553 <h4>ProjectBrowserModel.populateProjectDirectoryItem</h4>
554 <b>populateProjectDirectoryItem</b>(<i>parentItem, repopulate = False</i>) 554 <b>populateProjectDirectoryItem</b>(<i>parentItem, repopulate=False</i>)
555 <p> 555 <p>
556 Public method to populate a directory item's subtree. 556 Public method to populate a directory item's subtree.
557 </p><dl> 557 </p><dl>
558 <dt><i>parentItem</i></dt> 558 <dt><i>parentItem</i></dt>
559 <dd> 559 <dd>
615 <dd> 615 <dd>
616 name of the file relative to the project root (string) 616 name of the file relative to the project root (string)
617 </dd> 617 </dd>
618 </dl><a NAME="ProjectBrowserModel.updateVCSStatus" ID="ProjectBrowserModel.updateVCSStatus"></a> 618 </dl><a NAME="ProjectBrowserModel.updateVCSStatus" ID="ProjectBrowserModel.updateVCSStatus"></a>
619 <h4>ProjectBrowserModel.updateVCSStatus</h4> 619 <h4>ProjectBrowserModel.updateVCSStatus</h4>
620 <b>updateVCSStatus</b>(<i>name, recursive = True</i>) 620 <b>updateVCSStatus</b>(<i>name, recursive=True</i>)
621 <p> 621 <p>
622 Public method used to update the vcs status of a node. 622 Public method used to update the vcs status of a node.
623 </p><dl> 623 </p><dl>
624 <dt><i>name</i></dt> 624 <dt><i>name</i></dt>
625 <dd> 625 <dd>
658 <td>Public method to set the directory name.</td> 658 <td>Public method to set the directory name.</td>
659 </tr> 659 </tr>
660 </table> 660 </table>
661 <a NAME="ProjectBrowserSimpleDirectoryItem.__init__" ID="ProjectBrowserSimpleDirectoryItem.__init__"></a> 661 <a NAME="ProjectBrowserSimpleDirectoryItem.__init__" ID="ProjectBrowserSimpleDirectoryItem.__init__"></a>
662 <h4>ProjectBrowserSimpleDirectoryItem (Constructor)</h4> 662 <h4>ProjectBrowserSimpleDirectoryItem (Constructor)</h4>
663 <b>ProjectBrowserSimpleDirectoryItem</b>(<i>parent, projectType, text, path = ""</i>) 663 <b>ProjectBrowserSimpleDirectoryItem</b>(<i>parent, projectType, text, path=""</i>)
664 <p> 664 <p>
665 Constructor 665 Constructor
666 </p><dl> 666 </p><dl>
667 <dt><i>parent</i></dt> 667 <dt><i>parent</i></dt>
668 <dd> 668 <dd>
708 <dd> 708 <dd>
709 true, if this item is less than other (boolean) 709 true, if this item is less than other (boolean)
710 </dd> 710 </dd>
711 </dl><a NAME="ProjectBrowserSimpleDirectoryItem.setName" ID="ProjectBrowserSimpleDirectoryItem.setName"></a> 711 </dl><a NAME="ProjectBrowserSimpleDirectoryItem.setName" ID="ProjectBrowserSimpleDirectoryItem.setName"></a>
712 <h4>ProjectBrowserSimpleDirectoryItem.setName</h4> 712 <h4>ProjectBrowserSimpleDirectoryItem.setName</h4>
713 <b>setName</b>(<i>dinfo, full = True</i>) 713 <b>setName</b>(<i>dinfo, full=True</i>)
714 <p> 714 <p>
715 Public method to set the directory name. 715 Public method to set the directory name.
716 </p><dl> 716 </p><dl>
717 <dt><i>dinfo</i></dt> 717 <dt><i>dinfo</i></dt>
718 <dd> 718 <dd>

eric ide

mercurial