~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric3doc-eric3.UI.Browser.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
2
 
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
3
 
<html><head>
4
 
<title>eric3.UI.Browser</title>
5
 
</head>
6
 
<body bgcolor="#FFFFFF"><a NAME="top" ID="top"></a>
7
 
<h1><font color="#0000FF">eric3.UI.Browser</font></h1>
8
 
<p>
9
 
Module implementing a browser with class browsing capabilities.
10
 
</p><p>
11
 
The class browsing part is based on IDLE's classbrowser.
12
 
</p>
13
 
<h3><font color="#FF0000">Classes</font></h3>
14
 
<table>
15
 
<tr>
16
 
<td><a href="#Browser">Browser</a></td>
17
 
<td>Class used to display a file system tree.</td>
18
 
</tr><tr>
19
 
<td><a href="#BrowserClass">BrowserClass</a></td>
20
 
<td>Class implementing a BrowserNode that represents a python class or function.</td>
21
 
</tr><tr>
22
 
<td><a href="#BrowserClassAttributes">BrowserClassAttributes</a></td>
23
 
<td>Class implementing a BrowserNode that represents the attributes of a python class.</td>
24
 
</tr><tr>
25
 
<td><a href="#BrowserDirectory">BrowserDirectory</a></td>
26
 
<td>Class implementing a BrowserNode that represents a directory.</td>
27
 
</tr><tr>
28
 
<td><a href="#BrowserFile">BrowserFile</a></td>
29
 
<td>Class implementing a BrowserNode that represents a file.</td>
30
 
</tr><tr>
31
 
<td><a href="#BrowserMethod">BrowserMethod</a></td>
32
 
<td>Class implementing a BrowserNode that represents a python method.</td>
33
 
</tr><tr>
34
 
<td><a href="#BrowserNode">BrowserNode</a></td>
35
 
<td>Class implementing a thin wrapper around QListViewItem.</td>
36
 
</tr><tr>
37
 
<td><a href="#BrowserSysPath">BrowserSysPath</a></td>
38
 
<td>Class implementing a BrowserNode that represents the Python sys.path.</td>
39
 
</tr>
40
 
</table>
41
 
<h3><font color="#FF0000">Functions</font></h3>
42
 
<table>
43
 
<tr><td>None</td></tr>
44
 
</table>
45
 
<hr /><hr />
46
 
<a NAME="Browser" ID="Browser"></a>
47
 
<h2><font color="#0000FF">Browser</font></h2>
48
 
<p>
49
 
    Class used to display a file system tree. 
50
 
</p><p>
51
 
    Via the context menu that
52
 
    is displayed by a right click the user can select various actions on
53
 
    the selected file.
54
 
</p><h4>Signals</h4>
55
 
<dl>
56
 
<dt>designerFile(string)</dt>
57
 
<dd>
58
 
emitted to open a Qt-Designer file
59
 
</dd><dt>linguistFile(string)</dt>
60
 
<dd>
61
 
emitted to open a Qt-Linguist file
62
 
</dd><dt>pixmapFile(string)</dt>
63
 
<dd>
64
 
emitted to open a pixmap file
65
 
</dd><dt>projectFile(string)</dt>
66
 
<dd>
67
 
emitted to open an eric3 project file
68
 
</dd><dt>pythonFile(string, int)</dt>
69
 
<dd>
70
 
emitted to open a Python file at a line
71
 
</dd><dt>unittestOpen(string)</dt>
72
 
<dd>
73
 
emitted to open a Python file for a unittest
74
 
</dd>
75
 
</dl>
76
 
<h3><font color="#FF0000">Derived from</font></h3>
77
 
QListView
78
 
<h3><font color="#FF0000">Methods</font></h3>
79
 
<table>
80
 
<tr>
81
 
<td><a href="#Browser.__init__">Browser</a></td>
82
 
<td>Constructor</td>
83
 
</tr><tr>
84
 
<td><a href="#Browser.contentsMouseDoubleClickEvent">contentsMouseDoubleClickEvent</a></td>
85
 
<td>Protected method of QListView.</td>
86
 
</tr><tr>
87
 
<td><a href="#Browser.createPopupMenus">createPopupMenus</a></td>
88
 
<td>Private method to generate the various popup menus.</td>
89
 
</tr><tr>
90
 
<td><a href="#Browser.getItemsFiltered">getItemsFiltered</a></td>
91
 
<td>Public method to get the items of a specific type.</td>
92
 
</tr><tr>
93
 
<td><a href="#Browser.getSelectedItems">getSelectedItems</a></td>
94
 
<td>Public method to get the selected items.</td>
95
 
</tr><tr>
96
 
<td><a href="#Browser.getSelectedItemsCount">getSelectedItemsCount</a></td>
97
 
<td>Public method to get the count of items selcted.</td>
98
 
</tr><tr>
99
 
<td><a href="#Browser.handleAddAsToplevelDir">handleAddAsToplevelDir</a></td>
100
 
<td>Private slot to handle the Add as toplevel directory popup menu entry.</td>
101
 
</tr><tr>
102
 
<td><a href="#Browser.handleContextMenu">handleContextMenu</a></td>
103
 
<td>Private slot to show the context menu of the listview.</td>
104
 
</tr><tr>
105
 
