|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.UI.BrowserModel</title> |
|
4 <meta charset="UTF-8"> |
|
5 <link rel="stylesheet" href="styles.css"> |
|
6 </head> |
|
7 <body> |
|
8 <a NAME="top" ID="top"></a> |
|
9 <h1>eric7.UI.BrowserModel</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing the browser model. |
|
13 </p> |
|
14 <h3>Global Attributes</h3> |
|
15 |
|
16 <table> |
|
17 <tr><td>BrowserItemAttribute</td></tr><tr><td>BrowserItemAttributes</td></tr><tr><td>BrowserItemClass</td></tr><tr><td>BrowserItemCoding</td></tr><tr><td>BrowserItemDirectory</td></tr><tr><td>BrowserItemFile</td></tr><tr><td>BrowserItemImport</td></tr><tr><td>BrowserItemImports</td></tr><tr><td>BrowserItemMethod</td></tr><tr><td>BrowserItemRoot</td></tr><tr><td>BrowserItemSysPath</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 |
|
21 <table> |
|
22 |
|
23 <tr> |
|
24 <td><a href="#BrowserClassAttributeItem">BrowserClassAttributeItem</a></td> |
|
25 <td>Class implementing the data structure for browser class attribute items.</td> |
|
26 </tr> |
|
27 <tr> |
|
28 <td><a href="#BrowserClassAttributesItem">BrowserClassAttributesItem</a></td> |
|
29 <td>Class implementing the data structure for browser class attributes items.</td> |
|
30 </tr> |
|
31 <tr> |
|
32 <td><a href="#BrowserClassItem">BrowserClassItem</a></td> |
|
33 <td>Class implementing the data structure for browser class items.</td> |
|
34 </tr> |
|
35 <tr> |
|
36 <td><a href="#BrowserCodingItem">BrowserCodingItem</a></td> |
|
37 <td>Class implementing the data structure for browser coding items.</td> |
|
38 </tr> |
|
39 <tr> |
|
40 <td><a href="#BrowserDirectoryItem">BrowserDirectoryItem</a></td> |
|
41 <td>Class implementing the data structure for browser directory items.</td> |
|
42 </tr> |
|
43 <tr> |
|
44 <td><a href="#BrowserFileItem">BrowserFileItem</a></td> |
|
45 <td>Class implementing the data structure for browser file items.</td> |
|
46 </tr> |
|
47 <tr> |
|
48 <td><a href="#BrowserGlobalsItem">BrowserGlobalsItem</a></td> |
|
49 <td>Class implementing the data structure for browser globals items.</td> |
|
50 </tr> |
|
51 <tr> |
|
52 <td><a href="#BrowserImportItem">BrowserImportItem</a></td> |
|
53 <td>Class implementing the data structure for browser imported module and imported names items.</td> |
|
54 </tr> |
|
55 <tr> |
|
56 <td><a href="#BrowserImportsItem">BrowserImportsItem</a></td> |
|
57 <td>Class implementing the data structure for browser import items.</td> |
|
58 </tr> |
|
59 <tr> |
|
60 <td><a href="#BrowserItem">BrowserItem</a></td> |
|
61 <td>Class implementing the data structure for browser items.</td> |
|
62 </tr> |
|
63 <tr> |
|
64 <td><a href="#BrowserMethodItem">BrowserMethodItem</a></td> |
|
65 <td>Class implementing the data structure for browser method items.</td> |
|
66 </tr> |
|
67 <tr> |
|
68 <td><a href="#BrowserModel">BrowserModel</a></td> |
|
69 <td>Class implementing the browser model.</td> |
|
70 </tr> |
|
71 <tr> |
|
72 <td><a href="#BrowserSysPathItem">BrowserSysPathItem</a></td> |
|
73 <td>Class implementing the data structure for browser sys.path items.</td> |
|
74 </tr> |
|
75 </table> |
|
76 <h3>Functions</h3> |
|
77 |
|
78 <table> |
|
79 <tr><td>None</td></tr> |
|
80 </table> |
|
81 <hr /> |
|
82 <hr /> |
|
83 <a NAME="BrowserClassAttributeItem" ID="BrowserClassAttributeItem"></a> |
|
84 <h2>BrowserClassAttributeItem</h2> |
|
85 |
|
86 <p> |
|
87 Class implementing the data structure for browser class attribute items. |
|
88 </p> |
|
89 <h3>Derived from</h3> |
|
90 BrowserItem |
|
91 <h3>Class Attributes</h3> |
|
92 |
|
93 <table> |
|
94 <tr><td>None</td></tr> |
|
95 </table> |
|
96 <h3>Class Methods</h3> |
|
97 |
|
98 <table> |
|
99 <tr><td>None</td></tr> |
|
100 </table> |
|
101 <h3>Methods</h3> |
|
102 |
|
103 <table> |
|
104 |
|
105 <tr> |
|
106 <td><a href="#BrowserClassAttributeItem.__init__">BrowserClassAttributeItem</a></td> |
|
107 <td>Constructor</td> |
|
108 </tr> |
|
109 <tr> |
|
110 <td><a href="#BrowserClassAttributeItem.attributeObject">attributeObject</a></td> |
|
111 <td>Public method returning the class object.</td> |
|
112 </tr> |
|
113 <tr> |
|
114 <td><a href="#BrowserClassAttributeItem.fileName">fileName</a></td> |
|
115 <td>Public method returning the filename.</td> |
|
116 </tr> |
|
117 <tr> |
|
118 <td><a href="#BrowserClassAttributeItem.isPublic">isPublic</a></td> |
|
119 <td>Public method returning the public visibility status.</td> |
|
120 </tr> |
|
121 <tr> |
|
122 <td><a href="#BrowserClassAttributeItem.lessThan">lessThan</a></td> |
|
123 <td>Public method to check, if the item is less than the other one.</td> |
|
124 </tr> |
|
125 <tr> |
|
126 <td><a href="#BrowserClassAttributeItem.lineno">lineno</a></td> |
|
127 <td>Public method returning the line number defining this object.</td> |
|
128 </tr> |
|
129 <tr> |
|
130 <td><a href="#BrowserClassAttributeItem.linenos">linenos</a></td> |
|
131 <td>Public method returning the line numbers this object is assigned to.</td> |
|
132 </tr> |
|
133 </table> |
|
134 <h3>Static Methods</h3> |
|
135 |
|
136 <table> |
|
137 <tr><td>None</td></tr> |
|
138 </table> |
|
139 |
|
140 <a NAME="BrowserClassAttributeItem.__init__" ID="BrowserClassAttributeItem.__init__"></a> |
|
141 <h4>BrowserClassAttributeItem (Constructor)</h4> |
|
142 <b>BrowserClassAttributeItem</b>(<i>parent, attribute, isClass=False</i>) |
|
143 |
|
144 <p> |
|
145 Constructor |
|
146 </p> |
|
147 <dl> |
|
148 |
|
149 <dt><i>parent</i></dt> |
|
150 <dd> |
|
151 parent item |
|
152 </dd> |
|
153 <dt><i>attribute</i></dt> |
|
154 <dd> |
|
155 reference to the attribute object |
|
156 </dd> |
|
157 <dt><i>isClass</i></dt> |
|
158 <dd> |
|
159 flag indicating a class attribute (boolean) |
|
160 </dd> |
|
161 </dl> |
|
162 <a NAME="BrowserClassAttributeItem.attributeObject" ID="BrowserClassAttributeItem.attributeObject"></a> |
|
163 <h4>BrowserClassAttributeItem.attributeObject</h4> |
|
164 <b>attributeObject</b>(<i></i>) |
|
165 |
|
166 <p> |
|
167 Public method returning the class object. |
|
168 </p> |
|
169 <dl> |
|
170 <dt>Return:</dt> |
|
171 <dd> |
|
172 reference to the class object |
|
173 </dd> |
|
174 </dl> |
|
175 <a NAME="BrowserClassAttributeItem.fileName" ID="BrowserClassAttributeItem.fileName"></a> |
|
176 <h4>BrowserClassAttributeItem.fileName</h4> |
|
177 <b>fileName</b>(<i></i>) |
|
178 |
|
179 <p> |
|
180 Public method returning the filename. |
|
181 </p> |
|
182 <dl> |
|
183 <dt>Return:</dt> |
|
184 <dd> |
|
185 filename (string) |
|
186 </dd> |
|
187 </dl> |
|
188 <a NAME="BrowserClassAttributeItem.isPublic" ID="BrowserClassAttributeItem.isPublic"></a> |
|
189 <h4>BrowserClassAttributeItem.isPublic</h4> |
|
190 <b>isPublic</b>(<i></i>) |
|
191 |
|
192 <p> |
|
193 Public method returning the public visibility status. |
|
194 </p> |
|
195 <dl> |
|
196 <dt>Return:</dt> |
|
197 <dd> |
|
198 flag indicating public visibility (boolean) |
|
199 </dd> |
|
200 </dl> |
|
201 <a NAME="BrowserClassAttributeItem.lessThan" ID="BrowserClassAttributeItem.lessThan"></a> |
|
202 <h4>BrowserClassAttributeItem.lessThan</h4> |
|
203 <b>lessThan</b>(<i>other, column, order</i>) |
|
204 |
|
205 <p> |
|
206 Public method to check, if the item is less than the other one. |
|
207 </p> |
|
208 <dl> |
|
209 |
|
210 <dt><i>other</i></dt> |
|
211 <dd> |
|
212 reference to item to compare against (BrowserItem) |
|
213 </dd> |
|
214 <dt><i>column</i></dt> |
|
215 <dd> |
|
216 column number to use for the comparison (integer) |
|
217 </dd> |
|
218 <dt><i>order</i></dt> |
|
219 <dd> |
|
220 sort order (Qt.SortOrder) (for special sorting) |
|
221 </dd> |
|
222 </dl> |
|
223 <dl> |
|
224 <dt>Return:</dt> |
|
225 <dd> |
|
226 true, if this item is less than other (boolean) |
|
227 </dd> |
|
228 </dl> |
|
229 <a NAME="BrowserClassAttributeItem.lineno" ID="BrowserClassAttributeItem.lineno"></a> |
|
230 <h4>BrowserClassAttributeItem.lineno</h4> |
|
231 <b>lineno</b>(<i></i>) |
|
232 |
|
233 <p> |
|
234 Public method returning the line number defining this object. |
|
235 </p> |
|
236 <dl> |
|
237 <dt>Return:</dt> |
|
238 <dd> |
|
239 line number defining the object (integer) |
|
240 </dd> |
|
241 </dl> |
|
242 <a NAME="BrowserClassAttributeItem.linenos" ID="BrowserClassAttributeItem.linenos"></a> |
|
243 <h4>BrowserClassAttributeItem.linenos</h4> |
|
244 <b>linenos</b>(<i></i>) |
|
245 |
|
246 <p> |
|
247 Public method returning the line numbers this object is assigned to. |
|
248 </p> |
|
249 <dl> |
|
250 <dt>Return:</dt> |
|
251 <dd> |
|
252 line number the object is assigned to (list of integers) |
|
253 </dd> |
|
254 </dl> |
|
255 <div align="right"><a href="#top">Up</a></div> |
|
256 <hr /> |
|
257 <hr /> |
|
258 <a NAME="BrowserClassAttributesItem" ID="BrowserClassAttributesItem"></a> |
|
259 <h2>BrowserClassAttributesItem</h2> |
|
260 |
|
261 <p> |
|
262 Class implementing the data structure for browser class attributes items. |
|
263 </p> |
|
264 <h3>Derived from</h3> |
|
265 BrowserItem |
|
266 <h3>Class Attributes</h3> |
|
267 |
|
268 <table> |
|
269 <tr><td>None</td></tr> |
|
270 </table> |
|
271 <h3>Class Methods</h3> |
|
272 |
|
273 <table> |
|
274 <tr><td>None</td></tr> |
|
275 </table> |
|
276 <h3>Methods</h3> |
|
277 |
|
278 <table> |
|
279 |
|
280 <tr> |
|
281 <td><a href="#BrowserClassAttributesItem.__init__">BrowserClassAttributesItem</a></td> |
|
282 <td>Constructor</td> |
|
283 </tr> |
|
284 <tr> |
|
285 <td><a href="#BrowserClassAttributesItem.attributes">attributes</a></td> |
|
286 <td>Public method returning the attribute list.</td> |
|
287 </tr> |
|
288 <tr> |
|
289 <td><a href="#BrowserClassAttributesItem.isClassAttributes">isClassAttributes</a></td> |
|
290 <td>Public method returning the attributes type.</td> |
|
291 </tr> |
|
292 <tr> |
|
293 <td><a href="#BrowserClassAttributesItem.lessThan">lessThan</a></td> |
|
294 <td>Public method to check, if the item is less than the other one.</td> |
|
295 </tr> |
|
296 <tr> |
|
297 <td><a href="#BrowserClassAttributesItem.name">name</a></td> |
|
298 <td>Public method to return the name of the item.</td> |
|
299 </tr> |
|
300 </table> |
|
301 <h3>Static Methods</h3> |
|
302 |
|
303 <table> |
|
304 <tr><td>None</td></tr> |
|
305 </table> |
|
306 |
|
307 <a NAME="BrowserClassAttributesItem.__init__" ID="BrowserClassAttributesItem.__init__"></a> |
|
308 <h4>BrowserClassAttributesItem (Constructor)</h4> |
|
309 <b>BrowserClassAttributesItem</b>(<i>parent, attributes, text, isClass=False</i>) |
|
310 |
|
311 <p> |
|
312 Constructor |
|
313 </p> |
|
314 <dl> |
|
315 |
|
316 <dt><i>parent</i></dt> |
|
317 <dd> |
|
318 parent item |
|
319 </dd> |
|
320 <dt><i>attributes</i></dt> |
|
321 <dd> |
|
322 list of attributes |
|
323 </dd> |
|
324 <dt><i>text</i></dt> |
|
325 <dd> |
|
326 text to be shown by this item (string) |
|
327 </dd> |
|
328 <dt><i>isClass</i></dt> |
|
329 <dd> |
|
330 flag indicating class attributes (boolean) |
|
331 </dd> |
|
332 </dl> |
|
333 <a NAME="BrowserClassAttributesItem.attributes" ID="BrowserClassAttributesItem.attributes"></a> |
|
334 <h4>BrowserClassAttributesItem.attributes</h4> |
|
335 <b>attributes</b>(<i></i>) |
|
336 |
|
337 <p> |
|
338 Public method returning the attribute list. |
|
339 </p> |
|
340 <dl> |
|
341 <dt>Return:</dt> |
|
342 <dd> |
|
343 reference to the list of attributes |
|
344 </dd> |
|
345 </dl> |
|
346 <a NAME="BrowserClassAttributesItem.isClassAttributes" ID="BrowserClassAttributesItem.isClassAttributes"></a> |
|
347 <h4>BrowserClassAttributesItem.isClassAttributes</h4> |
|
348 <b>isClassAttributes</b>(<i></i>) |
|
349 |
|
350 <p> |
|
351 Public method returning the attributes type. |
|
352 </p> |
|
353 <dl> |
|
354 <dt>Return:</dt> |
|
355 <dd> |
|
356 flag indicating class attributes (boolean) |
|
357 </dd> |
|
358 </dl> |
|
359 <a NAME="BrowserClassAttributesItem.lessThan" ID="BrowserClassAttributesItem.lessThan"></a> |
|
360 <h4>BrowserClassAttributesItem.lessThan</h4> |
|
361 <b>lessThan</b>(<i>other, column, order</i>) |
|
362 |
|
363 <p> |
|
364 Public method to check, if the item is less than the other one. |
|
365 </p> |
|
366 <dl> |
|
367 |
|
368 <dt><i>other</i></dt> |
|
369 <dd> |
|
370 reference to item to compare against (BrowserItem) |
|
371 </dd> |
|
372 <dt><i>column</i></dt> |
|
373 <dd> |
|
374 column number to use for the comparison (integer) |
|
375 </dd> |
|
376 <dt><i>order</i></dt> |
|
377 <dd> |
|
378 sort order (Qt.SortOrder) (for special sorting) |
|
379 </dd> |
|
380 </dl> |
|
381 <dl> |
|
382 <dt>Return:</dt> |
|
383 <dd> |
|
384 true, if this item is less than other (boolean) |
|
385 </dd> |
|
386 </dl> |
|
387 <a NAME="BrowserClassAttributesItem.name" ID="BrowserClassAttributesItem.name"></a> |
|
388 <h4>BrowserClassAttributesItem.name</h4> |
|
389 <b>name</b>(<i></i>) |
|
390 |
|
391 <p> |
|
392 Public method to return the name of the item. |
|
393 </p> |
|
394 <dl> |
|
395 <dt>Return:</dt> |
|
396 <dd> |
|
397 name of the item (string) |
|
398 </dd> |
|
399 </dl> |
|
400 <div align="right"><a href="#top">Up</a></div> |
|
401 <hr /> |
|
402 <hr /> |
|
403 <a NAME="BrowserClassItem" ID="BrowserClassItem"></a> |
|
404 <h2>BrowserClassItem</h2> |
|
405 |
|
406 <p> |
|
407 Class implementing the data structure for browser class items. |
|
408 </p> |
|
409 <h3>Derived from</h3> |
|
410 BrowserItem |
|
411 <h3>Class Attributes</h3> |
|
412 |
|
413 <table> |
|
414 <tr><td>None</td></tr> |
|
415 </table> |
|
416 <h3>Class Methods</h3> |
|
417 |
|
418 <table> |
|
419 <tr><td>None</td></tr> |
|
420 </table> |
|
421 <h3>Methods</h3> |
|
422 |
|
423 <table> |
|
424 |
|
425 <tr> |
|
426 <td><a href="#BrowserClassItem.__init__">BrowserClassItem</a></td> |
|
427 <td>Constructor</td> |
|
428 </tr> |
|
429 <tr> |
|
430 <td><a href="#BrowserClassItem.boundaries">boundaries</a></td> |
|
431 <td>Public method returning the boundaries of the method definition.</td> |
|
432 </tr> |
|
433 <tr> |
|
434 <td><a href="#BrowserClassItem.classObject">classObject</a></td> |
|
435 <td>Public method returning the class object.</td> |
|
436 </tr> |
|
437 <tr> |
|
438 <td><a href="#BrowserClassItem.fileName">fileName</a></td> |
|
439 <td>Public method returning the filename.</td> |
|
440 </tr> |
|
441 <tr> |
|
442 <td><a href="#BrowserClassItem.isPublic">isPublic</a></td> |
|
443 <td>Public method returning the public visibility status.</td> |
|
444 </tr> |
|
445 <tr> |
|
446 <td><a href="#BrowserClassItem.lessThan">lessThan</a></td> |
|
447 <td>Public method to check, if the item is less than the other one.</td> |
|
448 </tr> |
|
449 <tr> |
|
450 <td><a href="#BrowserClassItem.lineno">lineno</a></td> |
|
451 <td>Public method returning the line number defining this object.</td> |
|
452 </tr> |
|
453 <tr> |
|
454 <td><a href="#BrowserClassItem.name">name</a></td> |
|
455 <td>Public method to return the name of the item.</td> |
|
456 </tr> |
|
457 </table> |
|
458 <h3>Static Methods</h3> |
|
459 |
|
460 <table> |
|
461 <tr><td>None</td></tr> |
|
462 </table> |
|
463 |
|
464 <a NAME="BrowserClassItem.__init__" ID="BrowserClassItem.__init__"></a> |
|
465 <h4>BrowserClassItem (Constructor)</h4> |
|
466 <b>BrowserClassItem</b>(<i>parent, cl, filename</i>) |
|
467 |
|
468 <p> |
|
469 Constructor |
|
470 </p> |
|
471 <dl> |
|
472 |
|
473 <dt><i>parent</i></dt> |
|
474 <dd> |
|
475 parent item |
|
476 </dd> |
|
477 <dt><i>cl</i></dt> |
|
478 <dd> |
|
479 Class object to be shown |
|
480 </dd> |
|
481 <dt><i>filename</i></dt> |
|
482 <dd> |
|
483 filename of the file defining this class |
|
484 </dd> |
|
485 </dl> |
|
486 <a NAME="BrowserClassItem.boundaries" ID="BrowserClassItem.boundaries"></a> |
|
487 <h4>BrowserClassItem.boundaries</h4> |
|
488 <b>boundaries</b>(<i></i>) |
|
489 |
|
490 <p> |
|
491 Public method returning the boundaries of the method definition. |
|
492 </p> |
|
493 <dl> |
|
494 <dt>Return:</dt> |
|
495 <dd> |
|
496 tuple with start end end line number (integer, integer) |
|
497 </dd> |
|
498 </dl> |
|
499 <a NAME="BrowserClassItem.classObject" ID="BrowserClassItem.classObject"></a> |
|
500 <h4>BrowserClassItem.classObject</h4> |
|
501 <b>classObject</b>(<i></i>) |
|
502 |
|
503 <p> |
|
504 Public method returning the class object. |
|
505 </p> |
|
506 <dl> |
|
507 <dt>Return:</dt> |
|
508 <dd> |
|
509 reference to the class object |
|
510 </dd> |
|
511 </dl> |
|
512 <a NAME="BrowserClassItem.fileName" ID="BrowserClassItem.fileName"></a> |
|
513 <h4>BrowserClassItem.fileName</h4> |
|
514 <b>fileName</b>(<i></i>) |
|
515 |
|
516 <p> |
|
517 Public method returning the filename. |
|
518 </p> |
|
519 <dl> |
|
520 <dt>Return:</dt> |
|
521 <dd> |
|
522 filename (string) |
|
523 </dd> |
|
524 </dl> |
|
525 <a NAME="BrowserClassItem.isPublic" ID="BrowserClassItem.isPublic"></a> |
|
526 <h4>BrowserClassItem.isPublic</h4> |
|
527 <b>isPublic</b>(<i></i>) |
|
528 |
|
529 <p> |
|
530 Public method returning the public visibility status. |
|
531 </p> |
|
532 <dl> |
|
533 <dt>Return:</dt> |
|
534 <dd> |
|
535 flag indicating public visibility (boolean) |
|
536 </dd> |
|
537 </dl> |
|
538 <a NAME="BrowserClassItem.lessThan" ID="BrowserClassItem.lessThan"></a> |
|
539 <h4>BrowserClassItem.lessThan</h4> |
|
540 <b>lessThan</b>(<i>other, column, order</i>) |
|
541 |
|
542 <p> |
|
543 Public method to check, if the item is less than the other one. |
|
544 </p> |
|
545 <dl> |
|
546 |
|
547 <dt><i>other</i></dt> |
|
548 <dd> |
|
549 reference to item to compare against (BrowserItem) |
|
550 </dd> |
|
551 <dt><i>column</i></dt> |
|
552 <dd> |
|
553 column number to use for the comparison (integer) |
|
554 </dd> |
|
555 <dt><i>order</i></dt> |
|
556 <dd> |
|
557 sort order (Qt.SortOrder) (for special sorting) |
|
558 </dd> |
|
559 </dl> |
|
560 <dl> |
|
561 <dt>Return:</dt> |
|
562 <dd> |
|
563 true, if this item is less than other (boolean) |
|
564 </dd> |
|
565 </dl> |
|
566 <a NAME="BrowserClassItem.lineno" ID="BrowserClassItem.lineno"></a> |
|
567 <h4>BrowserClassItem.lineno</h4> |
|
568 <b>lineno</b>(<i></i>) |
|
569 |
|
570 <p> |
|
571 Public method returning the line number defining this object. |
|
572 </p> |
|
573 <dl> |
|
574 <dt>Return:</dt> |
|
575 <dd> |
|
576 line number defining the object (integer) |
|
577 </dd> |
|
578 </dl> |
|
579 <a NAME="BrowserClassItem.name" ID="BrowserClassItem.name"></a> |
|
580 <h4>BrowserClassItem.name</h4> |
|
581 <b>name</b>(<i></i>) |
|
582 |
|
583 <p> |
|
584 Public method to return the name of the item. |
|
585 </p> |
|
586 <dl> |
|
587 <dt>Return:</dt> |
|
588 <dd> |
|
589 name of the item (string) |
|
590 </dd> |
|
591 </dl> |
|
592 <div align="right"><a href="#top">Up</a></div> |
|
593 <hr /> |
|
594 <hr /> |
|
595 <a NAME="BrowserCodingItem" ID="BrowserCodingItem"></a> |
|
596 <h2>BrowserCodingItem</h2> |
|
597 |
|
598 <p> |
|
599 Class implementing the data structure for browser coding items. |
|
600 </p> |
|
601 <h3>Derived from</h3> |
|
602 BrowserItem |
|
603 <h3>Class Attributes</h3> |
|
604 |
|
605 <table> |
|
606 <tr><td>None</td></tr> |
|
607 </table> |
|
608 <h3>Class Methods</h3> |
|
609 |
|
610 <table> |
|
611 <tr><td>None</td></tr> |
|
612 </table> |
|
613 <h3>Methods</h3> |
|
614 |
|
615 <table> |
|
616 |
|
617 <tr> |
|
618 <td><a href="#BrowserCodingItem.__init__">BrowserCodingItem</a></td> |
|
619 <td>Constructor</td> |
|
620 </tr> |
|
621 <tr> |
|
622 <td><a href="#BrowserCodingItem.lessThan">lessThan</a></td> |
|
623 <td>Public method to check, if the item is less than the other one.</td> |
|
624 </tr> |
|
625 <tr> |
|
626 <td><a href="#BrowserCodingItem.lineno">lineno</a></td> |
|
627 <td>Public method returning the line number of the coding line.</td> |
|
628 </tr> |
|
629 </table> |
|
630 <h3>Static Methods</h3> |
|
631 |
|
632 <table> |
|
633 <tr><td>None</td></tr> |
|
634 </table> |
|
635 |
|
636 <a NAME="BrowserCodingItem.__init__" ID="BrowserCodingItem.__init__"></a> |
|
637 <h4>BrowserCodingItem (Constructor)</h4> |
|
638 <b>BrowserCodingItem</b>(<i>parent, text, linenumber</i>) |
|
639 |
|
640 <p> |
|
641 Constructor |
|
642 </p> |
|
643 <dl> |
|
644 |
|
645 <dt><i>parent</i> (BrowserItem)</dt> |
|
646 <dd> |
|
647 parent item |
|
648 </dd> |
|
649 <dt><i>text</i> (str)</dt> |
|
650 <dd> |
|
651 text to be shown by this item |
|
652 </dd> |
|
653 <dt><i>linenumber</i> (int)</dt> |
|
654 <dd> |
|
655 line number of the coding line |
|
656 </dd> |
|
657 </dl> |
|
658 <a NAME="BrowserCodingItem.lessThan" ID="BrowserCodingItem.lessThan"></a> |
|
659 <h4>BrowserCodingItem.lessThan</h4> |
|
660 <b>lessThan</b>(<i>other, column, order</i>) |
|
661 |
|
662 <p> |
|
663 Public method to check, if the item is less than the other one. |
|
664 </p> |
|
665 <dl> |
|
666 |
|
667 <dt><i>other</i></dt> |
|
668 <dd> |
|
669 reference to item to compare against (BrowserItem) |
|
670 </dd> |
|
671 <dt><i>column</i></dt> |
|
672 <dd> |
|
673 column number to use for the comparison (integer) |
|
674 </dd> |
|
675 <dt><i>order</i></dt> |
|
676 <dd> |
|
677 sort order (Qt.SortOrder) (for special sorting) |
|
678 </dd> |
|
679 </dl> |
|
680 <dl> |
|
681 <dt>Return:</dt> |
|
682 <dd> |
|
683 true, if this item is less than other (boolean) |
|
684 </dd> |
|
685 </dl> |
|
686 <a NAME="BrowserCodingItem.lineno" ID="BrowserCodingItem.lineno"></a> |
|
687 <h4>BrowserCodingItem.lineno</h4> |
|
688 <b>lineno</b>(<i></i>) |
|
689 |
|
690 <p> |
|
691 Public method returning the line number of the coding line. |
|
692 </p> |
|
693 <dl> |
|
694 <dt>Return:</dt> |
|
695 <dd> |
|
696 line number defining the coding line |
|
697 </dd> |
|
698 </dl> |
|
699 <dl> |
|
700 <dt>Return Type:</dt> |
|
701 <dd> |
|
702 int |
|
703 </dd> |
|
704 </dl> |
|
705 <div align="right"><a href="#top">Up</a></div> |
|
706 <hr /> |
|
707 <hr /> |
|
708 <a NAME="BrowserDirectoryItem" ID="BrowserDirectoryItem"></a> |
|
709 <h2>BrowserDirectoryItem</h2> |
|
710 |
|
711 <p> |
|
712 Class implementing the data structure for browser directory items. |
|
713 </p> |
|
714 <h3>Derived from</h3> |
|
715 BrowserItem |
|
716 <h3>Class Attributes</h3> |
|
717 |
|
718 <table> |
|
719 <tr><td>None</td></tr> |
|
720 </table> |
|
721 <h3>Class Methods</h3> |
|
722 |
|
723 <table> |
|
724 <tr><td>None</td></tr> |
|
725 </table> |
|
726 <h3>Methods</h3> |
|
727 |
|
728 <table> |
|
729 |
|
730 <tr> |
|
731 <td><a href="#BrowserDirectoryItem.__init__">BrowserDirectoryItem</a></td> |
|
732 <td>Constructor</td> |
|
733 </tr> |
|
734 <tr> |
|
735 <td><a href="#BrowserDirectoryItem.dirName">dirName</a></td> |
|
736 <td>Public method returning the directory name.</td> |
|
737 </tr> |
|
738 <tr> |
|
739 <td><a href="#BrowserDirectoryItem.lessThan">lessThan</a></td> |
|
740 <td>Public method to check, if the item is less than the other one.</td> |
|
741 </tr> |
|
742 <tr> |
|
743 <td><a href="#BrowserDirectoryItem.name">name</a></td> |
|
744 <td>Public method to return the name of the item.</td> |
|
745 </tr> |
|
746 <tr> |
|
747 <td><a href="#BrowserDirectoryItem.setName">setName</a></td> |
|
748 <td>Public method to set the directory name.</td> |
|
749 </tr> |
|
750 </table> |
|
751 <h3>Static Methods</h3> |
|
752 |
|
753 <table> |
|
754 <tr><td>None</td></tr> |
|
755 </table> |
|
756 |
|
757 <a NAME="BrowserDirectoryItem.__init__" ID="BrowserDirectoryItem.__init__"></a> |
|
758 <h4>BrowserDirectoryItem (Constructor)</h4> |
|
759 <b>BrowserDirectoryItem</b>(<i>parent, dinfo, full=True</i>) |
|
760 |
|
761 <p> |
|
762 Constructor |
|
763 </p> |
|
764 <dl> |
|
765 |
|
766 <dt><i>parent</i></dt> |
|
767 <dd> |
|
768 parent item |
|
769 </dd> |
|
770 <dt><i>dinfo</i></dt> |
|
771 <dd> |
|
772 dinfo is the string for the directory (string) |
|
773 </dd> |
|
774 <dt><i>full</i></dt> |
|
775 <dd> |
|
776 flag indicating full pathname should be displayed (boolean) |
|
777 </dd> |
|
778 </dl> |
|
779 <a NAME="BrowserDirectoryItem.dirName" ID="BrowserDirectoryItem.dirName"></a> |
|
780 <h4>BrowserDirectoryItem.dirName</h4> |
|
781 <b>dirName</b>(<i></i>) |
|
782 |
|
783 <p> |
|
784 Public method returning the directory name. |
|
785 </p> |
|
786 <dl> |
|
787 <dt>Return:</dt> |
|
788 <dd> |
|
789 directory name (string) |
|
790 </dd> |
|
791 </dl> |
|
792 <a NAME="BrowserDirectoryItem.lessThan" ID="BrowserDirectoryItem.lessThan"></a> |
|
793 <h4>BrowserDirectoryItem.lessThan</h4> |
|
794 <b>lessThan</b>(<i>other, column, order</i>) |
|
795 |
|
796 <p> |
|
797 Public method to check, if the item is less than the other one. |
|
798 </p> |
|
799 <dl> |
|
800 |
|
801 <dt><i>other</i></dt> |
|
802 <dd> |
|
803 reference to item to compare against (BrowserItem) |
|
804 </dd> |
|
805 <dt><i>column</i></dt> |
|
806 <dd> |
|
807 column number to use for the comparison (integer) |
|
808 </dd> |
|
809 <dt><i>order</i></dt> |
|
810 <dd> |
|
811 sort order (Qt.SortOrder) (for special sorting) |
|
812 </dd> |
|
813 </dl> |
|
814 <dl> |
|
815 <dt>Return:</dt> |
|
816 <dd> |
|
817 true, if this item is less than other (boolean) |
|
818 </dd> |
|
819 </dl> |
|
820 <a NAME="BrowserDirectoryItem.name" ID="BrowserDirectoryItem.name"></a> |
|
821 <h4>BrowserDirectoryItem.name</h4> |
|
822 <b>name</b>(<i></i>) |
|
823 |
|
824 <p> |
|
825 Public method to return the name of the item. |
|
826 </p> |
|
827 <dl> |
|
828 <dt>Return:</dt> |
|
829 <dd> |
|
830 name of the item (string) |
|
831 </dd> |
|
832 </dl> |
|
833 <a NAME="BrowserDirectoryItem.setName" ID="BrowserDirectoryItem.setName"></a> |
|
834 <h4>BrowserDirectoryItem.setName</h4> |
|
835 <b>setName</b>(<i>dinfo, full=True</i>) |
|
836 |
|
837 <p> |
|
838 Public method to set the directory name. |
|
839 </p> |
|
840 <dl> |
|
841 |
|
842 <dt><i>dinfo</i></dt> |
|
843 <dd> |
|
844 dinfo is the string for the directory (string) |
|
845 </dd> |
|
846 <dt><i>full</i></dt> |
|
847 <dd> |
|
848 flag indicating full pathname should be displayed (boolean) |
|
849 </dd> |
|
850 </dl> |
|
851 <div align="right"><a href="#top">Up</a></div> |
|
852 <hr /> |
|
853 <hr /> |
|
854 <a NAME="BrowserFileItem" ID="BrowserFileItem"></a> |
|
855 <h2>BrowserFileItem</h2> |
|
856 |
|
857 <p> |
|
858 Class implementing the data structure for browser file items. |
|
859 </p> |
|
860 <h3>Derived from</h3> |
|
861 BrowserItem |
|
862 <h3>Class Attributes</h3> |
|
863 |
|
864 <table> |
|
865 <tr><td>None</td></tr> |
|
866 </table> |
|
867 <h3>Class Methods</h3> |
|
868 |
|
869 <table> |
|
870 <tr><td>None</td></tr> |
|
871 </table> |
|
872 <h3>Methods</h3> |
|
873 |
|
874 <table> |
|
875 |
|
876 <tr> |
|
877 <td><a href="#BrowserFileItem.__init__">BrowserFileItem</a></td> |
|
878 <td>Constructor</td> |
|
879 </tr> |
|
880 <tr> |
|
881 <td><a href="#BrowserFileItem.dirName">dirName</a></td> |
|
882 <td>Public method returning the directory name.</td> |
|
883 </tr> |
|
884 <tr> |
|
885 <td><a href="#BrowserFileItem.fileExt">fileExt</a></td> |
|
886 <td>Public method returning the file extension.</td> |
|
887 </tr> |
|
888 <tr> |
|
889 <td><a href="#BrowserFileItem.fileName">fileName</a></td> |
|
890 <td>Public method returning the filename.</td> |
|
891 </tr> |
|
892 <tr> |
|
893 <td><a href="#BrowserFileItem.isCythonFile">isCythonFile</a></td> |
|
894 <td>Public method to check, if this file is a Cython file.</td> |
|
895 </tr> |
|
896 <tr> |
|
897 <td><a href="#BrowserFileItem.isDFile">isDFile</a></td> |
|
898 <td>Public method to check, if this file is a D file.</td> |
|
899 </tr> |
|
900 <tr> |
|
901 <td><a href="#BrowserFileItem.isDesignerFile">isDesignerFile</a></td> |
|
902 <td>Public method to check, if this file is a Qt-Designer file.</td> |
|
903 </tr> |
|
904 <tr> |
|
905 <td><a href="#BrowserFileItem.isEricGraphicsFile">isEricGraphicsFile</a></td> |
|
906 <td>Public method to check, if this is an eric graphics file.</td> |
|
907 </tr> |
|
908 <tr> |
|
909 <td><a href="#BrowserFileItem.isIdlFile">isIdlFile</a></td> |
|
910 <td>Public method to check, if this file is a CORBA IDL file.</td> |
|
911 </tr> |
|
912 <tr> |
|
913 <td><a href="#BrowserFileItem.isJavaScriptFile">isJavaScriptFile</a></td> |
|
914 <td>Public method to check, if this file is a JavaScript file.</td> |
|
915 </tr> |
|
916 <tr> |
|
917 <td><a href="#BrowserFileItem.isLinguistFile">isLinguistFile</a></td> |
|
918 <td>Public method to check, if this file is a Qt-Linguist file.</td> |
|
919 </tr> |
|
920 <tr> |
|
921 <td><a href="#BrowserFileItem.isMultiProjectFile">isMultiProjectFile</a></td> |
|
922 <td>Public method to check, if this file is an eric multi project file.</td> |
|
923 </tr> |
|
924 <tr> |
|
925 <td><a href="#BrowserFileItem.isPixmapFile">isPixmapFile</a></td> |
|
926 <td>Public method to check, if this file is a pixmap file.</td> |
|
927 </tr> |
|
928 <tr> |
|
929 <td><a href="#BrowserFileItem.isProjectFile">isProjectFile</a></td> |
|
930 <td>Public method to check, if this file is an eric project file.</td> |
|
931 </tr> |
|
932 <tr> |
|
933 <td><a href="#BrowserFileItem.isProtobufFile">isProtobufFile</a></td> |
|
934 <td>Public method to check, if this file is a Google Protocol Buffer file.</td> |
|
935 </tr> |
|
936 <tr> |
|
937 <td><a href="#BrowserFileItem.isPython3File">isPython3File</a></td> |
|
938 <td>Public method to check, if this file is a Python3 script.</td> |
|
939 </tr> |
|
940 <tr> |
|
941 <td><a href="#BrowserFileItem.isResourcesFile">isResourcesFile</a></td> |
|
942 <td>Public method to check, if this file is a Qt-Resources file.</td> |
|
943 </tr> |
|
944 <tr> |
|
945 <td><a href="#BrowserFileItem.isRubyFile">isRubyFile</a></td> |
|
946 <td>Public method to check, if this file is a Ruby script.</td> |
|
947 </tr> |
|
948 <tr> |
|
949 <td><a href="#BrowserFileItem.isSvgFile">isSvgFile</a></td> |
|
950 <td>Public method to check, if this file is a SVG file.</td> |
|
951 </tr> |
|
952 <tr> |
|
953 <td><a href="#BrowserFileItem.lessThan">lessThan</a></td> |
|
954 <td>Public method to check, if the item is less than the other one.</td> |
|
955 </tr> |
|
956 <tr> |
|
957 <td><a href="#BrowserFileItem.moduleName">moduleName</a></td> |
|
958 <td>Public method returning the module name.</td> |
|
959 </tr> |
|
960 <tr> |
|
961 <td><a href="#BrowserFileItem.name">name</a></td> |
|
962 <td>Public method to return the name of the item.</td> |
|
963 </tr> |
|
964 <tr> |
|
965 <td><a href="#BrowserFileItem.setName">setName</a></td> |
|
966 <td>Public method to set the directory name.</td> |
|
967 </tr> |
|
968 </table> |
|
969 <h3>Static Methods</h3> |
|
970 |
|
971 <table> |
|
972 <tr><td>None</td></tr> |
|
973 </table> |
|
974 |
|
975 <a NAME="BrowserFileItem.__init__" ID="BrowserFileItem.__init__"></a> |
|
976 <h4>BrowserFileItem (Constructor)</h4> |
|
977 <b>BrowserFileItem</b>(<i>parent, finfo, full=True, sourceLanguage=""</i>) |
|
978 |
|
979 <p> |
|
980 Constructor |
|
981 </p> |
|
982 <dl> |
|
983 |
|
984 <dt><i>parent</i></dt> |
|
985 <dd> |
|
986 parent item |
|
987 </dd> |
|
988 <dt><i>finfo</i></dt> |
|
989 <dd> |
|
990 the string for the file (string) |
|
991 </dd> |
|
992 <dt><i>full</i></dt> |
|
993 <dd> |
|
994 flag indicating full pathname should be displayed (boolean) |
|
995 </dd> |
|
996 <dt><i>sourceLanguage</i></dt> |
|
997 <dd> |
|
998 source code language of the project (string) |
|
999 </dd> |
|
1000 </dl> |
|
1001 <a NAME="BrowserFileItem.dirName" ID="BrowserFileItem.dirName"></a> |
|
1002 <h4>BrowserFileItem.dirName</h4> |
|
1003 <b>dirName</b>(<i></i>) |
|
1004 |
|
1005 <p> |
|
1006 Public method returning the directory name. |
|
1007 </p> |
|
1008 <dl> |
|
1009 <dt>Return:</dt> |
|
1010 <dd> |
|
1011 directory name (string) |
|
1012 </dd> |
|
1013 </dl> |
|
1014 <a NAME="BrowserFileItem.fileExt" ID="BrowserFileItem.fileExt"></a> |
|
1015 <h4>BrowserFileItem.fileExt</h4> |
|
1016 <b>fileExt</b>(<i></i>) |
|
1017 |
|
1018 <p> |
|
1019 Public method returning the file extension. |
|
1020 </p> |
|
1021 <dl> |
|
1022 <dt>Return:</dt> |
|
1023 <dd> |
|
1024 file extension (string) |
|
1025 </dd> |
|
1026 </dl> |
|
1027 <a NAME="BrowserFileItem.fileName" ID="BrowserFileItem.fileName"></a> |
|
1028 <h4>BrowserFileItem.fileName</h4> |
|
1029 <b>fileName</b>(<i></i>) |
|
1030 |
|
1031 <p> |
|
1032 Public method returning the filename. |
|
1033 </p> |
|
1034 <dl> |
|
1035 <dt>Return:</dt> |
|
1036 <dd> |
|
1037 filename (string) |
|
1038 </dd> |
|
1039 </dl> |
|
1040 <a NAME="BrowserFileItem.isCythonFile" ID="BrowserFileItem.isCythonFile"></a> |
|
1041 <h4>BrowserFileItem.isCythonFile</h4> |
|
1042 <b>isCythonFile</b>(<i></i>) |
|
1043 |
|
1044 <p> |
|
1045 Public method to check, if this file is a Cython file. |
|
1046 </p> |
|
1047 <dl> |
|
1048 <dt>Return:</dt> |
|
1049 <dd> |
|
1050 flag indicating a Cython file |
|
1051 </dd> |
|
1052 </dl> |
|
1053 <dl> |
|
1054 <dt>Return Type:</dt> |
|
1055 <dd> |
|
1056 bool |
|
1057 </dd> |
|
1058 </dl> |
|
1059 <a NAME="BrowserFileItem.isDFile" ID="BrowserFileItem.isDFile"></a> |
|
1060 <h4>BrowserFileItem.isDFile</h4> |
|
1061 <b>isDFile</b>(<i></i>) |
|
1062 |
|
1063 <p> |
|
1064 Public method to check, if this file is a D file. |
|
1065 </p> |
|
1066 <dl> |
|
1067 <dt>Return:</dt> |
|
1068 <dd> |
|
1069 flag indicating a D file (boolean) |
|
1070 </dd> |
|
1071 </dl> |
|
1072 <a NAME="BrowserFileItem.isDesignerFile" ID="BrowserFileItem.isDesignerFile"></a> |
|
1073 <h4>BrowserFileItem.isDesignerFile</h4> |
|
1074 <b>isDesignerFile</b>(<i></i>) |
|
1075 |
|
1076 <p> |
|
1077 Public method to check, if this file is a Qt-Designer file. |
|
1078 </p> |
|
1079 <dl> |
|
1080 <dt>Return:</dt> |
|
1081 <dd> |
|
1082 flag indicating a Qt-Designer file |
|
1083 </dd> |
|
1084 </dl> |
|
1085 <dl> |
|
1086 <dt>Return Type:</dt> |
|
1087 <dd> |
|
1088 bool |
|
1089 </dd> |
|
1090 </dl> |
|
1091 <a NAME="BrowserFileItem.isEricGraphicsFile" ID="BrowserFileItem.isEricGraphicsFile"></a> |
|
1092 <h4>BrowserFileItem.isEricGraphicsFile</h4> |
|
1093 <b>isEricGraphicsFile</b>(<i></i>) |
|
1094 |
|
1095 <p> |
|
1096 Public method to check, if this is an eric graphics file. |
|
1097 </p> |
|
1098 <dl> |
|
1099 <dt>Return:</dt> |
|
1100 <dd> |
|
1101 flag indicating an eric graphics file |
|
1102 </dd> |
|
1103 </dl> |
|
1104 <dl> |
|
1105 <dt>Return Type:</dt> |
|
1106 <dd> |
|
1107 bool |
|
1108 </dd> |
|
1109 </dl> |
|
1110 <a NAME="BrowserFileItem.isIdlFile" ID="BrowserFileItem.isIdlFile"></a> |
|
1111 <h4>BrowserFileItem.isIdlFile</h4> |
|
1112 <b>isIdlFile</b>(<i></i>) |
|
1113 |
|
1114 <p> |
|
1115 Public method to check, if this file is a CORBA IDL file. |
|
1116 </p> |
|
1117 <dl> |
|
1118 <dt>Return:</dt> |
|
1119 <dd> |
|
1120 flag indicating a CORBA IDL file |
|
1121 </dd> |
|
1122 </dl> |
|
1123 <dl> |
|
1124 <dt>Return Type:</dt> |
|
1125 <dd> |
|
1126 bool |
|
1127 </dd> |
|
1128 </dl> |
|
1129 <a NAME="BrowserFileItem.isJavaScriptFile" ID="BrowserFileItem.isJavaScriptFile"></a> |
|
1130 <h4>BrowserFileItem.isJavaScriptFile</h4> |
|
1131 <b>isJavaScriptFile</b>(<i></i>) |
|
1132 |
|
1133 <p> |
|
1134 Public method to check, if this file is a JavaScript file. |
|
1135 </p> |
|
1136 <dl> |
|
1137 <dt>Return:</dt> |
|
1138 <dd> |
|
1139 flag indicating a JavaScript file |
|
1140 </dd> |
|
1141 </dl> |
|
1142 <dl> |
|
1143 <dt>Return Type:</dt> |
|
1144 <dd> |
|
1145 bool |
|
1146 </dd> |
|
1147 </dl> |
|
1148 <a NAME="BrowserFileItem.isLinguistFile" ID="BrowserFileItem.isLinguistFile"></a> |
|
1149 <h4>BrowserFileItem.isLinguistFile</h4> |
|
1150 <b>isLinguistFile</b>(<i></i>) |
|
1151 |
|
1152 <p> |
|
1153 Public method to check, if this file is a Qt-Linguist file. |
|
1154 </p> |
|
1155 <dl> |
|
1156 <dt>Return:</dt> |
|
1157 <dd> |
|
1158 flag indicating a Qt-Linguist file |
|
1159 </dd> |
|
1160 </dl> |
|
1161 <dl> |
|
1162 <dt>Return Type:</dt> |
|
1163 <dd> |
|
1164 bool |
|
1165 </dd> |
|
1166 </dl> |
|
1167 <a NAME="BrowserFileItem.isMultiProjectFile" ID="BrowserFileItem.isMultiProjectFile"></a> |
|
1168 <h4>BrowserFileItem.isMultiProjectFile</h4> |
|
1169 <b>isMultiProjectFile</b>(<i></i>) |
|
1170 |
|
1171 <p> |
|
1172 Public method to check, if this file is an eric multi project file. |
|
1173 </p> |
|
1174 <dl> |
|
1175 <dt>Return:</dt> |
|
1176 <dd> |
|
1177 flag indicating an eric project file |
|
1178 </dd> |
|
1179 </dl> |
|
1180 <dl> |
|
1181 <dt>Return Type:</dt> |
|
1182 <dd> |
|
1183 bool |
|
1184 </dd> |
|
1185 </dl> |
|
1186 <a NAME="BrowserFileItem.isPixmapFile" ID="BrowserFileItem.isPixmapFile"></a> |
|
1187 <h4>BrowserFileItem.isPixmapFile</h4> |
|
1188 <b>isPixmapFile</b>(<i></i>) |
|
1189 |
|
1190 <p> |
|
1191 Public method to check, if this file is a pixmap file. |
|
1192 </p> |
|
1193 <dl> |
|
1194 <dt>Return:</dt> |
|
1195 <dd> |
|
1196 flag indicating a pixmap file |
|
1197 </dd> |
|
1198 </dl> |
|
1199 <dl> |
|
1200 <dt>Return Type:</dt> |
|
1201 <dd> |
|
1202 bool |
|
1203 </dd> |
|
1204 </dl> |
|
1205 <a NAME="BrowserFileItem.isProjectFile" ID="BrowserFileItem.isProjectFile"></a> |
|
1206 <h4>BrowserFileItem.isProjectFile</h4> |
|
1207 <b>isProjectFile</b>(<i></i>) |
|
1208 |
|
1209 <p> |
|
1210 Public method to check, if this file is an eric project file. |
|
1211 </p> |
|
1212 <dl> |
|
1213 <dt>Return:</dt> |
|
1214 <dd> |
|
1215 flag indicating an eric project file |
|
1216 </dd> |
|
1217 </dl> |
|
1218 <dl> |
|
1219 <dt>Return Type:</dt> |
|
1220 <dd> |
|
1221 bool |
|
1222 </dd> |
|
1223 </dl> |
|
1224 <a NAME="BrowserFileItem.isProtobufFile" ID="BrowserFileItem.isProtobufFile"></a> |
|
1225 <h4>BrowserFileItem.isProtobufFile</h4> |
|
1226 <b>isProtobufFile</b>(<i></i>) |
|
1227 |
|
1228 <p> |
|
1229 Public method to check, if this file is a Google Protocol Buffer file. |
|
1230 </p> |
|
1231 <dl> |
|
1232 <dt>Return:</dt> |
|
1233 <dd> |
|
1234 flag indicating a protobuf file |
|
1235 </dd> |
|
1236 </dl> |
|
1237 <dl> |
|
1238 <dt>Return Type:</dt> |
|
1239 <dd> |
|
1240 bool |
|
1241 </dd> |
|
1242 </dl> |
|
1243 <a NAME="BrowserFileItem.isPython3File" ID="BrowserFileItem.isPython3File"></a> |
|
1244 <h4>BrowserFileItem.isPython3File</h4> |
|
1245 <b>isPython3File</b>(<i></i>) |
|
1246 |
|
1247 <p> |
|
1248 Public method to check, if this file is a Python3 script. |
|
1249 </p> |
|
1250 <dl> |
|
1251 <dt>Return:</dt> |
|
1252 <dd> |
|
1253 flag indicating a Python3 file |
|
1254 </dd> |
|
1255 </dl> |
|
1256 <dl> |
|
1257 <dt>Return Type:</dt> |
|
1258 <dd> |
|
1259 bool |
|
1260 </dd> |
|
1261 </dl> |
|
1262 <a NAME="BrowserFileItem.isResourcesFile" ID="BrowserFileItem.isResourcesFile"></a> |
|
1263 <h4>BrowserFileItem.isResourcesFile</h4> |
|
1264 <b>isResourcesFile</b>(<i></i>) |
|
1265 |
|
1266 <p> |
|
1267 Public method to check, if this file is a Qt-Resources file. |
|
1268 </p> |
|
1269 <dl> |
|
1270 <dt>Return:</dt> |
|
1271 <dd> |
|
1272 flag indicating a Qt-Resources file |
|
1273 </dd> |
|
1274 </dl> |
|
1275 <dl> |
|
1276 <dt>Return Type:</dt> |
|
1277 <dd> |
|
1278 bool |
|
1279 </dd> |
|
1280 </dl> |
|
1281 <a NAME="BrowserFileItem.isRubyFile" ID="BrowserFileItem.isRubyFile"></a> |
|
1282 <h4>BrowserFileItem.isRubyFile</h4> |
|
1283 <b>isRubyFile</b>(<i></i>) |
|
1284 |
|
1285 <p> |
|
1286 Public method to check, if this file is a Ruby script. |
|
1287 </p> |
|
1288 <dl> |
|
1289 <dt>Return:</dt> |
|
1290 <dd> |
|
1291 flag indicating a Ruby file |
|
1292 </dd> |
|
1293 </dl> |
|
1294 <dl> |
|
1295 <dt>Return Type:</dt> |
|
1296 <dd> |
|
1297 bool |
|
1298 </dd> |
|
1299 </dl> |
|
1300 <a NAME="BrowserFileItem.isSvgFile" ID="BrowserFileItem.isSvgFile"></a> |
|
1301 <h4>BrowserFileItem.isSvgFile</h4> |
|
1302 <b>isSvgFile</b>(<i></i>) |
|
1303 |
|
1304 <p> |
|
1305 Public method to check, if this file is a SVG file. |
|
1306 </p> |
|
1307 <dl> |
|
1308 <dt>Return:</dt> |
|
1309 <dd> |
|
1310 flag indicating a SVG file |
|
1311 </dd> |
|
1312 </dl> |
|
1313 <dl> |
|
1314 <dt>Return Type:</dt> |
|
1315 <dd> |
|
1316 bool |
|
1317 </dd> |
|
1318 </dl> |
|
1319 <a NAME="BrowserFileItem.lessThan" ID="BrowserFileItem.lessThan"></a> |
|
1320 <h4>BrowserFileItem.lessThan</h4> |
|
1321 <b>lessThan</b>(<i>other, column, order</i>) |
|
1322 |
|
1323 <p> |
|
1324 Public method to check, if the item is less than the other one. |
|
1325 </p> |
|
1326 <dl> |
|
1327 |
|
1328 <dt><i>other</i></dt> |
|
1329 <dd> |
|
1330 reference to item to compare against (BrowserItem) |
|
1331 </dd> |
|
1332 <dt><i>column</i></dt> |
|
1333 <dd> |
|
1334 column number to use for the comparison (integer) |
|
1335 </dd> |
|
1336 <dt><i>order</i></dt> |
|
1337 <dd> |
|
1338 sort order (Qt.SortOrder) (for special sorting) |
|
1339 </dd> |
|
1340 </dl> |
|
1341 <dl> |
|
1342 <dt>Return:</dt> |
|
1343 <dd> |
|
1344 true, if this item is less than other (boolean) |
|
1345 </dd> |
|
1346 </dl> |
|
1347 <a NAME="BrowserFileItem.moduleName" ID="BrowserFileItem.moduleName"></a> |
|
1348 <h4>BrowserFileItem.moduleName</h4> |
|
1349 <b>moduleName</b>(<i></i>) |
|
1350 |
|
1351 <p> |
|
1352 Public method returning the module name. |
|
1353 </p> |
|
1354 <dl> |
|
1355 <dt>Return:</dt> |
|
1356 <dd> |
|
1357 module name (string) |
|
1358 </dd> |
|
1359 </dl> |
|
1360 <a NAME="BrowserFileItem.name" ID="BrowserFileItem.name"></a> |
|
1361 <h4>BrowserFileItem.name</h4> |
|
1362 <b>name</b>(<i></i>) |
|
1363 |
|
1364 <p> |
|
1365 Public method to return the name of the item. |
|
1366 </p> |
|
1367 <dl> |
|
1368 <dt>Return:</dt> |
|
1369 <dd> |
|
1370 name of the item (string) |
|
1371 </dd> |
|
1372 </dl> |
|
1373 <a NAME="BrowserFileItem.setName" ID="BrowserFileItem.setName"></a> |
|
1374 <h4>BrowserFileItem.setName</h4> |
|
1375 <b>setName</b>(<i>finfo, full=True</i>) |
|
1376 |
|
1377 <p> |
|
1378 Public method to set the directory name. |
|
1379 </p> |
|
1380 <dl> |
|
1381 |
|
1382 <dt><i>finfo</i></dt> |
|
1383 <dd> |
|
1384 the string for the file (string) |
|
1385 </dd> |
|
1386 <dt><i>full</i></dt> |
|
1387 <dd> |
|
1388 flag indicating full pathname should be displayed (boolean) |
|
1389 </dd> |
|
1390 </dl> |
|
1391 <div align="right"><a href="#top">Up</a></div> |
|
1392 <hr /> |
|
1393 <hr /> |
|
1394 <a NAME="BrowserGlobalsItem" ID="BrowserGlobalsItem"></a> |
|
1395 <h2>BrowserGlobalsItem</h2> |
|
1396 |
|
1397 <p> |
|
1398 Class implementing the data structure for browser globals items. |
|
1399 </p> |
|
1400 <h3>Derived from</h3> |
|
1401 BrowserClassAttributesItem |
|
1402 <h3>Class Attributes</h3> |
|
1403 |
|
1404 <table> |
|
1405 <tr><td>None</td></tr> |
|
1406 </table> |
|
1407 <h3>Class Methods</h3> |
|
1408 |
|
1409 <table> |
|
1410 <tr><td>None</td></tr> |
|
1411 </table> |
|
1412 <h3>Methods</h3> |
|
1413 |
|
1414 <table> |
|
1415 |
|
1416 <tr> |
|
1417 <td><a href="#BrowserGlobalsItem.__init__">BrowserGlobalsItem</a></td> |
|
1418 <td>Constructor</td> |
|
1419 </tr> |
|
1420 </table> |
|
1421 <h3>Static Methods</h3> |
|
1422 |
|
1423 <table> |
|
1424 <tr><td>None</td></tr> |
|
1425 </table> |
|
1426 |
|
1427 <a NAME="BrowserGlobalsItem.__init__" ID="BrowserGlobalsItem.__init__"></a> |
|
1428 <h4>BrowserGlobalsItem (Constructor)</h4> |
|
1429 <b>BrowserGlobalsItem</b>(<i>parent, attributes, text</i>) |
|
1430 |
|
1431 <p> |
|
1432 Constructor |
|
1433 </p> |
|
1434 <dl> |
|
1435 |
|
1436 <dt><i>parent</i></dt> |
|
1437 <dd> |
|
1438 parent item |
|
1439 </dd> |
|
1440 <dt><i>attributes</i></dt> |
|
1441 <dd> |
|
1442 list of attributes |
|
1443 </dd> |
|
1444 <dt><i>text</i></dt> |
|
1445 <dd> |
|
1446 text to be shown by this item (string) |
|
1447 </dd> |
|
1448 </dl> |
|
1449 <div align="right"><a href="#top">Up</a></div> |
|
1450 <hr /> |
|
1451 <hr /> |
|
1452 <a NAME="BrowserImportItem" ID="BrowserImportItem"></a> |
|
1453 <h2>BrowserImportItem</h2> |
|
1454 |
|
1455 <p> |
|
1456 Class implementing the data structure for browser imported module and |
|
1457 imported names items. |
|
1458 </p> |
|
1459 <h3>Derived from</h3> |
|
1460 BrowserItem |
|
1461 <h3>Class Attributes</h3> |
|
1462 |
|
1463 <table> |
|
1464 <tr><td>None</td></tr> |
|
1465 </table> |
|
1466 <h3>Class Methods</h3> |
|
1467 |
|
1468 <table> |
|
1469 <tr><td>None</td></tr> |
|
1470 </table> |
|
1471 <h3>Methods</h3> |
|
1472 |
|
1473 <table> |
|
1474 |
|
1475 <tr> |
|
1476 <td><a href="#BrowserImportItem.__init__">BrowserImportItem</a></td> |
|
1477 <td>Constructor</td> |
|
1478 </tr> |
|
1479 <tr> |
|
1480 <td><a href="#BrowserImportItem.fileName">fileName</a></td> |
|
1481 <td>Public method returning the filename.</td> |
|
1482 </tr> |
|
1483 <tr> |
|
1484 <td><a href="#BrowserImportItem.lessThan">lessThan</a></td> |
|
1485 <td>Public method to check, if the item is less than the other one.</td> |
|
1486 </tr> |
|
1487 <tr> |
|
1488 <td><a href="#BrowserImportItem.lineno">lineno</a></td> |
|
1489 <td>Public method returning the line number of the first import.</td> |
|
1490 </tr> |
|
1491 <tr> |
|
1492 <td><a href="#BrowserImportItem.linenos">linenos</a></td> |
|
1493 <td>Public method returning the line numbers of all imports.</td> |
|
1494 </tr> |
|
1495 </table> |
|
1496 <h3>Static Methods</h3> |
|
1497 |
|
1498 <table> |
|
1499 <tr><td>None</td></tr> |
|
1500 </table> |
|
1501 |
|
1502 <a NAME="BrowserImportItem.__init__" ID="BrowserImportItem.__init__"></a> |
|
1503 <h4>BrowserImportItem (Constructor)</h4> |
|
1504 <b>BrowserImportItem</b>(<i>parent, text, filename, lineNumbers, isModule=True</i>) |
|
1505 |
|
1506 <p> |
|
1507 Constructor |
|
1508 </p> |
|
1509 <dl> |
|
1510 |
|
1511 <dt><i>parent</i></dt> |
|
1512 <dd> |
|
1513 parent item |
|
1514 </dd> |
|
1515 <dt><i>text</i></dt> |
|
1516 <dd> |
|
1517 text to be shown by this item (string) |
|
1518 </dd> |
|
1519 <dt><i>filename</i></dt> |
|
1520 <dd> |
|
1521 name of the file (string) |
|
1522 </dd> |
|
1523 <dt><i>lineNumbers</i></dt> |
|
1524 <dd> |
|
1525 list of line numbers of the import statement |
|
1526 (list of integer) |
|
1527 </dd> |
|
1528 <dt><i>isModule</i></dt> |
|
1529 <dd> |
|
1530 flag indicating a module item entry (boolean) |
|
1531 </dd> |
|
1532 </dl> |
|
1533 <a NAME="BrowserImportItem.fileName" ID="BrowserImportItem.fileName"></a> |
|
1534 <h4>BrowserImportItem.fileName</h4> |
|
1535 <b>fileName</b>(<i></i>) |
|
1536 |
|
1537 <p> |
|
1538 Public method returning the filename. |
|
1539 </p> |
|
1540 <dl> |
|
1541 <dt>Return:</dt> |
|
1542 <dd> |
|
1543 filename (string) |
|
1544 </dd> |
|
1545 </dl> |
|
1546 <a NAME="BrowserImportItem.lessThan" ID="BrowserImportItem.lessThan"></a> |
|
1547 <h4>BrowserImportItem.lessThan</h4> |
|
1548 <b>lessThan</b>(<i>other, column, order</i>) |
|
1549 |
|
1550 <p> |
|
1551 Public method to check, if the item is less than the other one. |
|
1552 </p> |
|
1553 <dl> |
|
1554 |
|
1555 <dt><i>other</i></dt> |
|
1556 <dd> |
|
1557 reference to item to compare against (BrowserItem) |
|
1558 </dd> |
|
1559 <dt><i>column</i></dt> |
|
1560 <dd> |
|
1561 column number to use for the comparison (integer) |
|
1562 </dd> |
|
1563 <dt><i>order</i></dt> |
|
1564 <dd> |
|
1565 sort order (Qt.SortOrder) (for special sorting) |
|
1566 </dd> |
|
1567 </dl> |
|
1568 <dl> |
|
1569 <dt>Return:</dt> |
|
1570 <dd> |
|
1571 true, if this item is less than other (boolean) |
|
1572 </dd> |
|
1573 </dl> |
|
1574 <a NAME="BrowserImportItem.lineno" ID="BrowserImportItem.lineno"></a> |
|
1575 <h4>BrowserImportItem.lineno</h4> |
|
1576 <b>lineno</b>(<i></i>) |
|
1577 |
|
1578 <p> |
|
1579 Public method returning the line number of the first import. |
|
1580 </p> |
|
1581 <dl> |
|
1582 <dt>Return:</dt> |
|
1583 <dd> |
|
1584 line number of the first import (integer) |
|
1585 </dd> |
|
1586 </dl> |
|
1587 <a NAME="BrowserImportItem.linenos" ID="BrowserImportItem.linenos"></a> |
|
1588 <h4>BrowserImportItem.linenos</h4> |
|
1589 <b>linenos</b>(<i></i>) |
|
1590 |
|
1591 <p> |
|
1592 Public method returning the line numbers of all imports. |
|
1593 </p> |
|
1594 <dl> |
|
1595 <dt>Return:</dt> |
|
1596 <dd> |
|
1597 line numbers of all imports (list of integers) |
|
1598 </dd> |
|
1599 </dl> |
|
1600 <div align="right"><a href="#top">Up</a></div> |
|
1601 <hr /> |
|
1602 <hr /> |
|
1603 <a NAME="BrowserImportsItem" ID="BrowserImportsItem"></a> |
|
1604 <h2>BrowserImportsItem</h2> |
|
1605 |
|
1606 <p> |
|
1607 Class implementing the data structure for browser import items. |
|
1608 </p> |
|
1609 <h3>Derived from</h3> |
|
1610 BrowserItem |
|
1611 <h3>Class Attributes</h3> |
|
1612 |
|
1613 <table> |
|
1614 <tr><td>None</td></tr> |
|
1615 </table> |
|
1616 <h3>Class Methods</h3> |
|
1617 |
|
1618 <table> |
|
1619 <tr><td>None</td></tr> |
|
1620 </table> |
|
1621 <h3>Methods</h3> |
|
1622 |
|
1623 <table> |
|
1624 |
|
1625 <tr> |
|
1626 <td><a href="#BrowserImportsItem.__init__">BrowserImportsItem</a></td> |
|
1627 <td>Constructor</td> |
|
1628 </tr> |
|
1629 <tr> |
|
1630 <td><a href="#BrowserImportsItem.lessThan">lessThan</a></td> |
|
1631 <td>Public method to check, if the item is less than the other one.</td> |
|
1632 </tr> |
|
1633 </table> |
|
1634 <h3>Static Methods</h3> |
|
1635 |
|
1636 <table> |
|
1637 <tr><td>None</td></tr> |
|
1638 </table> |
|
1639 |
|
1640 <a NAME="BrowserImportsItem.__init__" ID="BrowserImportsItem.__init__"></a> |
|
1641 <h4>BrowserImportsItem (Constructor)</h4> |
|
1642 <b>BrowserImportsItem</b>(<i>parent, text</i>) |
|
1643 |
|
1644 <p> |
|
1645 Constructor |
|
1646 </p> |
|
1647 <dl> |
|
1648 |
|
1649 <dt><i>parent</i></dt> |
|
1650 <dd> |
|
1651 parent item |
|
1652 </dd> |
|
1653 <dt><i>text</i></dt> |
|
1654 <dd> |
|
1655 text to be shown by this item (string) |
|
1656 </dd> |
|
1657 </dl> |
|
1658 <a NAME="BrowserImportsItem.lessThan" ID="BrowserImportsItem.lessThan"></a> |
|
1659 <h4>BrowserImportsItem.lessThan</h4> |
|
1660 <b>lessThan</b>(<i>other, column, order</i>) |
|
1661 |
|
1662 <p> |
|
1663 Public method to check, if the item is less than the other one. |
|
1664 </p> |
|
1665 <dl> |
|
1666 |
|
1667 <dt><i>other</i></dt> |
|
1668 <dd> |
|
1669 reference to item to compare against (BrowserItem) |
|
1670 </dd> |
|
1671 <dt><i>column</i></dt> |
|
1672 <dd> |
|
1673 column number to use for the comparison (integer) |
|
1674 </dd> |
|
1675 <dt><i>order</i></dt> |
|
1676 <dd> |
|
1677 sort order (Qt.SortOrder) (for special sorting) |
|
1678 </dd> |
|
1679 </dl> |
|
1680 <dl> |
|
1681 <dt>Return:</dt> |
|
1682 <dd> |
|
1683 true, if this item is less than other (boolean) |
|
1684 </dd> |
|
1685 </dl> |
|
1686 <div align="right"><a href="#top">Up</a></div> |
|
1687 <hr /> |
|
1688 <hr /> |
|
1689 <a NAME="BrowserItem" ID="BrowserItem"></a> |
|
1690 <h2>BrowserItem</h2> |
|
1691 |
|
1692 <p> |
|
1693 Class implementing the data structure for browser items. |
|
1694 </p> |
|
1695 <h3>Derived from</h3> |
|
1696 None |
|
1697 <h3>Class Attributes</h3> |
|
1698 |
|
1699 <table> |
|
1700 <tr><td>None</td></tr> |
|
1701 </table> |
|
1702 <h3>Class Methods</h3> |
|
1703 |
|
1704 <table> |
|
1705 <tr><td>None</td></tr> |
|
1706 </table> |
|
1707 <h3>Methods</h3> |
|
1708 |
|
1709 <table> |
|
1710 |
|
1711 <tr> |
|
1712 <td><a href="#BrowserItem.__init__">BrowserItem</a></td> |
|
1713 <td>Constructor</td> |
|
1714 </tr> |
|
1715 <tr> |
|
1716 <td><a href="#BrowserItem.appendChild">appendChild</a></td> |
|
1717 <td>Public method to add a child to this item.</td> |
|
1718 </tr> |
|
1719 <tr> |
|
1720 <td><a href="#BrowserItem.child">child</a></td> |
|
1721 <td>Public method to get a child id.</td> |
|
1722 </tr> |
|
1723 <tr> |
|
1724 <td><a href="#BrowserItem.childCount">childCount</a></td> |
|
1725 <td>Public method to get the number of available child items.</td> |
|
1726 </tr> |
|
1727 <tr> |
|
1728 <td><a href="#BrowserItem.children">children</a></td> |
|
1729 <td>Public method to get the ids of all child items.</td> |
|
1730 </tr> |
|
1731 <tr> |
|
1732 <td><a href="#BrowserItem.columnCount">columnCount</a></td> |
|
1733 <td>Public method to get the number of available data items.</td> |
|
1734 </tr> |
|
1735 <tr> |
|
1736 <td><a href="#BrowserItem.data">data</a></td> |
|
1737 <td>Public method to get a specific data item.</td> |
|
1738 </tr> |
|
1739 <tr> |
|
1740 <td><a href="#BrowserItem.getIcon">getIcon</a></td> |
|
1741 <td>Public method to get the items icon.</td> |
|
1742 </tr> |
|
1743 <tr> |
|
1744 <td><a href="#BrowserItem.isLazyPopulated">isLazyPopulated</a></td> |
|
1745 <td>Public method to check, if this item should be populated lazyly.</td> |
|
1746 </tr> |
|
1747 <tr> |
|
1748 <td><a href="#BrowserItem.isPopulated">isPopulated</a></td> |
|
1749 <td>Public method to chek, if this item is populated.</td> |
|
1750 </tr> |
|
1751 <tr> |
|
1752 <td><a href="#BrowserItem.isPublic">isPublic</a></td> |
|
1753 <td>Public method returning the public visibility status.</td> |
|
1754 </tr> |
|
1755 <tr> |
|
1756 <td><a href="#BrowserItem.isSymlink">isSymlink</a></td> |
|
1757 <td>Public method to check, if the items is a symbolic link.</td> |
|
1758 </tr> |
|
1759 <tr> |
|
1760 <td><a href="#BrowserItem.lessThan">lessThan</a></td> |
|
1761 <td>Public method to check, if the item is less than the other one.</td> |
|
1762 </tr> |
|
1763 <tr> |
|
1764 <td><a href="#BrowserItem.parent">parent</a></td> |
|
1765 <td>Public method to get the reference to the parent item.</td> |
|
1766 </tr> |
|
1767 <tr> |
|
1768 <td><a href="#BrowserItem.removeChild">removeChild</a></td> |
|
1769 <td>Public method to remove a child.</td> |
|
1770 </tr> |
|
1771 <tr> |
|
1772 <td><a href="#BrowserItem.removeChildren">removeChildren</a></td> |
|
1773 <td>Public method to remove all children.</td> |
|
1774 </tr> |
|
1775 <tr> |
|
1776 <td><a href="#BrowserItem.row">row</a></td> |
|
1777 <td>Public method to get the row number of this item.</td> |
|
1778 </tr> |
|
1779 <tr> |
|
1780 <td><a href="#BrowserItem.type">type</a></td> |
|
1781 <td>Public method to get the item type.</td> |
|
1782 </tr> |
|
1783 </table> |
|
1784 <h3>Static Methods</h3> |
|
1785 |
|
1786 <table> |
|
1787 <tr><td>None</td></tr> |
|
1788 </table> |
|
1789 |
|
1790 <a NAME="BrowserItem.__init__" ID="BrowserItem.__init__"></a> |
|
1791 <h4>BrowserItem (Constructor)</h4> |
|
1792 <b>BrowserItem</b>(<i>parent, data</i>) |
|
1793 |
|
1794 <p> |
|
1795 Constructor |
|
1796 </p> |
|
1797 <dl> |
|
1798 |
|
1799 <dt><i>parent</i></dt> |
|
1800 <dd> |
|
1801 reference to the parent item |
|
1802 </dd> |
|
1803 <dt><i>data</i></dt> |
|
1804 <dd> |
|
1805 single data of the item |
|
1806 </dd> |
|
1807 </dl> |
|
1808 <a NAME="BrowserItem.appendChild" ID="BrowserItem.appendChild"></a> |
|
1809 <h4>BrowserItem.appendChild</h4> |
|
1810 <b>appendChild</b>(<i>child</i>) |
|
1811 |
|
1812 <p> |
|
1813 Public method to add a child to this item. |
|
1814 </p> |
|
1815 <dl> |
|
1816 |
|
1817 <dt><i>child</i></dt> |
|
1818 <dd> |
|
1819 reference to the child item to add (BrowserItem) |
|
1820 </dd> |
|
1821 </dl> |
|
1822 <a NAME="BrowserItem.child" ID="BrowserItem.child"></a> |
|
1823 <h4>BrowserItem.child</h4> |
|
1824 <b>child</b>(<i>row</i>) |
|
1825 |
|
1826 <p> |
|
1827 Public method to get a child id. |
|
1828 </p> |
|
1829 <dl> |
|
1830 |
|
1831 <dt><i>row</i></dt> |
|
1832 <dd> |
|
1833 number of child to get the id of (integer) |
|
1834 </dd> |
|
1835 </dl> |
|
1836 <dl> |
|
1837 <dt>Return:</dt> |
|
1838 <dd> |
|
1839 reference to the child item (BrowserItem) |
|
1840 </dd> |
|
1841 </dl> |
|
1842 <a NAME="BrowserItem.childCount" ID="BrowserItem.childCount"></a> |
|
1843 <h4>BrowserItem.childCount</h4> |
|
1844 <b>childCount</b>(<i></i>) |
|
1845 |
|
1846 <p> |
|
1847 Public method to get the number of available child items. |
|
1848 </p> |
|
1849 <dl> |
|
1850 <dt>Return:</dt> |
|
1851 <dd> |
|
1852 number of child items (integer) |
|
1853 </dd> |
|
1854 </dl> |
|
1855 <a NAME="BrowserItem.children" ID="BrowserItem.children"></a> |
|
1856 <h4>BrowserItem.children</h4> |
|
1857 <b>children</b>(<i></i>) |
|
1858 |
|
1859 <p> |
|
1860 Public method to get the ids of all child items. |
|
1861 </p> |
|
1862 <dl> |
|
1863 <dt>Return:</dt> |
|
1864 <dd> |
|
1865 references to all child items (list of BrowserItem) |
|
1866 </dd> |
|
1867 </dl> |
|
1868 <a NAME="BrowserItem.columnCount" ID="BrowserItem.columnCount"></a> |
|
1869 <h4>BrowserItem.columnCount</h4> |
|
1870 <b>columnCount</b>(<i></i>) |
|
1871 |
|
1872 <p> |
|
1873 Public method to get the number of available data items. |
|
1874 </p> |
|
1875 <dl> |
|
1876 <dt>Return:</dt> |
|
1877 <dd> |
|
1878 number of data items (integer) |
|
1879 </dd> |
|
1880 </dl> |
|
1881 <a NAME="BrowserItem.data" ID="BrowserItem.data"></a> |
|
1882 <h4>BrowserItem.data</h4> |
|
1883 <b>data</b>(<i>column</i>) |
|
1884 |
|
1885 <p> |
|
1886 Public method to get a specific data item. |
|
1887 </p> |
|
1888 <dl> |
|
1889 |
|
1890 <dt><i>column</i></dt> |
|
1891 <dd> |
|
1892 number of the requested data item (integer) |
|
1893 </dd> |
|
1894 </dl> |
|
1895 <dl> |
|
1896 <dt>Return:</dt> |
|
1897 <dd> |
|
1898 stored data item |
|
1899 </dd> |
|
1900 </dl> |
|
1901 <a NAME="BrowserItem.getIcon" ID="BrowserItem.getIcon"></a> |
|
1902 <h4>BrowserItem.getIcon</h4> |
|
1903 <b>getIcon</b>(<i></i>) |
|
1904 |
|
1905 <p> |
|
1906 Public method to get the items icon. |
|
1907 </p> |
|
1908 <dl> |
|
1909 <dt>Return:</dt> |
|
1910 <dd> |
|
1911 the icon (QIcon) |
|
1912 </dd> |
|
1913 </dl> |
|
1914 <a NAME="BrowserItem.isLazyPopulated" ID="BrowserItem.isLazyPopulated"></a> |
|
1915 <h4>BrowserItem.isLazyPopulated</h4> |
|
1916 <b>isLazyPopulated</b>(<i></i>) |
|
1917 |
|
1918 <p> |
|
1919 Public method to check, if this item should be populated lazyly. |
|
1920 </p> |
|
1921 <dl> |
|
1922 <dt>Return:</dt> |
|
1923 <dd> |
|
1924 lazy population flag (boolean) |
|
1925 </dd> |
|
1926 </dl> |
|
1927 <a NAME="BrowserItem.isPopulated" ID="BrowserItem.isPopulated"></a> |
|
1928 <h4>BrowserItem.isPopulated</h4> |
|
1929 <b>isPopulated</b>(<i></i>) |
|
1930 |
|
1931 <p> |
|
1932 Public method to chek, if this item is populated. |
|
1933 </p> |
|
1934 <dl> |
|
1935 <dt>Return:</dt> |
|
1936 <dd> |
|
1937 population status (boolean) |
|
1938 </dd> |
|
1939 </dl> |
|
1940 <a NAME="BrowserItem.isPublic" ID="BrowserItem.isPublic"></a> |
|
1941 <h4>BrowserItem.isPublic</h4> |
|
1942 <b>isPublic</b>(<i></i>) |
|
1943 |
|
1944 <p> |
|
1945 Public method returning the public visibility status. |
|
1946 </p> |
|
1947 <dl> |
|
1948 <dt>Return:</dt> |
|
1949 <dd> |
|
1950 flag indicating public visibility (boolean) |
|
1951 </dd> |
|
1952 </dl> |
|
1953 <a NAME="BrowserItem.isSymlink" ID="BrowserItem.isSymlink"></a> |
|
1954 <h4>BrowserItem.isSymlink</h4> |
|
1955 <b>isSymlink</b>(<i></i>) |
|
1956 |
|
1957 <p> |
|
1958 Public method to check, if the items is a symbolic link. |
|
1959 </p> |
|
1960 <dl> |
|
1961 <dt>Return:</dt> |
|
1962 <dd> |
|
1963 flag indicating a symbolic link (boolean) |
|
1964 </dd> |
|
1965 </dl> |
|
1966 <a NAME="BrowserItem.lessThan" ID="BrowserItem.lessThan"></a> |
|
1967 <h4>BrowserItem.lessThan</h4> |
|
1968 <b>lessThan</b>(<i>other, column, order</i>) |
|
1969 |
|
1970 <p> |
|
1971 Public method to check, if the item is less than the other one. |
|
1972 </p> |
|
1973 <dl> |
|
1974 |
|
1975 <dt><i>other</i></dt> |
|
1976 <dd> |
|
1977 reference to item to compare against (BrowserItem) |
|
1978 </dd> |
|
1979 <dt><i>column</i></dt> |
|
1980 <dd> |
|
1981 column number to use for the comparison (integer) |
|
1982 </dd> |
|
1983 <dt><i>order</i></dt> |
|
1984 <dd> |
|
1985 sort order (Qt.SortOrder) (for special sorting) |
|
1986 </dd> |
|
1987 </dl> |
|
1988 <dl> |
|
1989 <dt>Return:</dt> |
|
1990 <dd> |
|
1991 true, if this item is less than other (boolean) |
|
1992 </dd> |
|
1993 </dl> |
|
1994 <a NAME="BrowserItem.parent" ID="BrowserItem.parent"></a> |
|
1995 <h4>BrowserItem.parent</h4> |
|
1996 <b>parent</b>(<i></i>) |
|
1997 |
|
1998 <p> |
|
1999 Public method to get the reference to the parent item. |
|
2000 </p> |
|
2001 <dl> |
|
2002 <dt>Return:</dt> |
|
2003 <dd> |
|
2004 reference to the parent item |
|
2005 </dd> |
|
2006 </dl> |
|
2007 <a NAME="BrowserItem.removeChild" ID="BrowserItem.removeChild"></a> |
|
2008 <h4>BrowserItem.removeChild</h4> |
|
2009 <b>removeChild</b>(<i>child</i>) |
|
2010 |
|
2011 <p> |
|
2012 Public method to remove a child. |
|
2013 </p> |
|
2014 <dl> |
|
2015 |
|
2016 <dt><i>child</i></dt> |
|
2017 <dd> |
|
2018 reference to the child to remove (BrowserItem) |
|
2019 </dd> |
|
2020 </dl> |
|
2021 <a NAME="BrowserItem.removeChildren" ID="BrowserItem.removeChildren"></a> |
|
2022 <h4>BrowserItem.removeChildren</h4> |
|
2023 <b>removeChildren</b>(<i></i>) |
|
2024 |
|
2025 <p> |
|
2026 Public method to remove all children. |
|
2027 </p> |
|
2028 <a NAME="BrowserItem.row" ID="BrowserItem.row"></a> |
|
2029 <h4>BrowserItem.row</h4> |
|
2030 <b>row</b>(<i></i>) |
|
2031 |
|
2032 <p> |
|
2033 Public method to get the row number of this item. |
|
2034 </p> |
|
2035 <dl> |
|
2036 <dt>Return:</dt> |
|
2037 <dd> |
|
2038 row number (integer) |
|
2039 </dd> |
|
2040 </dl> |
|
2041 <a NAME="BrowserItem.type" ID="BrowserItem.type"></a> |
|
2042 <h4>BrowserItem.type</h4> |
|
2043 <b>type</b>(<i></i>) |
|
2044 |
|
2045 <p> |
|
2046 Public method to get the item type. |
|
2047 </p> |
|
2048 <dl> |
|
2049 <dt>Return:</dt> |
|
2050 <dd> |
|
2051 type of the item |
|
2052 </dd> |
|
2053 </dl> |
|
2054 <div align="right"><a href="#top">Up</a></div> |
|
2055 <hr /> |
|
2056 <hr /> |
|
2057 <a NAME="BrowserMethodItem" ID="BrowserMethodItem"></a> |
|
2058 <h2>BrowserMethodItem</h2> |
|
2059 |
|
2060 <p> |
|
2061 Class implementing the data structure for browser method items. |
|
2062 </p> |
|
2063 <h3>Derived from</h3> |
|
2064 BrowserItem |
|
2065 <h3>Class Attributes</h3> |
|
2066 |
|
2067 <table> |
|
2068 <tr><td>None</td></tr> |
|
2069 </table> |
|
2070 <h3>Class Methods</h3> |
|
2071 |
|
2072 <table> |
|
2073 <tr><td>None</td></tr> |
|
2074 </table> |
|
2075 <h3>Methods</h3> |
|
2076 |
|
2077 <table> |
|
2078 |
|
2079 <tr> |
|
2080 <td><a href="#BrowserMethodItem.__init__">BrowserMethodItem</a></td> |
|
2081 <td>Constructor</td> |
|
2082 </tr> |
|
2083 <tr> |
|
2084 <td><a href="#BrowserMethodItem.boundaries">boundaries</a></td> |
|
2085 <td>Public method returning the boundaries of the method definition.</td> |
|
2086 </tr> |
|
2087 <tr> |
|
2088 <td><a href="#BrowserMethodItem.fileName">fileName</a></td> |
|
2089 <td>Public method returning the filename.</td> |
|
2090 </tr> |
|
2091 <tr> |
|
2092 <td><a href="#BrowserMethodItem.functionObject">functionObject</a></td> |
|
2093 <td>Public method returning the function object.</td> |
|
2094 </tr> |
|
2095 <tr> |
|
2096 <td><a href="#BrowserMethodItem.isPublic">isPublic</a></td> |
|
2097 <td>Public method returning the public visibility status.</td> |
|
2098 </tr> |
|
2099 <tr> |
|
2100 <td><a href="#BrowserMethodItem.lessThan">lessThan</a></td> |
|
2101 <td>Public method to check, if the item is less than the other one.</td> |
|
2102 </tr> |
|
2103 <tr> |
|
2104 <td><a href="#BrowserMethodItem.lineno">lineno</a></td> |
|
2105 <td>Public method returning the line number defining this object.</td> |
|
2106 </tr> |
|
2107 <tr> |
|
2108 <td><a href="#BrowserMethodItem.name">name</a></td> |
|
2109 <td>Public method to return the name of the item.</td> |
|
2110 </tr> |
|
2111 </table> |
|
2112 <h3>Static Methods</h3> |
|
2113 |
|
2114 <table> |
|
2115 <tr><td>None</td></tr> |
|
2116 </table> |
|
2117 |
|
2118 <a NAME="BrowserMethodItem.__init__" ID="BrowserMethodItem.__init__"></a> |
|
2119 <h4>BrowserMethodItem (Constructor)</h4> |
|
2120 <b>BrowserMethodItem</b>(<i>parent, fn, filename</i>) |
|
2121 |
|
2122 <p> |
|
2123 Constructor |
|
2124 </p> |
|
2125 <dl> |
|
2126 |
|
2127 <dt><i>parent</i></dt> |
|
2128 <dd> |
|
2129 parent item |
|
2130 </dd> |
|
2131 <dt><i>fn</i></dt> |
|
2132 <dd> |
|
2133 Function object to be shown |
|
2134 </dd> |
|
2135 <dt><i>filename</i></dt> |
|
2136 <dd> |
|
2137 filename of the file defining this class (string) |
|
2138 </dd> |
|
2139 </dl> |
|
2140 <a NAME="BrowserMethodItem.boundaries" ID="BrowserMethodItem.boundaries"></a> |
|
2141 <h4>BrowserMethodItem.boundaries</h4> |
|
2142 <b>boundaries</b>(<i></i>) |
|
2143 |
|
2144 <p> |
|
2145 Public method returning the boundaries of the method definition. |
|
2146 </p> |
|
2147 <dl> |
|
2148 <dt>Return:</dt> |
|
2149 <dd> |
|
2150 tuple with start end end line number (integer, integer) |
|
2151 </dd> |
|
2152 </dl> |
|
2153 <a NAME="BrowserMethodItem.fileName" ID="BrowserMethodItem.fileName"></a> |
|
2154 <h4>BrowserMethodItem.fileName</h4> |
|
2155 <b>fileName</b>(<i></i>) |
|
2156 |
|
2157 <p> |
|
2158 Public method returning the filename. |
|
2159 </p> |
|
2160 <dl> |
|
2161 <dt>Return:</dt> |
|
2162 <dd> |
|
2163 filename (string) |
|
2164 </dd> |
|
2165 </dl> |
|
2166 <a NAME="BrowserMethodItem.functionObject" ID="BrowserMethodItem.functionObject"></a> |
|
2167 <h4>BrowserMethodItem.functionObject</h4> |
|
2168 <b>functionObject</b>(<i></i>) |
|
2169 |
|
2170 <p> |
|
2171 Public method returning the function object. |
|
2172 </p> |
|
2173 <dl> |
|
2174 <dt>Return:</dt> |
|
2175 <dd> |
|
2176 reference to the function object |
|
2177 </dd> |
|
2178 </dl> |
|
2179 <a NAME="BrowserMethodItem.isPublic" ID="BrowserMethodItem.isPublic"></a> |
|
2180 <h4>BrowserMethodItem.isPublic</h4> |
|
2181 <b>isPublic</b>(<i></i>) |
|
2182 |
|
2183 <p> |
|
2184 Public method returning the public visibility status. |
|
2185 </p> |
|
2186 <dl> |
|
2187 <dt>Return:</dt> |
|
2188 <dd> |
|
2189 flag indicating public visibility (boolean) |
|
2190 </dd> |
|
2191 </dl> |
|
2192 <a NAME="BrowserMethodItem.lessThan" ID="BrowserMethodItem.lessThan"></a> |
|
2193 <h4>BrowserMethodItem.lessThan</h4> |
|
2194 <b>lessThan</b>(<i>other, column, order</i>) |
|
2195 |
|
2196 <p> |
|
2197 Public method to check, if the item is less than the other one. |
|
2198 </p> |
|
2199 <dl> |
|
2200 |
|
2201 <dt><i>other</i></dt> |
|
2202 <dd> |
|
2203 reference to item to compare against (BrowserItem) |
|
2204 </dd> |
|
2205 <dt><i>column</i></dt> |
|
2206 <dd> |
|
2207 column number to use for the comparison (integer) |
|
2208 </dd> |
|
2209 <dt><i>order</i></dt> |
|
2210 <dd> |
|
2211 sort order (Qt.SortOrder) (for special sorting) |
|
2212 </dd> |
|
2213 </dl> |
|
2214 <dl> |
|
2215 <dt>Return:</dt> |
|
2216 <dd> |
|
2217 true, if this item is less than other (boolean) |
|
2218 </dd> |
|
2219 </dl> |
|
2220 <a NAME="BrowserMethodItem.lineno" ID="BrowserMethodItem.lineno"></a> |
|
2221 <h4>BrowserMethodItem.lineno</h4> |
|
2222 <b>lineno</b>(<i></i>) |
|
2223 |
|
2224 <p> |
|
2225 Public method returning the line number defining this object. |
|
2226 </p> |
|
2227 <dl> |
|
2228 <dt>Return:</dt> |
|
2229 <dd> |
|
2230 line number defining the object (integer) |
|
2231 </dd> |
|
2232 </dl> |
|
2233 <a NAME="BrowserMethodItem.name" ID="BrowserMethodItem.name"></a> |
|
2234 <h4>BrowserMethodItem.name</h4> |
|
2235 <b>name</b>(<i></i>) |
|
2236 |
|
2237 <p> |
|
2238 Public method to return the name of the item. |
|
2239 </p> |
|
2240 <dl> |
|
2241 <dt>Return:</dt> |
|
2242 <dd> |
|
2243 name of the item (string) |
|
2244 </dd> |
|
2245 </dl> |
|
2246 <div align="right"><a href="#top">Up</a></div> |
|
2247 <hr /> |
|
2248 <hr /> |
|
2249 <a NAME="BrowserModel" ID="BrowserModel"></a> |
|
2250 <h2>BrowserModel</h2> |
|
2251 |
|
2252 <p> |
|
2253 Class implementing the browser model. |
|
2254 </p> |
|
2255 <h3>Derived from</h3> |
|
2256 QAbstractItemModel |
|
2257 <h3>Class Attributes</h3> |
|
2258 |
|
2259 <table> |
|
2260 <tr><td>None</td></tr> |
|
2261 </table> |
|
2262 <h3>Class Methods</h3> |
|
2263 |
|
2264 <table> |
|
2265 <tr><td>None</td></tr> |
|
2266 </table> |
|
2267 <h3>Methods</h3> |
|
2268 |
|
2269 <table> |
|
2270 |
|
2271 <tr> |
|
2272 <td><a href="#BrowserModel.__init__">BrowserModel</a></td> |
|
2273 <td>Constructor</td> |
|
2274 </tr> |
|
2275 <tr> |
|
2276 <td><a href="#BrowserModel.__populateModel">__populateModel</a></td> |
|
2277 <td>Private method to populate the browser model.</td> |
|
2278 </tr> |
|
2279 <tr> |
|
2280 <td><a href="#BrowserModel._addItem">_addItem</a></td> |
|
2281 <td>Protected slot to add an item.</td> |
|
2282 </tr> |
|
2283 <tr> |
|
2284 <td><a href="#BrowserModel._addWatchedItem">_addWatchedItem</a></td> |
|
2285 <td>Protected method to watch an item.</td> |
|
2286 </tr> |
|
2287 <tr> |
|
2288 <td><a href="#BrowserModel._removeWatchedItem">_removeWatchedItem</a></td> |
|
2289 <td>Protected method to remove a watched item.</td> |
|
2290 </tr> |
|
2291 <tr> |
|
2292 <td><a href="#BrowserModel.addItem">addItem</a></td> |
|
2293 <td>Public slot to add an item.</td> |
|
2294 </tr> |
|
2295 <tr> |
|
2296 <td><a href="#BrowserModel.addTopLevelDir">addTopLevelDir</a></td> |
|
2297 <td>Public method to add a new toplevel directory.</td> |
|
2298 </tr> |
|
2299 <tr> |
|
2300 <td><a href="#BrowserModel.clear">clear</a></td> |
|
2301 <td>Public method to clear the model.</td> |
|
2302 </tr> |
|
2303 <tr> |
|
2304 <td><a href="#BrowserModel.columnCount">columnCount</a></td> |
|
2305 <td>Public method to get the number of columns.</td> |
|
2306 </tr> |
|
2307 <tr> |
|
2308 <td><a href="#BrowserModel.data">data</a></td> |
|
2309 <td>Public method to get data of an item.</td> |
|
2310 </tr> |
|
2311 <tr> |
|
2312 <td><a href="#BrowserModel.directoryChanged">directoryChanged</a></td> |
|
2313 <td>Public slot to handle the directoryChanged signal of the watcher.</td> |
|
2314 </tr> |
|
2315 <tr> |
|
2316 <td><a href="#BrowserModel.fileChanged">fileChanged</a></td> |
|
2317 <td>Public method to react upon file changes.</td> |
|
2318 </tr> |
|
2319 <tr> |
|
2320 <td><a href="#BrowserModel.flags">flags</a></td> |
|
2321 <td>Public method to get the item flags.</td> |
|
2322 </tr> |
|
2323 <tr> |
|
2324 <td><a href="#BrowserModel.hasChildren">hasChildren</a></td> |
|
2325 <td>Public method to check for the presence of child items.</td> |
|
2326 </tr> |
|
2327 <tr> |
|
2328 <td><a href="#BrowserModel.headerData">headerData</a></td> |
|
2329 <td>Public method to get the header data.</td> |
|
2330 </tr> |
|
2331 <tr> |
|
2332 <td><a href="#BrowserModel.index">index</a></td> |
|
2333 <td>Public method to create an index.</td> |
|
2334 </tr> |
|
2335 <tr> |
|
2336 <td><a href="#BrowserModel.interpreterChanged">interpreterChanged</a></td> |
|
2337 <td>Public method to handle a change of the debug client's interpreter.</td> |
|
2338 </tr> |
|
2339 <tr> |
|
2340 <td><a href="#BrowserModel.item">item</a></td> |
|
2341 <td>Public method to get a reference to an item.</td> |
|
2342 </tr> |
|
2343 <tr> |
|
2344 <td><a href="#BrowserModel.parent">parent</a></td> |
|
2345 <td>Public method to get the index of the parent object.</td> |
|
2346 </tr> |
|
2347 <tr> |
|
2348 <td><a href="#BrowserModel.populateClassAttributesItem">populateClassAttributesItem</a></td> |
|
2349 <td>Public method to populate a class attributes item's subtree.</td> |
|
2350 </tr> |
|
2351 <tr> |
|
2352 <td><a href="#BrowserModel.populateClassItem">populateClassItem</a></td> |
|
2353 <td>Public method to populate a class item's subtree.</td> |
|
2354 </tr> |
|
2355 <tr> |
|
2356 <td><a href="#BrowserModel.populateDirectoryItem">populateDirectoryItem</a></td> |
|
2357 <td>Public method to populate a directory item's subtree.</td> |
|
2358 </tr> |
|
2359 <tr> |
|
2360 <td><a href="#BrowserModel.populateFileItem">populateFileItem</a></td> |
|
2361 <td>Public method to populate a file item's subtree.</td> |
|
2362 </tr> |
|
2363 <tr> |
|
2364 <td><a href="#BrowserModel.populateItem">populateItem</a></td> |
|
2365 <td>Public method to populate an item's subtree.</td> |
|
2366 </tr> |
|
2367 <tr> |
|
2368 <td><a href="#BrowserModel.populateMethodItem">populateMethodItem</a></td> |
|
2369 <td>Public method to populate a method item's subtree.</td> |
|
2370 </tr> |
|
2371 <tr> |
|
2372 <td><a href="#BrowserModel.populateSysPathItem">populateSysPathItem</a></td> |
|
2373 <td>Public method to populate a sys.path item's subtree.</td> |
|
2374 </tr> |
|
2375 <tr> |
|
2376 <td><a href="#BrowserModel.programChange">programChange</a></td> |
|
2377 <td>Public method to change the entry for the directory of file being debugged.</td> |
|
2378 </tr> |
|
2379 <tr> |
|
2380 <td><a href="#BrowserModel.removeToplevelDir">removeToplevelDir</a></td> |
|
2381 <td>Public method to remove a toplevel directory.</td> |
|
2382 </tr> |
|
2383 <tr> |
|
2384 <td><a href="#BrowserModel.repopulateFileItem">repopulateFileItem</a></td> |
|
2385 <td>Public method to repopulate a file item.</td> |
|
2386 </tr> |
|
2387 <tr> |
|
2388 <td><a href="#BrowserModel.rowCount">rowCount</a></td> |
|
2389 <td>Public method to get the number of rows.</td> |
|
2390 </tr> |
|
2391 <tr> |
|
2392 <td><a href="#BrowserModel.saveToplevelDirs">saveToplevelDirs</a></td> |
|
2393 <td>Public slot to save the toplevel directories.</td> |
|
2394 </tr> |
|
2395 </table> |
|
2396 <h3>Static Methods</h3> |
|
2397 |
|
2398 <table> |
|
2399 <tr><td>None</td></tr> |
|
2400 </table> |
|
2401 |
|
2402 <a NAME="BrowserModel.__init__" ID="BrowserModel.__init__"></a> |
|
2403 <h4>BrowserModel (Constructor)</h4> |
|
2404 <b>BrowserModel</b>(<i>parent=None, nopopulate=False</i>) |
|
2405 |
|
2406 <p> |
|
2407 Constructor |
|
2408 </p> |
|
2409 <dl> |
|
2410 |
|
2411 <dt><i>parent</i></dt> |
|
2412 <dd> |
|
2413 reference to parent object (QObject) |
|
2414 </dd> |
|
2415 <dt><i>nopopulate</i></dt> |
|
2416 <dd> |
|
2417 flag indicating to not populate the model |
|
2418 (boolean) |
|
2419 </dd> |
|
2420 </dl> |
|
2421 <a NAME="BrowserModel.__populateModel" ID="BrowserModel.__populateModel"></a> |
|
2422 <h4>BrowserModel.__populateModel</h4> |
|
2423 <b>__populateModel</b>(<i></i>) |
|
2424 |
|
2425 <p> |
|
2426 Private method to populate the browser model. |
|
2427 </p> |
|
2428 <a NAME="BrowserModel._addItem" ID="BrowserModel._addItem"></a> |
|
2429 <h4>BrowserModel._addItem</h4> |
|
2430 <b>_addItem</b>(<i>itm, parentItem</i>) |
|
2431 |
|
2432 <p> |
|
2433 Protected slot to add an item. |
|
2434 </p> |
|
2435 <dl> |
|
2436 |
|
2437 <dt><i>itm</i></dt> |
|
2438 <dd> |
|
2439 reference to item to add (BrowserItem) |
|
2440 </dd> |
|
2441 <dt><i>parentItem</i></dt> |
|
2442 <dd> |
|
2443 reference to item to add to (BrowserItem) |
|
2444 </dd> |
|
2445 </dl> |
|
2446 <a NAME="BrowserModel._addWatchedItem" ID="BrowserModel._addWatchedItem"></a> |
|
2447 <h4>BrowserModel._addWatchedItem</h4> |
|
2448 <b>_addWatchedItem</b>(<i>itm</i>) |
|
2449 |
|
2450 <p> |
|
2451 Protected method to watch an item. |
|
2452 </p> |
|
2453 <dl> |
|
2454 |
|
2455 <dt><i>itm</i></dt> |
|
2456 <dd> |
|
2457 item to be watched (BrowserDirectoryItem) |
|
2458 </dd> |
|
2459 </dl> |
|
2460 <a NAME="BrowserModel._removeWatchedItem" ID="BrowserModel._removeWatchedItem"></a> |
|
2461 <h4>BrowserModel._removeWatchedItem</h4> |
|
2462 <b>_removeWatchedItem</b>(<i>itm</i>) |
|
2463 |
|
2464 <p> |
|
2465 Protected method to remove a watched item. |
|
2466 </p> |
|
2467 <dl> |
|
2468 |
|
2469 <dt><i>itm</i></dt> |
|
2470 <dd> |
|
2471 item to be removed (BrowserDirectoryItem) |
|
2472 </dd> |
|
2473 </dl> |
|
2474 <a NAME="BrowserModel.addItem" ID="BrowserModel.addItem"></a> |
|
2475 <h4>BrowserModel.addItem</h4> |
|
2476 <b>addItem</b>(<i>itm, parent=None</i>) |
|
2477 |
|
2478 <p> |
|
2479 Public slot to add an item. |
|
2480 </p> |
|
2481 <dl> |
|
2482 |
|
2483 <dt><i>itm</i></dt> |
|
2484 <dd> |
|
2485 item to add (BrowserItem) |
|
2486 </dd> |
|
2487 <dt><i>parent</i></dt> |
|
2488 <dd> |
|
2489 index of parent item (QModelIndex) |
|
2490 </dd> |
|
2491 </dl> |
|
2492 <a NAME="BrowserModel.addTopLevelDir" ID="BrowserModel.addTopLevelDir"></a> |
|
2493 <h4>BrowserModel.addTopLevelDir</h4> |
|
2494 <b>addTopLevelDir</b>(<i>dirname</i>) |
|
2495 |
|
2496 <p> |
|
2497 Public method to add a new toplevel directory. |
|
2498 </p> |
|
2499 <dl> |
|
2500 |
|
2501 <dt><i>dirname</i></dt> |
|
2502 <dd> |
|
2503 name of the new toplevel directory (string) |
|
2504 </dd> |
|
2505 </dl> |
|
2506 <a NAME="BrowserModel.clear" ID="BrowserModel.clear"></a> |
|
2507 <h4>BrowserModel.clear</h4> |
|
2508 <b>clear</b>(<i></i>) |
|
2509 |
|
2510 <p> |
|
2511 Public method to clear the model. |
|
2512 </p> |
|
2513 <a NAME="BrowserModel.columnCount" ID="BrowserModel.columnCount"></a> |
|
2514 <h4>BrowserModel.columnCount</h4> |
|
2515 <b>columnCount</b>(<i>parent=None</i>) |
|
2516 |
|
2517 <p> |
|
2518 Public method to get the number of columns. |
|
2519 </p> |
|
2520 <dl> |
|
2521 |
|
2522 <dt><i>parent</i></dt> |
|
2523 <dd> |
|
2524 index of parent item (QModelIndex) |
|
2525 </dd> |
|
2526 </dl> |
|
2527 <dl> |
|
2528 <dt>Return:</dt> |
|
2529 <dd> |
|
2530 number of columns (integer) |
|
2531 </dd> |
|
2532 </dl> |
|
2533 <a NAME="BrowserModel.data" ID="BrowserModel.data"></a> |
|
2534 <h4>BrowserModel.data</h4> |
|
2535 <b>data</b>(<i>index, role</i>) |
|
2536 |
|
2537 <p> |
|
2538 Public method to get data of an item. |
|
2539 </p> |
|
2540 <dl> |
|
2541 |
|
2542 <dt><i>index</i></dt> |
|
2543 <dd> |
|
2544 index of the data to retrieve (QModelIndex) |
|
2545 </dd> |
|
2546 <dt><i>role</i></dt> |
|
2547 <dd> |
|
2548 role of data (Qt.ItemDataRole) |
|
2549 </dd> |
|
2550 </dl> |
|
2551 <dl> |
|
2552 <dt>Return:</dt> |
|
2553 <dd> |
|
2554 requested data |
|
2555 </dd> |
|
2556 </dl> |
|
2557 <a NAME="BrowserModel.directoryChanged" ID="BrowserModel.directoryChanged"></a> |
|
2558 <h4>BrowserModel.directoryChanged</h4> |
|
2559 <b>directoryChanged</b>(<i>path</i>) |
|
2560 |
|
2561 <p> |
|
2562 Public slot to handle the directoryChanged signal of the watcher. |
|
2563 </p> |
|
2564 <dl> |
|
2565 |
|
2566 <dt><i>path</i></dt> |
|
2567 <dd> |
|
2568 path of the directory (string) |
|
2569 </dd> |
|
2570 </dl> |
|
2571 <a NAME="BrowserModel.fileChanged" ID="BrowserModel.fileChanged"></a> |
|
2572 <h4>BrowserModel.fileChanged</h4> |
|
2573 <b>fileChanged</b>(<i>fileName</i>) |
|
2574 |
|
2575 <p> |
|
2576 Public method to react upon file changes. |
|
2577 </p> |
|
2578 <dl> |
|
2579 |
|
2580 <dt><i>fileName</i> (str)</dt> |
|
2581 <dd> |
|
2582 path of the changed file |
|
2583 </dd> |
|
2584 </dl> |
|
2585 <a NAME="BrowserModel.flags" ID="BrowserModel.flags"></a> |
|
2586 <h4>BrowserModel.flags</h4> |
|
2587 <b>flags</b>(<i>index</i>) |
|
2588 |
|
2589 <p> |
|
2590 Public method to get the item flags. |
|
2591 </p> |
|
2592 <dl> |
|
2593 |
|
2594 <dt><i>index</i></dt> |
|
2595 <dd> |
|
2596 index of the data to retrieve (QModelIndex) |
|
2597 </dd> |
|
2598 </dl> |
|
2599 <dl> |
|
2600 <dt>Return:</dt> |
|
2601 <dd> |
|
2602 requested flags (Qt.ItemFlags) |
|
2603 </dd> |
|
2604 </dl> |
|
2605 <a NAME="BrowserModel.hasChildren" ID="BrowserModel.hasChildren"></a> |
|
2606 <h4>BrowserModel.hasChildren</h4> |
|
2607 <b>hasChildren</b>(<i>parent=None</i>) |
|
2608 |
|
2609 <p> |
|
2610 Public method to check for the presence of child items. |
|
2611 </p> |
|
2612 <p> |
|
2613 We always return True for normal items in order to do lazy |
|
2614 population of the tree. |
|
2615 </p> |
|
2616 <dl> |
|
2617 |
|
2618 <dt><i>parent</i></dt> |
|
2619 <dd> |
|
2620 index of parent item (QModelIndex) |
|
2621 </dd> |
|
2622 </dl> |
|
2623 <dl> |
|
2624 <dt>Return:</dt> |
|
2625 <dd> |
|
2626 flag indicating the presence of child items (boolean) |
|
2627 </dd> |
|
2628 </dl> |
|
2629 <a NAME="BrowserModel.headerData" ID="BrowserModel.headerData"></a> |
|
2630 <h4>BrowserModel.headerData</h4> |
|
2631 <b>headerData</b>(<i>section, orientation, role=Qt.ItemDataRole.DisplayRole</i>) |
|
2632 |
|
2633 <p> |
|
2634 Public method to get the header data. |
|
2635 </p> |
|
2636 <dl> |
|
2637 |
|
2638 <dt><i>section</i></dt> |
|
2639 <dd> |
|
2640 number of section to get data for (integer) |
|
2641 </dd> |
|
2642 <dt><i>orientation</i></dt> |
|
2643 <dd> |
|
2644 header orientation (Qt.Orientation) |
|
2645 </dd> |
|
2646 <dt><i>role</i></dt> |
|
2647 <dd> |
|
2648 role of data (Qt.ItemDataRole) |
|
2649 </dd> |
|
2650 </dl> |
|
2651 <dl> |
|
2652 <dt>Return:</dt> |
|
2653 <dd> |
|
2654 requested header data |
|
2655 </dd> |
|
2656 </dl> |
|
2657 <a NAME="BrowserModel.index" ID="BrowserModel.index"></a> |
|
2658 <h4>BrowserModel.index</h4> |
|
2659 <b>index</b>(<i>row, column, parent=None</i>) |
|
2660 |
|
2661 <p> |
|
2662 Public method to create an index. |
|
2663 </p> |
|
2664 <dl> |
|
2665 |
|
2666 <dt><i>row</i></dt> |
|
2667 <dd> |
|
2668 row number of the new index (integer) |
|
2669 </dd> |
|
2670 <dt><i>column</i></dt> |
|
2671 <dd> |
|
2672 column number of the new index (integer) |
|
2673 </dd> |
|
2674 <dt><i>parent</i></dt> |
|
2675 <dd> |
|
2676 index of parent item (QModelIndex) |
|
2677 </dd> |
|
2678 </dl> |
|
2679 <dl> |
|
2680 <dt>Return:</dt> |
|
2681 <dd> |
|
2682 index object (QModelIndex) |
|
2683 </dd> |
|
2684 </dl> |
|
2685 <a NAME="BrowserModel.interpreterChanged" ID="BrowserModel.interpreterChanged"></a> |
|
2686 <h4>BrowserModel.interpreterChanged</h4> |
|
2687 <b>interpreterChanged</b>(<i>interpreter</i>) |
|
2688 |
|
2689 <p> |
|
2690 Public method to handle a change of the debug client's interpreter. |
|
2691 </p> |
|
2692 <dl> |
|
2693 |
|
2694 <dt><i>interpreter</i></dt> |
|
2695 <dd> |
|
2696 interpreter of the debug client (string) |
|
2697 </dd> |
|
2698 </dl> |
|
2699 <a NAME="BrowserModel.item" ID="BrowserModel.item"></a> |
|
2700 <h4>BrowserModel.item</h4> |
|
2701 <b>item</b>(<i>index</i>) |
|
2702 |
|
2703 <p> |
|
2704 Public method to get a reference to an item. |
|
2705 </p> |
|
2706 <dl> |
|
2707 |
|
2708 <dt><i>index</i></dt> |
|
2709 <dd> |
|
2710 index of the data to retrieve (QModelIndex) |
|
2711 </dd> |
|
2712 </dl> |
|
2713 <dl> |
|
2714 <dt>Return:</dt> |
|
2715 <dd> |
|
2716 requested item reference (BrowserItem) |
|
2717 </dd> |
|
2718 </dl> |
|
2719 <a NAME="BrowserModel.parent" ID="BrowserModel.parent"></a> |
|
2720 <h4>BrowserModel.parent</h4> |
|
2721 <b>parent</b>(<i>index</i>) |
|
2722 |
|
2723 <p> |
|
2724 Public method to get the index of the parent object. |
|
2725 </p> |
|
2726 <dl> |
|
2727 |
|
2728 <dt><i>index</i></dt> |
|
2729 <dd> |
|
2730 index of the item (QModelIndex) |
|
2731 </dd> |
|
2732 </dl> |
|
2733 <dl> |
|
2734 <dt>Return:</dt> |
|
2735 <dd> |
|
2736 index of parent item (QModelIndex) |
|
2737 </dd> |
|
2738 </dl> |
|
2739 <a NAME="BrowserModel.populateClassAttributesItem" ID="BrowserModel.populateClassAttributesItem"></a> |
|
2740 <h4>BrowserModel.populateClassAttributesItem</h4> |
|
2741 <b>populateClassAttributesItem</b>(<i>parentItem, repopulate=False</i>) |
|
2742 |
|
2743 <p> |
|
2744 Public method to populate a class attributes item's subtree. |
|
2745 </p> |
|
2746 <dl> |
|
2747 |
|
2748 <dt><i>parentItem</i></dt> |
|
2749 <dd> |
|
2750 reference to the class attributes item to be |
|
2751 populated |
|
2752 </dd> |
|
2753 <dt><i>repopulate</i></dt> |
|
2754 <dd> |
|
2755 flag indicating a repopulation (boolean) |
|
2756 </dd> |
|
2757 </dl> |
|
2758 <a NAME="BrowserModel.populateClassItem" ID="BrowserModel.populateClassItem"></a> |
|
2759 <h4>BrowserModel.populateClassItem</h4> |
|
2760 <b>populateClassItem</b>(<i>parentItem, repopulate=False</i>) |
|
2761 |
|
2762 <p> |
|
2763 Public method to populate a class item's subtree. |
|
2764 </p> |
|
2765 <dl> |
|
2766 |
|
2767 <dt><i>parentItem</i></dt> |
|
2768 <dd> |
|
2769 reference to the class item to be populated |
|
2770 </dd> |
|
2771 <dt><i>repopulate</i></dt> |
|
2772 <dd> |
|
2773 flag indicating a repopulation (boolean) |
|
2774 </dd> |
|
2775 </dl> |
|
2776 <a NAME="BrowserModel.populateDirectoryItem" ID="BrowserModel.populateDirectoryItem"></a> |
|
2777 <h4>BrowserModel.populateDirectoryItem</h4> |
|
2778 <b>populateDirectoryItem</b>(<i>parentItem, repopulate=False</i>) |
|
2779 |
|
2780 <p> |
|
2781 Public method to populate a directory item's subtree. |
|
2782 </p> |
|
2783 <dl> |
|
2784 |
|
2785 <dt><i>parentItem</i></dt> |
|
2786 <dd> |
|
2787 reference to the directory item to be populated |
|
2788 </dd> |
|
2789 <dt><i>repopulate</i></dt> |
|
2790 <dd> |
|
2791 flag indicating a repopulation (boolean) |
|
2792 </dd> |
|
2793 </dl> |
|
2794 <a NAME="BrowserModel.populateFileItem" ID="BrowserModel.populateFileItem"></a> |
|
2795 <h4>BrowserModel.populateFileItem</h4> |
|
2796 <b>populateFileItem</b>(<i>parentItem, repopulate=False</i>) |
|
2797 |
|
2798 <p> |
|
2799 Public method to populate a file item's subtree. |
|
2800 </p> |
|
2801 <dl> |
|
2802 |
|
2803 <dt><i>parentItem</i></dt> |
|
2804 <dd> |
|
2805 reference to the file item to be populated |
|
2806 </dd> |
|
2807 <dt><i>repopulate</i></dt> |
|
2808 <dd> |
|
2809 flag indicating a repopulation (boolean) |
|
2810 </dd> |
|
2811 </dl> |
|
2812 <a NAME="BrowserModel.populateItem" ID="BrowserModel.populateItem"></a> |
|
2813 <h4>BrowserModel.populateItem</h4> |
|
2814 <b>populateItem</b>(<i>parentItem, repopulate=False</i>) |
|
2815 |
|
2816 <p> |
|
2817 Public method to populate an item's subtree. |
|
2818 </p> |
|
2819 <dl> |
|
2820 |
|
2821 <dt><i>parentItem</i></dt> |
|
2822 <dd> |
|
2823 reference to the item to be populated |
|
2824 </dd> |
|
2825 <dt><i>repopulate</i></dt> |
|
2826 <dd> |
|
2827 flag indicating a repopulation (boolean) |
|
2828 </dd> |
|
2829 </dl> |
|
2830 <a NAME="BrowserModel.populateMethodItem" ID="BrowserModel.populateMethodItem"></a> |
|
2831 <h4>BrowserModel.populateMethodItem</h4> |
|
2832 <b>populateMethodItem</b>(<i>parentItem, repopulate=False</i>) |
|
2833 |
|
2834 <p> |
|
2835 Public method to populate a method item's subtree. |
|
2836 </p> |
|
2837 <dl> |
|
2838 |
|
2839 <dt><i>parentItem</i></dt> |
|
2840 <dd> |
|
2841 reference to the method item to be populated |
|
2842 </dd> |
|
2843 <dt><i>repopulate</i></dt> |
|
2844 <dd> |
|
2845 flag indicating a repopulation (boolean) |
|
2846 </dd> |
|
2847 </dl> |
|
2848 <a NAME="BrowserModel.populateSysPathItem" ID="BrowserModel.populateSysPathItem"></a> |
|
2849 <h4>BrowserModel.populateSysPathItem</h4> |
|
2850 <b>populateSysPathItem</b>(<i>parentItem, repopulate=False</i>) |
|
2851 |
|
2852 <p> |
|
2853 Public method to populate a sys.path item's subtree. |
|
2854 </p> |
|
2855 <dl> |
|
2856 |
|
2857 <dt><i>parentItem</i></dt> |
|
2858 <dd> |
|
2859 reference to the sys.path item to be populated |
|
2860 </dd> |
|
2861 <dt><i>repopulate</i></dt> |
|
2862 <dd> |
|
2863 flag indicating a repopulation (boolean) |
|
2864 </dd> |
|
2865 </dl> |
|
2866 <a NAME="BrowserModel.programChange" ID="BrowserModel.programChange"></a> |
|
2867 <h4>BrowserModel.programChange</h4> |
|
2868 <b>programChange</b>(<i>dirname</i>) |
|
2869 |
|
2870 <p> |
|
2871 Public method to change the entry for the directory of file being |
|
2872 debugged. |
|
2873 </p> |
|
2874 <dl> |
|
2875 |
|
2876 <dt><i>dirname</i></dt> |
|
2877 <dd> |
|
2878 name of the directory containing the file (string) |
|
2879 </dd> |
|
2880 </dl> |
|
2881 <a NAME="BrowserModel.removeToplevelDir" ID="BrowserModel.removeToplevelDir"></a> |
|
2882 <h4>BrowserModel.removeToplevelDir</h4> |
|
2883 <b>removeToplevelDir</b>(<i>index</i>) |
|
2884 |
|
2885 <p> |
|
2886 Public method to remove a toplevel directory. |
|
2887 </p> |
|
2888 <dl> |
|
2889 |
|
2890 <dt><i>index</i></dt> |
|
2891 <dd> |
|
2892 index of the toplevel directory to be removed |
|
2893 (QModelIndex) |
|
2894 </dd> |
|
2895 </dl> |
|
2896 <a NAME="BrowserModel.repopulateFileItem" ID="BrowserModel.repopulateFileItem"></a> |
|
2897 <h4>BrowserModel.repopulateFileItem</h4> |
|
2898 <b>repopulateFileItem</b>(<i>itm</i>) |
|
2899 |
|
2900 <p> |
|
2901 Public method to repopulate a file item. |
|
2902 </p> |
|
2903 <dl> |
|
2904 |
|
2905 <dt><i>itm</i> (BrowserFileItem)</dt> |
|
2906 <dd> |
|
2907 reference to the item to be repopulated |
|
2908 </dd> |
|
2909 </dl> |
|
2910 <a NAME="BrowserModel.rowCount" ID="BrowserModel.rowCount"></a> |
|
2911 <h4>BrowserModel.rowCount</h4> |
|
2912 <b>rowCount</b>(<i>parent=None</i>) |
|
2913 |
|
2914 <p> |
|
2915 Public method to get the number of rows. |
|
2916 </p> |
|
2917 <dl> |
|
2918 |
|
2919 <dt><i>parent</i></dt> |
|
2920 <dd> |
|
2921 index of parent item (QModelIndex) |
|
2922 </dd> |
|
2923 </dl> |
|
2924 <dl> |
|
2925 <dt>Return:</dt> |
|
2926 <dd> |
|
2927 number of rows (integer) |
|
2928 </dd> |
|
2929 </dl> |
|
2930 <a NAME="BrowserModel.saveToplevelDirs" ID="BrowserModel.saveToplevelDirs"></a> |
|
2931 <h4>BrowserModel.saveToplevelDirs</h4> |
|
2932 <b>saveToplevelDirs</b>(<i></i>) |
|
2933 |
|
2934 <p> |
|
2935 Public slot to save the toplevel directories. |
|
2936 </p> |
|
2937 <div align="right"><a href="#top">Up</a></div> |
|
2938 <hr /> |
|
2939 <hr /> |
|
2940 <a NAME="BrowserSysPathItem" ID="BrowserSysPathItem"></a> |
|
2941 <h2>BrowserSysPathItem</h2> |
|
2942 |
|
2943 <p> |
|
2944 Class implementing the data structure for browser sys.path items. |
|
2945 </p> |
|
2946 <h3>Derived from</h3> |
|
2947 BrowserItem |
|
2948 <h3>Class Attributes</h3> |
|
2949 |
|
2950 <table> |
|
2951 <tr><td>None</td></tr> |
|
2952 </table> |
|
2953 <h3>Class Methods</h3> |
|
2954 |
|
2955 <table> |
|
2956 <tr><td>None</td></tr> |
|
2957 </table> |
|
2958 <h3>Methods</h3> |
|
2959 |
|
2960 <table> |
|
2961 |
|
2962 <tr> |
|
2963 <td><a href="#BrowserSysPathItem.__init__">BrowserSysPathItem</a></td> |
|
2964 <td>Constructor</td> |
|
2965 </tr> |
|
2966 <tr> |
|
2967 <td><a href="#BrowserSysPathItem.name">name</a></td> |
|
2968 <td>Public method to return the name of the item.</td> |
|
2969 </tr> |
|
2970 </table> |
|
2971 <h3>Static Methods</h3> |
|
2972 |
|
2973 <table> |
|
2974 <tr><td>None</td></tr> |
|
2975 </table> |
|
2976 |
|
2977 <a NAME="BrowserSysPathItem.__init__" ID="BrowserSysPathItem.__init__"></a> |
|
2978 <h4>BrowserSysPathItem (Constructor)</h4> |
|
2979 <b>BrowserSysPathItem</b>(<i>parent</i>) |
|
2980 |
|
2981 <p> |
|
2982 Constructor |
|
2983 </p> |
|
2984 <dl> |
|
2985 |
|
2986 <dt><i>parent</i></dt> |
|
2987 <dd> |
|
2988 parent item |
|
2989 </dd> |
|
2990 </dl> |
|
2991 <a NAME="BrowserSysPathItem.name" ID="BrowserSysPathItem.name"></a> |
|
2992 <h4>BrowserSysPathItem.name</h4> |
|
2993 <b>name</b>(<i></i>) |
|
2994 |
|
2995 <p> |
|
2996 Public method to return the name of the item. |
|
2997 </p> |
|
2998 <dl> |
|
2999 <dt>Return:</dt> |
|
3000 <dd> |
|
3001 name of the item (string) |
|
3002 </dd> |
|
3003 </dl> |
|
3004 <div align="right"><a href="#top">Up</a></div> |
|
3005 <hr /> |
|
3006 </body></html> |