src/eric7/Documentation/Source/eric7.UI.Browser.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 9097
213951c41dcd
child 9730
00cf7289d899
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.UI.Browser</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.UI.Browser</h1>
10
11 <p>
12 Module implementing a browser with class browsing capabilities.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#Browser">Browser</a></td>
25 <td>Class used to display a file system tree.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="Browser" ID="Browser"></a>
36 <h2>Browser</h2>
37
38 <p>
39 Class used to display a file system tree.
40 </p>
41 <p>
42 Via the context menu that
43 is displayed by a right click the user can select various actions on
44 the selected file.
45 </p>
46 <h3>Signals</h3>
47 <dl>
48
49 <dt>binaryFile(filename)</dt>
50 <dd>
51 emitted to open a file as binary (str)
52 </dd>
53 <dt>designerFile(filename)</dt>
54 <dd>
55 emitted to open a Qt-Designer file (str)
56 </dd>
57 <dt>linguistFile(filename)</dt>
58 <dd>
59 emitted to open a Qt-Linguist (*.ts)
60 file (str)
61 </dd>
62 <dt>multiProjectFile(filename)</dt>
63 <dd>
64 emitted to open an eric multi project
65 file (str)
66 </dd>
67 <dt>pixmapEditFile(filename)</dt>
68 <dd>
69 emitted to edit a pixmap file (str)
70 </dd>
71 <dt>pixmapFile(filename)</dt>
72 <dd>
73 emitted to open a pixmap file (str)
74 </dd>
75 <dt>projectFile(filename)</dt>
76 <dd>
77 emitted to open an eric project file (str)
78 </dd>
79 <dt>sourceFile(filename)</dt>
80 <dd>
81 emitted to open a Python file at a line (str)
82 </dd>
83 <dt>sourceFile(filename, lineno)</dt>
84 <dd>
85 emitted to open a Python file at a
86 line (str, int)
87 </dd>
88 <dt>sourceFile(filename, lineno, type)</dt>
89 <dd>
90 emitted to open a Python file
91 at a line giving an explicit file type (str, int, str)
92 </dd>
93 <dt>sourceFile(filename, linenos)</dt>
94 <dd>
95 emitted to open a Python file giving
96 a list of lines(str, list)
97 </dd>
98 <dt>svgFile(filename)</dt>
99 <dd>
100 emitted to open a SVG file (str)
101 </dd>
102 <dt>testFile(filename)</dt>
103 <dd>
104 emitted to open a Python file for a
105 unit test (str)
106 </dd>
107 <dt>trpreview(filenames)</dt>
108 <dd>
109 emitted to preview Qt-Linguist (*.qm)
110 files (list of str)
111 </dd>
112 <dt>trpreview(filenames, ignore)</dt>
113 <dd>
114 emitted to preview Qt-Linguist (*.qm)
115 files indicating whether non-existent files shall be ignored
116 (list of str, bool)
117 </dd>
118 <dt>umlFile(filename)</dt>
119 <dd>
120 emitted to open an eric UML file (str)
121 </dd>
122 </dl>
123 <h3>Derived from</h3>
124 QTreeView
125 <h3>Class Attributes</h3>
126
127 <table>
128 <tr><td>None</td></tr>
129 </table>
130 <h3>Class Methods</h3>
131
132 <table>
133 <tr><td>None</td></tr>
134 </table>
135 <h3>Methods</h3>
136
137 <table>
138
139 <tr>
140 <td><a href="#Browser.__init__">Browser</a></td>
141 <td>Constructor</td>
142 </tr>
143 <tr>
144 <td><a href="#Browser.__addAsToplevelDir">__addAsToplevelDir</a></td>
145 <td>Private slot to handle the Add as toplevel directory popup menu entry.</td>
146 </tr>
147 <tr>
148 <td><a href="#Browser.__createPopupMenus">__createPopupMenus</a></td>
149 <td>Private method to generate the various popup menus.</td>
150 </tr>
151 <tr>
152 <td><a href="#Browser.__deleteDirectory">__deleteDirectory</a></td>
153 <td>Private method to delete a directory.</td>
154 </tr>
155 <tr>
156 <td><a href="#Browser.__deleteFile">__deleteFile</a></td>
157 <td>Private method to delete a file.</td>
158 </tr>
159 <tr>
160 <td><a href="#Browser.__deleteMultiple">__deleteMultiple</a></td>
161 <td>Private slot to delete multiple directories and files.</td>
162 </tr>
163 <tr>
164 <td><a href="#Browser.__findInDirectory">__findInDirectory</a></td>
165 <td>Private slot to handle the Find in directory popup menu entry.</td>
166 </tr>
167 <tr>
168 <td><a href="#Browser.__newToplevelDir">__newToplevelDir</a></td>
169 <td>Private slot to handle the New toplevel directory popup menu entry.</td>
170 </tr>
171 <tr>
172 <td><a href="#Browser.__refreshDirectory">__refreshDirectory</a></td>
173 <td>Private slot to refresh a directory entry.</td>
174 </tr>
175 <tr>
176 <td><a href="#Browser.__refreshSource">__refreshSource</a></td>
177 <td>Private slot to refresh the structure of a source file.</td>
178 </tr>
179 <tr>
180 <td><a href="#Browser.__removeToplevel">__removeToplevel</a></td>
181 <td>Private slot to handle the Remove from toplevel popup menu entry.</td>
182 </tr>
183 <tr>
184 <td><a href="#Browser.__replaceInDirectory">__replaceInDirectory</a></td>
185 <td>Private slot to handle the Find&Replace in directory popup menu entry.</td>
186 </tr>
187 <tr>
188 <td><a href="#Browser.__showMimeType">__showMimeType</a></td>
189 <td>Private slot to show the mime type of the selected entry.</td>
190 </tr>
191 <tr>
192 <td><a href="#Browser._contextMenuRequested">_contextMenuRequested</a></td>
193 <td>Protected slot to show the context menu of the listview.</td>
194 </tr>
195 <tr>
196 <td><a href="#Browser._copyToClipboard">_copyToClipboard</a></td>
197 <td>Protected method to copy the text shown for an entry to the clipboard.</td>
198 </tr>
199 <tr>
200 <td><a href="#Browser._deleteFileOrDirectory">_deleteFileOrDirectory</a></td>
201 <td>Protected slot to delete a directory or file.</td>
202 </tr>
203 <tr>
204 <td><a href="#Browser._editPixmap">_editPixmap</a></td>
205 <td>Protected slot to handle the open in icon editor popup menu entry.</td>
206 </tr>
207 <tr>
208 <td><a href="#Browser._gotoAttribute">_gotoAttribute</a></td>
209 <td>Protected slot to handle the selection of the goto menu.</td>
210 </tr>
211 <tr>
212 <td><a href="#Browser._init">_init</a></td>
213 <td>Protected method to perform initialization tasks common to this base class and all derived classes.</td>
214 </tr>
215 <tr>
216 <td><a href="#Browser._keyboardSearchType">_keyboardSearchType</a></td>
217 <td>Protected method to check, if the item is of the correct type.</td>
218 </tr>
219 <tr>
220 <td><a href="#Browser._newDirectory">_newDirectory</a></td>
221 <td>Protected slot to create a new directory.</td>
222 </tr>
223 <tr>
224 <td><a href="#Browser._newFile">_newFile</a></td>
225 <td>Protected slot to create a new file.</td>
226 </tr>
227 <tr>
228 <td><a href="#Browser._openFileInEditor">_openFileInEditor</a></td>
229 <td>Protected slot to handle the Open in Editor menu action.</td>
230 </tr>
231 <tr>
232 <td><a href="#Browser._openHexEditor">_openHexEditor</a></td>
233 <td>Protected slot to handle the open in hex editor popup menu entry.</td>
234 </tr>
235 <tr>
236 <td><a href="#Browser._openItem">_openItem</a></td>
237 <td>Protected slot to handle the open popup menu entry.</td>
238 </tr>
239 <tr>
240 <td><a href="#Browser._resizeColumns">_resizeColumns</a></td>
241 <td>Protected slot to resize the view when items get expanded or collapsed.</td>
242 </tr>
243 <tr>
244 <td><a href="#Browser._resort">_resort</a></td>
245 <td>Protected slot to resort the tree.</td>
246 </tr>
247 <tr>
248 <td><a href="#Browser._showGotoMenu">_showGotoMenu</a></td>
249 <td>Protected slot to prepare the goto submenu of the attribute menu.</td>
250 </tr>
251 <tr>
252 <td><a href="#Browser._showHidden">_showHidden</a></td>
253 <td>Protected slot to show or hide hidden files.</td>
254 </tr>
255 <tr>
256 <td><a href="#Browser.getSelectedItems">getSelectedItems</a></td>
257 <td>Public method to get the selected items.</td>
258 </tr>
259 <tr>
260 <td><a href="#Browser.getSelectedItemsCount">getSelectedItemsCount</a></td>
261 <td>Public method to get the count of items selected.</td>
262 </tr>
263 <tr>
264 <td><a href="#Browser.getSelectedItemsCountCategorized">getSelectedItemsCountCategorized</a></td>
265 <td>Public method to get a categorized count of selected items.</td>
266 </tr>
267 <tr>
268 <td><a href="#Browser.handleInterpreterChanged">handleInterpreterChanged</a></td>
269 <td>Public slot to handle a change of the debug client's interpreter.</td>
270 </tr>
271 <tr>
272 <td><a href="#Browser.handlePreferencesChanged">handlePreferencesChanged</a></td>
273 <td>Public slot used to handle the preferencesChanged signal.</td>
274 </tr>
275 <tr>
276 <td><a href="#Browser.handleProgramChange">handleProgramChange</a></td>
277 <td>Public slot to handle the programChange signal.</td>
278 </tr>
279 <tr>
280 <td><a href="#Browser.handleTesting">handleTesting</a></td>
281 <td>Public slot to handle the testing popup menu entry.</td>
282 </tr>
283 <tr>
284 <td><a href="#Browser.keyboardSearch">keyboardSearch</a></td>
285 <td>Public function to search the tree via the keyboard.</td>
286 </tr>
287 <tr>
288 <td><a href="#Browser.layoutDisplay">layoutDisplay</a></td>
289 <td>Public slot to perform a layout operation.</td>
290 </tr>
291 <tr>
292 <td><a href="#Browser.mouseDoubleClickEvent">mouseDoubleClickEvent</a></td>
293 <td>Protected method of QAbstractItemView.</td>
294 </tr>
295 <tr>
296 <td><a href="#Browser.saveToplevelDirs">saveToplevelDirs</a></td>
297 <td>Public slot to save the toplevel directories.</td>
298 </tr>
299 <tr>
300 <td><a href="#Browser.wantedItem">wantedItem</a></td>
301 <td>Public method to check type of an item.</td>
302 </tr>
303 </table>
304 <h3>Static Methods</h3>
305
306 <table>
307 <tr><td>None</td></tr>
308 </table>
309
310 <a NAME="Browser.__init__" ID="Browser.__init__"></a>
311 <h4>Browser (Constructor)</h4>
312 <b>Browser</b>(<i>parent=None</i>)
313
314 <p>
315 Constructor
316 </p>
317 <dl>
318
319 <dt><i>parent</i></dt>
320 <dd>
321 parent widget (QWidget)
322 </dd>
323 </dl>
324 <a NAME="Browser.__addAsToplevelDir" ID="Browser.__addAsToplevelDir"></a>
325 <h4>Browser.__addAsToplevelDir</h4>
326 <b>__addAsToplevelDir</b>(<i></i>)
327
328 <p>
329 Private slot to handle the Add as toplevel directory popup menu entry.
330 </p>
331 <a NAME="Browser.__createPopupMenus" ID="Browser.__createPopupMenus"></a>
332 <h4>Browser.__createPopupMenus</h4>
333 <b>__createPopupMenus</b>(<i></i>)
334
335 <p>
336 Private method to generate the various popup menus.
337 </p>
338 <a NAME="Browser.__deleteDirectory" ID="Browser.__deleteDirectory"></a>
339 <h4>Browser.__deleteDirectory</h4>
340 <b>__deleteDirectory</b>(<i>dn</i>)
341
342 <p>
343 Private method to delete a directory.
344 </p>
345 <dl>
346
347 <dt><i>dn</i> (str)</dt>
348 <dd>
349 directory name to be removed from the project
350 </dd>
351 </dl>
352 <a NAME="Browser.__deleteFile" ID="Browser.__deleteFile"></a>
353 <h4>Browser.__deleteFile</h4>
354 <b>__deleteFile</b>(<i>fn</i>)
355
356 <p>
357 Private method to delete a file.
358 </p>
359 <dl>
360
361 <dt><i>fn</i> (str)</dt>
362 <dd>
363 filename to be deleted
364 </dd>
365 </dl>
366 <a NAME="Browser.__deleteMultiple" ID="Browser.__deleteMultiple"></a>
367 <h4>Browser.__deleteMultiple</h4>
368 <b>__deleteMultiple</b>(<i></i>)
369
370 <p>
371 Private slot to delete multiple directories and files.
372 </p>
373 <p>
374 Note: The context menu for multi selection is only shown for file
375 items.
376 </p>
377 <a NAME="Browser.__findInDirectory" ID="Browser.__findInDirectory"></a>
378 <h4>Browser.__findInDirectory</h4>
379 <b>__findInDirectory</b>(<i></i>)
380
381 <p>
382 Private slot to handle the Find in directory popup menu entry.
383 </p>
384 <a NAME="Browser.__newToplevelDir" ID="Browser.__newToplevelDir"></a>
385 <h4>Browser.__newToplevelDir</h4>
386 <b>__newToplevelDir</b>(<i></i>)
387
388 <p>
389 Private slot to handle the New toplevel directory popup menu entry.
390 </p>
391 <a NAME="Browser.__refreshDirectory" ID="Browser.__refreshDirectory"></a>
392 <h4>Browser.__refreshDirectory</h4>
393 <b>__refreshDirectory</b>(<i></i>)
394
395 <p>
396 Private slot to refresh a directory entry.
397 </p>
398 <a NAME="Browser.__refreshSource" ID="Browser.__refreshSource"></a>
399 <h4>Browser.__refreshSource</h4>
400 <b>__refreshSource</b>(<i></i>)
401
402 <p>
403 Private slot to refresh the structure of a source file.
404 </p>
405 <a NAME="Browser.__removeToplevel" ID="Browser.__removeToplevel"></a>
406 <h4>Browser.__removeToplevel</h4>
407 <b>__removeToplevel</b>(<i></i>)
408
409 <p>
410 Private slot to handle the Remove from toplevel popup menu entry.
411 </p>
412 <a NAME="Browser.__replaceInDirectory" ID="Browser.__replaceInDirectory"></a>
413 <h4>Browser.__replaceInDirectory</h4>
414 <b>__replaceInDirectory</b>(<i></i>)
415
416 <p>
417 Private slot to handle the Find&Replace in directory popup menu entry.
418 </p>
419 <a NAME="Browser.__showMimeType" ID="Browser.__showMimeType"></a>
420 <h4>Browser.__showMimeType</h4>
421 <b>__showMimeType</b>(<i></i>)
422
423 <p>
424 Private slot to show the mime type of the selected entry.
425 </p>
426 <a NAME="Browser._contextMenuRequested" ID="Browser._contextMenuRequested"></a>
427 <h4>Browser._contextMenuRequested</h4>
428 <b>_contextMenuRequested</b>(<i>coord</i>)
429
430 <p>
431 Protected slot to show the context menu of the listview.
432 </p>
433 <dl>
434
435 <dt><i>coord</i></dt>
436 <dd>
437 the position of the mouse pointer (QPoint)
438 </dd>
439 </dl>
440 <a NAME="Browser._copyToClipboard" ID="Browser._copyToClipboard"></a>
441 <h4>Browser._copyToClipboard</h4>
442 <b>_copyToClipboard</b>(<i></i>)
443
444 <p>
445 Protected method to copy the text shown for an entry to the clipboard.
446 </p>
447 <a NAME="Browser._deleteFileOrDirectory" ID="Browser._deleteFileOrDirectory"></a>
448 <h4>Browser._deleteFileOrDirectory</h4>
449 <b>_deleteFileOrDirectory</b>(<i></i>)
450
451 <p>
452 Protected slot to delete a directory or file.
453 </p>
454 <a NAME="Browser._editPixmap" ID="Browser._editPixmap"></a>
455 <h4>Browser._editPixmap</h4>
456 <b>_editPixmap</b>(<i></i>)
457
458 <p>
459 Protected slot to handle the open in icon editor popup menu entry.
460 </p>
461 <a NAME="Browser._gotoAttribute" ID="Browser._gotoAttribute"></a>
462 <h4>Browser._gotoAttribute</h4>
463 <b>_gotoAttribute</b>(<i>act</i>)
464
465 <p>
466 Protected slot to handle the selection of the goto menu.
467 </p>
468 <dl>
469
470 <dt><i>act</i></dt>
471 <dd>
472 reference to the action (EricAction)
473 </dd>
474 </dl>
475 <a NAME="Browser._init" ID="Browser._init"></a>
476 <h4>Browser._init</h4>
477 <b>_init</b>(<i></i>)
478
479 <p>
480 Protected method to perform initialization tasks common to this
481 base class and all derived classes.
482 </p>
483 <a NAME="Browser._keyboardSearchType" ID="Browser._keyboardSearchType"></a>
484 <h4>Browser._keyboardSearchType</h4>
485 <b>_keyboardSearchType</b>(<i>item</i>)
486
487 <p>
488 Protected method to check, if the item is of the correct type.
489 </p>
490 <dl>
491
492 <dt><i>item</i> (BrowserItem)</dt>
493 <dd>
494 reference to the item
495 </dd>
496 </dl>
497 <dl>
498 <dt>Return:</dt>
499 <dd>
500 flag indicating a correct type
501 </dd>
502 </dl>
503 <dl>
504 <dt>Return Type:</dt>
505 <dd>
506 bool
507 </dd>
508 </dl>
509 <a NAME="Browser._newDirectory" ID="Browser._newDirectory"></a>
510 <h4>Browser._newDirectory</h4>
511 <b>_newDirectory</b>(<i></i>)
512
513 <p>
514 Protected slot to create a new directory.
515 </p>
516 <a NAME="Browser._newFile" ID="Browser._newFile"></a>
517 <h4>Browser._newFile</h4>
518 <b>_newFile</b>(<i></i>)
519
520 <p>
521 Protected slot to create a new file.
522 </p>
523 <a NAME="Browser._openFileInEditor" ID="Browser._openFileInEditor"></a>
524 <h4>Browser._openFileInEditor</h4>
525 <b>_openFileInEditor</b>(<i></i>)
526
527 <p>
528 Protected slot to handle the Open in Editor menu action.
529 </p>
530 <a NAME="Browser._openHexEditor" ID="Browser._openHexEditor"></a>
531 <h4>Browser._openHexEditor</h4>
532 <b>_openHexEditor</b>(<i></i>)
533
534 <p>
535 Protected slot to handle the open in hex editor popup menu entry.
536 </p>
537 <a NAME="Browser._openItem" ID="Browser._openItem"></a>
538 <h4>Browser._openItem</h4>
539 <b>_openItem</b>(<i></i>)
540
541 <p>
542 Protected slot to handle the open popup menu entry.
543 </p>
544 <a NAME="Browser._resizeColumns" ID="Browser._resizeColumns"></a>
545 <h4>Browser._resizeColumns</h4>
546 <b>_resizeColumns</b>(<i>index</i>)
547
548 <p>
549 Protected slot to resize the view when items get expanded or collapsed.
550 </p>
551 <dl>
552
553 <dt><i>index</i></dt>
554 <dd>
555 index of item (QModelIndex)
556 </dd>
557 </dl>
558 <a NAME="Browser._resort" ID="Browser._resort"></a>
559 <h4>Browser._resort</h4>
560 <b>_resort</b>(<i></i>)
561
562 <p>
563 Protected slot to resort the tree.
564 </p>
565 <a NAME="Browser._showGotoMenu" ID="Browser._showGotoMenu"></a>
566 <h4>Browser._showGotoMenu</h4>
567 <b>_showGotoMenu</b>(<i></i>)
568
569 <p>
570 Protected slot to prepare the goto submenu of the attribute menu.
571 </p>
572 <a NAME="Browser._showHidden" ID="Browser._showHidden"></a>
573 <h4>Browser._showHidden</h4>
574 <b>_showHidden</b>(<i>checked</i>)
575
576 <p>
577 Protected slot to show or hide hidden files.
578 </p>
579 <dl>
580
581 <dt><i>checked</i> (bool)</dt>
582 <dd>
583 flag indicating the state of the action
584 </dd>
585 </dl>
586 <a NAME="Browser.getSelectedItems" ID="Browser.getSelectedItems"></a>
587 <h4>Browser.getSelectedItems</h4>
588 <b>getSelectedItems</b>(<i>filterList=None</i>)
589
590 <p>
591 Public method to get the selected items.
592 </p>
593 <dl>
594
595 <dt><i>filterList</i></dt>
596 <dd>
597 list of classes to check against
598 </dd>
599 </dl>
600 <dl>
601 <dt>Return:</dt>
602 <dd>
603 list of selected items (list of BrowserItem)
604 </dd>
605 </dl>
606 <a NAME="Browser.getSelectedItemsCount" ID="Browser.getSelectedItemsCount"></a>
607 <h4>Browser.getSelectedItemsCount</h4>
608 <b>getSelectedItemsCount</b>(<i>filterList=None</i>)
609
610 <p>
611 Public method to get the count of items selected.
612 </p>
613 <dl>
614
615 <dt><i>filterList</i></dt>
616 <dd>
617 list of classes to check against
618 </dd>
619 </dl>
620 <dl>
621 <dt>Return:</dt>
622 <dd>
623 count of items selected (integer)
624 </dd>
625 </dl>
626 <a NAME="Browser.getSelectedItemsCountCategorized" ID="Browser.getSelectedItemsCountCategorized"></a>
627 <h4>Browser.getSelectedItemsCountCategorized</h4>
628 <b>getSelectedItemsCountCategorized</b>(<i>filterList=None</i>)
629
630 <p>
631 Public method to get a categorized count of selected items.
632 </p>
633 <dl>
634
635 <dt><i>filterList</i></dt>
636 <dd>
637 list of classes to check against
638 </dd>
639 </dl>
640 <dl>
641 <dt>Return:</dt>
642 <dd>
643 a dictionary containing the counts of items belonging
644 to the individual filter classes. The keys of the dictionary
645 are the string representation of the classes given in the
646 filter (i.e. str(filterClass)). The dictionary contains
647 an additional entry with key "sum", that stores the sum of
648 all selected entries fulfilling the filter criteria.
649 </dd>
650 </dl>
651 <a NAME="Browser.handleInterpreterChanged" ID="Browser.handleInterpreterChanged"></a>
652 <h4>Browser.handleInterpreterChanged</h4>
653 <b>handleInterpreterChanged</b>(<i>interpreter</i>)
654
655 <p>
656 Public slot to handle a change of the debug client's interpreter.
657 </p>
658 <dl>
659
660 <dt><i>interpreter</i></dt>
661 <dd>
662 interpreter of the debug client (string)
663 </dd>
664 </dl>
665 <a NAME="Browser.handlePreferencesChanged" ID="Browser.handlePreferencesChanged"></a>
666 <h4>Browser.handlePreferencesChanged</h4>
667 <b>handlePreferencesChanged</b>(<i></i>)
668
669 <p>
670 Public slot used to handle the preferencesChanged signal.
671 </p>
672 <a NAME="Browser.handleProgramChange" ID="Browser.handleProgramChange"></a>
673 <h4>Browser.handleProgramChange</h4>
674 <b>handleProgramChange</b>(<i>fn</i>)
675
676 <p>
677 Public slot to handle the programChange signal.
678 </p>
679 <dl>
680
681 <dt><i>fn</i></dt>
682 <dd>
683 file name (string)
684 </dd>
685 </dl>
686 <a NAME="Browser.handleTesting" ID="Browser.handleTesting"></a>
687 <h4>Browser.handleTesting</h4>
688 <b>handleTesting</b>(<i></i>)
689
690 <p>
691 Public slot to handle the testing popup menu entry.
692 </p>
693 <a NAME="Browser.keyboardSearch" ID="Browser.keyboardSearch"></a>
694 <h4>Browser.keyboardSearch</h4>
695 <b>keyboardSearch</b>(<i>search</i>)
696
697 <p>
698 Public function to search the tree via the keyboard.
699 </p>
700 <dl>
701
702 <dt><i>search</i> (str)</dt>
703 <dd>
704 the character entered via the keyboard
705 </dd>
706 </dl>
707 <a NAME="Browser.layoutDisplay" ID="Browser.layoutDisplay"></a>
708 <h4>Browser.layoutDisplay</h4>
709 <b>layoutDisplay</b>(<i></i>)
710
711 <p>
712 Public slot to perform a layout operation.
713 </p>
714 <a NAME="Browser.mouseDoubleClickEvent" ID="Browser.mouseDoubleClickEvent"></a>
715 <h4>Browser.mouseDoubleClickEvent</h4>
716 <b>mouseDoubleClickEvent</b>(<i>mouseEvent</i>)
717
718 <p>
719 Protected method of QAbstractItemView.
720 </p>
721 <p>
722 Reimplemented to disable expanding/collapsing of items when
723 double-clicking. Instead the double-clicked entry is opened.
724 </p>
725 <dl>
726
727 <dt><i>mouseEvent</i></dt>
728 <dd>
729 the mouse event (QMouseEvent)
730 </dd>
731 </dl>
732 <a NAME="Browser.saveToplevelDirs" ID="Browser.saveToplevelDirs"></a>
733 <h4>Browser.saveToplevelDirs</h4>
734 <b>saveToplevelDirs</b>(<i></i>)
735
736 <p>
737 Public slot to save the toplevel directories.
738 </p>
739 <a NAME="Browser.wantedItem" ID="Browser.wantedItem"></a>
740 <h4>Browser.wantedItem</h4>
741 <b>wantedItem</b>(<i>itm, filterList=None</i>)
742
743 <p>
744 Public method to check type of an item.
745 </p>
746 <dl>
747
748 <dt><i>itm</i></dt>
749 <dd>
750 the item to check (BrowserItem)
751 </dd>
752 <dt><i>filterList</i></dt>
753 <dd>
754 list of classes to check against
755 </dd>
756 </dl>
757 <dl>
758 <dt>Return:</dt>
759 <dd>
760 flag indicating item is a valid type (boolean)
761 </dd>
762 </dl>
763 <div align="right"><a href="#top">Up</a></div>
764 <hr />
765 </body></html>

eric ide

mercurial