<td><a href="#Browser.handleNewToplevelDir">handleNewToplevelDir</a></td>
106
 
<td>Private slot to handle the New toplevel directory popup menu entry.</td>
107
 
</tr><tr>
108
 
<td><a href="#Browser.handleOpen">handleOpen</a></td>
109
 
<td>Private slot to handle the open popup menu entry.</td>
110
 
</tr><tr>
111
 
<td><a href="#Browser.handlePreferencesChanged">handlePreferencesChanged</a></td>
112
 
<td>Public slot used to handle the preferencesChanged signal.</td>
113
 
</tr><tr>
114
 
<td><a href="#Browser.handleProgramChange">handleProgramChange</a></td>
115
 
<td>Public slot to handle the programChange signal.</td>
116
 
</tr><tr>
117
 
<td><a href="#Browser.handleRemoveToplevel">handleRemoveToplevel</a></td>
118
 
<td>Private slot to handle the Remove from toplevel popup menu entry.</td>
119
 
</tr><tr>
120
 
<td><a href="#Browser.handleUnittest">handleUnittest</a></td>
121
 
<td>Private slot to handle the unittest popup menu entry.</td>
122
 
</tr><tr>
123
 
<td><a href="#Browser.refreshTree">refreshTree</a></td>
124
 
<td>Private slot to refresh the tree.</td>
125
 
</tr><tr>
126
 
<td><a href="#Browser.saveToplevelDirs">saveToplevelDirs</a></td>
127
 
<td>Public slot to save the toplevel directories.</td>
128
 
</tr><tr>
129
 
<td><a href="#Browser.wantedItem">wantedItem</a></td>
130
 
<td>Private method to check type of a listview item.</td>
131
 
</tr>
132
 
</table>
133
 
<p><a NAME="Browser.__init__" ID="Browser__init__"></a>
134
 
<h3><font color="#0000FF">Browser (Constructor)</font></h3>
135
 
<b>Browser</b>(<i>parent=None</i>)
136
 
<p>
137
 
        Constructor
138
 
</p><dl>
139
 
<dt><i>parent</i></dt>
140
 
<dd>
141
 
parent widget (QWidget)
142
 
</dd>
143
 
</dl><a NAME="Browser.contentsMouseDoubleClickEvent" ID="BrowsercontentsMouseDoubleClickEvent"></a>
144
 
<h3><font color="#0000FF">Browser.contentsMouseDoubleClickEvent</font></h3>
145
 
<b>contentsMouseDoubleClickEvent</b>(<i>mouseEvent</i>)
146
 
<p>
147
 
        Protected method of QListView. 
148
 
</p><p>
149
 
        Reimplemented to disable expanding/collapsing
150
 
        of items when double-clicking. Instead the double-clicked entry is opened.
151
 
</p><dl>
152
 
<dt><i>mouseEvent</i></dt>
153
 
<dd>
154
 
the mouse event (QMouseEvent)
155
 
</dd>
156
 
</dl><a NAME="Browser.createPopupMenus" ID="BrowsercreatePopupMenus"></a>
157
 
<h3><font color="#0000FF">Browser.createPopupMenus</font></h3>
158
 
<b>createPopupMenus</b>(<i></i>)
159
 
<p>
160
 
        Private method to generate the various popup menus.
161
 
</p><a NAME="Browser.getItemsFiltered" ID="BrowsergetItemsFiltered"></a>
162
 
<h3><font color="#0000FF">Browser.getItemsFiltered</font></h3>
163
 
<b>getItemsFiltered</b>(<i>filter</i>)
164
 
<p>
165
 
        Public method to get the items of a specific type.
166
 
</p><dl>
167
 
<dt><i>filter</i></dt>
168
 
<dd>
169
 
list of class to check against
170
 
</dd>
171
 
</dl><dl>
172
 
<dt>Returns:</dt>
173
 
<dd>
174
 
list of items (list of QListViewItem)
175
 
</dd>
176
 
</dl><a NAME="Browser.getSelectedItems" ID="BrowsergetSelectedItems"></a>
177
 
<h3><font color="#0000FF">Browser.getSelectedItems</font></h3>
178
 
<b>getSelectedItems</b>(<i>filter=None</i>)
179
 
<p>
180
 
        Public method to get the selected items.
181
 
</p><dl>
182
 
<dt><i>filter</i></dt>
183
 
<dd>
184
 
list of class to check against
185
 
</dd>
186
 
</dl><dl>
187
 
<dt>Returns:</dt>
188
 
<dd>
189
 
list of selected items (list of QListViewItem)
190
 
</dd>
191
 
</dl><a NAME="Browser.getSelectedItemsCount" ID="BrowsergetSelectedItemsCount"></a>
192
 
<h3><font color="#0000FF">Browser.getSelectedItemsCount</font></h3>
193
 
<b>getSelectedItemsCount</b>(<i>filter=None</i>)
194
 
<p>
195
 
        Public method to get the count of items selcted.
196
 
</p><dl>
197
 
<dt><i>filter</i></dt>
198
 
<dd>
199
 
list of class to check against
200
 
</dd>
201
 
</dl><dl>
202
 
<dt>Returns:</dt>
203
 
<dd>
204
 
count of items selected (integer)
205
 
</dd>
206
 
