eric6/Documentation/Source/eric6.UI.BrowserModel.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.UI.BrowserModel</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.UI.BrowserModel</h1>
23 <p>
24 Module implementing the browser model.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <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>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#BrowserClassAttributeItem">BrowserClassAttributeItem</a></td>
34 <td>Class implementing the data structure for browser class attribute items.</td>
35 </tr><tr>
36 <td><a href="#BrowserClassAttributesItem">BrowserClassAttributesItem</a></td>
37 <td>Class implementing the data structure for browser class attributes items.</td>
38 </tr><tr>
39 <td><a href="#BrowserClassItem">BrowserClassItem</a></td>
40 <td>Class implementing the data structure for browser class items.</td>
41 </tr><tr>
42 <td><a href="#BrowserCodingItem">BrowserCodingItem</a></td>
43 <td>Class implementing the data structure for browser coding items.</td>
44 </tr><tr>
45 <td><a href="#BrowserDirectoryItem">BrowserDirectoryItem</a></td>
46 <td>Class implementing the data structure for browser directory items.</td>
47 </tr><tr>
48 <td><a href="#BrowserFileItem">BrowserFileItem</a></td>
49 <td>Class implementing the data structure for browser file items.</td>
50 </tr><tr>
51 <td><a href="#BrowserGlobalsItem">BrowserGlobalsItem</a></td>
52 <td>Class implementing the data structure for browser globals items.</td>
53 </tr><tr>
54 <td><a href="#BrowserImportItem">BrowserImportItem</a></td>
55 <td>Class implementing the data structure for browser imported module and imported names items.</td>
56 </tr><tr>
57 <td><a href="#BrowserImportsItem">BrowserImportsItem</a></td>
58 <td>Class implementing the data structure for browser import items.</td>
59 </tr><tr>
60 <td><a href="#BrowserItem">BrowserItem</a></td>
61 <td>Class implementing the data structure for browser items.</td>
62 </tr><tr>
63 <td><a href="#BrowserMethodItem">BrowserMethodItem</a></td>
64 <td>Class implementing the data structure for browser method items.</td>
65 </tr><tr>
66 <td><a href="#BrowserModel">BrowserModel</a></td>
67 <td>Class implementing the browser model.</td>
68 </tr><tr>
69 <td><a href="#BrowserSysPathItem">BrowserSysPathItem</a></td>
70 <td>Class implementing the data structure for browser sys.path items.</td>
71 </tr>
72 </table>
73 <h3>Functions</h3>
74 <table>
75 <tr><td>None</td></tr>
76 </table>
77 <hr /><hr />
78 <a NAME="BrowserClassAttributeItem" ID="BrowserClassAttributeItem"></a>
79 <h2>BrowserClassAttributeItem</h2>
80 <p>
81 Class implementing the data structure for browser class attribute items.
82 </p>
83 <h3>Derived from</h3>
84 BrowserItem
85 <h3>Class Attributes</h3>
86 <table>
87 <tr><td>None</td></tr>
88 </table>
89 <h3>Class Methods</h3>
90 <table>
91 <tr><td>None</td></tr>
92 </table>
93 <h3>Methods</h3>
94 <table>
95 <tr>
96 <td><a href="#BrowserClassAttributeItem.__init__">BrowserClassAttributeItem</a></td>
97 <td>Constructor</td>
98 </tr><tr>
99 <td><a href="#BrowserClassAttributeItem.attributeObject">attributeObject</a></td>
100 <td>Public method returning the class object.</td>
101 </tr><tr>
102 <td><a href="#BrowserClassAttributeItem.fileName">fileName</a></td>
103 <td>Public method returning the filename.</td>
104 </tr><tr>
105 <td><a href="#BrowserClassAttributeItem.isPublic">isPublic</a></td>
106 <td>Public method returning the public visibility status.</td>
107 </tr><tr>
108 <td><a href="#BrowserClassAttributeItem.lessThan">lessThan</a></td>
109 <td>Public method to check, if the item is less than the other one.</td>
110 </tr><tr>
111 <td><a href="#BrowserClassAttributeItem.lineno">lineno</a></td>
112 <td>Public method returning the line number defining this object.</td>
113 </tr><tr>
114 <td><a href="#BrowserClassAttributeItem.linenos">linenos</a></td>
115 <td>Public method returning the line numbers this object is assigned to.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122 <a NAME="BrowserClassAttributeItem.__init__" ID="BrowserClassAttributeItem.__init__"></a>
123 <h4>BrowserClassAttributeItem (Constructor)</h4>
124 <b>BrowserClassAttributeItem</b>(<i>parent, attribute, isClass=False</i>)
125 <p>
126 Constructor
127 </p><dl>
128 <dt><i>parent</i></dt>
129 <dd>
130 parent item
131 </dd><dt><i>attribute</i></dt>
132 <dd>
133 reference to the attribute object
134 </dd><dt><i>isClass</i></dt>
135 <dd>
136 flag indicating a class attribute (boolean)
137 </dd>
138 </dl><a NAME="BrowserClassAttributeItem.attributeObject" ID="BrowserClassAttributeItem.attributeObject"></a>
139 <h4>BrowserClassAttributeItem.attributeObject</h4>
140 <b>attributeObject</b>(<i></i>)
141 <p>
142 Public method returning the class object.
143 </p><dl>
144 <dt>Returns:</dt>
145 <dd>
146 reference to the class object
147 </dd>
148 </dl><a NAME="BrowserClassAttributeItem.fileName" ID="BrowserClassAttributeItem.fileName"></a>
149 <h4>BrowserClassAttributeItem.fileName</h4>
150 <b>fileName</b>(<i></i>)
151 <p>
152 Public method returning the filename.
153 </p><dl>
154 <dt>Returns:</dt>
155 <dd>
156 filename (string)
157 </dd>
158 </dl><a NAME="BrowserClassAttributeItem.isPublic" ID="BrowserClassAttributeItem.isPublic"></a>
159 <h4>BrowserClassAttributeItem.isPublic</h4>
160 <b>isPublic</b>(<i></i>)
161 <p>
162 Public method returning the public visibility status.
163 </p><dl>
164 <dt>Returns:</dt>
165 <dd>
166 flag indicating public visibility (boolean)
167 </dd>
168 </dl><a NAME="BrowserClassAttributeItem.lessThan" ID="BrowserClassAttributeItem.lessThan"></a>
169 <h4>BrowserClassAttributeItem.lessThan</h4>
170 <b>lessThan</b>(<i>other, column, order</i>)
171 <p>
172 Public method to check, if the item is less than the other one.
173 </p><dl>
174 <dt><i>other</i></dt>
175 <dd>
176 reference to item to compare against (BrowserItem)
177 </dd><dt><i>column</i></dt>
178 <dd>
179 column number to use for the comparison (integer)
180 </dd><dt><i>order</i></dt>
181 <dd>
182 sort order (Qt.SortOrder) (for special sorting)
183 </dd>
184 </dl><dl>
185 <dt>Returns:</dt>
186 <dd>
187 true, if this item is less than other (boolean)
188 </dd>
189 </dl><a NAME="BrowserClassAttributeItem.lineno" ID="BrowserClassAttributeItem.lineno"></a>
190 <h4>BrowserClassAttributeItem.lineno</h4>
191 <b>lineno</b>(<i></i>)
192 <p>
193 Public method returning the line number defining this object.
194 </p><dl>
195 <dt>Returns:</dt>
196 <dd>
197 line number defining the object (integer)
198 </dd>
199 </dl><a NAME="BrowserClassAttributeItem.linenos" ID="BrowserClassAttributeItem.linenos"></a>
200 <h4>BrowserClassAttributeItem.linenos</h4>
201 <b>linenos</b>(<i></i>)
202 <p>
203 Public method returning the line numbers this object is assigned to.
204 </p><dl>
205 <dt>Returns:</dt>
206 <dd>
207 line number the object is assigned to (list of integers)
208 </dd>
209 </dl>
210 <div align="right"><a href="#top">Up</a></div>
211 <hr /><hr />
212 <a NAME="BrowserClassAttributesItem" ID="BrowserClassAttributesItem"></a>
213 <h2>BrowserClassAttributesItem</h2>
214 <p>
215 Class implementing the data structure for browser class attributes items.
216 </p>
217 <h3>Derived from</h3>
218 BrowserItem
219 <h3>Class Attributes</h3>
220 <table>
221 <tr><td>None</td></tr>
222 </table>
223 <h3>Class Methods</h3>
224 <table>
225 <tr><td>None</td></tr>
226 </table>
227 <h3>Methods</h3>
228 <table>
229 <tr>
230 <td><a href="#BrowserClassAttributesItem.__init__">BrowserClassAttributesItem</a></td>
231 <td>Constructor</td>
232 </tr><tr>
233 <td><a href="#BrowserClassAttributesItem.attributes">attributes</a></td>
234 <td>Public method returning the attribute list.</td>
235 </tr><tr>
236 <td><a href="#BrowserClassAttributesItem.isClassAttributes">isClassAttributes</a></td>
237 <td>Public method returning the attributes type.</td>
238 </tr><tr>
239 <td><a href="#BrowserClassAttributesItem.lessThan">lessThan</a></td>
240 <td>Public method to check, if the item is less than the other one.</td>
241 </tr><tr>
242 <td><a href="#BrowserClassAttributesItem.name">name</a></td>
243 <td>Public method to return the name of the item.</td>
244 </tr>
245 </table>
246 <h3>Static Methods</h3>
247 <table>
248 <tr><td>None</td></tr>
249 </table>
250 <a NAME="BrowserClassAttributesItem.__init__" ID="BrowserClassAttributesItem.__init__"></a>
251 <h4>BrowserClassAttributesItem (Constructor)</h4>
252 <b>BrowserClassAttributesItem</b>(<i>parent, attributes, text, isClass=False</i>)
253 <p>
254 Constructor
255 </p><dl>
256 <dt><i>parent</i></dt>
257 <dd>
258 parent item
259 </dd><dt><i>attributes</i></dt>
260 <dd>
261 list of attributes
262 </dd><dt><i>text</i></dt>
263 <dd>
264 text to be shown by this item (string)
265 </dd><dt><i>isClass</i></dt>
266 <dd>
267 flag indicating class attributes (boolean)
268 </dd>
269 </dl><a NAME="BrowserClassAttributesItem.attributes" ID="BrowserClassAttributesItem.attributes"></a>
270 <h4>BrowserClassAttributesItem.attributes</h4>
271 <b>attributes</b>(<i></i>)
272 <p>
273 Public method returning the attribute list.
274 </p><dl>
275 <dt>Returns:</dt>
276 <dd>
277 reference to the list of attributes
278 </dd>
279 </dl><a NAME="BrowserClassAttributesItem.isClassAttributes" ID="BrowserClassAttributesItem.isClassAttributes"></a>
280 <h4>BrowserClassAttributesItem.isClassAttributes</h4>
281 <b>isClassAttributes</b>(<i></i>)
282 <p>
283 Public method returning the attributes type.
284 </p><dl>
285 <dt>Returns:</dt>
286 <dd>
287 flag indicating class attributes (boolean)
288 </dd>
289 </dl><a NAME="BrowserClassAttributesItem.lessThan" ID="BrowserClassAttributesItem.lessThan"></a>
290 <h4>BrowserClassAttributesItem.lessThan</h4>
291 <b>lessThan</b>(<i>other, column, order</i>)
292 <p>
293 Public method to check, if the item is less than the other one.
294 </p><dl>
295 <dt><i>other</i></dt>
296 <dd>
297 reference to item to compare against (BrowserItem)
298 </dd><dt><i>column</i></dt>
299 <dd>
300 column number to use for the comparison (integer)
301 </dd><dt><i>order</i></dt>
302 <dd>
303 sort order (Qt.SortOrder) (for special sorting)
304 </dd>
305 </dl><dl>
306 <dt>Returns:</dt>
307 <dd>
308 true, if this item is less than other (boolean)
309 </dd>
310 </dl><a NAME="BrowserClassAttributesItem.name" ID="BrowserClassAttributesItem.name"></a>
311 <h4>BrowserClassAttributesItem.name</h4>
312 <b>name</b>(<i></i>)
313 <p>
314 Public method to return the name of the item.
315 </p><dl>
316 <dt>Returns:</dt>
317 <dd>
318 name of the item (string)
319 </dd>
320 </dl>
321 <div align="right"><a href="#top">Up</a></div>
322 <hr /><hr />
323 <a NAME="BrowserClassItem" ID="BrowserClassItem"></a>
324 <h2>BrowserClassItem</h2>
325 <p>
326 Class implementing the data structure for browser class items.
327 </p>
328 <h3>Derived from</h3>
329 BrowserItem
330 <h3>Class Attributes</h3>
331 <table>
332 <tr><td>None</td></tr>
333 </table>
334 <h3>Class Methods</h3>
335 <table>
336 <tr><td>None</td></tr>
337 </table>
338 <h3>Methods</h3>
339 <table>
340 <tr>
341 <td><a href="#BrowserClassItem.__init__">BrowserClassItem</a></td>
342 <td>Constructor</td>
343 </tr><tr>
344 <td><a href="#BrowserClassItem.boundaries">boundaries</a></td>
345 <td>Public method returning the boundaries of the method definition.</td>
346 </tr><tr>
347 <td><a href="#BrowserClassItem.classObject">classObject</a></td>
348 <td>Public method returning the class object.</td>
349 </tr><tr>
350 <td><a href="#BrowserClassItem.fileName">fileName</a></td>
351 <td>Public method returning the filename.</td>
352 </tr><tr>
353 <td><a href="#BrowserClassItem.isPublic">isPublic</a></td>
354 <td>Public method returning the public visibility status.</td>
355 </tr><tr>
356 <td><a href="#BrowserClassItem.lessThan">lessThan</a></td>
357 <td>Public method to check, if the item is less than the other one.</td>
358 </tr><tr>
359 <td><a href="#BrowserClassItem.lineno">lineno</a></td>
360 <td>Public method returning the line number defining this object.</td>
361 </tr><tr>
362 <td><a href="#BrowserClassItem.name">name</a></td>
363 <td>Public method to return the name of the item.</td>
364 </tr>
365 </table>
366 <h3>Static Methods</h3>
367 <table>
368 <tr><td>None</td></tr>
369 </table>
370 <a NAME="BrowserClassItem.__init__" ID="BrowserClassItem.__init__"></a>
371 <h4>BrowserClassItem (Constructor)</h4>
372 <b>BrowserClassItem</b>(<i>parent, cl, filename</i>)
373 <p>
374 Constructor
375 </p><dl>
376 <dt><i>parent</i></dt>
377 <dd>
378 parent item
379 </dd><dt><i>cl</i></dt>
380 <dd>
381 Class object to be shown
382 </dd><dt><i>filename</i></dt>
383 <dd>
384 filename of the file defining this class
385 </dd>
386 </dl><a NAME="BrowserClassItem.boundaries" ID="BrowserClassItem.boundaries"></a>
387 <h4>BrowserClassItem.boundaries</h4>
388 <b>boundaries</b>(<i></i>)
389 <p>
390 Public method returning the boundaries of the method definition.
391 </p><dl>
392 <dt>Returns:</dt>
393 <dd>
394 tuple with start end end line number (integer, integer)
395 </dd>
396 </dl><a NAME="BrowserClassItem.classObject" ID="BrowserClassItem.classObject"></a>
397 <h4>BrowserClassItem.classObject</h4>
398 <b>classObject</b>(<i></i>)
399 <p>
400 Public method returning the class object.
401 </p><dl>
402 <dt>Returns:</dt>
403 <dd>
404 reference to the class object
405 </dd>
406 </dl><a NAME="BrowserClassItem.fileName" ID="BrowserClassItem.fileName"></a>
407 <h4>BrowserClassItem.fileName</h4>
408 <b>fileName</b>(<i></i>)
409 <p>
410 Public method returning the filename.
411 </p><dl>
412 <dt>Returns:</dt>
413 <dd>
414 filename (string)
415 </dd>
416 </dl><a NAME="BrowserClassItem.isPublic" ID="BrowserClassItem.isPublic"></a>
417 <h4>BrowserClassItem.isPublic</h4>
418 <b>isPublic</b>(<i></i>)
419 <p>
420 Public method returning the public visibility status.
421 </p><dl>
422 <dt>Returns:</dt>
423 <dd>
424 flag indicating public visibility (boolean)
425 </dd>
426 </dl><a NAME="BrowserClassItem.lessThan" ID="BrowserClassItem.lessThan"></a>
427 <h4>BrowserClassItem.lessThan</h4>
428 <b>lessThan</b>(<i>other, column, order</i>)
429 <p>
430 Public method to check, if the item is less than the other one.
431 </p><dl>
432 <dt><i>other</i></dt>
433 <dd>
434 reference to item to compare against (BrowserItem)
435 </dd><dt><i>column</i></dt>
436 <dd>
437 column number to use for the comparison (integer)
438 </dd><dt><i>order</i></dt>
439 <dd>
440 sort order (Qt.SortOrder) (for special sorting)
441 </dd>
442 </dl><dl>
443 <dt>Returns:</dt>
444 <dd>
445 true, if this item is less than other (boolean)
446 </dd>
447 </dl><a NAME="BrowserClassItem.lineno" ID="BrowserClassItem.lineno"></a>
448 <h4>BrowserClassItem.lineno</h4>
449 <b>lineno</b>(<i></i>)
450 <p>
451 Public method returning the line number defining this object.
452 </p><dl>
453 <dt>Returns:</dt>
454 <dd>
455 line number defining the object (integer)
456 </dd>
457 </dl><a NAME="BrowserClassItem.name" ID="BrowserClassItem.name"></a>
458 <h4>BrowserClassItem.name</h4>
459 <b>name</b>(<i></i>)
460 <p>
461 Public method to return the name of the item.
462 </p><dl>
463 <dt>Returns:</dt>
464 <dd>
465 name of the item (string)
466 </dd>
467 </dl>
468 <div align="right"><a href="#top">Up</a></div>
469 <hr /><hr />
470 <a NAME="BrowserCodingItem" ID="BrowserCodingItem"></a>
471 <h2>BrowserCodingItem</h2>
472 <p>
473 Class implementing the data structure for browser coding items.
474 </p>
475 <h3>Derived from</h3>
476 BrowserItem
477 <h3>Class Attributes</h3>
478 <table>
479 <tr><td>None</td></tr>
480 </table>
481 <h3>Class Methods</h3>
482 <table>
483 <tr><td>None</td></tr>
484 </table>
485 <h3>Methods</h3>
486 <table>
487 <tr>
488 <td><a href="#BrowserCodingItem.__init__">BrowserCodingItem</a></td>
489 <td>Constructor</td>
490 </tr><tr>
491 <td><a href="#BrowserCodingItem.lessThan">lessThan</a></td>
492 <td>Public method to check, if the item is less than the other one.</td>
493 </tr>
494 </table>
495 <h3>Static Methods</h3>
496 <table>
497 <tr><td>None</td></tr>
498 </table>
499 <a NAME="BrowserCodingItem.__init__" ID="BrowserCodingItem.__init__"></a>
500 <h4>BrowserCodingItem (Constructor)</h4>
501 <b>BrowserCodingItem</b>(<i>parent, text</i>)
502 <p>
503 Constructor
504 </p><dl>
505 <dt><i>parent</i></dt>
506 <dd>
507 parent item
508 </dd><dt><i>text</i></dt>
509 <dd>
510 text to be shown by this item (string)
511 </dd>
512 </dl><a NAME="BrowserCodingItem.lessThan" ID="BrowserCodingItem.lessThan"></a>
513 <h4>BrowserCodingItem.lessThan</h4>
514 <b>lessThan</b>(<i>other, column, order</i>)
515 <p>
516 Public method to check, if the item is less than the other one.
517 </p><dl>
518 <dt><i>other</i></dt>
519 <dd>
520 reference to item to compare against (BrowserItem)
521 </dd><dt><i>column</i></dt>
522 <dd>
523 column number to use for the comparison (integer)
524 </dd><dt><i>order</i></dt>
525 <dd>
526 sort order (Qt.SortOrder) (for special sorting)
527 </dd>
528 </dl><dl>
529 <dt>Returns:</dt>
530 <dd>
531 true, if this item is less than other (boolean)
532 </dd>
533 </dl>
534 <div align="right"><a href="#top">Up</a></div>
535 <hr /><hr />
536 <a NAME="BrowserDirectoryItem" ID="BrowserDirectoryItem"></a>
537 <h2>BrowserDirectoryItem</h2>
538 <p>
539 Class implementing the data structure for browser directory items.
540 </p>
541 <h3>Derived from</h3>
542 BrowserItem
543 <h3>Class Attributes</h3>
544 <table>
545 <tr><td>None</td></tr>
546 </table>
547 <h3>Class Methods</h3>
548 <table>
549 <tr><td>None</td></tr>
550 </table>
551 <h3>Methods</h3>
552 <table>
553 <tr>
554 <td><a href="#BrowserDirectoryItem.__init__">BrowserDirectoryItem</a></td>
555 <td>Constructor</td>
556 </tr><tr>
557 <td><a href="#BrowserDirectoryItem.dirName">dirName</a></td>
558 <td>Public method returning the directory name.</td>
559 </tr><tr>
560 <td><a href="#BrowserDirectoryItem.lessThan">lessThan</a></td>
561 <td>Public method to check, if the item is less than the other one.</td>
562 </tr><tr>
563 <td><a href="#BrowserDirectoryItem.name">name</a></td>
564 <td>Public method to return the name of the item.</td>
565 </tr><tr>
566 <td><a href="#BrowserDirectoryItem.setName">setName</a></td>
567 <td>Public method to set the directory name.</td>
568 </tr>
569 </table>
570 <h3>Static Methods</h3>
571 <table>
572 <tr><td>None</td></tr>
573 </table>
574 <a NAME="BrowserDirectoryItem.__init__" ID="BrowserDirectoryItem.__init__"></a>
575 <h4>BrowserDirectoryItem (Constructor)</h4>
576 <b>BrowserDirectoryItem</b>(<i>parent, dinfo, full=True</i>)
577 <p>
578 Constructor
579 </p><dl>
580 <dt><i>parent</i></dt>
581 <dd>
582 parent item
583 </dd><dt><i>dinfo</i></dt>
584 <dd>
585 dinfo is the string for the directory (string)
586 </dd><dt><i>full</i></dt>
587 <dd>
588 flag indicating full pathname should be displayed (boolean)
589 </dd>
590 </dl><a NAME="BrowserDirectoryItem.dirName" ID="BrowserDirectoryItem.dirName"></a>
591 <h4>BrowserDirectoryItem.dirName</h4>
592 <b>dirName</b>(<i></i>)
593 <p>
594 Public method returning the directory name.
595 </p><dl>
596 <dt>Returns:</dt>
597 <dd>
598 directory name (string)
599 </dd>
600 </dl><a NAME="BrowserDirectoryItem.lessThan" ID="BrowserDirectoryItem.lessThan"></a>
601 <h4>BrowserDirectoryItem.lessThan</h4>
602 <b>lessThan</b>(<i>other, column, order</i>)
603 <p>
604 Public method to check, if the item is less than the other one.
605 </p><dl>
606 <dt><i>other</i></dt>
607 <dd>
608 reference to item to compare against (BrowserItem)
609 </dd><dt><i>column</i></dt>
610 <dd>
611 column number to use for the comparison (integer)
612 </dd><dt><i>order</i></dt>
613 <dd>
614 sort order (Qt.SortOrder) (for special sorting)
615 </dd>
616 </dl><dl>
617 <dt>Returns:</dt>
618 <dd>
619 true, if this item is less than other (boolean)
620 </dd>
621 </dl><a NAME="BrowserDirectoryItem.name" ID="BrowserDirectoryItem.name"></a>
622 <h4>BrowserDirectoryItem.name</h4>
623 <b>name</b>(<i></i>)
624 <p>
625 Public method to return the name of the item.
626 </p><dl>
627 <dt>Returns:</dt>
628 <dd>
629 name of the item (string)
630 </dd>
631 </dl><a NAME="BrowserDirectoryItem.setName" ID="BrowserDirectoryItem.setName"></a>
632 <h4>BrowserDirectoryItem.setName</h4>
633 <b>setName</b>(<i>dinfo, full=True</i>)
634 <p>
635 Public method to set the directory name.
636 </p><dl>
637 <dt><i>dinfo</i></dt>
638 <dd>
639 dinfo is the string for the directory (string)
640 </dd><dt><i>full</i></dt>
641 <dd>
642 flag indicating full pathname should be displayed (boolean)
643 </dd>
644 </dl>
645 <div align="right"><a href="#top">Up</a></div>
646 <hr /><hr />
647 <a NAME="BrowserFileItem" ID="BrowserFileItem"></a>
648 <h2>BrowserFileItem</h2>
649 <p>
650 Class implementing the data structure for browser file items.
651 </p>
652 <h3>Derived from</h3>
653 BrowserItem
654 <h3>Class Attributes</h3>
655 <table>
656 <tr><td>None</td></tr>
657 </table>
658 <h3>Class Methods</h3>
659 <table>
660 <tr><td>None</td></tr>
661 </table>
662 <h3>Methods</h3>
663 <table>
664 <tr>
665 <td><a href="#BrowserFileItem.__init__">BrowserFileItem</a></td>
666 <td>Constructor</td>
667 </tr><tr>
668 <td><a href="#BrowserFileItem.dirName">dirName</a></td>
669 <td>Public method returning the directory name.</td>
670 </tr><tr>
671 <td><a href="#BrowserFileItem.fileExt">fileExt</a></td>
672 <td>Public method returning the file extension.</td>
673 </tr><tr>
674 <td><a href="#BrowserFileItem.fileName">fileName</a></td>
675 <td>Public method returning the filename.</td>
676 </tr><tr>
677 <td><a href="#BrowserFileItem.isDFile">isDFile</a></td>
678 <td>Public method to check, if this file is a D file.</td>
679 </tr><tr>
680 <td><a href="#BrowserFileItem.isDesignerFile">isDesignerFile</a></td>
681 <td>Public method to check, if this file is a Qt-Designer file.</td>
682 </tr><tr>
683 <td><a href="#BrowserFileItem.isIdlFile">isIdlFile</a></td>
684 <td>Public method to check, if this file is a CORBA IDL file.</td>
685 </tr><tr>
686 <td><a href="#BrowserFileItem.isJavaScriptFile">isJavaScriptFile</a></td>
687 <td>Public method to check, if this file is a JavaScript file.</td>
688 </tr><tr>
689 <td><a href="#BrowserFileItem.isLinguistFile">isLinguistFile</a></td>
690 <td>Public method to check, if this file is a Qt-Linguist file.</td>
691 </tr><tr>
692 <td><a href="#BrowserFileItem.isMultiProjectFile">isMultiProjectFile</a></td>
693 <td>Public method to check, if this file is an eric multi project file.</td>
694 </tr><tr>
695 <td><a href="#BrowserFileItem.isPixmapFile">isPixmapFile</a></td>
696 <td>Public method to check, if this file is a pixmap file.</td>
697 </tr><tr>
698 <td><a href="#BrowserFileItem.isProjectFile">isProjectFile</a></td>
699 <td>Public method to check, if this file is an eric project file.</td>
700 </tr><tr>
701 <td><a href="#BrowserFileItem.isProtobufFile">isProtobufFile</a></td>
702 <td>Public method to check, if this file is a Google Protocol Buffer file.</td>
703 </tr><tr>
704 <td><a href="#BrowserFileItem.isPython2File">isPython2File</a></td>
705 <td>Public method to check, if this file is a Python script.</td>
706 </tr><tr>
707 <td><a href="#BrowserFileItem.isPython3File">isPython3File</a></td>
708 <td>Public method to check, if this file is a Python3 script.</td>
709 </tr><tr>
710 <td><a href="#BrowserFileItem.isResourcesFile">isResourcesFile</a></td>
711 <td>Public method to check, if this file is a Qt-Resources file.</td>
712 </tr><tr>
713 <td><a href="#BrowserFileItem.isRubyFile">isRubyFile</a></td>
714 <td>Public method to check, if this file is a Ruby script.</td>
715 </tr><tr>
716 <td><a href="#BrowserFileItem.isSvgFile">isSvgFile</a></td>
717 <td>Public method to check, if this file is a SVG file.</td>
718 </tr><tr>
719 <td><a href="#BrowserFileItem.lessThan">lessThan</a></td>
720 <td>Public method to check, if the item is less than the other one.</td>
721 </tr><tr>
722 <td><a href="#BrowserFileItem.moduleName">moduleName</a></td>
723 <td>Public method returning the module name.</td>
724 </tr><tr>
725 <td><a href="#BrowserFileItem.name">name</a></td>
726 <td>Public method to return the name of the item.</td>
727 </tr><tr>
728 <td><a href="#BrowserFileItem.setName">setName</a></td>
729 <td>Public method to set the directory name.</td>
730 </tr>
731 </table>
732 <h3>Static Methods</h3>
733 <table>
734 <tr><td>None</td></tr>
735 </table>
736 <a NAME="BrowserFileItem.__init__" ID="BrowserFileItem.__init__"></a>
737 <h4>BrowserFileItem (Constructor)</h4>
738 <b>BrowserFileItem</b>(<i>parent, finfo, full=True, sourceLanguage=""</i>)
739 <p>
740 Constructor
741 </p><dl>
742 <dt><i>parent</i></dt>
743 <dd>
744 parent item
745 </dd><dt><i>finfo</i></dt>
746 <dd>
747 the string for the file (string)
748 </dd><dt><i>full</i></dt>
749 <dd>
750 flag indicating full pathname should be displayed (boolean)
751 </dd><dt><i>sourceLanguage</i></dt>
752 <dd>
753 source code language of the project (string)
754 </dd>
755 </dl><a NAME="BrowserFileItem.dirName" ID="BrowserFileItem.dirName"></a>
756 <h4>BrowserFileItem.dirName</h4>
757 <b>dirName</b>(<i></i>)
758 <p>
759 Public method returning the directory name.
760 </p><dl>
761 <dt>Returns:</dt>
762 <dd>
763 directory name (string)
764 </dd>
765 </dl><a NAME="BrowserFileItem.fileExt" ID="BrowserFileItem.fileExt"></a>
766 <h4>BrowserFileItem.fileExt</h4>
767 <b>fileExt</b>(<i></i>)
768 <p>
769 Public method returning the file extension.
770 </p><dl>
771 <dt>Returns:</dt>
772 <dd>
773 file extension (string)
774 </dd>
775 </dl><a NAME="BrowserFileItem.fileName" ID="BrowserFileItem.fileName"></a>
776 <h4>BrowserFileItem.fileName</h4>
777 <b>fileName</b>(<i></i>)
778 <p>
779 Public method returning the filename.
780 </p><dl>
781 <dt>Returns:</dt>
782 <dd>
783 filename (string)
784 </dd>
785 </dl><a NAME="BrowserFileItem.isDFile" ID="BrowserFileItem.isDFile"></a>
786 <h4>BrowserFileItem.isDFile</h4>
787 <b>isDFile</b>(<i></i>)
788 <p>
789 Public method to check, if this file is a D file.
790 </p><dl>
791 <dt>Returns:</dt>
792 <dd>
793 flag indicating a D file (boolean)
794 </dd>
795 </dl><a NAME="BrowserFileItem.isDesignerFile" ID="BrowserFileItem.isDesignerFile"></a>
796 <h4>BrowserFileItem.isDesignerFile</h4>
797 <b>isDesignerFile</b>(<i></i>)
798 <p>
799 Public method to check, if this file is a Qt-Designer file.
800 </p><dl>
801 <dt>Returns:</dt>
802 <dd>
803 flag indicating a Qt-Designer file (boolean)
804 </dd>
805 </dl><a NAME="BrowserFileItem.isIdlFile" ID="BrowserFileItem.isIdlFile"></a>
806 <h4>BrowserFileItem.isIdlFile</h4>
807 <b>isIdlFile</b>(<i></i>)
808 <p>
809 Public method to check, if this file is a CORBA IDL file.
810 </p><dl>
811 <dt>Returns:</dt>
812 <dd>
813 flag indicating a CORBA IDL file (boolean)
814 </dd>
815 </dl><a NAME="BrowserFileItem.isJavaScriptFile" ID="BrowserFileItem.isJavaScriptFile"></a>
816 <h4>BrowserFileItem.isJavaScriptFile</h4>
817 <b>isJavaScriptFile</b>(<i></i>)
818 <p>
819 Public method to check, if this file is a JavaScript file.
820 </p><dl>
821 <dt>Returns:</dt>
822 <dd>
823 flag indicating a JavaScript file (boolean)
824 </dd>
825 </dl><a NAME="BrowserFileItem.isLinguistFile" ID="BrowserFileItem.isLinguistFile"></a>
826 <h4>BrowserFileItem.isLinguistFile</h4>
827 <b>isLinguistFile</b>(<i></i>)
828 <p>
829 Public method to check, if this file is a Qt-Linguist file.
830 </p><dl>
831 <dt>Returns:</dt>
832 <dd>
833 flag indicating a Qt-Linguist file (boolean)
834 </dd>
835 </dl><a NAME="BrowserFileItem.isMultiProjectFile" ID="BrowserFileItem.isMultiProjectFile"></a>
836 <h4>BrowserFileItem.isMultiProjectFile</h4>
837 <b>isMultiProjectFile</b>(<i></i>)
838 <p>
839 Public method to check, if this file is an eric multi project file.
840 </p><dl>
841 <dt>Returns:</dt>
842 <dd>
843 flag indicating an eric project file (boolean)
844 </dd>
845 </dl><a NAME="BrowserFileItem.isPixmapFile" ID="BrowserFileItem.isPixmapFile"></a>
846 <h4>BrowserFileItem.isPixmapFile</h4>
847 <b>isPixmapFile</b>(<i></i>)
848 <p>
849 Public method to check, if this file is a pixmap file.
850 </p><dl>
851 <dt>Returns:</dt>
852 <dd>
853 flag indicating a pixmap file (boolean)
854 </dd>
855 </dl><a NAME="BrowserFileItem.isProjectFile" ID="BrowserFileItem.isProjectFile"></a>
856 <h4>BrowserFileItem.isProjectFile</h4>
857 <b>isProjectFile</b>(<i></i>)
858 <p>
859 Public method to check, if this file is an eric project file.
860 </p><dl>
861 <dt>Returns:</dt>
862 <dd>
863 flag indicating an eric project file (boolean)
864 </dd>
865 </dl><a NAME="BrowserFileItem.isProtobufFile" ID="BrowserFileItem.isProtobufFile"></a>
866 <h4>BrowserFileItem.isProtobufFile</h4>
867 <b>isProtobufFile</b>(<i></i>)
868 <p>
869 Public method to check, if this file is a Google Protocol Buffer file.
870 </p><dl>
871 <dt>Returns:</dt>
872 <dd>
873 flag indicating a protobuf file
874 </dd>
875 </dl><dl>
876 <dt>Return Type:</dt>
877 <dd>
878 bool
879 </dd>
880 </dl><a NAME="BrowserFileItem.isPython2File" ID="BrowserFileItem.isPython2File"></a>
881 <h4>BrowserFileItem.isPython2File</h4>
882 <b>isPython2File</b>(<i></i>)
883 <p>
884 Public method to check, if this file is a Python script.
885 </p><dl>
886 <dt>Returns:</dt>
887 <dd>
888 flag indicating a Python file (boolean)
889 </dd>
890 </dl><a NAME="BrowserFileItem.isPython3File" ID="BrowserFileItem.isPython3File"></a>
891 <h4>BrowserFileItem.isPython3File</h4>
892 <b>isPython3File</b>(<i></i>)
893 <p>
894 Public method to check, if this file is a Python3 script.
895 </p><dl>
896 <dt>Returns:</dt>
897 <dd>
898 flag indicating a Python file (boolean)
899 </dd>
900 </dl><a NAME="BrowserFileItem.isResourcesFile" ID="BrowserFileItem.isResourcesFile"></a>
901 <h4>BrowserFileItem.isResourcesFile</h4>
902 <b>isResourcesFile</b>(<i></i>)
903 <p>
904 Public method to check, if this file is a Qt-Resources file.
905 </p><dl>
906 <dt>Returns:</dt>
907 <dd>
908 flag indicating a Qt-Resources file (boolean)
909 </dd>
910 </dl><a NAME="BrowserFileItem.isRubyFile" ID="BrowserFileItem.isRubyFile"></a>
911 <h4>BrowserFileItem.isRubyFile</h4>
912 <b>isRubyFile</b>(<i></i>)
913 <p>
914 Public method to check, if this file is a Ruby script.
915 </p><dl>
916 <dt>Returns:</dt>
917 <dd>
918 flag indicating a Ruby file (boolean)
919 </dd>
920 </dl><a NAME="BrowserFileItem.isSvgFile" ID="BrowserFileItem.isSvgFile"></a>
921 <h4>BrowserFileItem.isSvgFile</h4>
922 <b>isSvgFile</b>(<i></i>)
923 <p>
924 Public method to check, if this file is a SVG file.
925 </p><dl>
926 <dt>Returns:</dt>
927 <dd>
928 flag indicating a SVG file (boolean)
929 </dd>
930 </dl><a NAME="BrowserFileItem.lessThan" ID="BrowserFileItem.lessThan"></a>
931 <h4>BrowserFileItem.lessThan</h4>
932 <b>lessThan</b>(<i>other, column, order</i>)
933 <p>
934 Public method to check, if the item is less than the other one.
935 </p><dl>
936 <dt><i>other</i></dt>
937 <dd>
938 reference to item to compare against (BrowserItem)
939 </dd><dt><i>column</i></dt>
940 <dd>
941 column number to use for the comparison (integer)
942 </dd><dt><i>order</i></dt>
943 <dd>
944 sort order (Qt.SortOrder) (for special sorting)
945 </dd>
946 </dl><dl>
947 <dt>Returns:</dt>
948 <dd>
949 true, if this item is less than other (boolean)
950 </dd>
951 </dl><a NAME="BrowserFileItem.moduleName" ID="BrowserFileItem.moduleName"></a>
952 <h4>BrowserFileItem.moduleName</h4>
953 <b>moduleName</b>(<i></i>)
954 <p>
955 Public method returning the module name.
956 </p><dl>
957 <dt>Returns:</dt>
958 <dd>
959 module name (string)
960 </dd>
961 </dl><a NAME="BrowserFileItem.name" ID="BrowserFileItem.name"></a>
962 <h4>BrowserFileItem.name</h4>
963 <b>name</b>(<i></i>)
964 <p>
965 Public method to return the name of the item.
966 </p><dl>
967 <dt>Returns:</dt>
968 <dd>
969 name of the item (string)
970 </dd>
971 </dl><a NAME="BrowserFileItem.setName" ID="BrowserFileItem.setName"></a>
972 <h4>BrowserFileItem.setName</h4>
973 <b>setName</b>(<i>finfo, full=True</i>)
974 <p>
975 Public method to set the directory name.
976 </p><dl>
977 <dt><i>finfo</i></dt>
978 <dd>
979 the string for the file (string)
980 </dd><dt><i>full</i></dt>
981 <dd>
982 flag indicating full pathname should be displayed (boolean)
983 </dd>
984 </dl>
985 <div align="right"><a href="#top">Up</a></div>
986 <hr /><hr />
987 <a NAME="BrowserGlobalsItem" ID="BrowserGlobalsItem"></a>
988 <h2>BrowserGlobalsItem</h2>
989 <p>
990 Class implementing the data structure for browser globals items.
991 </p>
992 <h3>Derived from</h3>
993 BrowserClassAttributesItem
994 <h3>Class Attributes</h3>
995 <table>
996 <tr><td>None</td></tr>
997 </table>
998 <h3>Class Methods</h3>
999 <table>
1000 <tr><td>None</td></tr>
1001 </table>
1002 <h3>Methods</h3>
1003 <table>
1004 <tr>
1005 <td><a href="#BrowserGlobalsItem.__init__">BrowserGlobalsItem</a></td>
1006 <td>Constructor</td>
1007 </tr>
1008 </table>
1009 <h3>Static Methods</h3>
1010 <table>
1011 <tr><td>None</td></tr>
1012 </table>
1013 <a NAME="BrowserGlobalsItem.__init__" ID="BrowserGlobalsItem.__init__"></a>
1014 <h4>BrowserGlobalsItem (Constructor)</h4>
1015 <b>BrowserGlobalsItem</b>(<i>parent, attributes, text</i>)
1016 <p>
1017 Constructor
1018 </p><dl>
1019 <dt><i>parent</i></dt>
1020 <dd>
1021 parent item
1022 </dd><dt><i>attributes</i></dt>
1023 <dd>
1024 list of attributes
1025 </dd><dt><i>text</i></dt>
1026 <dd>
1027 text to be shown by this item (string)
1028 </dd>
1029 </dl>
1030 <div align="right"><a href="#top">Up</a></div>
1031 <hr /><hr />
1032 <a NAME="BrowserImportItem" ID="BrowserImportItem"></a>
1033 <h2>BrowserImportItem</h2>
1034 <p>
1035 Class implementing the data structure for browser imported module and
1036 imported names items.
1037 </p>
1038 <h3>Derived from</h3>
1039 BrowserItem
1040 <h3>Class Attributes</h3>
1041 <table>
1042 <tr><td>None</td></tr>
1043 </table>
1044 <h3>Class Methods</h3>
1045 <table>
1046 <tr><td>None</td></tr>
1047 </table>
1048 <h3>Methods</h3>
1049 <table>
1050 <tr>
1051 <td><a href="#BrowserImportItem.__init__">BrowserImportItem</a></td>
1052 <td>Constructor</td>
1053 </tr><tr>
1054 <td><a href="#BrowserImportItem.fileName">fileName</a></td>
1055 <td>Public method returning the filename.</td>
1056 </tr><tr>
1057 <td><a href="#BrowserImportItem.lessThan">lessThan</a></td>
1058 <td>Public method to check, if the item is less than the other one.</td>
1059 </tr><tr>
1060 <td><a href="#BrowserImportItem.lineno">lineno</a></td>
1061 <td>Public method returning the line number of the first import.</td>
1062 </tr><tr>
1063 <td><a href="#BrowserImportItem.linenos">linenos</a></td>
1064 <td>Public method returning the line numbers of all imports.</td>
1065 </tr>
1066 </table>
1067 <h3>Static Methods</h3>
1068 <table>
1069 <tr><td>None</td></tr>
1070 </table>
1071 <a NAME="BrowserImportItem.__init__" ID="BrowserImportItem.__init__"></a>
1072 <h4>BrowserImportItem (Constructor)</h4>
1073 <b>BrowserImportItem</b>(<i>parent, text, filename, lineNumbers, isModule=True</i>)
1074 <p>
1075 Constructor
1076 </p><dl>
1077 <dt><i>parent</i></dt>
1078 <dd>
1079 parent item
1080 </dd><dt><i>text</i></dt>
1081 <dd>
1082 text to be shown by this item (string)
1083 </dd><dt><i>filename</i></dt>
1084 <dd>
1085 name of the file (string)
1086 </dd><dt><i>lineNumbers</i></dt>
1087 <dd>
1088 list of line numbers of the import statement
1089 (list of integer)
1090 </dd><dt><i>isModule</i></dt>
1091 <dd>
1092 flag indicating a module item entry (boolean)
1093 </dd>
1094 </dl><a NAME="BrowserImportItem.fileName" ID="BrowserImportItem.fileName"></a>
1095 <h4>BrowserImportItem.fileName</h4>
1096 <b>fileName</b>(<i></i>)
1097 <p>
1098 Public method returning the filename.
1099 </p><dl>
1100 <dt>Returns:</dt>
1101 <dd>
1102 filename (string)
1103 </dd>
1104 </dl><a NAME="BrowserImportItem.lessThan" ID="BrowserImportItem.lessThan"></a>
1105 <h4>BrowserImportItem.lessThan</h4>
1106 <b>lessThan</b>(<i>other, column, order</i>)
1107 <p>
1108 Public method to check, if the item is less than the other one.
1109 </p><dl>
1110 <dt><i>other</i></dt>
1111 <dd>
1112 reference to item to compare against (BrowserItem)
1113 </dd><dt><i>column</i></dt>
1114 <dd>
1115 column number to use for the comparison (integer)
1116 </dd><dt><i>order</i></dt>
1117 <dd>
1118 sort order (Qt.SortOrder) (for special sorting)
1119 </dd>
1120 </dl><dl>
1121 <dt>Returns:</dt>
1122 <dd>
1123 true, if this item is less than other (boolean)
1124 </dd>
1125 </dl><a NAME="BrowserImportItem.lineno" ID="BrowserImportItem.lineno"></a>
1126 <h4>BrowserImportItem.lineno</h4>
1127 <b>lineno</b>(<i></i>)
1128 <p>
1129 Public method returning the line number of the first import.
1130 </p><dl>
1131 <dt>Returns:</dt>
1132 <dd>
1133 line number of the first import (integer)
1134 </dd>
1135 </dl><a NAME="BrowserImportItem.linenos" ID="BrowserImportItem.linenos"></a>
1136 <h4>BrowserImportItem.linenos</h4>
1137 <b>linenos</b>(<i></i>)
1138 <p>
1139 Public method returning the line numbers of all imports.
1140 </p><dl>
1141 <dt>Returns:</dt>
1142 <dd>
1143 line numbers of all imports (list of integers)
1144 </dd>
1145 </dl>
1146 <div align="right"><a href="#top">Up</a></div>
1147 <hr /><hr />
1148 <a NAME="BrowserImportsItem" ID="BrowserImportsItem"></a>
1149 <h2>BrowserImportsItem</h2>
1150 <p>
1151 Class implementing the data structure for browser import items.
1152 </p>
1153 <h3>Derived from</h3>
1154 BrowserItem
1155 <h3>Class Attributes</h3>
1156 <table>
1157 <tr><td>None</td></tr>
1158 </table>
1159 <h3>Class Methods</h3>
1160 <table>
1161 <tr><td>None</td></tr>
1162 </table>
1163 <h3>Methods</h3>
1164 <table>
1165 <tr>
1166 <td><a href="#BrowserImportsItem.__init__">BrowserImportsItem</a></td>
1167 <td>Constructor</td>
1168 </tr><tr>
1169 <td><a href="#BrowserImportsItem.lessThan">lessThan</a></td>
1170 <td>Public method to check, if the item is less than the other one.</td>
1171 </tr>
1172 </table>
1173 <h3>Static Methods</h3>
1174 <table>
1175 <tr><td>None</td></tr>
1176 </table>
1177 <a NAME="BrowserImportsItem.__init__" ID="BrowserImportsItem.__init__"></a>
1178 <h4>BrowserImportsItem (Constructor)</h4>
1179 <b>BrowserImportsItem</b>(<i>parent, text</i>)
1180 <p>
1181 Constructor
1182 </p><dl>
1183 <dt><i>parent</i></dt>
1184 <dd>
1185 parent item
1186 </dd><dt><i>text</i></dt>
1187 <dd>
1188 text to be shown by this item (string)
1189 </dd>
1190 </dl><a NAME="BrowserImportsItem.lessThan" ID="BrowserImportsItem.lessThan"></a>
1191 <h4>BrowserImportsItem.lessThan</h4>
1192 <b>lessThan</b>(<i>other, column, order</i>)
1193 <p>
1194 Public method to check, if the item is less than the other one.
1195 </p><dl>
1196 <dt><i>other</i></dt>
1197 <dd>
1198 reference to item to compare against (BrowserItem)
1199 </dd><dt><i>column</i></dt>
1200 <dd>
1201 column number to use for the comparison (integer)
1202 </dd><dt><i>order</i></dt>
1203 <dd>
1204 sort order (Qt.SortOrder) (for special sorting)
1205 </dd>
1206 </dl><dl>
1207 <dt>Returns:</dt>
1208 <dd>
1209 true, if this item is less than other (boolean)
1210 </dd>
1211 </dl>
1212 <div align="right"><a href="#top">Up</a></div>
1213 <hr /><hr />
1214 <a NAME="BrowserItem" ID="BrowserItem"></a>
1215 <h2>BrowserItem</h2>
1216 <p>
1217 Class implementing the data structure for browser items.
1218 </p>
1219 <h3>Derived from</h3>
1220 object
1221 <h3>Class Attributes</h3>
1222 <table>
1223 <tr><td>None</td></tr>
1224 </table>
1225 <h3>Class Methods</h3>
1226 <table>
1227 <tr><td>None</td></tr>
1228 </table>
1229 <h3>Methods</h3>
1230 <table>
1231 <tr>
1232 <td><a href="#BrowserItem.__init__">BrowserItem</a></td>
1233 <td>Constructor</td>
1234 </tr><tr>
1235 <td><a href="#BrowserItem.appendChild">appendChild</a></td>
1236 <td>Public method to add a child to this item.</td>
1237 </tr><tr>
1238 <td><a href="#BrowserItem.child">child</a></td>
1239 <td>Public method to get a child id.</td>
1240 </tr><tr>
1241 <td><a href="#BrowserItem.childCount">childCount</a></td>
1242 <td>Public method to get the number of available child items.</td>
1243 </tr><tr>
1244 <td><a href="#BrowserItem.children">children</a></td>
1245 <td>Public method to get the ids of all child items.</td>
1246 </tr><tr>
1247 <td><a href="#BrowserItem.columnCount">columnCount</a></td>
1248 <td>Public method to get the number of available data items.</td>
1249 </tr><tr>
1250 <td><a href="#BrowserItem.data">data</a></td>
1251 <td>Public method to get a specific data item.</td>
1252 </tr><tr>
1253 <td><a href="#BrowserItem.getIcon">getIcon</a></td>
1254 <td>Public method to get the items icon.</td>
1255 </tr><tr>
1256 <td><a href="#BrowserItem.isLazyPopulated">isLazyPopulated</a></td>
1257 <td>Public method to check, if this item should be populated lazyly.</td>
1258 </tr><tr>
1259 <td><a href="#BrowserItem.isPopulated">isPopulated</a></td>
1260 <td>Public method to chek, if this item is populated.</td>
1261 </tr><tr>
1262 <td><a href="#BrowserItem.isPublic">isPublic</a></td>
1263 <td>Public method returning the public visibility status.</td>
1264 </tr><tr>
1265 <td><a href="#BrowserItem.isSymlink">isSymlink</a></td>
1266 <td>Public method to check, if the items is a symbolic link.</td>
1267 </tr><tr>
1268 <td><a href="#BrowserItem.lessThan">lessThan</a></td>
1269 <td>Public method to check, if the item is less than the other one.</td>
1270 </tr><tr>
1271 <td><a href="#BrowserItem.parent">parent</a></td>
1272 <td>Public method to get the reference to the parent item.</td>
1273 </tr><tr>
1274 <td><a href="#BrowserItem.removeChild">removeChild</a></td>
1275 <td>Public method to remove a child.</td>
1276 </tr><tr>
1277 <td><a href="#BrowserItem.removeChildren">removeChildren</a></td>
1278 <td>Public method to remove all children.</td>
1279 </tr><tr>
1280 <td><a href="#BrowserItem.row">row</a></td>
1281 <td>Public method to get the row number of this item.</td>
1282 </tr><tr>
1283 <td><a href="#BrowserItem.type">type</a></td>
1284 <td>Public method to get the item type.</td>
1285 </tr>
1286 </table>
1287 <h3>Static Methods</h3>
1288 <table>
1289 <tr><td>None</td></tr>
1290 </table>
1291 <a NAME="BrowserItem.__init__" ID="BrowserItem.__init__"></a>
1292 <h4>BrowserItem (Constructor)</h4>
1293 <b>BrowserItem</b>(<i>parent, data</i>)
1294 <p>
1295 Constructor
1296 </p><dl>
1297 <dt><i>parent</i></dt>
1298 <dd>
1299 reference to the parent item
1300 </dd><dt><i>data</i></dt>
1301 <dd>
1302 single data of the item
1303 </dd>
1304 </dl><a NAME="BrowserItem.appendChild" ID="BrowserItem.appendChild"></a>
1305 <h4>BrowserItem.appendChild</h4>
1306 <b>appendChild</b>(<i>child</i>)
1307 <p>
1308 Public method to add a child to this item.
1309 </p><dl>
1310 <dt><i>child</i></dt>
1311 <dd>
1312 reference to the child item to add (BrowserItem)
1313 </dd>
1314 </dl><a NAME="BrowserItem.child" ID="BrowserItem.child"></a>
1315 <h4>BrowserItem.child</h4>
1316 <b>child</b>(<i>row</i>)
1317 <p>
1318 Public method to get a child id.
1319 </p><dl>
1320 <dt><i>row</i></dt>
1321 <dd>
1322 number of child to get the id of (integer)
1323 </dd>
1324 </dl><dl>
1325 <dt>Returns:</dt>
1326 <dd>
1327 reference to the child item (BrowserItem)
1328 </dd>
1329 </dl><a NAME="BrowserItem.childCount" ID="BrowserItem.childCount"></a>
1330 <h4>BrowserItem.childCount</h4>
1331 <b>childCount</b>(<i></i>)
1332 <p>
1333 Public method to get the number of available child items.
1334 </p><dl>
1335 <dt>Returns:</dt>
1336 <dd>
1337 number of child items (integer)
1338 </dd>
1339 </dl><a NAME="BrowserItem.children" ID="BrowserItem.children"></a>
1340 <h4>BrowserItem.children</h4>
1341 <b>children</b>(<i></i>)
1342 <p>
1343 Public method to get the ids of all child items.
1344 </p><dl>
1345 <dt>Returns:</dt>
1346 <dd>
1347 references to all child items (list of BrowserItem)
1348 </dd>
1349 </dl><a NAME="BrowserItem.columnCount" ID="BrowserItem.columnCount"></a>
1350 <h4>BrowserItem.columnCount</h4>
1351 <b>columnCount</b>(<i></i>)
1352 <p>
1353 Public method to get the number of available data items.
1354 </p><dl>
1355 <dt>Returns:</dt>
1356 <dd>
1357 number of data items (integer)
1358 </dd>
1359 </dl><a NAME="BrowserItem.data" ID="BrowserItem.data"></a>
1360 <h4>BrowserItem.data</h4>
1361 <b>data</b>(<i>column</i>)
1362 <p>
1363 Public method to get a specific data item.
1364 </p><dl>
1365 <dt><i>column</i></dt>
1366 <dd>
1367 number of the requested data item (integer)
1368 </dd>
1369 </dl><dl>
1370 <dt>Returns:</dt>
1371 <dd>
1372 stored data item
1373 </dd>
1374 </dl><a NAME="BrowserItem.getIcon" ID="BrowserItem.getIcon"></a>
1375 <h4>BrowserItem.getIcon</h4>
1376 <b>getIcon</b>(<i></i>)
1377 <p>
1378 Public method to get the items icon.
1379 </p><dl>
1380 <dt>Returns:</dt>
1381 <dd>
1382 the icon (QIcon)
1383 </dd>
1384 </dl><a NAME="BrowserItem.isLazyPopulated" ID="BrowserItem.isLazyPopulated"></a>
1385 <h4>BrowserItem.isLazyPopulated</h4>
1386 <b>isLazyPopulated</b>(<i></i>)
1387 <p>
1388 Public method to check, if this item should be populated lazyly.
1389 </p><dl>
1390 <dt>Returns:</dt>
1391 <dd>
1392 lazy population flag (boolean)
1393 </dd>
1394 </dl><a NAME="BrowserItem.isPopulated" ID="BrowserItem.isPopulated"></a>
1395 <h4>BrowserItem.isPopulated</h4>
1396 <b>isPopulated</b>(<i></i>)
1397 <p>
1398 Public method to chek, if this item is populated.
1399 </p><dl>
1400 <dt>Returns:</dt>
1401 <dd>
1402 population status (boolean)
1403 </dd>
1404 </dl><a NAME="BrowserItem.isPublic" ID="BrowserItem.isPublic"></a>
1405 <h4>BrowserItem.isPublic</h4>
1406 <b>isPublic</b>(<i></i>)
1407 <p>
1408 Public method returning the public visibility status.
1409 </p><dl>
1410 <dt>Returns:</dt>
1411 <dd>
1412 flag indicating public visibility (boolean)
1413 </dd>
1414 </dl><a NAME="BrowserItem.isSymlink" ID="BrowserItem.isSymlink"></a>
1415 <h4>BrowserItem.isSymlink</h4>
1416 <b>isSymlink</b>(<i></i>)
1417 <p>
1418 Public method to check, if the items is a symbolic link.
1419 </p><dl>
1420 <dt>Returns:</dt>
1421 <dd>
1422 flag indicating a symbolic link (boolean)
1423 </dd>
1424 </dl><a NAME="BrowserItem.lessThan" ID="BrowserItem.lessThan"></a>
1425 <h4>BrowserItem.lessThan</h4>
1426 <b>lessThan</b>(<i>other, column, order</i>)
1427 <p>
1428 Public method to check, if the item is less than the other one.
1429 </p><dl>
1430 <dt><i>other</i></dt>
1431 <dd>
1432 reference to item to compare against (BrowserItem)
1433 </dd><dt><i>column</i></dt>
1434 <dd>
1435 column number to use for the comparison (integer)
1436 </dd><dt><i>order</i></dt>
1437 <dd>
1438 sort order (Qt.SortOrder) (for special sorting)
1439 </dd>
1440 </dl><dl>
1441 <dt>Returns:</dt>
1442 <dd>
1443 true, if this item is less than other (boolean)
1444 </dd>
1445 </dl><a NAME="BrowserItem.parent" ID="BrowserItem.parent"></a>
1446 <h4>BrowserItem.parent</h4>
1447 <b>parent</b>(<i></i>)
1448 <p>
1449 Public method to get the reference to the parent item.
1450 </p><dl>
1451 <dt>Returns:</dt>
1452 <dd>
1453 reference to the parent item
1454 </dd>
1455 </dl><a NAME="BrowserItem.removeChild" ID="BrowserItem.removeChild"></a>
1456 <h4>BrowserItem.removeChild</h4>
1457 <b>removeChild</b>(<i>child</i>)
1458 <p>
1459 Public method to remove a child.
1460 </p><dl>
1461 <dt><i>child</i></dt>
1462 <dd>
1463 reference to the child to remove (BrowserItem)
1464 </dd>
1465 </dl><a NAME="BrowserItem.removeChildren" ID="BrowserItem.removeChildren"></a>
1466 <h4>BrowserItem.removeChildren</h4>
1467 <b>removeChildren</b>(<i></i>)
1468 <p>
1469 Public method to remove all children.
1470 </p><a NAME="BrowserItem.row" ID="BrowserItem.row"></a>
1471 <h4>BrowserItem.row</h4>
1472 <b>row</b>(<i></i>)
1473 <p>
1474 Public method to get the row number of this item.
1475 </p><dl>
1476 <dt>Returns:</dt>
1477 <dd>
1478 row number (integer)
1479 </dd>
1480 </dl><a NAME="BrowserItem.type" ID="BrowserItem.type"></a>
1481 <h4>BrowserItem.type</h4>
1482 <b>type</b>(<i></i>)
1483 <p>
1484 Public method to get the item type.
1485 </p><dl>
1486 <dt>Returns:</dt>
1487 <dd>
1488 type of the item
1489 </dd>
1490 </dl>
1491 <div align="right"><a href="#top">Up</a></div>
1492 <hr /><hr />
1493 <a NAME="BrowserMethodItem" ID="BrowserMethodItem"></a>
1494 <h2>BrowserMethodItem</h2>
1495 <p>
1496 Class implementing the data structure for browser method items.
1497 </p>
1498 <h3>Derived from</h3>
1499 BrowserItem
1500 <h3>Class Attributes</h3>
1501 <table>
1502 <tr><td>None</td></tr>
1503 </table>
1504 <h3>Class Methods</h3>
1505 <table>
1506 <tr><td>None</td></tr>
1507 </table>
1508 <h3>Methods</h3>
1509 <table>
1510 <tr>
1511 <td><a href="#BrowserMethodItem.__init__">BrowserMethodItem</a></td>
1512 <td>Constructor</td>
1513 </tr><tr>
1514 <td><a href="#BrowserMethodItem.boundaries">boundaries</a></td>
1515 <td>Public method returning the boundaries of the method definition.</td>
1516 </tr><tr>
1517 <td><a href="#BrowserMethodItem.fileName">fileName</a></td>
1518 <td>Public method returning the filename.</td>
1519 </tr><tr>
1520 <td><a href="#BrowserMethodItem.functionObject">functionObject</a></td>
1521 <td>Public method returning the function object.</td>
1522 </tr><tr>
1523 <td><a href="#BrowserMethodItem.isPublic">isPublic</a></td>
1524 <td>Public method returning the public visibility status.</td>
1525 </tr><tr>
1526 <td><a href="#BrowserMethodItem.lessThan">lessThan</a></td>
1527 <td>Public method to check, if the item is less than the other one.</td>
1528 </tr><tr>
1529 <td><a href="#BrowserMethodItem.lineno">lineno</a></td>
1530 <td>Public method returning the line number defining this object.</td>
1531 </tr><tr>
1532 <td><a href="#BrowserMethodItem.name">name</a></td>
1533 <td>Public method to return the name of the item.</td>
1534 </tr>
1535 </table>
1536 <h3>Static Methods</h3>
1537 <table>
1538 <tr><td>None</td></tr>
1539 </table>
1540 <a NAME="BrowserMethodItem.__init__" ID="BrowserMethodItem.__init__"></a>
1541 <h4>BrowserMethodItem (Constructor)</h4>
1542 <b>BrowserMethodItem</b>(<i>parent, fn, filename</i>)
1543 <p>
1544 Constructor
1545 </p><dl>
1546 <dt><i>parent</i></dt>
1547 <dd>
1548 parent item
1549 </dd><dt><i>fn</i></dt>
1550 <dd>
1551 Function object to be shown
1552 </dd><dt><i>filename</i></dt>
1553 <dd>
1554 filename of the file defining this class (string)
1555 </dd>
1556 </dl><a NAME="BrowserMethodItem.boundaries" ID="BrowserMethodItem.boundaries"></a>
1557 <h4>BrowserMethodItem.boundaries</h4>
1558 <b>boundaries</b>(<i></i>)
1559 <p>
1560 Public method returning the boundaries of the method definition.
1561 </p><dl>
1562 <dt>Returns:</dt>
1563 <dd>
1564 tuple with start end end line number (integer, integer)
1565 </dd>
1566 </dl><a NAME="BrowserMethodItem.fileName" ID="BrowserMethodItem.fileName"></a>
1567 <h4>BrowserMethodItem.fileName</h4>
1568 <b>fileName</b>(<i></i>)
1569 <p>
1570 Public method returning the filename.
1571 </p><dl>
1572 <dt>Returns:</dt>
1573 <dd>
1574 filename (string)
1575 </dd>
1576 </dl><a NAME="BrowserMethodItem.functionObject" ID="BrowserMethodItem.functionObject"></a>
1577 <h4>BrowserMethodItem.functionObject</h4>
1578 <b>functionObject</b>(<i></i>)
1579 <p>
1580 Public method returning the function object.
1581 </p><dl>
1582 <dt>Returns:</dt>
1583 <dd>
1584 reference to the function object
1585 </dd>
1586 </dl><a NAME="BrowserMethodItem.isPublic" ID="BrowserMethodItem.isPublic"></a>
1587 <h4>BrowserMethodItem.isPublic</h4>
1588 <b>isPublic</b>(<i></i>)
1589 <p>
1590 Public method returning the public visibility status.
1591 </p><dl>
1592 <dt>Returns:</dt>
1593 <dd>
1594 flag indicating public visibility (boolean)
1595 </dd>
1596 </dl><a NAME="BrowserMethodItem.lessThan" ID="BrowserMethodItem.lessThan"></a>
1597 <h4>BrowserMethodItem.lessThan</h4>
1598 <b>lessThan</b>(<i>other, column, order</i>)
1599 <p>
1600 Public method to check, if the item is less than the other one.
1601 </p><dl>
1602 <dt><i>other</i></dt>
1603 <dd>
1604 reference to item to compare against (BrowserItem)
1605 </dd><dt><i>column</i></dt>
1606 <dd>
1607 column number to use for the comparison (integer)
1608 </dd><dt><i>order</i></dt>
1609 <dd>
1610 sort order (Qt.SortOrder) (for special sorting)
1611 </dd>
1612 </dl><dl>
1613 <dt>Returns:</dt>
1614 <dd>
1615 true, if this item is less than other (boolean)
1616 </dd>
1617 </dl><a NAME="BrowserMethodItem.lineno" ID="BrowserMethodItem.lineno"></a>
1618 <h4>BrowserMethodItem.lineno</h4>
1619 <b>lineno</b>(<i></i>)
1620 <p>
1621 Public method returning the line number defining this object.
1622 </p><dl>
1623 <dt>Returns:</dt>
1624 <dd>
1625 line number defining the object (integer)
1626 </dd>
1627 </dl><a NAME="BrowserMethodItem.name" ID="BrowserMethodItem.name"></a>
1628 <h4>BrowserMethodItem.name</h4>
1629 <b>name</b>(<i></i>)
1630 <p>
1631 Public method to return the name of the item.
1632 </p><dl>
1633 <dt>Returns:</dt>
1634 <dd>
1635 name of the item (string)
1636 </dd>
1637 </dl>
1638 <div align="right"><a href="#top">Up</a></div>
1639 <hr /><hr />
1640 <a NAME="BrowserModel" ID="BrowserModel"></a>
1641 <h2>BrowserModel</h2>
1642 <p>
1643 Class implementing the browser model.
1644 </p>
1645 <h3>Derived from</h3>
1646 QAbstractItemModel
1647 <h3>Class Attributes</h3>
1648 <table>
1649 <tr><td>None</td></tr>
1650 </table>
1651 <h3>Class Methods</h3>
1652 <table>
1653 <tr><td>None</td></tr>
1654 </table>
1655 <h3>Methods</h3>
1656 <table>
1657 <tr>
1658 <td><a href="#BrowserModel.__init__">BrowserModel</a></td>
1659 <td>Constructor</td>
1660 </tr><tr>
1661 <td><a href="#BrowserModel.__populateModel">__populateModel</a></td>
1662 <td>Private method to populate the browser model.</td>
1663 </tr><tr>
1664 <td><a href="#BrowserModel._addItem">_addItem</a></td>
1665 <td>Protected slot to add an item.</td>
1666 </tr><tr>
1667 <td><a href="#BrowserModel._addWatchedItem">_addWatchedItem</a></td>
1668 <td>Protected method to watch an item.</td>
1669 </tr><tr>
1670 <td><a href="#BrowserModel._removeWatchedItem">_removeWatchedItem</a></td>
1671 <td>Protected method to remove a watched item.</td>
1672 </tr><tr>
1673 <td><a href="#BrowserModel.addItem">addItem</a></td>
1674 <td>Public slot to add an item.</td>
1675 </tr><tr>
1676 <td><a href="#BrowserModel.addTopLevelDir">addTopLevelDir</a></td>
1677 <td>Public method to add a new toplevel directory.</td>
1678 </tr><tr>
1679 <td><a href="#BrowserModel.clear">clear</a></td>
1680 <td>Public method to clear the model.</td>
1681 </tr><tr>
1682 <td><a href="#BrowserModel.columnCount">columnCount</a></td>
1683 <td>Public method to get the number of columns.</td>
1684 </tr><tr>
1685 <td><a href="#BrowserModel.data">data</a></td>
1686 <td>Public method to get data of an item.</td>
1687 </tr><tr>
1688 <td><a href="#BrowserModel.directoryChanged">directoryChanged</a></td>
1689 <td>Public slot to handle the directoryChanged signal of the watcher.</td>
1690 </tr><tr>
1691 <td><a href="#BrowserModel.flags">flags</a></td>
1692 <td>Public method to get the item flags.</td>
1693 </tr><tr>
1694 <td><a href="#BrowserModel.hasChildren">hasChildren</a></td>
1695 <td>Public method to check for the presence of child items.</td>
1696 </tr><tr>
1697 <td><a href="#BrowserModel.headerData">headerData</a></td>
1698 <td>Public method to get the header data.</td>
1699 </tr><tr>
1700 <td><a href="#BrowserModel.index">index</a></td>
1701 <td>Public method to create an index.</td>
1702 </tr><tr>
1703 <td><a href="#BrowserModel.interpreterChanged">interpreterChanged</a></td>
1704 <td>Public method to handle a change of the debug client's interpreter.</td>
1705 </tr><tr>
1706 <td><a href="#BrowserModel.item">item</a></td>
1707 <td>Public method to get a reference to an item.</td>
1708 </tr><tr>
1709 <td><a href="#BrowserModel.parent">parent</a></td>
1710 <td>Public method to get the index of the parent object.</td>
1711 </tr><tr>
1712 <td><a href="#BrowserModel.populateClassAttributesItem">populateClassAttributesItem</a></td>
1713 <td>Public method to populate a class attributes item's subtree.</td>
1714 </tr><tr>
1715 <td><a href="#BrowserModel.populateClassItem">populateClassItem</a></td>
1716 <td>Public method to populate a class item's subtree.</td>
1717 </tr><tr>
1718 <td><a href="#BrowserModel.populateDirectoryItem">populateDirectoryItem</a></td>
1719 <td>Public method to populate a directory item's subtree.</td>
1720 </tr><tr>
1721 <td><a href="#BrowserModel.populateFileItem">populateFileItem</a></td>
1722 <td>Public method to populate a file item's subtree.</td>
1723 </tr><tr>
1724 <td><a href="#BrowserModel.populateItem">populateItem</a></td>
1725 <td>Public method to populate an item's subtree.</td>
1726 </tr><tr>
1727 <td><a href="#BrowserModel.populateMethodItem">populateMethodItem</a></td>
1728 <td>Public method to populate a method item's subtree.</td>
1729 </tr><tr>
1730 <td><a href="#BrowserModel.populateSysPathItem">populateSysPathItem</a></td>
1731 <td>Public method to populate a sys.path item's subtree.</td>
1732 </tr><tr>
1733 <td><a href="#BrowserModel.programChange">programChange</a></td>
1734 <td>Public method to change the entry for the directory of file being debugged.</td>
1735 </tr><tr>
1736 <td><a href="#BrowserModel.removeToplevelDir">removeToplevelDir</a></td>
1737 <td>Public method to remove a toplevel directory.</td>
1738 </tr><tr>
1739 <td><a href="#BrowserModel.rowCount">rowCount</a></td>
1740 <td>Public method to get the number of rows.</td>
1741 </tr><tr>
1742 <td><a href="#BrowserModel.saveToplevelDirs">saveToplevelDirs</a></td>
1743 <td>Public slot to save the toplevel directories.</td>
1744 </tr>
1745 </table>
1746 <h3>Static Methods</h3>
1747 <table>
1748 <tr><td>None</td></tr>
1749 </table>
1750 <a NAME="BrowserModel.__init__" ID="BrowserModel.__init__"></a>
1751 <h4>BrowserModel (Constructor)</h4>
1752 <b>BrowserModel</b>(<i>parent=None, nopopulate=False</i>)
1753 <p>
1754 Constructor
1755 </p><dl>
1756 <dt><i>parent</i></dt>
1757 <dd>
1758 reference to parent object (QObject)
1759 </dd><dt><i>nopopulate=</i></dt>
1760 <dd>
1761 flag indicating to not populate the model
1762 (boolean)
1763 </dd>
1764 </dl><a NAME="BrowserModel.__populateModel" ID="BrowserModel.__populateModel"></a>
1765 <h4>BrowserModel.__populateModel</h4>
1766 <b>__populateModel</b>(<i></i>)
1767 <p>
1768 Private method to populate the browser model.
1769 </p><a NAME="BrowserModel._addItem" ID="BrowserModel._addItem"></a>
1770 <h4>BrowserModel._addItem</h4>
1771 <b>_addItem</b>(<i>itm, parentItem</i>)
1772 <p>
1773 Protected slot to add an item.
1774 </p><dl>
1775 <dt><i>itm</i></dt>
1776 <dd>
1777 reference to item to add (BrowserItem)
1778 </dd><dt><i>parentItem</i></dt>
1779 <dd>
1780 reference to item to add to (BrowserItem)
1781 </dd>
1782 </dl><a NAME="BrowserModel._addWatchedItem" ID="BrowserModel._addWatchedItem"></a>
1783 <h4>BrowserModel._addWatchedItem</h4>
1784 <b>_addWatchedItem</b>(<i>itm</i>)
1785 <p>
1786 Protected method to watch an item.
1787 </p><dl>
1788 <dt><i>itm</i></dt>
1789 <dd>
1790 item to be watched (BrowserDirectoryItem)
1791 </dd>
1792 </dl><a NAME="BrowserModel._removeWatchedItem" ID="BrowserModel._removeWatchedItem"></a>
1793 <h4>BrowserModel._removeWatchedItem</h4>
1794 <b>_removeWatchedItem</b>(<i>itm</i>)
1795 <p>
1796 Protected method to remove a watched item.
1797 </p><dl>
1798 <dt><i>itm</i></dt>
1799 <dd>
1800 item to be removed (BrowserDirectoryItem)
1801 </dd>
1802 </dl><a NAME="BrowserModel.addItem" ID="BrowserModel.addItem"></a>
1803 <h4>BrowserModel.addItem</h4>
1804 <b>addItem</b>(<i>itm, parent=None</i>)
1805 <p>
1806 Public slot to add an item.
1807 </p><dl>
1808 <dt><i>itm</i></dt>
1809 <dd>
1810 item to add (BrowserItem)
1811 </dd><dt><i>parent</i></dt>
1812 <dd>
1813 index of parent item (QModelIndex)
1814 </dd>
1815 </dl><a NAME="BrowserModel.addTopLevelDir" ID="BrowserModel.addTopLevelDir"></a>
1816 <h4>BrowserModel.addTopLevelDir</h4>
1817 <b>addTopLevelDir</b>(<i>dirname</i>)
1818 <p>
1819 Public method to add a new toplevel directory.
1820 </p><dl>
1821 <dt><i>dirname</i></dt>
1822 <dd>
1823 name of the new toplevel directory (string)
1824 </dd>
1825 </dl><a NAME="BrowserModel.clear" ID="BrowserModel.clear"></a>
1826 <h4>BrowserModel.clear</h4>
1827 <b>clear</b>(<i></i>)
1828 <p>
1829 Public method to clear the model.
1830 </p><a NAME="BrowserModel.columnCount" ID="BrowserModel.columnCount"></a>
1831 <h4>BrowserModel.columnCount</h4>
1832 <b>columnCount</b>(<i>parent=None</i>)
1833 <p>
1834 Public method to get the number of columns.
1835 </p><dl>
1836 <dt><i>parent</i></dt>
1837 <dd>
1838 index of parent item (QModelIndex)
1839 </dd>
1840 </dl><dl>
1841 <dt>Returns:</dt>
1842 <dd>
1843 number of columns (integer)
1844 </dd>
1845 </dl><a NAME="BrowserModel.data" ID="BrowserModel.data"></a>
1846 <h4>BrowserModel.data</h4>
1847 <b>data</b>(<i>index, role</i>)
1848 <p>
1849 Public method to get data of an item.
1850 </p><dl>
1851 <dt><i>index</i></dt>
1852 <dd>
1853 index of the data to retrieve (QModelIndex)
1854 </dd><dt><i>role</i></dt>
1855 <dd>
1856 role of data (Qt.ItemDataRole)
1857 </dd>
1858 </dl><dl>
1859 <dt>Returns:</dt>
1860 <dd>
1861 requested data
1862 </dd>
1863 </dl><a NAME="BrowserModel.directoryChanged" ID="BrowserModel.directoryChanged"></a>
1864 <h4>BrowserModel.directoryChanged</h4>
1865 <b>directoryChanged</b>(<i>path</i>)
1866 <p>
1867 Public slot to handle the directoryChanged signal of the watcher.
1868 </p><dl>
1869 <dt><i>path</i></dt>
1870 <dd>
1871 path of the directory (string)
1872 </dd>
1873 </dl><a NAME="BrowserModel.flags" ID="BrowserModel.flags"></a>
1874 <h4>BrowserModel.flags</h4>
1875 <b>flags</b>(<i>index</i>)
1876 <p>
1877 Public method to get the item flags.
1878 </p><dl>
1879 <dt><i>index</i></dt>
1880 <dd>
1881 index of the data to retrieve (QModelIndex)
1882 </dd>
1883 </dl><dl>
1884 <dt>Returns:</dt>
1885 <dd>
1886 requested flags (Qt.ItemFlags)
1887 </dd>
1888 </dl><a NAME="BrowserModel.hasChildren" ID="BrowserModel.hasChildren"></a>
1889 <h4>BrowserModel.hasChildren</h4>
1890 <b>hasChildren</b>(<i>parent=None</i>)
1891 <p>
1892 Public method to check for the presence of child items.
1893 </p><p>
1894 We always return True for normal items in order to do lazy
1895 population of the tree.
1896 </p><dl>
1897 <dt><i>parent</i></dt>
1898 <dd>
1899 index of parent item (QModelIndex)
1900 </dd>
1901 </dl><dl>
1902 <dt>Returns:</dt>
1903 <dd>
1904 flag indicating the presence of child items (boolean)
1905 </dd>
1906 </dl><a NAME="BrowserModel.headerData" ID="BrowserModel.headerData"></a>
1907 <h4>BrowserModel.headerData</h4>
1908 <b>headerData</b>(<i>section, orientation, role=Qt.DisplayRole</i>)
1909 <p>
1910 Public method to get the header data.
1911 </p><dl>
1912 <dt><i>section</i></dt>
1913 <dd>
1914 number of section to get data for (integer)
1915 </dd><dt><i>orientation</i></dt>
1916 <dd>
1917 header orientation (Qt.Orientation)
1918 </dd><dt><i>role</i></dt>
1919 <dd>
1920 role of data (Qt.ItemDataRole)
1921 </dd>
1922 </dl><dl>
1923 <dt>Returns:</dt>
1924 <dd>
1925 requested header data
1926 </dd>
1927 </dl><a NAME="BrowserModel.index" ID="BrowserModel.index"></a>
1928 <h4>BrowserModel.index</h4>
1929 <b>index</b>(<i>row, column, parent=None</i>)
1930 <p>
1931 Public method to create an index.
1932 </p><dl>
1933 <dt><i>row</i></dt>
1934 <dd>
1935 row number of the new index (integer)
1936 </dd><dt><i>column</i></dt>
1937 <dd>
1938 column number of the new index (integer)
1939 </dd><dt><i>parent</i></dt>
1940 <dd>
1941 index of parent item (QModelIndex)
1942 </dd>
1943 </dl><dl>
1944 <dt>Returns:</dt>
1945 <dd>
1946 index object (QModelIndex)
1947 </dd>
1948 </dl><a NAME="BrowserModel.interpreterChanged" ID="BrowserModel.interpreterChanged"></a>
1949 <h4>BrowserModel.interpreterChanged</h4>
1950 <b>interpreterChanged</b>(<i>interpreter</i>)
1951 <p>
1952 Public method to handle a change of the debug client's interpreter.
1953 </p><dl>
1954 <dt><i>interpreter</i></dt>
1955 <dd>
1956 interpreter of the debug client (string)
1957 </dd>
1958 </dl><a NAME="BrowserModel.item" ID="BrowserModel.item"></a>
1959 <h4>BrowserModel.item</h4>
1960 <b>item</b>(<i>index</i>)
1961 <p>
1962 Public method to get a reference to an item.
1963 </p><dl>
1964 <dt><i>index</i></dt>
1965 <dd>
1966 index of the data to retrieve (QModelIndex)
1967 </dd>
1968 </dl><dl>
1969 <dt>Returns:</dt>
1970 <dd>
1971 requested item reference (BrowserItem)
1972 </dd>
1973 </dl><a NAME="BrowserModel.parent" ID="BrowserModel.parent"></a>
1974 <h4>BrowserModel.parent</h4>
1975 <b>parent</b>(<i>index</i>)
1976 <p>
1977 Public method to get the index of the parent object.
1978 </p><dl>
1979 <dt><i>index</i></dt>
1980 <dd>
1981 index of the item (QModelIndex)
1982 </dd>
1983 </dl><dl>
1984 <dt>Returns:</dt>
1985 <dd>
1986 index of parent item (QModelIndex)
1987 </dd>
1988 </dl><a NAME="BrowserModel.populateClassAttributesItem" ID="BrowserModel.populateClassAttributesItem"></a>
1989 <h4>BrowserModel.populateClassAttributesItem</h4>
1990 <b>populateClassAttributesItem</b>(<i>parentItem, repopulate=False</i>)
1991 <p>
1992 Public method to populate a class attributes item's subtree.
1993 </p><dl>
1994 <dt><i>parentItem</i></dt>
1995 <dd>
1996 reference to the class attributes item to be
1997 populated
1998 </dd><dt><i>repopulate</i></dt>
1999 <dd>
2000 flag indicating a repopulation (boolean)
2001 </dd>
2002 </dl><a NAME="BrowserModel.populateClassItem" ID="BrowserModel.populateClassItem"></a>
2003 <h4>BrowserModel.populateClassItem</h4>
2004 <b>populateClassItem</b>(<i>parentItem, repopulate=False</i>)
2005 <p>
2006 Public method to populate a class item's subtree.
2007 </p><dl>
2008 <dt><i>parentItem</i></dt>
2009 <dd>
2010 reference to the class item to be populated
2011 </dd><dt><i>repopulate</i></dt>
2012 <dd>
2013 flag indicating a repopulation (boolean)
2014 </dd>
2015 </dl><a NAME="BrowserModel.populateDirectoryItem" ID="BrowserModel.populateDirectoryItem"></a>
2016 <h4>BrowserModel.populateDirectoryItem</h4>
2017 <b>populateDirectoryItem</b>(<i>parentItem, repopulate=False</i>)
2018 <p>
2019 Public method to populate a directory item's subtree.
2020 </p><dl>
2021 <dt><i>parentItem</i></dt>
2022 <dd>
2023 reference to the directory item to be populated
2024 </dd><dt><i>repopulate</i></dt>
2025 <dd>
2026 flag indicating a repopulation (boolean)
2027 </dd>
2028 </dl><a NAME="BrowserModel.populateFileItem" ID="BrowserModel.populateFileItem"></a>
2029 <h4>BrowserModel.populateFileItem</h4>
2030 <b>populateFileItem</b>(<i>parentItem, repopulate=False</i>)
2031 <p>
2032 Public method to populate a file item's subtree.
2033 </p><dl>
2034 <dt><i>parentItem</i></dt>
2035 <dd>
2036 reference to the file item to be populated
2037 </dd><dt><i>repopulate</i></dt>
2038 <dd>
2039 flag indicating a repopulation (boolean)
2040 </dd>
2041 </dl><a NAME="BrowserModel.populateItem" ID="BrowserModel.populateItem"></a>
2042 <h4>BrowserModel.populateItem</h4>
2043 <b>populateItem</b>(<i>parentItem, repopulate=False</i>)
2044 <p>
2045 Public method to populate an item's subtree.
2046 </p><dl>
2047 <dt><i>parentItem</i></dt>
2048 <dd>
2049 reference to the item to be populated
2050 </dd><dt><i>repopulate</i></dt>
2051 <dd>
2052 flag indicating a repopulation (boolean)
2053 </dd>
2054 </dl><a NAME="BrowserModel.populateMethodItem" ID="BrowserModel.populateMethodItem"></a>
2055 <h4>BrowserModel.populateMethodItem</h4>
2056 <b>populateMethodItem</b>(<i>parentItem, repopulate=False</i>)
2057 <p>
2058 Public method to populate a method item's subtree.
2059 </p><dl>
2060 <dt><i>parentItem</i></dt>
2061 <dd>
2062 reference to the method item to be populated
2063 </dd><dt><i>repopulate</i></dt>
2064 <dd>
2065 flag indicating a repopulation (boolean)
2066 </dd>
2067 </dl><a NAME="BrowserModel.populateSysPathItem" ID="BrowserModel.populateSysPathItem"></a>
2068 <h4>BrowserModel.populateSysPathItem</h4>
2069 <b>populateSysPathItem</b>(<i>parentItem, repopulate=False</i>)
2070 <p>
2071 Public method to populate a sys.path item's subtree.
2072 </p><dl>
2073 <dt><i>parentItem</i></dt>
2074 <dd>
2075 reference to the sys.path item to be populated
2076 </dd><dt><i>repopulate</i></dt>
2077 <dd>
2078 flag indicating a repopulation (boolean)
2079 </dd>
2080 </dl><a NAME="BrowserModel.programChange" ID="BrowserModel.programChange"></a>
2081 <h4>BrowserModel.programChange</h4>
2082 <b>programChange</b>(<i>dirname</i>)
2083 <p>
2084 Public method to change the entry for the directory of file being
2085 debugged.
2086 </p><dl>
2087 <dt><i>dirname</i></dt>
2088 <dd>
2089 name of the directory containing the file (string)
2090 </dd>
2091 </dl><a NAME="BrowserModel.removeToplevelDir" ID="BrowserModel.removeToplevelDir"></a>
2092 <h4>BrowserModel.removeToplevelDir</h4>
2093 <b>removeToplevelDir</b>(<i>index</i>)
2094 <p>
2095 Public method to remove a toplevel directory.
2096 </p><dl>
2097 <dt><i>index</i></dt>
2098 <dd>
2099 index of the toplevel directory to be removed
2100 (QModelIndex)
2101 </dd>
2102 </dl><a NAME="BrowserModel.rowCount" ID="BrowserModel.rowCount"></a>
2103 <h4>BrowserModel.rowCount</h4>
2104 <b>rowCount</b>(<i>parent=None</i>)
2105 <p>
2106 Public method to get the number of rows.
2107 </p><dl>
2108 <dt><i>parent</i></dt>
2109 <dd>
2110 index of parent item (QModelIndex)
2111 </dd>
2112 </dl><dl>
2113 <dt>Returns:</dt>
2114 <dd>
2115 number of rows (integer)
2116 </dd>
2117 </dl><a NAME="BrowserModel.saveToplevelDirs" ID="BrowserModel.saveToplevelDirs"></a>
2118 <h4>BrowserModel.saveToplevelDirs</h4>
2119 <b>saveToplevelDirs</b>(<i></i>)
2120 <p>
2121 Public slot to save the toplevel directories.
2122 </p>
2123 <div align="right"><a href="#top">Up</a></div>
2124 <hr /><hr />
2125 <a NAME="BrowserSysPathItem" ID="BrowserSysPathItem"></a>
2126 <h2>BrowserSysPathItem</h2>
2127 <p>
2128 Class implementing the data structure for browser sys.path items.
2129 </p>
2130 <h3>Derived from</h3>
2131 BrowserItem
2132 <h3>Class Attributes</h3>
2133 <table>
2134 <tr><td>None</td></tr>
2135 </table>
2136 <h3>Class Methods</h3>
2137 <table>
2138 <tr><td>None</td></tr>
2139 </table>
2140 <h3>Methods</h3>
2141 <table>
2142 <tr>
2143 <td><a href="#BrowserSysPathItem.__init__">BrowserSysPathItem</a></td>
2144 <td>Constructor</td>
2145 </tr><tr>
2146 <td><a href="#BrowserSysPathItem.name">name</a></td>
2147 <td>Public method to return the name of the item.</td>
2148 </tr>
2149 </table>
2150 <h3>Static Methods</h3>
2151 <table>
2152 <tr><td>None</td></tr>
2153 </table>
2154 <a NAME="BrowserSysPathItem.__init__" ID="BrowserSysPathItem.__init__"></a>
2155 <h4>BrowserSysPathItem (Constructor)</h4>
2156 <b>BrowserSysPathItem</b>(<i>parent</i>)
2157 <p>
2158 Constructor
2159 </p><dl>
2160 <dt><i>parent</i></dt>
2161 <dd>
2162 parent item
2163 </dd>
2164 </dl><a NAME="BrowserSysPathItem.name" ID="BrowserSysPathItem.name"></a>
2165 <h4>BrowserSysPathItem.name</h4>
2166 <b>name</b>(<i></i>)
2167 <p>
2168 Public method to return the name of the item.
2169 </p><dl>
2170 <dt>Returns:</dt>
2171 <dd>
2172 name of the item (string)
2173 </dd>
2174 </dl>
2175 <div align="right"><a href="#top">Up</a></div>
2176 <hr />
2177 </body></html>

eric ide

mercurial