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