</dl><a NAME="Browser.handleAddAsToplevelDir" ID="BrowserhandleAddAsToplevelDir"></a>
207
 
<h3><font color="#0000FF">Browser.handleAddAsToplevelDir</font></h3>
208
 
<b>handleAddAsToplevelDir</b>(<i></i>)
209
 
<p>
210
 
        Private slot to handle the Add as toplevel directory popup menu entry.
211
 
</p><a NAME="Browser.handleContextMenu" ID="BrowserhandleContextMenu"></a>
212
 
<h3><font color="#0000FF">Browser.handleContextMenu</font></h3>
213
 
<b>handleContextMenu</b>(<i>itm, coord, col</i>)
214
 
<p>
215
 
        Private slot to show the context menu of the listview.
216
 
</p><dl>
217
 
<dt><i>itm</i></dt>
218
 
<dd>
219
 
the selected listview item (QListViewItem)
220
 
</dd><dt><i>coord</i></dt>
221
 
<dd>
222
 
the position of the mouse pointer (QPoint)
223
 
</dd><dt><i>col</i></dt>
224
 
<dd>
225
 
the column of the mouse pointer (int)
226
 
</dd>
227
 
</dl><a NAME="Browser.handleNewToplevelDir" ID="BrowserhandleNewToplevelDir"></a>
228
 
<h3><font color="#0000FF">Browser.handleNewToplevelDir</font></h3>
229
 
<b>handleNewToplevelDir</b>(<i></i>)
230
 
<p>
231
 
        Private slot to handle the New toplevel directory popup menu entry.
232
 
</p><a NAME="Browser.handleOpen" ID="BrowserhandleOpen"></a>
233
 
<h3><font color="#0000FF">Browser.handleOpen</font></h3>
234
 
<b>handleOpen</b>(<i></i>)
235
 
<p>
236
 
        Private slot to handle the open popup menu entry.
237
 
</p><a NAME="Browser.handlePreferencesChanged" ID="BrowserhandlePreferencesChanged"></a>
238
 
<h3><font color="#0000FF">Browser.handlePreferencesChanged</font></h3>
239
 
<b>handlePreferencesChanged</b>(<i></i>)
240
 
<p>
241
 
        Public slot used to handle the preferencesChanged signal.
242
 
</p><a NAME="Browser.handleProgramChange" ID="BrowserhandleProgramChange"></a>
243
 
<h3><font color="#0000FF">Browser.handleProgramChange</font></h3>
244
 
<b>handleProgramChange</b>(<i>fn</i>)
245
 
<p>
246
 
        Public slot to handle the programChange signal.
247
 
</p><a NAME="Browser.handleRemoveToplevel" ID="BrowserhandleRemoveToplevel"></a>
248
 
<h3><font color="#0000FF">Browser.handleRemoveToplevel</font></h3>
249
 
<b>handleRemoveToplevel</b>(<i></i>)
250
 
<p>
251
 
        Private slot to handle the Remove from toplevel popup menu entry.
252
 
</p><a NAME="Browser.handleUnittest" ID="BrowserhandleUnittest"></a>
253
 
<h3><font color="#0000FF">Browser.handleUnittest</font></h3>
254
 
<b>handleUnittest</b>(<i></i>)
255
 
<p>
256
 
        Private slot to handle the unittest popup menu entry.
257
 
</p><a NAME="Browser.refreshTree" ID="BrowserrefreshTree"></a>
258
 
<h3><font color="#0000FF">Browser.refreshTree</font></h3>
259
 
<b>refreshTree</b>(<i></i>)
260
 
<p>
261
 
        Private slot to refresh the tree.
262
 
</p><p>
263
 
        The tree is refreshed by closing all open items and reopening them.
264
 
</p><a NAME="Browser.saveToplevelDirs" ID="BrowsersaveToplevelDirs"></a>
265
 
<h3><font color="#0000FF">Browser.saveToplevelDirs</font></h3>
266
 
<b>saveToplevelDirs</b>(<i></i>)
267
 
<p>
268
 
        Public slot to save the toplevel directories.
269
 
</p><a NAME="Browser.wantedItem" ID="BrowserwantedItem"></a>
270
 
<h3><font color="#0000FF">Browser.wantedItem</font></h3>
271
 
<b>wantedItem</b>(<i>itm, filter=None</i>)
272
 
<p>
273
 
        Private method to check type of a listview item.
274
 
</p><dl>
275
 
<dt><i>itm</i></dt>
276
 
<dd>
277
 
the listview item to check (QListViewItem)
278
 
</dd><dt><i>filter</i></dt>
279
 
<dd>
280
 
list of class to check against
281
 
</dd>
282
 
</dl><dl>
283
 
<dt>Returns:</dt>
284
 
<dd>
285
 
flag indicating item is a valid type (boolean)
286
 
</dd>
287
 
</dl></p>
288
 
<div align="right"><a href="#top">Up</a></div>
289
 
<hr /><hr />
290
 
<a NAME="BrowserClass" ID="BrowserClass"></a>
291
 
<h2><font color="#0000FF">BrowserClass</font></h2>
292
 
<p>
293
 
    Class implementing a BrowserNode that represents a python class or function. 
294
 
</p>
295
 
<h3><font color="#FF0000">Derived from</font></h3>
296
 
BrowserNode
297
 
