Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Project.Project.html
src/eric7/Documentation/Source/eric7.Project.Project.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 9141
- 7085ece52151
- child 9215
- 30d7f7fd2b4a
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Project.Project</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.Project.Project</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing the project management functionality. | |
| 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="#Project">Project</a></td> | |
| 25 <td>Class implementing the project management functionality.</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="Project" ID="Project"></a> | |
| 36 <h2>Project</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing the project management functionality. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>appendStderr(str)</dt> | |
| 45 <dd> | |
| 46 emitted after something was received from | |
| 47 a QProcess on stderr | |
| 48 </dd> | |
| 49 <dt>appendStdout(str)</dt> | |
| 50 <dd> | |
| 51 emitted after something was received from | |
| 52 a QProcess on stdout | |
| 53 </dd> | |
| 54 <dt>completeRepopulateItem(str)</dt> | |
| 55 <dd> | |
| 56 emitted after an item of the model was | |
| 57 repopulated | |
| 58 </dd> | |
| 59 <dt>designerFile(str)</dt> | |
| 60 <dd> | |
| 61 emitted to open a found designer file | |
| 62 </dd> | |
| 63 <dt>directoryRemoved(str)</dt> | |
| 64 <dd> | |
| 65 emitted after a directory has been removed | |
| 66 from the project | |
| 67 </dd> | |
| 68 <dt>dirty(bool)</dt> | |
| 69 <dd> | |
| 70 emitted when the dirty state changes | |
| 71 </dd> | |
| 72 <dt>lexerAssociationsChanged()</dt> | |
| 73 <dd> | |
| 74 emitted after the lexer associations | |
| 75 have been changed | |
| 76 </dd> | |
| 77 <dt>linguistFile(str)</dt> | |
| 78 <dd> | |
| 79 emitted to open a found translation file | |
| 80 </dd> | |
| 81 <dt>newProject()</dt> | |
| 82 <dd> | |
| 83 emitted after a new project was generated | |
| 84 </dd> | |
| 85 <dt>newProjectHooks()</dt> | |
| 86 <dd> | |
| 87 emitted after a new project was generated but | |
| 88 before the newProject() signal is sent | |
| 89 </dd> | |
| 90 <dt>prepareRepopulateItem(str)</dt> | |
| 91 <dd> | |
| 92 emitted before an item of the model is | |
| 93 repopulated | |
| 94 </dd> | |
| 95 <dt>projectAboutToBeCreated()</dt> | |
| 96 <dd> | |
| 97 emitted just before the project will be | |
| 98 created | |
| 99 </dd> | |
| 100 <dt>projectChanged()</dt> | |
| 101 <dd> | |
| 102 emitted to signal a change of the project | |
| 103 </dd> | |
| 104 <dt>projectClosed(shutdown)</dt> | |
| 105 <dd> | |
| 106 emitted after a project was closed sending | |
| 107 a flag indicating the IDE shutdown operation | |
| 108 </dd> | |
| 109 <dt>projectClosedHooks()</dt> | |
| 110 <dd> | |
| 111 emitted after a project file was closed but | |
| 112 before the projectClosed() signal is sent | |
| 113 </dd> | |
| 114 <dt>projectFileRenamed(str, str)</dt> | |
| 115 <dd> | |
| 116 emitted after a file of the project | |
| 117 has been renamed | |
| 118 </dd> | |
| 119 <dt>projectFormAdded(str)</dt> | |
| 120 <dd> | |
| 121 emitted after a new form was added | |
| 122 </dd> | |
| 123 <dt>projectFormCompiled(str)</dt> | |
| 124 <dd> | |
| 125 emitted after a form was compiled | |
| 126 </dd> | |
| 127 <dt>projectFormRemoved(str)</dt> | |
| 128 <dd> | |
| 129 emitted after a form was removed | |
| 130 </dd> | |
| 131 <dt>projectInterfaceAdded(str)</dt> | |
| 132 <dd> | |
| 133 emitted after a new IDL file was added | |
| 134 </dd> | |
| 135 <dt>projectInterfaceRemoved(str)</dt> | |
| 136 <dd> | |
| 137 emitted after a IDL file was removed | |
| 138 </dd> | |
| 139 <dt>projectLanguageAdded(str)</dt> | |
| 140 <dd> | |
| 141 emitted after a new language was added | |
| 142 </dd> | |
| 143 <dt>projectLanguageAddedByCode(str)</dt> | |
| 144 <dd> | |
| 145 emitted after a new language was | |
| 146 added. The language code is sent by this signal. | |
| 147 </dd> | |
| 148 <dt>projectLanguageRemoved(str)</dt> | |
| 149 <dd> | |
| 150 emitted after a language was removed | |
| 151 </dd> | |
| 152 <dt>projectOpened()</dt> | |
| 153 <dd> | |
| 154 emitted after a project file was read | |
| 155 </dd> | |
| 156 <dt>projectOpenedHooks()</dt> | |
| 157 <dd> | |
| 158 emitted after a project file was read but | |
| 159 before the projectOpened() signal is sent | |
| 160 </dd> | |
| 161 <dt>projectOthersAdded(str)</dt> | |
| 162 <dd> | |
| 163 emitted after a file or directory was added | |
| 164 to the OTHERS project data area | |
| 165 </dd> | |
| 166 <dt>projectOthersRemoved(str)</dt> | |
| 167 <dd> | |
| 168 emitted after a file was removed from the | |
| 169 OTHERS project data area | |
| 170 </dd> | |
| 171 <dt>projectPropertiesChanged()</dt> | |
| 172 <dd> | |
| 173 emitted after the project properties | |
| 174 were changed | |
| 175 </dd> | |
| 176 <dt>projectProtocolAdded(str)</dt> | |
| 177 <dd> | |
| 178 emitted after a new proto file was added | |
| 179 </dd> | |
| 180 <dt>projectProtocolRemoved(str)</dt> | |
| 181 <dd> | |
| 182 emitted after a proto file was removed | |
| 183 </dd> | |
| 184 <dt>projectResourceAdded(str)</dt> | |
| 185 <dd> | |
| 186 emitted after a new resource file was | |
| 187 added | |
| 188 </dd> | |
| 189 <dt>projectResourceRemoved(str)</dt> | |
| 190 <dd> | |
| 191 emitted after a resource was removed | |
| 192 </dd> | |
| 193 <dt>projectSourceAdded(str)</dt> | |
| 194 <dd> | |
| 195 emitted after a new source file was added | |
| 196 </dd> | |
| 197 <dt>projectSourceRemoved(str)</dt> | |
| 198 <dd> | |
| 199 emitted after a source was removed | |
| 200 </dd> | |
| 201 <dt>reinitVCS()</dt> | |
| 202 <dd> | |
| 203 emitted after the VCS has been reinitialized | |
| 204 </dd> | |
| 205 <dt>showMenu(str, QMenu)</dt> | |
| 206 <dd> | |
| 207 emitted when a menu is about to be shown. The | |
| 208 name of the menu and a reference to the menu are given. | |
| 209 </dd> | |
| 210 <dt>sourceFile(str)</dt> | |
| 211 <dd> | |
| 212 emitted after a project file was read to | |
| 213 open the main script | |
| 214 </dd> | |
| 215 <dt>vcsCommitted()</dt> | |
| 216 <dd> | |
| 217 emitted to indicate a completed commit action | |
| 218 </dd> | |
| 219 <dt>vcsStatusMonitorAllData(dict)</dt> | |
| 220 <dd> | |
| 221 emitted to signal all VCS status | |
| 222 (key is project relative file name, value is status) | |
| 223 </dd> | |
| 224 <dt>vcsStatusMonitorData(list)</dt> | |
| 225 <dd> | |
| 226 emitted to signal the VCS status data | |
| 227 </dd> | |
| 228 <dt>vcsStatusMonitorInfo(str)</dt> | |
| 229 <dd> | |
| 230 emitted to signal some info of the | |
| 231 monitoring thread | |
| 232 </dd> | |
| 233 <dt>vcsStatusMonitorStatus(str, str)</dt> | |
| 234 <dd> | |
| 235 emitted to signal the status of | |
| 236 the monitoring thread (ok, nok, op, off) and a status message | |
| 237 </dd> | |
| 238 </dl> | |
| 239 <h3>Derived from</h3> | |
| 240 QObject | |
| 241 <h3>Class Attributes</h3> | |
| 242 | |
| 243 <table> | |
| 244 <tr><td>DefaultMake</td></tr><tr><td>DefaultMakefile</td></tr><tr><td>eols</td></tr> | |
| 245 </table> | |
| 246 <h3>Class Methods</h3> | |
| 247 | |
| 248 <table> | |
| 249 <tr><td>None</td></tr> | |
| 250 </table> | |
| 251 <h3>Methods</h3> | |
| 252 | |
| 253 <table> | |
| 254 | |
| 255 <tr> | |
| 256 <td><a href="#Project.__init__">Project</a></td> | |
| 257 <td>Constructor</td> | |
| 258 </tr> | |
| 259 <tr> | |
| 260 <td><a href="#Project.__addRecursiveDirectory">__addRecursiveDirectory</a></td> | |
| 261 <td>Private method used to add all files of a directory tree.</td> | |
| 262 </tr> | |
| 263 <tr> | |
| 264 <td><a href="#Project.__addSingleDirectory">__addSingleDirectory</a></td> | |
| 265 <td>Private method used to add all files of a single directory to the project.</td> | |
| 266 </tr> | |
| 267 <tr> | |
| 268 <td><a href="#Project.__binaryTranslationFile">__binaryTranslationFile</a></td> | |
| 269 <td>Private method to calculate the filename of the binary translations file given the name of the raw translations file.</td> | |
| 270 </tr> | |
| 271 <tr> | |
| 272 <td><a href="#Project.__checkFilesExist">__checkFilesExist</a></td> | |
| 273 <td>Private method to check, if the files in a list exist.</td> | |
| 274 </tr> | |
| 275 <tr> | |
| 276 <td><a href="#Project.__checkProjectFileGroup">__checkProjectFileGroup</a></td> | |
| 277 <td>Private method to check, if a file is in a specific file group of the project.</td> | |
| 278 </tr> | |
| 279 <tr> | |
| 280 <td><a href="#Project.__cleanupMake">__cleanupMake</a></td> | |
| 281 <td>Private method to clean up make related stuff.</td> | |
| 282 </tr> | |
| 283 <tr> | |
| 284 <td><a href="#Project.__closeAllWindows">__closeAllWindows</a></td> | |
| 285 <td>Private method to close all project related windows.</td> | |
| 286 </tr> | |
| 287 <tr> | |
| 288 <td><a href="#Project.__createSBOMFile">__createSBOMFile</a></td> | |
| 289 <td>Private slot to create a SBOM file of the project dependencies.</td> | |
| 290 </tr> | |
| 291 <tr> | |
| 292 <td><a href="#Project.__createSnapshotSource">__createSnapshotSource</a></td> | |
| 293 <td>Private method to create a snapshot plugin version.</td> | |
| 294 </tr> | |
| 295 <tr> | |
| 296 <td><a href="#Project.__createZipDirEntries">__createZipDirEntries</a></td> | |
| 297 <td>Private method to create dir entries in the zip file.</td> | |
| 298 </tr> | |
| 299 <tr> | |
| 300 <td><a href="#Project.__deleteDebugProperties">__deleteDebugProperties</a></td> | |
| 301 <td>Private method to delete the project debugger properties file (.edj or .e4d).</td> | |
| 302 </tr> | |
| 303 <tr> | |
| 304 <td><a href="#Project.__deleteSession">__deleteSession</a></td> | |
| 305 <td>Private method to delete the session file.</td> | |
| 306 </tr> | |
| 307 <tr> | |
| 308 <td><a href="#Project.__doSearchNewFiles">__doSearchNewFiles</a></td> | |
| 309 <td>Private method to search for new files in the project directory.</td> | |
| 310 </tr> | |
| 311 <tr> | |
| 312 <td><a href="#Project.__executeMake">__executeMake</a></td> | |
| 313 <td>Private method to execute a project specific make run.</td> | |
| 314 </tr> | |
| 315 <tr> | |
| 316 <td><a href="#Project.__initData">__initData</a></td> | |
| 317 <td>Private method to initialize the project data part.</td> | |
| 318 </tr> | |
| 319 <tr> | |
| 320 <td><a href="#Project.__initDebugProperties">__initDebugProperties</a></td> | |
| 321 <td>Private method to initialize the debug properties.</td> | |
| 322 </tr> | |
| 323 <tr> | |
| 324 <td><a href="#Project.__initProjectTypes">__initProjectTypes</a></td> | |
| 325 <td>Private method to initialize the list of supported project types.</td> | |
| 326 </tr> | |
| 327 <tr> | |
| 328 <td><a href="#Project.__isInPdata">__isInPdata</a></td> | |
| 329 <td>Private method used to check, if the passed in filename is project controlled..</td> | |
| 330 </tr> | |
| 331 <tr> | |
| 332 <td><a href="#Project.__loadDiagram">__loadDiagram</a></td> | |
| 333 <td>Private slot to load a diagram from file.</td> | |
| 334 </tr> | |
| 335 <tr> | |
| 336 <td><a href="#Project.__loadRecent">__loadRecent</a></td> | |
| 337 <td>Private method to load the recently opened project filenames.</td> | |
| 338 </tr> | |
| 339 <tr> | |
| 340 <td><a href="#Project.__makeFinished">__makeFinished</a></td> | |
| 341 <td>Private slot handling the make process finished signal.</td> | |
| 342 </tr> | |
| 343 <tr> | |
| 344 <td><a href="#Project.__makeReadStdErr">__makeReadStdErr</a></td> | |
| 345 <td>Private slot to process process output received via stderr.</td> | |
| 346 </tr> | |
| 347 <tr> | |
| 348 <td><a href="#Project.__makeReadStdOut">__makeReadStdOut</a></td> | |
| 349 <td>Private slot to process process output received via stdout.</td> | |
| 350 </tr> | |
| 351 <tr> | |
| 352 <td><a href="#Project.__openRecent">__openRecent</a></td> | |
| 353 <td>Private method to open a project from the list of rencently opened projects.</td> | |
| 354 </tr> | |
| 355 <tr> | |
| 356 <td><a href="#Project.__pluginCreateArchives">__pluginCreateArchives</a></td> | |
| 357 <td>Private slot to create eric plugin archives.</td> | |
| 358 </tr> | |
| 359 <tr> | |
| 360 <td><a href="#Project.__pluginCreatePkgList">__pluginCreatePkgList</a></td> | |
| 361 <td>Private slot to create a PKGLIST file needed for archive file creation.</td> | |
| 362 </tr> | |
| 363 <tr> | |
| 364 <td><a href="#Project.__pluginCreateSnapshotArchives">__pluginCreateSnapshotArchives</a></td> | |
| 365 <td>Private slot to create eric plugin archive snapshot releases.</td> | |
| 366 </tr> | |
| 367 <tr> | |
| 368 <td><a href="#Project.__pluginExtractVersion">__pluginExtractVersion</a></td> | |
| 369 <td>Private method to extract the version number entry.</td> | |
| 370 </tr> | |
| 371 <tr> | |
| 372 <td><a href="#Project.__pluginVersionToTuple">__pluginVersionToTuple</a></td> | |
| 373 <td>Private method to convert a plug-in version string into a version tuple.</td> | |
| 374 </tr> | |
| 375 <tr> | |
| 376 <td><a href="#Project.__readDebugProperties">__readDebugProperties</a></td> | |
| 377 <td>Private method to read in the project debugger properties file (.edj or .e4d).</td> | |
| 378 </tr> | |
| 379 <tr> | |
| 380 <td><a href="#Project.__readProject">__readProject</a></td> | |
| 381 <td>Private method to read in a project (.epj or .e4p) file.</td> | |
| 382 </tr> | |
| 383 <tr> | |
| 384 <td><a href="#Project.__readSession">__readSession</a></td> | |
| 385 <td>Private method to read in the project session file (.esj or .e5s).</td> | |
| 386 </tr> | |
| 387 <tr> | |
| 388 <td><a href="#Project.__readTasks">__readTasks</a></td> | |
| 389 <td>Private method to read in the project tasks file (.etj or .e6t).</td> | |
| 390 </tr> | |
| 391 <tr> | |
| 392 <td><a href="#Project.__readUserProperties">__readUserProperties</a></td> | |
| 393 <td>Private method to read in the user specific project file (.eqj or .e4q).</td> | |
| 394 </tr> | |
| 395 <tr> | |
| 396 <td><a href="#Project.__reorganizeFiles">__reorganizeFiles</a></td> | |
| 397 <td>Private method to reorganize files stored in the project.</td> | |
| 398 </tr> | |
| 399 <tr> | |
| 400 <td><a href="#Project.__saveRecent">__saveRecent</a></td> | |
| 401 <td>Private method to save the list of recently opened filenames.</td> | |
| 402 </tr> | |
| 403 <tr> | |
| 404 <td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td> | |
| 405 <td>Private slot used to handle the search new files action.</td> | |
| 406 </tr> | |
| 407 <tr> | |
| 408 <td><a href="#Project.__searchProjectFile">__searchProjectFile</a></td> | |
| 409 <td>Private slot to show the Find Project File dialog.</td> | |
| 410 </tr> | |
| 411 <tr> | |
| 412 <td><a href="#Project.__showCodeCoverage">__showCodeCoverage</a></td> | |
| 413 <td>Private slot used to show the code coverage information for the project files.</td> | |
| 414 </tr> | |
| 415 <tr> | |
| 416 <td><a href="#Project.__showCodeMetrics">__showCodeMetrics</a></td> | |
| 417 <td>Private slot used to calculate some code metrics for the project files.</td> | |
| 418 </tr> | |
| 419 <tr> | |
| 420 <td><a href="#Project.__showContextMenuApiDoc">__showContextMenuApiDoc</a></td> | |
| 421 <td>Private slot called before the apidoc menu is shown.</td> | |
| 422 </tr> | |
| 423 <tr> | |
| 424 <td><a href="#Project.__showContextMenuChecks">__showContextMenuChecks</a></td> | |
| 425 <td>Private slot called before the checks menu is shown.</td> | |
| 426 </tr> | |
| 427 <tr> | |
| 428 <td><a href="#Project.__showContextMenuDebugger">__showContextMenuDebugger</a></td> | |
| 429 <td>Private slot called before the Debugger menu is shown.</td> | |
| 430 </tr> | |
| 431 <tr> | |
| 432 <td><a href="#Project.__showContextMenuGraphics">__showContextMenuGraphics</a></td> | |
| 433 <td>Private slot called before the graphics menu is shown.</td> | |
| 434 </tr> | |
| 435 <tr> | |
| 436 <td><a href="#Project.__showContextMenuMake">__showContextMenuMake</a></td> | |
| 437 <td>Private slot called before the make menu is shown.</td> | |
| 438 </tr> | |
| 439 <tr> | |
| 440 <td><a href="#Project.__showContextMenuOthers">__showContextMenuOthers</a></td> | |
| 441 <td>Private slot called before the 'Other Tools' menu is shown.</td> | |
| 442 </tr> | |
| 443 <tr> | |
| 444 <td><a href="#Project.__showContextMenuPackagers">__showContextMenuPackagers</a></td> | |
| 445 <td>Private slot called before the packagers menu is shown.</td> | |
| 446 </tr> | |
| 447 <tr> | |
| 448 <td><a href="#Project.__showContextMenuRecent">__showContextMenuRecent</a></td> | |
| 449 <td>Private method to set up the recent projects menu.</td> | |
| 450 </tr> | |
| 451 <tr> | |
| 452 <td><a href="#Project.__showContextMenuSession">__showContextMenuSession</a></td> | |
| 453 <td>Private slot called before the Session menu is shown.</td> | |
| 454 </tr> | |
| 455 <tr> | |
| 456 <td><a href="#Project.__showContextMenuShow">__showContextMenuShow</a></td> | |
| 457 <td>Private slot called before the show menu is shown.</td> | |
| 458 </tr> | |
| 459 <tr> | |
| 460 <td><a href="#Project.__showContextMenuVCS">__showContextMenuVCS</a></td> | |
| 461 <td>Private slot called before the vcs menu is shown.</td> | |
| 462 </tr> | |
| 463 <tr> | |
| 464 <td><a href="#Project.__showDebugProperties">__showDebugProperties</a></td> | |
| 465 <td>Private slot to display the debugger properties dialog.</td> | |
| 466 </tr> | |
| 467 <tr> | |
| 468 <td><a href="#Project.__showFiletypeAssociations">__showFiletypeAssociations</a></td> | |
| 469 <td>Private slot to display the filetype association dialog.</td> | |
| 470 </tr> | |
| 471 <tr> | |
| 472 <td><a href="#Project.__showLexerAssociations">__showLexerAssociations</a></td> | |
| 473 <td>Private slot to display the lexer association dialog.</td> | |
| 474 </tr> | |
| 475 <tr> | |
| 476 <td><a href="#Project.__showMenu">__showMenu</a></td> | |
| 477 <td>Private method to set up the project menu.</td> | |
| 478 </tr> | |
| 479 <tr> | |
| 480 <td><a href="#Project.__showProfileData">__showProfileData</a></td> | |
| 481 <td>Private slot used to show the profiling information for the project.</td> | |
| 482 </tr> | |
| 483 <tr> | |
| 484 <td><a href="#Project.__showProperties">__showProperties</a></td> | |
| 485 <td>Private slot to display the properties dialog.</td> | |
| 486 </tr> | |
| 487 <tr> | |
| 488 <td><a href="#Project.__showUserProperties">__showUserProperties</a></td> | |
| 489 <td>Private slot to display the user specific properties dialog.</td> | |
| 490 </tr> | |
| 491 <tr> | |
| 492 <td><a href="#Project.__sourceExtensions">__sourceExtensions</a></td> | |
| 493 <td>Private method to get the source extensions of a programming language.</td> | |
| 494 </tr> | |
| 495 <tr> | |
| 496 <td><a href="#Project.__syncRecent">__syncRecent</a></td> | |
| 497 <td>Private method to synchronize the list of recently opened projects with the central store.</td> | |
| 498 </tr> | |
| 499 <tr> | |
| 500 <td><a href="#Project.__vcsConnectStatusMonitor">__vcsConnectStatusMonitor</a></td> | |
| 501 <td>Private method to start the VCS monitor and connect its signals.</td> | |
| 502 </tr> | |
| 503 <tr> | |
| 504 <td><a href="#Project.__vcsStatusChanged">__vcsStatusChanged</a></td> | |
| 505 <td>Private slot to handle a change of the overall VCS status.</td> | |
| 506 </tr> | |
| 507 <tr> | |
| 508 <td><a href="#Project.__writeDebugProperties">__writeDebugProperties</a></td> | |
| 509 <td>Private method to write the project debugger properties file (.edj).</td> | |
| 510 </tr> | |
| 511 <tr> | |
| 512 <td><a href="#Project.__writeProject">__writeProject</a></td> | |
| 513 <td>Private method to save the project infos to a project file.</td> | |
| 514 </tr> | |
| 515 <tr> | |
| 516 <td><a href="#Project.__writeSession">__writeSession</a></td> | |
| 517 <td>Private method to write the session data to an XML file (.esj).</td> | |
| 518 </tr> | |
| 519 <tr> | |
| 520 <td><a href="#Project.__writeUserProperties">__writeUserProperties</a></td> | |
| 521 <td>Private method to write the user specific project data to a JSON file.</td> | |
| 522 </tr> | |
| 523 <tr> | |
| 524 <td><a href="#Project.addDirectory">addDirectory</a></td> | |
| 525 <td>Public method used to add all files of a directory to the project.</td> | |
| 526 </tr> | |
| 527 <tr> | |
| 528 <td><a href="#Project.addEricActions">addEricActions</a></td> | |
| 529 <td>Public method to add actions to the list of actions.</td> | |
| 530 </tr> | |
| 531 <tr> | |
| 532 <td><a href="#Project.addFiles">addFiles</a></td> | |
| 533 <td>Public slot used to add files to the project.</td> | |
| 534 </tr> | |
| 535 <tr> | |
| 536 <td><a href="#Project.addIdlDir">addIdlDir</a></td> | |
| 537 <td>Public slot to add all IDL interfaces of a directory to the current project.</td> | |
| 538 </tr> | |
| 539 <tr> | |
| 540 <td><a href="#Project.addIdlFiles">addIdlFiles</a></td> | |
| 541 <td>Public slot to add IDL interfaces to the current project.</td> | |
| 542 </tr> | |
| 543 <tr> | |
| 544 <td><a href="#Project.addLanguage">addLanguage</a></td> | |
| 545 <td>Public slot used to add a language to the project.</td> | |
| 546 </tr> | |
| 547 <tr> | |
| 548 <td><a href="#Project.addOthersDir">addOthersDir</a></td> | |
| 549 <td>Public slot to add a directory to the OTHERS project data.</td> | |
| 550 </tr> | |
| 551 <tr> | |
| 552 <td><a href="#Project.addOthersFiles">addOthersFiles</a></td> | |
| 553 <td>Public slot to add files to the OTHERS project data.</td> | |
| 554 </tr> | |
| 555 <tr> | |
| 556 <td><a href="#Project.addProtoDir">addProtoDir</a></td> | |
| 557 <td>Public slot to add all protocol files of a directory to the current project.</td> | |
| 558 </tr> | |
| 559 <tr> | |
| 560 <td><a href="#Project.addProtoFiles">addProtoFiles</a></td> | |
| 561 <td>Public slot to add protocol files to the current project.</td> | |
| 562 </tr> | |
| 563 <tr> | |
| 564 <td><a href="#Project.addResourceDir">addResourceDir</a></td> | |
| 565 <td>Public slot to add all Qt resource files of a directory to the current project.</td> | |
| 566 </tr> | |
| 567 <tr> | |
| 568 <td><a href="#Project.addResourceFiles">addResourceFiles</a></td> | |
| 569 <td>Public slot to add Qt resources to the current project.</td> | |
| 570 </tr> | |
| 571 <tr> | |
| 572 <td><a href="#Project.addSourceDir">addSourceDir</a></td> | |
| 573 <td>Public slot to add all source files of a directory to the current project.</td> | |
| 574 </tr> | |
| 575 <tr> | |
| 576 <td><a href="#Project.addSourceFiles">addSourceFiles</a></td> | |
| 577 <td>Public slot to add source files to the current project.</td> | |
| 578 </tr> | |
| 579 <tr> | |
| 580 <td><a href="#Project.addToOthers">addToOthers</a></td> | |
| 581 <td>Public method to add a file/directory to the OTHERS project data.</td> | |
| 582 </tr> | |
| 583 <tr> | |
| 584 <td><a href="#Project.addUiDir">addUiDir</a></td> | |
| 585 <td>Public slot to add all forms of a directory to the current project.</td> | |
| 586 </tr> | |
| 587 <tr> | |
| 588 <td><a href="#Project.addUiFiles">addUiFiles</a></td> | |
| 589 <td>Public slot to add forms to the current project.</td> | |
| 590 </tr> | |
| 591 <tr> | |
| 592 <td><a href="#Project.appendFile">appendFile</a></td> | |
| 593 <td>Public method to append a file to the project.</td> | |
| 594 </tr> | |
| 595 <tr> | |
| 596 <td><a href="#Project.checkAllScriptsDirty">checkAllScriptsDirty</a></td> | |
| 597 <td>Public method to check all scripts belonging to the project for their dirty status.</td> | |
| 598 </tr> | |
| 599 <tr> | |
| 600 <td><a href="#Project.checkDirty">checkDirty</a></td> | |
| 601 <td>Public method to check dirty status and open a message window.</td> | |
| 602 </tr> | |
| 603 <tr> | |
| 604 <td><a href="#Project.checkLanguageFiles">checkLanguageFiles</a></td> | |
| 605 <td>Public slot to check the language files after a release process.</td> | |
| 606 </tr> | |
| 607 <tr> | |
| 608 <td><a href="#Project.checkVCSStatus">checkVCSStatus</a></td> | |
| 609 <td>Public method to wake up the VCS status monitor thread.</td> | |
| 610 </tr> | |
| 611 <tr> | |
| 612 <td><a href="#Project.clearHistories">clearHistories</a></td> | |
| 613 <td>Public method to clear the project related histories.</td> | |
| 614 </tr> | |
| 615 <tr> | |
| 616 <td><a href="#Project.clearRecent">clearRecent</a></td> | |
| 617 <td>Public method to clear the recent projects menu.</td> | |
| 618 </tr> | |
| 619 <tr> | |
| 620 <td><a href="#Project.clearStatusMonitorCachedState">clearStatusMonitorCachedState</a></td> | |
| 621 <td>Public method to clear the cached VCS state of a file/directory.</td> | |
| 622 </tr> | |
| 623 <tr> | |
| 624 <td><a href="#Project.closeProject">closeProject</a></td> | |
| 625 <td>Public slot to close the current project.</td> | |
| 626 </tr> | |
| 627 <tr> | |
| 628 <td><a href="#Project.copyDirectory">copyDirectory</a></td> | |
| 629 <td>Public slot to copy a directory.</td> | |
| 630 </tr> | |
| 631 <tr> | |
| 632 <td><a href="#Project.createNewProject">createNewProject</a></td> | |
| 633 <td>Public slot to built a new project.</td> | |
| 634 </tr> | |
| 635 <tr> | |
| 636 <td><a href="#Project.createProjectManagementDir">createProjectManagementDir</a></td> | |
| 637 <td>Public method to create the project management directory.</td> | |
| 638 </tr> | |
| 639 <tr> | |
| 640 <td><a href="#Project.deleteDirectory">deleteDirectory</a></td> | |
| 641 <td>Public method to delete a directory from the project directory.</td> | |
| 642 </tr> | |
| 643 <tr> | |
| 644 <td><a href="#Project.deleteFile">deleteFile</a></td> | |
| 645 <td>Public method to delete a file from the project directory.</td> | |
| 646 </tr> | |
| 647 <tr> | |
| 648 <td><a href="#Project.deleteLanguageFile">deleteLanguageFile</a></td> | |
| 649 <td>Public slot to delete a translation from the project directory.</td> | |
| 650 </tr> | |
| 651 <tr> | |
| 652 <td><a href="#Project.executeMake">executeMake</a></td> | |
| 653 <td>Public slot to execute a project specific make run (auto-run) (execute or question).</td> | |
| 654 </tr> | |
| 655 <tr> | |
| 656 <td><a href="#Project.getAbsolutePath">getAbsolutePath</a></td> | |
| 657 <td>Public method to convert a project relative file path to an absolute file path.</td> | |
| 658 </tr> | |
| 659 <tr> | |
| 660 <td><a href="#Project.getAbsoluteUniversalPath">getAbsoluteUniversalPath</a></td> | |
| 661 <td>Public method to convert a project relative file path with universal separators to an absolute file path.</td> | |
| 662 </tr> | |
| 663 <tr> | |
| 664 <td><a href="#Project.getActions">getActions</a></td> | |
| 665 <td>Public method to get a list of all actions.</td> | |
| 666 </tr> | |
| 667 <tr> | |
| 668 <td><a href="#Project.getData">getData</a></td> | |
| 669 <td>Public method to get data out of the project data store.</td> | |
| 670 </tr> | |
| 671 <tr> | |
| 672 <td><a href="#Project.getDebugProperty">getDebugProperty</a></td> | |
| 673 <td>Public method to retrieve a debugger property.</td> | |
| 674 </tr> | |
| 675 <tr> | |
| 676 <td><a href="#Project.getDebuggerFilters">getDebuggerFilters</a></td> | |
| 677 <td>Public method to get the debugger filters for a programming language.</td> | |
| 678 </tr> | |
| 679 <tr> | |
| 680 <td><a href="#Project.getDefaultRccCompilerParameters">getDefaultRccCompilerParameters</a></td> | |
| 681 <td>Public method to get the default rcc compiler parameters.</td> | |
| 682 </tr> | |
| 683 <tr> | |
| 684 <td><a href="#Project.getDefaultSourceExtension">getDefaultSourceExtension</a></td> | |
| 685 <td>Public method to get the default extension for the project's programming language.</td> | |
| 686 </tr> | |
| 687 <tr> | |
| 688 <td><a href="#Project.getDocstringType">getDocstringType</a></td> | |
| 689 <td>Public method to get the configured docstring style.</td> | |
| 690 </tr> | |
| 691 <tr> | |
| 692 <td><a href="#Project.getEditorLexerAssoc">getEditorLexerAssoc</a></td> | |
| 693 <td>Public method to retrieve a lexer association.</td> | |
| 694 </tr> | |
| 695 <tr> | |
| 696 <td><a href="#Project.getEolString">getEolString</a></td> | |
| 697 <td>Public method to get the EOL-string to be used by the project.</td> | |
| 698 </tr> | |
| 699 <tr> | |
| 700 <td><a href="#Project.getFiles">getFiles</a></td> | |
| 701 <td>Public method to get all files starting with a common prefix.</td> | |
| 702 </tr> | |
| 703 <tr> | |
| 704 <td><a href="#Project.getFiletypeAssociations">getFiletypeAssociations</a></td> | |
| 705 <td>Public method to get the list of file type associations for the given association type.</td> | |
| 706 </tr> | |
| 707 <tr> | |
| 708 <td><a href="#Project.getHash">getHash</a></td> | |
| 709 <td>Public method to get the project hash.</td> | |
| 710 </tr> | |
| 711 <tr> | |
| 712 <td><a href="#Project.getIgnorePatterns">getIgnorePatterns</a></td> | |
| 713 <td>Public method to get the list of file name patterns for files to be ignored.</td> | |
| 714 </tr> | |
| 715 <tr> | |
| 716 <td><a href="#Project.getMainScript">getMainScript</a></td> | |
| 717 <td>Public method to return the main script filename.</td> | |
| 718 </tr> | |
| 719 <tr> | |
| 720 <td><a href="#Project.getMenu">getMenu</a></td> | |
| 721 <td>Public method to get a reference to the main menu or a submenu.</td> | |
| 722 </tr> | |
| 723 <tr> | |
| 724 <td><a href="#Project.getModel">getModel</a></td> | |
| 725 <td>Public method to get a reference to the project browser model.</td> | |
| 726 </tr> | |
| 727 <tr> | |
| 728 <td><a href="#Project.getMostRecent">getMostRecent</a></td> | |
| 729 <td>Public method to get the most recently opened project.</td> | |
| 730 </tr> | |
| 731 <tr> | |
| 732 <td><a href="#Project.getProgrammingLanguages">getProgrammingLanguages</a></td> | |
| 733 <td>Public method to get the programming languages supported by project.</td> | |
| 734 </tr> | |
| 735 <tr> | |
| 736 <td><a href="#Project.getProjectAuthor">getProjectAuthor</a></td> | |
| 737 <td>Public method to get the author of the project.</td> | |
| 738 </tr> | |
| 739 <tr> | |
| 740 <td><a href="#Project.getProjectAuthorEmail">getProjectAuthorEmail</a></td> | |
| 741 <td>Public method to get the email address of the project author.</td> | |
| 742 </tr> | |
| 743 <tr> | |
| 744 <td><a href="#Project.getProjectDescription">getProjectDescription</a></td> | |
| 745 <td>Public method to get the description of the project.</td> | |
| 746 </tr> | |
| 747 <tr> | |
| 748 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td> | |
| 749 <td>Public method to get the names of the project specific dictionaries.</td> | |
| 750 </tr> | |
| 751 <tr> | |
| 752 <td><a href="#Project.getProjectExecPath">getProjectExecPath</a></td> | |
| 753 <td>Public method to get the executable search path prefix of the project.</td> | |
| 754 </tr> | |
| 755 <tr> | |
| 756 <td><a href="#Project.getProjectFile">getProjectFile</a></td> | |
| 757 <td>Public method to get the path of the project file.</td> | |
| 758 </tr> | |
| 759 <tr> | |
| 760 <td><a href="#Project.getProjectFiles">getProjectFiles</a></td> | |
| 761 <td>Public method to get the file entries of the given type.</td> | |
| 762 </tr> | |
| 763 <tr> | |
| 764 <td><a href="#Project.getProjectInterpreter">getProjectInterpreter</a></td> | |
| 765 <td>Public method to get the path of the interpreter used by the project.</td> | |
| 766 </tr> | |
| 767 <tr> | |
| 768 <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td> | |
| 769 <td>Public method to get the project's programming language.</td> | |
| 770 </tr> | |
| 771 <tr> | |
| 772 <td><a href="#Project.getProjectLicense">getProjectLicense</a></td> | |
| 773 <td>Public method to get the license type used by the project.</td> | |
| 774 </tr> | |
| 775 <tr> | |
| 776 <td><a href="#Project.getProjectManagementDir">getProjectManagementDir</a></td> | |
| 777 <td>Public method to get the path of the management directory.</td> | |
| 778 </tr> | |
| 779 <tr> | |
| 780 <td><a href="#Project.getProjectName">getProjectName</a></td> | |
| 781 <td>Public method to get the name of the project.</td> | |
| 782 </tr> | |
| 783 <tr> | |
| 784 <td><a href="#Project.getProjectPath">getProjectPath</a></td> | |
| 785 <td>Public method to get the project path.</td> | |
| 786 </tr> | |
| 787 <tr> | |
| 788 <td><a href="#Project.getProjectSpellLanguage">getProjectSpellLanguage</a></td> | |
| 789 <td>Public method to get the project's programming language.</td> | |
| 790 </tr> | |
| 791 <tr> | |
| 792 <td><a href="#Project.getProjectTestingFramework">getProjectTestingFramework</a></td> | |
| 793 <td>Public method to get the testing framework name of the project.</td> | |
| 794 </tr> | |
| 795 <tr> | |
| 796 <td><a href="#Project.getProjectType">getProjectType</a></td> | |
| 797 <td>Public method to get the type of the project.</td> | |
| 798 </tr> | |
| 799 <tr> | |
| 800 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td> | |
| 801 <td>Public method to get the list of supported project types.</td> | |
| 802 </tr> | |
| 803 <tr> | |
| 804 <td><a href="#Project.getProjectVenv">getProjectVenv</a></td> | |
| 805 <td>Public method to get the name of the virtual environment used by the project.</td> | |
| 806 </tr> | |
| 807 <tr> | |
| 808 <td><a href="#Project.getProjectVersion">getProjectVersion</a></td> | |
| 809 <td>Public mehod to get the version number of the project.</td> | |
| 810 </tr> | |
| 811 <tr> | |
| 812 <td><a href="#Project.getRelativePath">getRelativePath</a></td> | |
| 813 <td>Public method to convert a file path to a project relative file path.</td> | |
| 814 </tr> | |
| 815 <tr> | |
| 816 <td><a href="#Project.getRelativeUniversalPath">getRelativeUniversalPath</a></td> | |
| 817 <td>Public method to convert a file path to a project relative file path with universal separators.</td> | |
| 818 </tr> | |
| 819 <tr> | |
| 820 <td><a href="#Project.getSources">getSources</a></td> | |
| 821 <td>Public method to return the source script files.</td> | |
| 822 </tr> | |
| 823 <tr> | |
| 824 <td><a href="#Project.getStatusMonitorAutoUpdate">getStatusMonitorAutoUpdate</a></td> | |
| 825 <td>Public method to retrieve the status of the auto update function.</td> | |
| 826 </tr> | |
| 827 <tr> | |
| 828 <td><a href="#Project.getStatusMonitorInterval">getStatusMonitorInterval</a></td> | |
| 829 <td>Public method to get the monitor interval.</td> | |
| 830 </tr> | |
| 831 <tr> | |
| 832 <td><a href="#Project.getTranslationPattern">getTranslationPattern</a></td> | |
| 833 <td>Public method to get the translation pattern.</td> | |
| 834 </tr> | |
| 835 <tr> | |
| 836 <td><a href="#Project.getUicParameter">getUicParameter</a></td> | |
| 837 <td>Public method to get a named uic related parameter.</td> | |
| 838 </tr> | |
| 839 <tr> | |
| 840 <td><a href="#Project.getVcs">getVcs</a></td> | |
| 841 <td>Public method to get a reference to the VCS object.</td> | |
| 842 </tr> | |
| 843 <tr> | |
| 844 <td><a href="#Project.handleApplicationDiagram">handleApplicationDiagram</a></td> | |
| 845 <td>Public method to handle the application diagram context menu action.</td> | |
| 846 </tr> | |
| 847 <tr> | |
| 848 <td><a href="#Project.handlePreferencesChanged">handlePreferencesChanged</a></td> | |
| 849 <td>Public slot used to handle the preferencesChanged signal.</td> | |
| 850 </tr> | |
| 851 <tr> | |
| 852 <td><a href="#Project.hasDefaultDocstringParameter">hasDefaultDocstringParameter</a></td> | |
| 853 <td>Public method to test, if the project contains the default docstring parameter.</td> | |
| 854 </tr> | |
| 855 <tr> | |
| 856 <td><a href="#Project.hasDefaultIdlCompilerParameters">hasDefaultIdlCompilerParameters</a></td> | |
| 857 <td>Public method to test, if the project contains the default IDL compiler parameters.</td> | |
| 858 </tr> | |
| 859 <tr> | |
| 860 <td><a href="#Project.hasDefaultMakeParameters">hasDefaultMakeParameters</a></td> | |
| 861 <td>Public method to test, if the project contains the default make parameters.</td> | |
| 862 </tr> | |
| 863 <tr> | |
| 864 <td><a href="#Project.hasDefaultRccCompilerParameters">hasDefaultRccCompilerParameters</a></td> | |
| 865 <td>Public method to test, if the project contains the default rcc compiler parameters.</td> | |
| 866 </tr> | |
| 867 <tr> | |
| 868 <td><a href="#Project.hasDefaultUicCompilerParameters">hasDefaultUicCompilerParameters</a></td> | |
| 869 <td>Public method to test, if the project contains the default uic compiler parameters.</td> | |
| 870 </tr> | |
| 871 <tr> | |
| 872 <td><a href="#Project.hasEntry">hasEntry</a></td> | |
| 873 <td>Public method to check the project for a file.</td> | |
| 874 </tr> | |
| 875 <tr> | |
| 876 <td><a href="#Project.hasProjectType">hasProjectType</a></td> | |
| 877 <td>Public method to check, if a project type is already registered.</td> | |
| 878 </tr> | |
| 879 <tr> | |
| 880 <td><a href="#Project.initActions">initActions</a></td> | |
| 881 <td>Public slot to initialize the project related actions.</td> | |
| 882 </tr> | |
| 883 <tr> | |
| 884 <td><a href="#Project.initFileTypes">initFileTypes</a></td> | |
| 885 <td>Public method to initialize the filetype associations with default values.</td> | |
| 886 </tr> | |
| 887 <tr> | |
| 888 <td><a href="#Project.initMenus">initMenus</a></td> | |
| 889 <td>Public slot to initialize the project menus.</td> | |
| 890 </tr> | |
| 891 <tr> | |
| 892 <td><a href="#Project.initToolbars">initToolbars</a></td> | |
| 893 <td>Public slot to initialize the project toolbar and the basic VCS toolbar.</td> | |
| 894 </tr> | |
| 895 <tr> | |
| 896 <td><a href="#Project.initVCS">initVCS</a></td> | |
| 897 <td>Public method used to instantiate a vcs system.</td> | |
| 898 </tr> | |
| 899 <tr> | |
| 900 <td><a href="#Project.isDebugPropertiesLoaded">isDebugPropertiesLoaded</a></td> | |
| 901 <td>Public method to return the status of the debug properties.</td> | |
| 902 </tr> | |
| 903 <tr> | |
| 904 <td><a href="#Project.isDirty">isDirty</a></td> | |
| 905 <td>Public method to return the dirty state.</td> | |
| 906 </tr> | |
| 907 <tr> | |
| 908 <td><a href="#Project.isJavaScriptProject">isJavaScriptProject</a></td> | |
| 909 <td>Public method to check, if this project is a JavaScript project.</td> | |
| 910 </tr> | |
| 911 <tr> | |
| 912 <td><a href="#Project.isMakeEnabled">isMakeEnabled</a></td> | |
| 913 <td>Public method to test, if make is enabled for the project.</td> | |
| 914 </tr> | |
| 915 <tr> | |
| 916 <td><a href="#Project.isMicroPythonProject">isMicroPythonProject</a></td> | |
| 917 <td>Public method to check, if this project is a MicroPython project.</td> | |
| 918 </tr> | |
| 919 <tr> | |
| 920 <td><a href="#Project.isMixedLanguageProject">isMixedLanguageProject</a></td> | |
| 921 <td>Public method to check, if this is a mixed language project.</td> | |
| 922 </tr> | |
| 923 <tr> | |
| 924 <td><a href="#Project.isOpen">isOpen</a></td> | |
| 925 <td>Public method to return the opened state.</td> | |
| 926 </tr> | |
| 927 <tr> | |
| 928 <td><a href="#Project.isProjectFile">isProjectFile</a></td> | |
| 929 <td>Public method used to check, if the passed in filename belongs to the project.</td> | |
| 930 </tr> | |
| 931 <tr> | |
| 932 <td><a href="#Project.isProjectForm">isProjectForm</a></td> | |
| 933 <td>Public method used to check, if the passed in filename belongs to the project forms.</td> | |
| 934 </tr> | |
| 935 <tr> | |
| 936 <td><a href="#Project.isProjectInterface">isProjectInterface</a></td> | |
| 937 <td>Public method used to check, if the passed in filename belongs to the project interfaces.</td> | |
| 938 </tr> | |
| 939 <tr> | |
| 940 <td><a href="#Project.isProjectProtocol">isProjectProtocol</a></td> | |
| 941 <td>Public method used to check, if the passed in filename belongs to the project protocols.</td> | |
| 942 </tr> | |
| 943 <tr> | |
| 944 <td><a href="#Project.isProjectResource">isProjectResource</a></td> | |
| 945 <td>Public method used to check, if the passed in filename belongs to the project resources.</td> | |
| 946 </tr> | |
| 947 <tr> | |
| 948 <td><a href="#Project.isProjectSource">isProjectSource</a></td> | |
| 949 <td>Public method used to check, if the passed in filename belongs to the project sources.</td> | |
| 950 </tr> | |
| 951 <tr> | |
| 952 <td><a href="#Project.isPy3Project">isPy3Project</a></td> | |
| 953 <td>Public method to check, if this project is a Python3 project.</td> | |
| 954 </tr> | |
| 955 <tr> | |
| 956 <td><a href="#Project.isPythonProject">isPythonProject</a></td> | |
| 957 <td>Public method to check, if this project is a Python3 or MicroPython project.</td> | |
| 958 </tr> | |
| 959 <tr> | |
| 960 <td><a href="#Project.isRubyProject">isRubyProject</a></td> | |
| 961 <td>Public method to check, if this project is a Ruby project.</td> | |
| 962 </tr> | |
| 963 <tr> | |
| 964 <td><a href="#Project.moveDirectory">moveDirectory</a></td> | |
| 965 <td>Public slot to move a directory.</td> | |
| 966 </tr> | |
| 967 <tr> | |
| 968 <td><a href="#Project.newProjectAddFiles">newProjectAddFiles</a></td> | |
| 969 <td>Public method to add files to a new project.</td> | |
| 970 </tr> | |
| 971 <tr> | |
| 972 <td><a href="#Project.openProject">openProject</a></td> | |
| 973 <td>Public slot to open a project.</td> | |
| 974 </tr> | |
| 975 <tr> | |
| 976 <td><a href="#Project.othersAdded">othersAdded</a></td> | |
| 977 <td>Public slot to be called, if something was added to the OTHERS project data area.</td> | |
| 978 </tr> | |
| 979 <tr> | |
| 980 <td><a href="#Project.registerProjectType">registerProjectType</a></td> | |
| 981 <td>Public method to register a project type.</td> | |
| 982 </tr> | |
| 983 <tr> | |
| 984 <td><a href="#Project.removeDirectory">removeDirectory</a></td> | |
| 985 <td>Public method to remove a directory from the project.</td> | |
| 986 </tr> | |
| 987 <tr> | |
| 988 <td><a href="#Project.removeEricActions">removeEricActions</a></td> | |
| 989 <td>Public method to remove actions from the list of actions.</td> | |
| 990 </tr> | |
| 991 <tr> | |
| 992 <td><a href="#Project.removeFile">removeFile</a></td> | |
| 993 <td>Public slot to remove a file from the project.</td> | |
| 994 </tr> | |
| 995 <tr> | |
| 996 <td><a href="#Project.removeLanguageFile">removeLanguageFile</a></td> | |
| 997 <td>Public slot to remove a translation from the project.</td> | |
| 998 </tr> | |
| 999 <tr> | |
| 1000 <td><a href="#Project.renameFile">renameFile</a></td> | |
| 1001 <td>Public slot to rename a file of the project.</td> | |
| 1002 </tr> | |
| 1003 <tr> | |
| 1004 <td><a href="#Project.renameFileInPdata">renameFileInPdata</a></td> | |
| 1005 <td>Public method to rename a file in the pdata structure.</td> | |
| 1006 </tr> | |
| 1007 <tr> | |
| 1008 <td><a href="#Project.renameMainScript">renameMainScript</a></td> | |
| 1009 <td>Public method to rename the main script.</td> | |
| 1010 </tr> | |
| 1011 <tr> | |
| 1012 <td><a href="#Project.reopenProject">reopenProject</a></td> | |
| 1013 <td>Public slot to reopen the current project.</td> | |
| 1014 </tr> | |
| 1015 <tr> | |
| 1016 <td><a href="#Project.repopulateItem">repopulateItem</a></td> | |
| 1017 <td>Public slot to repopulate a named item.</td> | |
| 1018 </tr> | |
| 1019 <tr> | |
| 1020 <td><a href="#Project.resetVCS">resetVCS</a></td> | |
| 1021 <td>Public method to reset the VCS.</td> | |
| 1022 </tr> | |
| 1023 <tr> | |
| 1024 <td><a href="#Project.saveAllScripts">saveAllScripts</a></td> | |
| 1025 <td>Public method to save all scripts belonging to the project.</td> | |
| 1026 </tr> | |
| 1027 <tr> | |
| 1028 <td><a href="#Project.saveProject">saveProject</a></td> | |
| 1029 <td>Public slot to save the current project.</td> | |
| 1030 </tr> | |
| 1031 <tr> | |
| 1032 <td><a href="#Project.saveProjectAs">saveProjectAs</a></td> | |
| 1033 <td>Public slot to save the current project to a different file.</td> | |
| 1034 </tr> | |
| 1035 <tr> | |
| 1036 <td><a href="#Project.setData">setData</a></td> | |
| 1037 <td>Public method to store data in the project data store.</td> | |
| 1038 </tr> | |
| 1039 <tr> | |
| 1040 <td><a href="#Project.setDbgInfo">setDbgInfo</a></td> | |
| 1041 <td>Public method to set the debugging information.</td> | |
| 1042 </tr> | |
| 1043 <tr> | |
| 1044 <td><a href="#Project.setDirty">setDirty</a></td> | |
| 1045 <td>Public method to set the dirty state.</td> | |
| 1046 </tr> | |
| 1047 <tr> | |
| 1048 <td><a href="#Project.setStatusMonitorAutoUpdate">setStatusMonitorAutoUpdate</a></td> | |
| 1049 <td>Public method to enable the auto update function.</td> | |
| 1050 </tr> | |
| 1051 <tr> | |
| 1052 <td><a href="#Project.setStatusMonitorInterval">setStatusMonitorInterval</a></td> | |
| 1053 <td>Public method to se the interval of the VCS status monitor thread.</td> | |
| 1054 </tr> | |
| 1055 <tr> | |
| 1056 <td><a href="#Project.setTranslationPattern">setTranslationPattern</a></td> | |
| 1057 <td>Public method to set the translation pattern.</td> | |
| 1058 </tr> | |
| 1059 <tr> | |
| 1060 <td><a href="#Project.startFileSystemMonitoring">startFileSystemMonitoring</a></td> | |
| 1061 <td>Public method to (re)start monitoring the project file system.</td> | |
| 1062 </tr> | |
| 1063 <tr> | |
| 1064 <td><a href="#Project.startStatusMonitor">startStatusMonitor</a></td> | |
| 1065 <td>Public method to start the VCS status monitor thread.</td> | |
| 1066 </tr> | |
| 1067 <tr> | |
| 1068 <td><a href="#Project.startswithProjectPath">startswithProjectPath</a></td> | |
| 1069 <td>Public method to check, if a path starts with the project path.</td> | |
| 1070 </tr> | |
| 1071 <tr> | |
| 1072 <td><a href="#Project.stopFileSystemMonitoring">stopFileSystemMonitoring</a></td> | |
| 1073 <td>Public method to stop monitoring the project file system.</td> | |
| 1074 </tr> | |
| 1075 <tr> | |
| 1076 <td><a href="#Project.stopStatusMonitor">stopStatusMonitor</a></td> | |
| 1077 <td>Public method to stop the VCS status monitor thread.</td> | |
| 1078 </tr> | |
| 1079 <tr> | |
| 1080 <td><a href="#Project.unregisterProjectType">unregisterProjectType</a></td> | |
| 1081 <td>Public method to unregister a project type.</td> | |
| 1082 </tr> | |
| 1083 <tr> | |
| 1084 <td><a href="#Project.updateFileTypes">updateFileTypes</a></td> | |
| 1085 <td>Public method to update the filetype associations with new default values.</td> | |
| 1086 </tr> | |
| 1087 <tr> | |
| 1088 <td><a href="#Project.useSystemEol">useSystemEol</a></td> | |
| 1089 <td>Public method to check, if the project uses the system eol setting.</td> | |
| 1090 </tr> | |
| 1091 <tr> | |
| 1092 <td><a href="#Project.vcsSoftwareAvailable">vcsSoftwareAvailable</a></td> | |
| 1093 <td>Public method to check, if some supported VCS software is available to the IDE.</td> | |
| 1094 </tr> | |
| 1095 <tr> | |
| 1096 <td><a href="#Project.writeTasks">writeTasks</a></td> | |
| 1097 <td>Public method to write the tasks data to a JSON file (.etj).</td> | |
| 1098 </tr> | |
| 1099 </table> | |
| 1100 <h3>Static Methods</h3> | |
| 1101 | |
| 1102 <table> | |
| 1103 <tr><td>None</td></tr> | |
| 1104 </table> | |
| 1105 | |
| 1106 <a NAME="Project.__init__" ID="Project.__init__"></a> | |
| 1107 <h4>Project (Constructor)</h4> | |
| 1108 <b>Project</b>(<i>parent=None, filename=None</i>) | |
| 1109 | |
| 1110 <p> | |
| 1111 Constructor | |
| 1112 </p> | |
| 1113 <dl> | |
| 1114 | |
| 1115 <dt><i>parent</i></dt> | |
| 1116 <dd> | |
| 1117 parent widget (usually the ui object) (QWidget) | |
| 1118 </dd> | |
| 1119 <dt><i>filename</i></dt> | |
| 1120 <dd> | |
| 1121 optional filename of a project file to open (string) | |
| 1122 </dd> | |
| 1123 </dl> | |
| 1124 <a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a> | |
| 1125 <h4>Project.__addRecursiveDirectory</h4> | |
| 1126 <b>__addRecursiveDirectory</b>(<i>filetype, source, target</i>) | |
| 1127 | |
| 1128 <p> | |
| 1129 Private method used to add all files of a directory tree. | |
| 1130 </p> | |
| 1131 <p> | |
| 1132 The tree is rooted at source to another one rooted at target. This | |
| 1133 method decents down to the lowest subdirectory. | |
| 1134 </p> | |
| 1135 <dl> | |
| 1136 | |
| 1137 <dt><i>filetype</i></dt> | |
| 1138 <dd> | |
| 1139 type of files to add (string) | |
| 1140 </dd> | |
| 1141 <dt><i>source</i></dt> | |
| 1142 <dd> | |
| 1143 source directory (string) | |
| 1144 </dd> | |
| 1145 <dt><i>target</i></dt> | |
| 1146 <dd> | |
| 1147 target directory (string) | |
| 1148 </dd> | |
| 1149 </dl> | |
| 1150 <a NAME="Project.__addSingleDirectory" ID="Project.__addSingleDirectory"></a> | |
| 1151 <h4>Project.__addSingleDirectory</h4> | |
| 1152 <b>__addSingleDirectory</b>(<i>filetype, source, target, quiet=False</i>) | |
| 1153 | |
| 1154 <p> | |
| 1155 Private method used to add all files of a single directory to the | |
| 1156 project. | |
| 1157 </p> | |
| 1158 <dl> | |
| 1159 | |
| 1160 <dt><i>filetype</i></dt> | |
| 1161 <dd> | |
| 1162 type of files to add (string) | |
| 1163 </dd> | |
| 1164 <dt><i>source</i></dt> | |
| 1165 <dd> | |
| 1166 source directory (string) | |
| 1167 </dd> | |
| 1168 <dt><i>target</i></dt> | |
| 1169 <dd> | |
| 1170 target directory (string) | |
| 1171 </dd> | |
| 1172 <dt><i>quiet</i></dt> | |
| 1173 <dd> | |
| 1174 flag indicating quiet operations (boolean) | |
| 1175 </dd> | |
| 1176 </dl> | |
| 1177 <a NAME="Project.__binaryTranslationFile" ID="Project.__binaryTranslationFile"></a> | |
| 1178 <h4>Project.__binaryTranslationFile</h4> | |
| 1179 <b>__binaryTranslationFile</b>(<i>langFile</i>) | |
| 1180 | |
| 1181 <p> | |
| 1182 Private method to calculate the filename of the binary translations | |
| 1183 file given the name of the raw translations file. | |
| 1184 </p> | |
| 1185 <dl> | |
| 1186 | |
| 1187 <dt><i>langFile</i></dt> | |
| 1188 <dd> | |
| 1189 name of the raw translations file (string) | |
| 1190 </dd> | |
| 1191 </dl> | |
| 1192 <dl> | |
| 1193 <dt>Return:</dt> | |
| 1194 <dd> | |
| 1195 name of the binary translations file (string) | |
| 1196 </dd> | |
| 1197 </dl> | |
| 1198 <a NAME="Project.__checkFilesExist" ID="Project.__checkFilesExist"></a> | |
| 1199 <h4>Project.__checkFilesExist</h4> | |
| 1200 <b>__checkFilesExist</b>(<i>index</i>) | |
| 1201 | |
| 1202 <p> | |
| 1203 Private method to check, if the files in a list exist. | |
| 1204 </p> | |
| 1205 <p> | |
| 1206 The files in the indicated list are checked for existance in the | |
| 1207 filesystem. Non existant files are removed from the list and the | |
| 1208 dirty state of the project is changed accordingly. | |
| 1209 </p> | |
| 1210 <dl> | |
| 1211 | |
| 1212 <dt><i>index</i></dt> | |
| 1213 <dd> | |
| 1214 key of the list to be checked (string) | |
| 1215 </dd> | |
| 1216 </dl> | |
| 1217 <a NAME="Project.__checkProjectFileGroup" ID="Project.__checkProjectFileGroup"></a> | |
| 1218 <h4>Project.__checkProjectFileGroup</h4> | |
| 1219 <b>__checkProjectFileGroup</b>(<i>fn, group</i>) | |
| 1220 | |
| 1221 <p> | |
| 1222 Private method to check, if a file is in a specific file group of the | |
| 1223 project. | |
| 1224 </p> | |
| 1225 <dl> | |
| 1226 | |
| 1227 <dt><i>fn</i></dt> | |
| 1228 <dd> | |
| 1229 filename to be checked (string) | |
| 1230 </dd> | |
| 1231 <dt><i>group</i></dt> | |
| 1232 <dd> | |
| 1233 group to check (string) | |
| 1234 </dd> | |
| 1235 </dl> | |
| 1236 <dl> | |
| 1237 <dt>Return:</dt> | |
| 1238 <dd> | |
| 1239 flag indicating membership (boolean) | |
| 1240 </dd> | |
| 1241 </dl> | |
| 1242 <a NAME="Project.__cleanupMake" ID="Project.__cleanupMake"></a> | |
| 1243 <h4>Project.__cleanupMake</h4> | |
| 1244 <b>__cleanupMake</b>(<i></i>) | |
| 1245 | |
| 1246 <p> | |
| 1247 Private method to clean up make related stuff. | |
| 1248 </p> | |
| 1249 <a NAME="Project.__closeAllWindows" ID="Project.__closeAllWindows"></a> | |
| 1250 <h4>Project.__closeAllWindows</h4> | |
| 1251 <b>__closeAllWindows</b>(<i></i>) | |
| 1252 | |
| 1253 <p> | |
| 1254 Private method to close all project related windows. | |
| 1255 </p> | |
| 1256 <a NAME="Project.__createSBOMFile" ID="Project.__createSBOMFile"></a> | |
| 1257 <h4>Project.__createSBOMFile</h4> | |
| 1258 <b>__createSBOMFile</b>(<i></i>) | |
| 1259 | |
| 1260 <p> | |
| 1261 Private slot to create a SBOM file of the project dependencies. | |
| 1262 </p> | |
| 1263 <a NAME="Project.__createSnapshotSource" ID="Project.__createSnapshotSource"></a> | |
| 1264 <h4>Project.__createSnapshotSource</h4> | |
| 1265 <b>__createSnapshotSource</b>(<i>filename</i>) | |
| 1266 | |
| 1267 <p> | |
| 1268 Private method to create a snapshot plugin version. | |
| 1269 </p> | |
| 1270 <p> | |
| 1271 The version entry in the plugin module is modified to signify | |
| 1272 a snapshot version. This method appends the string "-snapshot-" | |
| 1273 and date indicator to the version string. | |
| 1274 </p> | |
| 1275 <dl> | |
| 1276 | |
| 1277 <dt><i>filename</i></dt> | |
| 1278 <dd> | |
| 1279 name of the plugin file to modify (string) | |
| 1280 </dd> | |
| 1281 </dl> | |
| 1282 <dl> | |
| 1283 <dt>Return:</dt> | |
| 1284 <dd> | |
| 1285 modified source (bytes), snapshot version string (string) | |
| 1286 </dd> | |
| 1287 </dl> | |
| 1288 <a NAME="Project.__createZipDirEntries" ID="Project.__createZipDirEntries"></a> | |
| 1289 <h4>Project.__createZipDirEntries</h4> | |
| 1290 <b>__createZipDirEntries</b>(<i>path, zipFile</i>) | |
| 1291 | |
| 1292 <p> | |
| 1293 Private method to create dir entries in the zip file. | |
| 1294 </p> | |
| 1295 <dl> | |
| 1296 | |
| 1297 <dt><i>path</i></dt> | |
| 1298 <dd> | |
| 1299 name of the directory entry to create (string) | |
| 1300 </dd> | |
| 1301 <dt><i>zipFile</i></dt> | |
| 1302 <dd> | |
| 1303 open ZipFile object (zipfile.ZipFile) | |
| 1304 </dd> | |
| 1305 </dl> | |
| 1306 <a NAME="Project.__deleteDebugProperties" ID="Project.__deleteDebugProperties"></a> | |
| 1307 <h4>Project.__deleteDebugProperties</h4> | |
| 1308 <b>__deleteDebugProperties</b>(<i></i>) | |
| 1309 | |
| 1310 <p> | |
| 1311 Private method to delete the project debugger properties file | |
| 1312 (.edj or .e4d). | |
| 1313 </p> | |
| 1314 <a NAME="Project.__deleteSession" ID="Project.__deleteSession"></a> | |
| 1315 <h4>Project.__deleteSession</h4> | |
| 1316 <b>__deleteSession</b>(<i></i>) | |
| 1317 | |
| 1318 <p> | |
| 1319 Private method to delete the session file. | |
| 1320 </p> | |
| 1321 <a NAME="Project.__doSearchNewFiles" ID="Project.__doSearchNewFiles"></a> | |
| 1322 <h4>Project.__doSearchNewFiles</h4> | |
| 1323 <b>__doSearchNewFiles</b>(<i>AI=True, onUserDemand=False</i>) | |
| 1324 | |
| 1325 <p> | |
| 1326 Private method to search for new files in the project directory. | |
| 1327 </p> | |
| 1328 <p> | |
| 1329 If new files were found, it shows a dialog listing these files and | |
| 1330 gives the user the opportunity to select the ones he wants to | |
| 1331 include. If 'Automatic Inclusion' is enabled, the new files are | |
| 1332 automatically added to the project. | |
| 1333 </p> | |
| 1334 <dl> | |
| 1335 | |
| 1336 <dt><i>AI</i></dt> | |
| 1337 <dd> | |
| 1338 flag indicating whether the automatic inclusion should | |
| 1339 be honoured (boolean) | |
| 1340 </dd> | |
| 1341 <dt><i>onUserDemand</i></dt> | |
| 1342 <dd> | |
| 1343 flag indicating whether this method was | |
| 1344 requested by the user via a menu action (boolean) | |
| 1345 </dd> | |
| 1346 </dl> | |
| 1347 <a NAME="Project.__executeMake" ID="Project.__executeMake"></a> | |
| 1348 <h4>Project.__executeMake</h4> | |
| 1349 <b>__executeMake</b>(<i>questionOnly=False, interactive=True</i>) | |
| 1350 | |
| 1351 <p> | |
| 1352 Private method to execute a project specific make run. | |
| 1353 </p> | |
| 1354 <dl> | |
| 1355 | |
| 1356 <dt><i>questionOnly</i> (bool)</dt> | |
| 1357 <dd> | |
| 1358 flag indicating to ask make for changes only | |
| 1359 </dd> | |
| 1360 <dt><i>interactive</i> (bool)</dt> | |
| 1361 <dd> | |
| 1362 flag indicating an interactive invocation (i.e. | |
| 1363 through a menu action) | |
| 1364 </dd> | |
| 1365 </dl> | |
| 1366 <a NAME="Project.__initData" ID="Project.__initData"></a> | |
| 1367 <h4>Project.__initData</h4> | |
| 1368 <b>__initData</b>(<i></i>) | |
| 1369 | |
| 1370 <p> | |
| 1371 Private method to initialize the project data part. | |
| 1372 </p> | |
| 1373 <a NAME="Project.__initDebugProperties" ID="Project.__initDebugProperties"></a> | |
| 1374 <h4>Project.__initDebugProperties</h4> | |
| 1375 <b>__initDebugProperties</b>(<i></i>) | |
| 1376 | |
| 1377 <p> | |
| 1378 Private method to initialize the debug properties. | |
| 1379 </p> | |
| 1380 <a NAME="Project.__initProjectTypes" ID="Project.__initProjectTypes"></a> | |
| 1381 <h4>Project.__initProjectTypes</h4> | |
| 1382 <b>__initProjectTypes</b>(<i></i>) | |
| 1383 | |
| 1384 <p> | |
| 1385 Private method to initialize the list of supported project types. | |
| 1386 </p> | |
| 1387 <a NAME="Project.__isInPdata" ID="Project.__isInPdata"></a> | |
| 1388 <h4>Project.__isInPdata</h4> | |
| 1389 <b>__isInPdata</b>(<i>fn</i>) | |
| 1390 | |
| 1391 <p> | |
| 1392 Private method used to check, if the passed in filename is project | |
| 1393 controlled.. | |
| 1394 </p> | |
| 1395 <dl> | |
| 1396 | |
| 1397 <dt><i>fn</i> (str)</dt> | |
| 1398 <dd> | |
| 1399 filename to be checked | |
| 1400 </dd> | |
| 1401 </dl> | |
| 1402 <dl> | |
| 1403 <dt>Return:</dt> | |
| 1404 <dd> | |
| 1405 flag indicating membership | |
| 1406 </dd> | |
| 1407 </dl> | |
| 1408 <dl> | |
| 1409 <dt>Return Type:</dt> | |
| 1410 <dd> | |
| 1411 bool | |
| 1412 </dd> | |
| 1413 </dl> | |
| 1414 <a NAME="Project.__loadDiagram" ID="Project.__loadDiagram"></a> | |
| 1415 <h4>Project.__loadDiagram</h4> | |
| 1416 <b>__loadDiagram</b>(<i></i>) | |
| 1417 | |
| 1418 <p> | |
| 1419 Private slot to load a diagram from file. | |
| 1420 </p> | |
| 1421 <a NAME="Project.__loadRecent" ID="Project.__loadRecent"></a> | |
| 1422 <h4>Project.__loadRecent</h4> | |
| 1423 <b>__loadRecent</b>(<i></i>) | |
| 1424 | |
| 1425 <p> | |
| 1426 Private method to load the recently opened project filenames. | |
| 1427 </p> | |
| 1428 <a NAME="Project.__makeFinished" ID="Project.__makeFinished"></a> | |
| 1429 <h4>Project.__makeFinished</h4> | |
| 1430 <b>__makeFinished</b>(<i>exitCode, exitStatus, questionOnly, interactive=True</i>) | |
| 1431 | |
| 1432 <p> | |
| 1433 Private slot handling the make process finished signal. | |
| 1434 </p> | |
| 1435 <dl> | |
| 1436 | |
| 1437 <dt><i>exitCode</i> (int)</dt> | |
| 1438 <dd> | |
| 1439 exit code of the make process | |
| 1440 </dd> | |
| 1441 <dt><i>exitStatus</i> (QProcess.ExitStatus)</dt> | |
| 1442 <dd> | |
| 1443 exit status of the make process | |
| 1444 </dd> | |
| 1445 <dt><i>questionOnly</i> (bool)</dt> | |
| 1446 <dd> | |
| 1447 flag indicating a test only run | |
| 1448 </dd> | |
| 1449 <dt><i>interactive</i> (bool)</dt> | |
| 1450 <dd> | |
| 1451 flag indicating an interactive invocation (i.e. | |
| 1452 through a menu action) | |
| 1453 </dd> | |
| 1454 </dl> | |
| 1455 <a NAME="Project.__makeReadStdErr" ID="Project.__makeReadStdErr"></a> | |
| 1456 <h4>Project.__makeReadStdErr</h4> | |
| 1457 <b>__makeReadStdErr</b>(<i></i>) | |
| 1458 | |
| 1459 <p> | |
| 1460 Private slot to process process output received via stderr. | |
| 1461 </p> | |
| 1462 <a NAME="Project.__makeReadStdOut" ID="Project.__makeReadStdOut"></a> | |
| 1463 <h4>Project.__makeReadStdOut</h4> | |
| 1464 <b>__makeReadStdOut</b>(<i></i>) | |
| 1465 | |
| 1466 <p> | |
| 1467 Private slot to process process output received via stdout. | |
| 1468 </p> | |
| 1469 <a NAME="Project.__openRecent" ID="Project.__openRecent"></a> | |
| 1470 <h4>Project.__openRecent</h4> | |
| 1471 <b>__openRecent</b>(<i>act</i>) | |
| 1472 | |
| 1473 <p> | |
| 1474 Private method to open a project from the list of rencently opened | |
| 1475 projects. | |
| 1476 </p> | |
| 1477 <dl> | |
| 1478 | |
| 1479 <dt><i>act</i></dt> | |
| 1480 <dd> | |
| 1481 reference to the action that triggered (QAction) | |
| 1482 </dd> | |
| 1483 </dl> | |
| 1484 <a NAME="Project.__pluginCreateArchives" ID="Project.__pluginCreateArchives"></a> | |
| 1485 <h4>Project.__pluginCreateArchives</h4> | |
| 1486 <b>__pluginCreateArchives</b>(<i>snapshot=False</i>) | |
| 1487 | |
| 1488 <p> | |
| 1489 Private slot to create eric plugin archives. | |
| 1490 </p> | |
| 1491 <dl> | |
| 1492 | |
| 1493 <dt><i>snapshot</i></dt> | |
| 1494 <dd> | |
| 1495 flag indicating snapshot archives (boolean) | |
| 1496 </dd> | |
| 1497 </dl> | |
| 1498 <a NAME="Project.__pluginCreatePkgList" ID="Project.__pluginCreatePkgList"></a> | |
| 1499 <h4>Project.__pluginCreatePkgList</h4> | |
| 1500 <b>__pluginCreatePkgList</b>(<i></i>) | |
| 1501 | |
| 1502 <p> | |
| 1503 Private slot to create a PKGLIST file needed for archive file creation. | |
| 1504 </p> | |
| 1505 <a NAME="Project.__pluginCreateSnapshotArchives" ID="Project.__pluginCreateSnapshotArchives"></a> | |
| 1506 <h4>Project.__pluginCreateSnapshotArchives</h4> | |
| 1507 <b>__pluginCreateSnapshotArchives</b>(<i></i>) | |
| 1508 | |
| 1509 <p> | |
| 1510 Private slot to create eric plugin archive snapshot releases. | |
| 1511 </p> | |
| 1512 <a NAME="Project.__pluginExtractVersion" ID="Project.__pluginExtractVersion"></a> | |
| 1513 <h4>Project.__pluginExtractVersion</h4> | |
| 1514 <b>__pluginExtractVersion</b>(<i>filename</i>) | |
| 1515 | |
| 1516 <p> | |
| 1517 Private method to extract the version number entry. | |
| 1518 </p> | |
| 1519 <dl> | |
| 1520 | |
| 1521 <dt><i>filename</i></dt> | |
| 1522 <dd> | |
| 1523 name of the plugin file (string) | |
| 1524 </dd> | |
| 1525 </dl> | |
| 1526 <dl> | |
| 1527 <dt>Return:</dt> | |
| 1528 <dd> | |
| 1529 version string (string) | |
| 1530 </dd> | |
| 1531 </dl> | |
| 1532 <a NAME="Project.__pluginVersionToTuple" ID="Project.__pluginVersionToTuple"></a> | |
| 1533 <h4>Project.__pluginVersionToTuple</h4> | |
| 1534 <b>__pluginVersionToTuple</b>(<i>versionStr</i>) | |
| 1535 | |
| 1536 <p> | |
| 1537 Private method to convert a plug-in version string into a version | |
| 1538 tuple. | |
| 1539 </p> | |
| 1540 <dl> | |
| 1541 | |
| 1542 <dt><i>versionStr</i> (str)</dt> | |
| 1543 <dd> | |
| 1544 version string to be converted | |
| 1545 </dd> | |
| 1546 </dl> | |
| 1547 <dl> | |
| 1548 <dt>Return:</dt> | |
| 1549 <dd> | |
| 1550 version info as a tuple | |
| 1551 </dd> | |
| 1552 </dl> | |
| 1553 <dl> | |
| 1554 <dt>Return Type:</dt> | |
| 1555 <dd> | |
| 1556 tuple of int and str | |
| 1557 </dd> | |
| 1558 </dl> | |
| 1559 <a NAME="Project.__readDebugProperties" ID="Project.__readDebugProperties"></a> | |
| 1560 <h4>Project.__readDebugProperties</h4> | |
| 1561 <b>__readDebugProperties</b>(<i>quiet=False</i>) | |
| 1562 | |
| 1563 <p> | |
| 1564 Private method to read in the project debugger properties file | |
| 1565 (.edj or .e4d). | |
| 1566 </p> | |
| 1567 <dl> | |
| 1568 | |
| 1569 <dt><i>quiet</i></dt> | |
| 1570 <dd> | |
| 1571 flag indicating quiet operations. | |
| 1572 If this flag is true, no errors are reported. | |
| 1573 </dd> | |
| 1574 </dl> | |
| 1575 <a NAME="Project.__readProject" ID="Project.__readProject"></a> | |
| 1576 <h4>Project.__readProject</h4> | |
| 1577 <b>__readProject</b>(<i>fn</i>) | |
| 1578 | |
| 1579 <p> | |
| 1580 Private method to read in a project (.epj or .e4p) file. | |
| 1581 </p> | |
| 1582 <dl> | |
| 1583 | |
| 1584 <dt><i>fn</i></dt> | |
| 1585 <dd> | |
| 1586 filename of the project file to be read (string) | |
| 1587 </dd> | |
| 1588 </dl> | |
| 1589 <dl> | |
| 1590 <dt>Return:</dt> | |
| 1591 <dd> | |
| 1592 flag indicating success | |
| 1593 </dd> | |
| 1594 </dl> | |
| 1595 <a NAME="Project.__readSession" ID="Project.__readSession"></a> | |
| 1596 <h4>Project.__readSession</h4> | |
| 1597 <b>__readSession</b>(<i>quiet=False, indicator=""</i>) | |
| 1598 | |
| 1599 <p> | |
| 1600 Private method to read in the project session file (.esj or .e5s). | |
| 1601 </p> | |
| 1602 <dl> | |
| 1603 | |
| 1604 <dt><i>quiet</i></dt> | |
| 1605 <dd> | |
| 1606 flag indicating quiet operations. | |
| 1607 If this flag is true, no errors are reported. | |
| 1608 </dd> | |
| 1609 <dt><i>indicator</i></dt> | |
| 1610 <dd> | |
| 1611 indicator string (string) | |
| 1612 </dd> | |
| 1613 </dl> | |
| 1614 <a NAME="Project.__readTasks" ID="Project.__readTasks"></a> | |
| 1615 <h4>Project.__readTasks</h4> | |
| 1616 <b>__readTasks</b>(<i></i>) | |
| 1617 | |
| 1618 <p> | |
| 1619 Private method to read in the project tasks file (.etj or .e6t). | |
| 1620 </p> | |
| 1621 <a NAME="Project.__readUserProperties" ID="Project.__readUserProperties"></a> | |
| 1622 <h4>Project.__readUserProperties</h4> | |
| 1623 <b>__readUserProperties</b>(<i></i>) | |
| 1624 | |
| 1625 <p> | |
| 1626 Private method to read in the user specific project file (.eqj or | |
| 1627 .e4q). | |
| 1628 </p> | |
| 1629 <a NAME="Project.__reorganizeFiles" ID="Project.__reorganizeFiles"></a> | |
| 1630 <h4>Project.__reorganizeFiles</h4> | |
| 1631 <b>__reorganizeFiles</b>(<i></i>) | |
| 1632 | |
| 1633 <p> | |
| 1634 Private method to reorganize files stored in the project. | |
| 1635 </p> | |
| 1636 <a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a> | |
| 1637 <h4>Project.__saveRecent</h4> | |
| 1638 <b>__saveRecent</b>(<i></i>) | |
| 1639 | |
| 1640 <p> | |
| 1641 Private method to save the list of recently opened filenames. | |
| 1642 </p> | |
| 1643 <a NAME="Project.__searchNewFiles" ID="Project.__searchNewFiles"></a> | |
| 1644 <h4>Project.__searchNewFiles</h4> | |
| 1645 <b>__searchNewFiles</b>(<i></i>) | |
| 1646 | |
| 1647 <p> | |
| 1648 Private slot used to handle the search new files action. | |
| 1649 </p> | |
| 1650 <a NAME="Project.__searchProjectFile" ID="Project.__searchProjectFile"></a> | |
| 1651 <h4>Project.__searchProjectFile</h4> | |
| 1652 <b>__searchProjectFile</b>(<i></i>) | |
| 1653 | |
| 1654 <p> | |
| 1655 Private slot to show the Find Project File dialog. | |
| 1656 </p> | |
| 1657 <a NAME="Project.__showCodeCoverage" ID="Project.__showCodeCoverage"></a> | |
| 1658 <h4>Project.__showCodeCoverage</h4> | |
| 1659 <b>__showCodeCoverage</b>(<i></i>) | |
| 1660 | |
| 1661 <p> | |
| 1662 Private slot used to show the code coverage information for the | |
| 1663 project files. | |
| 1664 </p> | |
| 1665 <a NAME="Project.__showCodeMetrics" ID="Project.__showCodeMetrics"></a> | |
| 1666 <h4>Project.__showCodeMetrics</h4> | |
| 1667 <b>__showCodeMetrics</b>(<i></i>) | |
| 1668 | |
| 1669 <p> | |
| 1670 Private slot used to calculate some code metrics for the project files. | |
| 1671 </p> | |
| 1672 <a NAME="Project.__showContextMenuApiDoc" ID="Project.__showContextMenuApiDoc"></a> | |
| 1673 <h4>Project.__showContextMenuApiDoc</h4> | |
| 1674 <b>__showContextMenuApiDoc</b>(<i></i>) | |
| 1675 | |
| 1676 <p> | |
| 1677 Private slot called before the apidoc menu is shown. | |
| 1678 </p> | |
| 1679 <a NAME="Project.__showContextMenuChecks" ID="Project.__showContextMenuChecks"></a> | |
| 1680 <h4>Project.__showContextMenuChecks</h4> | |
| 1681 <b>__showContextMenuChecks</b>(<i></i>) | |
| 1682 | |
| 1683 <p> | |
| 1684 Private slot called before the checks menu is shown. | |
| 1685 </p> | |
| 1686 <a NAME="Project.__showContextMenuDebugger" ID="Project.__showContextMenuDebugger"></a> | |
| 1687 <h4>Project.__showContextMenuDebugger</h4> | |
| 1688 <b>__showContextMenuDebugger</b>(<i></i>) | |
| 1689 | |
| 1690 <p> | |
| 1691 Private slot called before the Debugger menu is shown. | |
| 1692 </p> | |
| 1693 <a NAME="Project.__showContextMenuGraphics" ID="Project.__showContextMenuGraphics"></a> | |
| 1694 <h4>Project.__showContextMenuGraphics</h4> | |
| 1695 <b>__showContextMenuGraphics</b>(<i></i>) | |
| 1696 | |
| 1697 <p> | |
| 1698 Private slot called before the graphics menu is shown. | |
| 1699 </p> | |
| 1700 <a NAME="Project.__showContextMenuMake" ID="Project.__showContextMenuMake"></a> | |
| 1701 <h4>Project.__showContextMenuMake</h4> | |
| 1702 <b>__showContextMenuMake</b>(<i></i>) | |
| 1703 | |
| 1704 <p> | |
| 1705 Private slot called before the make menu is shown. | |
| 1706 </p> | |
| 1707 <a NAME="Project.__showContextMenuOthers" ID="Project.__showContextMenuOthers"></a> | |
| 1708 <h4>Project.__showContextMenuOthers</h4> | |
| 1709 <b>__showContextMenuOthers</b>(<i></i>) | |
| 1710 | |
| 1711 <p> | |
| 1712 Private slot called before the 'Other Tools' menu is shown. | |
| 1713 </p> | |
| 1714 <a NAME="Project.__showContextMenuPackagers" ID="Project.__showContextMenuPackagers"></a> | |
| 1715 <h4>Project.__showContextMenuPackagers</h4> | |
| 1716 <b>__showContextMenuPackagers</b>(<i></i>) | |
| 1717 | |
| 1718 <p> | |
| 1719 Private slot called before the packagers menu is shown. | |
| 1720 </p> | |
| 1721 <a NAME="Project.__showContextMenuRecent" ID="Project.__showContextMenuRecent"></a> | |
| 1722 <h4>Project.__showContextMenuRecent</h4> | |
| 1723 <b>__showContextMenuRecent</b>(<i></i>) | |
| 1724 | |
| 1725 <p> | |
| 1726 Private method to set up the recent projects menu. | |
| 1727 </p> | |
| 1728 <a NAME="Project.__showContextMenuSession" ID="Project.__showContextMenuSession"></a> | |
| 1729 <h4>Project.__showContextMenuSession</h4> | |
| 1730 <b>__showContextMenuSession</b>(<i></i>) | |
| 1731 | |
| 1732 <p> | |
| 1733 Private slot called before the Session menu is shown. | |
| 1734 </p> | |
| 1735 <a NAME="Project.__showContextMenuShow" ID="Project.__showContextMenuShow"></a> | |
| 1736 <h4>Project.__showContextMenuShow</h4> | |
| 1737 <b>__showContextMenuShow</b>(<i></i>) | |
| 1738 | |
| 1739 <p> | |
| 1740 Private slot called before the show menu is shown. | |
| 1741 </p> | |
| 1742 <a NAME="Project.__showContextMenuVCS" ID="Project.__showContextMenuVCS"></a> | |
| 1743 <h4>Project.__showContextMenuVCS</h4> | |
| 1744 <b>__showContextMenuVCS</b>(<i></i>) | |
| 1745 | |
| 1746 <p> | |
| 1747 Private slot called before the vcs menu is shown. | |
| 1748 </p> | |
| 1749 <a NAME="Project.__showDebugProperties" ID="Project.__showDebugProperties"></a> | |
| 1750 <h4>Project.__showDebugProperties</h4> | |
| 1751 <b>__showDebugProperties</b>(<i></i>) | |
| 1752 | |
| 1753 <p> | |
| 1754 Private slot to display the debugger properties dialog. | |
| 1755 </p> | |
| 1756 <a NAME="Project.__showFiletypeAssociations" ID="Project.__showFiletypeAssociations"></a> | |
| 1757 <h4>Project.__showFiletypeAssociations</h4> | |
| 1758 <b>__showFiletypeAssociations</b>(<i></i>) | |
| 1759 | |
| 1760 <p> | |
| 1761 Private slot to display the filetype association dialog. | |
| 1762 </p> | |
| 1763 <a NAME="Project.__showLexerAssociations" ID="Project.__showLexerAssociations"></a> | |
| 1764 <h4>Project.__showLexerAssociations</h4> | |
| 1765 <b>__showLexerAssociations</b>(<i></i>) | |
| 1766 | |
| 1767 <p> | |
| 1768 Private slot to display the lexer association dialog. | |
| 1769 </p> | |
| 1770 <a NAME="Project.__showMenu" ID="Project.__showMenu"></a> | |
| 1771 <h4>Project.__showMenu</h4> | |
| 1772 <b>__showMenu</b>(<i></i>) | |
| 1773 | |
| 1774 <p> | |
| 1775 Private method to set up the project menu. | |
| 1776 </p> | |
| 1777 <a NAME="Project.__showProfileData" ID="Project.__showProfileData"></a> | |
| 1778 <h4>Project.__showProfileData</h4> | |
| 1779 <b>__showProfileData</b>(<i></i>) | |
| 1780 | |
| 1781 <p> | |
| 1782 Private slot used to show the profiling information for the project. | |
| 1783 </p> | |
| 1784 <a NAME="Project.__showProperties" ID="Project.__showProperties"></a> | |
| 1785 <h4>Project.__showProperties</h4> | |
| 1786 <b>__showProperties</b>(<i></i>) | |
| 1787 | |
| 1788 <p> | |
| 1789 Private slot to display the properties dialog. | |
| 1790 </p> | |
| 1791 <a NAME="Project.__showUserProperties" ID="Project.__showUserProperties"></a> | |
| 1792 <h4>Project.__showUserProperties</h4> | |
| 1793 <b>__showUserProperties</b>(<i></i>) | |
| 1794 | |
| 1795 <p> | |
| 1796 Private slot to display the user specific properties dialog. | |
| 1797 </p> | |
| 1798 <a NAME="Project.__sourceExtensions" ID="Project.__sourceExtensions"></a> | |
| 1799 <h4>Project.__sourceExtensions</h4> | |
| 1800 <b>__sourceExtensions</b>(<i>language</i>) | |
| 1801 | |
| 1802 <p> | |
| 1803 Private method to get the source extensions of a programming language. | |
| 1804 </p> | |
| 1805 <dl> | |
| 1806 | |
| 1807 <dt><i>language</i></dt> | |
| 1808 <dd> | |
| 1809 programming language (string) | |
| 1810 </dd> | |
| 1811 </dl> | |
| 1812 <dl> | |
| 1813 <dt>Return:</dt> | |
| 1814 <dd> | |
| 1815 source extensions (list of string) | |
| 1816 </dd> | |
| 1817 </dl> | |
| 1818 <a NAME="Project.__syncRecent" ID="Project.__syncRecent"></a> | |
| 1819 <h4>Project.__syncRecent</h4> | |
| 1820 <b>__syncRecent</b>(<i></i>) | |
| 1821 | |
| 1822 <p> | |
| 1823 Private method to synchronize the list of recently opened projects | |
| 1824 with the central store. | |
| 1825 </p> | |
| 1826 <a NAME="Project.__vcsConnectStatusMonitor" ID="Project.__vcsConnectStatusMonitor"></a> | |
| 1827 <h4>Project.__vcsConnectStatusMonitor</h4> | |
| 1828 <b>__vcsConnectStatusMonitor</b>(<i></i>) | |
| 1829 | |
| 1830 <p> | |
| 1831 Private method to start the VCS monitor and connect its signals. | |
| 1832 </p> | |
| 1833 <a NAME="Project.__vcsStatusChanged" ID="Project.__vcsStatusChanged"></a> | |
| 1834 <h4>Project.__vcsStatusChanged</h4> | |
| 1835 <b>__vcsStatusChanged</b>(<i></i>) | |
| 1836 | |
| 1837 <p> | |
| 1838 Private slot to handle a change of the overall VCS status. | |
| 1839 </p> | |
| 1840 <a NAME="Project.__writeDebugProperties" ID="Project.__writeDebugProperties"></a> | |
| 1841 <h4>Project.__writeDebugProperties</h4> | |
| 1842 <b>__writeDebugProperties</b>(<i>quiet=False</i>) | |
| 1843 | |
| 1844 <p> | |
| 1845 Private method to write the project debugger properties file (.edj). | |
| 1846 </p> | |
| 1847 <dl> | |
| 1848 | |
| 1849 <dt><i>quiet</i></dt> | |
| 1850 <dd> | |
| 1851 flag indicating quiet operations. | |
| 1852 If this flag is true, no errors are reported. | |
| 1853 </dd> | |
| 1854 </dl> | |
| 1855 <a NAME="Project.__writeProject" ID="Project.__writeProject"></a> | |
| 1856 <h4>Project.__writeProject</h4> | |
| 1857 <b>__writeProject</b>(<i>fn=None</i>) | |
| 1858 | |
| 1859 <p> | |
| 1860 Private method to save the project infos to a project file. | |
| 1861 </p> | |
| 1862 <dl> | |
| 1863 | |
| 1864 <dt><i>fn</i></dt> | |
| 1865 <dd> | |
| 1866 optional filename of the project file to be written (string). | |
| 1867 If fn is None, the filename stored in the project object | |
| 1868 is used. This is the 'save' action. If fn is given, this filename | |
| 1869 is used instead of the one in the project object. This is the | |
| 1870 'save as' action. | |
| 1871 </dd> | |
| 1872 </dl> | |
| 1873 <dl> | |
| 1874 <dt>Return:</dt> | |
| 1875 <dd> | |
| 1876 flag indicating success | |
| 1877 </dd> | |
| 1878 </dl> | |
| 1879 <a NAME="Project.__writeSession" ID="Project.__writeSession"></a> | |
| 1880 <h4>Project.__writeSession</h4> | |
| 1881 <b>__writeSession</b>(<i>quiet=False, indicator=""</i>) | |
| 1882 | |
| 1883 <p> | |
| 1884 Private method to write the session data to an XML file (.esj). | |
| 1885 </p> | |
| 1886 <dl> | |
| 1887 | |
| 1888 <dt><i>quiet</i></dt> | |
| 1889 <dd> | |
| 1890 flag indicating quiet operations. | |
| 1891 If this flag is true, no errors are reported. | |
| 1892 </dd> | |
| 1893 <dt><i>indicator</i></dt> | |
| 1894 <dd> | |
| 1895 indicator string (string) | |
| 1896 </dd> | |
| 1897 </dl> | |
| 1898 <a NAME="Project.__writeUserProperties" ID="Project.__writeUserProperties"></a> | |
| 1899 <h4>Project.__writeUserProperties</h4> | |
| 1900 <b>__writeUserProperties</b>(<i></i>) | |
| 1901 | |
| 1902 <p> | |
| 1903 Private method to write the user specific project data to a JSON file. | |
| 1904 </p> | |
| 1905 <a NAME="Project.addDirectory" ID="Project.addDirectory"></a> | |
| 1906 <h4>Project.addDirectory</h4> | |
| 1907 <b>addDirectory</b>(<i>fileTypeFilter=None, startdir=None</i>) | |
| 1908 | |
| 1909 <p> | |
| 1910 Public method used to add all files of a directory to the project. | |
| 1911 </p> | |
| 1912 <dl> | |
| 1913 | |
| 1914 <dt><i>fileTypeFilter</i> (str out of source, form, resource, interface, protocol, others)</dt> | |
| 1915 <dd> | |
| 1916 filter to be used by the add directory dialog | |
| 1917 </dd> | |
| 1918 <dt><i>startdir</i> (str)</dt> | |
| 1919 <dd> | |
| 1920 start directory for the selection dialog | |
| 1921 </dd> | |
| 1922 </dl> | |
| 1923 <a NAME="Project.addEricActions" ID="Project.addEricActions"></a> | |
| 1924 <h4>Project.addEricActions</h4> | |
| 1925 <b>addEricActions</b>(<i>actions</i>) | |
| 1926 | |
| 1927 <p> | |
| 1928 Public method to add actions to the list of actions. | |
| 1929 </p> | |
| 1930 <dl> | |
| 1931 | |
| 1932 <dt><i>actions</i></dt> | |
| 1933 <dd> | |
| 1934 list of actions (list of EricAction) | |
| 1935 </dd> | |
| 1936 </dl> | |
| 1937 <a NAME="Project.addFiles" ID="Project.addFiles"></a> | |
| 1938 <h4>Project.addFiles</h4> | |
| 1939 <b>addFiles</b>(<i>fileTypeFilter=None, startdir=None</i>) | |
| 1940 | |
| 1941 <p> | |
| 1942 Public slot used to add files to the project. | |
| 1943 </p> | |
| 1944 <dl> | |
| 1945 | |
| 1946 <dt><i>fileTypeFilter</i> (str out of source, form, resource, interface, protocol, others)</dt> | |
| 1947 <dd> | |
| 1948 filter to be used by the add file dialog | |
| 1949 </dd> | |
| 1950 <dt><i>startdir</i> (str)</dt> | |
| 1951 <dd> | |
| 1952 start directory for the selection dialog | |
| 1953 </dd> | |
| 1954 </dl> | |
| 1955 <a NAME="Project.addIdlDir" ID="Project.addIdlDir"></a> | |
| 1956 <h4>Project.addIdlDir</h4> | |
| 1957 <b>addIdlDir</b>(<i></i>) | |
| 1958 | |
| 1959 <p> | |
| 1960 Public slot to add all IDL interfaces of a directory to the current | |
| 1961 project. | |
| 1962 </p> | |
| 1963 <a NAME="Project.addIdlFiles" ID="Project.addIdlFiles"></a> | |
| 1964 <h4>Project.addIdlFiles</h4> | |
| 1965 <b>addIdlFiles</b>(<i></i>) | |
| 1966 | |
| 1967 <p> | |
| 1968 Public slot to add IDL interfaces to the current project. | |
| 1969 </p> | |
| 1970 <a NAME="Project.addLanguage" ID="Project.addLanguage"></a> | |
| 1971 <h4>Project.addLanguage</h4> | |
| 1972 <b>addLanguage</b>(<i></i>) | |
| 1973 | |
| 1974 <p> | |
| 1975 Public slot used to add a language to the project. | |
| 1976 </p> | |
| 1977 <a NAME="Project.addOthersDir" ID="Project.addOthersDir"></a> | |
| 1978 <h4>Project.addOthersDir</h4> | |
| 1979 <b>addOthersDir</b>(<i></i>) | |
| 1980 | |
| 1981 <p> | |
| 1982 Public slot to add a directory to the OTHERS project data. | |
| 1983 </p> | |
| 1984 <a NAME="Project.addOthersFiles" ID="Project.addOthersFiles"></a> | |
| 1985 <h4>Project.addOthersFiles</h4> | |
| 1986 <b>addOthersFiles</b>(<i></i>) | |
| 1987 | |
| 1988 <p> | |
| 1989 Public slot to add files to the OTHERS project data. | |
| 1990 </p> | |
| 1991 <a NAME="Project.addProtoDir" ID="Project.addProtoDir"></a> | |
| 1992 <h4>Project.addProtoDir</h4> | |
| 1993 <b>addProtoDir</b>(<i></i>) | |
| 1994 | |
| 1995 <p> | |
| 1996 Public slot to add all protocol files of a directory to the current | |
| 1997 project. | |
| 1998 </p> | |
| 1999 <a NAME="Project.addProtoFiles" ID="Project.addProtoFiles"></a> | |
| 2000 <h4>Project.addProtoFiles</h4> | |
| 2001 <b>addProtoFiles</b>(<i></i>) | |
| 2002 | |
| 2003 <p> | |
| 2004 Public slot to add protocol files to the current project. | |
| 2005 </p> | |
| 2006 <a NAME="Project.addResourceDir" ID="Project.addResourceDir"></a> | |
| 2007 <h4>Project.addResourceDir</h4> | |
| 2008 <b>addResourceDir</b>(<i></i>) | |
| 2009 | |
| 2010 <p> | |
| 2011 Public slot to add all Qt resource files of a directory to the current | |
| 2012 project. | |
| 2013 </p> | |
| 2014 <a NAME="Project.addResourceFiles" ID="Project.addResourceFiles"></a> | |
| 2015 <h4>Project.addResourceFiles</h4> | |
| 2016 <b>addResourceFiles</b>(<i></i>) | |
| 2017 | |
| 2018 <p> | |
| 2019 Public slot to add Qt resources to the current project. | |
| 2020 </p> | |
| 2021 <a NAME="Project.addSourceDir" ID="Project.addSourceDir"></a> | |
| 2022 <h4>Project.addSourceDir</h4> | |
| 2023 <b>addSourceDir</b>(<i></i>) | |
| 2024 | |
| 2025 <p> | |
| 2026 Public slot to add all source files of a directory to the current | |
| 2027 project. | |
| 2028 </p> | |
| 2029 <a NAME="Project.addSourceFiles" ID="Project.addSourceFiles"></a> | |
| 2030 <h4>Project.addSourceFiles</h4> | |
| 2031 <b>addSourceFiles</b>(<i></i>) | |
| 2032 | |
| 2033 <p> | |
| 2034 Public slot to add source files to the current project. | |
| 2035 </p> | |
| 2036 <a NAME="Project.addToOthers" ID="Project.addToOthers"></a> | |
| 2037 <h4>Project.addToOthers</h4> | |
| 2038 <b>addToOthers</b>(<i>fn</i>) | |
| 2039 | |
| 2040 <p> | |
| 2041 Public method to add a file/directory to the OTHERS project data. | |
| 2042 </p> | |
| 2043 <dl> | |
| 2044 | |
| 2045 <dt><i>fn</i></dt> | |
| 2046 <dd> | |
| 2047 file name or directory name to add (string) | |
| 2048 </dd> | |
| 2049 </dl> | |
| 2050 <a NAME="Project.addUiDir" ID="Project.addUiDir"></a> | |
| 2051 <h4>Project.addUiDir</h4> | |
| 2052 <b>addUiDir</b>(<i></i>) | |
| 2053 | |
| 2054 <p> | |
| 2055 Public slot to add all forms of a directory to the current project. | |
| 2056 </p> | |
| 2057 <a NAME="Project.addUiFiles" ID="Project.addUiFiles"></a> | |
| 2058 <h4>Project.addUiFiles</h4> | |
| 2059 <b>addUiFiles</b>(<i></i>) | |
| 2060 | |
| 2061 <p> | |
| 2062 Public slot to add forms to the current project. | |
| 2063 </p> | |
| 2064 <a NAME="Project.appendFile" ID="Project.appendFile"></a> | |
| 2065 <h4>Project.appendFile</h4> | |
| 2066 <b>appendFile</b>(<i>fn, isSourceFile=False, updateModel=True</i>) | |
| 2067 | |
| 2068 <p> | |
| 2069 Public method to append a file to the project. | |
| 2070 </p> | |
| 2071 <dl> | |
| 2072 | |
| 2073 <dt><i>fn</i></dt> | |
| 2074 <dd> | |
| 2075 filename to be added to the project (string) | |
| 2076 </dd> | |
| 2077 <dt><i>isSourceFile</i></dt> | |
| 2078 <dd> | |
| 2079 flag indicating that this is a source file | |
| 2080 even if it doesn't have the source extension (boolean) | |
| 2081 </dd> | |
| 2082 <dt><i>updateModel</i></dt> | |
| 2083 <dd> | |
| 2084 flag indicating an update of the model is | |
| 2085 requested (boolean) | |
| 2086 </dd> | |
| 2087 </dl> | |
| 2088 <a NAME="Project.checkAllScriptsDirty" ID="Project.checkAllScriptsDirty"></a> | |
| 2089 <h4>Project.checkAllScriptsDirty</h4> | |
| 2090 <b>checkAllScriptsDirty</b>(<i>reportSyntaxErrors=False</i>) | |
| 2091 | |
| 2092 <p> | |
| 2093 Public method to check all scripts belonging to the project for | |
| 2094 their dirty status. | |
| 2095 </p> | |
| 2096 <dl> | |
| 2097 | |
| 2098 <dt><i>reportSyntaxErrors</i></dt> | |
| 2099 <dd> | |
| 2100 flag indicating special reporting | |
| 2101 for syntax errors (boolean) | |
| 2102 </dd> | |
| 2103 </dl> | |
| 2104 <dl> | |
| 2105 <dt>Return:</dt> | |
| 2106 <dd> | |
| 2107 flag indicating success (boolean) | |
| 2108 </dd> | |
| 2109 </dl> | |
| 2110 <a NAME="Project.checkDirty" ID="Project.checkDirty"></a> | |
| 2111 <h4>Project.checkDirty</h4> | |
| 2112 <b>checkDirty</b>(<i></i>) | |
| 2113 | |
| 2114 <p> | |
| 2115 Public method to check dirty status and open a message window. | |
| 2116 </p> | |
| 2117 <dl> | |
| 2118 <dt>Return:</dt> | |
| 2119 <dd> | |
| 2120 flag indicating whether this operation was successful (boolean) | |
| 2121 </dd> | |
| 2122 </dl> | |
| 2123 <a NAME="Project.checkLanguageFiles" ID="Project.checkLanguageFiles"></a> | |
| 2124 <h4>Project.checkLanguageFiles</h4> | |
| 2125 <b>checkLanguageFiles</b>(<i></i>) | |
| 2126 | |
| 2127 <p> | |
| 2128 Public slot to check the language files after a release process. | |
| 2129 </p> | |
| 2130 <a NAME="Project.checkVCSStatus" ID="Project.checkVCSStatus"></a> | |
| 2131 <h4>Project.checkVCSStatus</h4> | |
| 2132 <b>checkVCSStatus</b>(<i></i>) | |
| 2133 | |
| 2134 <p> | |
| 2135 Public method to wake up the VCS status monitor thread. | |
| 2136 </p> | |
| 2137 <a NAME="Project.clearHistories" ID="Project.clearHistories"></a> | |
| 2138 <h4>Project.clearHistories</h4> | |
| 2139 <b>clearHistories</b>(<i></i>) | |
| 2140 | |
| 2141 <p> | |
| 2142 Public method to clear the project related histories. | |
| 2143 </p> | |
| 2144 <a NAME="Project.clearRecent" ID="Project.clearRecent"></a> | |
| 2145 <h4>Project.clearRecent</h4> | |
| 2146 <b>clearRecent</b>(<i></i>) | |
| 2147 | |
| 2148 <p> | |
| 2149 Public method to clear the recent projects menu. | |
| 2150 </p> | |
| 2151 <a NAME="Project.clearStatusMonitorCachedState" ID="Project.clearStatusMonitorCachedState"></a> | |
| 2152 <h4>Project.clearStatusMonitorCachedState</h4> | |
| 2153 <b>clearStatusMonitorCachedState</b>(<i>name</i>) | |
| 2154 | |
| 2155 <p> | |
| 2156 Public method to clear the cached VCS state of a file/directory. | |
| 2157 </p> | |
| 2158 <dl> | |
| 2159 | |
| 2160 <dt><i>name</i></dt> | |
| 2161 <dd> | |
| 2162 name of the entry to be cleared (string) | |
| 2163 </dd> | |
| 2164 </dl> | |
| 2165 <a NAME="Project.closeProject" ID="Project.closeProject"></a> | |
| 2166 <h4>Project.closeProject</h4> | |
| 2167 <b>closeProject</b>(<i>reopen=False, noSave=False, shutdown=False</i>) | |
| 2168 | |
| 2169 <p> | |
| 2170 Public slot to close the current project. | |
| 2171 </p> | |
| 2172 <dl> | |
| 2173 | |
| 2174 <dt><i>reopen</i> (bool)</dt> | |
| 2175 <dd> | |
| 2176 flag indicating a reopening of the project | |
| 2177 </dd> | |
| 2178 <dt><i>noSave</i> (bool)</dt> | |
| 2179 <dd> | |
| 2180 flag indicating to not perform save actions | |
| 2181 </dd> | |
| 2182 <dt><i>shutdown</i> (bool)</dt> | |
| 2183 <dd> | |
| 2184 flag indicating the IDE shutdown | |
| 2185 </dd> | |
| 2186 </dl> | |
| 2187 <dl> | |
| 2188 <dt>Return:</dt> | |
| 2189 <dd> | |
| 2190 flag indicating success | |
| 2191 </dd> | |
| 2192 </dl> | |
| 2193 <dl> | |
| 2194 <dt>Return Type:</dt> | |
| 2195 <dd> | |
| 2196 bool | |
| 2197 </dd> | |
| 2198 </dl> | |
| 2199 <a NAME="Project.copyDirectory" ID="Project.copyDirectory"></a> | |
| 2200 <h4>Project.copyDirectory</h4> | |
| 2201 <b>copyDirectory</b>(<i>olddn, newdn</i>) | |
| 2202 | |
| 2203 <p> | |
| 2204 Public slot to copy a directory. | |
| 2205 </p> | |
| 2206 <dl> | |
| 2207 | |
| 2208 <dt><i>olddn</i></dt> | |
| 2209 <dd> | |
| 2210 original directory name (string) | |
| 2211 </dd> | |
| 2212 <dt><i>newdn</i></dt> | |
| 2213 <dd> | |
| 2214 new directory name (string) | |
| 2215 </dd> | |
| 2216 </dl> | |
| 2217 <a NAME="Project.createNewProject" ID="Project.createNewProject"></a> | |
| 2218 <h4>Project.createNewProject</h4> | |
| 2219 <b>createNewProject</b>(<i></i>) | |
| 2220 | |
| 2221 <p> | |
| 2222 Public slot to built a new project. | |
| 2223 </p> | |
| 2224 <p> | |
| 2225 This method displays the new project dialog and initializes | |
| 2226 the project object with the data entered. | |
| 2227 </p> | |
| 2228 <a NAME="Project.createProjectManagementDir" ID="Project.createProjectManagementDir"></a> | |
| 2229 <h4>Project.createProjectManagementDir</h4> | |
| 2230 <b>createProjectManagementDir</b>(<i></i>) | |
| 2231 | |
| 2232 <p> | |
| 2233 Public method to create the project management directory. | |
| 2234 </p> | |
| 2235 <p> | |
| 2236 It does nothing, if it already exists. | |
| 2237 </p> | |
| 2238 <a NAME="Project.deleteDirectory" ID="Project.deleteDirectory"></a> | |
| 2239 <h4>Project.deleteDirectory</h4> | |
| 2240 <b>deleteDirectory</b>(<i>dn</i>) | |
| 2241 | |
| 2242 <p> | |
| 2243 Public method to delete a directory from the project directory. | |
| 2244 </p> | |
| 2245 <dl> | |
| 2246 | |
| 2247 <dt><i>dn</i></dt> | |
| 2248 <dd> | |
| 2249 directory name to be removed from the project | |
| 2250 </dd> | |
| 2251 </dl> | |
| 2252 <dl> | |
| 2253 <dt>Return:</dt> | |
| 2254 <dd> | |
| 2255 flag indicating success (boolean) | |
| 2256 </dd> | |
| 2257 </dl> | |
| 2258 <a NAME="Project.deleteFile" ID="Project.deleteFile"></a> | |
| 2259 <h4>Project.deleteFile</h4> | |
| 2260 <b>deleteFile</b>(<i>fn</i>) | |
| 2261 | |
| 2262 <p> | |
| 2263 Public method to delete a file from the project directory. | |
| 2264 </p> | |
| 2265 <dl> | |
| 2266 | |
| 2267 <dt><i>fn</i></dt> | |
| 2268 <dd> | |
| 2269 filename to be deleted from the project | |
| 2270 </dd> | |
| 2271 </dl> | |
| 2272 <dl> | |
| 2273 <dt>Return:</dt> | |
| 2274 <dd> | |
| 2275 flag indicating success (boolean) | |
| 2276 </dd> | |
| 2277 </dl> | |
| 2278 <a NAME="Project.deleteLanguageFile" ID="Project.deleteLanguageFile"></a> | |
| 2279 <h4>Project.deleteLanguageFile</h4> | |
| 2280 <b>deleteLanguageFile</b>(<i>langFile</i>) | |
| 2281 | |
| 2282 <p> | |
| 2283 Public slot to delete a translation from the project directory. | |
| 2284 </p> | |
| 2285 <dl> | |
| 2286 | |
| 2287 <dt><i>langFile</i></dt> | |
| 2288 <dd> | |
| 2289 the translation file to be removed (string) | |
| 2290 </dd> | |
| 2291 </dl> | |
| 2292 <a NAME="Project.executeMake" ID="Project.executeMake"></a> | |
| 2293 <h4>Project.executeMake</h4> | |
| 2294 <b>executeMake</b>(<i></i>) | |
| 2295 | |
| 2296 <p> | |
| 2297 Public slot to execute a project specific make run (auto-run) | |
| 2298 (execute or question). | |
| 2299 </p> | |
| 2300 <a NAME="Project.getAbsolutePath" ID="Project.getAbsolutePath"></a> | |
| 2301 <h4>Project.getAbsolutePath</h4> | |
| 2302 <b>getAbsolutePath</b>(<i>fn</i>) | |
| 2303 | |
| 2304 <p> | |
| 2305 Public method to convert a project relative file path to an absolute | |
| 2306 file path. | |
| 2307 </p> | |
| 2308 <dl> | |
| 2309 | |
| 2310 <dt><i>fn</i></dt> | |
| 2311 <dd> | |
| 2312 file or directory name to convert (string) | |
| 2313 </dd> | |
| 2314 </dl> | |
| 2315 <dl> | |
| 2316 <dt>Return:</dt> | |
| 2317 <dd> | |
| 2318 absolute path (string) | |
| 2319 </dd> | |
| 2320 </dl> | |
| 2321 <a NAME="Project.getAbsoluteUniversalPath" ID="Project.getAbsoluteUniversalPath"></a> | |
| 2322 <h4>Project.getAbsoluteUniversalPath</h4> | |
| 2323 <b>getAbsoluteUniversalPath</b>(<i>fn</i>) | |
| 2324 | |
| 2325 <p> | |
| 2326 Public method to convert a project relative file path with universal | |
| 2327 separators to an absolute file path. | |
| 2328 </p> | |
| 2329 <dl> | |
| 2330 | |
| 2331 <dt><i>fn</i></dt> | |
| 2332 <dd> | |
| 2333 file or directory name to convert (string) | |
| 2334 </dd> | |
| 2335 </dl> | |
| 2336 <dl> | |
| 2337 <dt>Return:</dt> | |
| 2338 <dd> | |
| 2339 absolute path (string) | |
| 2340 </dd> | |
| 2341 </dl> | |
| 2342 <a NAME="Project.getActions" ID="Project.getActions"></a> | |
| 2343 <h4>Project.getActions</h4> | |
| 2344 <b>getActions</b>(<i></i>) | |
| 2345 | |
| 2346 <p> | |
| 2347 Public method to get a list of all actions. | |
| 2348 </p> | |
| 2349 <dl> | |
| 2350 <dt>Return:</dt> | |
| 2351 <dd> | |
| 2352 list of all actions (list of EricAction) | |
| 2353 </dd> | |
| 2354 </dl> | |
| 2355 <a NAME="Project.getData" ID="Project.getData"></a> | |
| 2356 <h4>Project.getData</h4> | |
| 2357 <b>getData</b>(<i>category, key</i>) | |
| 2358 | |
| 2359 <p> | |
| 2360 Public method to get data out of the project data store. | |
| 2361 </p> | |
| 2362 <dl> | |
| 2363 | |
| 2364 <dt><i>category</i></dt> | |
| 2365 <dd> | |
| 2366 category of the data to get (string, one of | |
| 2367 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS, | |
| 2368 DOCUMENTATIONPARMS or OTHERTOOLSPARMS) | |
| 2369 </dd> | |
| 2370 <dt><i>key</i></dt> | |
| 2371 <dd> | |
| 2372 key of the data entry to get (string). | |
| 2373 </dd> | |
| 2374 </dl> | |
| 2375 <dl> | |
| 2376 <dt>Return:</dt> | |
| 2377 <dd> | |
| 2378 a copy of the requested data or None | |
| 2379 </dd> | |
| 2380 </dl> | |
| 2381 <a NAME="Project.getDebugProperty" ID="Project.getDebugProperty"></a> | |
| 2382 <h4>Project.getDebugProperty</h4> | |
| 2383 <b>getDebugProperty</b>(<i>key</i>) | |
| 2384 | |
| 2385 <p> | |
| 2386 Public method to retrieve a debugger property. | |
| 2387 </p> | |
| 2388 <dl> | |
| 2389 | |
| 2390 <dt><i>key</i></dt> | |
| 2391 <dd> | |
| 2392 key of the property (string) | |
| 2393 </dd> | |
| 2394 </dl> | |
| 2395 <dl> | |
| 2396 <dt>Return:</dt> | |
| 2397 <dd> | |
| 2398 value of the property | |
| 2399 </dd> | |
| 2400 </dl> | |
| 2401 <a NAME="Project.getDebuggerFilters" ID="Project.getDebuggerFilters"></a> | |
| 2402 <h4>Project.getDebuggerFilters</h4> | |
| 2403 <b>getDebuggerFilters</b>(<i>language</i>) | |
| 2404 | |
| 2405 <p> | |
| 2406 Public method to get the debugger filters for a programming language. | |
| 2407 </p> | |
| 2408 <dl> | |
| 2409 | |
| 2410 <dt><i>language</i> (str)</dt> | |
| 2411 <dd> | |
| 2412 programming language | |
| 2413 </dd> | |
| 2414 </dl> | |
| 2415 <dl> | |
| 2416 <dt>Return:</dt> | |
| 2417 <dd> | |
| 2418 filter string | |
| 2419 </dd> | |
| 2420 </dl> | |
| 2421 <dl> | |
| 2422 <dt>Return Type:</dt> | |
| 2423 <dd> | |
| 2424 str | |
| 2425 </dd> | |
| 2426 </dl> | |
| 2427 <a NAME="Project.getDefaultRccCompilerParameters" ID="Project.getDefaultRccCompilerParameters"></a> | |
| 2428 <h4>Project.getDefaultRccCompilerParameters</h4> | |
| 2429 <b>getDefaultRccCompilerParameters</b>(<i></i>) | |
| 2430 | |
| 2431 <p> | |
| 2432 Public method to get the default rcc compiler parameters. | |
| 2433 </p> | |
| 2434 <dl> | |
| 2435 <dt>Return:</dt> | |
| 2436 <dd> | |
| 2437 dictionary containing the default rcc compiler parameters | |
| 2438 </dd> | |
| 2439 </dl> | |
| 2440 <dl> | |
| 2441 <dt>Return Type:</dt> | |
| 2442 <dd> | |
| 2443 dict | |
| 2444 </dd> | |
| 2445 </dl> | |
| 2446 <a NAME="Project.getDefaultSourceExtension" ID="Project.getDefaultSourceExtension"></a> | |
| 2447 <h4>Project.getDefaultSourceExtension</h4> | |
| 2448 <b>getDefaultSourceExtension</b>(<i></i>) | |
| 2449 | |
| 2450 <p> | |
| 2451 Public method to get the default extension for the project's | |
| 2452 programming language. | |
| 2453 </p> | |
| 2454 <dl> | |
| 2455 <dt>Return:</dt> | |
| 2456 <dd> | |
| 2457 default extension (including the dot) (string) | |
| 2458 </dd> | |
| 2459 </dl> | |
| 2460 <a NAME="Project.getDocstringType" ID="Project.getDocstringType"></a> | |
| 2461 <h4>Project.getDocstringType</h4> | |
| 2462 <b>getDocstringType</b>(<i></i>) | |
| 2463 | |
| 2464 <p> | |
| 2465 Public method to get the configured docstring style. | |
| 2466 </p> | |
| 2467 <dl> | |
| 2468 <dt>Return:</dt> | |
| 2469 <dd> | |
| 2470 configured docstring style | |
| 2471 </dd> | |
| 2472 </dl> | |
| 2473 <dl> | |
| 2474 <dt>Return Type:</dt> | |
| 2475 <dd> | |
| 2476 str | |
| 2477 </dd> | |
| 2478 </dl> | |
| 2479 <a NAME="Project.getEditorLexerAssoc" ID="Project.getEditorLexerAssoc"></a> | |
| 2480 <h4>Project.getEditorLexerAssoc</h4> | |
| 2481 <b>getEditorLexerAssoc</b>(<i>filename</i>) | |
| 2482 | |
| 2483 <p> | |
| 2484 Public method to retrieve a lexer association. | |
| 2485 </p> | |
| 2486 <dl> | |
| 2487 | |
| 2488 <dt><i>filename</i></dt> | |
| 2489 <dd> | |
| 2490 filename used to determine the associated lexer | |
| 2491 language (string) | |
| 2492 </dd> | |
| 2493 </dl> | |
| 2494 <dl> | |
| 2495 <dt>Return:</dt> | |
| 2496 <dd> | |
| 2497 the requested lexer language (string) | |
| 2498 </dd> | |
| 2499 </dl> | |
| 2500 <a NAME="Project.getEolString" ID="Project.getEolString"></a> | |
| 2501 <h4>Project.getEolString</h4> | |
| 2502 <b>getEolString</b>(<i></i>) | |
| 2503 | |
| 2504 <p> | |
| 2505 Public method to get the EOL-string to be used by the project. | |
| 2506 </p> | |
| 2507 <dl> | |
| 2508 <dt>Return:</dt> | |
| 2509 <dd> | |
| 2510 eol string (string) | |
| 2511 </dd> | |
| 2512 </dl> | |
| 2513 <a NAME="Project.getFiles" ID="Project.getFiles"></a> | |
| 2514 <h4>Project.getFiles</h4> | |
| 2515 <b>getFiles</b>(<i>start</i>) | |
| 2516 | |
| 2517 <p> | |
| 2518 Public method to get all files starting with a common prefix. | |
| 2519 </p> | |
| 2520 <dl> | |
| 2521 | |
| 2522 <dt><i>start</i></dt> | |
| 2523 <dd> | |
| 2524 prefix (string) | |
| 2525 </dd> | |
| 2526 </dl> | |
| 2527 <dl> | |
| 2528 <dt>Return:</dt> | |
| 2529 <dd> | |
| 2530 list of files starting with a common prefix (list of strings) | |
| 2531 </dd> | |
| 2532 </dl> | |
| 2533 <a NAME="Project.getFiletypeAssociations" ID="Project.getFiletypeAssociations"></a> | |
| 2534 <h4>Project.getFiletypeAssociations</h4> | |
| 2535 <b>getFiletypeAssociations</b>(<i>associationType</i>) | |
| 2536 | |
| 2537 <p> | |
| 2538 Public method to get the list of file type associations for | |
| 2539 the given association type. | |
| 2540 </p> | |
| 2541 <dl> | |
| 2542 | |
| 2543 <dt><i>associationType</i> (str)</dt> | |
| 2544 <dd> | |
| 2545 type of the association (one of FORMS, | |
| 2546 INTERFACES, OTHERS, PROTOCOLS, RESOURCES, SOURCES, | |
| 2547 TRANSLATIONS or __IGNORE__) | |
| 2548 </dd> | |
| 2549 </dl> | |
| 2550 <dl> | |
| 2551 <dt>Return:</dt> | |
| 2552 <dd> | |
| 2553 list of file patterns for the given type | |
| 2554 </dd> | |
| 2555 </dl> | |
| 2556 <dl> | |
| 2557 <dt>Return Type:</dt> | |
| 2558 <dd> | |
| 2559 list of str | |
| 2560 </dd> | |
| 2561 </dl> | |
| 2562 <a NAME="Project.getHash" ID="Project.getHash"></a> | |
| 2563 <h4>Project.getHash</h4> | |
| 2564 <b>getHash</b>(<i></i>) | |
| 2565 | |
| 2566 <p> | |
| 2567 Public method to get the project hash. | |
| 2568 </p> | |
| 2569 <dl> | |
| 2570 <dt>Return:</dt> | |
| 2571 <dd> | |
| 2572 project hash as a hex string (string) | |
| 2573 </dd> | |
| 2574 </dl> | |
| 2575 <a NAME="Project.getIgnorePatterns" ID="Project.getIgnorePatterns"></a> | |
| 2576 <h4>Project.getIgnorePatterns</h4> | |
| 2577 <b>getIgnorePatterns</b>(<i></i>) | |
| 2578 | |
| 2579 <p> | |
| 2580 Public method to get the list of file name patterns for files to be | |
| 2581 ignored. | |
| 2582 </p> | |
| 2583 <dl> | |
| 2584 <dt>Return:</dt> | |
| 2585 <dd> | |
| 2586 list of ignore file name patterns | |
| 2587 </dd> | |
| 2588 </dl> | |
| 2589 <dl> | |
| 2590 <dt>Return Type:</dt> | |
| 2591 <dd> | |
| 2592 list of str | |
| 2593 </dd> | |
| 2594 </dl> | |
| 2595 <a NAME="Project.getMainScript" ID="Project.getMainScript"></a> | |
| 2596 <h4>Project.getMainScript</h4> | |
| 2597 <b>getMainScript</b>(<i>normalized=False</i>) | |
| 2598 | |
| 2599 <p> | |
| 2600 Public method to return the main script filename. | |
| 2601 </p> | |
| 2602 <p> | |
| 2603 The normalized name is the name of the main script prepended with | |
| 2604 the project path. | |
| 2605 </p> | |
| 2606 <dl> | |
| 2607 | |
| 2608 <dt><i>normalized</i> (bool)</dt> | |
| 2609 <dd> | |
| 2610 flag indicating a normalized filename is wanted | |
| 2611 </dd> | |
| 2612 </dl> | |
| 2613 <dl> | |
| 2614 <dt>Return:</dt> | |
| 2615 <dd> | |
| 2616 filename of the projects main script | |
| 2617 </dd> | |
| 2618 </dl> | |
| 2619 <dl> | |
| 2620 <dt>Return Type:</dt> | |
| 2621 <dd> | |
| 2622 str | |
| 2623 </dd> | |
| 2624 </dl> | |
| 2625 <a NAME="Project.getMenu" ID="Project.getMenu"></a> | |
| 2626 <h4>Project.getMenu</h4> | |
| 2627 <b>getMenu</b>(<i>menuName</i>) | |
| 2628 | |
| 2629 <p> | |
| 2630 Public method to get a reference to the main menu or a submenu. | |
| 2631 </p> | |
| 2632 <dl> | |
| 2633 | |
| 2634 <dt><i>menuName</i></dt> | |
| 2635 <dd> | |
| 2636 name of the menu (string) | |
| 2637 </dd> | |
| 2638 </dl> | |
| 2639 <dl> | |
| 2640 <dt>Return:</dt> | |
| 2641 <dd> | |
| 2642 reference to the requested menu (QMenu) or None | |
| 2643 </dd> | |
| 2644 </dl> | |
| 2645 <a NAME="Project.getModel" ID="Project.getModel"></a> | |
| 2646 <h4>Project.getModel</h4> | |
| 2647 <b>getModel</b>(<i></i>) | |
| 2648 | |
| 2649 <p> | |
| 2650 Public method to get a reference to the project browser model. | |
| 2651 </p> | |
| 2652 <dl> | |
| 2653 <dt>Return:</dt> | |
| 2654 <dd> | |
| 2655 reference to the project browser model (ProjectBrowserModel) | |
| 2656 </dd> | |
| 2657 </dl> | |
| 2658 <a NAME="Project.getMostRecent" ID="Project.getMostRecent"></a> | |
| 2659 <h4>Project.getMostRecent</h4> | |
| 2660 <b>getMostRecent</b>(<i></i>) | |
| 2661 | |
| 2662 <p> | |
| 2663 Public method to get the most recently opened project. | |
| 2664 </p> | |
| 2665 <dl> | |
| 2666 <dt>Return:</dt> | |
| 2667 <dd> | |
| 2668 path of the most recently opened project (string) | |
| 2669 </dd> | |
| 2670 </dl> | |
| 2671 <a NAME="Project.getProgrammingLanguages" ID="Project.getProgrammingLanguages"></a> | |
| 2672 <h4>Project.getProgrammingLanguages</h4> | |
| 2673 <b>getProgrammingLanguages</b>(<i></i>) | |
| 2674 | |
| 2675 <p> | |
| 2676 Public method to get the programming languages supported by project. | |
| 2677 </p> | |
| 2678 <dl> | |
| 2679 <dt>Return:</dt> | |
| 2680 <dd> | |
| 2681 list of supported programming languages (list of string) | |
| 2682 </dd> | |
| 2683 </dl> | |
| 2684 <a NAME="Project.getProjectAuthor" ID="Project.getProjectAuthor"></a> | |
| 2685 <h4>Project.getProjectAuthor</h4> | |
| 2686 <b>getProjectAuthor</b>(<i></i>) | |
| 2687 | |
| 2688 <p> | |
| 2689 Public method to get the author of the project. | |
| 2690 </p> | |
| 2691 <dl> | |
| 2692 <dt>Return:</dt> | |
| 2693 <dd> | |
| 2694 author name | |
| 2695 </dd> | |
| 2696 </dl> | |
| 2697 <dl> | |
| 2698 <dt>Return Type:</dt> | |
| 2699 <dd> | |
| 2700 str | |
| 2701 </dd> | |
| 2702 </dl> | |
| 2703 <a NAME="Project.getProjectAuthorEmail" ID="Project.getProjectAuthorEmail"></a> | |
| 2704 <h4>Project.getProjectAuthorEmail</h4> | |
| 2705 <b>getProjectAuthorEmail</b>(<i></i>) | |
| 2706 | |
| 2707 <p> | |
| 2708 Public method to get the email address of the project author. | |
| 2709 </p> | |
| 2710 <dl> | |
| 2711 <dt>Return:</dt> | |
| 2712 <dd> | |
| 2713 project author email | |
| 2714 </dd> | |
| 2715 </dl> | |
| 2716 <dl> | |
| 2717 <dt>Return Type:</dt> | |
| 2718 <dd> | |
| 2719 str | |
| 2720 </dd> | |
| 2721 </dl> | |
| 2722 <a NAME="Project.getProjectDescription" ID="Project.getProjectDescription"></a> | |
| 2723 <h4>Project.getProjectDescription</h4> | |
| 2724 <b>getProjectDescription</b>(<i></i>) | |
| 2725 | |
| 2726 <p> | |
| 2727 Public method to get the description of the project. | |
| 2728 </p> | |
| 2729 <dl> | |
| 2730 <dt>Return:</dt> | |
| 2731 <dd> | |
| 2732 project description | |
| 2733 </dd> | |
| 2734 </dl> | |
| 2735 <dl> | |
| 2736 <dt>Return Type:</dt> | |
| 2737 <dd> | |
| 2738 str | |
| 2739 </dd> | |
| 2740 </dl> | |
| 2741 <a NAME="Project.getProjectDictionaries" ID="Project.getProjectDictionaries"></a> | |
| 2742 <h4>Project.getProjectDictionaries</h4> | |
| 2743 <b>getProjectDictionaries</b>(<i></i>) | |
| 2744 | |
| 2745 <p> | |
| 2746 Public method to get the names of the project specific dictionaries. | |
| 2747 </p> | |
| 2748 <dl> | |
| 2749 <dt>Return:</dt> | |
| 2750 <dd> | |
| 2751 tuple of two strings giving the absolute path names of the | |
| 2752 project specific word and exclude list | |
| 2753 </dd> | |
| 2754 </dl> | |
| 2755 <a NAME="Project.getProjectExecPath" ID="Project.getProjectExecPath"></a> | |
| 2756 <h4>Project.getProjectExecPath</h4> | |
| 2757 <b>getProjectExecPath</b>(<i></i>) | |
| 2758 | |
| 2759 <p> | |
| 2760 Public method to get the executable search path prefix of the project. | |
| 2761 </p> | |
| 2762 <dl> | |
| 2763 <dt>Return:</dt> | |
| 2764 <dd> | |
| 2765 executable search path prefix | |
| 2766 </dd> | |
| 2767 </dl> | |
| 2768 <dl> | |
| 2769 <dt>Return Type:</dt> | |
| 2770 <dd> | |
| 2771 str | |
| 2772 </dd> | |
| 2773 </dl> | |
| 2774 <a NAME="Project.getProjectFile" ID="Project.getProjectFile"></a> | |
| 2775 <h4>Project.getProjectFile</h4> | |
| 2776 <b>getProjectFile</b>(<i></i>) | |
| 2777 | |
| 2778 <p> | |
| 2779 Public method to get the path of the project file. | |
| 2780 </p> | |
| 2781 <dl> | |
| 2782 <dt>Return:</dt> | |
| 2783 <dd> | |
| 2784 path of the project file (string) | |
| 2785 </dd> | |
| 2786 </dl> | |
| 2787 <a NAME="Project.getProjectFiles" ID="Project.getProjectFiles"></a> | |
| 2788 <h4>Project.getProjectFiles</h4> | |
| 2789 <b>getProjectFiles</b>(<i>fileType, normalized=False</i>) | |
| 2790 | |
| 2791 <p> | |
| 2792 Public method to get the file entries of the given type. | |
| 2793 </p> | |
| 2794 <dl> | |
| 2795 | |
| 2796 <dt><i>fileType</i> (str)</dt> | |
| 2797 <dd> | |
| 2798 project file type (one of SOURCES, FORMS, RESOURCES, | |
| 2799 INTERFACES, PROTOCOLS, OTHERS, TRANSLATIONS) | |
| 2800 </dd> | |
| 2801 <dt><i>normalized</i> (boolean)</dt> | |
| 2802 <dd> | |
| 2803 flag indicating normalized file names are wanted | |
| 2804 </dd> | |
| 2805 </dl> | |
| 2806 <dl> | |
| 2807 <dt>Return:</dt> | |
| 2808 <dd> | |
| 2809 list of file names | |
| 2810 </dd> | |
| 2811 </dl> | |
| 2812 <dl> | |
| 2813 <dt>Return Type:</dt> | |
| 2814 <dd> | |
| 2815 list of str | |
| 2816 </dd> | |
| 2817 </dl> | |
| 2818 <dl> | |
| 2819 | |
| 2820 <dt>Raises <b>ValueError</b>:</dt> | |
| 2821 <dd> | |
| 2822 raised when an unsupported file type is given | |
| 2823 </dd> | |
| 2824 </dl> | |
| 2825 <a NAME="Project.getProjectInterpreter" ID="Project.getProjectInterpreter"></a> | |
| 2826 <h4>Project.getProjectInterpreter</h4> | |
| 2827 <b>getProjectInterpreter</b>(<i>resolveGlobal=True</i>) | |
| 2828 | |
| 2829 <p> | |
| 2830 Public method to get the path of the interpreter used by the project. | |
| 2831 </p> | |
| 2832 <dl> | |
| 2833 | |
| 2834 <dt><i>resolveGlobal</i> (bool)</dt> | |
| 2835 <dd> | |
| 2836 flag indicating to resolve the interpreter using | |
| 2837 the global interpreter if no project of debugger specific | |
| 2838 environment was configured | |
| 2839 </dd> | |
| 2840 </dl> | |
| 2841 <dl> | |
| 2842 <dt>Return:</dt> | |
| 2843 <dd> | |
| 2844 path of the project's interpreter | |
| 2845 </dd> | |
| 2846 </dl> | |
| 2847 <dl> | |
| 2848 <dt>Return Type:</dt> | |
| 2849 <dd> | |
| 2850 str | |
| 2851 </dd> | |
| 2852 </dl> | |
| 2853 <a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a> | |
| 2854 <h4>Project.getProjectLanguage</h4> | |
| 2855 <b>getProjectLanguage</b>(<i></i>) | |
| 2856 | |
| 2857 <p> | |
| 2858 Public method to get the project's programming language. | |
| 2859 </p> | |
| 2860 <dl> | |
| 2861 <dt>Return:</dt> | |
| 2862 <dd> | |
| 2863 programming language (string) | |
| 2864 </dd> | |
| 2865 </dl> | |
| 2866 <a NAME="Project.getProjectLicense" ID="Project.getProjectLicense"></a> | |
| 2867 <h4>Project.getProjectLicense</h4> | |
| 2868 <b>getProjectLicense</b>(<i></i>) | |
| 2869 | |
| 2870 <p> | |
| 2871 Public method to get the license type used by the project. | |
| 2872 </p> | |
| 2873 <dl> | |
| 2874 <dt>Return:</dt> | |
| 2875 <dd> | |
| 2876 license type of the project | |
| 2877 </dd> | |
| 2878 </dl> | |
| 2879 <dl> | |
| 2880 <dt>Return Type:</dt> | |
| 2881 <dd> | |
| 2882 str | |
| 2883 </dd> | |
| 2884 </dl> | |
| 2885 <a NAME="Project.getProjectManagementDir" ID="Project.getProjectManagementDir"></a> | |
| 2886 <h4>Project.getProjectManagementDir</h4> | |
| 2887 <b>getProjectManagementDir</b>(<i></i>) | |
| 2888 | |
| 2889 <p> | |
| 2890 Public method to get the path of the management directory. | |
| 2891 </p> | |
| 2892 <dl> | |
| 2893 <dt>Return:</dt> | |
| 2894 <dd> | |
| 2895 path of the management directory (string) | |
| 2896 </dd> | |
| 2897 </dl> | |
| 2898 <a NAME="Project.getProjectName" ID="Project.getProjectName"></a> | |
| 2899 <h4>Project.getProjectName</h4> | |
| 2900 <b>getProjectName</b>(<i></i>) | |
| 2901 | |
| 2902 <p> | |
| 2903 Public method to get the name of the project. | |
| 2904 </p> | |
| 2905 <p> | |
| 2906 The project name is determined from the name of the project file. | |
| 2907 </p> | |
| 2908 <dl> | |
| 2909 <dt>Return:</dt> | |
| 2910 <dd> | |
| 2911 name of the project (string) | |
| 2912 </dd> | |
| 2913 </dl> | |
| 2914 <a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a> | |
| 2915 <h4>Project.getProjectPath</h4> | |
| 2916 <b>getProjectPath</b>(<i></i>) | |
| 2917 | |
| 2918 <p> | |
| 2919 Public method to get the project path. | |
| 2920 </p> | |
| 2921 <dl> | |
| 2922 <dt>Return:</dt> | |
| 2923 <dd> | |
| 2924 project path (string) | |
| 2925 </dd> | |
| 2926 </dl> | |
| 2927 <a NAME="Project.getProjectSpellLanguage" ID="Project.getProjectSpellLanguage"></a> | |
| 2928 <h4>Project.getProjectSpellLanguage</h4> | |
| 2929 <b>getProjectSpellLanguage</b>(<i></i>) | |
| 2930 | |
| 2931 <p> | |
| 2932 Public method to get the project's programming language. | |
| 2933 </p> | |
| 2934 <dl> | |
| 2935 <dt>Return:</dt> | |
| 2936 <dd> | |
| 2937 programming language (string) | |
| 2938 </dd> | |
| 2939 </dl> | |
| 2940 <a NAME="Project.getProjectTestingFramework" ID="Project.getProjectTestingFramework"></a> | |
| 2941 <h4>Project.getProjectTestingFramework</h4> | |
| 2942 <b>getProjectTestingFramework</b>(<i></i>) | |
| 2943 | |
| 2944 <p> | |
| 2945 Public method to get the testing framework name of the project. | |
| 2946 </p> | |
| 2947 <dl> | |
| 2948 <dt>Return:</dt> | |
| 2949 <dd> | |
| 2950 testing framework name of the project | |
| 2951 </dd> | |
| 2952 </dl> | |
| 2953 <dl> | |
| 2954 <dt>Return Type:</dt> | |
| 2955 <dd> | |
| 2956 str | |
| 2957 </dd> | |
| 2958 </dl> | |
| 2959 <a NAME="Project.getProjectType" ID="Project.getProjectType"></a> | |
| 2960 <h4>Project.getProjectType</h4> | |
| 2961 <b>getProjectType</b>(<i></i>) | |
| 2962 | |
| 2963 <p> | |
| 2964 Public method to get the type of the project. | |
| 2965 </p> | |
| 2966 <dl> | |
| 2967 <dt>Return:</dt> | |
| 2968 <dd> | |
| 2969 UI type of the project (string) | |
| 2970 </dd> | |
| 2971 </dl> | |
| 2972 <a NAME="Project.getProjectTypes" ID="Project.getProjectTypes"></a> | |
| 2973 <h4>Project.getProjectTypes</h4> | |
| 2974 <b>getProjectTypes</b>(<i>progLanguage=""</i>) | |
| 2975 | |
| 2976 <p> | |
| 2977 Public method to get the list of supported project types. | |
| 2978 </p> | |
| 2979 <dl> | |
| 2980 | |
| 2981 <dt><i>progLanguage</i></dt> | |
| 2982 <dd> | |
| 2983 programming language to get project types for | |
| 2984 (string) | |
| 2985 </dd> | |
| 2986 </dl> | |
| 2987 <dl> | |
| 2988 <dt>Return:</dt> | |
| 2989 <dd> | |
| 2990 reference to the dictionary of project types. | |
| 2991 </dd> | |
| 2992 </dl> | |
| 2993 <a NAME="Project.getProjectVenv" ID="Project.getProjectVenv"></a> | |
| 2994 <h4>Project.getProjectVenv</h4> | |
| 2995 <b>getProjectVenv</b>(<i>resolveDebugger=True</i>) | |
| 2996 | |
| 2997 <p> | |
| 2998 Public method to get the name of the virtual environment used by the | |
| 2999 project. | |
| 3000 </p> | |
| 3001 <dl> | |
| 3002 | |
| 3003 <dt><i>resolveDebugger</i> (bool)</dt> | |
| 3004 <dd> | |
| 3005 flag indicating to resolve the virtual | |
| 3006 environment name via the debugger settings if none was configured | |
| 3007 </dd> | |
| 3008 </dl> | |
| 3009 <dl> | |
| 3010 <dt>Return:</dt> | |
| 3011 <dd> | |
| 3012 name of the project's virtual environment | |
| 3013 </dd> | |
| 3014 </dl> | |
| 3015 <dl> | |
| 3016 <dt>Return Type:</dt> | |
| 3017 <dd> | |
| 3018 str | |
| 3019 </dd> | |
| 3020 </dl> | |
| 3021 <a NAME="Project.getProjectVersion" ID="Project.getProjectVersion"></a> | |
| 3022 <h4>Project.getProjectVersion</h4> | |
| 3023 <b>getProjectVersion</b>(<i></i>) | |
| 3024 | |
| 3025 <p> | |
| 3026 Public mehod to get the version number of the project. | |
| 3027 </p> | |
| 3028 <dl> | |
| 3029 <dt>Return:</dt> | |
| 3030 <dd> | |
| 3031 version number | |
| 3032 </dd> | |
| 3033 </dl> | |
| 3034 <dl> | |
| 3035 <dt>Return Type:</dt> | |
| 3036 <dd> | |
| 3037 str | |
| 3038 </dd> | |
| 3039 </dl> | |
| 3040 <a NAME="Project.getRelativePath" ID="Project.getRelativePath"></a> | |
| 3041 <h4>Project.getRelativePath</h4> | |
| 3042 <b>getRelativePath</b>(<i>path</i>) | |
| 3043 | |
| 3044 <p> | |
| 3045 Public method to convert a file path to a project relative | |
| 3046 file path. | |
| 3047 </p> | |
| 3048 <dl> | |
| 3049 | |
| 3050 <dt><i>path</i></dt> | |
| 3051 <dd> | |
| 3052 file or directory name to convert (string) | |
| 3053 </dd> | |
| 3054 </dl> | |
| 3055 <dl> | |
| 3056 <dt>Return:</dt> | |
| 3057 <dd> | |
| 3058 project relative path or unchanged path, if path doesn't | |
| 3059 belong to the project (string) | |
| 3060 </dd> | |
| 3061 </dl> | |
| 3062 <a NAME="Project.getRelativeUniversalPath" ID="Project.getRelativeUniversalPath"></a> | |
| 3063 <h4>Project.getRelativeUniversalPath</h4> | |
| 3064 <b>getRelativeUniversalPath</b>(<i>path</i>) | |
| 3065 | |
| 3066 <p> | |
| 3067 Public method to convert a file path to a project relative | |
| 3068 file path with universal separators. | |
| 3069 </p> | |
| 3070 <dl> | |
| 3071 | |
| 3072 <dt><i>path</i></dt> | |
| 3073 <dd> | |
| 3074 file or directory name to convert (string) | |
| 3075 </dd> | |
| 3076 </dl> | |
| 3077 <dl> | |
| 3078 <dt>Return:</dt> | |
| 3079 <dd> | |
| 3080 project relative path or unchanged path, if path doesn't | |
| 3081 belong to the project (string) | |
| 3082 </dd> | |
| 3083 </dl> | |
| 3084 <a NAME="Project.getSources" ID="Project.getSources"></a> | |
| 3085 <h4>Project.getSources</h4> | |
| 3086 <b>getSources</b>(<i>normalized=False</i>) | |
| 3087 | |
| 3088 <p> | |
| 3089 Public method to return the source script files. | |
| 3090 </p> | |
| 3091 <dl> | |
| 3092 | |
| 3093 <dt><i>normalized</i> (bool)</dt> | |
| 3094 <dd> | |
| 3095 flag indicating a normalized filename is wanted | |
| 3096 </dd> | |
| 3097 </dl> | |
| 3098 <dl> | |
| 3099 <dt>Return:</dt> | |
| 3100 <dd> | |
| 3101 list of the projects scripts | |
| 3102 </dd> | |
| 3103 </dl> | |
| 3104 <dl> | |
| 3105 <dt>Return Type:</dt> | |
| 3106 <dd> | |
| 3107 list of str | |
| 3108 </dd> | |
| 3109 </dl> | |
| 3110 <a NAME="Project.getStatusMonitorAutoUpdate" ID="Project.getStatusMonitorAutoUpdate"></a> | |
| 3111 <h4>Project.getStatusMonitorAutoUpdate</h4> | |
| 3112 <b>getStatusMonitorAutoUpdate</b>(<i></i>) | |
| 3113 | |
| 3114 <p> | |
| 3115 Public method to retrieve the status of the auto update function. | |
| 3116 </p> | |
| 3117 <dl> | |
| 3118 <dt>Return:</dt> | |
| 3119 <dd> | |
| 3120 status of the auto update function (boolean) | |
| 3121 </dd> | |
| 3122 </dl> | |
| 3123 <a NAME="Project.getStatusMonitorInterval" ID="Project.getStatusMonitorInterval"></a> | |
| 3124 <h4>Project.getStatusMonitorInterval</h4> | |
| 3125 <b>getStatusMonitorInterval</b>(<i></i>) | |
| 3126 | |
| 3127 <p> | |
| 3128 Public method to get the monitor interval. | |
| 3129 </p> | |
| 3130 <dl> | |
| 3131 <dt>Return:</dt> | |
| 3132 <dd> | |
| 3133 interval in seconds (integer) | |
| 3134 </dd> | |
| 3135 </dl> | |
| 3136 <a NAME="Project.getTranslationPattern" ID="Project.getTranslationPattern"></a> | |
| 3137 <h4>Project.getTranslationPattern</h4> | |
| 3138 <b>getTranslationPattern</b>(<i></i>) | |
| 3139 | |
| 3140 <p> | |
| 3141 Public method to get the translation pattern. | |
| 3142 </p> | |
| 3143 <dl> | |
| 3144 <dt>Return:</dt> | |
| 3145 <dd> | |
| 3146 translation pattern (string) | |
| 3147 </dd> | |
| 3148 </dl> | |
| 3149 <a NAME="Project.getUicParameter" ID="Project.getUicParameter"></a> | |
| 3150 <h4>Project.getUicParameter</h4> | |
| 3151 <b>getUicParameter</b>(<i>name</i>) | |
| 3152 | |
| 3153 <p> | |
| 3154 Public method to get a named uic related parameter. | |
| 3155 </p> | |
| 3156 <dl> | |
| 3157 | |
| 3158 <dt><i>name</i> (str)</dt> | |
| 3159 <dd> | |
| 3160 name of the parameter | |
| 3161 </dd> | |
| 3162 </dl> | |
| 3163 <dl> | |
| 3164 <dt>Return:</dt> | |
| 3165 <dd> | |
| 3166 value of the given parameter | |
| 3167 </dd> | |
| 3168 </dl> | |
| 3169 <dl> | |
| 3170 <dt>Return Type:</dt> | |
| 3171 <dd> | |
| 3172 any, None in case on non-existence | |
| 3173 </dd> | |
| 3174 </dl> | |
| 3175 <a NAME="Project.getVcs" ID="Project.getVcs"></a> | |
| 3176 <h4>Project.getVcs</h4> | |
| 3177 <b>getVcs</b>(<i></i>) | |
| 3178 | |
| 3179 <p> | |
| 3180 Public method to get a reference to the VCS object. | |
| 3181 </p> | |
| 3182 <dl> | |
| 3183 <dt>Return:</dt> | |
| 3184 <dd> | |
| 3185 reference to the VCS object | |
| 3186 </dd> | |
| 3187 </dl> | |
| 3188 <a NAME="Project.handleApplicationDiagram" ID="Project.handleApplicationDiagram"></a> | |
| 3189 <h4>Project.handleApplicationDiagram</h4> | |
| 3190 <b>handleApplicationDiagram</b>(<i></i>) | |
| 3191 | |
| 3192 <p> | |
| 3193 Public method to handle the application diagram context menu action. | |
| 3194 </p> | |
| 3195 <a NAME="Project.handlePreferencesChanged" ID="Project.handlePreferencesChanged"></a> | |
| 3196 <h4>Project.handlePreferencesChanged</h4> | |
| 3197 <b>handlePreferencesChanged</b>(<i></i>) | |
| 3198 | |
| 3199 <p> | |
| 3200 Public slot used to handle the preferencesChanged signal. | |
| 3201 </p> | |
| 3202 <a NAME="Project.hasDefaultDocstringParameter" ID="Project.hasDefaultDocstringParameter"></a> | |
| 3203 <h4>Project.hasDefaultDocstringParameter</h4> | |
| 3204 <b>hasDefaultDocstringParameter</b>(<i></i>) | |
| 3205 | |
| 3206 <p> | |
| 3207 Public method to test, if the project contains the default docstring | |
| 3208 parameter. | |
| 3209 </p> | |
| 3210 <dl> | |
| 3211 <dt>Return:</dt> | |
| 3212 <dd> | |
| 3213 flag indicating default parameter | |
| 3214 </dd> | |
| 3215 </dl> | |
| 3216 <dl> | |
| 3217 <dt>Return Type:</dt> | |
| 3218 <dd> | |
| 3219 bool | |
| 3220 </dd> | |
| 3221 </dl> | |
| 3222 <a NAME="Project.hasDefaultIdlCompilerParameters" ID="Project.hasDefaultIdlCompilerParameters"></a> | |
| 3223 <h4>Project.hasDefaultIdlCompilerParameters</h4> | |
| 3224 <b>hasDefaultIdlCompilerParameters</b>(<i></i>) | |
| 3225 | |
| 3226 <p> | |
| 3227 Public method to test, if the project contains the default IDL compiler | |
| 3228 parameters. | |
| 3229 </p> | |
| 3230 <dl> | |
| 3231 <dt>Return:</dt> | |
| 3232 <dd> | |
| 3233 flag indicating default parameter set | |
| 3234 </dd> | |
| 3235 </dl> | |
| 3236 <dl> | |
| 3237 <dt>Return Type:</dt> | |
| 3238 <dd> | |
| 3239 bool | |
| 3240 </dd> | |
| 3241 </dl> | |
| 3242 <a NAME="Project.hasDefaultMakeParameters" ID="Project.hasDefaultMakeParameters"></a> | |
| 3243 <h4>Project.hasDefaultMakeParameters</h4> | |
| 3244 <b>hasDefaultMakeParameters</b>(<i></i>) | |
| 3245 | |
| 3246 <p> | |
| 3247 Public method to test, if the project contains the default make | |
| 3248 parameters. | |
| 3249 </p> | |
| 3250 <dl> | |
| 3251 <dt>Return:</dt> | |
| 3252 <dd> | |
| 3253 flag indicating default parameter set | |
| 3254 </dd> | |
| 3255 </dl> | |
| 3256 <dl> | |
| 3257 <dt>Return Type:</dt> | |
| 3258 <dd> | |
| 3259 bool | |
| 3260 </dd> | |
| 3261 </dl> | |
| 3262 <a NAME="Project.hasDefaultRccCompilerParameters" ID="Project.hasDefaultRccCompilerParameters"></a> | |
| 3263 <h4>Project.hasDefaultRccCompilerParameters</h4> | |
| 3264 <b>hasDefaultRccCompilerParameters</b>(<i></i>) | |
| 3265 | |
| 3266 <p> | |
| 3267 Public method to test, if the project contains the default rcc compiler | |
| 3268 parameters. | |
| 3269 </p> | |
| 3270 <dl> | |
| 3271 <dt>Return:</dt> | |
| 3272 <dd> | |
| 3273 flag indicating default parameter set | |
| 3274 </dd> | |
| 3275 </dl> | |
| 3276 <dl> | |
| 3277 <dt>Return Type:</dt> | |
| 3278 <dd> | |
| 3279 bool | |
| 3280 </dd> | |
| 3281 </dl> | |
| 3282 <a NAME="Project.hasDefaultUicCompilerParameters" ID="Project.hasDefaultUicCompilerParameters"></a> | |
| 3283 <h4>Project.hasDefaultUicCompilerParameters</h4> | |
| 3284 <b>hasDefaultUicCompilerParameters</b>(<i></i>) | |
| 3285 | |
| 3286 <p> | |
| 3287 Public method to test, if the project contains the default uic compiler | |
| 3288 parameters. | |
| 3289 </p> | |
| 3290 <dl> | |
| 3291 <dt>Return:</dt> | |
| 3292 <dd> | |
| 3293 flag indicating default parameter set | |
| 3294 </dd> | |
| 3295 </dl> | |
| 3296 <dl> | |
| 3297 <dt>Return Type:</dt> | |
| 3298 <dd> | |
| 3299 bool | |
| 3300 </dd> | |
| 3301 </dl> | |
| 3302 <a NAME="Project.hasEntry" ID="Project.hasEntry"></a> | |
| 3303 <h4>Project.hasEntry</h4> | |
| 3304 <b>hasEntry</b>(<i>fn</i>) | |
| 3305 | |
| 3306 <p> | |
| 3307 Public method to check the project for a file. | |
| 3308 </p> | |
| 3309 <dl> | |
| 3310 | |
| 3311 <dt><i>fn</i></dt> | |
| 3312 <dd> | |
| 3313 filename to be checked (string) | |
| 3314 </dd> | |
| 3315 </dl> | |
| 3316 <dl> | |
| 3317 <dt>Return:</dt> | |
| 3318 <dd> | |
| 3319 flag indicating, if the project contains the file (boolean) | |
| 3320 </dd> | |
| 3321 </dl> | |
| 3322 <a NAME="Project.hasProjectType" ID="Project.hasProjectType"></a> | |
| 3323 <h4>Project.hasProjectType</h4> | |
| 3324 <b>hasProjectType</b>(<i>type_, progLanguage=""</i>) | |
| 3325 | |
| 3326 <p> | |
| 3327 Public method to check, if a project type is already registered. | |
| 3328 </p> | |
| 3329 <dl> | |
| 3330 | |
| 3331 <dt><i>type_</i></dt> | |
| 3332 <dd> | |
| 3333 internal type designator (string) | |
| 3334 </dd> | |
| 3335 <dt><i>progLanguage</i></dt> | |
| 3336 <dd> | |
| 3337 programming language of the project type (string) | |
| 3338 </dd> | |
| 3339 </dl> | |
| 3340 <dl> | |
| 3341 <dt>Return:</dt> | |
| 3342 <dd> | |
| 3343 flag indicating presence of the project type (boolean) | |
| 3344 </dd> | |
| 3345 </dl> | |
| 3346 <a NAME="Project.initActions" ID="Project.initActions"></a> | |
| 3347 <h4>Project.initActions</h4> | |
| 3348 <b>initActions</b>(<i></i>) | |
| 3349 | |
| 3350 <p> | |
| 3351 Public slot to initialize the project related actions. | |
| 3352 </p> | |
| 3353 <a NAME="Project.initFileTypes" ID="Project.initFileTypes"></a> | |
| 3354 <h4>Project.initFileTypes</h4> | |
| 3355 <b>initFileTypes</b>(<i></i>) | |
| 3356 | |
| 3357 <p> | |
| 3358 Public method to initialize the filetype associations with default | |
| 3359 values. | |
| 3360 </p> | |
| 3361 <a NAME="Project.initMenus" ID="Project.initMenus"></a> | |
| 3362 <h4>Project.initMenus</h4> | |
| 3363 <b>initMenus</b>(<i></i>) | |
| 3364 | |
| 3365 <p> | |
| 3366 Public slot to initialize the project menus. | |
| 3367 </p> | |
| 3368 <dl> | |
| 3369 <dt>Return:</dt> | |
| 3370 <dd> | |
| 3371 tuple of generated menus | |
| 3372 </dd> | |
| 3373 </dl> | |
| 3374 <dl> | |
| 3375 <dt>Return Type:</dt> | |
| 3376 <dd> | |
| 3377 tuple of (QMenu, QMenu) | |
| 3378 </dd> | |
| 3379 </dl> | |
| 3380 <a NAME="Project.initToolbars" ID="Project.initToolbars"></a> | |
| 3381 <h4>Project.initToolbars</h4> | |
| 3382 <b>initToolbars</b>(<i>toolbarManager</i>) | |
| 3383 | |
| 3384 <p> | |
| 3385 Public slot to initialize the project toolbar and the basic VCS | |
| 3386 toolbar. | |
| 3387 </p> | |
| 3388 <dl> | |
| 3389 | |
| 3390 <dt><i>toolbarManager</i></dt> | |
| 3391 <dd> | |
| 3392 reference to a toolbar manager object | |
| 3393 (EricToolBarManager) | |
| 3394 </dd> | |
| 3395 </dl> | |
| 3396 <dl> | |
| 3397 <dt>Return:</dt> | |
| 3398 <dd> | |
| 3399 tuple of the generated toolbars (tuple of two QToolBar) | |
| 3400 </dd> | |
| 3401 </dl> | |
| 3402 <a NAME="Project.initVCS" ID="Project.initVCS"></a> | |
| 3403 <h4>Project.initVCS</h4> | |
| 3404 <b>initVCS</b>(<i>vcsSystem=None, nooverride=False</i>) | |
| 3405 | |
| 3406 <p> | |
| 3407 Public method used to instantiate a vcs system. | |
| 3408 </p> | |
| 3409 <dl> | |
| 3410 | |
| 3411 <dt><i>vcsSystem</i></dt> | |
| 3412 <dd> | |
| 3413 type of VCS to be used (string) | |
| 3414 </dd> | |
| 3415 <dt><i>nooverride</i></dt> | |
| 3416 <dd> | |
| 3417 flag indicating to ignore an override request | |
| 3418 (boolean) | |
| 3419 </dd> | |
| 3420 </dl> | |
| 3421 <dl> | |
| 3422 <dt>Return:</dt> | |
| 3423 <dd> | |
| 3424 a reference to the vcs object | |
| 3425 </dd> | |
| 3426 </dl> | |
| 3427 <a NAME="Project.isDebugPropertiesLoaded" ID="Project.isDebugPropertiesLoaded"></a> | |
| 3428 <h4>Project.isDebugPropertiesLoaded</h4> | |
| 3429 <b>isDebugPropertiesLoaded</b>(<i></i>) | |
| 3430 | |
| 3431 <p> | |
| 3432 Public method to return the status of the debug properties. | |
| 3433 </p> | |
| 3434 <dl> | |
| 3435 <dt>Return:</dt> | |
| 3436 <dd> | |
| 3437 load status of debug properties (boolean) | |
| 3438 </dd> | |
| 3439 </dl> | |
| 3440 <a NAME="Project.isDirty" ID="Project.isDirty"></a> | |
| 3441 <h4>Project.isDirty</h4> | |
| 3442 <b>isDirty</b>(<i></i>) | |
| 3443 | |
| 3444 <p> | |
| 3445 Public method to return the dirty state. | |
| 3446 </p> | |
| 3447 <dl> | |
| 3448 <dt>Return:</dt> | |
| 3449 <dd> | |
| 3450 dirty state (boolean) | |
| 3451 </dd> | |
| 3452 </dl> | |
| 3453 <a NAME="Project.isJavaScriptProject" ID="Project.isJavaScriptProject"></a> | |
| 3454 <h4>Project.isJavaScriptProject</h4> | |
| 3455 <b>isJavaScriptProject</b>(<i></i>) | |
| 3456 | |
| 3457 <p> | |
| 3458 Public method to check, if this project is a JavaScript project. | |
| 3459 </p> | |
| 3460 <dl> | |
| 3461 <dt>Return:</dt> | |
| 3462 <dd> | |
| 3463 flag indicating a JavaScript project (boolean) | |
| 3464 </dd> | |
| 3465 </dl> | |
| 3466 <a NAME="Project.isMakeEnabled" ID="Project.isMakeEnabled"></a> | |
| 3467 <h4>Project.isMakeEnabled</h4> | |
| 3468 <b>isMakeEnabled</b>(<i></i>) | |
| 3469 | |
| 3470 <p> | |
| 3471 Public method to test, if make is enabled for the project. | |
| 3472 </p> | |
| 3473 <dl> | |
| 3474 <dt>Return:</dt> | |
| 3475 <dd> | |
| 3476 flag indicating enabled make support | |
| 3477 </dd> | |
| 3478 </dl> | |
| 3479 <dl> | |
| 3480 <dt>Return Type:</dt> | |
| 3481 <dd> | |
| 3482 bool | |
| 3483 </dd> | |
| 3484 </dl> | |
| 3485 <a NAME="Project.isMicroPythonProject" ID="Project.isMicroPythonProject"></a> | |
| 3486 <h4>Project.isMicroPythonProject</h4> | |
| 3487 <b>isMicroPythonProject</b>(<i></i>) | |
| 3488 | |
| 3489 <p> | |
| 3490 Public method to check, if this project is a MicroPython project. | |
| 3491 </p> | |
| 3492 <dl> | |
| 3493 <dt>Return:</dt> | |
| 3494 <dd> | |
| 3495 flag indicating a MicroPython project | |
| 3496 </dd> | |
| 3497 </dl> | |
| 3498 <dl> | |
| 3499 <dt>Return Type:</dt> | |
| 3500 <dd> | |
| 3501 bool | |
| 3502 </dd> | |
| 3503 </dl> | |
| 3504 <a NAME="Project.isMixedLanguageProject" ID="Project.isMixedLanguageProject"></a> | |
| 3505 <h4>Project.isMixedLanguageProject</h4> | |
| 3506 <b>isMixedLanguageProject</b>(<i></i>) | |
| 3507 | |
| 3508 <p> | |
| 3509 Public method to check, if this is a mixed language project. | |
| 3510 </p> | |
| 3511 <dl> | |
| 3512 <dt>Return:</dt> | |
| 3513 <dd> | |
| 3514 flag indicating a mixed language project | |
| 3515 </dd> | |
| 3516 </dl> | |
| 3517 <dl> | |
| 3518 <dt>Return Type:</dt> | |
| 3519 <dd> | |
| 3520 bool | |
| 3521 </dd> | |
| 3522 </dl> | |
| 3523 <a NAME="Project.isOpen" ID="Project.isOpen"></a> | |
| 3524 <h4>Project.isOpen</h4> | |
| 3525 <b>isOpen</b>(<i></i>) | |
| 3526 | |
| 3527 <p> | |
| 3528 Public method to return the opened state. | |
| 3529 </p> | |
| 3530 <dl> | |
| 3531 <dt>Return:</dt> | |
| 3532 <dd> | |
| 3533 open state (boolean) | |
| 3534 </dd> | |
| 3535 </dl> | |
| 3536 <a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a> | |
| 3537 <h4>Project.isProjectFile</h4> | |
| 3538 <b>isProjectFile</b>(<i>fn</i>) | |
| 3539 | |
| 3540 <p> | |
| 3541 Public method used to check, if the passed in filename belongs to the | |
| 3542 project. | |
| 3543 </p> | |
| 3544 <dl> | |
| 3545 | |
| 3546 <dt><i>fn</i></dt> | |
| 3547 <dd> | |
| 3548 filename to be checked (string) | |
| 3549 </dd> | |
| 3550 </dl> | |
| 3551 <dl> | |
| 3552 <dt>Return:</dt> | |
| 3553 <dd> | |
| 3554 flag indicating membership (boolean) | |
| 3555 </dd> | |
| 3556 </dl> | |
| 3557 <a NAME="Project.isProjectForm" ID="Project.isProjectForm"></a> | |
| 3558 <h4>Project.isProjectForm</h4> | |
| 3559 <b>isProjectForm</b>(<i>fn</i>) | |
| 3560 | |
| 3561 <p> | |
| 3562 Public method used to check, if the passed in filename belongs to the | |
| 3563 project forms. | |
| 3564 </p> | |
| 3565 <dl> | |
| 3566 | |
| 3567 <dt><i>fn</i></dt> | |
| 3568 <dd> | |
| 3569 filename to be checked (string) | |
| 3570 </dd> | |
| 3571 </dl> | |
| 3572 <dl> | |
| 3573 <dt>Return:</dt> | |
| 3574 <dd> | |
| 3575 flag indicating membership (boolean) | |
| 3576 </dd> | |
| 3577 </dl> | |
| 3578 <a NAME="Project.isProjectInterface" ID="Project.isProjectInterface"></a> | |
| 3579 <h4>Project.isProjectInterface</h4> | |
| 3580 <b>isProjectInterface</b>(<i>fn</i>) | |
| 3581 | |
| 3582 <p> | |
| 3583 Public method used to check, if the passed in filename belongs to the | |
| 3584 project interfaces. | |
| 3585 </p> | |
| 3586 <dl> | |
| 3587 | |
| 3588 <dt><i>fn</i></dt> | |
| 3589 <dd> | |
| 3590 filename to be checked (string) | |
| 3591 </dd> | |
| 3592 </dl> | |
| 3593 <dl> | |
| 3594 <dt>Return:</dt> | |
| 3595 <dd> | |
| 3596 flag indicating membership (boolean) | |
| 3597 </dd> | |
| 3598 </dl> | |
| 3599 <a NAME="Project.isProjectProtocol" ID="Project.isProjectProtocol"></a> | |
| 3600 <h4>Project.isProjectProtocol</h4> | |
| 3601 <b>isProjectProtocol</b>(<i>fn</i>) | |
| 3602 | |
| 3603 <p> | |
| 3604 Public method used to check, if the passed in filename belongs to the | |
| 3605 project protocols. | |
| 3606 </p> | |
| 3607 <dl> | |
| 3608 | |
| 3609 <dt><i>fn</i> (str)</dt> | |
| 3610 <dd> | |
| 3611 filename to be checked | |
| 3612 </dd> | |
| 3613 </dl> | |
| 3614 <dl> | |
| 3615 <dt>Return:</dt> | |
| 3616 <dd> | |
| 3617 flag indicating membership | |
| 3618 </dd> | |
| 3619 </dl> | |
| 3620 <dl> | |
| 3621 <dt>Return Type:</dt> | |
| 3622 <dd> | |
| 3623 bool | |
| 3624 </dd> | |
| 3625 </dl> | |
| 3626 <a NAME="Project.isProjectResource" ID="Project.isProjectResource"></a> | |
| 3627 <h4>Project.isProjectResource</h4> | |
| 3628 <b>isProjectResource</b>(<i>fn</i>) | |
| 3629 | |
| 3630 <p> | |
| 3631 Public method used to check, if the passed in filename belongs to the | |
| 3632 project resources. | |
| 3633 </p> | |
| 3634 <dl> | |
| 3635 | |
| 3636 <dt><i>fn</i></dt> | |
| 3637 <dd> | |
| 3638 filename to be checked (string) | |
| 3639 </dd> | |
| 3640 </dl> | |
| 3641 <dl> | |
| 3642 <dt>Return:</dt> | |
| 3643 <dd> | |
| 3644 flag indicating membership (boolean) | |
| 3645 </dd> | |
| 3646 </dl> | |
| 3647 <a NAME="Project.isProjectSource" ID="Project.isProjectSource"></a> | |
| 3648 <h4>Project.isProjectSource</h4> | |
| 3649 <b>isProjectSource</b>(<i>fn</i>) | |
| 3650 | |
| 3651 <p> | |
| 3652 Public method used to check, if the passed in filename belongs to the | |
| 3653 project sources. | |
| 3654 </p> | |
| 3655 <dl> | |
| 3656 | |
| 3657 <dt><i>fn</i></dt> | |
| 3658 <dd> | |
| 3659 filename to be checked (string) | |
| 3660 </dd> | |
| 3661 </dl> | |
| 3662 <dl> | |
| 3663 <dt>Return:</dt> | |
| 3664 <dd> | |
| 3665 flag indicating membership (boolean) | |
| 3666 </dd> | |
| 3667 </dl> | |
| 3668 <a NAME="Project.isPy3Project" ID="Project.isPy3Project"></a> | |
| 3669 <h4>Project.isPy3Project</h4> | |
| 3670 <b>isPy3Project</b>(<i></i>) | |
| 3671 | |
| 3672 <p> | |
| 3673 Public method to check, if this project is a Python3 project. | |
| 3674 </p> | |
| 3675 <dl> | |
| 3676 <dt>Return:</dt> | |
| 3677 <dd> | |
| 3678 flag indicating a Python3 project (boolean) | |
| 3679 </dd> | |
| 3680 </dl> | |
| 3681 <a NAME="Project.isPythonProject" ID="Project.isPythonProject"></a> | |
| 3682 <h4>Project.isPythonProject</h4> | |
| 3683 <b>isPythonProject</b>(<i></i>) | |
| 3684 | |
| 3685 <p> | |
| 3686 Public method to check, if this project is a Python3 or MicroPython | |
| 3687 project. | |
| 3688 </p> | |
| 3689 <dl> | |
| 3690 <dt>Return:</dt> | |
| 3691 <dd> | |
| 3692 flag indicating a Python project (boolean) | |
| 3693 </dd> | |
| 3694 </dl> | |
| 3695 <a NAME="Project.isRubyProject" ID="Project.isRubyProject"></a> | |
| 3696 <h4>Project.isRubyProject</h4> | |
| 3697 <b>isRubyProject</b>(<i></i>) | |
| 3698 | |
| 3699 <p> | |
| 3700 Public method to check, if this project is a Ruby project. | |
| 3701 </p> | |
| 3702 <dl> | |
| 3703 <dt>Return:</dt> | |
| 3704 <dd> | |
| 3705 flag indicating a Ruby project (boolean) | |
| 3706 </dd> | |
| 3707 </dl> | |
| 3708 <a NAME="Project.moveDirectory" ID="Project.moveDirectory"></a> | |
| 3709 <h4>Project.moveDirectory</h4> | |
| 3710 <b>moveDirectory</b>(<i>olddn, newdn</i>) | |
| 3711 | |
| 3712 <p> | |
| 3713 Public slot to move a directory. | |
| 3714 </p> | |
| 3715 <dl> | |
| 3716 | |
| 3717 <dt><i>olddn</i></dt> | |
| 3718 <dd> | |
| 3719 old directory name (string) | |
| 3720 </dd> | |
| 3721 <dt><i>newdn</i></dt> | |
| 3722 <dd> | |
| 3723 new directory name (string) | |
| 3724 </dd> | |
| 3725 </dl> | |
| 3726 <a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a> | |
| 3727 <h4>Project.newProjectAddFiles</h4> | |
| 3728 <b>newProjectAddFiles</b>(<i>mainscript</i>) | |
| 3729 | |
| 3730 <p> | |
| 3731 Public method to add files to a new project. | |
| 3732 </p> | |
| 3733 <dl> | |
| 3734 | |
| 3735 <dt><i>mainscript</i></dt> | |
| 3736 <dd> | |
| 3737 name of the mainscript (string) | |
| 3738 </dd> | |
| 3739 </dl> | |
| 3740 <a NAME="Project.openProject" ID="Project.openProject"></a> | |
| 3741 <h4>Project.openProject</h4> | |
| 3742 <b>openProject</b>(<i>fn=None, restoreSession=True, reopen=False</i>) | |
| 3743 | |
| 3744 <p> | |
| 3745 Public slot to open a project. | |
| 3746 </p> | |
| 3747 <dl> | |
| 3748 | |
| 3749 <dt><i>fn</i></dt> | |
| 3750 <dd> | |
| 3751 optional filename of the project file to be read | |
| 3752 </dd> | |
| 3753 <dt><i>restoreSession</i></dt> | |
| 3754 <dd> | |
| 3755 flag indicating to restore the project | |
| 3756 session (boolean) | |
| 3757 </dd> | |
| 3758 <dt><i>reopen</i></dt> | |
| 3759 <dd> | |
| 3760 flag indicating a reopening of the project (boolean) | |
| 3761 </dd> | |
| 3762 </dl> | |
| 3763 <a NAME="Project.othersAdded" ID="Project.othersAdded"></a> | |
| 3764 <h4>Project.othersAdded</h4> | |
| 3765 <b>othersAdded</b>(<i>fn, updateModel=True</i>) | |
| 3766 | |
| 3767 <p> | |
| 3768 Public slot to be called, if something was added to the OTHERS project | |
| 3769 data area. | |
| 3770 </p> | |
| 3771 <dl> | |
| 3772 | |
| 3773 <dt><i>fn</i></dt> | |
| 3774 <dd> | |
| 3775 filename or directory name added (string) | |
| 3776 </dd> | |
| 3777 <dt><i>updateModel</i></dt> | |
| 3778 <dd> | |
| 3779 flag indicating an update of the model is requested | |
| 3780 (boolean) | |
| 3781 </dd> | |
| 3782 </dl> | |
| 3783 <a NAME="Project.registerProjectType" ID="Project.registerProjectType"></a> | |
| 3784 <h4>Project.registerProjectType</h4> | |
| 3785 <b>registerProjectType</b>(<i>type_, description, fileTypeCallback=None, binaryTranslationsCallback=None, lexerAssociationCallback=None, progLanguages=None</i>) | |
| 3786 | |
| 3787 <p> | |
| 3788 Public method to register a project type. | |
| 3789 </p> | |
| 3790 <dl> | |
| 3791 | |
| 3792 <dt><i>type_</i></dt> | |
| 3793 <dd> | |
| 3794 internal type designator to be registered (string) | |
| 3795 </dd> | |
| 3796 <dt><i>description</i></dt> | |
| 3797 <dd> | |
| 3798 more verbose type name (display string) (string) | |
| 3799 </dd> | |
| 3800 <dt><i>fileTypeCallback</i></dt> | |
| 3801 <dd> | |
| 3802 reference to a method returning a dictionary | |
| 3803 of filetype associations. | |
| 3804 </dd> | |
| 3805 <dt><i>binaryTranslationsCallback</i></dt> | |
| 3806 <dd> | |
| 3807 reference to a method returning | |
| 3808 the name of the binary translation file given the name of the raw | |
| 3809 translation file | |
| 3810 </dd> | |
| 3811 <dt><i>lexerAssociationCallback</i></dt> | |
| 3812 <dd> | |
| 3813 reference to a method returning the | |
| 3814 lexer type to be used for syntax highlighting given the name of | |
| 3815 a file | |
| 3816 </dd> | |
| 3817 <dt><i>progLanguages</i></dt> | |
| 3818 <dd> | |
| 3819 programming languages supported by the | |
| 3820 project type (list of string) | |
| 3821 </dd> | |
| 3822 </dl> | |
| 3823 <a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a> | |
| 3824 <h4>Project.removeDirectory</h4> | |
| 3825 <b>removeDirectory</b>(<i>dn</i>) | |
| 3826 | |
| 3827 <p> | |
| 3828 Public method to remove a directory from the project. | |
| 3829 </p> | |
| 3830 <p> | |
| 3831 The directory is not deleted from the project directory. | |
| 3832 </p> | |
| 3833 <dl> | |
| 3834 | |
| 3835 <dt><i>dn</i></dt> | |
| 3836 <dd> | |
| 3837 directory name to be removed from the project | |
| 3838 </dd> | |
| 3839 </dl> | |
| 3840 <a NAME="Project.removeEricActions" ID="Project.removeEricActions"></a> | |
| 3841 <h4>Project.removeEricActions</h4> | |
| 3842 <b>removeEricActions</b>(<i>actions</i>) | |
| 3843 | |
| 3844 <p> | |
| 3845 Public method to remove actions from the list of actions. | |
| 3846 </p> | |
| 3847 <dl> | |
| 3848 | |
| 3849 <dt><i>actions</i></dt> | |
| 3850 <dd> | |
| 3851 list of actions (list of EricAction) | |
| 3852 </dd> | |
| 3853 </dl> | |
| 3854 <a NAME="Project.removeFile" ID="Project.removeFile"></a> | |
| 3855 <h4>Project.removeFile</h4> | |
| 3856 <b>removeFile</b>(<i>fn, updateModel=True</i>) | |
| 3857 | |
| 3858 <p> | |
| 3859 Public slot to remove a file from the project. | |
| 3860 </p> | |
| 3861 <p> | |
| 3862 The file is not deleted from the project directory. | |
| 3863 </p> | |
| 3864 <dl> | |
| 3865 | |
| 3866 <dt><i>fn</i></dt> | |
| 3867 <dd> | |
| 3868 filename to be removed from the project | |
| 3869 </dd> | |
| 3870 <dt><i>updateModel</i></dt> | |
| 3871 <dd> | |
| 3872 flag indicating an update of the model is | |
| 3873 requested (boolean) | |
| 3874 </dd> | |
| 3875 </dl> | |
| 3876 <a NAME="Project.removeLanguageFile" ID="Project.removeLanguageFile"></a> | |
| 3877 <h4>Project.removeLanguageFile</h4> | |
| 3878 <b>removeLanguageFile</b>(<i>langFile</i>) | |
| 3879 | |
| 3880 <p> | |
| 3881 Public slot to remove a translation from the project. | |
| 3882 </p> | |
| 3883 <p> | |
| 3884 The translation file is not deleted from the project directory. | |
| 3885 </p> | |
| 3886 <dl> | |
| 3887 | |
| 3888 <dt><i>langFile</i></dt> | |
| 3889 <dd> | |
| 3890 the translation file to be removed (string) | |
| 3891 </dd> | |
| 3892 </dl> | |
| 3893 <a NAME="Project.renameFile" ID="Project.renameFile"></a> | |
| 3894 <h4>Project.renameFile</h4> | |
| 3895 <b>renameFile</b>(<i>oldfn, newfn=None</i>) | |
| 3896 | |
| 3897 <p> | |
| 3898 Public slot to rename a file of the project. | |
| 3899 </p> | |
| 3900 <dl> | |
| 3901 | |
| 3902 <dt><i>oldfn</i></dt> | |
| 3903 <dd> | |
| 3904 old filename of the file (string) | |
| 3905 </dd> | |
| 3906 <dt><i>newfn</i></dt> | |
| 3907 <dd> | |
| 3908 new filename of the file (string) | |
| 3909 </dd> | |
| 3910 </dl> | |
| 3911 <dl> | |
| 3912 <dt>Return:</dt> | |
| 3913 <dd> | |
| 3914 flag indicating success | |
| 3915 </dd> | |
| 3916 </dl> | |
| 3917 <a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a> | |
| 3918 <h4>Project.renameFileInPdata</h4> | |
| 3919 <b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile=False</i>) | |
| 3920 | |
| 3921 <p> | |
| 3922 Public method to rename a file in the pdata structure. | |
| 3923 </p> | |
| 3924 <dl> | |
| 3925 | |
| 3926 <dt><i>oldname</i></dt> | |
| 3927 <dd> | |
| 3928 old filename (string) | |
| 3929 </dd> | |
| 3930 <dt><i>newname</i></dt> | |
| 3931 <dd> | |
| 3932 new filename (string) | |
| 3933 </dd> | |
| 3934 <dt><i>isSourceFile</i></dt> | |
| 3935 <dd> | |
| 3936 flag indicating that this is a source file | |
| 3937 even if it doesn't have the source extension (boolean) | |
| 3938 </dd> | |
| 3939 </dl> | |
| 3940 <a NAME="Project.renameMainScript" ID="Project.renameMainScript"></a> | |
| 3941 <h4>Project.renameMainScript</h4> | |
| 3942 <b>renameMainScript</b>(<i>oldfn, newfn</i>) | |
| 3943 | |
| 3944 <p> | |
| 3945 Public method to rename the main script. | |
| 3946 </p> | |
| 3947 <dl> | |
| 3948 | |
| 3949 <dt><i>oldfn</i></dt> | |
| 3950 <dd> | |
| 3951 old filename (string) | |
| 3952 </dd> | |
| 3953 <dt><i>newfn</i></dt> | |
| 3954 <dd> | |
| 3955 new filename of the main script (string) | |
| 3956 </dd> | |
| 3957 </dl> | |
| 3958 <a NAME="Project.reopenProject" ID="Project.reopenProject"></a> | |
| 3959 <h4>Project.reopenProject</h4> | |
| 3960 <b>reopenProject</b>(<i></i>) | |
| 3961 | |
| 3962 <p> | |
| 3963 Public slot to reopen the current project. | |
| 3964 </p> | |
| 3965 <a NAME="Project.repopulateItem" ID="Project.repopulateItem"></a> | |
| 3966 <h4>Project.repopulateItem</h4> | |
| 3967 <b>repopulateItem</b>(<i>fullname</i>) | |
| 3968 | |
| 3969 <p> | |
| 3970 Public slot to repopulate a named item. | |
| 3971 </p> | |
| 3972 <dl> | |
| 3973 | |
| 3974 <dt><i>fullname</i></dt> | |
| 3975 <dd> | |
| 3976 full name of the item to repopulate (string) | |
| 3977 </dd> | |
| 3978 </dl> | |
| 3979 <a NAME="Project.resetVCS" ID="Project.resetVCS"></a> | |
| 3980 <h4>Project.resetVCS</h4> | |
| 3981 <b>resetVCS</b>(<i></i>) | |
| 3982 | |
| 3983 <p> | |
| 3984 Public method to reset the VCS. | |
| 3985 </p> | |
| 3986 <a NAME="Project.saveAllScripts" ID="Project.saveAllScripts"></a> | |
| 3987 <h4>Project.saveAllScripts</h4> | |
| 3988 <b>saveAllScripts</b>(<i>reportSyntaxErrors=False</i>) | |
| 3989 | |
| 3990 <p> | |
| 3991 Public method to save all scripts belonging to the project. | |
| 3992 </p> | |
| 3993 <dl> | |
| 3994 | |
| 3995 <dt><i>reportSyntaxErrors</i></dt> | |
| 3996 <dd> | |
| 3997 flag indicating special reporting | |
| 3998 for syntax errors (boolean) | |
| 3999 </dd> | |
| 4000 </dl> | |
| 4001 <dl> | |
| 4002 <dt>Return:</dt> | |
| 4003 <dd> | |
| 4004 flag indicating success (boolean) | |
| 4005 </dd> | |
| 4006 </dl> | |
| 4007 <a NAME="Project.saveProject" ID="Project.saveProject"></a> | |
| 4008 <h4>Project.saveProject</h4> | |
| 4009 <b>saveProject</b>(<i></i>) | |
| 4010 | |
| 4011 <p> | |
| 4012 Public slot to save the current project. | |
| 4013 </p> | |
| 4014 <dl> | |
| 4015 <dt>Return:</dt> | |
| 4016 <dd> | |
| 4017 flag indicating success | |
| 4018 </dd> | |
| 4019 </dl> | |
| 4020 <a NAME="Project.saveProjectAs" ID="Project.saveProjectAs"></a> | |
| 4021 <h4>Project.saveProjectAs</h4> | |
| 4022 <b>saveProjectAs</b>(<i></i>) | |
| 4023 | |
| 4024 <p> | |
| 4025 Public slot to save the current project to a different file. | |
| 4026 </p> | |
| 4027 <dl> | |
| 4028 <dt>Return:</dt> | |
| 4029 <dd> | |
| 4030 flag indicating success (boolean) | |
| 4031 </dd> | |
| 4032 </dl> | |
| 4033 <a NAME="Project.setData" ID="Project.setData"></a> | |
| 4034 <h4>Project.setData</h4> | |
| 4035 <b>setData</b>(<i>category, key, data</i>) | |
| 4036 | |
| 4037 <p> | |
| 4038 Public method to store data in the project data store. | |
| 4039 </p> | |
| 4040 <dl> | |
| 4041 | |
| 4042 <dt><i>category</i></dt> | |
| 4043 <dd> | |
| 4044 category of the data to get (string, one of | |
| 4045 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS, | |
| 4046 DOCUMENTATIONPARMS or OTHERTOOLSPARMS) | |
| 4047 </dd> | |
| 4048 <dt><i>key</i></dt> | |
| 4049 <dd> | |
| 4050 key of the data entry to get (string). | |
| 4051 </dd> | |
| 4052 <dt><i>data</i></dt> | |
| 4053 <dd> | |
| 4054 data to be stored | |
| 4055 </dd> | |
| 4056 </dl> | |
| 4057 <dl> | |
| 4058 <dt>Return:</dt> | |
| 4059 <dd> | |
| 4060 flag indicating success (boolean) | |
| 4061 </dd> | |
| 4062 </dl> | |
| 4063 <a NAME="Project.setDbgInfo" ID="Project.setDbgInfo"></a> | |
| 4064 <h4>Project.setDbgInfo</h4> | |
| 4065 <b>setDbgInfo</b>(<i>venvName, argv, wd, env, excReporting, excList, excIgnoreList, autoClearShell, tracePython=None, autoContinue=None, enableMultiprocess=None, multiprocessNoDebug=None, configOverride=None</i>) | |
| 4066 | |
| 4067 <p> | |
| 4068 Public method to set the debugging information. | |
| 4069 </p> | |
| 4070 <dl> | |
| 4071 | |
| 4072 <dt><i>venvName</i> (str)</dt> | |
| 4073 <dd> | |
| 4074 name of the virtual environment used | |
| 4075 </dd> | |
| 4076 <dt><i>argv</i> (str)</dt> | |
| 4077 <dd> | |
| 4078 command line arguments to be used | |
| 4079 </dd> | |
| 4080 <dt><i>wd</i> (str)</dt> | |
| 4081 <dd> | |
| 4082 working directory | |
| 4083 </dd> | |
| 4084 <dt><i>env</i> (str)</dt> | |
| 4085 <dd> | |
| 4086 environment setting | |
| 4087 </dd> | |
| 4088 <dt><i>excReporting</i> (bool)</dt> | |
| 4089 <dd> | |
| 4090 flag indicating the highlighting of exceptions | |
| 4091 </dd> | |
| 4092 <dt><i>excList</i> (list of str)</dt> | |
| 4093 <dd> | |
| 4094 list of exceptions to be highlighted | |
| 4095 </dd> | |
| 4096 <dt><i>excIgnoreList</i> (list of str)</dt> | |
| 4097 <dd> | |
| 4098 list of exceptions to be ignored | |
| 4099 </dd> | |
| 4100 <dt><i>autoClearShell</i> (bool)</dt> | |
| 4101 <dd> | |
| 4102 flag indicating, that the interpreter window | |
| 4103 should be cleared | |
| 4104 </dd> | |
| 4105 <dt><i>tracePython</i> (bool)</dt> | |
| 4106 <dd> | |
| 4107 flag to indicate if the Python library should be | |
| 4108 traced as well | |
| 4109 </dd> | |
| 4110 <dt><i>autoContinue</i> (bool)</dt> | |
| 4111 <dd> | |
| 4112 flag indicating, that the debugger should not | |
| 4113 stop at the first executable line | |
| 4114 </dd> | |
| 4115 <dt><i>enableMultiprocess</i> (bool)</dt> | |
| 4116 <dd> | |
| 4117 flag indicating, that the debugger should | |
| 4118 run in multi process mode | |
| 4119 </dd> | |
| 4120 <dt><i>multiprocessNoDebug</i> (str)</dt> | |
| 4121 <dd> | |
| 4122 list of programs not to be debugged in | |
| 4123 multi process mode | |
| 4124 </dd> | |
| 4125 <dt><i>configOverride</i> (dict)</dt> | |
| 4126 <dd> | |
| 4127 dictionary containing the global config override | |
| 4128 data | |
| 4129 </dd> | |
| 4130 </dl> | |
| 4131 <a NAME="Project.setDirty" ID="Project.setDirty"></a> | |
| 4132 <h4>Project.setDirty</h4> | |
| 4133 <b>setDirty</b>(<i>dirty</i>) | |
| 4134 | |
| 4135 <p> | |
| 4136 Public method to set the dirty state. | |
| 4137 </p> | |
| 4138 <p> | |
| 4139 It emits the signal dirty(bool). | |
| 4140 </p> | |
| 4141 <dl> | |
| 4142 | |
| 4143 <dt><i>dirty</i> (bool)</dt> | |
| 4144 <dd> | |
| 4145 dirty state | |
| 4146 </dd> | |
| 4147 </dl> | |
| 4148 <a NAME="Project.setStatusMonitorAutoUpdate" ID="Project.setStatusMonitorAutoUpdate"></a> | |
| 4149 <h4>Project.setStatusMonitorAutoUpdate</h4> | |
| 4150 <b>setStatusMonitorAutoUpdate</b>(<i>auto</i>) | |
| 4151 | |
| 4152 <p> | |
| 4153 Public method to enable the auto update function. | |
| 4154 </p> | |
| 4155 <dl> | |
| 4156 | |
| 4157 <dt><i>auto</i></dt> | |
| 4158 <dd> | |
| 4159 status of the auto update function (boolean) | |
| 4160 </dd> | |
| 4161 </dl> | |
| 4162 <a NAME="Project.setStatusMonitorInterval" ID="Project.setStatusMonitorInterval"></a> | |
| 4163 <h4>Project.setStatusMonitorInterval</h4> | |
| 4164 <b>setStatusMonitorInterval</b>(<i>interval</i>) | |
| 4165 | |
| 4166 <p> | |
| 4167 Public method to se the interval of the VCS status monitor thread. | |
| 4168 </p> | |
| 4169 <dl> | |
| 4170 | |
| 4171 <dt><i>interval</i></dt> | |
| 4172 <dd> | |
| 4173 status monitor interval in seconds (integer) | |
| 4174 </dd> | |
| 4175 </dl> | |
| 4176 <a NAME="Project.setTranslationPattern" ID="Project.setTranslationPattern"></a> | |
| 4177 <h4>Project.setTranslationPattern</h4> | |
| 4178 <b>setTranslationPattern</b>(<i>pattern</i>) | |
| 4179 | |
| 4180 <p> | |
| 4181 Public method to set the translation pattern. | |
| 4182 </p> | |
| 4183 <dl> | |
| 4184 | |
| 4185 <dt><i>pattern</i> (str)</dt> | |
| 4186 <dd> | |
| 4187 translation pattern | |
| 4188 </dd> | |
| 4189 </dl> | |
| 4190 <a NAME="Project.startFileSystemMonitoring" ID="Project.startFileSystemMonitoring"></a> | |
| 4191 <h4>Project.startFileSystemMonitoring</h4> | |
| 4192 <b>startFileSystemMonitoring</b>(<i></i>) | |
| 4193 | |
| 4194 <p> | |
| 4195 Public method to (re)start monitoring the project file system. | |
| 4196 </p> | |
| 4197 <a NAME="Project.startStatusMonitor" ID="Project.startStatusMonitor"></a> | |
| 4198 <h4>Project.startStatusMonitor</h4> | |
| 4199 <b>startStatusMonitor</b>(<i></i>) | |
| 4200 | |
| 4201 <p> | |
| 4202 Public method to start the VCS status monitor thread. | |
| 4203 </p> | |
| 4204 <a NAME="Project.startswithProjectPath" ID="Project.startswithProjectPath"></a> | |
| 4205 <h4>Project.startswithProjectPath</h4> | |
| 4206 <b>startswithProjectPath</b>(<i>path</i>) | |
| 4207 | |
| 4208 <p> | |
| 4209 Public method to check, if a path starts with the project path. | |
| 4210 </p> | |
| 4211 <dl> | |
| 4212 | |
| 4213 <dt><i>path</i> (str)</dt> | |
| 4214 <dd> | |
| 4215 path to be checked | |
| 4216 </dd> | |
| 4217 </dl> | |
| 4218 <dl> | |
| 4219 <dt>Return:</dt> | |
| 4220 <dd> | |
| 4221 flag indicating that the path starts with the project path | |
| 4222 </dd> | |
| 4223 </dl> | |
| 4224 <dl> | |
| 4225 <dt>Return Type:</dt> | |
| 4226 <dd> | |
| 4227 bool | |
| 4228 </dd> | |
| 4229 </dl> | |
| 4230 <a NAME="Project.stopFileSystemMonitoring" ID="Project.stopFileSystemMonitoring"></a> | |
| 4231 <h4>Project.stopFileSystemMonitoring</h4> | |
| 4232 <b>stopFileSystemMonitoring</b>(<i></i>) | |
| 4233 | |
| 4234 <p> | |
| 4235 Public method to stop monitoring the project file system. | |
| 4236 </p> | |
| 4237 <a NAME="Project.stopStatusMonitor" ID="Project.stopStatusMonitor"></a> | |
| 4238 <h4>Project.stopStatusMonitor</h4> | |
| 4239 <b>stopStatusMonitor</b>(<i></i>) | |
| 4240 | |
| 4241 <p> | |
| 4242 Public method to stop the VCS status monitor thread. | |
| 4243 </p> | |
| 4244 <a NAME="Project.unregisterProjectType" ID="Project.unregisterProjectType"></a> | |
| 4245 <h4>Project.unregisterProjectType</h4> | |
| 4246 <b>unregisterProjectType</b>(<i>type_</i>) | |
| 4247 | |
| 4248 <p> | |
| 4249 Public method to unregister a project type. | |
| 4250 </p> | |
| 4251 <dl> | |
| 4252 | |
| 4253 <dt><i>type_</i></dt> | |
| 4254 <dd> | |
| 4255 internal type designator to be unregistered (string) | |
| 4256 </dd> | |
| 4257 </dl> | |
| 4258 <a NAME="Project.updateFileTypes" ID="Project.updateFileTypes"></a> | |
| 4259 <h4>Project.updateFileTypes</h4> | |
| 4260 <b>updateFileTypes</b>(<i></i>) | |
| 4261 | |
| 4262 <p> | |
| 4263 Public method to update the filetype associations with new default | |
| 4264 values. | |
| 4265 </p> | |
| 4266 <a NAME="Project.useSystemEol" ID="Project.useSystemEol"></a> | |
| 4267 <h4>Project.useSystemEol</h4> | |
| 4268 <b>useSystemEol</b>(<i></i>) | |
| 4269 | |
| 4270 <p> | |
| 4271 Public method to check, if the project uses the system eol setting. | |
| 4272 </p> | |
| 4273 <dl> | |
| 4274 <dt>Return:</dt> | |
| 4275 <dd> | |
| 4276 flag indicating the usage of system eol (boolean) | |
| 4277 </dd> | |
| 4278 </dl> | |
| 4279 <a NAME="Project.vcsSoftwareAvailable" ID="Project.vcsSoftwareAvailable"></a> | |
| 4280 <h4>Project.vcsSoftwareAvailable</h4> | |
| 4281 <b>vcsSoftwareAvailable</b>(<i></i>) | |
| 4282 | |
| 4283 <p> | |
| 4284 Public method to check, if some supported VCS software is available | |
| 4285 to the IDE. | |
| 4286 </p> | |
| 4287 <dl> | |
| 4288 <dt>Return:</dt> | |
| 4289 <dd> | |
| 4290 flag indicating availability of VCS software (boolean) | |
| 4291 </dd> | |
| 4292 </dl> | |
| 4293 <a NAME="Project.writeTasks" ID="Project.writeTasks"></a> | |
| 4294 <h4>Project.writeTasks</h4> | |
| 4295 <b>writeTasks</b>(<i></i>) | |
| 4296 | |
| 4297 <p> | |
| 4298 Public method to write the tasks data to a JSON file (.etj). | |
| 4299 </p> | |
| 4300 <div align="right"><a href="#top">Up</a></div> | |
| 4301 <hr /> | |
| 4302 </body></html> |
