Documentation/Source/eric4.UI.BrowserModel.html

changeset 3
0d9daebf5b8c
child 7
c679fb30c8f3
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.UI.BrowserModel</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.UI.BrowserModel</h1>
24 <p>
25 Module implementing the browser model.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <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>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#BrowserClassAttributeItem">BrowserClassAttributeItem</a></td>
35 <td>Class implementing the data structure for browser class attribute items.</td>
36 </tr><tr>
37 <td><a href="#BrowserClassAttributesItem">BrowserClassAttributesItem</a></td>
38 <td>Class implementing the data structure for browser class attributes items.</td>
39 </tr><tr>
40 <td><a href="#BrowserClassItem">BrowserClassItem</a></td>
41 <td>Class implementing the data structure for browser class items.</td>
42 </tr><tr>
43 <td><a href="#BrowserCodingItem">BrowserCodingItem</a></td>
44 <td>Class implementing the data structure for browser coding items.</td>
45 </tr><tr>
46 <td><a href="#BrowserDirectoryItem">BrowserDirectoryItem</a></td>
47 <td>Class implementing the data structure for browser directory items.</td>
48 </tr><tr>
49 <td><a href="#BrowserFileItem">BrowserFileItem</a></td>
50 <td>Class implementing the data structure for browser file items.</td>
51 </tr><tr>
52 <td><a href="#BrowserItem">BrowserItem</a></td>
53 <td>Class implementing the data structure for browser items.</td>
54 </tr><tr>
55 <td><a href="#BrowserMethodItem">BrowserMethodItem</a></td>
56 <td>Class implementing the data structure for browser method items.</td>
57 </tr><tr>
58 <td><a href="#BrowserModel">BrowserModel</a></td>
59 <td>Class implementing the browser model.</td>
60 </tr><tr>
61 <td><a href="#BrowserSysPathItem">BrowserSysPathItem</a></td>
62 <td>Class implementing the data structure for browser sys.path items.</td>
63 </tr>
64 </table>
65 <h3>Functions</h3>
66 <table>
67 <tr><td>None</td></tr>
68 </table>
69 <hr /><hr />
70 <a NAME="BrowserClassAttributeItem" ID="BrowserClassAttributeItem"></a>
71 <h2>BrowserClassAttributeItem</h2>
72 <p>
73 Class implementing the data structure for browser class attribute items.
74 </p>
75 <h3>Derived from</h3>
76 BrowserItem
77 <h3>Class Attributes</h3>
78 <table>
79 <tr><td>None</td></tr>
80 </table>
81 <h3>Methods</h3>
82 <table>
83 <tr>
84 <td><a href="#BrowserClassAttributeItem.__init__">BrowserClassAttributeItem</a></td>
85 <td>Constructor</td>
86 </tr><tr>
87 <td><a href="#BrowserClassAttributeItem.attributeObject">attributeObject</a></td>
88 <td>Public method returning the class object.</td>
89 </tr><tr>
90 <td><a href="#BrowserClassAttributeItem.fileName">fileName</a></td>
91 <td>Public method returning the filename.</td>
92 </tr><tr>
93 <td><a href="#BrowserClassAttributeItem.isPublic">isPublic</a></td>
94 <td>Public method returning the public visibility status.</td>
95 </tr><tr>
96 <td><a href="#BrowserClassAttributeItem.lessThan">lessThan</a></td>
97 <td>Public method to check, if the item is less than the other one.</td>
98 </tr><tr>
99 <td><a href="#BrowserClassAttributeItem.lineno">lineno</a></td>
100 <td>Public method returning the line number defining this object.</td>
101 </tr>
102 </table>
103 <a NAME="BrowserClassAttributeItem.__init__" ID="BrowserClassAttributeItem.__init__"></a>
104 <h4>BrowserClassAttributeItem (Constructor)</h4>
105 <b>BrowserClassAttributeItem</b>(<i>parent, attribute</i>)
106 <p>
107 Constructor
108 </p><dl>
109 <dt><i>parent</i></dt>
110 <dd>
111 parent item
112 </dd><dt><i>attribute</i></dt>
113 <dd>
114 reference to the attribute object
115 </dd>
116 </dl><a NAME="BrowserClassAttributeItem.attributeObject" ID="BrowserClassAttributeItem.attributeObject"></a>
117 <h4>BrowserClassAttributeItem.attributeObject</h4>
118 <b>attributeObject</b>(<i></i>)
119 <p>
120 Public method returning the class object.
121 </p><dl>
122 <dt>Returns:</dt>
123 <dd>
124 reference to the class object
125 </dd>
126 </dl><a NAME="BrowserClassAttributeItem.fileName" ID="BrowserClassAttributeItem.fileName"></a>
127 <h4>BrowserClassAttributeItem.fileName</h4>
128 <b>fileName</b>(<i></i>)
129 <p>
130 Public method returning the filename.
131 </p><dl>
132 <dt>Returns:</dt>
133 <dd>
134 filename (string)
135 </dd>
136 </dl><a NAME="BrowserClassAttributeItem.isPublic" ID="BrowserClassAttributeItem.isPublic"></a>
137 <h4>BrowserClassAttributeItem.isPublic</h4>
138 <b>isPublic</b>(<i></i>)
139 <p>
140 Public method returning the public visibility status.
141 </p><dl>
142 <dt>Returns:</dt>
143 <dd>
144 flag indicating public visibility (boolean)
145 </dd>
146 </dl><a NAME="BrowserClassAttributeItem.lessThan" ID="BrowserClassAttributeItem.lessThan"></a>
147 <h4>BrowserClassAttributeItem.lessThan</h4>
148 <b>lessThan</b>(<i>other, column, order</i>)
149 <p>
150 Public method to check, if the item is less than the other one.
151 </p><dl>
152 <dt><i>other</i></dt>
153 <dd>
154 reference to item to compare against (BrowserItem)
155 </dd><dt><i>column</i></dt>
156 <dd>
157 column number to use for the comparison (integer)
158 </dd><dt><i>order</i></dt>
159 <dd>
160 sort order (Qt.SortOrder) (for special sorting)
161 </dd>
162 </dl><dl>
163 <dt>Returns:</dt>
164 <dd>
165 true, if this item is less than other (boolean)
166 </dd>
167 </dl><a NAME="BrowserClassAttributeItem.lineno" ID="BrowserClassAttributeItem.lineno"></a>
168 <h4>BrowserClassAttributeItem.lineno</h4>
169 <b>lineno</b>(<i></i>)
170 <p>
171 Public method returning the line number defining this object.
172 </p><p>
173 return line number defining the object (integer)
174 </p>
175 <div align="right"><a href="#top">Up</a></div>
176 <hr /><hr />
177 <a NAME="BrowserClassAttributesItem" ID="BrowserClassAttributesItem"></a>
178 <h2>BrowserClassAttributesItem</h2>
179 <p>
180 Class implementing the data structure for browser class attributes items.
181 </p>
182 <h3>Derived from</h3>
183 BrowserItem
184 <h3>Class Attributes</h3>
185 <table>
186 <tr><td>None</td></tr>
187 </table>
188 <h3>Methods</h3>
189 <table>
190 <tr>
191 <td><a href="#BrowserClassAttributesItem.__init__">BrowserClassAttributesItem</a></td>
192 <td>Constructor</td>
193 </tr><tr>
194 <td><a href="#BrowserClassAttributesItem.attributes">attributes</a></td>
195 <td>Public method returning the attribute list.</td>
196 </tr><tr>
197 <td><a href="#BrowserClassAttributesItem.lessThan">lessThan</a></td>
198 <td>Public method to check, if the item is less than the other one.</td>
199 </tr>
200 </table>
201 <a NAME="BrowserClassAttributesItem.__init__" ID="BrowserClassAttributesItem.__init__"></a>
202 <h4>BrowserClassAttributesItem (Constructor)</h4>
203 <b>BrowserClassAttributesItem</b>(<i>parent, attributes, text</i>)
204 <p>
205 Constructor
206 </p><dl>
207 <dt><i>parent</i></dt>
208 <dd>
209 parent item
210 </dd><dt><i>attributes</i></dt>
211 <dd>
212 list of attributes
213 </dd><dt><i>text</i></dt>
214 <dd>
215 text to be shown by this item (string)
216 </dd>
217 </dl><a NAME="BrowserClassAttributesItem.attributes" ID="BrowserClassAttributesItem.attributes"></a>
218 <h4>BrowserClassAttributesItem.attributes</h4>
219 <b>attributes</b>(<i></i>)
220 <p>
221 Public method returning the attribute list.
222 </p><dl>
223 <dt>Returns:</dt>
224 <dd>
225 reference to the list of attributes
226 </dd>
227 </dl><a NAME="BrowserClassAttributesItem.lessThan" ID="BrowserClassAttributesItem.lessThan"></a>
228 <h4>BrowserClassAttributesItem.lessThan</h4>
229 <b>lessThan</b>(<i>other, column, order</i>)
230 <p>
231 Public method to check, if the item is less than the other one.
232 </p><dl>
233 <dt><i>other</i></dt>
234 <dd>
235 reference to item to compare against (BrowserItem)
236 </dd><dt><i>column</i></dt>
237 <dd>
238 column number to use for the comparison (integer)
239 </dd><dt><i>order</i></dt>
240 <dd>
241 sort order (Qt.SortOrder) (for special sorting)
242 </dd>
243 </dl><dl>
244 <dt>Returns:</dt>
245 <dd>
246 true, if this item is less than other (boolean)
247 </dd>
248 </dl>
249 <div align="right"><a href="#top">Up</a></div>
250 <hr /><hr />
251 <a NAME="BrowserClassItem" ID="BrowserClassItem"></a>
252 <h2>BrowserClassItem</h2>
253 <p>
254 Class implementing the data structure for browser class items.
255 </p>
256 <h3>Derived from</h3>
257 BrowserItem
258 <h3>Class Attributes</h3>
259 <table>
260 <tr><td>None</td></tr>
261 </table>
262 <h3>Methods</h3>
263 <table>
264 <tr>
265 <td><a href="#BrowserClassItem.__init__">BrowserClassItem</a></td>
266 <td>Constructor</td>
267 </tr><tr>
268 <td><a href="#BrowserClassItem.classObject">classObject</a></td>
269 <td>Public method returning the class object.</td>
270 </tr><tr>
271 <td><a href="#BrowserClassItem.fileName">fileName</a></td>
272 <td>Public method returning the filename.</td>
273 </tr><tr>
274 <td><a href="#BrowserClassItem.isPublic">isPublic</a></td>
275 <td>Public method returning the public visibility status.</td>
276 </tr><tr>
277 <td><a href="#BrowserClassItem.lessThan">lessThan</a></td>
278 <td>Public method to check, if the item is less than the other one.</td>
279 </tr><tr>
280 <td><a href="#BrowserClassItem.lineno">lineno</a></td>
281 <td>Public method returning the line number defining this object.</td>
282 </tr>
283 </table>
284 <a NAME="BrowserClassItem.__init__" ID="BrowserClassItem.__init__"></a>
285 <h4>BrowserClassItem (Constructor)</h4>
286 <b>BrowserClassItem</b>(<i>parent, cl, filename</i>)
287 <p>
288 Constructor
289 </p><dl>
290 <dt><i>parent</i></dt>
291 <dd>
292 parent item
293 </dd><dt><i>cl</i></dt>
294 <dd>
295 Class object to be shown
296 </dd><dt><i>filename</i></dt>
297 <dd>
298 filename of the file defining this class
299 </dd>
300 </dl><a NAME="BrowserClassItem.classObject" ID="BrowserClassItem.classObject"></a>
301 <h4>BrowserClassItem.classObject</h4>
302 <b>classObject</b>(<i></i>)
303 <p>
304 Public method returning the class object.
305 </p><dl>
306 <dt>Returns:</dt>
307 <dd>
308 reference to the class object
309 </dd>
310 </dl><a NAME="BrowserClassItem.fileName" ID="BrowserClassItem.fileName"></a>
311 <h4>BrowserClassItem.fileName</h4>
312 <b>fileName</b>(<i></i>)
313 <p>
314 Public method returning the filename.
315 </p><dl>
316 <dt>Returns:</dt>
317 <dd>
318 filename (string)
319 </dd>
320 </dl><a NAME="BrowserClassItem.isPublic" ID="BrowserClassItem.isPublic"></a>
321 <h4>BrowserClassItem.isPublic</h4>
322 <b>isPublic</b>(<i></i>)
323 <p>
324 Public method returning the public visibility status.
325 </p><dl>
326 <dt>Returns:</dt>
327 <dd>
328 flag indicating public visibility (boolean)
329 </dd>
330 </dl><a NAME="BrowserClassItem.lessThan" ID="BrowserClassItem.lessThan"></a>
331 <h4>BrowserClassItem.lessThan</h4>
332 <b>lessThan</b>(<i>other, column, order</i>)
333 <p>
334 Public method to check, if the item is less than the other one.
335 </p><dl>
336 <dt><i>other</i></dt>
337 <dd>
338 reference to item to compare against (BrowserItem)
339 </dd><dt><i>column</i></dt>
340 <dd>
341 column number to use for the comparison (integer)
342 </dd><dt><i>order</i></dt>
343 <dd>
344 sort order (Qt.SortOrder) (for special sorting)
345 </dd>
346 </dl><dl>
347 <dt>Returns:</dt>
348 <dd>
349 true, if this item is less than other (boolean)
350 </dd>
351 </dl><a NAME="BrowserClassItem.lineno" ID="BrowserClassItem.lineno"></a>
352 <h4>BrowserClassItem.lineno</h4>
353 <b>lineno</b>(<i></i>)
354 <p>
355 Public method returning the line number defining this object.
356 </p><p>
357 return line number defining the object (integer)
358 </p>
359 <div align="right"><a href="#top">Up</a></div>
360 <hr /><hr />
361 <a NAME="BrowserCodingItem" ID="BrowserCodingItem"></a>
362 <h2>BrowserCodingItem</h2>
363 <p>
364 Class implementing the data structure for browser coding items.
365 </p>
366 <h3>Derived from</h3>
367 BrowserItem
368 <h3>Class Attributes</h3>
369 <table>
370 <tr><td>None</td></tr>
371 </table>
372 <h3>Methods</h3>
373 <table>
374 <tr>
375 <td><a href="#BrowserCodingItem.__init__">BrowserCodingItem</a></td>
376 <td>Constructor</td>
377 </tr><tr>
378 <td><a href="#BrowserCodingItem.lessThan">lessThan</a></td>
379 <td>Public method to check, if the item is less than the other one.</td>
380 </tr>
381 </table>
382 <a NAME="BrowserCodingItem.__init__" ID="BrowserCodingItem.__init__"></a>
383 <h4>BrowserCodingItem (Constructor)</h4>
384 <b>BrowserCodingItem</b>(<i>parent, text</i>)
385 <p>
386 Constructor
387 </p><dl>
388 <dt><i>parent</i></dt>
389 <dd>
390 parent item
391 </dd><dt><i>text</i></dt>
392 <dd>
393 text to be shown by this item (string)
394 </dd>
395 </dl><a NAME="BrowserCodingItem.lessThan" ID="BrowserCodingItem.lessThan"></a>
396 <h4>BrowserCodingItem.lessThan</h4>
397 <b>lessThan</b>(<i>other, column, order</i>)
398 <p>
399 Public method to check, if the item is less than the other one.
400 </p><dl>
401 <dt><i>other</i></dt>
402 <dd>
403 reference to item to compare against (BrowserItem)
404 </dd><dt><i>column</i></dt>
405 <dd>
406 column number to use for the comparison (integer)
407 </dd><dt><i>order</i></dt>
408 <dd>
409 sort order (Qt.SortOrder) (for special sorting)
410 </dd>
411 </dl><dl>
412 <dt>Returns:</dt>
413 <dd>
414 true, if this item is less than other (boolean)
415 </dd>
416 </dl>
417 <div align="right"><a href="#top">Up</a></div>
418 <hr /><hr />
419 <a NAME="BrowserDirectoryItem" ID="BrowserDirectoryItem"></a>
420 <h2>BrowserDirectoryItem</h2>
421 <p>
422 Class implementing the data structure for browser directory items.
423 </p>
424 <h3>Derived from</h3>
425 BrowserItem
426 <h3>Class Attributes</h3>
427 <table>
428 <tr><td>None</td></tr>
429 </table>
430 <h3>Methods</h3>
431 <table>
432 <tr>
433 <td><a href="#BrowserDirectoryItem.__init__">BrowserDirectoryItem</a></td>
434 <td>Constructor</td>
435 </tr><tr>
436 <td><a href="#BrowserDirectoryItem.dirName">dirName</a></td>
437 <td>Public method returning the directory name.</td>
438 </tr><tr>
439 <td><a href="#BrowserDirectoryItem.lessThan">lessThan</a></td>
440 <td>Public method to check, if the item is less than the other one.</td>
441 </tr><tr>
442 <td><a href="#BrowserDirectoryItem.setName">setName</a></td>
443 <td>Public method to set the directory name.</td>
444 </tr>
445 </table>
446 <a NAME="BrowserDirectoryItem.__init__" ID="BrowserDirectoryItem.__init__"></a>
447 <h4>BrowserDirectoryItem (Constructor)</h4>
448 <b>BrowserDirectoryItem</b>(<i>parent, dinfo, full = True</i>)
449 <p>
450 Constructor
451 </p><dl>
452 <dt><i>parent</i></dt>
453 <dd>
454 parent item
455 </dd><dt><i>dinfo</i></dt>
456 <dd>
457 dinfo is the string for the directory (string)
458 </dd><dt><i>full</i></dt>
459 <dd>
460 flag indicating full pathname should be displayed (boolean)
461 </dd>
462 </dl><a NAME="BrowserDirectoryItem.dirName" ID="BrowserDirectoryItem.dirName"></a>
463 <h4>BrowserDirectoryItem.dirName</h4>
464 <b>dirName</b>(<i></i>)
465 <p>
466 Public method returning the directory name.
467 </p><dl>
468 <dt>Returns:</dt>
469 <dd>
470 directory name (string)
471 </dd>
472 </dl><a NAME="BrowserDirectoryItem.lessThan" ID="BrowserDirectoryItem.lessThan"></a>
473 <h4>BrowserDirectoryItem.lessThan</h4>
474 <b>lessThan</b>(<i>other, column, order</i>)
475 <p>
476 Public method to check, if the item is less than the other one.
477 </p><dl>
478 <dt><i>other</i></dt>
479 <dd>
480 reference to item to compare against (BrowserItem)
481 </dd><dt><i>column</i></dt>
482 <dd>
483 column number to use for the comparison (integer)
484 </dd><dt><i>order</i></dt>
485 <dd>
486 sort order (Qt.SortOrder) (for special sorting)
487 </dd>
488 </dl><dl>
489 <dt>Returns:</dt>
490 <dd>
491 true, if this item is less than other (boolean)
492 </dd>
493 </dl><a NAME="BrowserDirectoryItem.setName" ID="BrowserDirectoryItem.setName"></a>
494 <h4>BrowserDirectoryItem.setName</h4>
495 <b>setName</b>(<i>dinfo, full = True</i>)
496 <p>
497 Public method to set the directory name.
498 </p><dl>
499 <dt><i>dinfo</i></dt>
500 <dd>
501 dinfo is the string for the directory (string)
502 </dd><dt><i>full</i></dt>
503 <dd>
504 flag indicating full pathname should be displayed (boolean)
505 </dd>
506 </dl>
507 <div align="right"><a href="#top">Up</a></div>
508 <hr /><hr />
509 <a NAME="BrowserFileItem" ID="BrowserFileItem"></a>
510 <h2>BrowserFileItem</h2>
511 <p>
512 Class implementing the data structure for browser file items.
513 </p>
514 <h3>Derived from</h3>
515 BrowserItem
516 <h3>Class Attributes</h3>
517 <table>
518 <tr><td>None</td></tr>
519 </table>
520 <h3>Methods</h3>
521 <table>
522 <tr>
523 <td><a href="#BrowserFileItem.__init__">BrowserFileItem</a></td>
524 <td>Constructor</td>
525 </tr><tr>
526 <td><a href="#BrowserFileItem.dirName">dirName</a></td>
527 <td>Public method returning the directory name.</td>
528 </tr><tr>
529 <td><a href="#BrowserFileItem.fileExt">fileExt</a></td>
530 <td>Public method returning the file extension.</td>
531 </tr><tr>
532 <td><a href="#BrowserFileItem.fileName">fileName</a></td>
533 <td>Public method returning the filename.</td>
534 </tr><tr>
535 <td><a href="#BrowserFileItem.isDFile">isDFile</a></td>
536 <td>Public method to check, if this file is a D file.</td>
537 </tr><tr>
538 <td><a href="#BrowserFileItem.isDesignerFile">isDesignerFile</a></td>
539 <td>Public method to check, if this file is a Qt-Designer file.</td>
540 </tr><tr>
541 <td><a href="#BrowserFileItem.isIdlFile">isIdlFile</a></td>
542 <td>Public method to check, if this file is a CORBA IDL file.</td>
543 </tr><tr>
544 <td><a href="#BrowserFileItem.isLinguistFile">isLinguistFile</a></td>
545 <td>Public method to check, if this file is a Qt-Linguist file.</td>
546 </tr><tr>
547 <td><a href="#BrowserFileItem.isMultiProjectFile">isMultiProjectFile</a></td>
548 <td>Public method to check, if this file is an eric4 multi project file.</td>
549 </tr><tr>
550 <td><a href="#BrowserFileItem.isPixmapFile">isPixmapFile</a></td>
551 <td>Public method to check, if this file is a pixmap file.</td>
552 </tr><tr>
553 <td><a href="#BrowserFileItem.isProjectFile">isProjectFile</a></td>
554 <td>Public method to check, if this file is an eric4 project file.</td>
555 </tr><tr>
556 <td><a href="#BrowserFileItem.isPython3File">isPython3File</a></td>
557 <td>Public method to check, if this file is a Python3 script.</td>
558 </tr><tr>
559 <td><a href="#BrowserFileItem.isPythonFile">isPythonFile</a></td>
560 <td>Public method to check, if this file is a Python script.</td>
561 </tr><tr>
562 <td><a href="#BrowserFileItem.isResourcesFile">isResourcesFile</a></td>
563 <td>Public method to check, if this file is a Qt-Resources file.</td>
564 </tr><tr>
565 <td><a href="#BrowserFileItem.isRubyFile">isRubyFile</a></td>
566 <td>Public method to check, if this file is a Ruby script.</td>
567 </tr><tr>
568 <td><a href="#BrowserFileItem.isSvgFile">isSvgFile</a></td>
569 <td>Public method to check, if this file is a SVG file.</td>
570 </tr><tr>
571 <td><a href="#BrowserFileItem.lessThan">lessThan</a></td>
572 <td>Public method to check, if the item is less than the other one.</td>
573 </tr><tr>
574 <td><a href="#BrowserFileItem.moduleName">moduleName</a></td>
575 <td>Public method returning the module name.</td>
576 </tr><tr>
577 <td><a href="#BrowserFileItem.setName">setName</a></td>
578 <td>Public method to set the directory name.</td>
579 </tr>
580 </table>
581 <a NAME="BrowserFileItem.__init__" ID="BrowserFileItem.__init__"></a>
582 <h4>BrowserFileItem (Constructor)</h4>
583 <b>BrowserFileItem</b>(<i>parent, finfo, full = True, sourceLanguage = ""</i>)
584 <p>
585 Constructor
586 </p><dl>
587 <dt><i>parent</i></dt>
588 <dd>
589 parent item
590 </dd><dt><i>finfo</i></dt>
591 <dd>
592 the string for the file (string)
593 </dd><dt><i>full</i></dt>
594 <dd>
595 flag indicating full pathname should be displayed (boolean)
596 </dd><dt><i>sourceLanguage</i></dt>
597 <dd>
598 source code language of the project (string)
599 </dd>
600 </dl><a NAME="BrowserFileItem.dirName" ID="BrowserFileItem.dirName"></a>
601 <h4>BrowserFileItem.dirName</h4>
602 <b>dirName</b>(<i></i>)
603 <p>
604 Public method returning the directory name.
605 </p><dl>
606 <dt>Returns:</dt>
607 <dd>
608 directory name (string)
609 </dd>
610 </dl><a NAME="BrowserFileItem.fileExt" ID="BrowserFileItem.fileExt"></a>
611 <h4>BrowserFileItem.fileExt</h4>
612 <b>fileExt</b>(<i></i>)
613 <p>
614 Public method returning the file extension.
615 </p><dl>
616 <dt>Returns:</dt>
617 <dd>
618 file extension (string)
619 </dd>
620 </dl><a NAME="BrowserFileItem.fileName" ID="BrowserFileItem.fileName"></a>
621 <h4>BrowserFileItem.fileName</h4>
622 <b>fileName</b>(<i></i>)
623 <p>
624 Public method returning the filename.
625 </p><dl>
626 <dt>Returns:</dt>
627 <dd>
628 filename (string)
629 </dd>
630 </dl><a NAME="BrowserFileItem.isDFile" ID="BrowserFileItem.isDFile"></a>
631 <h4>BrowserFileItem.isDFile</h4>
632 <b>isDFile</b>(<i></i>)
633 <p>
634 Public method to check, if this file is a D file.
635 </p><dl>
636 <dt>Returns:</dt>
637 <dd>
638 flag indicating a D file (boolean)
639 </dd>
640 </dl><a NAME="BrowserFileItem.isDesignerFile" ID="BrowserFileItem.isDesignerFile"></a>
641 <h4>BrowserFileItem.isDesignerFile</h4>
642 <b>isDesignerFile</b>(<i></i>)
643 <p>
644 Public method to check, if this file is a Qt-Designer file.
645 </p><dl>
646 <dt>Returns:</dt>
647 <dd>
648 flag indicating a Qt-Designer file (boolean)
649 </dd>
650 </dl><a NAME="BrowserFileItem.isIdlFile" ID="BrowserFileItem.isIdlFile"></a>
651 <h4>BrowserFileItem.isIdlFile</h4>
652 <b>isIdlFile</b>(<i></i>)
653 <p>
654 Public method to check, if this file is a CORBA IDL file.
655 </p><dl>
656 <dt>Returns:</dt>
657 <dd>
658 flag indicating a CORBA IDL file (boolean)
659 </dd>
660 </dl><a NAME="BrowserFileItem.isLinguistFile" ID="BrowserFileItem.isLinguistFile"></a>
661 <h4>BrowserFileItem.isLinguistFile</h4>
662 <b>isLinguistFile</b>(<i></i>)
663 <p>
664 Public method to check, if this file is a Qt-Linguist file.
665 </p><dl>
666 <dt>Returns:</dt>
667 <dd>
668 flag indicating a Qt-Linguist file (boolean)
669 </dd>
670 </dl><a NAME="BrowserFileItem.isMultiProjectFile" ID="BrowserFileItem.isMultiProjectFile"></a>
671 <h4>BrowserFileItem.isMultiProjectFile</h4>
672 <b>isMultiProjectFile</b>(<i></i>)
673 <p>
674 Public method to check, if this file is an eric4 multi project file.
675 </p><dl>
676 <dt>Returns:</dt>
677 <dd>
678 flag indicating an eric4 project file (boolean)
679 </dd>
680 </dl><a NAME="BrowserFileItem.isPixmapFile" ID="BrowserFileItem.isPixmapFile"></a>
681 <h4>BrowserFileItem.isPixmapFile</h4>
682 <b>isPixmapFile</b>(<i></i>)
683 <p>
684 Public method to check, if this file is a pixmap file.
685 </p><dl>
686 <dt>Returns:</dt>
687 <dd>
688 flag indicating a pixmap file (boolean)
689 </dd>
690 </dl><a NAME="BrowserFileItem.isProjectFile" ID="BrowserFileItem.isProjectFile"></a>
691 <h4>BrowserFileItem.isProjectFile</h4>
692 <b>isProjectFile</b>(<i></i>)
693 <p>
694 Public method to check, if this file is an eric4 project file.
695 </p><dl>
696 <dt>Returns:</dt>
697 <dd>
698 flag indicating an eric4 project file (boolean)
699 </dd>
700 </dl><a NAME="BrowserFileItem.isPython3File" ID="BrowserFileItem.isPython3File"></a>
701 <h4>BrowserFileItem.isPython3File</h4>
702 <b>isPython3File</b>(<i></i>)
703 <p>
704 Public method to check, if this file is a Python3 script.
705 </p><dl>
706 <dt>Returns:</dt>
707 <dd>
708 flag indicating a Python file (boolean)
709 </dd>
710 </dl><a NAME="BrowserFileItem.isPythonFile" ID="BrowserFileItem.isPythonFile"></a>
711 <h4>BrowserFileItem.isPythonFile</h4>
712 <b>isPythonFile</b>(<i></i>)
713 <p>
714 Public method to check, if this file is a Python script.
715 </p><dl>
716 <dt>Returns:</dt>
717 <dd>
718 flag indicating a Python file (boolean)
719 </dd>
720 </dl><a NAME="BrowserFileItem.isResourcesFile" ID="BrowserFileItem.isResourcesFile"></a>
721 <h4>BrowserFileItem.isResourcesFile</h4>
722 <b>isResourcesFile</b>(<i></i>)
723 <p>
724 Public method to check, if this file is a Qt-Resources file.
725 </p><dl>
726 <dt>Returns:</dt>
727 <dd>
728 flag indicating a Qt-Resources file (boolean)
729 </dd>
730 </dl><a NAME="BrowserFileItem.isRubyFile" ID="BrowserFileItem.isRubyFile"></a>
731 <h4>BrowserFileItem.isRubyFile</h4>
732 <b>isRubyFile</b>(<i></i>)
733 <p>
734 Public method to check, if this file is a Ruby script.
735 </p><dl>
736 <dt>Returns:</dt>
737 <dd>
738 flag indicating a Ruby file (boolean)
739 </dd>
740 </dl><a NAME="BrowserFileItem.isSvgFile" ID="BrowserFileItem.isSvgFile"></a>
741 <h4>BrowserFileItem.isSvgFile</h4>
742 <b>isSvgFile</b>(<i></i>)
743 <p>
744 Public method to check, if this file is a SVG file.
745 </p><dl>
746 <dt>Returns:</dt>
747 <dd>
748 flag indicating a SVG file (boolean)
749 </dd>
750 </dl><a NAME="BrowserFileItem.lessThan" ID="BrowserFileItem.lessThan"></a>
751 <h4>BrowserFileItem.lessThan</h4>
752 <b>lessThan</b>(<i>other, column, order</i>)
753 <p>
754 Public method to check, if the item is less than the other one.
755 </p><dl>
756 <dt><i>other</i></dt>
757 <dd>
758 reference to item to compare against (BrowserItem)
759 </dd><dt><i>column</i></dt>
760 <dd>
761 column number to use for the comparison (integer)
762 </dd><dt><i>order</i></dt>
763 <dd>
764 sort order (Qt.SortOrder) (for special sorting)
765 </dd>
766 </dl><dl>
767 <dt>Returns:</dt>
768 <dd>
769 true, if this item is less than other (boolean)
770 </dd>
771 </dl><a NAME="BrowserFileItem.moduleName" ID="BrowserFileItem.moduleName"></a>
772 <h4>BrowserFileItem.moduleName</h4>
773 <b>moduleName</b>(<i></i>)
774 <p>
775 Public method returning the module name.
776 </p><dl>
777 <dt>Returns:</dt>
778 <dd>
779 module name (string)
780 </dd>
781 </dl><a NAME="BrowserFileItem.setName" ID="BrowserFileItem.setName"></a>
782 <h4>BrowserFileItem.setName</h4>
783 <b>setName</b>(<i>finfo, full = True</i>)
784 <p>
785 Public method to set the directory name.
786 </p><dl>
787 <dt><i>finfo</i></dt>
788 <dd>
789 the string for the file (string)
790 </dd><dt><i>full</i></dt>
791 <dd>
792 flag indicating full pathname should be displayed (boolean)
793 </dd>
794 </dl>
795 <div align="right"><a href="#top">Up</a></div>
796 <hr /><hr />
797 <a NAME="BrowserItem" ID="BrowserItem"></a>
798 <h2>BrowserItem</h2>
799 <p>
800 Class implementing the data structure for browser items.
801 </p>
802 <h3>Derived from</h3>
803 object
804 <h3>Class Attributes</h3>
805 <table>
806 <tr><td>None</td></tr>
807 </table>
808 <h3>Methods</h3>
809 <table>
810 <tr>
811 <td><a href="#BrowserItem.__init__">BrowserItem</a></td>
812 <td>Constructor.</td>
813 </tr><tr>
814 <td><a href="#BrowserItem.appendChild">appendChild</a></td>
815 <td>Public method to add a child to this item.</td>
816 </tr><tr>
817 <td><a href="#BrowserItem.child">child</a></td>
818 <td>Public method to get a child id.</td>
819 </tr><tr>
820 <td><a href="#BrowserItem.childCount">childCount</a></td>
821 <td>Public method to get the number of available child items.</td>
822 </tr><tr>
823 <td><a href="#BrowserItem.children">children</a></td>
824 <td>Public method to get the ids of all child items.</td>
825 </tr><tr>
826 <td><a href="#BrowserItem.columnCount">columnCount</a></td>
827 <td>Public method to get the number of available data items.</td>
828 </tr><tr>
829 <td><a href="#BrowserItem.data">data</a></td>
830 <td>Public method to get a specific data item.</td>
831 </tr><tr>
832 <td><a href="#BrowserItem.getIcon">getIcon</a></td>
833 <td>Public method to get the items icon.</td>
834 </tr><tr>
835 <td><a href="#BrowserItem.isLazyPopulated">isLazyPopulated</a></td>
836 <td>Public method to check, if this item should be populated lazyly.</td>
837 </tr><tr>
838 <td><a href="#BrowserItem.isPopulated">isPopulated</a></td>
839 <td>Public method to chek, if this item is populated.</td>
840 </tr><tr>
841 <td><a href="#BrowserItem.isPublic">isPublic</a></td>
842 <td>Public method returning the public visibility status.</td>
843 </tr><tr>
844 <td><a href="#BrowserItem.lessThan">lessThan</a></td>
845 <td>Public method to check, if the item is less than the other one.</td>
846 </tr><tr>
847 <td><a href="#BrowserItem.parent">parent</a></td>
848 <td>Public method to get the reference to the parent item.</td>
849 </tr><tr>
850 <td><a href="#BrowserItem.removeChild">removeChild</a></td>
851 <td>Public method to remove a child.</td>
852 </tr><tr>
853 <td><a href="#BrowserItem.removeChildren">removeChildren</a></td>
854 <td>Public method to remove all children.</td>
855 </tr><tr>
856 <td><a href="#BrowserItem.row">row</a></td>
857 <td>Public method to get the row number of this item.</td>
858 </tr><tr>
859 <td><a href="#BrowserItem.type">type</a></td>
860 <td>Public method to get the item type.</td>
861 </tr>
862 </table>
863 <a NAME="BrowserItem.__init__" ID="BrowserItem.__init__"></a>
864 <h4>BrowserItem (Constructor)</h4>
865 <b>BrowserItem</b>(<i>parent, data</i>)
866 <p>
867 Constructor.
868 </p><dl>
869 <dt><i>parent</i></dt>
870 <dd>
871 reference to the parent item
872 </dd><dt><i>data</i></dt>
873 <dd>
874 single data of the item
875 </dd>
876 </dl><a NAME="BrowserItem.appendChild" ID="BrowserItem.appendChild"></a>
877 <h4>BrowserItem.appendChild</h4>
878 <b>appendChild</b>(<i>child</i>)
879 <p>
880 Public method to add a child to this item.
881 </p><dl>
882 <dt><i>child</i></dt>
883 <dd>
884 reference to the child item to add (BrowserItem)
885 </dd>
886 </dl><a NAME="BrowserItem.child" ID="BrowserItem.child"></a>
887 <h4>BrowserItem.child</h4>
888 <b>child</b>(<i>row</i>)
889 <p>
890 Public method to get a child id.
891 </p><dl>
892 <dt><i>row</i></dt>
893 <dd>
894 number of child to get the id of (integer)
895 </dd><dt><i>return</i></dt>
896 <dd>
897 reference to the child item (BrowserItem)
898 </dd>
899 </dl><a NAME="BrowserItem.childCount" ID="BrowserItem.childCount"></a>
900 <h4>BrowserItem.childCount</h4>
901 <b>childCount</b>(<i></i>)
902 <p>
903 Public method to get the number of available child items.
904 </p><dl>
905 <dt>Returns:</dt>
906 <dd>
907 number of child items (integer)
908 </dd>
909 </dl><a NAME="BrowserItem.children" ID="BrowserItem.children"></a>
910 <h4>BrowserItem.children</h4>
911 <b>children</b>(<i></i>)
912 <p>
913 Public method to get the ids of all child items.
914 </p><dl>
915 <dt>Returns:</dt>
916 <dd>
917 references to all child items (list of BrowserItem)
918 </dd>
919 </dl><a NAME="BrowserItem.columnCount" ID="BrowserItem.columnCount"></a>
920 <h4>BrowserItem.columnCount</h4>
921 <b>columnCount</b>(<i></i>)
922 <p>
923 Public method to get the number of available data items.
924 </p><dl>
925 <dt>Returns:</dt>
926 <dd>
927 number of data items (integer)
928 </dd>
929 </dl><a NAME="BrowserItem.data" ID="BrowserItem.data"></a>
930 <h4>BrowserItem.data</h4>
931 <b>data</b>(<i>column</i>)
932 <p>
933 Public method to get a specific data item.
934 </p><dl>
935 <dt><i>column</i></dt>
936 <dd>
937 number of the requested data item (integer)
938 </dd><dt><i>return</i></dt>
939 <dd>
940 the stored data item
941 </dd>
942 </dl><a NAME="BrowserItem.getIcon" ID="BrowserItem.getIcon"></a>
943 <h4>BrowserItem.getIcon</h4>
944 <b>getIcon</b>(<i></i>)
945 <p>
946 Public method to get the items icon.
947 </p><dl>
948 <dt>Returns:</dt>
949 <dd>
950 the icon (QIcon)
951 </dd>
952 </dl><a NAME="BrowserItem.isLazyPopulated" ID="BrowserItem.isLazyPopulated"></a>
953 <h4>BrowserItem.isLazyPopulated</h4>
954 <b>isLazyPopulated</b>(<i></i>)
955 <p>
956 Public method to check, if this item should be populated lazyly.
957 </p><dl>
958 <dt>Returns:</dt>
959 <dd>
960 lazy population flag (boolean)
961 </dd>
962 </dl><a NAME="BrowserItem.isPopulated" ID="BrowserItem.isPopulated"></a>
963 <h4>BrowserItem.isPopulated</h4>
964 <b>isPopulated</b>(<i></i>)
965 <p>
966 Public method to chek, if this item is populated.
967 </p><dl>
968 <dt>Returns:</dt>
969 <dd>
970 population status (boolean)
971 </dd>
972 </dl><a NAME="BrowserItem.isPublic" ID="BrowserItem.isPublic"></a>
973 <h4>BrowserItem.isPublic</h4>
974 <b>isPublic</b>(<i></i>)
975 <p>
976 Public method returning the public visibility status.
977 </p><dl>
978 <dt>Returns:</dt>
979 <dd>
980 flag indicating public visibility (boolean)
981 </dd>
982 </dl><a NAME="BrowserItem.lessThan" ID="BrowserItem.lessThan"></a>
983 <h4>BrowserItem.lessThan</h4>
984 <b>lessThan</b>(<i>other, column, order</i>)
985 <p>
986 Public method to check, if the item is less than the other one.
987 </p><dl>
988 <dt><i>other</i></dt>
989 <dd>
990 reference to item to compare against (BrowserItem)
991 </dd><dt><i>column</i></dt>
992 <dd>
993 column number to use for the comparison (integer)
994 </dd><dt><i>order</i></dt>
995 <dd>
996 sort order (Qt.SortOrder) (for special sorting)
997 </dd>
998 </dl><dl>
999 <dt>Returns:</dt>
1000 <dd>
1001 true, if this item is less than other (boolean)
1002 </dd>
1003 </dl><a NAME="BrowserItem.parent" ID="BrowserItem.parent"></a>
1004 <h4>BrowserItem.parent</h4>
1005 <b>parent</b>(<i></i>)
1006 <p>
1007 Public method to get the reference to the parent item.
1008 </p><dl>
1009 <dt>Returns:</dt>
1010 <dd>
1011 reference to the parent item
1012 </dd>
1013 </dl><a NAME="BrowserItem.removeChild" ID="BrowserItem.removeChild"></a>
1014 <h4>BrowserItem.removeChild</h4>
1015 <b>removeChild</b>(<i>child</i>)
1016 <p>
1017 Public method to remove a child.
1018 </p><dl>
1019 <dt><i>child</i></dt>
1020 <dd>
1021 reference to the child to remove (BrowserItem)
1022 </dd>
1023 </dl><a NAME="BrowserItem.removeChildren" ID="BrowserItem.removeChildren"></a>
1024 <h4>BrowserItem.removeChildren</h4>
1025 <b>removeChildren</b>(<i></i>)
1026 <p>
1027 Public method to remove all children.
1028 </p><a NAME="BrowserItem.row" ID="BrowserItem.row"></a>
1029 <h4>BrowserItem.row</h4>
1030 <b>row</b>(<i></i>)
1031 <p>
1032 Public method to get the row number of this item.
1033 </p><dl>
1034 <dt>Returns:</dt>
1035 <dd>
1036 row number (integer)
1037 </dd>
1038 </dl><a NAME="BrowserItem.type" ID="BrowserItem.type"></a>
1039 <h4>BrowserItem.type</h4>
1040 <b>type</b>(<i></i>)
1041 <p>
1042 Public method to get the item type.
1043 </p><dl>
1044 <dt>Returns:</dt>
1045 <dd>
1046 type of the item
1047 </dd>
1048 </dl>
1049 <div align="right"><a href="#top">Up</a></div>
1050 <hr /><hr />
1051 <a NAME="BrowserMethodItem" ID="BrowserMethodItem"></a>
1052 <h2>BrowserMethodItem</h2>
1053 <p>
1054 Class implementing the data structure for browser method items.
1055 </p>
1056 <h3>Derived from</h3>
1057 BrowserItem
1058 <h3>Class Attributes</h3>
1059 <table>
1060 <tr><td>None</td></tr>
1061 </table>
1062 <h3>Methods</h3>
1063 <table>
1064 <tr>
1065 <td><a href="#BrowserMethodItem.__init__">BrowserMethodItem</a></td>
1066 <td>Constructor</td>
1067 </tr><tr>
1068 <td><a href="#BrowserMethodItem.fileName">fileName</a></td>
1069 <td>Public method returning the filename.</td>
1070 </tr><tr>
1071 <td><a href="#BrowserMethodItem.functionObject">functionObject</a></td>
1072 <td>Public method returning the function object.</td>
1073 </tr><tr>
1074 <td><a href="#BrowserMethodItem.isPublic">isPublic</a></td>
1075 <td>Public method returning the public visibility status.</td>
1076 </tr><tr>
1077 <td><a href="#BrowserMethodItem.lessThan">lessThan</a></td>
1078 <td>Public method to check, if the item is less than the other one.</td>
1079 </tr><tr>
1080 <td><a href="#BrowserMethodItem.lineno">lineno</a></td>
1081 <td>Public method returning the line number defining this object.</td>
1082 </tr>
1083 </table>
1084 <a NAME="BrowserMethodItem.__init__" ID="BrowserMethodItem.__init__"></a>
1085 <h4>BrowserMethodItem (Constructor)</h4>
1086 <b>BrowserMethodItem</b>(<i>parent, fn, filename</i>)
1087 <p>
1088 Constructor
1089 </p><dl>
1090 <dt><i>parent</i></dt>
1091 <dd>
1092 parent item
1093 </dd><dt><i>fn</i></dt>
1094 <dd>
1095 Function object to be shown
1096 </dd><dt><i>filename</i></dt>
1097 <dd>
1098 filename of the file defining this class (string)
1099 </dd>
1100 </dl><a NAME="BrowserMethodItem.fileName" ID="BrowserMethodItem.fileName"></a>
1101 <h4>BrowserMethodItem.fileName</h4>
1102 <b>fileName</b>(<i></i>)
1103 <p>
1104 Public method returning the filename.
1105 </p><dl>
1106 <dt>Returns:</dt>
1107 <dd>
1108 filename (string)
1109 </dd>
1110 </dl><a NAME="BrowserMethodItem.functionObject" ID="BrowserMethodItem.functionObject"></a>
1111 <h4>BrowserMethodItem.functionObject</h4>
1112 <b>functionObject</b>(<i></i>)
1113 <p>
1114 Public method returning the function object.
1115 </p><dl>
1116 <dt>Returns:</dt>
1117 <dd>
1118 reference to the function object
1119 </dd>
1120 </dl><a NAME="BrowserMethodItem.isPublic" ID="BrowserMethodItem.isPublic"></a>
1121 <h4>BrowserMethodItem.isPublic</h4>
1122 <b>isPublic</b>(<i></i>)
1123 <p>
1124 Public method returning the public visibility status.
1125 </p><dl>
1126 <dt>Returns:</dt>
1127 <dd>
1128 flag indicating public visibility (boolean)
1129 </dd>
1130 </dl><a NAME="BrowserMethodItem.lessThan" ID="BrowserMethodItem.lessThan"></a>
1131 <h4>BrowserMethodItem.lessThan</h4>
1132 <b>lessThan</b>(<i>other, column, order</i>)
1133 <p>
1134 Public method to check, if the item is less than the other one.
1135 </p><dl>
1136 <dt><i>other</i></dt>
1137 <dd>
1138 reference to item to compare against (BrowserItem)
1139 </dd><dt><i>column</i></dt>
1140 <dd>
1141 column number to use for the comparison (integer)
1142 </dd><dt><i>order</i></dt>
1143 <dd>
1144 sort order (Qt.SortOrder) (for special sorting)
1145 </dd>
1146 </dl><dl>
1147 <dt>Returns:</dt>
1148 <dd>
1149 true, if this item is less than other (boolean)
1150 </dd>
1151 </dl><a NAME="BrowserMethodItem.lineno" ID="BrowserMethodItem.lineno"></a>
1152 <h4>BrowserMethodItem.lineno</h4>
1153 <b>lineno</b>(<i></i>)
1154 <p>
1155 Public method returning the line number defining this object.
1156 </p><p>
1157 return line number defining the object (integer)
1158 </p>
1159 <div align="right"><a href="#top">Up</a></div>
1160 <hr /><hr />
1161 <a NAME="BrowserModel" ID="BrowserModel"></a>
1162 <h2>BrowserModel</h2>
1163 <p>
1164 Class implementing the browser model.
1165 </p>
1166 <h3>Derived from</h3>
1167 QAbstractItemModel
1168 <h3>Class Attributes</h3>
1169 <table>
1170 <tr><td>None</td></tr>
1171 </table>
1172 <h3>Methods</h3>
1173 <table>
1174 <tr>
1175 <td><a href="#BrowserModel.__init__">BrowserModel</a></td>
1176 <td>Constructor</td>
1177 </tr><tr>
1178 <td><a href="#BrowserModel.__populateModel">__populateModel</a></td>
1179 <td>Private method to populate the browser model.</td>
1180 </tr><tr>
1181 <td><a href="#BrowserModel._addItem">_addItem</a></td>
1182 <td>Protected slot to add an item.</td>
1183 </tr><tr>
1184 <td><a href="#BrowserModel.addItem">addItem</a></td>
1185 <td>Puplic slot to add an item.</td>
1186 </tr><tr>
1187 <td><a href="#BrowserModel.addTopLevelDir">addTopLevelDir</a></td>
1188 <td>Public method to add a new toplevel directory.</td>
1189 </tr><tr>
1190 <td><a href="#BrowserModel.clear">clear</a></td>
1191 <td>Public method to clear the model.</td>
1192 </tr><tr>
1193 <td><a href="#BrowserModel.columnCount">columnCount</a></td>
1194 <td>Public method to get the number of columns.</td>
1195 </tr><tr>
1196 <td><a href="#BrowserModel.data">data</a></td>
1197 <td>Public method to get data of an item.</td>
1198 </tr><tr>
1199 <td><a href="#BrowserModel.flags">flags</a></td>
1200 <td>Public method to get the item flags.</td>
1201 </tr><tr>
1202 <td><a href="#BrowserModel.hasChildren">hasChildren</a></td>
1203 <td>Public method to check for the presence of child items.</td>
1204 </tr><tr>
1205 <td><a href="#BrowserModel.headerData">headerData</a></td>
1206 <td>Public method to get the header data.</td>
1207 </tr><tr>
1208 <td><a href="#BrowserModel.index">index</a></td>
1209 <td>Public method to create an index.</td>
1210 </tr><tr>
1211 <td><a href="#BrowserModel.item">item</a></td>
1212 <td>Public method to get a reference to an item.</td>
1213 </tr><tr>
1214 <td><a href="#BrowserModel.parent">parent</a></td>
1215 <td>Public method to get the index of the parent object.</td>
1216 </tr><tr>
1217 <td><a href="#BrowserModel.populateClassAttributesItem">populateClassAttributesItem</a></td>
1218 <td>Public method to populate a class attributes item's subtree.</td>
1219 </tr><tr>
1220 <td><a href="#BrowserModel.populateClassItem">populateClassItem</a></td>
1221 <td>Public method to populate a class item's subtree.</td>
1222 </tr><tr>
1223 <td><a href="#BrowserModel.populateDirectoryItem">populateDirectoryItem</a></td>
1224 <td>Public method to populate a directory item's subtree.</td>
1225 </tr><tr>
1226 <td><a href="#BrowserModel.populateFileItem">populateFileItem</a></td>
1227 <td>Public method to populate a file item's subtree.</td>
1228 </tr><tr>
1229 <td><a href="#BrowserModel.populateItem">populateItem</a></td>
1230 <td>Public method to populate an item's subtree.</td>
1231 </tr><tr>
1232 <td><a href="#BrowserModel.populateMethodItem">populateMethodItem</a></td>
1233 <td>Public method to populate a method item's subtree.</td>
1234 </tr><tr>
1235 <td><a href="#BrowserModel.populateSysPathItem">populateSysPathItem</a></td>
1236 <td>Public method to populate a sys.path item's subtree.</td>
1237 </tr><tr>
1238 <td><a href="#BrowserModel.programChange">programChange</a></td>
1239 <td>Public method to change the entry for the directory of file being debugged.</td>
1240 </tr><tr>
1241 <td><a href="#BrowserModel.removeToplevelDir">removeToplevelDir</a></td>
1242 <td>Public method to remove a toplevel directory.</td>
1243 </tr><tr>
1244 <td><a href="#BrowserModel.rowCount">rowCount</a></td>
1245 <td>Public method to get the number of rows.</td>
1246 </tr><tr>
1247 <td><a href="#BrowserModel.saveToplevelDirs">saveToplevelDirs</a></td>
1248 <td>Public slot to save the toplevel directories.</td>
1249 </tr>
1250 </table>
1251 <a NAME="BrowserModel.__init__" ID="BrowserModel.__init__"></a>
1252 <h4>BrowserModel (Constructor)</h4>
1253 <b>BrowserModel</b>(<i>parent = None</i>)
1254 <p>
1255 Constructor
1256 </p><dl>
1257 <dt><i>parent</i></dt>
1258 <dd>
1259 reference to parent object (QObject)
1260 </dd>
1261 </dl><a NAME="BrowserModel.__populateModel" ID="BrowserModel.__populateModel"></a>
1262 <h4>BrowserModel.__populateModel</h4>
1263 <b>__populateModel</b>(<i></i>)
1264 <p>
1265 Private method to populate the browser model.
1266 </p><a NAME="BrowserModel._addItem" ID="BrowserModel._addItem"></a>
1267 <h4>BrowserModel._addItem</h4>
1268 <b>_addItem</b>(<i>itm, parentItem</i>)
1269 <p>
1270 Protected slot to add an item.
1271 </p><dl>
1272 <dt><i>itm</i></dt>
1273 <dd>
1274 reference to item to add (BrowserItem)
1275 </dd><dt><i>parentItem</i></dt>
1276 <dd>
1277 reference to item to add to (BrowserItem)
1278 </dd>
1279 </dl><a NAME="BrowserModel.addItem" ID="BrowserModel.addItem"></a>
1280 <h4>BrowserModel.addItem</h4>
1281 <b>addItem</b>(<i>itm, parent = QModelIndex()</i>)
1282 <p>
1283 Puplic slot to add an item.
1284 </p><dl>
1285 <dt><i>itm</i></dt>
1286 <dd>
1287 item to add (BrowserItem)
1288 </dd><dt><i>parent</i></dt>
1289 <dd>
1290 index of parent item (QModelIndex)
1291 </dd>
1292 </dl><a NAME="BrowserModel.addTopLevelDir" ID="BrowserModel.addTopLevelDir"></a>
1293 <h4>BrowserModel.addTopLevelDir</h4>
1294 <b>addTopLevelDir</b>(<i>dirname</i>)
1295 <p>
1296 Public method to add a new toplevel directory.
1297 </p><dl>
1298 <dt><i>dirname</i></dt>
1299 <dd>
1300 name of the new toplevel directory (string)
1301 </dd>
1302 </dl><a NAME="BrowserModel.clear" ID="BrowserModel.clear"></a>
1303 <h4>BrowserModel.clear</h4>
1304 <b>clear</b>(<i></i>)
1305 <p>
1306 Public method to clear the model.
1307 </p><a NAME="BrowserModel.columnCount" ID="BrowserModel.columnCount"></a>
1308 <h4>BrowserModel.columnCount</h4>
1309 <b>columnCount</b>(<i>parent=QModelIndex()</i>)
1310 <p>
1311 Public method to get the number of columns.
1312 </p><dl>
1313 <dt><i>parent</i></dt>
1314 <dd>
1315 index of parent item (QModelIndex)
1316 </dd>
1317 </dl><dl>
1318 <dt>Returns:</dt>
1319 <dd>
1320 number of columns (integer)
1321 </dd>
1322 </dl><a NAME="BrowserModel.data" ID="BrowserModel.data"></a>
1323 <h4>BrowserModel.data</h4>
1324 <b>data</b>(<i>index, role</i>)
1325 <p>
1326 Public method to get data of an item.
1327 </p><dl>
1328 <dt><i>index</i></dt>
1329 <dd>
1330 index of the data to retrieve (QModelIndex)
1331 </dd><dt><i>role</i></dt>
1332 <dd>
1333 role of data (Qt.ItemDataRole)
1334 </dd>
1335 </dl><dl>
1336 <dt>Returns:</dt>
1337 <dd>
1338 requested data (QVariant)
1339 </dd>
1340 </dl><a NAME="BrowserModel.flags" ID="BrowserModel.flags"></a>
1341 <h4>BrowserModel.flags</h4>
1342 <b>flags</b>(<i>index</i>)
1343 <p>
1344 Public method to get the item flags.
1345 </p><dl>
1346 <dt><i>index</i></dt>
1347 <dd>
1348 index of the data to retrieve (QModelIndex)
1349 </dd>
1350 </dl><dl>
1351 <dt>Returns:</dt>
1352 <dd>
1353 requested flags (Qt.ItemFlags)
1354 </dd>
1355 </dl><a NAME="BrowserModel.hasChildren" ID="BrowserModel.hasChildren"></a>
1356 <h4>BrowserModel.hasChildren</h4>
1357 <b>hasChildren</b>(<i>parent = QModelIndex()</i>)
1358 <p>
1359 Public method to check for the presence of child items.
1360 </p><p>
1361 We always return True for normal items in order to do lazy
1362 population of the tree.
1363 </p><dl>
1364 <dt><i>parent</i></dt>
1365 <dd>
1366 index of parent item (QModelIndex)
1367 </dd>
1368 </dl><dl>
1369 <dt>Returns:</dt>
1370 <dd>
1371 flag indicating the presence of child items (boolean)
1372 </dd>
1373 </dl><a NAME="BrowserModel.headerData" ID="BrowserModel.headerData"></a>
1374 <h4>BrowserModel.headerData</h4>
1375 <b>headerData</b>(<i>section, orientation, role = Qt.DisplayRole</i>)
1376 <p>
1377 Public method to get the header data.
1378 </p><dl>
1379 <dt><i>section</i></dt>
1380 <dd>
1381 number of section to get data for (integer)
1382 </dd><dt><i>orientation</i></dt>
1383 <dd>
1384 header orientation (Qt.Orientation)
1385 </dd><dt><i>role</i></dt>
1386 <dd>
1387 role of data (Qt.ItemDataRole)
1388 </dd>
1389 </dl><dl>
1390 <dt>Returns:</dt>
1391 <dd>
1392 requested header data (QVariant)
1393 </dd>
1394 </dl><a NAME="BrowserModel.index" ID="BrowserModel.index"></a>
1395 <h4>BrowserModel.index</h4>
1396 <b>index</b>(<i>row, column, parent = QModelIndex()</i>)
1397 <p>
1398 Public method to create an index.
1399 </p><dl>
1400 <dt><i>row</i></dt>
1401 <dd>
1402 row number of the new index (integer)
1403 </dd><dt><i>column</i></dt>
1404 <dd>
1405 column number of the new index (integer)
1406 </dd><dt><i>parent</i></dt>
1407 <dd>
1408 index of parent item (QModelIndex)
1409 </dd>
1410 </dl><dl>
1411 <dt>Returns:</dt>
1412 <dd>
1413 index object (QModelIndex)
1414 </dd>
1415 </dl><a NAME="BrowserModel.item" ID="BrowserModel.item"></a>
1416 <h4>BrowserModel.item</h4>
1417 <b>item</b>(<i>index</i>)
1418 <p>
1419 Public method to get a reference to an item.
1420 </p><dl>
1421 <dt><i>index</i></dt>
1422 <dd>
1423 index of the data to retrieve (QModelIndex)
1424 </dd>
1425 </dl><dl>
1426 <dt>Returns:</dt>
1427 <dd>
1428 requested item reference (BrowserItem)
1429 </dd>
1430 </dl><a NAME="BrowserModel.parent" ID="BrowserModel.parent"></a>
1431 <h4>BrowserModel.parent</h4>
1432 <b>parent</b>(<i>index</i>)
1433 <p>
1434 Public method to get the index of the parent object.
1435 </p><dl>
1436 <dt><i>index</i></dt>
1437 <dd>
1438 index of the item (QModelIndex)
1439 </dd>
1440 </dl><dl>
1441 <dt>Returns:</dt>
1442 <dd>
1443 index of parent item (QModelIndex)
1444 </dd>
1445 </dl><a NAME="BrowserModel.populateClassAttributesItem" ID="BrowserModel.populateClassAttributesItem"></a>
1446 <h4>BrowserModel.populateClassAttributesItem</h4>
1447 <b>populateClassAttributesItem</b>(<i>parentItem, repopulate = False</i>)
1448 <p>
1449 Public method to populate a class attributes item's subtree.
1450 </p><dl>
1451 <dt><i>parentItem</i></dt>
1452 <dd>
1453 reference to the class attributes item to be populated
1454 </dd><dt><i>repopulate</i></dt>
1455 <dd>
1456 flag indicating a repopulation (boolean)
1457 </dd>
1458 </dl><a NAME="BrowserModel.populateClassItem" ID="BrowserModel.populateClassItem"></a>
1459 <h4>BrowserModel.populateClassItem</h4>
1460 <b>populateClassItem</b>(<i>parentItem, repopulate = False</i>)
1461 <p>
1462 Public method to populate a class item's subtree.
1463 </p><dl>
1464 <dt><i>parentItem</i></dt>
1465 <dd>
1466 reference to the class item to be populated
1467 </dd><dt><i>repopulate</i></dt>
1468 <dd>
1469 flag indicating a repopulation (boolean)
1470 </dd>
1471 </dl><a NAME="BrowserModel.populateDirectoryItem" ID="BrowserModel.populateDirectoryItem"></a>
1472 <h4>BrowserModel.populateDirectoryItem</h4>
1473 <b>populateDirectoryItem</b>(<i>parentItem, repopulate = False</i>)
1474 <p>
1475 Public method to populate a directory item's subtree.
1476 </p><dl>
1477 <dt><i>parentItem</i></dt>
1478 <dd>
1479 reference to the directory item to be populated
1480 </dd><dt><i>repopulate</i></dt>
1481 <dd>
1482 flag indicating a repopulation (boolean)
1483 </dd>
1484 </dl><a NAME="BrowserModel.populateFileItem" ID="BrowserModel.populateFileItem"></a>
1485 <h4>BrowserModel.populateFileItem</h4>
1486 <b>populateFileItem</b>(<i>parentItem, repopulate = False</i>)
1487 <p>
1488 Public method to populate a file item's subtree.
1489 </p><dl>
1490 <dt><i>parentItem</i></dt>
1491 <dd>
1492 reference to the file item to be populated
1493 </dd><dt><i>repopulate</i></dt>
1494 <dd>
1495 flag indicating a repopulation (boolean)
1496 </dd>
1497 </dl><a NAME="BrowserModel.populateItem" ID="BrowserModel.populateItem"></a>
1498 <h4>BrowserModel.populateItem</h4>
1499 <b>populateItem</b>(<i>parentItem, repopulate = False</i>)
1500 <p>
1501 Public method to populate an item's subtree.
1502 </p><dl>
1503 <dt><i>parentItem</i></dt>
1504 <dd>
1505 reference to the item to be populated
1506 </dd><dt><i>repopulate</i></dt>
1507 <dd>
1508 flag indicating a repopulation (boolean)
1509 </dd>
1510 </dl><a NAME="BrowserModel.populateMethodItem" ID="BrowserModel.populateMethodItem"></a>
1511 <h4>BrowserModel.populateMethodItem</h4>
1512 <b>populateMethodItem</b>(<i>parentItem, repopulate = False</i>)
1513 <p>
1514 Public method to populate a method item's subtree.
1515 </p><dl>
1516 <dt><i>parentItem</i></dt>
1517 <dd>
1518 reference to the method item to be populated
1519 </dd><dt><i>repopulate</i></dt>
1520 <dd>
1521 flag indicating a repopulation (boolean)
1522 </dd>
1523 </dl><a NAME="BrowserModel.populateSysPathItem" ID="BrowserModel.populateSysPathItem"></a>
1524 <h4>BrowserModel.populateSysPathItem</h4>
1525 <b>populateSysPathItem</b>(<i>parentItem, repopulate = False</i>)
1526 <p>
1527 Public method to populate a sys.path item's subtree.
1528 </p><dl>
1529 <dt><i>parentItem</i></dt>
1530 <dd>
1531 reference to the sys.path item to be populated
1532 </dd><dt><i>repopulate</i></dt>
1533 <dd>
1534 flag indicating a repopulation (boolean)
1535 </dd>
1536 </dl><a NAME="BrowserModel.programChange" ID="BrowserModel.programChange"></a>
1537 <h4>BrowserModel.programChange</h4>
1538 <b>programChange</b>(<i>dirname</i>)
1539 <p>
1540 Public method to change the entry for the directory of file being debugged.
1541 </p><dl>
1542 <dt><i>dirname</i></dt>
1543 <dd>
1544 name of the directory containg the file (string)
1545 </dd>
1546 </dl><a NAME="BrowserModel.removeToplevelDir" ID="BrowserModel.removeToplevelDir"></a>
1547 <h4>BrowserModel.removeToplevelDir</h4>
1548 <b>removeToplevelDir</b>(<i>index</i>)
1549 <p>
1550 Public method to remove a toplevel directory.
1551 </p><dl>
1552 <dt><i>index</i></dt>
1553 <dd>
1554 index of the toplevel directory to be removed (QModelIndex)
1555 </dd>
1556 </dl><a NAME="BrowserModel.rowCount" ID="BrowserModel.rowCount"></a>
1557 <h4>BrowserModel.rowCount</h4>
1558 <b>rowCount</b>(<i>parent = QModelIndex()</i>)
1559 <p>
1560 Public method to get the number of rows.
1561 </p><dl>
1562 <dt><i>parent</i></dt>
1563 <dd>
1564 index of parent item (QModelIndex)
1565 </dd>
1566 </dl><dl>
1567 <dt>Returns:</dt>
1568 <dd>
1569 number of rows (integer)
1570 </dd>
1571 </dl><a NAME="BrowserModel.saveToplevelDirs" ID="BrowserModel.saveToplevelDirs"></a>
1572 <h4>BrowserModel.saveToplevelDirs</h4>
1573 <b>saveToplevelDirs</b>(<i></i>)
1574 <p>
1575 Public slot to save the toplevel directories.
1576 </p>
1577 <div align="right"><a href="#top">Up</a></div>
1578 <hr /><hr />
1579 <a NAME="BrowserSysPathItem" ID="BrowserSysPathItem"></a>
1580 <h2>BrowserSysPathItem</h2>
1581 <p>
1582 Class implementing the data structure for browser sys.path items.
1583 </p>
1584 <h3>Derived from</h3>
1585 BrowserItem
1586 <h3>Class Attributes</h3>
1587 <table>
1588 <tr><td>None</td></tr>
1589 </table>
1590 <h3>Methods</h3>
1591 <table>
1592 <tr>
1593 <td><a href="#BrowserSysPathItem.__init__">BrowserSysPathItem</a></td>
1594 <td>Constructor</td>
1595 </tr>
1596 </table>
1597 <a NAME="BrowserSysPathItem.__init__" ID="BrowserSysPathItem.__init__"></a>
1598 <h4>BrowserSysPathItem (Constructor)</h4>
1599 <b>BrowserSysPathItem</b>(<i>parent</i>)
1600 <p>
1601 Constructor
1602 </p><dl>
1603 <dt><i>parent</i></dt>
1604 <dd>
1605 parent item
1606 </dd>
1607 </dl>
1608 <div align="right"><a href="#top">Up</a></div>
1609 <hr />
1610 </body></html>

eric ide

mercurial