<h3><font color="#FF0000">Methods</font></h3>
298
 
<table>
299
 
<tr>
300
 
<td><a href="#BrowserClass.__init__">BrowserClass</a></td>
301
 
<td>Constructor</td>
302
 
</tr><tr>
303
 
<td><a href="#BrowserClass.fileName">fileName</a></td>
304
 
<td>Public method returning the name of the file defining this class.</td>
305
 
</tr><tr>
306
 
<td><a href="#BrowserClass.setOpen">setOpen</a></td>
307
 
<td>Public slot to set/reset the open state.</td>
308
 
</tr>
309
 
</table>
310
 
<p><a NAME="BrowserClass.__init__" ID="BrowserClass__init__"></a>
311
 
<h3><font color="#0000FF">BrowserClass (Constructor)</font></h3>
312
 
<b>BrowserClass</b>(<i>parent, cl, after, filename</i>)
313
 
<p>
314
 
        Constructor
315
 
</p><dl>
316
 
<dt><i>parent</i></dt>
317
 
<dd>
318
 
parent Browser or BrowserNode
319
 
</dd><dt><i>cl</i></dt>
320
 
<dd>
321
 
Class object to be shown
322
 
</dd><dt><i>after</i></dt>
323
 
<dd>
324
 
sibling this node is positioned after
325
 
</dd><dt><i>filename</i></dt>
326
 
<dd>
327
 
filename of the file defining this class
328
 
</dd>
329
 
</dl><a NAME="BrowserClass.fileName" ID="BrowserClassfileName"></a>
330
 
<h3><font color="#0000FF">BrowserClass.fileName</font></h3>
331
 
<b>fileName</b>(<i></i>)
332
 
<p>
333
 
        Public method returning the name of the file defining this class.
334
 
</p><dl>
335
 
<dt>Returns:</dt>
336
 
<dd>
337
 
filename (string)
338
 
</dd>
339
 
</dl><a NAME="BrowserClass.setOpen" ID="BrowserClasssetOpen"></a>
340
 
<h3><font color="#0000FF">BrowserClass.setOpen</font></h3>
341
 
<b>setOpen</b>(<i>o</i>)
342
 
<p>
343
 
        Public slot to set/reset the open state.
344
 
</p><dl>
345
 
<dt><i>o</i></dt>
346
 
<dd>
347
 
flag indicating the open state
348
 
</dd>
349
 
</dl></p>
350
 
<div align="right"><a href="#top">Up</a></div>
351
 
<hr /><hr />
352
 
<a NAME="BrowserClassAttributes" ID="BrowserClassAttributes"></a>
353
 
<h2><font color="#0000FF">BrowserClassAttributes</font></h2>
354
 
<p>
355
 
    Class implementing a BrowserNode that represents the attributes of a python class. 
356
 
</p>
357
 
<h3><font color="#FF0000">Derived from</font></h3>
358
 
BrowserNode
359
 
<h3><font color="#FF0000">Methods</font></h3>
360
 
<table>
361
 
<tr>
362
 
<td><a href="#BrowserClassAttributes.__init__">BrowserClassAttributes</a></td>
363
 
<td>Constructor</td>
364
 
</tr><tr>
365
 
<td><a href="#BrowserClassAttributes.setOpen">setOpen</a></td>
366
 
<td>Public slot to set/reset the open state.</td>
367
 
</tr>
368
 
</table>
369
 
<p><a NAME="BrowserClassAttributes.__init__" ID="BrowserClassAttributes__init__"></a>
370
 
<h3><font color="#0000FF">BrowserClassAttributes (Constructor)</font></h3>
371
 
<b>BrowserClassAttributes</b>(<i>parent, after, attributes</i>)
372
 
<p>
373
 
        Constructor
374
 
</p><dl>
375
 
<dt><i>parent</i></dt>
376
 
<dd>
377
 
parent Browser or BrowserNode
378
 
</dd><dt><i>after</i></dt>
379
 
<dd>
380
 
sibling this node is positioned after
381
 
</dd><dt><i>attributes</i></dt>
382
 
<dd>
383
 
list of attribute names
384
 
</dd>
385
 
</dl><a NAME="BrowserClassAttributes.setOpen" ID="BrowserClassAttributessetOpen"></a>
386
 
<h3><font color="#0000FF">BrowserClassAttributes.setOpen</font></h3>
387
 
<b>setOpen</b>(<i>o</i>)
388
 
<p>
389
 
        Public slot to set/reset the open state.
390
 
</p><dl>
391
 
<dt><i>o</i></dt>
392
 
<dd>
393
 
flag indicating the open state
394
 
</dd>
395
 
</dl></p>
396
 
<div align="right"><a href="#top">Up</a></div>
397
 
<hr /><hr />
398
 
<a NAME="BrowserDirectory" ID="BrowserDirectory"></a>
399
 
<h2><font color="#0000FF">BrowserDirectory</font></h2>
400
 
<p>
401
 
    Class implementing a BrowserNode that represents a directory.  
402
 
</p>
403
 
<h3><font color="#FF0000">Derived from</font></h3>
404
 
BrowserNode
405
 
<h3><font color="#FF0000">Methods</font></h3>
406
 
<table>
407
 
<tr>
408
 
<td><a href="#BrowserDirectory.__init__">BrowserDirectory</a></td>
409
 
