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

branch
eric7
changeset 10399
48014775ad31
parent 10259
b51dfacef37f
child 10433
328f3ec4b77a
equal deleted inserted replaced
10398:ef1ea18994d5 10399:48014775ad31
12 Module implementing the browser model. 12 Module implementing the browser model.
13 </p> 13 </p>
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15
16 <table> 16 <table>
17 <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>BrowserItemImport</td></tr><tr><td>BrowserItemImports</td></tr><tr><td>BrowserItemMethod</td></tr><tr><td>BrowserItemRoot</td></tr><tr><td>BrowserItemSysPath</td></tr> 17 <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>BrowserItemImport</td></tr><tr><td>BrowserItemImports</td></tr><tr><td>BrowserItemMethod</td></tr><tr><td>BrowserItemRoot</td></tr><tr><td>BrowserItemSimpleDirectory</td></tr><tr><td>BrowserItemSysPath</td></tr>
18 </table> 18 </table>
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20
21 <table> 21 <table>
22 22
65 <td>Class implementing the data structure for browser method items.</td> 65 <td>Class implementing the data structure for browser method items.</td>
66 </tr> 66 </tr>
67 <tr> 67 <tr>
68 <td><a href="#BrowserModel">BrowserModel</a></td> 68 <td><a href="#BrowserModel">BrowserModel</a></td>
69 <td>Class implementing the browser model.</td> 69 <td>Class implementing the browser model.</td>
70 </tr>
71 <tr>
72 <td><a href="#BrowserSimpleDirectoryItem">BrowserSimpleDirectoryItem</a></td>
73 <td>Class implementing the data structure for browser simple directory items.</td>
70 </tr> 74 </tr>
71 <tr> 75 <tr>
72 <td><a href="#BrowserSysPathItem">BrowserSysPathItem</a></td> 76 <td><a href="#BrowserSysPathItem">BrowserSysPathItem</a></td>
73 <td>Class implementing the data structure for browser sys.path items.</td> 77 <td>Class implementing the data structure for browser sys.path items.</td>
74 </tr> 78 </tr>
2935 Public slot to save the toplevel directories. 2939 Public slot to save the toplevel directories.
2936 </p> 2940 </p>
2937 <div align="right"><a href="#top">Up</a></div> 2941 <div align="right"><a href="#top">Up</a></div>
2938 <hr /> 2942 <hr />
2939 <hr /> 2943 <hr />
2940 <a NAME="BrowserSysPathItem" ID="BrowserSysPathItem"></a> 2944 <a NAME="BrowserSimpleDirectoryItem" ID="BrowserSimpleDirectoryItem"></a>
2941 <h2>BrowserSysPathItem</h2> 2945 <h2>BrowserSimpleDirectoryItem</h2>
2942 2946
2943 <p> 2947 <p>
2944 Class implementing the data structure for browser sys.path items. 2948 Class implementing the data structure for browser simple directory items.
2945 </p> 2949 </p>
2946 <h3>Derived from</h3> 2950 <h3>Derived from</h3>
2947 BrowserItem 2951 BrowserItem
2948 <h3>Class Attributes</h3> 2952 <h3>Class Attributes</h3>
2949 2953
2958 <h3>Methods</h3> 2962 <h3>Methods</h3>
2959 2963
2960 <table> 2964 <table>
2961 2965
2962 <tr> 2966 <tr>
2967 <td><a href="#BrowserSimpleDirectoryItem.__init__">BrowserSimpleDirectoryItem</a></td>
2968 <td>Constructor</td>
2969 </tr>
2970 <tr>
2971 <td><a href="#BrowserSimpleDirectoryItem.dirName">dirName</a></td>
2972 <td>Public method returning the directory name.</td>
2973 </tr>
2974 <tr>
2975 <td><a href="#BrowserSimpleDirectoryItem.lessThan">lessThan</a></td>
2976 <td>Public method to check, if the item is less than the other one.</td>
2977 </tr>
2978 <tr>
2979 <td><a href="#BrowserSimpleDirectoryItem.name">name</a></td>
2980 <td>Public method to return the name of the item.</td>
2981 </tr>
2982 <tr>
2983 <td><a href="#BrowserSimpleDirectoryItem.setName">setName</a></td>
2984 <td>Public method to set the directory name.</td>
2985 </tr>
2986 </table>
2987 <h3>Static Methods</h3>
2988
2989 <table>
2990 <tr><td>None</td></tr>
2991 </table>
2992
2993 <a NAME="BrowserSimpleDirectoryItem.__init__" ID="BrowserSimpleDirectoryItem.__init__"></a>
2994 <h4>BrowserSimpleDirectoryItem (Constructor)</h4>
2995 <b>BrowserSimpleDirectoryItem</b>(<i>parent, text, path=""</i>)
2996
2997 <p>
2998 Constructor
2999 </p>
3000 <dl>
3001
3002 <dt><i>parent</i></dt>
3003 <dd>
3004 parent item
3005 </dd>
3006 <dt><i>text</i></dt>
3007 <dd>
3008 text to be displayed (string)
3009 </dd>
3010 <dt><i>path</i></dt>
3011 <dd>
3012 path of the directory (string)
3013 </dd>
3014 </dl>
3015 <a NAME="BrowserSimpleDirectoryItem.dirName" ID="BrowserSimpleDirectoryItem.dirName"></a>
3016 <h4>BrowserSimpleDirectoryItem.dirName</h4>
3017 <b>dirName</b>(<i></i>)
3018
3019 <p>
3020 Public method returning the directory name.
3021 </p>
3022 <dl>
3023 <dt>Return:</dt>
3024 <dd>
3025 directory name (string)
3026 </dd>
3027 </dl>
3028 <a NAME="BrowserSimpleDirectoryItem.lessThan" ID="BrowserSimpleDirectoryItem.lessThan"></a>
3029 <h4>BrowserSimpleDirectoryItem.lessThan</h4>
3030 <b>lessThan</b>(<i>other, column, order</i>)
3031
3032 <p>
3033 Public method to check, if the item is less than the other one.
3034 </p>
3035 <dl>
3036
3037 <dt><i>other</i></dt>
3038 <dd>
3039 reference to item to compare against (BrowserItem)
3040 </dd>
3041 <dt><i>column</i></dt>
3042 <dd>
3043 column number to use for the comparison (integer)
3044 </dd>
3045 <dt><i>order</i></dt>
3046 <dd>
3047 sort order (Qt.SortOrder) (for special sorting)
3048 </dd>
3049 </dl>
3050 <dl>
3051 <dt>Return:</dt>
3052 <dd>
3053 true, if this item is less than other (boolean)
3054 </dd>
3055 </dl>
3056 <a NAME="BrowserSimpleDirectoryItem.name" ID="BrowserSimpleDirectoryItem.name"></a>
3057 <h4>BrowserSimpleDirectoryItem.name</h4>
3058 <b>name</b>(<i></i>)
3059
3060 <p>
3061 Public method to return the name of the item.
3062 </p>
3063 <dl>
3064 <dt>Return:</dt>
3065 <dd>
3066 name of the item (string)
3067 </dd>
3068 </dl>
3069 <a NAME="BrowserSimpleDirectoryItem.setName" ID="BrowserSimpleDirectoryItem.setName"></a>
3070 <h4>BrowserSimpleDirectoryItem.setName</h4>
3071 <b>setName</b>(<i>dinfo, full=True</i>)
3072
3073 <p>
3074 Public method to set the directory name.
3075 </p>
3076 <dl>
3077
3078 <dt><i>dinfo</i></dt>
3079 <dd>
3080 dinfo is the string for the directory (string)
3081 </dd>
3082 <dt><i>full</i></dt>
3083 <dd>
3084 flag indicating full path name should be displayed (boolean)
3085 </dd>
3086 </dl>
3087 <div align="right"><a href="#top">Up</a></div>
3088 <hr />
3089 <hr />
3090 <a NAME="BrowserSysPathItem" ID="BrowserSysPathItem"></a>
3091 <h2>BrowserSysPathItem</h2>
3092
3093 <p>
3094 Class implementing the data structure for browser sys.path items.
3095 </p>
3096 <h3>Derived from</h3>
3097 BrowserItem
3098 <h3>Class Attributes</h3>
3099
3100 <table>
3101 <tr><td>None</td></tr>
3102 </table>
3103 <h3>Class Methods</h3>
3104
3105 <table>
3106 <tr><td>None</td></tr>
3107 </table>
3108 <h3>Methods</h3>
3109
3110 <table>
3111
3112 <tr>
2963 <td><a href="#BrowserSysPathItem.__init__">BrowserSysPathItem</a></td> 3113 <td><a href="#BrowserSysPathItem.__init__">BrowserSysPathItem</a></td>
2964 <td>Constructor</td> 3114 <td>Constructor</td>
2965 </tr> 3115 </tr>
2966 <tr> 3116 <tr>
2967 <td><a href="#BrowserSysPathItem.name">name</a></td> 3117 <td><a href="#BrowserSysPathItem.name">name</a></td>

eric ide

mercurial