src/eric7/Documentation/Source/eric7.UI.BrowserModel.html

branch
eric7
changeset 10832
479cf39ac9cb
parent 10784
521fd465b048
child 10845
bbcad422aea7
equal deleted inserted replaced
10831:f6be97f4d96a 10832:479cf39ac9cb
69 <tr> 69 <tr>
70 <td><a href="#BrowserModel">BrowserModel</a></td> 70 <td><a href="#BrowserModel">BrowserModel</a></td>
71 <td>Class implementing the browser model.</td> 71 <td>Class implementing the browser model.</td>
72 </tr> 72 </tr>
73 <tr> 73 <tr>
74 <td><a href="#BrowserModelType">BrowserModelType</a></td>
75 <td>Class defining the various browser model types.</td>
76 </tr>
77 <tr>
74 <td><a href="#BrowserSimpleDirectoryItem">BrowserSimpleDirectoryItem</a></td> 78 <td><a href="#BrowserSimpleDirectoryItem">BrowserSimpleDirectoryItem</a></td>
75 <td>Class implementing the data structure for browser simple directory items.</td> 79 <td>Class implementing the data structure for browser simple directory items.</td>
76 </tr> 80 </tr>
77 <tr> 81 <tr>
78 <td><a href="#BrowserSysPathItem">BrowserSysPathItem</a></td> 82 <td><a href="#BrowserSysPathItem">BrowserSysPathItem</a></td>
147 </table> 151 </table>
148 152
149 153
150 <a NAME="BrowserClassAttributeItem.__init__" ID="BrowserClassAttributeItem.__init__"></a> 154 <a NAME="BrowserClassAttributeItem.__init__" ID="BrowserClassAttributeItem.__init__"></a>
151 <h4>BrowserClassAttributeItem (Constructor)</h4> 155 <h4>BrowserClassAttributeItem (Constructor)</h4>
152 <b>BrowserClassAttributeItem</b>(<i>parent, attribute, isClass=False</i>) 156 <b>BrowserClassAttributeItem</b>(<i>parent, attribute, isClass=False, modelType=BrowserModelType.Generic</i>)
153 <p> 157 <p>
154 Constructor 158 Constructor
155 </p> 159 </p>
156 160
157 <dl> 161 <dl>
162 </dd> 166 </dd>
163 <dt><i>attribute</i> (Attribute)</dt> 167 <dt><i>attribute</i> (Attribute)</dt>
164 <dd> 168 <dd>
165 reference to the attribute object 169 reference to the attribute object
166 </dd> 170 </dd>
167 <dt><i>isClass</i> (bool)</dt> 171 <dt><i>isClass</i> (bool (optional))</dt>
168 <dd> 172 <dd>
169 flag indicating a class attribute 173 flag indicating a class attribute (defaults to False)
174 </dd>
175 <dt><i>modelType</i> (BrowserModelType (optional))</dt>
176 <dd>
177 type of the browser model (defaults to
178 BrowserModelType.Generic)
170 </dd> 179 </dd>
171 </dl> 180 </dl>
172 <a NAME="BrowserClassAttributeItem.attributeObject" ID="BrowserClassAttributeItem.attributeObject"></a> 181 <a NAME="BrowserClassAttributeItem.attributeObject" ID="BrowserClassAttributeItem.attributeObject"></a>
173 <h4>BrowserClassAttributeItem.attributeObject</h4> 182 <h4>BrowserClassAttributeItem.attributeObject</h4>
174 <b>attributeObject</b>(<i></i>) 183 <b>attributeObject</b>(<i></i>)
552 </table> 561 </table>
553 562
554 563
555 <a NAME="BrowserClassItem.__init__" ID="BrowserClassItem.__init__"></a> 564 <a NAME="BrowserClassItem.__init__" ID="BrowserClassItem.__init__"></a>
556 <h4>BrowserClassItem (Constructor)</h4> 565 <h4>BrowserClassItem (Constructor)</h4>
557 <b>BrowserClassItem</b>(<i>parent, cl, filename</i>) 566 <b>BrowserClassItem</b>(<i>parent, cl, filename, modelType=BrowserModelType.Generic</i>)
558 <p> 567 <p>
559 Constructor 568 Constructor
560 </p> 569 </p>
561 570
562 <dl> 571 <dl>
570 Class object to be shown 579 Class object to be shown
571 </dd> 580 </dd>
572 <dt><i>filename</i> (str)</dt> 581 <dt><i>filename</i> (str)</dt>
573 <dd> 582 <dd>
574 file name of the file defining this class 583 file name of the file defining this class
584 </dd>
585 <dt><i>modelType</i> (BrowserModelType (optional))</dt>
586 <dd>
587 type of the browser model (defaults to
588 BrowserModelType.Generic)
575 </dd> 589 </dd>
576 </dl> 590 </dl>
577 <a NAME="BrowserClassItem.boundaries" ID="BrowserClassItem.boundaries"></a> 591 <a NAME="BrowserClassItem.boundaries" ID="BrowserClassItem.boundaries"></a>
578 <h4>BrowserClassItem.boundaries</h4> 592 <h4>BrowserClassItem.boundaries</h4>
579 <b>boundaries</b>(<i></i>) 593 <b>boundaries</b>(<i></i>)
1722 </table> 1736 </table>
1723 1737
1724 1738
1725 <a NAME="BrowserImportItem.__init__" ID="BrowserImportItem.__init__"></a> 1739 <a NAME="BrowserImportItem.__init__" ID="BrowserImportItem.__init__"></a>
1726 <h4>BrowserImportItem (Constructor)</h4> 1740 <h4>BrowserImportItem (Constructor)</h4>
1727 <b>BrowserImportItem</b>(<i>parent, text, filename, lineNumbers, isModule=True</i>) 1741 <b>BrowserImportItem</b>(<i>parent, text, filename, lineNumbers, isModule=True, modelType=BrowserModelType.Generic, </i>)
1728 <p> 1742 <p>
1729 Constructor 1743 Constructor
1730 </p> 1744 </p>
1731 1745
1732 <dl> 1746 <dl>
1745 </dd> 1759 </dd>
1746 <dt><i>lineNumbers</i> (list of int)</dt> 1760 <dt><i>lineNumbers</i> (list of int)</dt>
1747 <dd> 1761 <dd>
1748 list of line numbers of the import statement 1762 list of line numbers of the import statement
1749 </dd> 1763 </dd>
1750 <dt><i>isModule</i> (bool)</dt> 1764 <dt><i>isModule</i> (bool (optional))</dt>
1751 <dd> 1765 <dd>
1752 flag indicating a module item entry 1766 flag indicating a module item entry (defaults to True)
1767 </dd>
1768 <dt><i>modelType</i> (BrowserModelType (optional))</dt>
1769 <dd>
1770 type of the browser model (defaults to
1771 BrowserModelType.Generic)
1753 </dd> 1772 </dd>
1754 </dl> 1773 </dl>
1755 <a NAME="BrowserImportItem.fileName" ID="BrowserImportItem.fileName"></a> 1774 <a NAME="BrowserImportItem.fileName" ID="BrowserImportItem.fileName"></a>
1756 <h4>BrowserImportItem.fileName</h4> 1775 <h4>BrowserImportItem.fileName</h4>
1757 <b>fileName</b>(<i></i>) 1776 <b>fileName</b>(<i></i>)
2544 </table> 2563 </table>
2545 2564
2546 2565
2547 <a NAME="BrowserMethodItem.__init__" ID="BrowserMethodItem.__init__"></a> 2566 <a NAME="BrowserMethodItem.__init__" ID="BrowserMethodItem.__init__"></a>
2548 <h4>BrowserMethodItem (Constructor)</h4> 2567 <h4>BrowserMethodItem (Constructor)</h4>
2549 <b>BrowserMethodItem</b>(<i>parent, fn, filename</i>) 2568 <b>BrowserMethodItem</b>(<i>parent, fn, filename, modelType=BrowserModelType.Generic</i>)
2550 <p> 2569 <p>
2551 Constructor 2570 Constructor
2552 </p> 2571 </p>
2553 2572
2554 <dl> 2573 <dl>
2562 Function object to be shown 2581 Function object to be shown
2563 </dd> 2582 </dd>
2564 <dt><i>filename</i> (str)</dt> 2583 <dt><i>filename</i> (str)</dt>
2565 <dd> 2584 <dd>
2566 filename of the file defining this class 2585 filename of the file defining this class
2586 </dd>
2587 <dt><i>modelType</i> (BrowserModelType (optional))</dt>
2588 <dd>
2589 type of the browser model (defaults to
2590 BrowserModelType.Generic)
2567 </dd> 2591 </dd>
2568 </dl> 2592 </dl>
2569 <a NAME="BrowserMethodItem.boundaries" ID="BrowserMethodItem.boundaries"></a> 2593 <a NAME="BrowserMethodItem.boundaries" ID="BrowserMethodItem.boundaries"></a>
2570 <h4>BrowserMethodItem.boundaries</h4> 2594 <h4>BrowserMethodItem.boundaries</h4>
2571 <b>boundaries</b>(<i></i>) 2595 <b>boundaries</b>(<i></i>)
2892 </table> 2916 </table>
2893 2917
2894 2918
2895 <a NAME="BrowserModel.__init__" ID="BrowserModel.__init__"></a> 2919 <a NAME="BrowserModel.__init__" ID="BrowserModel.__init__"></a>
2896 <h4>BrowserModel (Constructor)</h4> 2920 <h4>BrowserModel (Constructor)</h4>
2897 <b>BrowserModel</b>(<i>parent=None, nopopulate=False, fsInterface=None</i>) 2921 <b>BrowserModel</b>(<i>parent=None, nopopulate=False, fsInterface=None, modelType=BrowserModelType.Generic, </i>)
2898 <p> 2922 <p>
2899 Constructor 2923 Constructor
2900 </p> 2924 </p>
2901 2925
2902 <dl> 2926 <dl>
2911 </dd> 2935 </dd>
2912 <dt><i>fsInterface</i> (EricServerFileSystemInterface (optional))</dt> 2936 <dt><i>fsInterface</i> (EricServerFileSystemInterface (optional))</dt>
2913 <dd> 2937 <dd>
2914 reference to the 'eric-ide' server interface object 2938 reference to the 'eric-ide' server interface object
2915 (defaults to None) 2939 (defaults to None)
2940 </dd>
2941 <dt><i>modelType</i> (BrowserModelType (optional))</dt>
2942 <dd>
2943 type of the browser model (defaults to
2944 BrowserModelType.Generic)
2916 </dd> 2945 </dd>
2917 </dl> 2946 </dl>
2918 <a NAME="BrowserModel.__populateModel" ID="BrowserModel.__populateModel"></a> 2947 <a NAME="BrowserModel.__populateModel" ID="BrowserModel.__populateModel"></a>
2919 <h4>BrowserModel.__populateModel</h4> 2948 <h4>BrowserModel.__populateModel</h4>
2920 <b>__populateModel</b>(<i></i>) 2949 <b>__populateModel</b>(<i></i>)
3503 <h4>BrowserModel.saveToplevelDirs</h4> 3532 <h4>BrowserModel.saveToplevelDirs</h4>
3504 <b>saveToplevelDirs</b>(<i></i>) 3533 <b>saveToplevelDirs</b>(<i></i>)
3505 <p> 3534 <p>
3506 Public slot to save the toplevel directories. 3535 Public slot to save the toplevel directories.
3507 </p> 3536 </p>
3537
3538 <div align="right"><a href="#top">Up</a></div>
3539 <hr />
3540 <hr />
3541 <a NAME="BrowserModelType" ID="BrowserModelType"></a>
3542 <h2>BrowserModelType</h2>
3543 <p>
3544 Class defining the various browser model types.
3545 </p>
3546
3547 <h3>Derived from</h3>
3548 enum.Enum
3549 <h3>Class Attributes</h3>
3550 <table>
3551 <tr><td>EditorOutline</td></tr>
3552 <tr><td>Generic</td></tr>
3553 <tr><td>Project</td></tr>
3554 </table>
3555
3556 <h3>Class Methods</h3>
3557 <table>
3558 <tr><td>None</td></tr>
3559 </table>
3560
3561 <h3>Methods</h3>
3562 <table>
3563 <tr><td>None</td></tr>
3564 </table>
3565
3566 <h3>Static Methods</h3>
3567 <table>
3568 <tr><td>None</td></tr>
3569 </table>
3570
3508 3571
3509 <div align="right"><a href="#top">Up</a></div> 3572 <div align="right"><a href="#top">Up</a></div>
3510 <hr /> 3573 <hr />
3511 <hr /> 3574 <hr />
3512 <a NAME="BrowserSimpleDirectoryItem" ID="BrowserSimpleDirectoryItem"></a> 3575 <a NAME="BrowserSimpleDirectoryItem" ID="BrowserSimpleDirectoryItem"></a>

eric ide

mercurial