<td>Constructor</td>
410
 
</tr><tr>
411
 
<td><a href="#BrowserDirectory.compare">compare</a></td>
412
 
<td>Private method to compare two items.</td>
413
 
</tr><tr>
414
 
<td><a href="#BrowserDirectory.fileName">fileName</a></td>
415
 
<td>Public method returning the directory name of this node.</td>
416
 
</tr><tr>
417
 
<td><a href="#BrowserDirectory.setOpen">setOpen</a></td>
418
 
<td>Public slot to set/reset the open state.</td>
419
 
</tr>
420
 
</table>
421
 
<p><a NAME="BrowserDirectory.__init__" ID="BrowserDirectory__init__"></a>
422
 
<h3><font color="#0000FF">BrowserDirectory (Constructor)</font></h3>
423
 
<b>BrowserDirectory</b>(<i>parent, dinfo, after, full=1, bold=0</i>)
424
 
<p>
425
 
        Constructor
426
 
</p><dl>
427
 
<dt><i>parent</i></dt>
428
 
<dd>
429
 
parent Browser or BrowserNode
430
 
</dd><dt><i>dinfo</i></dt>
431
 
<dd>
432
 
dinfo is the string for the directory (string or QString)
433
 
</dd><dt><i>after</i></dt>
434
 
<dd>
435
 
sibling this node is positioned after
436
 
</dd><dt><i>full</i></dt>
437
 
<dd>
438
 
flag indicating full pathname should be displayed (boolean)
439
 
</dd><dt><i>bold</i></dt>
440
 
<dd>
441
 
flag indicating a highlighted display (boolean)
442
 
</dd>
443
 
</dl><a NAME="BrowserDirectory.compare" ID="BrowserDirectorycompare"></a>
444
 
<h3><font color="#0000FF">BrowserDirectory.compare</font></h3>
445
 
<b>compare</b>(<i>item, col, ascending</i>)
446
 
<p>
447
 
        Private method to compare two items.
448
 
</p><a NAME="BrowserDirectory.fileName" ID="BrowserDirectoryfileName"></a>
449
 
<h3><font color="#0000FF">BrowserDirectory.fileName</font></h3>
450
 
<b>fileName</b>(<i></i>)
451
 
<p>
452
 
        Public method returning the directory name of this node.
453
 
</p><dl>
454
 
<dt>Returns:</dt>
455
 
<dd>
456
 
directory name (string)
457
 
</dd>
458
 
</dl><a NAME="BrowserDirectory.setOpen" ID="BrowserDirectorysetOpen"></a>
459
 
<h3><font color="#0000FF">BrowserDirectory.setOpen</font></h3>
460
 
<b>setOpen</b>(<i>o</i>)
461
 
<p>
462
 
        Public slot to set/reset the open state.
463
 
</p><dl>
464
 
<dt><i>o</i></dt>
465
 
<dd>
466
 
flag indicating the open state
467
 
</dd>
468
 
</dl></p>
469
 
<div align="right"><a href="#top">Up</a></div>
470
 
<hr /><hr />
471
 
<a NAME="BrowserFile" ID="BrowserFile"></a>
472
 
<h2><font color="#0000FF">BrowserFile</font></h2>
473
 
<p>
474
 
    Class implementing a BrowserNode that represents a file.  
475
 
</p>
476
 
<h3><font color="#FF0000">Derived from</font></h3>
477
 
BrowserNode
478
 
<h3><font color="#FF0000">Methods</font></h3>
479
 
<table>
480
 
<tr>
481
 
<td><a href="#BrowserFile.__init__">BrowserFile</a></td>
482
 
<td>Constructor</td>
483
 
</tr><tr>
484
 
<td><a href="#BrowserFile.compare">compare</a></td>
485
 
<td>Private method to compare two items.</td>
486
 
</tr><tr>
487
 
<td><a href="#BrowserFile.fileName">fileName</a></td>
488
 
<td>Public method returning the filename.</td>
489
 
</tr><tr>
490
 
<td><a href="#BrowserFile.isDesignerFile">isDesignerFile</a></td>
491
 
<td>Public method to check, if this file is a Qt-Designer file.</td>
492
 
</tr><tr>
493
 
<td><a href="#BrowserFile.isDesignerHeaderFile">isDesignerHeaderFile</a></td>
494
 
<td>Public method to check, if this file is a Qt-Designer header file.</td>
495
 
</tr><tr>
496
 
<td><a href="#BrowserFile.isIdlFile">isIdlFile</a></td>
497
 
<td>Public method to check, if this file is a CORBA IDL file.</td>
498
 
</tr><tr>
499
 
<td><a href="#BrowserFile.isLinguistFile">isLinguistFile</a></td>
500
 
<td>Public method to check, if this file is a Qt-Linguist.</td>
501
 
</tr><tr>
502
 
<td><a href="#BrowserFile.isPixmapFile">isPixmapFile</a></td>
503
 
<td>Public method to check, if this file is a pixmap file.</td>
504
 
</tr><tr>
505
 
<td><a href="#BrowserFile.isProjectFile">isProjectFile</a></td>
506
 
<td>Public method to check, if this file is an eric3 project file.</td>
507
 
</tr><tr>
508
 
