Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Project.ProjectBrowser.html
src/eric7/Documentation/Source/eric7.Project.ProjectBrowser.html
- branch
- eric7
- changeset 9530
- c30f02ea1b27
- parent 9209
- b99e7fd55fd3
- child 9647
- e4c2ae118781
equal
deleted
inserted
replaced
| 9529:5ce1774b3106 | 9530:c30f02ea1b27 |
|---|---|
| 44 the project resources browser, the project translations browser, | 44 the project resources browser, the project translations browser, |
| 45 the project interfaces (IDL) browser and a browser for stuff, | 45 the project interfaces (IDL) browser and a browser for stuff, |
| 46 that doesn't fit these categories. Optionally it contains an additional | 46 that doesn't fit these categories. Optionally it contains an additional |
| 47 tab with the file system browser. | 47 tab with the file system browser. |
| 48 </p> | 48 </p> |
| 49 <p> | |
| 50 Note: The following signals are defined here to proxy the individual browser | |
| 51 signals. | |
| 52 </p> | |
| 53 <h3>Signals</h3> | |
| 54 <dl> | |
| 55 | |
| 56 <dt>appendStderr(str)</dt> | |
| 57 <dd> | |
| 58 emitted after something was received from | |
| 59 a QProcess on stderr | |
| 60 </dd> | |
| 61 <dt>appendStdout(str)</dt> | |
| 62 <dd> | |
| 63 emitted after something was received from | |
| 64 a QProcess on stdout | |
| 65 </dd> | |
| 66 <dt>binaryFile(filename)</dt> | |
| 67 <dd> | |
| 68 emitted to open a file as binary (str) | |
| 69 </dd> | |
| 70 <dt>closeSourceWindow(str)</dt> | |
| 71 <dd> | |
| 72 emitted to close a source file | |
| 73 </dd> | |
| 74 <dt>designerFile(filename)</dt> | |
| 75 <dd> | |
| 76 emitted to open a Qt-Designer file (str) | |
| 77 </dd> | |
| 78 <dt>linguistFile(filename)</dt> | |
| 79 <dd> | |
| 80 emitted to open a Qt-Linguist (*.ts) | |
| 81 file (str) | |
| 82 </dd> | |
| 83 <dt>pixmapEditFile(filename)</dt> | |
| 84 <dd> | |
| 85 emitted to edit a pixmap file (str) | |
| 86 </dd> | |
| 87 <dt>pixmapFile(filename)</dt> | |
| 88 <dd> | |
| 89 emitted to open a pixmap file (str) | |
| 90 </dd> | |
| 91 <dt>preferencesChanged()</dt> | |
| 92 <dd> | |
| 93 emitted when the preferences have been changed | |
| 94 </dd> | |
| 95 <dt>processChangedProjectFiles()</dt> | |
| 96 <dd> | |
| 97 emitted to indicate, that changed project files | |
| 98 should be processed | |
| 99 </dd> | |
| 100 <dt>sourceFile(filename)</dt> | |
| 101 <dd> | |
| 102 emitted to open a Python file at a line (str) | |
| 103 </dd> | |
| 104 <dt>sourceFile(filename, lineno)</dt> | |
| 105 <dd> | |
| 106 emitted to open a Python file at a | |
| 107 line (str, int) | |
| 108 </dd> | |
| 109 <dt>sourceFile(filename, lineno, type)</dt> | |
| 110 <dd> | |
| 111 emitted to open a Python file | |
| 112 at a line giving an explicit file type (str, int, str) | |
| 113 </dd> | |
| 114 <dt>sourceFile(filename, linenos)</dt> | |
| 115 <dd> | |
| 116 emitted to open a Python file giving | |
| 117 a list of lines(str, list) | |
| 118 </dd> | |
| 119 <dt>svgFile(filename)</dt> | |
| 120 <dd> | |
| 121 emitted to open a SVG file (str) | |
| 122 </dd> | |
| 123 <dt>testFile(filename)</dt> | |
| 124 <dd> | |
| 125 emitted to open a Python file for a | |
| 126 unit test (str) | |
| 127 </dd> | |
| 128 <dt>trpreview(filenames)</dt> | |
| 129 <dd> | |
| 130 emitted to preview Qt-Linguist (*.qm) | |
| 131 files (list of str) | |
| 132 </dd> | |
| 133 <dt>trpreview(filenames, ignore)</dt> | |
| 134 <dd> | |
| 135 emitted to preview Qt-Linguist (*.qm) | |
| 136 files indicating whether non-existent files shall be ignored | |
| 137 (list of str, bool) | |
| 138 </dd> | |
| 139 <dt>uipreview(str)</dt> | |
| 140 <dd> | |
| 141 emitted to preview a forms file | |
| 142 </dd> | |
| 143 <dt>umlFile(filename)</dt> | |
| 144 <dd> | |
| 145 emitted to open an eric UML file (str) | |
| 146 </dd> | |
| 147 </dl> | |
| 49 <h3>Derived from</h3> | 148 <h3>Derived from</h3> |
| 50 EricTabWidget | 149 EricTabWidget |
| 51 <h3>Class Attributes</h3> | 150 <h3>Class Attributes</h3> |
| 52 | 151 |
| 53 <table> | 152 <table> |
| 101 <tr> | 200 <tr> |
| 102 <td><a href="#ProjectBrowser.__vcsStatusIndicatorClicked">__vcsStatusIndicatorClicked</a></td> | 201 <td><a href="#ProjectBrowser.__vcsStatusIndicatorClicked">__vcsStatusIndicatorClicked</a></td> |
| 103 <td>Private slot to react upon clicks on the VCS indicator LED.</td> | 202 <td>Private slot to react upon clicks on the VCS indicator LED.</td> |
| 104 </tr> | 203 </tr> |
| 105 <tr> | 204 <tr> |
| 205 <td><a href="#ProjectBrowser.addTypedProjectBrowser">addTypedProjectBrowser</a></td> | |
| 206 <td>Public method to add a project browser type to the browser repository.</td> | |
| 207 </tr> | |
| 208 <tr> | |
| 106 <td><a href="#ProjectBrowser.getProjectBrowser">getProjectBrowser</a></td> | 209 <td><a href="#ProjectBrowser.getProjectBrowser">getProjectBrowser</a></td> |
| 107 <td>Public method to get a reference to the named project browser.</td> | 210 <td>Public method to get a reference to the project browser of given type.</td> |
| 211 </tr> | |
| 212 <tr> | |
| 213 <td><a href="#ProjectBrowser.getProjectBrowserFilter">getProjectBrowserFilter</a></td> | |
| 214 <td>Public method to get the project browser file filter for a file category.</td> | |
| 215 </tr> | |
| 216 <tr> | |
| 217 <td><a href="#ProjectBrowser.getProjectBrowserIcon">getProjectBrowserIcon</a></td> | |
| 218 <td>Public method to get the icon for a project browser.</td> | |
| 108 </tr> | 219 </tr> |
| 109 <tr> | 220 <tr> |
| 110 <td><a href="#ProjectBrowser.getProjectBrowserNames">getProjectBrowserNames</a></td> | 221 <td><a href="#ProjectBrowser.getProjectBrowserNames">getProjectBrowserNames</a></td> |
| 111 <td>Public method to get the names of the various project browsers.</td> | 222 <td>Public method to get the types of the various project browsers.</td> |
| 223 </tr> | |
| 224 <tr> | |
| 225 <td><a href="#ProjectBrowser.getProjectBrowserType">getProjectBrowserType</a></td> | |
| 226 <td>Public method to get the project browser type for a file category.</td> | |
| 227 </tr> | |
| 228 <tr> | |
| 229 <td><a href="#ProjectBrowser.getProjectBrowserUserStrings">getProjectBrowserUserStrings</a></td> | |
| 230 <td>Public method to get a dictionary of defined project browser user strings.</td> | |
| 112 </tr> | 231 </tr> |
| 113 <tr> | 232 <tr> |
| 114 <td><a href="#ProjectBrowser.getProjectBrowsers">getProjectBrowsers</a></td> | 233 <td><a href="#ProjectBrowser.getProjectBrowsers">getProjectBrowsers</a></td> |
| 115 <td>Public method to get references to the individual project browsers.</td> | 234 <td>Public method to get references to the individual project browsers.</td> |
| 116 </tr> | 235 </tr> |
| 123 <td>Public slot to handle the editorLineChanged signal.</td> | 242 <td>Public slot to handle the editorLineChanged signal.</td> |
| 124 </tr> | 243 </tr> |
| 125 <tr> | 244 <tr> |
| 126 <td><a href="#ProjectBrowser.handlePreferencesChanged">handlePreferencesChanged</a></td> | 245 <td><a href="#ProjectBrowser.handlePreferencesChanged">handlePreferencesChanged</a></td> |
| 127 <td>Public slot used to handle the preferencesChanged signal.</td> | 246 <td>Public slot used to handle the preferencesChanged signal.</td> |
| 247 </tr> | |
| 248 <tr> | |
| 249 <td><a href="#ProjectBrowser.removeTypedProjectBrowser">removeTypedProjectBrowser</a></td> | |
| 250 <td>Public method to remove a browser type from the browsers repository.</td> | |
| 128 </tr> | 251 </tr> |
| 129 </table> | 252 </table> |
| 130 <h3>Static Methods</h3> | 253 <h3>Static Methods</h3> |
| 131 | 254 |
| 132 <table> | 255 <table> |
| 193 <p> | 316 <p> |
| 194 Private slot to handle the projectPropertiesChanged signal. | 317 Private slot to handle the projectPropertiesChanged signal. |
| 195 </p> | 318 </p> |
| 196 <a NAME="ProjectBrowser.__setBrowsersAvailable" ID="ProjectBrowser.__setBrowsersAvailable"></a> | 319 <a NAME="ProjectBrowser.__setBrowsersAvailable" ID="ProjectBrowser.__setBrowsersAvailable"></a> |
| 197 <h4>ProjectBrowser.__setBrowsersAvailable</h4> | 320 <h4>ProjectBrowser.__setBrowsersAvailable</h4> |
| 198 <b>__setBrowsersAvailable</b>(<i>browserFlags</i>) | 321 <b>__setBrowsersAvailable</b>(<i>browsersList</i>) |
| 199 | 322 |
| 200 <p> | 323 <p> |
| 201 Private method to add selected browsers to the project browser. | 324 Private method to add selected browsers to the project browser. |
| 202 </p> | 325 </p> |
| 203 <dl> | 326 <dl> |
| 204 | 327 |
| 205 <dt><i>browserFlags</i></dt> | 328 <dt><i>browsersList</i> (list of str)</dt> |
| 206 <dd> | 329 <dd> |
| 207 flags indicating the browsers to add (integer) | 330 list of project browsers to be shown |
| 208 </dd> | 331 </dd> |
| 209 </dl> | 332 </dl> |
| 210 <a NAME="ProjectBrowser.__setSourcesIcon" ID="ProjectBrowser.__setSourcesIcon"></a> | 333 <a NAME="ProjectBrowser.__setSourcesIcon" ID="ProjectBrowser.__setSourcesIcon"></a> |
| 211 <h4>ProjectBrowser.__setSourcesIcon</h4> | 334 <h4>ProjectBrowser.__setSourcesIcon</h4> |
| 212 <b>__setSourcesIcon</b>(<i></i>) | 335 <b>__setSourcesIcon</b>(<i></i>) |
| 240 <dt><i>pos</i></dt> | 363 <dt><i>pos</i></dt> |
| 241 <dd> | 364 <dd> |
| 242 position of the click (QPoint) | 365 position of the click (QPoint) |
| 243 </dd> | 366 </dd> |
| 244 </dl> | 367 </dl> |
| 368 <a NAME="ProjectBrowser.addTypedProjectBrowser" ID="ProjectBrowser.addTypedProjectBrowser"></a> | |
| 369 <h4>ProjectBrowser.addTypedProjectBrowser</h4> | |
| 370 <b>addTypedProjectBrowser</b>(<i>browserType, projectBrowserItem</i>) | |
| 371 | |
| 372 <p> | |
| 373 Public method to add a project browser type to the browser repository. | |
| 374 </p> | |
| 375 <dl> | |
| 376 | |
| 377 <dt><i>browserType</i> (str)</dt> | |
| 378 <dd> | |
| 379 type of the project browser | |
| 380 </dd> | |
| 381 <dt><i>projectBrowserItem</i> (ProjectBrowserRepositoryItem)</dt> | |
| 382 <dd> | |
| 383 data structure containing the type specific data | |
| 384 </dd> | |
| 385 </dl> | |
| 386 <dl> | |
| 387 | |
| 388 <dt>Raises <b>TypeError</b>:</dt> | |
| 389 <dd> | |
| 390 raised to signal a wrong type for the project browser item | |
| 391 </dd> | |
| 392 </dl> | |
| 245 <a NAME="ProjectBrowser.getProjectBrowser" ID="ProjectBrowser.getProjectBrowser"></a> | 393 <a NAME="ProjectBrowser.getProjectBrowser" ID="ProjectBrowser.getProjectBrowser"></a> |
| 246 <h4>ProjectBrowser.getProjectBrowser</h4> | 394 <h4>ProjectBrowser.getProjectBrowser</h4> |
| 247 <b>getProjectBrowser</b>(<i>name</i>) | 395 <b>getProjectBrowser</b>(<i>browserType</i>) |
| 248 | 396 |
| 249 <p> | 397 <p> |
| 250 Public method to get a reference to the named project browser. | 398 Public method to get a reference to the project browser of given type. |
| 251 </p> | 399 </p> |
| 252 <dl> | 400 <dl> |
| 253 | 401 |
| 254 <dt><i>name</i></dt> | 402 <dt><i>browserType</i> (str)</dt> |
| 255 <dd> | 403 <dd> |
| 256 name of the requested project browser (string). | 404 type of the requested project browser |
| 257 Valid names are "sources, forms, resources, translations, | |
| 258 interfaces, protocols, others". | |
| 259 </dd> | 405 </dd> |
| 260 </dl> | 406 </dl> |
| 261 <dl> | 407 <dl> |
| 262 <dt>Return:</dt> | 408 <dt>Return:</dt> |
| 263 <dd> | 409 <dd> |
| 264 reference to the requested browser or None | 410 reference to the requested browser or None |
| 411 </dd> | |
| 412 </dl> | |
| 413 <dl> | |
| 414 <dt>Return Type:</dt> | |
| 415 <dd> | |
| 416 ProjectBaseBrowser or None | |
| 417 </dd> | |
| 418 </dl> | |
| 419 <a NAME="ProjectBrowser.getProjectBrowserFilter" ID="ProjectBrowser.getProjectBrowserFilter"></a> | |
| 420 <h4>ProjectBrowser.getProjectBrowserFilter</h4> | |
| 421 <b>getProjectBrowserFilter</b>(<i>fileCategory</i>) | |
| 422 | |
| 423 <p> | |
| 424 Public method to get the project browser file filter for a file category. | |
| 425 </p> | |
| 426 <dl> | |
| 427 | |
| 428 <dt><i>fileCategory</i> (str)</dt> | |
| 429 <dd> | |
| 430 file category | |
| 431 </dd> | |
| 432 </dl> | |
| 433 <dl> | |
| 434 <dt>Return:</dt> | |
| 435 <dd> | |
| 436 project browser file filter | |
| 437 </dd> | |
| 438 </dl> | |
| 439 <dl> | |
| 440 <dt>Return Type:</dt> | |
| 441 <dd> | |
| 442 str | |
| 443 </dd> | |
| 444 </dl> | |
| 445 <a NAME="ProjectBrowser.getProjectBrowserIcon" ID="ProjectBrowser.getProjectBrowserIcon"></a> | |
| 446 <h4>ProjectBrowser.getProjectBrowserIcon</h4> | |
| 447 <b>getProjectBrowserIcon</b>(<i>browserType</i>) | |
| 448 | |
| 449 <p> | |
| 450 Public method to get the icon for a project browser. | |
| 451 </p> | |
| 452 <dl> | |
| 453 | |
| 454 <dt><i>browserType</i> (str)</dt> | |
| 455 <dd> | |
| 456 type of the project browser | |
| 457 </dd> | |
| 458 </dl> | |
| 459 <dl> | |
| 460 <dt>Return:</dt> | |
| 461 <dd> | |
| 462 icon for the project browser | |
| 463 </dd> | |
| 464 </dl> | |
| 465 <dl> | |
| 466 <dt>Return Type:</dt> | |
| 467 <dd> | |
| 468 QIcon | |
| 265 </dd> | 469 </dd> |
| 266 </dl> | 470 </dl> |
| 267 <a NAME="ProjectBrowser.getProjectBrowserNames" ID="ProjectBrowser.getProjectBrowserNames"></a> | 471 <a NAME="ProjectBrowser.getProjectBrowserNames" ID="ProjectBrowser.getProjectBrowserNames"></a> |
| 268 <h4>ProjectBrowser.getProjectBrowserNames</h4> | 472 <h4>ProjectBrowser.getProjectBrowserNames</h4> |
| 269 <b>getProjectBrowserNames</b>(<i></i>) | 473 <b>getProjectBrowserNames</b>(<i></i>) |
| 270 | 474 |
| 271 <p> | 475 <p> |
| 272 Public method to get the names of the various project browsers. | 476 Public method to get the types of the various project browsers. |
| 273 </p> | 477 </p> |
| 274 <dl> | 478 <dl> |
| 275 <dt>Return:</dt> | 479 <dt>Return:</dt> |
| 276 <dd> | 480 <dd> |
| 277 list of project browser names (list of string) | 481 list of project browser types |
| 482 </dd> | |
| 483 </dl> | |
| 484 <dl> | |
| 485 <dt>Return Type:</dt> | |
| 486 <dd> | |
| 487 list of str | |
| 488 </dd> | |
| 489 </dl> | |
| 490 <a NAME="ProjectBrowser.getProjectBrowserType" ID="ProjectBrowser.getProjectBrowserType"></a> | |
| 491 <h4>ProjectBrowser.getProjectBrowserType</h4> | |
| 492 <b>getProjectBrowserType</b>(<i>fileCategory</i>) | |
| 493 | |
| 494 <p> | |
| 495 Public method to get the project browser type for a file category. | |
| 496 </p> | |
| 497 <dl> | |
| 498 | |
| 499 <dt><i>fileCategory</i> (str)</dt> | |
| 500 <dd> | |
| 501 file category | |
| 502 </dd> | |
| 503 </dl> | |
| 504 <dl> | |
| 505 <dt>Return:</dt> | |
| 506 <dd> | |
| 507 project browser type | |
| 508 </dd> | |
| 509 </dl> | |
| 510 <dl> | |
| 511 <dt>Return Type:</dt> | |
| 512 <dd> | |
| 513 str | |
| 514 </dd> | |
| 515 </dl> | |
| 516 <a NAME="ProjectBrowser.getProjectBrowserUserStrings" ID="ProjectBrowser.getProjectBrowserUserStrings"></a> | |
| 517 <h4>ProjectBrowser.getProjectBrowserUserStrings</h4> | |
| 518 <b>getProjectBrowserUserStrings</b>(<i></i>) | |
| 519 | |
| 520 <p> | |
| 521 Public method to get a dictionary of defined project browser user strings. | |
| 522 </p> | |
| 523 <dl> | |
| 524 <dt>Return:</dt> | |
| 525 <dd> | |
| 526 dictionary of defined project browser user strings | |
| 527 </dd> | |
| 528 </dl> | |
| 529 <dl> | |
| 530 <dt>Return Type:</dt> | |
| 531 <dd> | |
| 532 dict | |
| 278 </dd> | 533 </dd> |
| 279 </dl> | 534 </dl> |
| 280 <a NAME="ProjectBrowser.getProjectBrowsers" ID="ProjectBrowser.getProjectBrowsers"></a> | 535 <a NAME="ProjectBrowser.getProjectBrowsers" ID="ProjectBrowser.getProjectBrowsers"></a> |
| 281 <h4>ProjectBrowser.getProjectBrowsers</h4> | 536 <h4>ProjectBrowser.getProjectBrowsers</h4> |
| 282 <b>getProjectBrowsers</b>(<i></i>) | 537 <b>getProjectBrowsers</b>(<i></i>) |
| 288 <dt>Return:</dt> | 543 <dt>Return:</dt> |
| 289 <dd> | 544 <dd> |
| 290 list of references to project browsers | 545 list of references to project browsers |
| 291 </dd> | 546 </dd> |
| 292 </dl> | 547 </dl> |
| 548 <dl> | |
| 549 <dt>Return Type:</dt> | |
| 550 <dd> | |
| 551 list of ProjectBaseBrowser | |
| 552 </dd> | |
| 553 </dl> | |
| 293 <a NAME="ProjectBrowser.handleEditorChanged" ID="ProjectBrowser.handleEditorChanged"></a> | 554 <a NAME="ProjectBrowser.handleEditorChanged" ID="ProjectBrowser.handleEditorChanged"></a> |
| 294 <h4>ProjectBrowser.handleEditorChanged</h4> | 555 <h4>ProjectBrowser.handleEditorChanged</h4> |
| 295 <b>handleEditorChanged</b>(<i>fn</i>) | 556 <b>handleEditorChanged</b>(<i>fn</i>) |
| 296 | 557 |
| 297 <p> | 558 <p> |
| 298 Public slot to handle the editorChanged signal. | 559 Public slot to handle the editorChanged signal. |
| 299 </p> | 560 </p> |
| 300 <dl> | 561 <dl> |
| 301 | 562 |
| 302 <dt><i>fn</i></dt> | 563 <dt><i>fn</i> (str)</dt> |
| 303 <dd> | 564 <dd> |
| 304 filename of the changed file (string) | 565 filename of the changed file |
| 305 </dd> | 566 </dd> |
| 306 </dl> | 567 </dl> |
| 307 <a NAME="ProjectBrowser.handleEditorLineChanged" ID="ProjectBrowser.handleEditorLineChanged"></a> | 568 <a NAME="ProjectBrowser.handleEditorLineChanged" ID="ProjectBrowser.handleEditorLineChanged"></a> |
| 308 <h4>ProjectBrowser.handleEditorLineChanged</h4> | 569 <h4>ProjectBrowser.handleEditorLineChanged</h4> |
| 309 <b>handleEditorLineChanged</b>(<i>fn, lineno</i>) | 570 <b>handleEditorLineChanged</b>(<i>fn, lineno</i>) |
| 327 <b>handlePreferencesChanged</b>(<i></i>) | 588 <b>handlePreferencesChanged</b>(<i></i>) |
| 328 | 589 |
| 329 <p> | 590 <p> |
| 330 Public slot used to handle the preferencesChanged signal. | 591 Public slot used to handle the preferencesChanged signal. |
| 331 </p> | 592 </p> |
| 593 <a NAME="ProjectBrowser.removeTypedProjectBrowser" ID="ProjectBrowser.removeTypedProjectBrowser"></a> | |
| 594 <h4>ProjectBrowser.removeTypedProjectBrowser</h4> | |
| 595 <b>removeTypedProjectBrowser</b>(<i>browserType</i>) | |
| 596 | |
| 597 <p> | |
| 598 Public method to remove a browser type from the browsers repository. | |
| 599 </p> | |
| 600 <p> | |
| 601 Note: If the browser type is not contained in the repository, the request to | |
| 602 remove it will be ignored silently. | |
| 603 </p> | |
| 604 <dl> | |
| 605 | |
| 606 <dt><i>browserType</i> (str)</dt> | |
| 607 <dd> | |
| 608 project browser type | |
| 609 </dd> | |
| 610 </dl> | |
| 332 <div align="right"><a href="#top">Up</a></div> | 611 <div align="right"><a href="#top">Up</a></div> |
| 333 <hr /> | 612 <hr /> |
| 334 </body></html> | 613 </body></html> |
