Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Project.ProjectBaseBrowser.html

Documentation/Source/eric4.Project.ProjectBaseBrowser.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.Project.ProjectBaseBrowser</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.Project.ProjectBaseBrowser</h1>
24 <p>
25 Module implementing the baseclass for the various project browsers.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#ProjectBaseBrowser">ProjectBaseBrowser</a></td>
35 <td>Baseclass implementing common functionality for the various project browsers.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="ProjectBaseBrowser" ID="ProjectBaseBrowser"></a>
44 <h2>ProjectBaseBrowser</h2>
45 <p>
46 Baseclass implementing common functionality for the various project browsers.
47 </p>
48 <h3>Derived from</h3>
49 Browser
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>None</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#ProjectBaseBrowser.__init__">ProjectBaseBrowser</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#ProjectBaseBrowser.__checkHookKey">__checkHookKey</a></td>
61 <td>Private method to check a hook key</td>
62 </tr><tr>
63 <td><a href="#ProjectBaseBrowser.__modelDataChanged">__modelDataChanged</a></td>
64 <td>Private slot called after data has been changed in the model.</td>
65 </tr><tr>
66 <td><a href="#ProjectBaseBrowser.__modelRowsInserted">__modelRowsInserted</a></td>
67 <td>Private slot called after rows have been inserted into the model.</td>
68 </tr><tr>
69 <td><a href="#ProjectBaseBrowser._collapseAllDirs">_collapseAllDirs</a></td>
70 <td>Protected slot to handle the 'Collapse all directories' menu action.</td>
71 </tr><tr>
72 <td><a href="#ProjectBaseBrowser._completeRepopulateItem">_completeRepopulateItem</a></td>
73 <td>Protected slot to handle the completeRepopulateItem signal.</td>
74 </tr><tr>
75 <td><a href="#ProjectBaseBrowser._configure">_configure</a></td>
76 <td>Protected method to open the configuration dialog.</td>
77 </tr><tr>
78 <td><a href="#ProjectBaseBrowser._connectExpandedCollapsed">_connectExpandedCollapsed</a></td>
79 <td>Protected method to connect the expanded and collapsed signals.</td>
80 </tr><tr>
81 <td><a href="#ProjectBaseBrowser._contextMenuRequested">_contextMenuRequested</a></td>
82 <td>Protected slot to show the context menu.</td>
83 </tr><tr>
84 <td><a href="#ProjectBaseBrowser._copyToClipboard">_copyToClipboard</a></td>
85 <td>Protected method to copy the path of an entry to the clipboard.</td>
86 </tr><tr>
87 <td><a href="#ProjectBaseBrowser._createPopupMenus">_createPopupMenus</a></td>
88 <td>Protected overloaded method to generate the popup menus.</td>
89 </tr><tr>
90 <td><a href="#ProjectBaseBrowser._disconnectExpandedCollapsed">_disconnectExpandedCollapsed</a></td>
91 <td>Protected method to disconnect the expanded and collapsed signals.</td>
92 </tr><tr>
93 <td><a href="#ProjectBaseBrowser._expandAllDirs">_expandAllDirs</a></td>
94 <td>Protected slot to handle the 'Expand all directories' menu action.</td>
95 </tr><tr>
96 <td><a href="#ProjectBaseBrowser._initHookMethods">_initHookMethods</a></td>
97 <td>Protected method to initialize the hooks dictionary.</td>
98 </tr><tr>
99 <td><a href="#ProjectBaseBrowser._initMenusAndVcs">_initMenusAndVcs</a></td>
100 <td>Protected slot to initialize the menus and the Vcs interface.</td>
101 </tr><tr>
102 <td><a href="#ProjectBaseBrowser._newProject">_newProject</a></td>
103 <td>Protected slot to handle the newProject signal.</td>
104 </tr><tr>
105 <td><a href="#ProjectBaseBrowser._prepareRepopulateItem">_prepareRepopulateItem</a></td>
106 <td>Protected slot to handle the prepareRepopulateItem signal.</td>
107 </tr><tr>
108 <td><a href="#ProjectBaseBrowser._projectClosed">_projectClosed</a></td>
109 <td>Protected slot to handle the projectClosed signal.</td>
110 </tr><tr>
111 <td><a href="#ProjectBaseBrowser._projectOpened">_projectOpened</a></td>
112 <td>Protected slot to handle the projectOpened signal.</td>
113 </tr><tr>
114 <td><a href="#ProjectBaseBrowser._removeDir">_removeDir</a></td>
115 <td>Protected method to remove a (single) directory from the project.</td>
116 </tr><tr>
117 <td><a href="#ProjectBaseBrowser._removeFile">_removeFile</a></td>
118 <td>Protected method to remove a file or files from the project.</td>
119 </tr><tr>
120 <td><a href="#ProjectBaseBrowser._renameFile">_renameFile</a></td>
121 <td>Protected method to rename a file of the project.</td>
122 </tr><tr>
123 <td><a href="#ProjectBaseBrowser._selectEntries">_selectEntries</a></td>
124 <td>Protected method to select entries based on their VCS status.</td>
125 </tr><tr>
126 <td><a href="#ProjectBaseBrowser._selectSingleItem">_selectSingleItem</a></td>
127 <td>Protected method to select a single item.</td>
128 </tr><tr>
129 <td><a href="#ProjectBaseBrowser._setItemRangeSelected">_setItemRangeSelected</a></td>
130 <td>Protected method to set the selection status of a range of items.</td>
131 </tr><tr>
132 <td><a href="#ProjectBaseBrowser._setItemSelected">_setItemSelected</a></td>
133 <td>Protected method to set the selection status of an item.</td>
134 </tr><tr>
135 <td><a href="#ProjectBaseBrowser._showContextMenu">_showContextMenu</a></td>
136 <td>Protected slot called before the context menu is shown.</td>
137 </tr><tr>
138 <td><a href="#ProjectBaseBrowser._showContextMenuBack">_showContextMenuBack</a></td>
139 <td>Protected slot called before the context menu is shown.</td>
140 </tr><tr>
141 <td><a href="#ProjectBaseBrowser._showContextMenuDir">_showContextMenuDir</a></td>
142 <td>Protected slot called before the context menu is shown.</td>
143 </tr><tr>
144 <td><a href="#ProjectBaseBrowser._showContextMenuDirMulti">_showContextMenuDirMulti</a></td>
145 <td>Protected slot called before the context menu is shown.</td>
146 </tr><tr>
147 <td><a href="#ProjectBaseBrowser._showContextMenuMulti">_showContextMenuMulti</a></td>
148 <td>Protected slot called before the context menu (multiple selections) is shown.</td>
149 </tr><tr>
150 <td><a href="#ProjectBaseBrowser.addHookMethod">addHookMethod</a></td>
151 <td>Public method to add a hook method to the dictionary.</td>
152 </tr><tr>
153 <td><a href="#ProjectBaseBrowser.addHookMethodAndMenuEntry">addHookMethodAndMenuEntry</a></td>
154 <td>Public method to add a hook method to the dictionary.</td>
155 </tr><tr>
156 <td><a href="#ProjectBaseBrowser.currentItem">currentItem</a></td>
157 <td>Public method to get a reference to the current item.</td>
158 </tr><tr>
159 <td><a href="#ProjectBaseBrowser.removeHookMethod">removeHookMethod</a></td>
160 <td>Public method to remove a hook method from the dictionary.</td>
161 </tr><tr>
162 <td><a href="#ProjectBaseBrowser.selectFile">selectFile</a></td>
163 <td>Public method to highlight a node given its filename.</td>
164 </tr><tr>
165 <td><a href="#ProjectBaseBrowser.selectLocalDirEntries">selectLocalDirEntries</a></td>
166 <td>Public slot to handle the select local directories context menu entries</td>
167 </tr><tr>
168 <td><a href="#ProjectBaseBrowser.selectLocalEntries">selectLocalEntries</a></td>
169 <td>Public slot to handle the select local files context menu entries</td>
170 </tr><tr>
171 <td><a href="#ProjectBaseBrowser.selectVCSDirEntries">selectVCSDirEntries</a></td>
172 <td>Public slot to handle the select VCS directories context menu entries</td>
173 </tr><tr>
174 <td><a href="#ProjectBaseBrowser.selectVCSEntries">selectVCSEntries</a></td>
175 <td>Public slot to handle the select VCS files context menu entries</td>
176 </tr>
177 </table>
178 <a NAME="ProjectBaseBrowser.__init__" ID="ProjectBaseBrowser.__init__"></a>
179 <h4>ProjectBaseBrowser (Constructor)</h4>
180 <b>ProjectBaseBrowser</b>(<i>project, type_, parent = None</i>)
181 <p>
182 Constructor
183 </p><dl>
184 <dt><i>project</i></dt>
185 <dd>
186 reference to the project object
187 </dd><dt><i>type</i></dt>
188 <dd>
189 project browser type (string)
190 </dd><dt><i>parent</i></dt>
191 <dd>
192 parent widget of this browser
193 </dd>
194 </dl><a NAME="ProjectBaseBrowser.__checkHookKey" ID="ProjectBaseBrowser.__checkHookKey"></a>
195 <h4>ProjectBaseBrowser.__checkHookKey</h4>
196 <b>__checkHookKey</b>(<i>key</i>)
197 <p>
198 Private method to check a hook key
199 </p><a NAME="ProjectBaseBrowser.__modelDataChanged" ID="ProjectBaseBrowser.__modelDataChanged"></a>
200 <h4>ProjectBaseBrowser.__modelDataChanged</h4>
201 <b>__modelDataChanged</b>(<i>startIndex, endIndex</i>)
202 <p>
203 Private slot called after data has been changed in the model.
204 </p><dl>
205 <dt><i>startIndex</i></dt>
206 <dd>
207 start index of the changed data (QModelIndex)
208 </dd><dt><i>endIndex</i></dt>
209 <dd>
210 end index of the changed data (QModelIndex)
211 </dd>
212 </dl><a NAME="ProjectBaseBrowser.__modelRowsInserted" ID="ProjectBaseBrowser.__modelRowsInserted"></a>
213 <h4>ProjectBaseBrowser.__modelRowsInserted</h4>
214 <b>__modelRowsInserted</b>(<i>parent, start, end</i>)
215 <p>
216 Private slot called after rows have been inserted into the model.
217 </p><dl>
218 <dt><i>parent</i></dt>
219 <dd>
220 parent index of inserted rows (QModelIndex)
221 </dd><dt><i>start</i></dt>
222 <dd>
223 start row number (integer)
224 </dd><dt><i>end</i></dt>
225 <dd>
226 end row number (integer)
227 </dd>
228 </dl><a NAME="ProjectBaseBrowser._collapseAllDirs" ID="ProjectBaseBrowser._collapseAllDirs"></a>
229 <h4>ProjectBaseBrowser._collapseAllDirs</h4>
230 <b>_collapseAllDirs</b>(<i></i>)
231 <p>
232 Protected slot to handle the 'Collapse all directories' menu action.
233 </p><a NAME="ProjectBaseBrowser._completeRepopulateItem" ID="ProjectBaseBrowser._completeRepopulateItem"></a>
234 <h4>ProjectBaseBrowser._completeRepopulateItem</h4>
235 <b>_completeRepopulateItem</b>(<i>name</i>)
236 <p>
237 Protected slot to handle the completeRepopulateItem signal.
238 </p><dl>
239 <dt><i>name</i></dt>
240 <dd>
241 relative name of file item to be repopulated (string)
242 </dd>
243 </dl><a NAME="ProjectBaseBrowser._configure" ID="ProjectBaseBrowser._configure"></a>
244 <h4>ProjectBaseBrowser._configure</h4>
245 <b>_configure</b>(<i></i>)
246 <p>
247 Protected method to open the configuration dialog.
248 </p><a NAME="ProjectBaseBrowser._connectExpandedCollapsed" ID="ProjectBaseBrowser._connectExpandedCollapsed"></a>
249 <h4>ProjectBaseBrowser._connectExpandedCollapsed</h4>
250 <b>_connectExpandedCollapsed</b>(<i></i>)
251 <p>
252 Protected method to connect the expanded and collapsed signals.
253 </p><a NAME="ProjectBaseBrowser._contextMenuRequested" ID="ProjectBaseBrowser._contextMenuRequested"></a>
254 <h4>ProjectBaseBrowser._contextMenuRequested</h4>
255 <b>_contextMenuRequested</b>(<i>coord</i>)
256 <p>
257 Protected slot to show the context menu.
258 </p><dl>
259 <dt><i>coord</i></dt>
260 <dd>
261 the position of the mouse pointer (QPoint)
262 </dd>
263 </dl><a NAME="ProjectBaseBrowser._copyToClipboard" ID="ProjectBaseBrowser._copyToClipboard"></a>
264 <h4>ProjectBaseBrowser._copyToClipboard</h4>
265 <b>_copyToClipboard</b>(<i></i>)
266 <p>
267 Protected method to copy the path of an entry to the clipboard.
268 </p><a NAME="ProjectBaseBrowser._createPopupMenus" ID="ProjectBaseBrowser._createPopupMenus"></a>
269 <h4>ProjectBaseBrowser._createPopupMenus</h4>
270 <b>_createPopupMenus</b>(<i></i>)
271 <p>
272 Protected overloaded method to generate the popup menus.
273 </p><a NAME="ProjectBaseBrowser._disconnectExpandedCollapsed" ID="ProjectBaseBrowser._disconnectExpandedCollapsed"></a>
274 <h4>ProjectBaseBrowser._disconnectExpandedCollapsed</h4>
275 <b>_disconnectExpandedCollapsed</b>(<i></i>)
276 <p>
277 Protected method to disconnect the expanded and collapsed signals.
278 </p><a NAME="ProjectBaseBrowser._expandAllDirs" ID="ProjectBaseBrowser._expandAllDirs"></a>
279 <h4>ProjectBaseBrowser._expandAllDirs</h4>
280 <b>_expandAllDirs</b>(<i></i>)
281 <p>
282 Protected slot to handle the 'Expand all directories' menu action.
283 </p><a NAME="ProjectBaseBrowser._initHookMethods" ID="ProjectBaseBrowser._initHookMethods"></a>
284 <h4>ProjectBaseBrowser._initHookMethods</h4>
285 <b>_initHookMethods</b>(<i></i>)
286 <p>
287 Protected method to initialize the hooks dictionary.
288 </p><p>
289 This method should be overridden by subclasses. All supported
290 hook methods should be initialized with a None value. The keys
291 must be strings.
292 </p><a NAME="ProjectBaseBrowser._initMenusAndVcs" ID="ProjectBaseBrowser._initMenusAndVcs"></a>
293 <h4>ProjectBaseBrowser._initMenusAndVcs</h4>
294 <b>_initMenusAndVcs</b>(<i></i>)
295 <p>
296 Protected slot to initialize the menus and the Vcs interface.
297 </p><a NAME="ProjectBaseBrowser._newProject" ID="ProjectBaseBrowser._newProject"></a>
298 <h4>ProjectBaseBrowser._newProject</h4>
299 <b>_newProject</b>(<i></i>)
300 <p>
301 Protected slot to handle the newProject signal.
302 </p><a NAME="ProjectBaseBrowser._prepareRepopulateItem" ID="ProjectBaseBrowser._prepareRepopulateItem"></a>
303 <h4>ProjectBaseBrowser._prepareRepopulateItem</h4>
304 <b>_prepareRepopulateItem</b>(<i>name</i>)
305 <p>
306 Protected slot to handle the prepareRepopulateItem signal.
307 </p><dl>
308 <dt><i>name</i></dt>
309 <dd>
310 relative name of file item to be repopulated (string)
311 </dd>
312 </dl><a NAME="ProjectBaseBrowser._projectClosed" ID="ProjectBaseBrowser._projectClosed"></a>
313 <h4>ProjectBaseBrowser._projectClosed</h4>
314 <b>_projectClosed</b>(<i></i>)
315 <p>
316 Protected slot to handle the projectClosed signal.
317 </p><a NAME="ProjectBaseBrowser._projectOpened" ID="ProjectBaseBrowser._projectOpened"></a>
318 <h4>ProjectBaseBrowser._projectOpened</h4>
319 <b>_projectOpened</b>(<i></i>)
320 <p>
321 Protected slot to handle the projectOpened signal.
322 </p><a NAME="ProjectBaseBrowser._removeDir" ID="ProjectBaseBrowser._removeDir"></a>
323 <h4>ProjectBaseBrowser._removeDir</h4>
324 <b>_removeDir</b>(<i></i>)
325 <p>
326 Protected method to remove a (single) directory from the project.
327 </p><a NAME="ProjectBaseBrowser._removeFile" ID="ProjectBaseBrowser._removeFile"></a>
328 <h4>ProjectBaseBrowser._removeFile</h4>
329 <b>_removeFile</b>(<i></i>)
330 <p>
331 Protected method to remove a file or files from the project.
332 </p><a NAME="ProjectBaseBrowser._renameFile" ID="ProjectBaseBrowser._renameFile"></a>
333 <h4>ProjectBaseBrowser._renameFile</h4>
334 <b>_renameFile</b>(<i></i>)
335 <p>
336 Protected method to rename a file of the project.
337 </p><a NAME="ProjectBaseBrowser._selectEntries" ID="ProjectBaseBrowser._selectEntries"></a>
338 <h4>ProjectBaseBrowser._selectEntries</h4>
339 <b>_selectEntries</b>(<i>local = True, filter = None</i>)
340 <p>
341 Protected method to select entries based on their VCS status.
342 </p><dl>
343 <dt><i>local</i></dt>
344 <dd>
345 flag indicating local (i.e. non VCS controlled) file/directory
346 entries should be selected (boolean)
347 </dd><dt><i>filter</i></dt>
348 <dd>
349 list of classes to check against
350 </dd>
351 </dl><a NAME="ProjectBaseBrowser._selectSingleItem" ID="ProjectBaseBrowser._selectSingleItem"></a>
352 <h4>ProjectBaseBrowser._selectSingleItem</h4>
353 <b>_selectSingleItem</b>(<i>index</i>)
354 <p>
355 Protected method to select a single item.
356 </p><dl>
357 <dt><i>index</i></dt>
358 <dd>
359 index of item to be selected (QModelIndex)
360 </dd>
361 </dl><a NAME="ProjectBaseBrowser._setItemRangeSelected" ID="ProjectBaseBrowser._setItemRangeSelected"></a>
362 <h4>ProjectBaseBrowser._setItemRangeSelected</h4>
363 <b>_setItemRangeSelected</b>(<i>startIndex, endIndex, selected</i>)
364 <p>
365 Protected method to set the selection status of a range of items.
366 </p><dl>
367 <dt><i>startIndex</i></dt>
368 <dd>
369 start index of range of items to set (QModelIndex)
370 </dd><dt><i>endIndex</i></dt>
371 <dd>
372 end index of range of items to set (QModelIndex)
373 </dd><dt><i>selected</i></dt>
374 <dd>
375 flag giving the new selection status (boolean)
376 </dd>
377 </dl><a NAME="ProjectBaseBrowser._setItemSelected" ID="ProjectBaseBrowser._setItemSelected"></a>
378 <h4>ProjectBaseBrowser._setItemSelected</h4>
379 <b>_setItemSelected</b>(<i>index, selected</i>)
380 <p>
381 Protected method to set the selection status of an item.
382 </p><dl>
383 <dt><i>index</i></dt>
384 <dd>
385 index of item to set (QModelIndex)
386 </dd><dt><i>selected</i></dt>
387 <dd>
388 flag giving the new selection status (boolean)
389 </dd>
390 </dl><a NAME="ProjectBaseBrowser._showContextMenu" ID="ProjectBaseBrowser._showContextMenu"></a>
391 <h4>ProjectBaseBrowser._showContextMenu</h4>
392 <b>_showContextMenu</b>(<i>menu</i>)
393 <p>
394 Protected slot called before the context menu is shown.
395 </p><p>
396 It enables/disables the VCS menu entries depending on the overall
397 VCS status and the file status.
398 </p><dl>
399 <dt><i>menu</i></dt>
400 <dd>
401 reference to the menu to be shown (QMenu)
402 </dd>
403 </dl><a NAME="ProjectBaseBrowser._showContextMenuBack" ID="ProjectBaseBrowser._showContextMenuBack"></a>
404 <h4>ProjectBaseBrowser._showContextMenuBack</h4>
405 <b>_showContextMenuBack</b>(<i>menu</i>)
406 <p>
407 Protected slot called before the context menu is shown.
408 </p><dl>
409 <dt><i>menu</i></dt>
410 <dd>
411 reference to the menu to be shown (QMenu)
412 </dd>
413 </dl><a NAME="ProjectBaseBrowser._showContextMenuDir" ID="ProjectBaseBrowser._showContextMenuDir"></a>
414 <h4>ProjectBaseBrowser._showContextMenuDir</h4>
415 <b>_showContextMenuDir</b>(<i>menu</i>)
416 <p>
417 Protected slot called before the context menu is shown.
418 </p><p>
419 It enables/disables the VCS menu entries depending on the overall
420 VCS status and the directory status.
421 </p><dl>
422 <dt><i>menu</i></dt>
423 <dd>
424 reference to the menu to be shown (QMenu)
425 </dd>
426 </dl><a NAME="ProjectBaseBrowser._showContextMenuDirMulti" ID="ProjectBaseBrowser._showContextMenuDirMulti"></a>
427 <h4>ProjectBaseBrowser._showContextMenuDirMulti</h4>
428 <b>_showContextMenuDirMulti</b>(<i>menu</i>)
429 <p>
430 Protected slot called before the context menu is shown.
431 </p><p>
432 It enables/disables the VCS menu entries depending on the overall
433 VCS status and the directory status.
434 </p><dl>
435 <dt><i>menu</i></dt>
436 <dd>
437 reference to the menu to be shown (QMenu)
438 </dd>
439 </dl><a NAME="ProjectBaseBrowser._showContextMenuMulti" ID="ProjectBaseBrowser._showContextMenuMulti"></a>
440 <h4>ProjectBaseBrowser._showContextMenuMulti</h4>
441 <b>_showContextMenuMulti</b>(<i>menu</i>)
442 <p>
443 Protected slot called before the context menu (multiple selections) is shown.
444 </p><p>
445 It enables/disables the VCS menu entries depending on the overall
446 VCS status and the files status.
447 </p><dl>
448 <dt><i>menu</i></dt>
449 <dd>
450 reference to the menu to be shown (QMenu)
451 </dd>
452 </dl><a NAME="ProjectBaseBrowser.addHookMethod" ID="ProjectBaseBrowser.addHookMethod"></a>
453 <h4>ProjectBaseBrowser.addHookMethod</h4>
454 <b>addHookMethod</b>(<i>key, method</i>)
455 <p>
456 Public method to add a hook method to the dictionary.
457 </p><dl>
458 <dt><i>key</i></dt>
459 <dd>
460 for the hook method (string)
461 </dd><dt><i>method</i></dt>
462 <dd>
463 reference to the hook method (method object)
464 </dd>
465 </dl><a NAME="ProjectBaseBrowser.addHookMethodAndMenuEntry" ID="ProjectBaseBrowser.addHookMethodAndMenuEntry"></a>
466 <h4>ProjectBaseBrowser.addHookMethodAndMenuEntry</h4>
467 <b>addHookMethodAndMenuEntry</b>(<i>key, method, menuEntry</i>)
468 <p>
469 Public method to add a hook method to the dictionary.
470 </p><dl>
471 <dt><i>key</i></dt>
472 <dd>
473 for the hook method (string)
474 </dd><dt><i>method</i></dt>
475 <dd>
476 reference to the hook method (method object)
477 </dd><dt><i>menuEntry</i></dt>
478 <dd>
479 entry to be shown in the context menu (string)
480 </dd>
481 </dl><a NAME="ProjectBaseBrowser.currentItem" ID="ProjectBaseBrowser.currentItem"></a>
482 <h4>ProjectBaseBrowser.currentItem</h4>
483 <b>currentItem</b>(<i></i>)
484 <p>
485 Public method to get a reference to the current item.
486 </p><dl>
487 <dt>Returns:</dt>
488 <dd>
489 reference to the current item
490 </dd>
491 </dl><a NAME="ProjectBaseBrowser.removeHookMethod" ID="ProjectBaseBrowser.removeHookMethod"></a>
492 <h4>ProjectBaseBrowser.removeHookMethod</h4>
493 <b>removeHookMethod</b>(<i>key</i>)
494 <p>
495 Public method to remove a hook method from the dictionary.
496 </p><dl>
497 <dt><i>key</i></dt>
498 <dd>
499 for the hook method (string)
500 </dd>
501 </dl><a NAME="ProjectBaseBrowser.selectFile" ID="ProjectBaseBrowser.selectFile"></a>
502 <h4>ProjectBaseBrowser.selectFile</h4>
503 <b>selectFile</b>(<i>fn</i>)
504 <p>
505 Public method to highlight a node given its filename.
506 </p><dl>
507 <dt><i>fn</i></dt>
508 <dd>
509 filename of file to be highlighted (string)
510 </dd>
511 </dl><a NAME="ProjectBaseBrowser.selectLocalDirEntries" ID="ProjectBaseBrowser.selectLocalDirEntries"></a>
512 <h4>ProjectBaseBrowser.selectLocalDirEntries</h4>
513 <b>selectLocalDirEntries</b>(<i></i>)
514 <p>
515 Public slot to handle the select local directories context menu entries
516 </p><a NAME="ProjectBaseBrowser.selectLocalEntries" ID="ProjectBaseBrowser.selectLocalEntries"></a>
517 <h4>ProjectBaseBrowser.selectLocalEntries</h4>
518 <b>selectLocalEntries</b>(<i></i>)
519 <p>
520 Public slot to handle the select local files context menu entries
521 </p><a NAME="ProjectBaseBrowser.selectVCSDirEntries" ID="ProjectBaseBrowser.selectVCSDirEntries"></a>
522 <h4>ProjectBaseBrowser.selectVCSDirEntries</h4>
523 <b>selectVCSDirEntries</b>(<i></i>)
524 <p>
525 Public slot to handle the select VCS directories context menu entries
526 </p><a NAME="ProjectBaseBrowser.selectVCSEntries" ID="ProjectBaseBrowser.selectVCSEntries"></a>
527 <h4>ProjectBaseBrowser.selectVCSEntries</h4>
528 <b>selectVCSEntries</b>(<i></i>)
529 <p>
530 Public slot to handle the select VCS files context menu entries
531 </p>
532 <div align="right"><a href="#top">Up</a></div>
533 <hr />
534 </body></html>

Mercurial Repository: eric

eric ide

mercurial