<td><a href="#BrowserFile.isPythonFile">isPythonFile</a></td>
509
 
<td>Public method to check, if this file is a Python script.</td>
510
 
</tr><tr>
511
 
<td><a href="#BrowserFile.isRubyFile">isRubyFile</a></td>
512
 
<td>Public method to check, if this file is a Ruby script.</td>
513
 
</tr><tr>
514
 
<td><a href="#BrowserFile.setOpen">setOpen</a></td>
515
 
<td>Public slot to set/reset the open state.</td>
516
 
</tr>
517
 
</table>
518
 
<p><a NAME="BrowserFile.__init__" ID="BrowserFile__init__"></a>
519
 
<h3><font color="#0000FF">BrowserFile (Constructor)</font></h3>
520
 
<b>BrowserFile</b>(<i>parent, finfo, after, special=0, dtext=QString.null, bold=0, isPyFile=0</i>)
521
 
<p>
522
 
        Constructor
523
 
</p><dl>
524
 
<dt><i>parent</i></dt>
525
 
<dd>
526
 
parent Browser or BrowserNode
527
 
</dd><dt><i>finfo</i></dt>
528
 
<dd>
529
 
the string for the file (string)
530
 
</dd><dt><i>after</i></dt>
531
 
<dd>
532
 
sibling this node is positioned after
533
 
</dd><dt><i>special</i></dt>
534
 
<dd>
535
 
flag indicating special treatment (boolean)
536
 
</dd><dt><i>dtext</i></dt>
537
 
<dd>
538
 
display text if special is set (string or QString)
539
 
</dd><dt><i>bold</i></dt>
540
 
<dd>
541
 
flag indicating a highlighted display (boolean)
542
 
</dd><dt><i>isPyFile</i></dt>
543
 
<dd>
544
 
flag indicating that this is a Python file
545
 
                even if it doesn't have the .py extension (boolean)
546
 
</dd>
547
 
</dl><a NAME="BrowserFile.compare" ID="BrowserFilecompare"></a>
548
 
<h3><font color="#0000FF">BrowserFile.compare</font></h3>
549
 
<b>compare</b>(<i>item, col, ascending</i>)
550
 
<p>
551
 
        Private method to compare two items.
552
 
</p><a NAME="BrowserFile.fileName" ID="BrowserFilefileName"></a>
553
 
<h3><font color="#0000FF">BrowserFile.fileName</font></h3>
554
 
<b>fileName</b>(<i></i>)
555
 
<p>
556
 
        Public method returning the filename.
557
 
</p><dl>
558
 
<dt>Returns:</dt>
559
 
<dd>
560
 
filename (string)
561
 
</dd>
562
 
</dl><a NAME="BrowserFile.isDesignerFile" ID="BrowserFileisDesignerFile"></a>
563
 
<h3><font color="#0000FF">BrowserFile.isDesignerFile</font></h3>
564
 
<b>isDesignerFile</b>(<i></i>)
565
 
<p>
566
 
        Public method to check, if this file is a Qt-Designer file.
567
 
</p><dl>
568
 
<dt>Returns:</dt>
569
 
<dd>
570
 
flag indicating a Qt-Designer file (boolean)
571
 
</dd>
572
 
</dl><a NAME="BrowserFile.isDesignerHeaderFile" ID="BrowserFileisDesignerHeaderFile"></a>
573
 
<h3><font color="#0000FF">BrowserFile.isDesignerHeaderFile</font></h3>
574
 
<b>isDesignerHeaderFile</b>(<i></i>)
575
 
<p>
576
 
        Public method to check, if this file is a Qt-Designer header file.
577
 
</p><dl>
578
 
<dt>Returns:</dt>
579
 
<dd>
580
 
flag indicating a Qt-Designer header file (boolean)
581
 
</dd>
582
 
</dl><a NAME="BrowserFile.isIdlFile" ID="BrowserFileisIdlFile"></a>
583
 
<h3><font color="#0000FF">BrowserFile.isIdlFile</font></h3>
584
 
<b>isIdlFile</b>(<i></i>)
585
 
<p>
586
 
        Public method to check, if this file is a CORBA IDL file.
587
 
</p><dl>
588
 
<dt>Returns:</dt>
589
 
<dd>
590
 
flag indicating a CORBA IDL file (boolean)
591
 
</dd>
592
 
</dl><a NAME="BrowserFile.isLinguistFile" ID="BrowserFileisLinguistFile"></a>
593
 
<h3><font color="#0000FF">BrowserFile.isLinguistFile</font></h3>
594
 
<b>isLinguistFile</b>(<i></i>)
595
 
<p>
596
 
        Public method to check, if this file is a Qt-Linguist.
597
 
</p><dl>
598
 
<dt>Returns:</dt>
599
 
<dd>
600
 
flag indicating a Qt-Linguist file (boolean)
601
 
</dd>
602
 
</dl><a NAME="BrowserFile.isPixmapFile" ID="BrowserFileisPixmapFile"></a>
603
 
<h3><font color="#0000FF">BrowserFile.isPixmapFile</font></h3>
604
 
<b>isPixmapFile</b>(<i></i>)
605
 
<p>
606
 
        Public method to check, if this file is a pixmap file.
607
 
</p><dl>
608
 
<dt>Returns:</dt>
609
 
<dd>
610
 
