eric: Documentation/Source/eric6.UI.BrowserModel.html@e26d7d0c1088 (annotated)

 <!DOCTYPE html>
 <html><head>
 <title>eric6.UI.BrowserModel</title>
 <meta charset="UTF-8">
 <style>
 body {
     background: #EDECE6;
     margin: 0em 1em 10em 1em;
     color: black;
 }
 h1 { color: white; background: #85774A; }
 h2 { color: white; background: #85774A; }
 h3 { color: white; background: #9D936E; }
 h4 { color: white; background: #9D936E; }
 a { color: #BA6D36; }
 </style>
 </head>
 <body><a NAME="top" ID="top"></a>
 <h1>eric6.UI.BrowserModel</h1>
 <p>
 Module implementing the browser model.
 </p>
 <h3>Global Attributes</h3>
 <table>
 <tr><td>BrowserItemAttribute</td></tr><tr><td>BrowserItemAttributes</td></tr><tr><td>BrowserItemClass</td></tr><tr><td>BrowserItemCoding</td></tr><tr><td>BrowserItemDirectory</td></tr><tr><td>BrowserItemFile</td></tr><tr><td>BrowserItemMethod</td></tr><tr><td>BrowserItemRoot</td></tr><tr><td>BrowserItemSysPath</td></tr>
 </table>
 <h3>Classes</h3>
 <table>
 <tr>
 <td><a href="#BrowserClassAttributeItem">BrowserClassAttributeItem</a></td>
 <td>Class implementing the data structure for browser class attribute items.</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributesItem">BrowserClassAttributesItem</a></td>
 <td>Class implementing the data structure for browser class attributes items.</td>
 </tr><tr>
 <td><a href="#BrowserClassItem">BrowserClassItem</a></td>
 <td>Class implementing the data structure for browser class items.</td>
 </tr><tr>
 <td><a href="#BrowserCodingItem">BrowserCodingItem</a></td>
 <td>Class implementing the data structure for browser coding items.</td>
 </tr><tr>
 <td><a href="#BrowserDirectoryItem">BrowserDirectoryItem</a></td>
 <td>Class implementing the data structure for browser directory items.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem">BrowserFileItem</a></td>
 <td>Class implementing the data structure for browser file items.</td>
 </tr><tr>
 <td><a href="#BrowserItem">BrowserItem</a></td>
 <td>Class implementing the data structure for browser items.</td>
 </tr><tr>
 <td><a href="#BrowserMethodItem">BrowserMethodItem</a></td>
 <td>Class implementing the data structure for browser method items.</td>
 </tr><tr>
 <td><a href="#BrowserModel">BrowserModel</a></td>
 <td>Class implementing the browser model.</td>
 </tr><tr>
 <td><a href="#BrowserSysPathItem">BrowserSysPathItem</a></td>
 <td>Class implementing the data structure for browser sys.path items.</td>
 </tr>
 </table>
 <h3>Functions</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <hr /><hr />
 <a NAME="BrowserClassAttributeItem" ID="BrowserClassAttributeItem"></a>
 <h2>BrowserClassAttributeItem</h2>
 <p>
     Class implementing the data structure for browser class attribute items.
 </p>
 <h3>Derived from</h3>
 BrowserItem
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#BrowserClassAttributeItem.__init__">BrowserClassAttributeItem</a></td>
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributeItem.attributeObject">attributeObject</a></td>
 <td>Public method returning the class object.</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributeItem.fileName">fileName</a></td>
 <td>Public method returning the filename.</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributeItem.isPublic">isPublic</a></td>
 <td>Public method returning the public visibility status.</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributeItem.lessThan">lessThan</a></td>
 <td>Public method to check, if the item is less than the other one.</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributeItem.lineno">lineno</a></td>
 <td>Public method returning the line number defining this object.</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributeItem.linenos">linenos</a></td>
 <td>Public method returning the line numbers this object is assigned to.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="BrowserClassAttributeItem.__init__" ID="BrowserClassAttributeItem.__init__"></a>
 <h4>BrowserClassAttributeItem (Constructor)</h4>
 <b>BrowserClassAttributeItem</b>(<i>parent, attribute, isClass=False</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
 parent item
 </dd><dt><i>attribute</i></dt>
 <dd>
 reference to the attribute object
 </dd><dt><i>isClass</i></dt>
 <dd>
 flag indicating a class attribute (boolean)
 </dd>
 </dl><a NAME="BrowserClassAttributeItem.attributeObject" ID="BrowserClassAttributeItem.attributeObject"></a>
 <h4>BrowserClassAttributeItem.attributeObject</h4>
 <b>attributeObject</b>(<i></i>)
 <p>
         Public method returning the class object.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 reference to the class object
 </dd>
 </dl><a NAME="BrowserClassAttributeItem.fileName" ID="BrowserClassAttributeItem.fileName"></a>
 <h4>BrowserClassAttributeItem.fileName</h4>
 <b>fileName</b>(<i></i>)
 <p>
         Public method returning the filename.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 filename (string)
 </dd>
 </dl><a NAME="BrowserClassAttributeItem.isPublic" ID="BrowserClassAttributeItem.isPublic"></a>
 <h4>BrowserClassAttributeItem.isPublic</h4>
 <b>isPublic</b>(<i></i>)
 <p>
         Public method returning the public visibility status.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating public visibility (boolean)
 </dd>
 </dl><a NAME="BrowserClassAttributeItem.lessThan" ID="BrowserClassAttributeItem.lessThan"></a>
 <h4>BrowserClassAttributeItem.lessThan</h4>
 <b>lessThan</b>(<i>other, column, order</i>)
 <p>
         Public method to check, if the item is less than the other one.
 </p><dl>
 <dt><i>other</i></dt>
 <dd>
 reference to item to compare against (BrowserItem)
 </dd><dt><i>column</i></dt>
 <dd>
 column number to use for the comparison (integer)
 </dd><dt><i>order</i></dt>
 <dd>
 sort order (Qt.SortOrder) (for special sorting)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 true, if this item is less than other (boolean)
 </dd>
 </dl><a NAME="BrowserClassAttributeItem.lineno" ID="BrowserClassAttributeItem.lineno"></a>
 <h4>BrowserClassAttributeItem.lineno</h4>
 <b>lineno</b>(<i></i>)
 <p>
         Public method returning the line number defining this object.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 line number defining the object (integer)
 </dd>
 </dl><a NAME="BrowserClassAttributeItem.linenos" ID="BrowserClassAttributeItem.linenos"></a>
 <h4>BrowserClassAttributeItem.linenos</h4>
 <b>linenos</b>(<i></i>)
 <p>
         Public method returning the line numbers this object is assigned to.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 line number the object is assigned to (list of integers)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="BrowserClassAttributesItem" ID="BrowserClassAttributesItem"></a>
 <h2>BrowserClassAttributesItem</h2>
 <p>
     Class implementing the data structure for browser class attributes items.
 </p>
 <h3>Derived from</h3>
 BrowserItem
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#BrowserClassAttributesItem.__init__">BrowserClassAttributesItem</a></td>
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributesItem.attributes">attributes</a></td>
 <td>Public method returning the attribute list.</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributesItem.isClassAttributes">isClassAttributes</a></td>
 <td>Public method returning the attributes type.</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributesItem.lessThan">lessThan</a></td>
 <td>Public method to check, if the item is less than the other one.</td>
 </tr><tr>
 <td><a href="#BrowserClassAttributesItem.name">name</a></td>
 <td>Public method to return the name of the item.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="BrowserClassAttributesItem.__init__" ID="BrowserClassAttributesItem.__init__"></a>
 <h4>BrowserClassAttributesItem (Constructor)</h4>
 <b>BrowserClassAttributesItem</b>(<i>parent, attributes, text, isClass=False</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
 parent item
 </dd><dt><i>attributes</i></dt>
 <dd>
 list of attributes
 </dd><dt><i>text</i></dt>
 <dd>
 text to be shown by this item (string)
 </dd><dt><i>isClass</i></dt>
 <dd>
 flag indicating class attributes (boolean)
 </dd>
 </dl><a NAME="BrowserClassAttributesItem.attributes" ID="BrowserClassAttributesItem.attributes"></a>
 <h4>BrowserClassAttributesItem.attributes</h4>
 <b>attributes</b>(<i></i>)
 <p>
         Public method returning the attribute list.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 reference to the list of attributes
 </dd>
 </dl><a NAME="BrowserClassAttributesItem.isClassAttributes" ID="BrowserClassAttributesItem.isClassAttributes"></a>
 <h4>BrowserClassAttributesItem.isClassAttributes</h4>
 <b>isClassAttributes</b>(<i></i>)
 <p>
         Public method returning the attributes type.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating class attributes (boolean)
 </dd>
 </dl><a NAME="BrowserClassAttributesItem.lessThan" ID="BrowserClassAttributesItem.lessThan"></a>
 <h4>BrowserClassAttributesItem.lessThan</h4>
 <b>lessThan</b>(<i>other, column, order</i>)
 <p>
         Public method to check, if the item is less than the other one.
 </p><dl>
 <dt><i>other</i></dt>
 <dd>
 reference to item to compare against (BrowserItem)
 </dd><dt><i>column</i></dt>
 <dd>
 column number to use for the comparison (integer)
 </dd><dt><i>order</i></dt>
 <dd>
 sort order (Qt.SortOrder) (for special sorting)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 true, if this item is less than other (boolean)
 </dd>
 </dl><a NAME="BrowserClassAttributesItem.name" ID="BrowserClassAttributesItem.name"></a>
 <h4>BrowserClassAttributesItem.name</h4>
 <b>name</b>(<i></i>)
 <p>
         Public method to return the name of the item.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 name of the item (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="BrowserClassItem" ID="BrowserClassItem"></a>
 <h2>BrowserClassItem</h2>
 <p>
     Class implementing the data structure for browser class items.
 </p>
 <h3>Derived from</h3>
 BrowserItem
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#BrowserClassItem.__init__">BrowserClassItem</a></td>
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#BrowserClassItem.boundaries">boundaries</a></td>
 <td>Public method returning the boundaries of the method definition.</td>
 </tr><tr>
 <td><a href="#BrowserClassItem.classObject">classObject</a></td>
 <td>Public method returning the class object.</td>
 </tr><tr>
 <td><a href="#BrowserClassItem.fileName">fileName</a></td>
 <td>Public method returning the filename.</td>
 </tr><tr>
 <td><a href="#BrowserClassItem.isPublic">isPublic</a></td>
 <td>Public method returning the public visibility status.</td>
 </tr><tr>
 <td><a href="#BrowserClassItem.lessThan">lessThan</a></td>
 <td>Public method to check, if the item is less than the other one.</td>
 </tr><tr>
 <td><a href="#BrowserClassItem.lineno">lineno</a></td>
 <td>Public method returning the line number defining this object.</td>
 </tr><tr>
 <td><a href="#BrowserClassItem.name">name</a></td>
 <td>Public method to return the name of the item.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="BrowserClassItem.__init__" ID="BrowserClassItem.__init__"></a>
 <h4>BrowserClassItem (Constructor)</h4>
 <b>BrowserClassItem</b>(<i>parent, cl, filename</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
 parent item
 </dd><dt><i>cl</i></dt>
 <dd>
 Class object to be shown
 </dd><dt><i>filename</i></dt>
 <dd>
 filename of the file defining this class
 </dd>
 </dl><a NAME="BrowserClassItem.boundaries" ID="BrowserClassItem.boundaries"></a>
 <h4>BrowserClassItem.boundaries</h4>
 <b>boundaries</b>(<i></i>)
 <p>
         Public method returning the boundaries of the method definition.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 tuple with start end end line number (integer, integer)
 </dd>
 </dl><a NAME="BrowserClassItem.classObject" ID="BrowserClassItem.classObject"></a>
 <h4>BrowserClassItem.classObject</h4>
 <b>classObject</b>(<i></i>)
 <p>
         Public method returning the class object.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 reference to the class object
 </dd>
 </dl><a NAME="BrowserClassItem.fileName" ID="BrowserClassItem.fileName"></a>
 <h4>BrowserClassItem.fileName</h4>
 <b>fileName</b>(<i></i>)
 <p>
         Public method returning the filename.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 filename (string)
 </dd>
 </dl><a NAME="BrowserClassItem.isPublic" ID="BrowserClassItem.isPublic"></a>
 <h4>BrowserClassItem.isPublic</h4>
 <b>isPublic</b>(<i></i>)
 <p>
         Public method returning the public visibility status.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating public visibility (boolean)
 </dd>
 </dl><a NAME="BrowserClassItem.lessThan" ID="BrowserClassItem.lessThan"></a>
 <h4>BrowserClassItem.lessThan</h4>
 <b>lessThan</b>(<i>other, column, order</i>)
 <p>
         Public method to check, if the item is less than the other one.
 </p><dl>
 <dt><i>other</i></dt>
 <dd>
 reference to item to compare against (BrowserItem)
 </dd><dt><i>column</i></dt>
 <dd>
 column number to use for the comparison (integer)
 </dd><dt><i>order</i></dt>
 <dd>
 sort order (Qt.SortOrder) (for special sorting)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 true, if this item is less than other (boolean)
 </dd>
 </dl><a NAME="BrowserClassItem.lineno" ID="BrowserClassItem.lineno"></a>
 <h4>BrowserClassItem.lineno</h4>
 <b>lineno</b>(<i></i>)
 <p>
         Public method returning the line number defining this object.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 line number defining the object (integer)
 </dd>
 </dl><a NAME="BrowserClassItem.name" ID="BrowserClassItem.name"></a>
 <h4>BrowserClassItem.name</h4>
 <b>name</b>(<i></i>)
 <p>
         Public method to return the name of the item.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 name of the item (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="BrowserCodingItem" ID="BrowserCodingItem"></a>
 <h2>BrowserCodingItem</h2>
 <p>
     Class implementing the data structure for browser coding items.
 </p>
 <h3>Derived from</h3>
 BrowserItem
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#BrowserCodingItem.__init__">BrowserCodingItem</a></td>
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#BrowserCodingItem.lessThan">lessThan</a></td>
 <td>Public method to check, if the item is less than the other one.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="BrowserCodingItem.__init__" ID="BrowserCodingItem.__init__"></a>
 <h4>BrowserCodingItem (Constructor)</h4>
 <b>BrowserCodingItem</b>(<i>parent, text</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
 parent item
 </dd><dt><i>text</i></dt>
 <dd>
 text to be shown by this item (string)
 </dd>
 </dl><a NAME="BrowserCodingItem.lessThan" ID="BrowserCodingItem.lessThan"></a>
 <h4>BrowserCodingItem.lessThan</h4>
 <b>lessThan</b>(<i>other, column, order</i>)
 <p>
         Public method to check, if the item is less than the other one.
 </p><dl>
 <dt><i>other</i></dt>
 <dd>
 reference to item to compare against (BrowserItem)
 </dd><dt><i>column</i></dt>
 <dd>
 column number to use for the comparison (integer)
 </dd><dt><i>order</i></dt>
 <dd>
 sort order (Qt.SortOrder) (for special sorting)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 true, if this item is less than other (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="BrowserDirectoryItem" ID="BrowserDirectoryItem"></a>
 <h2>BrowserDirectoryItem</h2>
 <p>
     Class implementing the data structure for browser directory items.
 </p>
 <h3>Derived from</h3>
 BrowserItem
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#BrowserDirectoryItem.__init__">BrowserDirectoryItem</a></td>
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#BrowserDirectoryItem.dirName">dirName</a></td>
 <td>Public method returning the directory name.</td>
 </tr><tr>
 <td><a href="#BrowserDirectoryItem.lessThan">lessThan</a></td>
 <td>Public method to check, if the item is less than the other one.</td>
 </tr><tr>
 <td><a href="#BrowserDirectoryItem.name">name</a></td>
 <td>Public method to return the name of the item.</td>
 </tr><tr>
 <td><a href="#BrowserDirectoryItem.setName">setName</a></td>
 <td>Public method to set the directory name.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="BrowserDirectoryItem.__init__" ID="BrowserDirectoryItem.__init__"></a>
 <h4>BrowserDirectoryItem (Constructor)</h4>
 <b>BrowserDirectoryItem</b>(<i>parent, dinfo, full=True</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
 parent item
 </dd><dt><i>dinfo</i></dt>
 <dd>
 dinfo is the string for the directory (string)
 </dd><dt><i>full</i></dt>
 <dd>
 flag indicating full pathname should be displayed (boolean)
 </dd>
 </dl><a NAME="BrowserDirectoryItem.dirName" ID="BrowserDirectoryItem.dirName"></a>
 <h4>BrowserDirectoryItem.dirName</h4>
 <b>dirName</b>(<i></i>)
 <p>
         Public method returning the directory name.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 directory name (string)
 </dd>
 </dl><a NAME="BrowserDirectoryItem.lessThan" ID="BrowserDirectoryItem.lessThan"></a>
 <h4>BrowserDirectoryItem.lessThan</h4>
 <b>lessThan</b>(<i>other, column, order</i>)
 <p>
         Public method to check, if the item is less than the other one.
 </p><dl>
 <dt><i>other</i></dt>
 <dd>
 reference to item to compare against (BrowserItem)
 </dd><dt><i>column</i></dt>
 <dd>
 column number to use for the comparison (integer)
 </dd><dt><i>order</i></dt>
 <dd>
 sort order (Qt.SortOrder) (for special sorting)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 true, if this item is less than other (boolean)
 </dd>
 </dl><a NAME="BrowserDirectoryItem.name" ID="BrowserDirectoryItem.name"></a>
 <h4>BrowserDirectoryItem.name</h4>
 <b>name</b>(<i></i>)
 <p>
         Public method to return the name of the item.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 name of the item (string)
 </dd>
 </dl><a NAME="BrowserDirectoryItem.setName" ID="BrowserDirectoryItem.setName"></a>
 <h4>BrowserDirectoryItem.setName</h4>
 <b>setName</b>(<i>dinfo, full=True</i>)
 <p>
         Public method to set the directory name.
 </p><dl>
 <dt><i>dinfo</i></dt>
 <dd>
 dinfo is the string for the directory (string)
 </dd><dt><i>full</i></dt>
 <dd>
 flag indicating full pathname should be displayed (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="BrowserFileItem" ID="BrowserFileItem"></a>
 <h2>BrowserFileItem</h2>
 <p>
     Class implementing the data structure for browser file items.
 </p>
 <h3>Derived from</h3>
 BrowserItem
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#BrowserFileItem.__init__">BrowserFileItem</a></td>
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.dirName">dirName</a></td>
 <td>Public method returning the directory name.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.fileExt">fileExt</a></td>
 <td>Public method returning the file extension.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.fileName">fileName</a></td>
 <td>Public method returning the filename.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isDFile">isDFile</a></td>
 <td>Public method to check, if this file is a D file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isDesignerFile">isDesignerFile</a></td>
 <td>Public method to check, if this file is a Qt-Designer file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isIdlFile">isIdlFile</a></td>
 <td>Public method to check, if this file is a CORBA IDL file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isJavaScriptFile">isJavaScriptFile</a></td>
 <td>Public method to check, if this file is a JavaScript file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isLinguistFile">isLinguistFile</a></td>
 <td>Public method to check, if this file is a Qt-Linguist file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isMultiProjectFile">isMultiProjectFile</a></td>
 <td>Public method to check, if this file is an eric multi project file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isPixmapFile">isPixmapFile</a></td>
 <td>Public method to check, if this file is a pixmap file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isProjectFile">isProjectFile</a></td>
 <td>Public method to check, if this file is an eric project file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isPython2File">isPython2File</a></td>
 <td>Public method to check, if this file is a Python script.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isPython3File">isPython3File</a></td>
 <td>Public method to check, if this file is a Python3 script.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isResourcesFile">isResourcesFile</a></td>
 <td>Public method to check, if this file is a Qt-Resources file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isRubyFile">isRubyFile</a></td>
 <td>Public method to check, if this file is a Ruby script.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.isSvgFile">isSvgFile</a></td>
 <td>Public method to check, if this file is a SVG file.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.lessThan">lessThan</a></td>
 <td>Public method to check, if the item is less than the other one.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.moduleName">moduleName</a></td>
 <td>Public method returning the module name.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.name">name</a></td>
 <td>Public method to return the name of the item.</td>
 </tr><tr>
 <td><a href="#BrowserFileItem.setName">setName</a></td>
 <td>Public method to set the directory name.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="BrowserFileItem.__init__" ID="BrowserFileItem.__init__"></a>
 <h4>BrowserFileItem (Constructor)</h4>
 <b>BrowserFileItem</b>(<i>parent, finfo, full=True, sourceLanguage=""</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
 parent item
 </dd><dt><i>finfo</i></dt>
 <dd>
 the string for the file (string)
 </dd><dt><i>full</i></dt>
 <dd>
 flag indicating full pathname should be displayed (boolean)
 </dd><dt><i>sourceLanguage</i></dt>
 <dd>
 source code language of the project (string)
 </dd>
 </dl><a NAME="BrowserFileItem.dirName" ID="BrowserFileItem.dirName"></a>
 <h4>BrowserFileItem.dirName</h4>
 <b>dirName</b>(<i></i>)
 <p>
         Public method returning the directory name.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 directory name (string)
 </dd>
 </dl><a NAME="BrowserFileItem.fileExt" ID="BrowserFileItem.fileExt"></a>
 <h4>BrowserFileItem.fileExt</h4>
 <b>fileExt</b>(<i></i>)
 <p>
         Public method returning the file extension.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 file extension (string)
 </dd>
 </dl><a NAME="BrowserFileItem.fileName" ID="BrowserFileItem.fileName"></a>
 <h4>BrowserFileItem.fileName</h4>
 <b>fileName</b>(<i></i>)
 <p>
         Public method returning the filename.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 filename (string)
 </dd>
 </dl><a NAME="BrowserFileItem.isDFile" ID="BrowserFileItem.isDFile"></a>
 <h4>BrowserFileItem.isDFile</h4>
 <b>isDFile</b>(<i></i>)
 <p>
         Public method to check, if this file is a D file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a D file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isDesignerFile" ID="BrowserFileItem.isDesignerFile"></a>
 <h4>BrowserFileItem.isDesignerFile</h4>
 <b>isDesignerFile</b>(<i></i>)
 <p>
         Public method to check, if this file is a Qt-Designer file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a Qt-Designer file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isIdlFile" ID="BrowserFileItem.isIdlFile"></a>
 <h4>BrowserFileItem.isIdlFile</h4>
 <b>isIdlFile</b>(<i></i>)
 <p>
         Public method to check, if this file is a CORBA IDL file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a CORBA IDL file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isJavaScriptFile" ID="BrowserFileItem.isJavaScriptFile"></a>
 <h4>BrowserFileItem.isJavaScriptFile</h4>
 <b>isJavaScriptFile</b>(<i></i>)
 <p>
         Public method to check, if this file is a JavaScript file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a JavaScript file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isLinguistFile" ID="BrowserFileItem.isLinguistFile"></a>
 <h4>BrowserFileItem.isLinguistFile</h4>
 <b>isLinguistFile</b>(<i></i>)
 <p>
         Public method to check, if this file is a Qt-Linguist file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a Qt-Linguist file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isMultiProjectFile" ID="BrowserFileItem.isMultiProjectFile"></a>
 <h4>BrowserFileItem.isMultiProjectFile</h4>
 <b>isMultiProjectFile</b>(<i></i>)
 <p>
         Public method to check, if this file is an eric multi project file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating an eric project file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isPixmapFile" ID="BrowserFileItem.isPixmapFile"></a>
 <h4>BrowserFileItem.isPixmapFile</h4>
 <b>isPixmapFile</b>(<i></i>)
 <p>
         Public method to check, if this file is a pixmap file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a pixmap file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isProjectFile" ID="BrowserFileItem.isProjectFile"></a>
 <h4>BrowserFileItem.isProjectFile</h4>
 <b>isProjectFile</b>(<i></i>)
 <p>
         Public method to check, if this file is an eric project file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating an eric project file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isPython2File" ID="BrowserFileItem.isPython2File"></a>
 <h4>BrowserFileItem.isPython2File</h4>
 <b>isPython2File</b>(<i></i>)
 <p>
         Public method to check, if this file is a Python script.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a Python file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isPython3File" ID="BrowserFileItem.isPython3File"></a>
 <h4>BrowserFileItem.isPython3File</h4>
 <b>isPython3File</b>(<i></i>)
 <p>
         Public method to check, if this file is a Python3 script.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a Python file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isResourcesFile" ID="BrowserFileItem.isResourcesFile"></a>
 <h4>BrowserFileItem.isResourcesFile</h4>
 <b>isResourcesFile</b>(<i></i>)
 <p>
         Public method to check, if this file is a Qt-Resources file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a Qt-Resources file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isRubyFile" ID="BrowserFileItem.isRubyFile"></a>
 <h4>BrowserFileItem.isRubyFile</h4>
 <b>isRubyFile</b>(<i></i>)
 <p>
         Public method to check, if this file is a Ruby script.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a Ruby file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.isSvgFile" ID="BrowserFileItem.isSvgFile"></a>
 <h4>BrowserFileItem.isSvgFile</h4>
 <b>isSvgFile</b>(<i></i>)
 <p>
         Public method to check, if this file is a SVG file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 flag indicating a SVG file (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.lessThan" ID="BrowserFileItem.lessThan"></a>
 <h4>BrowserFileItem.lessThan</h4>
 <b>lessThan</b>(<i>other, column, order</i>)
 <p>
         Public method to check, if the item is less than the other one.
 </p><dl>
 <dt><i>other</i></dt>
 <dd>
 reference to item to compare against (BrowserItem)
 </dd><dt><i>column</i></dt>
 <dd>
 column number to use for the comparison (integer)
 </dd><dt><i>order</i></dt>
 <dd>
 sort order (Qt.SortOrder) (for special sorting)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 true, if this item is less than other (boolean)
 </dd>
 </dl><a NAME="BrowserFileItem.moduleName" ID="BrowserFileItem.moduleName"></a>
 <h4>BrowserFileItem.moduleName</h4>
 <b>moduleName</b>(<i></i>)
 <p>
         Public method returning the module name.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 module name (string)
 </dd>
 </dl><a NAME="BrowserFileItem.name" ID="BrowserFileItem.name"></a>
 <h4>BrowserFileItem.name</h4>
 <b>name</b>(<i></i>)
 <p>
         Public method to return the name of the item.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 name of the item (string)
 </dd>
 </dl><a NAME="BrowserFileItem.setName" ID="BrowserFileItem.setName"></a>
 <h4>BrowserFileItem.setName</h4>
 <b>setName</b>(<i>finfo, full=True</i>)
 <p>
         Public method to set the directory name.
 </p><dl>
 <dt><i>finfo</i></dt>
 <dd>
 the string for the file (string)
 </dd><dt><i>full</i></dt>
 <dd>
 flag indicating full pathname should be displayed (boolean)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr /><hr />
 <a NAME="BrowserItem" ID="BrowserItem"></a>
 <h2>BrowserItem</h2>
 <p>
     Class implementing the data structure for browser items.
 </p>
 <h3>Derived from</h3>
 object
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Class Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <h3>Methods</h3>
 <table>
 <tr>
 <td><a href="#BrowserItem.__init__">BrowserItem</a></td>
 <td>Constructor</td>
 </tr><tr>
 <td><a href="#BrowserItem.appendChild">appendChild</a></td>
 <td>Public method to add a child to this item.</td>
 </tr><tr>
 <td><a href="#BrowserItem.child">child</a></td>
 <td>Public method to get a child id.</td>
 </tr><tr>
 <td><a href="#BrowserItem.childCount">childCount</a></td>
 <td>Public method to get the number of available child items.</td>
 </tr><tr>
 <td><a href="#BrowserItem.children">children</a></td>
 <td>Public method to get the ids of all child items.</td>
 </tr><tr>
 <td><a href="#BrowserItem.columnCount">columnCount</a></td>
 <td>Public method to get the number of available data items.</td>
 </tr><tr>
 <td><a href="#BrowserItem.data">data</a></td>
 <td>Public method to get a specific data item.</td>
 </tr><tr>
 <td><a href="#BrowserItem.getIcon">getIcon</a></td>
 <td>Public method to get the items icon.</td>
 </tr><tr>
 <td><a href="#BrowserItem.isLazyPopulated">isLazyPopulated</a></td>
 <td>Public method to check, if this item should be populated lazyly.</td>
 </tr><tr>
 <td><a href="#BrowserItem.isPopulated">isPopulated</a></td>
 <td>Public method to chek, if this item is populated.</td>
 </tr><tr>
 <td><a href="#BrowserItem.isPublic">isPublic</a></td>
 <td>Public method returning the public visibility status.</td>
 </tr><tr>
 <td><a href="#BrowserItem.isSymlink">isSymlink</a></td>
 <td>Public method to check, if the items is a symbolic link.</td>
 </tr><tr>
 <td><a href="#BrowserItem.lessThan">lessThan</a></td>
 <td>Public method to check, if the item is less than the other one.</td>
 </tr><tr>
 <td><a href="#BrowserItem.parent">parent</a></td>
 <td>Public method to get the reference to the parent item.</td>
 </tr><tr>
 <td><a href="#BrowserItem.removeChild">removeChild</a></td>
 <td>Public method to remove a child.</td>
 </tr><tr>
 <td><a href="#BrowserItem.removeChildren">removeChildren</a></td>
 <td>Public method to remove all children.</td>
 </tr><tr>
 <td><a href="#BrowserItem.row">row</a></td>
 <td>Public method to get the row number of this item.</td>
 </tr><tr>
 <td><a href="#BrowserItem.type">type</a></td>
 <td>Public method to get the item type.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <a NAME="BrowserItem.__init__" ID="BrowserItem.__init__"></a>
 <h4>BrowserItem (Constructor)</h4>
 <b>BrowserItem</b>(<i>parent, data</i>)
 <p>
         Constructor
 </p><dl>
 <dt><i>parent</i></dt>
 <dd>
 reference to the parent item
 </dd><dt><i>data</i></dt>
 <dd>
 single data of the item
 </dd>
 </dl><a NAME="BrowserItem.appendChild" ID="BrowserItem.appendChild"></a>
 <h4>BrowserItem.appendChild</h4>
 <b>appendChild</b>(<i>child</i>)
 <p>
         Public method to add a child to this item.
 </p><dl>
 <dt><i>child</i></dt>
 <dd>
 reference to the child item to add (BrowserItem)
 </dd>
 </dl><a NAME="BrowserItem.child" ID="BrowserItem.child"></a>
 <h4>BrowserItem.child</h4>
 <b>child</b>(<i>row</i>)
 <p>
         Public method to get a child id.
 </p><dl>
 <dt><i>row</i></dt>
 <dd>
 number of child to get the id of (integer)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
 reference to the child item (BrowserItem)
 </dd>
 </dl><a NAME="BrowserItem.childCount" ID="BrowserItem.childCount"></a>
 <h4>BrowserItem.childCount</h4>
 <b>childCount</b>(<i></i>)
 <p>
         Public method to get the number of available child items.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 number of child items (integer)
 </dd>
 </dl><a NAME="BrowserItem.children" ID="BrowserItem.children"></a>
 <h4>BrowserItem.children</h4>
 <b>children</b>(<i></i>)
 <p>
         Public method to get the ids of all child items.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 references to all child items (list of BrowserItem)
 </dd>
 </dl><a NAME="BrowserItem.columnCount" ID="BrowserItem.columnCount"></a>
 <h4>BrowserItem.columnCount</h4>
 <b>columnCount</b>(<i></i>)
 <p>
         Public method to get the number of available data items.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
 number of data items (integer)
 </dd>
 e26d7d0c1088
Generated source docu.

Detlev Offenbach <detlev@die-offenbach&

Mercurial Repositories > eric / annotate

Documentation/Source/eric6.UI.BrowserModel.html@e26d7d0c1088 (annotated)

Documentation/Source/eric6.UI.BrowserModel.html