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