flag indicating a pixmap file (boolean)
611
 
</dd>
612
 
</dl><a NAME="BrowserFile.isProjectFile" ID="BrowserFileisProjectFile"></a>
613
 
<h3><font color="#0000FF">BrowserFile.isProjectFile</font></h3>
614
 
<b>isProjectFile</b>(<i></i>)
615
 
<p>
616
 
        Public method to check, if this file is an eric3 project file.
617
 
</p><dl>
618
 
<dt>Returns:</dt>
619
 
<dd>
620
 
flag indicating an eric3 project file (boolean)
621
 
</dd>
622
 
</dl><a NAME="BrowserFile.isPythonFile" ID="BrowserFileisPythonFile"></a>
623
 
<h3><font color="#0000FF">BrowserFile.isPythonFile</font></h3>
624
 
<b>isPythonFile</b>(<i></i>)
625
 
<p>
626
 
        Public method to check, if this file is a Python script.
627
 
</p><dl>
628
 
<dt>Returns:</dt>
629
 
<dd>
630
 
flag indicating a Python file (boolean)
631
 
</dd>
632
 
</dl><a NAME="BrowserFile.isRubyFile" ID="BrowserFileisRubyFile"></a>
633
 
<h3><font color="#0000FF">BrowserFile.isRubyFile</font></h3>
634
 
<b>isRubyFile</b>(<i></i>)
635
 
<p>
636
 
        Public method to check, if this file is a Ruby script.
637
 
</p><dl>
638
 
<dt>Returns:</dt>
639
 
<dd>
640
 
flag indicating a Ruby file (boolean)
641
 
</dd>
642
 
</dl><a NAME="BrowserFile.setOpen" ID="BrowserFilesetOpen"></a>
643
 
<h3><font color="#0000FF">BrowserFile.setOpen</font></h3>
644
 
<b>setOpen</b>(<i>o</i>)
645
 
<p>
646
 
        Public slot to set/reset the open state.
647
 
</p><dl>
648
 
<dt><i>o</i></dt>
649
 
<dd>
650
 
flag indicating the open state
651
 
</dd>
652
 
</dl></p>
653
 
<div align="right"><a href="#top">Up</a></div>
654
 
<hr /><hr />
655
 
<a NAME="BrowserMethod" ID="BrowserMethod"></a>
656
 
<h2><font color="#0000FF">BrowserMethod</font></h2>
657
 
<p>
658
 
    Class implementing a BrowserNode that represents a python method.
659
 
</p>
660
 
<h3><font color="#FF0000">Derived from</font></h3>
661
 
BrowserNode
662
 
<h3><font color="#FF0000">Methods</font></h3>
663
 
<table>
664
 
<tr>
665
 
<td><a href="#BrowserMethod.__init__">BrowserMethod</a></td>
666
 
<td>Constructor</td>
667
 
</tr><tr>
668
 
<td><a href="#BrowserMethod.compare">compare</a></td>
669
 
<td>Private method to compare two items.</td>
670
 
</tr><tr>
671
 
<td><a href="#BrowserMethod.fileName">fileName</a></td>
672
 
<td>Public method returning the name of the file defining this class.</td>
673
 
</tr><tr>
674
 
<td><a href="#BrowserMethod.setOpen">setOpen</a></td>
675
 
<td>Public slot to set/reset the open state.</td>
676
 
</tr>
677
 
</table>
678
 
<p><a NAME="BrowserMethod.__init__" ID="BrowserMethod__init__"></a>
679
 
<h3><font color="#0000FF">BrowserMethod (Constructor)</font></h3>
680
 
<b>BrowserMethod</b>(<i>parent, fn, after, filename</i>)
681
 
<p>
682
 
        Constructor
683
 
</p><dl>
684
 
<dt><i>parent</i></dt>
685
 
<dd>
686
 
parent Browser or BrowserNode
687
 
</dd><dt><i>fn</i></dt>
688
 
<dd>
689
 
Function object to be shown
690
 
</dd><dt><i>after</i></dt>
691
 
<dd>
692
 
sibling this node is positioned after
693
 
</dd><dt><i>filename</i></dt>
694
 
<dd>
695
 
filename of the file defining this method
696
 
</dd>
697
 
</dl><a NAME="BrowserMethod.compare" ID="BrowserMethodcompare"></a>
698
 
<h3><font color="#0000FF">BrowserMethod.compare</font></h3>
699
 
<b>compare</b>(<i>item, col, ascending</i>)
700
 
<p>
701
 
        Private method to compare two items.
702
 
</p><a NAME="BrowserMethod.fileName" ID="BrowserMethodfileName"></a>
703
 
<h3><font color="#0000FF">BrowserMethod.fileName</font></h3>
704
 
<b>fileName</b>(<i></i>)
705
 
<p>
706
 
        Public method returning the name of the file defining this class.
707
 
</p><dl>
708
 
<dt>Returns:</dt>
709
 
<dd>
710
 
filename (string)
711
 
</dd>
712
 
</dl><a NAME="BrowserMethod.setOpen" ID="BrowserMethodsetOpen"></a>
713
 
<h3><font color="#0000FF">BrowserMethod.setOpen</font></h3>
714
 
<b>setOpen</b>(<i>o</i>)
715
 
