Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial