Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.Project.ProjectBaseBrowser.html

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

Mercurial Repository: eric

eric ide

mercurial