<p>
716
 
        Public slot to set/reset the open state.
717
 
</p><dl>
718
 
<dt><i>o</i></dt>
719
 
<dd>
720
 
flag indicating the open state
721
 
</dd>
722
 
</dl></p>
723
 
<div align="right"><a href="#top">Up</a></div>
724
 
<hr /><hr />
725
 
<a NAME="BrowserNode" ID="BrowserNode"></a>
726
 
<h2><font color="#0000FF">BrowserNode</font></h2>
727
 
<p>
728
 
    Class implementing a thin wrapper around QListViewItem. 
729
 
</p><p>
730
 
    It makes sure that it is positioned after the previous sibling.  
731
 
</p>
732
 
<h3><font color="#FF0000">Derived from</font></h3>
733
 
QListViewItem
734
 
<h3><font color="#FF0000">Methods</font></h3>
735
 
<table>
736
 
<tr>
737
 
<td><a href="#BrowserNode.__init__">BrowserNode</a></td>
738
 
<td>Constructor</td>
739
 
</tr><tr>
740
 
<td><a href="#BrowserNode.paintCell">paintCell</a></td>
741
 
<td>Overwritten class to set a different text color, if bold is true.</td>
742
 
</tr>
743
 
</table>
744
 
<p><a NAME="BrowserNode.__init__" ID="BrowserNode__init__"></a>
745
 
<h3><font color="#0000FF">BrowserNode (Constructor)</font></h3>
746
 
<b>BrowserNode</b>(<i>parent, text, after, bold=0</i>)
747
 
<p>
748
 
        Constructor
749
 
</p><dl>
750
 
<dt><i>parent</i></dt>
751
 
<dd>
752
 
parent Browser or BrowserNode
753
 
</dd><dt><i>text</i></dt>
754
 
<dd>
755
 
text to be displayed by this node (string or QString)
756
 
</dd><dt><i>after</i></dt>
757
 
<dd>
758
 
sibling this node is positioned after
759
 
</dd><dt><i>bold</i></dt>
760
 
<dd>
761
 
flag indicating a highlighted font
762
 
</dd>
763
 
</dl><a NAME="BrowserNode.paintCell" ID="BrowserNodepaintCell"></a>
764
 
<h3><font color="#0000FF">BrowserNode.paintCell</font></h3>
765
 
<b>paintCell</b>(<i>p, cg, column, width, alignment</i>)
766
 
<p>
767
 
        Overwritten class to set a different text color, if bold is true.
768
 
</p><dl>
769
 
<dt><i>p</i></dt>
770
 
<dd>
771
 
the painter (QPainter)
772
 
</dd><dt><i>cg</i></dt>
773
 
<dd>
774
 
the color group (QColorGroup)
775
 
</dd><dt><i>column</i></dt>
776
 
<dd>
777
 
the column (int)
778
 
</dd><dt><i>width</i></dt>
779
 
<dd>
780
 
width of the cell (int)
781
 
</dd><dt><i>alignment</i></dt>
782
 
<dd>
783
 
alignment of the cell (int)
784
 
</dd>
785
 
</dl></p>
786
 
<div align="right"><a href="#top">Up</a></div>
787
 
<hr /><hr />
788
 
<a NAME="BrowserSysPath" ID="BrowserSysPath"></a>
789
 
<h2><font color="#0000FF">BrowserSysPath</font></h2>
790
 
<p>
791
 
    Class implementing a BrowserNode that represents the Python sys.path.  
792
 
</p>
793
 
<h3><font color="#FF0000">Derived from</font></h3>
794
 
BrowserNode
795
 
<h3><font color="#FF0000">Methods</font></h3>
796
 
<table>
797
 
<tr>
798
 
<td><a href="#BrowserSysPath.__init__">BrowserSysPath</a></td>
799
 
<td>Constructor</td>
800
 
</tr><tr>
801
 
<td><a href="#BrowserSysPath.setOpen">setOpen</a></td>
802
 
<td>Public slot to set/reset the open state.</td>
803
 
</tr>
804
 
</table>
805
 
<p><a NAME="BrowserSysPath.__init__" ID="BrowserSysPath__init__"></a>
806
 
<h3><font color="#0000FF">BrowserSysPath (Constructor)</font></h3>
807
 
<b>BrowserSysPath</b>(<i>parent, after</i>)
808
 
<p>
809
 
        Constructor
810
 
</p><dl>
811
 
<dt><i>parent</i></dt>
812
 
<dd>
813
 
parent Browser or BrowserNode
814
 
</dd><dt><i>after</i></dt>
815
 
<dd>
816
 
sibling this node is positioned after
817
 
</dd>
818
 
</dl><a NAME="BrowserSysPath.setOpen" ID="BrowserSysPathsetOpen"></a>
819
 
<h3><font color="#0000FF">BrowserSysPath.setOpen</font></h3>
820
 
<b>setOpen</b>(<i>o</i>)
821
 
<p>
822
 
        Public slot to set/reset the open state.
823
 
</p><dl>
824
 
<dt><i>o</i></dt>
825
 
<dd>
826
 
flag indicating the open state
827
 
</dd>
828
 
</dl></p>
829
 
<div align="right"><a href="#top">Up</a></div>
830
 
<hr />
831
 
</body></html>
 
 
b'\\ No newline at end of file'