Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.MultiProject.MultiProjectBrowser.html
src/eric7/Documentation/Source/eric7.MultiProject.MultiProjectBrowser.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10411
- f9dedceca6c9
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.MultiProject.MultiProjectBrowser</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.MultiProject.MultiProjectBrowser</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the multi project browser. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#MultiProjectBrowser">MultiProjectBrowser</a></td> | |
| 25 <td>Class implementing the multi project browser.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="MultiProjectBrowser" ID="MultiProjectBrowser"></a> | |
| 36 <h2>MultiProjectBrowser</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the multi project browser. | |
| 40 </p> | |
| 41 <h3>Derived from</h3> | |
| 42 QTreeWidget | |
| 43 <h3>Class Attributes</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>ProjectFileNameRole</td></tr><tr><td>ProjectUidRole</td></tr> | |
| 47 </table> | |
| 48 <h3>Class Methods</h3> | |
| 49 | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Methods</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#MultiProjectBrowser.__init__">MultiProjectBrowser</a></td> | |
| 59 <td>Constructor</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#MultiProjectBrowser.__addNewProject">__addNewProject</a></td> | |
| 63 <td>Private method to add a new project entry.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#MultiProjectBrowser.__addProject">__addProject</a></td> | |
| 67 <td>Private method to add a project to the list.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#MultiProjectBrowser.__configure">__configure</a></td> | |
| 71 <td>Private method to open the configuration dialog.</td> | |
| 72 </tr> | |
| 73 <tr> | |
| 74 <td><a href="#MultiProjectBrowser.__contextMenuRequested">__contextMenuRequested</a></td> | |
| 75 <td>Private slot to show the context menu.</td> | |
| 76 </tr> | |
| 77 <tr> | |
| 78 <td><a href="#MultiProjectBrowser.__copyProject">__copyProject</a></td> | |
| 79 <td>Private method to copy the selected project on disk.</td> | |
| 80 </tr> | |
| 81 <tr> | |
| 82 <td><a href="#MultiProjectBrowser.__createPopupMenu">__createPopupMenu</a></td> | |
| 83 <td>Private method to create the popup menu.</td> | |
| 84 </tr> | |
| 85 <tr> | |
| 86 <td><a href="#MultiProjectBrowser.__deleteProject">__deleteProject</a></td> | |
| 87 <td>Private method to handle the Delete context menu entry.</td> | |
| 88 </tr> | |
| 89 <tr> | |
| 90 <td><a href="#MultiProjectBrowser.__findCategoryItem">__findCategoryItem</a></td> | |
| 91 <td>Private method to find the item for a category.</td> | |
| 92 </tr> | |
| 93 <tr> | |
| 94 <td><a href="#MultiProjectBrowser.__findProjectItem">__findProjectItem</a></td> | |
| 95 <td>Private method to search a specific project item.</td> | |
| 96 </tr> | |
| 97 <tr> | |
| 98 <td><a href="#MultiProjectBrowser.__multiProjectClosed">__multiProjectClosed</a></td> | |
| 99 <td>Private slot to handle the closing of a multi project.</td> | |
| 100 </tr> | |
| 101 <tr> | |
| 102 <td><a href="#MultiProjectBrowser.__multiProjectOpened">__multiProjectOpened</a></td> | |
| 103 <td>Private slot to handle the opening of a multi project.</td> | |
| 104 </tr> | |
| 105 <tr> | |
| 106 <td><a href="#MultiProjectBrowser.__newMultiProject">__newMultiProject</a></td> | |
| 107 <td>Private slot to handle the creation of a new multi project.</td> | |
| 108 </tr> | |
| 109 <tr> | |
| 110 <td><a href="#MultiProjectBrowser.__openItem">__openItem</a></td> | |
| 111 <td>Private slot to open a project.</td> | |
| 112 </tr> | |
| 113 <tr> | |
| 114 <td><a href="#MultiProjectBrowser.__projectAdded">__projectAdded</a></td> | |
| 115 <td>Private slot to handle the addition of a project to the multi project.</td> | |
| 116 </tr> | |
| 117 <tr> | |
| 118 <td><a href="#MultiProjectBrowser.__projectClosed">__projectClosed</a></td> | |
| 119 <td>Private slot to handle the closing of a project.</td> | |
| 120 </tr> | |
| 121 <tr> | |
| 122 <td><a href="#MultiProjectBrowser.__projectDataChanged">__projectDataChanged</a></td> | |
| 123 <td>Private slot to handle the change of a project of the multi project.</td> | |
| 124 </tr> | |
| 125 <tr> | |
| 126 <td><a href="#MultiProjectBrowser.__projectOpened">__projectOpened</a></td> | |
| 127 <td>Private slot to handle the opening of a project.</td> | |
| 128 </tr> | |
| 129 <tr> | |
| 130 <td><a href="#MultiProjectBrowser.__projectRemoved">__projectRemoved</a></td> | |
| 131 <td>Private slot to handle the removal of a project from the multi project.</td> | |
| 132 </tr> | |
| 133 <tr> | |
| 134 <td><a href="#MultiProjectBrowser.__removeProject">__removeProject</a></td> | |
| 135 <td>Private method to handle the Remove context menu entry.</td> | |
| 136 </tr> | |
| 137 <tr> | |
| 138 <td><a href="#MultiProjectBrowser.__setItemData">__setItemData</a></td> | |
| 139 <td>Private method to set the data of a project item.</td> | |
| 140 </tr> | |
| 141 <tr> | |
| 142 <td><a href="#MultiProjectBrowser.__showProjectProperties">__showProjectProperties</a></td> | |
| 143 <td>Private method to show the data of a project entry.</td> | |
| 144 </tr> | |
| 145 </table> | |
| 146 <h3>Static Methods</h3> | |
| 147 | |
| 148 <table> | |
| 149 <tr><td>None</td></tr> | |
| 150 </table> | |
| 151 | |
| 152 <a NAME="MultiProjectBrowser.__init__" ID="MultiProjectBrowser.__init__"></a> | |
| 153 <h4>MultiProjectBrowser (Constructor)</h4> | |
| 154 <b>MultiProjectBrowser</b>(<i>multiProject, project, parent=None</i>) | |
| 155 | |
| 156 <p> | |
| 157 Constructor | |
| 158 </p> | |
| 159 <dl> | |
| 160 | |
| 161 <dt><i>multiProject</i> (MultiProject)</dt> | |
| 162 <dd> | |
| 163 reference to the multi project object | |
| 164 </dd> | |
| 165 <dt><i>project</i> (Project)</dt> | |
| 166 <dd> | |
| 167 reference to the project object | |
| 168 </dd> | |
| 169 <dt><i>parent</i> (QWidget)</dt> | |
| 170 <dd> | |
| 171 parent widget | |
| 172 </dd> | |
| 173 </dl> | |
| 174 <a NAME="MultiProjectBrowser.__addNewProject" ID="MultiProjectBrowser.__addNewProject"></a> | |
| 175 <h4>MultiProjectBrowser.__addNewProject</h4> | |
| 176 <b>__addNewProject</b>(<i></i>) | |
| 177 | |
| 178 <p> | |
| 179 Private method to add a new project entry. | |
| 180 </p> | |
| 181 <a NAME="MultiProjectBrowser.__addProject" ID="MultiProjectBrowser.__addProject"></a> | |
| 182 <h4>MultiProjectBrowser.__addProject</h4> | |
| 183 <b>__addProject</b>(<i>project</i>) | |
| 184 | |
| 185 <p> | |
| 186 Private method to add a project to the list. | |
| 187 </p> | |
| 188 <dl> | |
| 189 | |
| 190 <dt><i>project</i></dt> | |
| 191 <dd> | |
| 192 reference to the project data dictionary | |
| 193 </dd> | |
| 194 </dl> | |
| 195 <a NAME="MultiProjectBrowser.__configure" ID="MultiProjectBrowser.__configure"></a> | |
| 196 <h4>MultiProjectBrowser.__configure</h4> | |
| 197 <b>__configure</b>(<i></i>) | |
| 198 | |
| 199 <p> | |
| 200 Private method to open the configuration dialog. | |
| 201 </p> | |
| 202 <a NAME="MultiProjectBrowser.__contextMenuRequested" ID="MultiProjectBrowser.__contextMenuRequested"></a> | |
| 203 <h4>MultiProjectBrowser.__contextMenuRequested</h4> | |
| 204 <b>__contextMenuRequested</b>(<i>coord</i>) | |
| 205 | |
| 206 <p> | |
| 207 Private slot to show the context menu. | |
| 208 </p> | |
| 209 <dl> | |
| 210 | |
| 211 <dt><i>coord</i></dt> | |
| 212 <dd> | |
| 213 the position of the mouse pointer (QPoint) | |
| 214 </dd> | |
| 215 </dl> | |
| 216 <a NAME="MultiProjectBrowser.__copyProject" ID="MultiProjectBrowser.__copyProject"></a> | |
| 217 <h4>MultiProjectBrowser.__copyProject</h4> | |
| 218 <b>__copyProject</b>(<i></i>) | |
| 219 | |
| 220 <p> | |
| 221 Private method to copy the selected project on disk. | |
| 222 </p> | |
| 223 <a NAME="MultiProjectBrowser.__createPopupMenu" ID="MultiProjectBrowser.__createPopupMenu"></a> | |
| 224 <h4>MultiProjectBrowser.__createPopupMenu</h4> | |
| 225 <b>__createPopupMenu</b>(<i></i>) | |
| 226 | |
| 227 <p> | |
| 228 Private method to create the popup menu. | |
| 229 </p> | |
| 230 <a NAME="MultiProjectBrowser.__deleteProject" ID="MultiProjectBrowser.__deleteProject"></a> | |
| 231 <h4>MultiProjectBrowser.__deleteProject</h4> | |
| 232 <b>__deleteProject</b>(<i></i>) | |
| 233 | |
| 234 <p> | |
| 235 Private method to handle the Delete context menu entry. | |
| 236 </p> | |
| 237 <a NAME="MultiProjectBrowser.__findCategoryItem" ID="MultiProjectBrowser.__findCategoryItem"></a> | |
| 238 <h4>MultiProjectBrowser.__findCategoryItem</h4> | |
| 239 <b>__findCategoryItem</b>(<i>category</i>) | |
| 240 | |
| 241 <p> | |
| 242 Private method to find the item for a category. | |
| 243 </p> | |
| 244 <dl> | |
| 245 | |
| 246 <dt><i>category</i></dt> | |
| 247 <dd> | |
| 248 category to search for (string) | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <dl> | |
| 252 <dt>Return:</dt> | |
| 253 <dd> | |
| 254 reference to the category item or None, if there is | |
| 255 no such item (QTreeWidgetItem or None) | |
| 256 </dd> | |
| 257 </dl> | |
| 258 <a NAME="MultiProjectBrowser.__findProjectItem" ID="MultiProjectBrowser.__findProjectItem"></a> | |
| 259 <h4>MultiProjectBrowser.__findProjectItem</h4> | |
| 260 <b>__findProjectItem</b>(<i>project</i>) | |
| 261 | |
| 262 <p> | |
| 263 Private method to search a specific project item. | |
| 264 </p> | |
| 265 <dl> | |
| 266 | |
| 267 <dt><i>project</i></dt> | |
| 268 <dd> | |
| 269 reference to the project data dictionary | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <dl> | |
| 273 <dt>Return:</dt> | |
| 274 <dd> | |
| 275 reference to the item (QTreeWidgetItem) or None | |
| 276 </dd> | |
| 277 </dl> | |
| 278 <a NAME="MultiProjectBrowser.__multiProjectClosed" ID="MultiProjectBrowser.__multiProjectClosed"></a> | |
| 279 <h4>MultiProjectBrowser.__multiProjectClosed</h4> | |
| 280 <b>__multiProjectClosed</b>(<i></i>) | |
| 281 | |
| 282 <p> | |
| 283 Private slot to handle the closing of a multi project. | |
| 284 </p> | |
| 285 <a NAME="MultiProjectBrowser.__multiProjectOpened" ID="MultiProjectBrowser.__multiProjectOpened"></a> | |
| 286 <h4>MultiProjectBrowser.__multiProjectOpened</h4> | |
| 287 <b>__multiProjectOpened</b>(<i></i>) | |
| 288 | |
| 289 <p> | |
| 290 Private slot to handle the opening of a multi project. | |
| 291 </p> | |
| 292 <a NAME="MultiProjectBrowser.__newMultiProject" ID="MultiProjectBrowser.__newMultiProject"></a> | |
| 293 <h4>MultiProjectBrowser.__newMultiProject</h4> | |
| 294 <b>__newMultiProject</b>(<i></i>) | |
| 295 | |
| 296 <p> | |
| 297 Private slot to handle the creation of a new multi project. | |
| 298 </p> | |
| 299 <a NAME="MultiProjectBrowser.__openItem" ID="MultiProjectBrowser.__openItem"></a> | |
| 300 <h4>MultiProjectBrowser.__openItem</h4> | |
| 301 <b>__openItem</b>(<i>itm=None</i>) | |
| 302 | |
| 303 <p> | |
| 304 Private slot to open a project. | |
| 305 </p> | |
| 306 <dl> | |
| 307 | |
| 308 <dt><i>itm</i></dt> | |
| 309 <dd> | |
| 310 reference to the project item to be opened (QTreeWidgetItem) | |
| 311 </dd> | |
| 312 </dl> | |
| 313 <a NAME="MultiProjectBrowser.__projectAdded" ID="MultiProjectBrowser.__projectAdded"></a> | |
| 314 <h4>MultiProjectBrowser.__projectAdded</h4> | |
| 315 <b>__projectAdded</b>(<i>project</i>) | |
| 316 | |
| 317 <p> | |
| 318 Private slot to handle the addition of a project to the multi project. | |
| 319 </p> | |
| 320 <dl> | |
| 321 | |
| 322 <dt><i>project</i></dt> | |
| 323 <dd> | |
| 324 reference to the project data dictionary | |
| 325 </dd> | |
| 326 </dl> | |
| 327 <a NAME="MultiProjectBrowser.__projectClosed" ID="MultiProjectBrowser.__projectClosed"></a> | |
| 328 <h4>MultiProjectBrowser.__projectClosed</h4> | |
| 329 <b>__projectClosed</b>(<i></i>) | |
| 330 | |
| 331 <p> | |
| 332 Private slot to handle the closing of a project. | |
| 333 </p> | |
| 334 <a NAME="MultiProjectBrowser.__projectDataChanged" ID="MultiProjectBrowser.__projectDataChanged"></a> | |
| 335 <h4>MultiProjectBrowser.__projectDataChanged</h4> | |
| 336 <b>__projectDataChanged</b>(<i>project</i>) | |
| 337 | |
| 338 <p> | |
| 339 Private slot to handle the change of a project of the multi project. | |
| 340 </p> | |
| 341 <dl> | |
| 342 | |
| 343 <dt><i>project</i></dt> | |
| 344 <dd> | |
| 345 reference to the project data dictionary | |
| 346 </dd> | |
| 347 </dl> | |
| 348 <a NAME="MultiProjectBrowser.__projectOpened" ID="MultiProjectBrowser.__projectOpened"></a> | |
| 349 <h4>MultiProjectBrowser.__projectOpened</h4> | |
| 350 <b>__projectOpened</b>(<i></i>) | |
| 351 | |
| 352 <p> | |
| 353 Private slot to handle the opening of a project. | |
| 354 </p> | |
| 355 <a NAME="MultiProjectBrowser.__projectRemoved" ID="MultiProjectBrowser.__projectRemoved"></a> | |
| 356 <h4>MultiProjectBrowser.__projectRemoved</h4> | |
| 357 <b>__projectRemoved</b>(<i>project</i>) | |
| 358 | |
| 359 <p> | |
| 360 Private slot to handle the removal of a project from the multi project. | |
| 361 </p> | |
| 362 <dl> | |
| 363 | |
| 364 <dt><i>project</i></dt> | |
| 365 <dd> | |
| 366 reference to the project data dictionary | |
| 367 </dd> | |
| 368 </dl> | |
| 369 <a NAME="MultiProjectBrowser.__removeProject" ID="MultiProjectBrowser.__removeProject"></a> | |
| 370 <h4>MultiProjectBrowser.__removeProject</h4> | |
| 371 <b>__removeProject</b>(<i></i>) | |
| 372 | |
| 373 <p> | |
| 374 Private method to handle the Remove context menu entry. | |
| 375 </p> | |
| 376 <a NAME="MultiProjectBrowser.__setItemData" ID="MultiProjectBrowser.__setItemData"></a> | |
| 377 <h4>MultiProjectBrowser.__setItemData</h4> | |
| 378 <b>__setItemData</b>(<i>itm, project</i>) | |
| 379 | |
| 380 <p> | |
| 381 Private method to set the data of a project item. | |
| 382 </p> | |
| 383 <dl> | |
| 384 | |
| 385 <dt><i>itm</i></dt> | |
| 386 <dd> | |
| 387 reference to the item to be set (QTreeWidgetItem) | |
| 388 </dd> | |
| 389 <dt><i>project</i></dt> | |
| 390 <dd> | |
| 391 reference to the project data dictionary | |
| 392 </dd> | |
| 393 </dl> | |
| 394 <a NAME="MultiProjectBrowser.__showProjectProperties" ID="MultiProjectBrowser.__showProjectProperties"></a> | |
| 395 <h4>MultiProjectBrowser.__showProjectProperties</h4> | |
| 396 <b>__showProjectProperties</b>(<i></i>) | |
| 397 | |
| 398 <p> | |
| 399 Private method to show the data of a project entry. | |
| 400 </p> | |
| 401 <div align="right"><a href="#top">Up</a></div> | |
| 402 <hr /> | |
| 403 </body></html> |
