Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Project.Project.html
Documentation/Source/eric4.Project.Project.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.Project.Project</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Project.Project</h1> | |
| 24 <p> | |
| 25 Module implementing the project management functionality. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#Project">Project</a></td> | |
| 35 <td>Class implementing the project management functionality.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="Project" ID="Project"></a> | |
| 44 <h2>Project</h2> | |
| 45 <p> | |
| 46 Class implementing the project management functionality. | |
| 47 </p><h4>Signals</h4> | |
| 48 <dl> | |
| 49 <dt>completeRepopulateItem(string)</dt> | |
| 50 <dd> | |
| 51 emitted after an item of the model was | |
| 52 repopulated | |
| 53 </dd><dt>directoryRemoved(string)</dt> | |
| 54 <dd> | |
| 55 emitted after a directory has been removed from | |
| 56 the project | |
| 57 </dd><dt>dirty(int)</dt> | |
| 58 <dd> | |
| 59 emitted when the dirty state changes | |
| 60 </dd><dt>lexerAssociationsChanged()</dt> | |
| 61 <dd> | |
| 62 emitted after the lexer associations have been | |
| 63 changed | |
| 64 </dd><dt>newProject()</dt> | |
| 65 <dd> | |
| 66 emitted after a new project was generated | |
| 67 </dd><dt>newProjectHooks()</dt> | |
| 68 <dd> | |
| 69 emitted after a new project was generated but before | |
| 70 the newProject() signal is sent | |
| 71 </dd><dt>prepareRepopulateItem(string)</dt> | |
| 72 <dd> | |
| 73 emitted before an item of the model is | |
| 74 repopulated | |
| 75 </dd><dt>projectAboutToBeCreated()</dt> | |
| 76 <dd> | |
| 77 emitted just before the project will be created | |
| 78 </dd><dt>projectClosed()</dt> | |
| 79 <dd> | |
| 80 emitted after a project was closed | |
| 81 </dd><dt>projectClosedHooks()</dt> | |
| 82 <dd> | |
| 83 emitted after a project file was clsoed but before the | |
| 84 projectClosed() signal is sent | |
| 85 </dd><dt>projectFileRenamed(string, string)</dt> | |
| 86 <dd> | |
| 87 emitted after a file of the project | |
| 88 has been renamed | |
| 89 </dd><dt>projectFormAdded(string)</dt> | |
| 90 <dd> | |
| 91 emitted after a new form was added | |
| 92 </dd><dt>projectInterfaceAdded(string)</dt> | |
| 93 <dd> | |
| 94 emitted after a new IDL file was added | |
| 95 </dd><dt>projectLanguageAdded(string)</dt> | |
| 96 <dd> | |
| 97 emitted after a new language was added | |
| 98 </dd><dt>projectLanguageAddedByCode(string)</dt> | |
| 99 <dd> | |
| 100 emitted after a new language was added. | |
| 101 The language code is sent by this signal. | |
| 102 </dd><dt>projectOpened()</dt> | |
| 103 <dd> | |
| 104 emitted after a project file was read | |
| 105 </dd><dt>projectOpenedHooks()</dt> | |
| 106 <dd> | |
| 107 emitted after a project file was read but before the | |
| 108 projectOpened() signal is sent | |
| 109 </dd><dt>projectOthersAdded(string)</dt> | |
| 110 <dd> | |
| 111 emitted after a file or directory was added | |
| 112 to the OTHERS project data area | |
| 113 </dd><dt>projectPropertiesChanged()</dt> | |
| 114 <dd> | |
| 115 emitted after the project properties were changed | |
| 116 </dd><dt>projectResourceAdded(string)</dt> | |
| 117 <dd> | |
| 118 emitted after a new resource file was added | |
| 119 </dd><dt>projectSessionLoaded()</dt> | |
| 120 <dd> | |
| 121 emitted after a project session file was loaded | |
| 122 </dd><dt>projectSourceAdded(string)</dt> | |
| 123 <dd> | |
| 124 emitted after a new source file was added | |
| 125 </dd><dt>reinitVCS()</dt> | |
| 126 <dd> | |
| 127 emitted after the VCS has been reinitialized | |
| 128 </dd><dt>showMenu(string, QMenu)</dt> | |
| 129 <dd> | |
| 130 emitted when a menu is about to be shown. The name | |
| 131 of the menu and a reference to the menu are given. | |
| 132 </dd><dt>sourceFile(string)</dt> | |
| 133 <dd> | |
| 134 emitted after a project file was read to | |
| 135 open the main script | |
| 136 </dd><dt>vcsStatusMonitorStatus(QString, QString)</dt> | |
| 137 <dd> | |
| 138 emitted to signal the status of the | |
| 139 monitoring thread (ok, nok, op, off) and a status message | |
| 140 </dd> | |
| 141 </dl> | |
| 142 <h3>Derived from</h3> | |
| 143 QObject | |
| 144 <h3>Class Attributes</h3> | |
| 145 <table> | |
| 146 <tr><td>dbgKeynames</td></tr><tr><td>keynames</td></tr><tr><td>userKeynames</td></tr> | |
| 147 </table> | |
| 148 <h3>Methods</h3> | |
| 149 <table> | |
| 150 <tr> | |
| 151 <td><a href="#Project.__init__">Project</a></td> | |
| 152 <td>Constructor</td> | |
| 153 </tr><tr> | |
| 154 <td><a href="#Project.__addRecursiveDirectory">__addRecursiveDirectory</a></td> | |
| 155 <td>Private method used to add all files of a directory tree.</td> | |
| 156 </tr><tr> | |
| 157 <td><a href="#Project.__addSingleDirectory">__addSingleDirectory</a></td> | |
| 158 <td>Private method used to add all files of a single directory to the project.</td> | |
| 159 </tr><tr> | |
| 160 <td><a href="#Project.__addToOthers">__addToOthers</a></td> | |
| 161 <td>Private method to add file/directory to the OTHERS project data.</td> | |
| 162 </tr><tr> | |
| 163 <td><a href="#Project.__binaryTranslationFile">__binaryTranslationFile</a></td> | |
| 164 <td>Private method to calculate the filename of the binary translations file given the name of the raw translations file.</td> | |
| 165 </tr><tr> | |
| 166 <td><a href="#Project.__checkFilesExist">__checkFilesExist</a></td> | |
| 167 <td>Private method to check, if the files in a list exist.</td> | |
| 168 </tr><tr> | |
| 169 <td><a href="#Project.__clearRecent">__clearRecent</a></td> | |
| 170 <td>Private method to clear the recent projects menu.</td> | |
| 171 </tr><tr> | |
| 172 <td><a href="#Project.__closeAllWindows">__closeAllWindows</a></td> | |
| 173 <td>Private method to close all project related windows.</td> | |
| 174 </tr><tr> | |
| 175 <td><a href="#Project.__createSnapshotSource">__createSnapshotSource</a></td> | |
| 176 <td>Private method to create a snapshot plugin version.</td> | |
| 177 </tr><tr> | |
| 178 <td><a href="#Project.__createZipDirEntries">__createZipDirEntries</a></td> | |
| 179 <td>Private method to create dir entries in the zip file.</td> | |
| 180 </tr><tr> | |
| 181 <td><a href="#Project.__deleteDebugProperties">__deleteDebugProperties</a></td> | |
| 182 <td>Private method to delete the project debugger properties file (.e3d)</td> | |
| 183 </tr><tr> | |
| 184 <td><a href="#Project.__deleteSession">__deleteSession</a></td> | |
| 185 <td>Private method to delete the session file.</td> | |
| 186 </tr><tr> | |
| 187 <td><a href="#Project.__doSearchNewFiles">__doSearchNewFiles</a></td> | |
| 188 <td>Private method to search for new files in the project directory.</td> | |
| 189 </tr><tr> | |
| 190 <td><a href="#Project.__initData">__initData</a></td> | |
| 191 <td>Private method to initialize the project data part.</td> | |
| 192 </tr><tr> | |
| 193 <td><a href="#Project.__initDebugProperties">__initDebugProperties</a></td> | |
| 194 <td>Private method to initialize the debug properties.</td> | |
| 195 </tr><tr> | |
| 196 <td><a href="#Project.__initProjectTypes">__initProjectTypes</a></td> | |
| 197 <td>Private method to initialize the list of supported project types.</td> | |
| 198 </tr><tr> | |
| 199 <td><a href="#Project.__loadRecent">__loadRecent</a></td> | |
| 200 <td>Private method to load the recently opened project filenames.</td> | |
| 201 </tr><tr> | |
| 202 <td><a href="#Project.__openRecent">__openRecent</a></td> | |
| 203 <td>Private method to open a project from the list of rencently opened projects.</td> | |
| 204 </tr><tr> | |
| 205 <td><a href="#Project.__pluginCreateArchive">__pluginCreateArchive</a></td> | |
| 206 <td>Private slot to create an eric4 plugin archive.</td> | |
| 207 </tr><tr> | |
| 208 <td><a href="#Project.__pluginCreatePkgList">__pluginCreatePkgList</a></td> | |
| 209 <td>Private slot to create a PKGLIST file needed for archive file creation.</td> | |
| 210 </tr><tr> | |
| 211 <td><a href="#Project.__pluginCreateSnapshotArchive">__pluginCreateSnapshotArchive</a></td> | |
| 212 <td>Private slot to create an eric4 plugin archive snapshot release.</td> | |
| 213 </tr><tr> | |
| 214 <td><a href="#Project.__pluginExtractVersion">__pluginExtractVersion</a></td> | |
| 215 <td>Private method to extract the version number entry.</td> | |
| 216 </tr><tr> | |
| 217 <td><a href="#Project.__readDebugProperties">__readDebugProperties</a></td> | |
| 218 <td>Private method to read in the project debugger properties file (.e4d, .e3d)</td> | |
| 219 </tr><tr> | |
| 220 <td><a href="#Project.__readProject">__readProject</a></td> | |
| 221 <td>Private method to read in a project (.e4p, .e4pz, .e3p, .e3pz) file.</td> | |
| 222 </tr><tr> | |
| 223 <td><a href="#Project.__readSession">__readSession</a></td> | |
| 224 <td>Private method to read in the project session file (.e4s, .e3s)</td> | |
| 225 </tr><tr> | |
| 226 <td><a href="#Project.__readTasks">__readTasks</a></td> | |
| 227 <td>Private method to read in the project tasks file (.e4t, .e3t)</td> | |
| 228 </tr><tr> | |
| 229 <td><a href="#Project.__readUserProperties">__readUserProperties</a></td> | |
| 230 <td>Private method to read in the user specific project file (.e4q)</td> | |
| 231 </tr><tr> | |
| 232 <td><a href="#Project.__readXMLDebugProperties">__readXMLDebugProperties</a></td> | |
| 233 <td>Public method to read the debugger properties from an XML file.</td> | |
| 234 </tr><tr> | |
| 235 <td><a href="#Project.__readXMLProject">__readXMLProject</a></td> | |
| 236 <td>Private method to read the project data from an XML file.</td> | |
| 237 </tr><tr> | |
| 238 <td><a href="#Project.__readXMLSession">__readXMLSession</a></td> | |
| 239 <td>Private method to read the session data from an XML file.</td> | |
| 240 </tr><tr> | |
| 241 <td><a href="#Project.__readXMLTasks">__readXMLTasks</a></td> | |
| 242 <td>Private method to read the project tasks data from an XML file.</td> | |
| 243 </tr><tr> | |
| 244 <td><a href="#Project.__saveRecent">__saveRecent</a></td> | |
| 245 <td>Private method to save the list of recently opened filenames.</td> | |
| 246 </tr><tr> | |
| 247 <td><a href="#Project.__searchNewFiles">__searchNewFiles</a></td> | |
| 248 <td>Private slot used to handle the search new files action.</td> | |
| 249 </tr><tr> | |
| 250 <td><a href="#Project.__showCodeCoverage">__showCodeCoverage</a></td> | |
| 251 <td>Private slot used to show the code coverage information for the project files.</td> | |
| 252 </tr><tr> | |
| 253 <td><a href="#Project.__showCodeMetrics">__showCodeMetrics</a></td> | |
| 254 <td>Private slot used to calculate some code metrics for the project files.</td> | |
| 255 </tr><tr> | |
| 256 <td><a href="#Project.__showContextMenuApiDoc">__showContextMenuApiDoc</a></td> | |
| 257 <td>Private slot called before the apidoc menu is shown.</td> | |
| 258 </tr><tr> | |
| 259 <td><a href="#Project.__showContextMenuChecks">__showContextMenuChecks</a></td> | |
| 260 <td>Private slot called before the checks menu is shown.</td> | |
| 261 </tr><tr> | |
| 262 <td><a href="#Project.__showContextMenuGraphics">__showContextMenuGraphics</a></td> | |
| 263 <td>Private slot called before the graphics menu is shown.</td> | |
| 264 </tr><tr> | |
| 265 <td><a href="#Project.__showContextMenuPackagers">__showContextMenuPackagers</a></td> | |
| 266 <td>Private slot called before the packagers menu is shown.</td> | |
| 267 </tr><tr> | |
| 268 <td><a href="#Project.__showContextMenuRecent">__showContextMenuRecent</a></td> | |
| 269 <td>Private method to set up the recent projects menu.</td> | |
| 270 </tr><tr> | |
| 271 <td><a href="#Project.__showContextMenuShow">__showContextMenuShow</a></td> | |
| 272 <td>Private slot called before the show menu is shown.</td> | |
| 273 </tr><tr> | |
| 274 <td><a href="#Project.__showContextMenuVCS">__showContextMenuVCS</a></td> | |
| 275 <td>Private slot called before the vcs menu is shown.</td> | |
| 276 </tr><tr> | |
| 277 <td><a href="#Project.__showDebugProperties">__showDebugProperties</a></td> | |
| 278 <td>Private slot to display the debugger properties dialog.</td> | |
| 279 </tr><tr> | |
| 280 <td><a href="#Project.__showFiletypeAssociations">__showFiletypeAssociations</a></td> | |
| 281 <td>Public slot to display the filetype association dialog.</td> | |
| 282 </tr><tr> | |
| 283 <td><a href="#Project.__showLexerAssociations">__showLexerAssociations</a></td> | |
| 284 <td>Public slot to display the lexer association dialog.</td> | |
| 285 </tr><tr> | |
| 286 <td><a href="#Project.__showMenu">__showMenu</a></td> | |
| 287 <td>Private method to set up the project menu.</td> | |
| 288 </tr><tr> | |
| 289 <td><a href="#Project.__showProfileData">__showProfileData</a></td> | |
| 290 <td>Private slot used to show the profiling information for the project.</td> | |
| 291 </tr><tr> | |
| 292 <td><a href="#Project.__showProperties">__showProperties</a></td> | |
| 293 <td>Private slot to display the properties dialog.</td> | |
| 294 </tr><tr> | |
| 295 <td><a href="#Project.__showUserProperties">__showUserProperties</a></td> | |
| 296 <td>Private slot to display the user specific properties dialog.</td> | |
| 297 </tr><tr> | |
| 298 <td><a href="#Project.__statusMonitorStatus">__statusMonitorStatus</a></td> | |
| 299 <td>Private method to receive the status monitor status.</td> | |
| 300 </tr><tr> | |
| 301 <td><a href="#Project.__syncRecent">__syncRecent</a></td> | |
| 302 <td>Private method to synchronize the list of recently opened projects with the central store.</td> | |
| 303 </tr><tr> | |
| 304 <td><a href="#Project.__writeDebugProperties">__writeDebugProperties</a></td> | |
| 305 <td>Private method to write the project debugger properties file (.e4d)</td> | |
| 306 </tr><tr> | |
| 307 <td><a href="#Project.__writeProject">__writeProject</a></td> | |
| 308 <td>Private method to save the project infos to a project file.</td> | |
| 309 </tr><tr> | |
| 310 <td><a href="#Project.__writeSession">__writeSession</a></td> | |
| 311 <td>Private method to write the session data to an XML file (.e4s).</td> | |
| 312 </tr><tr> | |
| 313 <td><a href="#Project.__writeTasks">__writeTasks</a></td> | |
| 314 <td>Private method to write the tasks data to an XML file (.e4t).</td> | |
| 315 </tr><tr> | |
| 316 <td><a href="#Project.__writeUserProperties">__writeUserProperties</a></td> | |
| 317 <td>Private method to write the project data to an XML file.</td> | |
| 318 </tr><tr> | |
| 319 <td><a href="#Project.__writeXMLProject">__writeXMLProject</a></td> | |
| 320 <td>Private method to write the project data to an XML file.</td> | |
| 321 </tr><tr> | |
| 322 <td><a href="#Project.addDirectory">addDirectory</a></td> | |
| 323 <td>Public method used to add all files of a directory to the project.</td> | |
| 324 </tr><tr> | |
| 325 <td><a href="#Project.addE4Actions">addE4Actions</a></td> | |
| 326 <td>Public method to add actions to the list of actions.</td> | |
| 327 </tr><tr> | |
| 328 <td><a href="#Project.addFiles">addFiles</a></td> | |
| 329 <td>Public slot used to add files to the project.</td> | |
| 330 </tr><tr> | |
| 331 <td><a href="#Project.addIdlDir">addIdlDir</a></td> | |
| 332 <td>Public slot to add all IDL interfaces of a directory to the current project.</td> | |
| 333 </tr><tr> | |
| 334 <td><a href="#Project.addIdlFiles">addIdlFiles</a></td> | |
| 335 <td>Public slot to add IDL interfaces to the current project.</td> | |
| 336 </tr><tr> | |
| 337 <td><a href="#Project.addLanguage">addLanguage</a></td> | |
| 338 <td>Public slot used to add a language to the project.</td> | |
| 339 </tr><tr> | |
| 340 <td><a href="#Project.addOthersDir">addOthersDir</a></td> | |
| 341 <td>Private slot to add a directory to the OTHERS project data.</td> | |
| 342 </tr><tr> | |
| 343 <td><a href="#Project.addOthersFiles">addOthersFiles</a></td> | |
| 344 <td>Private slot to add files to the OTHERS project data.</td> | |
| 345 </tr><tr> | |
| 346 <td><a href="#Project.addResourceDir">addResourceDir</a></td> | |
| 347 <td>Public slot to add all Qt resource files of a directory to the current project.</td> | |
| 348 </tr><tr> | |
| 349 <td><a href="#Project.addResourceFiles">addResourceFiles</a></td> | |
| 350 <td>Public slot to add Qt resources to the current project.</td> | |
| 351 </tr><tr> | |
| 352 <td><a href="#Project.addSourceDir">addSourceDir</a></td> | |
| 353 <td>Public slot to add all source files of a directory to the current project.</td> | |
| 354 </tr><tr> | |
| 355 <td><a href="#Project.addSourceFiles">addSourceFiles</a></td> | |
| 356 <td>Public slot to add source files to the current project.</td> | |
| 357 </tr><tr> | |
| 358 <td><a href="#Project.addUiDir">addUiDir</a></td> | |
| 359 <td>Public slot to add all forms of a directory to the current project.</td> | |
| 360 </tr><tr> | |
| 361 <td><a href="#Project.addUiFiles">addUiFiles</a></td> | |
| 362 <td>Public slot to add forms to the current project.</td> | |
| 363 </tr><tr> | |
| 364 <td><a href="#Project.appendFile">appendFile</a></td> | |
| 365 <td>Public method to append a file to the project.</td> | |
| 366 </tr><tr> | |
| 367 <td><a href="#Project.checkDirty">checkDirty</a></td> | |
| 368 <td>Public method to check dirty status and open a message window.</td> | |
| 369 </tr><tr> | |
| 370 <td><a href="#Project.checkLanguageFiles">checkLanguageFiles</a></td> | |
| 371 <td>Public slot to check the language files after a release process.</td> | |
| 372 </tr><tr> | |
| 373 <td><a href="#Project.checkVCSStatus">checkVCSStatus</a></td> | |
| 374 <td>Public method to wake up the VCS status monitor thread.</td> | |
| 375 </tr><tr> | |
| 376 <td><a href="#Project.clearStatusMonitorCachedState">clearStatusMonitorCachedState</a></td> | |
| 377 <td>Public method to clear the cached VCS state of a file/directory.</td> | |
| 378 </tr><tr> | |
| 379 <td><a href="#Project.closeProject">closeProject</a></td> | |
| 380 <td>Public slot to close the current project.</td> | |
| 381 </tr><tr> | |
| 382 <td><a href="#Project.copyDirectory">copyDirectory</a></td> | |
| 383 <td>Public slot to copy a directory.</td> | |
| 384 </tr><tr> | |
| 385 <td><a href="#Project.deleteDirectory">deleteDirectory</a></td> | |
| 386 <td>Public slot to delete a directory from the project directory.</td> | |
| 387 </tr><tr> | |
| 388 <td><a href="#Project.deleteFile">deleteFile</a></td> | |
| 389 <td>Public slot to delete a file from the project directory.</td> | |
| 390 </tr><tr> | |
| 391 <td><a href="#Project.deleteLanguageFile">deleteLanguageFile</a></td> | |
| 392 <td>Public slot to delete a translation from the project directory.</td> | |
| 393 </tr><tr> | |
| 394 <td><a href="#Project.getActions">getActions</a></td> | |
| 395 <td>Public method to get a list of all actions.</td> | |
| 396 </tr><tr> | |
| 397 <td><a href="#Project.getData">getData</a></td> | |
| 398 <td>Public method to get data out of the project data store.</td> | |
| 399 </tr><tr> | |
| 400 <td><a href="#Project.getDebugProperty">getDebugProperty</a></td> | |
| 401 <td>Public method to retrieve a debugger property.</td> | |
| 402 </tr><tr> | |
| 403 <td><a href="#Project.getDefaultSourceExtension">getDefaultSourceExtension</a></td> | |
| 404 <td>Public method to get the default extension for the project's programming language.</td> | |
| 405 </tr><tr> | |
| 406 <td><a href="#Project.getEditorLexerAssoc">getEditorLexerAssoc</a></td> | |
| 407 <td>Public method to retrieve a lexer association.</td> | |
| 408 </tr><tr> | |
| 409 <td><a href="#Project.getFiles">getFiles</a></td> | |
| 410 <td>Public method to get all files starting with a common prefix.</td> | |
| 411 </tr><tr> | |
| 412 <td><a href="#Project.getMainScript">getMainScript</a></td> | |
| 413 <td>Public method to return the main script filename.</td> | |
| 414 </tr><tr> | |
| 415 <td><a href="#Project.getMenu">getMenu</a></td> | |
| 416 <td>Public method to get a reference to the main menu or a submenu.</td> | |
| 417 </tr><tr> | |
| 418 <td><a href="#Project.getModel">getModel</a></td> | |
| 419 <td>Public method to get a reference to the project browser model.</td> | |
| 420 </tr><tr> | |
| 421 <td><a href="#Project.getMostRecent">getMostRecent</a></td> | |
| 422 <td>Public method to get the most recently opened project.</td> | |
| 423 </tr><tr> | |
| 424 <td><a href="#Project.getProjectDictionaries">getProjectDictionaries</a></td> | |
| 425 <td>Public method to get the names of the project specific dictionaries.</td> | |
| 426 </tr><tr> | |
| 427 <td><a href="#Project.getProjectFile">getProjectFile</a></td> | |
| 428 <td>Public method to get the path of the project file.</td> | |
| 429 </tr><tr> | |
| 430 <td><a href="#Project.getProjectLanguage">getProjectLanguage</a></td> | |
| 431 <td>Public method to get the project's programming language.</td> | |
| 432 </tr><tr> | |
| 433 <td><a href="#Project.getProjectManagementDir">getProjectManagementDir</a></td> | |
| 434 <td>Public method to get the path of the management directory.</td> | |
| 435 </tr><tr> | |
| 436 <td><a href="#Project.getProjectPath">getProjectPath</a></td> | |
| 437 <td>Public method to get the project path.</td> | |
| 438 </tr><tr> | |
| 439 <td><a href="#Project.getProjectSpellLanguage">getProjectSpellLanguage</a></td> | |
| 440 <td>Public method to get the project's programming language.</td> | |
| 441 </tr><tr> | |
| 442 <td><a href="#Project.getProjectType">getProjectType</a></td> | |
| 443 <td>Public method to get the type of the project.</td> | |
| 444 </tr><tr> | |
| 445 <td><a href="#Project.getProjectTypes">getProjectTypes</a></td> | |
| 446 <td>Public method to get the list of supported project types.</td> | |
| 447 </tr><tr> | |
| 448 <td><a href="#Project.getSources">getSources</a></td> | |
| 449 <td>Public method to return the source script files.</td> | |
| 450 </tr><tr> | |
| 451 <td><a href="#Project.getStatusMonitorAutoUpdate">getStatusMonitorAutoUpdate</a></td> | |
| 452 <td>Public method to retrieve the status of the auto update function.</td> | |
| 453 </tr><tr> | |
| 454 <td><a href="#Project.getStatusMonitorInterval">getStatusMonitorInterval</a></td> | |
| 455 <td>Public method to get the monitor interval.</td> | |
| 456 </tr><tr> | |
| 457 <td><a href="#Project.getVcs">getVcs</a></td> | |
| 458 <td>Public method to get a reference to the VCS object.</td> | |
| 459 </tr><tr> | |
| 460 <td><a href="#Project.handleApplicationDiagram">handleApplicationDiagram</a></td> | |
| 461 <td>Private method to handle the application diagram context menu action.</td> | |
| 462 </tr><tr> | |
| 463 <td><a href="#Project.handlePreferencesChanged">handlePreferencesChanged</a></td> | |
| 464 <td>Public slot used to handle the preferencesChanged signal.</td> | |
| 465 </tr><tr> | |
| 466 <td><a href="#Project.hasEntry">hasEntry</a></td> | |
| 467 <td>Public method to check the project for a file.</td> | |
| 468 </tr><tr> | |
| 469 <td><a href="#Project.hasProjectType">hasProjectType</a></td> | |
| 470 <td>Public method to check, if a project type is already registered.</td> | |
| 471 </tr><tr> | |
| 472 <td><a href="#Project.initActions">initActions</a></td> | |
| 473 <td>Public slot to initialize the project related actions.</td> | |
| 474 </tr><tr> | |
| 475 <td><a href="#Project.initFileTypes">initFileTypes</a></td> | |
| 476 <td>Public method to initialize the filetype associations with default values.</td> | |
| 477 </tr><tr> | |
| 478 <td><a href="#Project.initMenu">initMenu</a></td> | |
| 479 <td>Public slot to initialize the project menu.</td> | |
| 480 </tr><tr> | |
| 481 <td><a href="#Project.initToolbar">initToolbar</a></td> | |
| 482 <td>Public slot to initialize the project toolbar.</td> | |
| 483 </tr><tr> | |
| 484 <td><a href="#Project.initVCS">initVCS</a></td> | |
| 485 <td>Public method used to instantiate a vcs system.</td> | |
| 486 </tr><tr> | |
| 487 <td><a href="#Project.isDebugPropertiesLoaded">isDebugPropertiesLoaded</a></td> | |
| 488 <td>Public method to return the status of the debug properties.</td> | |
| 489 </tr><tr> | |
| 490 <td><a href="#Project.isDirty">isDirty</a></td> | |
| 491 <td>Public method to return the dirty state.</td> | |
| 492 </tr><tr> | |
| 493 <td><a href="#Project.isOpen">isOpen</a></td> | |
| 494 <td>Public method to return the opened state.</td> | |
| 495 </tr><tr> | |
| 496 <td><a href="#Project.isProjectFile">isProjectFile</a></td> | |
| 497 <td>Public method used to check, if the passed in filename belongs to the project.</td> | |
| 498 </tr><tr> | |
| 499 <td><a href="#Project.isProjectForm">isProjectForm</a></td> | |
| 500 <td>Public method used to check, if the passed in filename belongs to the project forms.</td> | |
| 501 </tr><tr> | |
| 502 <td><a href="#Project.isProjectInterface">isProjectInterface</a></td> | |
| 503 <td>Public method used to check, if the passed in filename belongs to the project interfaces.</td> | |
| 504 </tr><tr> | |
| 505 <td><a href="#Project.isProjectResource">isProjectResource</a></td> | |
| 506 <td>Public method used to check, if the passed in filename belongs to the project resources.</td> | |
| 507 </tr><tr> | |
| 508 <td><a href="#Project.isProjectSource">isProjectSource</a></td> | |
| 509 <td>Public method used to check, if the passed in filename belongs to the project sources.</td> | |
| 510 </tr><tr> | |
| 511 <td><a href="#Project.moveDirectory">moveDirectory</a></td> | |
| 512 <td>Public slot to move a directory.</td> | |
| 513 </tr><tr> | |
| 514 <td><a href="#Project.newProject">newProject</a></td> | |
| 515 <td>Public slot to built a new project.</td> | |
| 516 </tr><tr> | |
| 517 <td><a href="#Project.newProjectAddFiles">newProjectAddFiles</a></td> | |
| 518 <td>Public method to add files to a new project.</td> | |
| 519 </tr><tr> | |
| 520 <td><a href="#Project.openProject">openProject</a></td> | |
| 521 <td>Public slot to open a project.</td> | |
| 522 </tr><tr> | |
| 523 <td><a href="#Project.othersAdded">othersAdded</a></td> | |
| 524 <td>Public slot to be called, if something was added to the OTHERS project data area.</td> | |
| 525 </tr><tr> | |
| 526 <td><a href="#Project.registerProjectType">registerProjectType</a></td> | |
| 527 <td>Public method to register a project type.</td> | |
| 528 </tr><tr> | |
| 529 <td><a href="#Project.removeDirectory">removeDirectory</a></td> | |
| 530 <td>Public slot to remove a directory from the project.</td> | |
| 531 </tr><tr> | |
| 532 <td><a href="#Project.removeE4Actions">removeE4Actions</a></td> | |
| 533 <td>Public method to remove actions from the list of actions.</td> | |
| 534 </tr><tr> | |
| 535 <td><a href="#Project.removeFile">removeFile</a></td> | |
| 536 <td>Public slot to remove a file from the project.</td> | |
| 537 </tr><tr> | |
| 538 <td><a href="#Project.removeLanguageFile">removeLanguageFile</a></td> | |
| 539 <td>Public slot to remove a translation from the project.</td> | |
| 540 </tr><tr> | |
| 541 <td><a href="#Project.renameFile">renameFile</a></td> | |
| 542 <td>Public slot to rename a file of the project.</td> | |
| 543 </tr><tr> | |
| 544 <td><a href="#Project.renameFileInPdata">renameFileInPdata</a></td> | |
| 545 <td>Public method to rename a file in the pdata structure.</td> | |
| 546 </tr><tr> | |
| 547 <td><a href="#Project.renameMainScript">renameMainScript</a></td> | |
| 548 <td>Public method to rename the main script.</td> | |
| 549 </tr><tr> | |
| 550 <td><a href="#Project.reopenProject">reopenProject</a></td> | |
| 551 <td>Public slot to reopen the current project.</td> | |
| 552 </tr><tr> | |
| 553 <td><a href="#Project.repopulateItem">repopulateItem</a></td> | |
| 554 <td>Public slot to repopulate a named item.</td> | |
| 555 </tr><tr> | |
| 556 <td><a href="#Project.saveAllScripts">saveAllScripts</a></td> | |
| 557 <td>Public method to save all scripts belonging to the project.</td> | |
| 558 </tr><tr> | |
| 559 <td><a href="#Project.saveProject">saveProject</a></td> | |
| 560 <td>Public slot to save the current project.</td> | |
| 561 </tr><tr> | |
| 562 <td><a href="#Project.saveProjectAs">saveProjectAs</a></td> | |
| 563 <td>Public slot to save the current project to a different file.</td> | |
| 564 </tr><tr> | |
| 565 <td><a href="#Project.setData">setData</a></td> | |
| 566 <td>Public method to store data in the project data store.</td> | |
| 567 </tr><tr> | |
| 568 <td><a href="#Project.setDbgInfo">setDbgInfo</a></td> | |
| 569 <td>Public method to set the debugging information.</td> | |
| 570 </tr><tr> | |
| 571 <td><a href="#Project.setDirty">setDirty</a></td> | |
| 572 <td>Public method to set the dirty state.</td> | |
| 573 </tr><tr> | |
| 574 <td><a href="#Project.setStatusMonitorAutoUpdate">setStatusMonitorAutoUpdate</a></td> | |
| 575 <td>Public method to enable the auto update function.</td> | |
| 576 </tr><tr> | |
| 577 <td><a href="#Project.setStatusMonitorInterval">setStatusMonitorInterval</a></td> | |
| 578 <td>Public method to se the interval of the VCS status monitor thread.</td> | |
| 579 </tr><tr> | |
| 580 <td><a href="#Project.startStatusMonitor">startStatusMonitor</a></td> | |
| 581 <td>Public method to start the VCS status monitor thread.</td> | |
| 582 </tr><tr> | |
| 583 <td><a href="#Project.stopStatusMonitor">stopStatusMonitor</a></td> | |
| 584 <td>Public method to stop the VCS status monitor thread.</td> | |
| 585 </tr><tr> | |
| 586 <td><a href="#Project.unregisterProjectType">unregisterProjectType</a></td> | |
| 587 <td>Public method to unregister a project type.</td> | |
| 588 </tr><tr> | |
| 589 <td><a href="#Project.updateFileTypes">updateFileTypes</a></td> | |
| 590 <td>Public method to update the filetype associations with new default values.</td> | |
| 591 </tr> | |
| 592 </table> | |
| 593 <a NAME="Project.__init__" ID="Project.__init__"></a> | |
| 594 <h4>Project (Constructor)</h4> | |
| 595 <b>Project</b>(<i>parent = None, filename = None</i>) | |
| 596 <p> | |
| 597 Constructor | |
| 598 </p><dl> | |
| 599 <dt><i>parent</i></dt> | |
| 600 <dd> | |
| 601 parent widget (usually the ui object) (QWidget) | |
| 602 </dd><dt><i>filename</i></dt> | |
| 603 <dd> | |
| 604 optional filename of a project file to open (string) | |
| 605 </dd> | |
| 606 </dl><a NAME="Project.__addRecursiveDirectory" ID="Project.__addRecursiveDirectory"></a> | |
| 607 <h4>Project.__addRecursiveDirectory</h4> | |
| 608 <b>__addRecursiveDirectory</b>(<i>filetype, source, target</i>) | |
| 609 <p> | |
| 610 Private method used to add all files of a directory tree. | |
| 611 </p><p> | |
| 612 The tree is rooted at source to another one rooted at target. This | |
| 613 method decents down to the lowest subdirectory. | |
| 614 </p><dl> | |
| 615 <dt><i>filetype</i></dt> | |
| 616 <dd> | |
| 617 type of files to add (string) | |
| 618 </dd><dt><i>source</i></dt> | |
| 619 <dd> | |
| 620 source directory (string) | |
| 621 </dd><dt><i>target</i></dt> | |
| 622 <dd> | |
| 623 target directory (string) | |
| 624 </dd> | |
| 625 </dl><a NAME="Project.__addSingleDirectory" ID="Project.__addSingleDirectory"></a> | |
| 626 <h4>Project.__addSingleDirectory</h4> | |
| 627 <b>__addSingleDirectory</b>(<i>filetype, source, target, quiet = False</i>) | |
| 628 <p> | |
| 629 Private method used to add all files of a single directory to the project. | |
| 630 </p><dl> | |
| 631 <dt><i>filetype</i></dt> | |
| 632 <dd> | |
| 633 type of files to add (string) | |
| 634 </dd><dt><i>source</i></dt> | |
| 635 <dd> | |
| 636 source directory (string) | |
| 637 </dd><dt><i>target</i></dt> | |
| 638 <dd> | |
| 639 target directory (string) | |
| 640 </dd><dt><i>quiet</i></dt> | |
| 641 <dd> | |
| 642 flag indicating quiet operations (boolean) | |
| 643 </dd> | |
| 644 </dl><a NAME="Project.__addToOthers" ID="Project.__addToOthers"></a> | |
| 645 <h4>Project.__addToOthers</h4> | |
| 646 <b>__addToOthers</b>(<i>fn</i>) | |
| 647 <p> | |
| 648 Private method to add file/directory to the OTHERS project data. | |
| 649 </p><dl> | |
| 650 <dt><i>fn</i></dt> | |
| 651 <dd> | |
| 652 filename or directoryname to add | |
| 653 </dd> | |
| 654 </dl><a NAME="Project.__binaryTranslationFile" ID="Project.__binaryTranslationFile"></a> | |
| 655 <h4>Project.__binaryTranslationFile</h4> | |
| 656 <b>__binaryTranslationFile</b>(<i>langFile</i>) | |
| 657 <p> | |
| 658 Private method to calculate the filename of the binary translations file | |
| 659 given the name of the raw translations file. | |
| 660 </p><dl> | |
| 661 <dt><i>langFile</i></dt> | |
| 662 <dd> | |
| 663 name of the raw translations file (string) | |
| 664 </dd> | |
| 665 </dl><dl> | |
| 666 <dt>Returns:</dt> | |
| 667 <dd> | |
| 668 name of the binary translations file (string) | |
| 669 </dd> | |
| 670 </dl><a NAME="Project.__checkFilesExist" ID="Project.__checkFilesExist"></a> | |
| 671 <h4>Project.__checkFilesExist</h4> | |
| 672 <b>__checkFilesExist</b>(<i>index</i>) | |
| 673 <p> | |
| 674 Private method to check, if the files in a list exist. | |
| 675 </p><p> | |
| 676 The files in the indicated list are checked for existance in the | |
| 677 filesystem. Non existant files are removed from the list and the | |
| 678 dirty state of the project is changed accordingly. | |
| 679 </p><dl> | |
| 680 <dt><i>index</i></dt> | |
| 681 <dd> | |
| 682 key of the list to be checked (string) | |
| 683 </dd> | |
| 684 </dl><a NAME="Project.__clearRecent" ID="Project.__clearRecent"></a> | |
| 685 <h4>Project.__clearRecent</h4> | |
| 686 <b>__clearRecent</b>(<i></i>) | |
| 687 <p> | |
| 688 Private method to clear the recent projects menu. | |
| 689 </p><a NAME="Project.__closeAllWindows" ID="Project.__closeAllWindows"></a> | |
| 690 <h4>Project.__closeAllWindows</h4> | |
| 691 <b>__closeAllWindows</b>(<i></i>) | |
| 692 <p> | |
| 693 Private method to close all project related windows. | |
| 694 </p><a NAME="Project.__createSnapshotSource" ID="Project.__createSnapshotSource"></a> | |
| 695 <h4>Project.__createSnapshotSource</h4> | |
| 696 <b>__createSnapshotSource</b>(<i>filename</i>) | |
| 697 <p> | |
| 698 Private method to create a snapshot plugin version. | |
| 699 </p><p> | |
| 700 The version entry in the plugin module is modified to signify | |
| 701 a snapshot version. This method appends the string "-snapshot-" | |
| 702 and date indicator to the version string. | |
| 703 </p><dl> | |
| 704 <dt><i>filename</i></dt> | |
| 705 <dd> | |
| 706 name of the plugin file to modify (string) | |
| 707 </dd> | |
| 708 </dl><dl> | |
| 709 <dt>Returns:</dt> | |
| 710 <dd> | |
| 711 modified source (string), snapshot version string (string) | |
| 712 </dd> | |
| 713 </dl><a NAME="Project.__createZipDirEntries" ID="Project.__createZipDirEntries"></a> | |
| 714 <h4>Project.__createZipDirEntries</h4> | |
| 715 <b>__createZipDirEntries</b>(<i>path, zipFile</i>) | |
| 716 <p> | |
| 717 Private method to create dir entries in the zip file. | |
| 718 </p><dl> | |
| 719 <dt><i>path</i></dt> | |
| 720 <dd> | |
| 721 name of the directory entry to create (string) | |
| 722 </dd><dt><i>zipFile</i></dt> | |
| 723 <dd> | |
| 724 open ZipFile object (zipfile.ZipFile) | |
| 725 </dd> | |
| 726 </dl><a NAME="Project.__deleteDebugProperties" ID="Project.__deleteDebugProperties"></a> | |
| 727 <h4>Project.__deleteDebugProperties</h4> | |
| 728 <b>__deleteDebugProperties</b>(<i></i>) | |
| 729 <p> | |
| 730 Private method to delete the project debugger properties file (.e3d) | |
| 731 </p><a NAME="Project.__deleteSession" ID="Project.__deleteSession"></a> | |
| 732 <h4>Project.__deleteSession</h4> | |
| 733 <b>__deleteSession</b>(<i></i>) | |
| 734 <p> | |
| 735 Private method to delete the session file. | |
| 736 </p><a NAME="Project.__doSearchNewFiles" ID="Project.__doSearchNewFiles"></a> | |
| 737 <h4>Project.__doSearchNewFiles</h4> | |
| 738 <b>__doSearchNewFiles</b>(<i>AI = True, onUserDemand = False</i>) | |
| 739 <p> | |
| 740 Private method to search for new files in the project directory. | |
| 741 </p><p> | |
| 742 If new files were found, it shows a dialog listing these files and | |
| 743 gives the user the opportunity to select the ones he wants to | |
| 744 include. If 'Automatic Inclusion' is enabled, the new files are | |
| 745 automatically added to the project. | |
| 746 </p><dl> | |
| 747 <dt><i>AI</i></dt> | |
| 748 <dd> | |
| 749 flag indicating whether the automatic inclusion should | |
| 750 be honoured (boolean) | |
| 751 </dd><dt><i>onUserDemand</i></dt> | |
| 752 <dd> | |
| 753 flag indicating whether this method was | |
| 754 requested by the user via a menu action (boolean) | |
| 755 </dd> | |
| 756 </dl><a NAME="Project.__initData" ID="Project.__initData"></a> | |
| 757 <h4>Project.__initData</h4> | |
| 758 <b>__initData</b>(<i></i>) | |
| 759 <p> | |
| 760 Private method to initialize the project data part. | |
| 761 </p><a NAME="Project.__initDebugProperties" ID="Project.__initDebugProperties"></a> | |
| 762 <h4>Project.__initDebugProperties</h4> | |
| 763 <b>__initDebugProperties</b>(<i></i>) | |
| 764 <p> | |
| 765 Private method to initialize the debug properties. | |
| 766 </p><a NAME="Project.__initProjectTypes" ID="Project.__initProjectTypes"></a> | |
| 767 <h4>Project.__initProjectTypes</h4> | |
| 768 <b>__initProjectTypes</b>(<i></i>) | |
| 769 <p> | |
| 770 Private method to initialize the list of supported project types. | |
| 771 </p><a NAME="Project.__loadRecent" ID="Project.__loadRecent"></a> | |
| 772 <h4>Project.__loadRecent</h4> | |
| 773 <b>__loadRecent</b>(<i></i>) | |
| 774 <p> | |
| 775 Private method to load the recently opened project filenames. | |
| 776 </p><a NAME="Project.__openRecent" ID="Project.__openRecent"></a> | |
| 777 <h4>Project.__openRecent</h4> | |
| 778 <b>__openRecent</b>(<i>act</i>) | |
| 779 <p> | |
| 780 Private method to open a project from the list of rencently opened projects. | |
| 781 </p><dl> | |
| 782 <dt><i>act</i></dt> | |
| 783 <dd> | |
| 784 reference to the action that triggered (QAction) | |
| 785 </dd> | |
| 786 </dl><a NAME="Project.__pluginCreateArchive" ID="Project.__pluginCreateArchive"></a> | |
| 787 <h4>Project.__pluginCreateArchive</h4> | |
| 788 <b>__pluginCreateArchive</b>(<i>snapshot = False</i>) | |
| 789 <p> | |
| 790 Private slot to create an eric4 plugin archive. | |
| 791 </p><dl> | |
| 792 <dt><i>snapshot</i></dt> | |
| 793 <dd> | |
| 794 flag indicating a snapshot archive (boolean) | |
| 795 </dd> | |
| 796 </dl><a NAME="Project.__pluginCreatePkgList" ID="Project.__pluginCreatePkgList"></a> | |
| 797 <h4>Project.__pluginCreatePkgList</h4> | |
| 798 <b>__pluginCreatePkgList</b>(<i></i>) | |
| 799 <p> | |
| 800 Private slot to create a PKGLIST file needed for archive file creation. | |
| 801 </p><a NAME="Project.__pluginCreateSnapshotArchive" ID="Project.__pluginCreateSnapshotArchive"></a> | |
| 802 <h4>Project.__pluginCreateSnapshotArchive</h4> | |
| 803 <b>__pluginCreateSnapshotArchive</b>(<i></i>) | |
| 804 <p> | |
| 805 Private slot to create an eric4 plugin archive snapshot release. | |
| 806 </p><a NAME="Project.__pluginExtractVersion" ID="Project.__pluginExtractVersion"></a> | |
| 807 <h4>Project.__pluginExtractVersion</h4> | |
| 808 <b>__pluginExtractVersion</b>(<i>filename</i>) | |
| 809 <p> | |
| 810 Private method to extract the version number entry. | |
| 811 </p><dl> | |
| 812 <dt><i>filename</i></dt> | |
| 813 <dd> | |
| 814 name of the plugin file to modify (string) | |
| 815 </dd> | |
| 816 </dl><dl> | |
| 817 <dt>Returns:</dt> | |
| 818 <dd> | |
| 819 version string (string) | |
| 820 </dd> | |
| 821 </dl><a NAME="Project.__readDebugProperties" ID="Project.__readDebugProperties"></a> | |
| 822 <h4>Project.__readDebugProperties</h4> | |
| 823 <b>__readDebugProperties</b>(<i>quiet = False</i>) | |
| 824 <p> | |
| 825 Private method to read in the project debugger properties file (.e4d, .e3d) | |
| 826 </p><dl> | |
| 827 <dt><i>quiet</i></dt> | |
| 828 <dd> | |
| 829 flag indicating quiet operations. | |
| 830 If this flag is true, no errors are reported. | |
| 831 </dd> | |
| 832 </dl><a NAME="Project.__readProject" ID="Project.__readProject"></a> | |
| 833 <h4>Project.__readProject</h4> | |
| 834 <b>__readProject</b>(<i>fn</i>) | |
| 835 <p> | |
| 836 Private method to read in a project (.e4p, .e4pz, .e3p, .e3pz) file. | |
| 837 </p><dl> | |
| 838 <dt><i>fn</i></dt> | |
| 839 <dd> | |
| 840 filename of the project file to be read (string) | |
| 841 </dd> | |
| 842 </dl><dl> | |
| 843 <dt>Returns:</dt> | |
| 844 <dd> | |
| 845 flag indicating success | |
| 846 </dd> | |
| 847 </dl><a NAME="Project.__readSession" ID="Project.__readSession"></a> | |
| 848 <h4>Project.__readSession</h4> | |
| 849 <b>__readSession</b>(<i>quiet = False, indicator = ""</i>) | |
| 850 <p> | |
| 851 Private method to read in the project session file (.e4s, .e3s) | |
| 852 </p><dl> | |
| 853 <dt><i>quiet</i></dt> | |
| 854 <dd> | |
| 855 flag indicating quiet operations. | |
| 856 If this flag is true, no errors are reported. | |
| 857 </dd><dt><i>indicator=</i></dt> | |
| 858 <dd> | |
| 859 indicator string (string) | |
| 860 </dd> | |
| 861 </dl><a NAME="Project.__readTasks" ID="Project.__readTasks"></a> | |
| 862 <h4>Project.__readTasks</h4> | |
| 863 <b>__readTasks</b>(<i></i>) | |
| 864 <p> | |
| 865 Private method to read in the project tasks file (.e4t, .e3t) | |
| 866 </p><a NAME="Project.__readUserProperties" ID="Project.__readUserProperties"></a> | |
| 867 <h4>Project.__readUserProperties</h4> | |
| 868 <b>__readUserProperties</b>(<i></i>) | |
| 869 <p> | |
| 870 Private method to read in the user specific project file (.e4q) | |
| 871 </p><a NAME="Project.__readXMLDebugProperties" ID="Project.__readXMLDebugProperties"></a> | |
| 872 <h4>Project.__readXMLDebugProperties</h4> | |
| 873 <b>__readXMLDebugProperties</b>(<i>fn, validating, quiet</i>) | |
| 874 <p> | |
| 875 Public method to read the debugger properties from an XML file. | |
| 876 </p><dl> | |
| 877 <dt><i>fn</i></dt> | |
| 878 <dd> | |
| 879 filename of the project debugger properties file to be read | |
| 880 (string) | |
| 881 </dd><dt><i>validating</i></dt> | |
| 882 <dd> | |
| 883 flag indicating a validation of the XML file is | |
| 884 requested (boolean) | |
| 885 </dd><dt><i>quiet</i></dt> | |
| 886 <dd> | |
| 887 flag indicating quiet operations. | |
| 888 If this flag is true, no errors are reported. | |
| 889 </dd> | |
| 890 </dl><a NAME="Project.__readXMLProject" ID="Project.__readXMLProject"></a> | |
| 891 <h4>Project.__readXMLProject</h4> | |
| 892 <b>__readXMLProject</b>(<i>fn, validating</i>) | |
| 893 <p> | |
| 894 Private method to read the project data from an XML file. | |
| 895 </p><dl> | |
| 896 <dt><i>fn</i></dt> | |
| 897 <dd> | |
| 898 filename of the project file to be read (string) | |
| 899 </dd><dt><i>validating</i></dt> | |
| 900 <dd> | |
| 901 flag indicating a validation of the XML file is | |
| 902 requested (boolean) | |
| 903 </dd> | |
| 904 </dl><dl> | |
| 905 <dt>Returns:</dt> | |
| 906 <dd> | |
| 907 flag indicating success (boolean) | |
| 908 </dd> | |
| 909 </dl><a NAME="Project.__readXMLSession" ID="Project.__readXMLSession"></a> | |
| 910 <h4>Project.__readXMLSession</h4> | |
| 911 <b>__readXMLSession</b>(<i>fn, validating, quiet</i>) | |
| 912 <p> | |
| 913 Private method to read the session data from an XML file. | |
| 914 </p><p> | |
| 915 The data read is: | |
| 916 <ul> | |
| 917 <li>all open source filenames</li> | |
| 918 <li>the active window</li> | |
| 919 <li>all breakpoints</li> | |
| 920 <li>the commandline</li> | |
| 921 <li>the working directory</li> | |
| 922 <li>the exception reporting flag</li> | |
| 923 <li>the list of exception types to be highlighted</li> | |
| 924 <li>all bookmarks</li> | |
| 925 </ul> | |
| 926 </p><dl> | |
| 927 <dt><i>fn</i></dt> | |
| 928 <dd> | |
| 929 filename of the project session file to be read (string) | |
| 930 </dd><dt><i>validating</i></dt> | |
| 931 <dd> | |
| 932 flag indicating a validation of the XML file is | |
| 933 requested (boolean) | |
| 934 </dd><dt><i>quiet</i></dt> | |
| 935 <dd> | |
| 936 flag indicating quiet operations. | |
| 937 If this flag is true, no errors are reported. | |
| 938 </dd> | |
| 939 </dl><a NAME="Project.__readXMLTasks" ID="Project.__readXMLTasks"></a> | |
| 940 <h4>Project.__readXMLTasks</h4> | |
| 941 <b>__readXMLTasks</b>(<i>fn, validating</i>) | |
| 942 <p> | |
| 943 Private method to read the project tasks data from an XML file. | |
| 944 </p><dl> | |
| 945 <dt><i>fn</i></dt> | |
| 946 <dd> | |
| 947 filename of the project tasks file to be read (string) | |
| 948 </dd><dt><i>validating</i></dt> | |
| 949 <dd> | |
| 950 flag indicating a validation of the XML file is | |
| 951 requested (boolean) | |
| 952 </dd> | |
| 953 </dl><a NAME="Project.__saveRecent" ID="Project.__saveRecent"></a> | |
| 954 <h4>Project.__saveRecent</h4> | |
| 955 <b>__saveRecent</b>(<i></i>) | |
| 956 <p> | |
| 957 Private method to save the list of recently opened filenames. | |
| 958 </p><a NAME="Project.__searchNewFiles" ID="Project.__searchNewFiles"></a> | |
| 959 <h4>Project.__searchNewFiles</h4> | |
| 960 <b>__searchNewFiles</b>(<i></i>) | |
| 961 <p> | |
| 962 Private slot used to handle the search new files action. | |
| 963 </p><a NAME="Project.__showCodeCoverage" ID="Project.__showCodeCoverage"></a> | |
| 964 <h4>Project.__showCodeCoverage</h4> | |
| 965 <b>__showCodeCoverage</b>(<i></i>) | |
| 966 <p> | |
| 967 Private slot used to show the code coverage information for the project files. | |
| 968 </p><a NAME="Project.__showCodeMetrics" ID="Project.__showCodeMetrics"></a> | |
| 969 <h4>Project.__showCodeMetrics</h4> | |
| 970 <b>__showCodeMetrics</b>(<i></i>) | |
| 971 <p> | |
| 972 Private slot used to calculate some code metrics for the project files. | |
| 973 </p><a NAME="Project.__showContextMenuApiDoc" ID="Project.__showContextMenuApiDoc"></a> | |
| 974 <h4>Project.__showContextMenuApiDoc</h4> | |
| 975 <b>__showContextMenuApiDoc</b>(<i></i>) | |
| 976 <p> | |
| 977 Private slot called before the apidoc menu is shown. | |
| 978 </p><a NAME="Project.__showContextMenuChecks" ID="Project.__showContextMenuChecks"></a> | |
| 979 <h4>Project.__showContextMenuChecks</h4> | |
| 980 <b>__showContextMenuChecks</b>(<i></i>) | |
| 981 <p> | |
| 982 Private slot called before the checks menu is shown. | |
| 983 </p><a NAME="Project.__showContextMenuGraphics" ID="Project.__showContextMenuGraphics"></a> | |
| 984 <h4>Project.__showContextMenuGraphics</h4> | |
| 985 <b>__showContextMenuGraphics</b>(<i></i>) | |
| 986 <p> | |
| 987 Private slot called before the graphics menu is shown. | |
| 988 </p><a NAME="Project.__showContextMenuPackagers" ID="Project.__showContextMenuPackagers"></a> | |
| 989 <h4>Project.__showContextMenuPackagers</h4> | |
| 990 <b>__showContextMenuPackagers</b>(<i></i>) | |
| 991 <p> | |
| 992 Private slot called before the packagers menu is shown. | |
| 993 </p><a NAME="Project.__showContextMenuRecent" ID="Project.__showContextMenuRecent"></a> | |
| 994 <h4>Project.__showContextMenuRecent</h4> | |
| 995 <b>__showContextMenuRecent</b>(<i></i>) | |
| 996 <p> | |
| 997 Private method to set up the recent projects menu. | |
| 998 </p><a NAME="Project.__showContextMenuShow" ID="Project.__showContextMenuShow"></a> | |
| 999 <h4>Project.__showContextMenuShow</h4> | |
| 1000 <b>__showContextMenuShow</b>(<i></i>) | |
| 1001 <p> | |
| 1002 Private slot called before the show menu is shown. | |
| 1003 </p><a NAME="Project.__showContextMenuVCS" ID="Project.__showContextMenuVCS"></a> | |
| 1004 <h4>Project.__showContextMenuVCS</h4> | |
| 1005 <b>__showContextMenuVCS</b>(<i></i>) | |
| 1006 <p> | |
| 1007 Private slot called before the vcs menu is shown. | |
| 1008 </p><a NAME="Project.__showDebugProperties" ID="Project.__showDebugProperties"></a> | |
| 1009 <h4>Project.__showDebugProperties</h4> | |
| 1010 <b>__showDebugProperties</b>(<i></i>) | |
| 1011 <p> | |
| 1012 Private slot to display the debugger properties dialog. | |
| 1013 </p><a NAME="Project.__showFiletypeAssociations" ID="Project.__showFiletypeAssociations"></a> | |
| 1014 <h4>Project.__showFiletypeAssociations</h4> | |
| 1015 <b>__showFiletypeAssociations</b>(<i></i>) | |
| 1016 <p> | |
| 1017 Public slot to display the filetype association dialog. | |
| 1018 </p><a NAME="Project.__showLexerAssociations" ID="Project.__showLexerAssociations"></a> | |
| 1019 <h4>Project.__showLexerAssociations</h4> | |
| 1020 <b>__showLexerAssociations</b>(<i></i>) | |
| 1021 <p> | |
| 1022 Public slot to display the lexer association dialog. | |
| 1023 </p><a NAME="Project.__showMenu" ID="Project.__showMenu"></a> | |
| 1024 <h4>Project.__showMenu</h4> | |
| 1025 <b>__showMenu</b>(<i></i>) | |
| 1026 <p> | |
| 1027 Private method to set up the project menu. | |
| 1028 </p><a NAME="Project.__showProfileData" ID="Project.__showProfileData"></a> | |
| 1029 <h4>Project.__showProfileData</h4> | |
| 1030 <b>__showProfileData</b>(<i></i>) | |
| 1031 <p> | |
| 1032 Private slot used to show the profiling information for the project. | |
| 1033 </p><a NAME="Project.__showProperties" ID="Project.__showProperties"></a> | |
| 1034 <h4>Project.__showProperties</h4> | |
| 1035 <b>__showProperties</b>(<i></i>) | |
| 1036 <p> | |
| 1037 Private slot to display the properties dialog. | |
| 1038 </p><a NAME="Project.__showUserProperties" ID="Project.__showUserProperties"></a> | |
| 1039 <h4>Project.__showUserProperties</h4> | |
| 1040 <b>__showUserProperties</b>(<i></i>) | |
| 1041 <p> | |
| 1042 Private slot to display the user specific properties dialog. | |
| 1043 </p><a NAME="Project.__statusMonitorStatus" ID="Project.__statusMonitorStatus"></a> | |
| 1044 <h4>Project.__statusMonitorStatus</h4> | |
| 1045 <b>__statusMonitorStatus</b>(<i>status, statusMsg</i>) | |
| 1046 <p> | |
| 1047 Private method to receive the status monitor status. | |
| 1048 </p><p> | |
| 1049 It simply reemits the received status. | |
| 1050 </p><dl> | |
| 1051 <dt><i>status</i></dt> | |
| 1052 <dd> | |
| 1053 status of the monitoring thread (string, ok, nok or off) | |
| 1054 </dd><dt><i>statusMsg</i></dt> | |
| 1055 <dd> | |
| 1056 explanotory text for the signaled status (string) | |
| 1057 </dd> | |
| 1058 </dl><a NAME="Project.__syncRecent" ID="Project.__syncRecent"></a> | |
| 1059 <h4>Project.__syncRecent</h4> | |
| 1060 <b>__syncRecent</b>(<i></i>) | |
| 1061 <p> | |
| 1062 Private method to synchronize the list of recently opened projects | |
| 1063 with the central store. | |
| 1064 </p><a NAME="Project.__writeDebugProperties" ID="Project.__writeDebugProperties"></a> | |
| 1065 <h4>Project.__writeDebugProperties</h4> | |
| 1066 <b>__writeDebugProperties</b>(<i>quiet=0</i>) | |
| 1067 <p> | |
| 1068 Private method to write the project debugger properties file (.e4d) | |
| 1069 </p><dl> | |
| 1070 <dt><i>quiet</i></dt> | |
| 1071 <dd> | |
| 1072 flag indicating quiet operations. | |
| 1073 If this flag is true, no errors are reported. | |
| 1074 </dd> | |
| 1075 </dl><a NAME="Project.__writeProject" ID="Project.__writeProject"></a> | |
| 1076 <h4>Project.__writeProject</h4> | |
| 1077 <b>__writeProject</b>(<i>fn = None</i>) | |
| 1078 <p> | |
| 1079 Private method to save the project infos to a project file. | |
| 1080 </p><dl> | |
| 1081 <dt><i>fn</i></dt> | |
| 1082 <dd> | |
| 1083 optional filename of the project file to be written (string). | |
| 1084 If fn is None, the filename stored in the project object | |
| 1085 is used. This is the 'save' action. If fn is given, this filename | |
| 1086 is used instead of the one in the project object. This is the | |
| 1087 'save as' action. | |
| 1088 </dd> | |
| 1089 </dl><dl> | |
| 1090 <dt>Returns:</dt> | |
| 1091 <dd> | |
| 1092 flag indicating success | |
| 1093 </dd> | |
| 1094 </dl><a NAME="Project.__writeSession" ID="Project.__writeSession"></a> | |
| 1095 <h4>Project.__writeSession</h4> | |
| 1096 <b>__writeSession</b>(<i>quiet = False, indicator = ""</i>) | |
| 1097 <p> | |
| 1098 Private method to write the session data to an XML file (.e4s). | |
| 1099 </p><p> | |
| 1100 The data saved is: | |
| 1101 <ul> | |
| 1102 <li>all open source filenames belonging to the project</li> | |
| 1103 <li>the active window, if it belongs to the project</li> | |
| 1104 <li>all breakpoints</li> | |
| 1105 <li>the commandline</li> | |
| 1106 <li>the working directory</li> | |
| 1107 <li>the exception reporting flag</li> | |
| 1108 <li>the list of exception types to be highlighted</li> | |
| 1109 <li>all bookmarks of files belonging to the project</li> | |
| 1110 </ul> | |
| 1111 </p><dl> | |
| 1112 <dt><i>quiet</i></dt> | |
| 1113 <dd> | |
| 1114 flag indicating quiet operations. | |
| 1115 If this flag is true, no errors are reported. | |
| 1116 </dd><dt><i>indicator=</i></dt> | |
| 1117 <dd> | |
| 1118 indicator string (string) | |
| 1119 </dd> | |
| 1120 </dl><a NAME="Project.__writeTasks" ID="Project.__writeTasks"></a> | |
| 1121 <h4>Project.__writeTasks</h4> | |
| 1122 <b>__writeTasks</b>(<i></i>) | |
| 1123 <p> | |
| 1124 Private method to write the tasks data to an XML file (.e4t). | |
| 1125 </p><a NAME="Project.__writeUserProperties" ID="Project.__writeUserProperties"></a> | |
| 1126 <h4>Project.__writeUserProperties</h4> | |
| 1127 <b>__writeUserProperties</b>(<i></i>) | |
| 1128 <p> | |
| 1129 Private method to write the project data to an XML file. | |
| 1130 </p><a NAME="Project.__writeXMLProject" ID="Project.__writeXMLProject"></a> | |
| 1131 <h4>Project.__writeXMLProject</h4> | |
| 1132 <b>__writeXMLProject</b>(<i>fn = None</i>) | |
| 1133 <p> | |
| 1134 Private method to write the project data to an XML file. | |
| 1135 </p><dl> | |
| 1136 <dt><i>fn</i></dt> | |
| 1137 <dd> | |
| 1138 the filename of the project file (string) | |
| 1139 </dd> | |
| 1140 </dl><dl> | |
| 1141 <dt>Returns:</dt> | |
| 1142 <dd> | |
| 1143 flag indicating success (boolean) | |
| 1144 </dd> | |
| 1145 </dl><a NAME="Project.addDirectory" ID="Project.addDirectory"></a> | |
| 1146 <h4>Project.addDirectory</h4> | |
| 1147 <b>addDirectory</b>(<i>filter = None, startdir = None</i>) | |
| 1148 <p> | |
| 1149 Public method used to add all files of a directory to the project. | |
| 1150 </p><dl> | |
| 1151 <dt><i>filter</i></dt> | |
| 1152 <dd> | |
| 1153 filter to be used by the add directory dialog | |
| 1154 (string out of source, form, resource, interface, others) | |
| 1155 </dd><dt><i>startdir</i></dt> | |
| 1156 <dd> | |
| 1157 start directory for the selection dialog (string) | |
| 1158 </dd> | |
| 1159 </dl><a NAME="Project.addE4Actions" ID="Project.addE4Actions"></a> | |
| 1160 <h4>Project.addE4Actions</h4> | |
| 1161 <b>addE4Actions</b>(<i>actions</i>) | |
| 1162 <p> | |
| 1163 Public method to add actions to the list of actions. | |
| 1164 </p><dl> | |
| 1165 <dt><i>actions</i></dt> | |
| 1166 <dd> | |
| 1167 list of actions (list of E4Action) | |
| 1168 </dd> | |
| 1169 </dl><a NAME="Project.addFiles" ID="Project.addFiles"></a> | |
| 1170 <h4>Project.addFiles</h4> | |
| 1171 <b>addFiles</b>(<i>filter = None, startdir = None</i>) | |
| 1172 <p> | |
| 1173 Public slot used to add files to the project. | |
| 1174 </p><dl> | |
| 1175 <dt><i>filter</i></dt> | |
| 1176 <dd> | |
| 1177 filter to be used by the add file dialog | |
| 1178 (string out of source, form, resource, interface, others) | |
| 1179 </dd><dt><i>startdir</i></dt> | |
| 1180 <dd> | |
| 1181 start directory for the selection dialog | |
| 1182 </dd> | |
| 1183 </dl><a NAME="Project.addIdlDir" ID="Project.addIdlDir"></a> | |
| 1184 <h4>Project.addIdlDir</h4> | |
| 1185 <b>addIdlDir</b>(<i></i>) | |
| 1186 <p> | |
| 1187 Public slot to add all IDL interfaces of a directory to the current project. | |
| 1188 </p><a NAME="Project.addIdlFiles" ID="Project.addIdlFiles"></a> | |
| 1189 <h4>Project.addIdlFiles</h4> | |
| 1190 <b>addIdlFiles</b>(<i></i>) | |
| 1191 <p> | |
| 1192 Public slot to add IDL interfaces to the current project. | |
| 1193 </p><a NAME="Project.addLanguage" ID="Project.addLanguage"></a> | |
| 1194 <h4>Project.addLanguage</h4> | |
| 1195 <b>addLanguage</b>(<i></i>) | |
| 1196 <p> | |
| 1197 Public slot used to add a language to the project. | |
| 1198 </p><a NAME="Project.addOthersDir" ID="Project.addOthersDir"></a> | |
| 1199 <h4>Project.addOthersDir</h4> | |
| 1200 <b>addOthersDir</b>(<i></i>) | |
| 1201 <p> | |
| 1202 Private slot to add a directory to the OTHERS project data. | |
| 1203 </p><a NAME="Project.addOthersFiles" ID="Project.addOthersFiles"></a> | |
| 1204 <h4>Project.addOthersFiles</h4> | |
| 1205 <b>addOthersFiles</b>(<i></i>) | |
| 1206 <p> | |
| 1207 Private slot to add files to the OTHERS project data. | |
| 1208 </p><a NAME="Project.addResourceDir" ID="Project.addResourceDir"></a> | |
| 1209 <h4>Project.addResourceDir</h4> | |
| 1210 <b>addResourceDir</b>(<i></i>) | |
| 1211 <p> | |
| 1212 Public slot to add all Qt resource files of a directory to the current project. | |
| 1213 </p><a NAME="Project.addResourceFiles" ID="Project.addResourceFiles"></a> | |
| 1214 <h4>Project.addResourceFiles</h4> | |
| 1215 <b>addResourceFiles</b>(<i></i>) | |
| 1216 <p> | |
| 1217 Public slot to add Qt resources to the current project. | |
| 1218 </p><a NAME="Project.addSourceDir" ID="Project.addSourceDir"></a> | |
| 1219 <h4>Project.addSourceDir</h4> | |
| 1220 <b>addSourceDir</b>(<i></i>) | |
| 1221 <p> | |
| 1222 Public slot to add all source files of a directory to the current project. | |
| 1223 </p><a NAME="Project.addSourceFiles" ID="Project.addSourceFiles"></a> | |
| 1224 <h4>Project.addSourceFiles</h4> | |
| 1225 <b>addSourceFiles</b>(<i></i>) | |
| 1226 <p> | |
| 1227 Public slot to add source files to the current project. | |
| 1228 </p><a NAME="Project.addUiDir" ID="Project.addUiDir"></a> | |
| 1229 <h4>Project.addUiDir</h4> | |
| 1230 <b>addUiDir</b>(<i></i>) | |
| 1231 <p> | |
| 1232 Public slot to add all forms of a directory to the current project. | |
| 1233 </p><a NAME="Project.addUiFiles" ID="Project.addUiFiles"></a> | |
| 1234 <h4>Project.addUiFiles</h4> | |
| 1235 <b>addUiFiles</b>(<i></i>) | |
| 1236 <p> | |
| 1237 Public slot to add forms to the current project. | |
| 1238 </p><a NAME="Project.appendFile" ID="Project.appendFile"></a> | |
| 1239 <h4>Project.appendFile</h4> | |
| 1240 <b>appendFile</b>(<i>fn, isSourceFile = False, updateModel = True</i>) | |
| 1241 <p> | |
| 1242 Public method to append a file to the project. | |
| 1243 </p><dl> | |
| 1244 <dt><i>fn</i></dt> | |
| 1245 <dd> | |
| 1246 filename to be added to the project (string) | |
| 1247 </dd><dt><i>isSourceFile</i></dt> | |
| 1248 <dd> | |
| 1249 flag indicating that this is a source file | |
| 1250 even if it doesn't have the source extension (boolean) | |
| 1251 </dd><dt><i>updateModel</i></dt> | |
| 1252 <dd> | |
| 1253 flag indicating an update of the model is requested (boolean) | |
| 1254 </dd> | |
| 1255 </dl><a NAME="Project.checkDirty" ID="Project.checkDirty"></a> | |
| 1256 <h4>Project.checkDirty</h4> | |
| 1257 <b>checkDirty</b>(<i></i>) | |
| 1258 <p> | |
| 1259 Public method to check dirty status and open a message window. | |
| 1260 </p><dl> | |
| 1261 <dt>Returns:</dt> | |
| 1262 <dd> | |
| 1263 flag indicating whether this operation was successful (boolean) | |
| 1264 </dd> | |
| 1265 </dl><a NAME="Project.checkLanguageFiles" ID="Project.checkLanguageFiles"></a> | |
| 1266 <h4>Project.checkLanguageFiles</h4> | |
| 1267 <b>checkLanguageFiles</b>(<i></i>) | |
| 1268 <p> | |
| 1269 Public slot to check the language files after a release process. | |
| 1270 </p><a NAME="Project.checkVCSStatus" ID="Project.checkVCSStatus"></a> | |
| 1271 <h4>Project.checkVCSStatus</h4> | |
| 1272 <b>checkVCSStatus</b>(<i></i>) | |
| 1273 <p> | |
| 1274 Public method to wake up the VCS status monitor thread. | |
| 1275 </p><a NAME="Project.clearStatusMonitorCachedState" ID="Project.clearStatusMonitorCachedState"></a> | |
| 1276 <h4>Project.clearStatusMonitorCachedState</h4> | |
| 1277 <b>clearStatusMonitorCachedState</b>(<i>name</i>) | |
| 1278 <p> | |
| 1279 Public method to clear the cached VCS state of a file/directory. | |
| 1280 </p><dl> | |
| 1281 <dt><i>name</i></dt> | |
| 1282 <dd> | |
| 1283 name of the entry to be cleared (string) | |
| 1284 </dd> | |
| 1285 </dl><a NAME="Project.closeProject" ID="Project.closeProject"></a> | |
| 1286 <h4>Project.closeProject</h4> | |
| 1287 <b>closeProject</b>(<i>reopen = False</i>) | |
| 1288 <p> | |
| 1289 Public slot to close the current project. | |
| 1290 </p><dl> | |
| 1291 <dt><i>reopen=</i></dt> | |
| 1292 <dd> | |
| 1293 flag indicating a reopening of the project (boolean) | |
| 1294 </dd> | |
| 1295 </dl><dl> | |
| 1296 <dt>Returns:</dt> | |
| 1297 <dd> | |
| 1298 flag indicating success (boolean) | |
| 1299 </dd> | |
| 1300 </dl><a NAME="Project.copyDirectory" ID="Project.copyDirectory"></a> | |
| 1301 <h4>Project.copyDirectory</h4> | |
| 1302 <b>copyDirectory</b>(<i>olddn, newdn</i>) | |
| 1303 <p> | |
| 1304 Public slot to copy a directory. | |
| 1305 </p><dl> | |
| 1306 <dt><i>olddn</i></dt> | |
| 1307 <dd> | |
| 1308 original directory name (string) | |
| 1309 </dd><dt><i>newdn</i></dt> | |
| 1310 <dd> | |
| 1311 new directory name (string) | |
| 1312 </dd> | |
| 1313 </dl><a NAME="Project.deleteDirectory" ID="Project.deleteDirectory"></a> | |
| 1314 <h4>Project.deleteDirectory</h4> | |
| 1315 <b>deleteDirectory</b>(<i>dn</i>) | |
| 1316 <p> | |
| 1317 Public slot to delete a directory from the project directory. | |
| 1318 </p><dl> | |
| 1319 <dt><i>dn</i></dt> | |
| 1320 <dd> | |
| 1321 directory name to be removed from the project | |
| 1322 </dd> | |
| 1323 </dl><dl> | |
| 1324 <dt>Returns:</dt> | |
| 1325 <dd> | |
| 1326 flag indicating success (boolean) | |
| 1327 </dd> | |
| 1328 </dl><a NAME="Project.deleteFile" ID="Project.deleteFile"></a> | |
| 1329 <h4>Project.deleteFile</h4> | |
| 1330 <b>deleteFile</b>(<i>fn</i>) | |
| 1331 <p> | |
| 1332 Public slot to delete a file from the project directory. | |
| 1333 </p><dl> | |
| 1334 <dt><i>fn</i></dt> | |
| 1335 <dd> | |
| 1336 filename to be deleted from the project | |
| 1337 </dd> | |
| 1338 </dl><dl> | |
| 1339 <dt>Returns:</dt> | |
| 1340 <dd> | |
| 1341 flag indicating success (boolean) | |
| 1342 </dd> | |
| 1343 </dl><a NAME="Project.deleteLanguageFile" ID="Project.deleteLanguageFile"></a> | |
| 1344 <h4>Project.deleteLanguageFile</h4> | |
| 1345 <b>deleteLanguageFile</b>(<i>langFile</i>) | |
| 1346 <p> | |
| 1347 Public slot to delete a translation from the project directory. | |
| 1348 </p><dl> | |
| 1349 <dt><i>langFile</i></dt> | |
| 1350 <dd> | |
| 1351 the translation file to be removed (string) | |
| 1352 </dd> | |
| 1353 </dl><a NAME="Project.getActions" ID="Project.getActions"></a> | |
| 1354 <h4>Project.getActions</h4> | |
| 1355 <b>getActions</b>(<i></i>) | |
| 1356 <p> | |
| 1357 Public method to get a list of all actions. | |
| 1358 </p><dl> | |
| 1359 <dt>Returns:</dt> | |
| 1360 <dd> | |
| 1361 list of all actions (list of E4Action) | |
| 1362 </dd> | |
| 1363 </dl><a NAME="Project.getData" ID="Project.getData"></a> | |
| 1364 <h4>Project.getData</h4> | |
| 1365 <b>getData</b>(<i>category, key</i>) | |
| 1366 <p> | |
| 1367 Public method to get data out of the project data store. | |
| 1368 </p><dl> | |
| 1369 <dt><i>category</i></dt> | |
| 1370 <dd> | |
| 1371 category of the data to get (string, one of | |
| 1372 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS, DOCUMENTATIONPARMS | |
| 1373 or OTHERTOOLSPARMS) | |
| 1374 </dd><dt><i>key</i></dt> | |
| 1375 <dd> | |
| 1376 key of the data entry to get (string). | |
| 1377 </dd> | |
| 1378 </dl><dl> | |
| 1379 <dt>Returns:</dt> | |
| 1380 <dd> | |
| 1381 a copy of the requested data or None | |
| 1382 </dd> | |
| 1383 </dl><a NAME="Project.getDebugProperty" ID="Project.getDebugProperty"></a> | |
| 1384 <h4>Project.getDebugProperty</h4> | |
| 1385 <b>getDebugProperty</b>(<i>key</i>) | |
| 1386 <p> | |
| 1387 Public method to retrieve a debugger property. | |
| 1388 </p><dl> | |
| 1389 <dt><i>key</i></dt> | |
| 1390 <dd> | |
| 1391 key of the property (string) | |
| 1392 </dd> | |
| 1393 </dl><dl> | |
| 1394 <dt>Returns:</dt> | |
| 1395 <dd> | |
| 1396 value of the property | |
| 1397 </dd> | |
| 1398 </dl><a NAME="Project.getDefaultSourceExtension" ID="Project.getDefaultSourceExtension"></a> | |
| 1399 <h4>Project.getDefaultSourceExtension</h4> | |
| 1400 <b>getDefaultSourceExtension</b>(<i></i>) | |
| 1401 <p> | |
| 1402 Public method to get the default extension for the project's | |
| 1403 programming language. | |
| 1404 </p><dl> | |
| 1405 <dt>Returns:</dt> | |
| 1406 <dd> | |
| 1407 default extension (including the dot) (string) | |
| 1408 </dd> | |
| 1409 </dl><a NAME="Project.getEditorLexerAssoc" ID="Project.getEditorLexerAssoc"></a> | |
| 1410 <h4>Project.getEditorLexerAssoc</h4> | |
| 1411 <b>getEditorLexerAssoc</b>(<i>filename</i>) | |
| 1412 <p> | |
| 1413 Public method to retrieve a lexer association. | |
| 1414 </p><dl> | |
| 1415 <dt><i>filename</i></dt> | |
| 1416 <dd> | |
| 1417 filename used to determine the associated lexer language (string) | |
| 1418 </dd> | |
| 1419 </dl><dl> | |
| 1420 <dt>Returns:</dt> | |
| 1421 <dd> | |
| 1422 the requested lexer language (string) | |
| 1423 </dd> | |
| 1424 </dl><a NAME="Project.getFiles" ID="Project.getFiles"></a> | |
| 1425 <h4>Project.getFiles</h4> | |
| 1426 <b>getFiles</b>(<i>start</i>) | |
| 1427 <p> | |
| 1428 Public method to get all files starting with a common prefix. | |
| 1429 </p><dl> | |
| 1430 <dt><i>start</i></dt> | |
| 1431 <dd> | |
| 1432 prefix (string) | |
| 1433 </dd> | |
| 1434 </dl><a NAME="Project.getMainScript" ID="Project.getMainScript"></a> | |
| 1435 <h4>Project.getMainScript</h4> | |
| 1436 <b>getMainScript</b>(<i>normalized = False</i>) | |
| 1437 <p> | |
| 1438 Public method to return the main script filename. | |
| 1439 </p><dl> | |
| 1440 <dt><i>normalized</i></dt> | |
| 1441 <dd> | |
| 1442 flag indicating a normalized filename is wanted (boolean) | |
| 1443 </dd> | |
| 1444 </dl><dl> | |
| 1445 <dt>Returns:</dt> | |
| 1446 <dd> | |
| 1447 filename of the projects main script (string) | |
| 1448 </dd> | |
| 1449 </dl><a NAME="Project.getMenu" ID="Project.getMenu"></a> | |
| 1450 <h4>Project.getMenu</h4> | |
| 1451 <b>getMenu</b>(<i>menuName</i>) | |
| 1452 <p> | |
| 1453 Public method to get a reference to the main menu or a submenu. | |
| 1454 </p><dl> | |
| 1455 <dt><i>menuName</i></dt> | |
| 1456 <dd> | |
| 1457 name of the menu (string) | |
| 1458 </dd> | |
| 1459 </dl><dl> | |
| 1460 <dt>Returns:</dt> | |
| 1461 <dd> | |
| 1462 reference to the requested menu (QMenu) or None | |
| 1463 </dd> | |
| 1464 </dl><a NAME="Project.getModel" ID="Project.getModel"></a> | |
| 1465 <h4>Project.getModel</h4> | |
| 1466 <b>getModel</b>(<i></i>) | |
| 1467 <p> | |
| 1468 Public method to get a reference to the project browser model. | |
| 1469 </p><dl> | |
| 1470 <dt>Returns:</dt> | |
| 1471 <dd> | |
| 1472 reference to the project browser model (ProjectBrowserModel) | |
| 1473 </dd> | |
| 1474 </dl><a NAME="Project.getMostRecent" ID="Project.getMostRecent"></a> | |
| 1475 <h4>Project.getMostRecent</h4> | |
| 1476 <b>getMostRecent</b>(<i></i>) | |
| 1477 <p> | |
| 1478 Public method to get the most recently opened project. | |
| 1479 </p><dl> | |
| 1480 <dt>Returns:</dt> | |
| 1481 <dd> | |
| 1482 path of the most recently opened project (string) | |
| 1483 </dd> | |
| 1484 </dl><a NAME="Project.getProjectDictionaries" ID="Project.getProjectDictionaries"></a> | |
| 1485 <h4>Project.getProjectDictionaries</h4> | |
| 1486 <b>getProjectDictionaries</b>(<i></i>) | |
| 1487 <p> | |
| 1488 Public method to get the names of the project specific dictionaries. | |
| 1489 </p><dl> | |
| 1490 <dt>Returns:</dt> | |
| 1491 <dd> | |
| 1492 tuple of two strings giving the absolute path names of the | |
| 1493 project specific word and exclude list | |
| 1494 </dd> | |
| 1495 </dl><a NAME="Project.getProjectFile" ID="Project.getProjectFile"></a> | |
| 1496 <h4>Project.getProjectFile</h4> | |
| 1497 <b>getProjectFile</b>(<i></i>) | |
| 1498 <p> | |
| 1499 Public method to get the path of the project file. | |
| 1500 </p><dl> | |
| 1501 <dt>Returns:</dt> | |
| 1502 <dd> | |
| 1503 path of the project file (string) | |
| 1504 </dd> | |
| 1505 </dl><a NAME="Project.getProjectLanguage" ID="Project.getProjectLanguage"></a> | |
| 1506 <h4>Project.getProjectLanguage</h4> | |
| 1507 <b>getProjectLanguage</b>(<i></i>) | |
| 1508 <p> | |
| 1509 Public method to get the project's programming language. | |
| 1510 </p><dl> | |
| 1511 <dt>Returns:</dt> | |
| 1512 <dd> | |
| 1513 programming language (string) | |
| 1514 </dd> | |
| 1515 </dl><a NAME="Project.getProjectManagementDir" ID="Project.getProjectManagementDir"></a> | |
| 1516 <h4>Project.getProjectManagementDir</h4> | |
| 1517 <b>getProjectManagementDir</b>(<i></i>) | |
| 1518 <p> | |
| 1519 Public method to get the path of the management directory. | |
| 1520 </p><dl> | |
| 1521 <dt>Returns:</dt> | |
| 1522 <dd> | |
| 1523 path of the management directory (string) | |
| 1524 </dd> | |
| 1525 </dl><a NAME="Project.getProjectPath" ID="Project.getProjectPath"></a> | |
| 1526 <h4>Project.getProjectPath</h4> | |
| 1527 <b>getProjectPath</b>(<i></i>) | |
| 1528 <p> | |
| 1529 Public method to get the project path. | |
| 1530 </p><dl> | |
| 1531 <dt>Returns:</dt> | |
| 1532 <dd> | |
| 1533 project path (string) | |
| 1534 </dd> | |
| 1535 </dl><a NAME="Project.getProjectSpellLanguage" ID="Project.getProjectSpellLanguage"></a> | |
| 1536 <h4>Project.getProjectSpellLanguage</h4> | |
| 1537 <b>getProjectSpellLanguage</b>(<i></i>) | |
| 1538 <p> | |
| 1539 Public method to get the project's programming language. | |
| 1540 </p><dl> | |
| 1541 <dt>Returns:</dt> | |
| 1542 <dd> | |
| 1543 programming language (string) | |
| 1544 </dd> | |
| 1545 </dl><a NAME="Project.getProjectType" ID="Project.getProjectType"></a> | |
| 1546 <h4>Project.getProjectType</h4> | |
| 1547 <b>getProjectType</b>(<i></i>) | |
| 1548 <p> | |
| 1549 Public method to get the type of the project. | |
| 1550 </p><dl> | |
| 1551 <dt>Returns:</dt> | |
| 1552 <dd> | |
| 1553 UI type of the project (string) | |
| 1554 </dd> | |
| 1555 </dl><a NAME="Project.getProjectTypes" ID="Project.getProjectTypes"></a> | |
| 1556 <h4>Project.getProjectTypes</h4> | |
| 1557 <b>getProjectTypes</b>(<i></i>) | |
| 1558 <p> | |
| 1559 Public method to get the list of supported project types. | |
| 1560 </p><dl> | |
| 1561 <dt>Returns:</dt> | |
| 1562 <dd> | |
| 1563 reference to the dictionary of project types. | |
| 1564 </dd> | |
| 1565 </dl><a NAME="Project.getSources" ID="Project.getSources"></a> | |
| 1566 <h4>Project.getSources</h4> | |
| 1567 <b>getSources</b>(<i>normalized = False</i>) | |
| 1568 <p> | |
| 1569 Public method to return the source script files. | |
| 1570 </p><dl> | |
| 1571 <dt><i>normalized</i></dt> | |
| 1572 <dd> | |
| 1573 flag indicating a normalized filename is wanted (boolean) | |
| 1574 </dd> | |
| 1575 </dl><dl> | |
| 1576 <dt>Returns:</dt> | |
| 1577 <dd> | |
| 1578 list of the projects scripts (list of string) | |
| 1579 </dd> | |
| 1580 </dl><a NAME="Project.getStatusMonitorAutoUpdate" ID="Project.getStatusMonitorAutoUpdate"></a> | |
| 1581 <h4>Project.getStatusMonitorAutoUpdate</h4> | |
| 1582 <b>getStatusMonitorAutoUpdate</b>(<i></i>) | |
| 1583 <p> | |
| 1584 Public method to retrieve the status of the auto update function. | |
| 1585 </p><dl> | |
| 1586 <dt>Returns:</dt> | |
| 1587 <dd> | |
| 1588 status of the auto update function (boolean) | |
| 1589 </dd> | |
| 1590 </dl><a NAME="Project.getStatusMonitorInterval" ID="Project.getStatusMonitorInterval"></a> | |
| 1591 <h4>Project.getStatusMonitorInterval</h4> | |
| 1592 <b>getStatusMonitorInterval</b>(<i></i>) | |
| 1593 <p> | |
| 1594 Public method to get the monitor interval. | |
| 1595 </p><dl> | |
| 1596 <dt>Returns:</dt> | |
| 1597 <dd> | |
| 1598 interval in seconds (integer) | |
| 1599 </dd> | |
| 1600 </dl><a NAME="Project.getVcs" ID="Project.getVcs"></a> | |
| 1601 <h4>Project.getVcs</h4> | |
| 1602 <b>getVcs</b>(<i></i>) | |
| 1603 <p> | |
| 1604 Public method to get a reference to the VCS object. | |
| 1605 </p><dl> | |
| 1606 <dt>Returns:</dt> | |
| 1607 <dd> | |
| 1608 reference to the VCS object | |
| 1609 </dd> | |
| 1610 </dl><a NAME="Project.handleApplicationDiagram" ID="Project.handleApplicationDiagram"></a> | |
| 1611 <h4>Project.handleApplicationDiagram</h4> | |
| 1612 <b>handleApplicationDiagram</b>(<i></i>) | |
| 1613 <p> | |
| 1614 Private method to handle the application diagram context menu action. | |
| 1615 </p><a NAME="Project.handlePreferencesChanged" ID="Project.handlePreferencesChanged"></a> | |
| 1616 <h4>Project.handlePreferencesChanged</h4> | |
| 1617 <b>handlePreferencesChanged</b>(<i></i>) | |
| 1618 <p> | |
| 1619 Public slot used to handle the preferencesChanged signal. | |
| 1620 </p><a NAME="Project.hasEntry" ID="Project.hasEntry"></a> | |
| 1621 <h4>Project.hasEntry</h4> | |
| 1622 <b>hasEntry</b>(<i>fn</i>) | |
| 1623 <p> | |
| 1624 Public method to check the project for a file. | |
| 1625 </p><dl> | |
| 1626 <dt><i>fn</i></dt> | |
| 1627 <dd> | |
| 1628 filename to be checked (string) | |
| 1629 </dd> | |
| 1630 </dl><dl> | |
| 1631 <dt>Returns:</dt> | |
| 1632 <dd> | |
| 1633 flag indicating, if the project contains the file (boolean) | |
| 1634 </dd> | |
| 1635 </dl><a NAME="Project.hasProjectType" ID="Project.hasProjectType"></a> | |
| 1636 <h4>Project.hasProjectType</h4> | |
| 1637 <b>hasProjectType</b>(<i>type_</i>) | |
| 1638 <p> | |
| 1639 Public method to check, if a project type is already registered. | |
| 1640 </p><dl> | |
| 1641 <dt><i>type_</i></dt> | |
| 1642 <dd> | |
| 1643 internal type designator to be unregistered (string) | |
| 1644 </dd> | |
| 1645 </dl><a NAME="Project.initActions" ID="Project.initActions"></a> | |
| 1646 <h4>Project.initActions</h4> | |
| 1647 <b>initActions</b>(<i></i>) | |
| 1648 <p> | |
| 1649 Public slot to initialize the project related actions. | |
| 1650 </p><a NAME="Project.initFileTypes" ID="Project.initFileTypes"></a> | |
| 1651 <h4>Project.initFileTypes</h4> | |
| 1652 <b>initFileTypes</b>(<i></i>) | |
| 1653 <p> | |
| 1654 Public method to initialize the filetype associations with default values. | |
| 1655 </p><a NAME="Project.initMenu" ID="Project.initMenu"></a> | |
| 1656 <h4>Project.initMenu</h4> | |
| 1657 <b>initMenu</b>(<i></i>) | |
| 1658 <p> | |
| 1659 Public slot to initialize the project menu. | |
| 1660 </p><dl> | |
| 1661 <dt>Returns:</dt> | |
| 1662 <dd> | |
| 1663 the menu generated (QMenu) | |
| 1664 </dd> | |
| 1665 </dl><a NAME="Project.initToolbar" ID="Project.initToolbar"></a> | |
| 1666 <h4>Project.initToolbar</h4> | |
| 1667 <b>initToolbar</b>(<i>toolbarManager</i>) | |
| 1668 <p> | |
| 1669 Public slot to initialize the project toolbar. | |
| 1670 </p><dl> | |
| 1671 <dt><i>toolbarManager</i></dt> | |
| 1672 <dd> | |
| 1673 reference to a toolbar manager object (E4ToolBarManager) | |
| 1674 </dd> | |
| 1675 </dl><dl> | |
| 1676 <dt>Returns:</dt> | |
| 1677 <dd> | |
| 1678 the toolbar generated (QToolBar) | |
| 1679 </dd> | |
| 1680 </dl><a NAME="Project.initVCS" ID="Project.initVCS"></a> | |
| 1681 <h4>Project.initVCS</h4> | |
| 1682 <b>initVCS</b>(<i>vcsSystem = None, nooverride = False</i>) | |
| 1683 <p> | |
| 1684 Public method used to instantiate a vcs system. | |
| 1685 </p><dl> | |
| 1686 <dt><i>vcsSystem</i></dt> | |
| 1687 <dd> | |
| 1688 type of VCS to be used (string) | |
| 1689 </dd><dt><i>nooverride</i></dt> | |
| 1690 <dd> | |
| 1691 flag indicating to ignore an override request (boolean) | |
| 1692 </dd> | |
| 1693 </dl><dl> | |
| 1694 <dt>Returns:</dt> | |
| 1695 <dd> | |
| 1696 a reference to the vcs object | |
| 1697 </dd> | |
| 1698 </dl><a NAME="Project.isDebugPropertiesLoaded" ID="Project.isDebugPropertiesLoaded"></a> | |
| 1699 <h4>Project.isDebugPropertiesLoaded</h4> | |
| 1700 <b>isDebugPropertiesLoaded</b>(<i></i>) | |
| 1701 <p> | |
| 1702 Public method to return the status of the debug properties. | |
| 1703 </p><dl> | |
| 1704 <dt>Returns:</dt> | |
| 1705 <dd> | |
| 1706 load status of debug properties (boolean) | |
| 1707 </dd> | |
| 1708 </dl><a NAME="Project.isDirty" ID="Project.isDirty"></a> | |
| 1709 <h4>Project.isDirty</h4> | |
| 1710 <b>isDirty</b>(<i></i>) | |
| 1711 <p> | |
| 1712 Public method to return the dirty state. | |
| 1713 </p><dl> | |
| 1714 <dt>Returns:</dt> | |
| 1715 <dd> | |
| 1716 dirty state (boolean) | |
| 1717 </dd> | |
| 1718 </dl><a NAME="Project.isOpen" ID="Project.isOpen"></a> | |
| 1719 <h4>Project.isOpen</h4> | |
| 1720 <b>isOpen</b>(<i></i>) | |
| 1721 <p> | |
| 1722 Public method to return the opened state. | |
| 1723 </p><dl> | |
| 1724 <dt>Returns:</dt> | |
| 1725 <dd> | |
| 1726 open state (boolean) | |
| 1727 </dd> | |
| 1728 </dl><a NAME="Project.isProjectFile" ID="Project.isProjectFile"></a> | |
| 1729 <h4>Project.isProjectFile</h4> | |
| 1730 <b>isProjectFile</b>(<i>fn</i>) | |
| 1731 <p> | |
| 1732 Public method used to check, if the passed in filename belongs to the project. | |
| 1733 </p><dl> | |
| 1734 <dt><i>fn</i></dt> | |
| 1735 <dd> | |
| 1736 filename to be checked (string) | |
| 1737 </dd> | |
| 1738 </dl><dl> | |
| 1739 <dt>Returns:</dt> | |
| 1740 <dd> | |
| 1741 flag indicating membership (boolean) | |
| 1742 </dd> | |
| 1743 </dl><a NAME="Project.isProjectForm" ID="Project.isProjectForm"></a> | |
| 1744 <h4>Project.isProjectForm</h4> | |
| 1745 <b>isProjectForm</b>(<i>fn</i>) | |
| 1746 <p> | |
| 1747 Public method used to check, if the passed in filename belongs to the project | |
| 1748 forms. | |
| 1749 </p><dl> | |
| 1750 <dt><i>fn</i></dt> | |
| 1751 <dd> | |
| 1752 filename to be checked (string) | |
| 1753 </dd> | |
| 1754 </dl><dl> | |
| 1755 <dt>Returns:</dt> | |
| 1756 <dd> | |
| 1757 flag indicating membership (boolean) | |
| 1758 </dd> | |
| 1759 </dl><a NAME="Project.isProjectInterface" ID="Project.isProjectInterface"></a> | |
| 1760 <h4>Project.isProjectInterface</h4> | |
| 1761 <b>isProjectInterface</b>(<i>fn</i>) | |
| 1762 <p> | |
| 1763 Public method used to check, if the passed in filename belongs to the project | |
| 1764 interfaces. | |
| 1765 </p><dl> | |
| 1766 <dt><i>fn</i></dt> | |
| 1767 <dd> | |
| 1768 filename to be checked (string) | |
| 1769 </dd> | |
| 1770 </dl><dl> | |
| 1771 <dt>Returns:</dt> | |
| 1772 <dd> | |
| 1773 flag indicating membership (boolean) | |
| 1774 </dd> | |
| 1775 </dl><a NAME="Project.isProjectResource" ID="Project.isProjectResource"></a> | |
| 1776 <h4>Project.isProjectResource</h4> | |
| 1777 <b>isProjectResource</b>(<i>fn</i>) | |
| 1778 <p> | |
| 1779 Public method used to check, if the passed in filename belongs to the project | |
| 1780 resources. | |
| 1781 </p><dl> | |
| 1782 <dt><i>fn</i></dt> | |
| 1783 <dd> | |
| 1784 filename to be checked (string) | |
| 1785 </dd> | |
| 1786 </dl><dl> | |
| 1787 <dt>Returns:</dt> | |
| 1788 <dd> | |
| 1789 flag indicating membership (boolean) | |
| 1790 </dd> | |
| 1791 </dl><a NAME="Project.isProjectSource" ID="Project.isProjectSource"></a> | |
| 1792 <h4>Project.isProjectSource</h4> | |
| 1793 <b>isProjectSource</b>(<i>fn</i>) | |
| 1794 <p> | |
| 1795 Public method used to check, if the passed in filename belongs to the project | |
| 1796 sources. | |
| 1797 </p><dl> | |
| 1798 <dt><i>fn</i></dt> | |
| 1799 <dd> | |
| 1800 filename to be checked (string) | |
| 1801 </dd> | |
| 1802 </dl><dl> | |
| 1803 <dt>Returns:</dt> | |
| 1804 <dd> | |
| 1805 flag indicating membership (boolean) | |
| 1806 </dd> | |
| 1807 </dl><a NAME="Project.moveDirectory" ID="Project.moveDirectory"></a> | |
| 1808 <h4>Project.moveDirectory</h4> | |
| 1809 <b>moveDirectory</b>(<i>olddn, newdn</i>) | |
| 1810 <p> | |
| 1811 Public slot to move a directory. | |
| 1812 </p><dl> | |
| 1813 <dt><i>olddn</i></dt> | |
| 1814 <dd> | |
| 1815 old directory name (string) | |
| 1816 </dd><dt><i>newdn</i></dt> | |
| 1817 <dd> | |
| 1818 new directory name (string) | |
| 1819 </dd> | |
| 1820 </dl><a NAME="Project.newProject" ID="Project.newProject"></a> | |
| 1821 <h4>Project.newProject</h4> | |
| 1822 <b>newProject</b>(<i></i>) | |
| 1823 <p> | |
| 1824 Public slot to built a new project. | |
| 1825 </p><p> | |
| 1826 This method displays the new project dialog and initializes | |
| 1827 the project object with the data entered. | |
| 1828 </p><a NAME="Project.newProjectAddFiles" ID="Project.newProjectAddFiles"></a> | |
| 1829 <h4>Project.newProjectAddFiles</h4> | |
| 1830 <b>newProjectAddFiles</b>(<i>mainscript</i>) | |
| 1831 <p> | |
| 1832 Public method to add files to a new project. | |
| 1833 </p><dl> | |
| 1834 <dt><i>mainscript</i></dt> | |
| 1835 <dd> | |
| 1836 name of the mainscript (string) | |
| 1837 </dd> | |
| 1838 </dl><a NAME="Project.openProject" ID="Project.openProject"></a> | |
| 1839 <h4>Project.openProject</h4> | |
| 1840 <b>openProject</b>(<i>fn = None, restoreSession = True, reopen = False</i>) | |
| 1841 <p> | |
| 1842 Public slot to open a project. | |
| 1843 </p><dl> | |
| 1844 <dt><i>fn</i></dt> | |
| 1845 <dd> | |
| 1846 optional filename of the project file to be read | |
| 1847 </dd><dt><i>restoreSession</i></dt> | |
| 1848 <dd> | |
| 1849 flag indicating to restore the project | |
| 1850 session (boolean) | |
| 1851 </dd><dt><i>reopen=</i></dt> | |
| 1852 <dd> | |
| 1853 flag indicating a reopening of the project (boolean) | |
| 1854 </dd> | |
| 1855 </dl><a NAME="Project.othersAdded" ID="Project.othersAdded"></a> | |
| 1856 <h4>Project.othersAdded</h4> | |
| 1857 <b>othersAdded</b>(<i>fn, updateModel = True</i>) | |
| 1858 <p> | |
| 1859 Public slot to be called, if something was added to the OTHERS project data area. | |
| 1860 </p><dl> | |
| 1861 <dt><i>fn</i></dt> | |
| 1862 <dd> | |
| 1863 filename or directory name added (string) | |
| 1864 </dd><dt><i>updateModel</i></dt> | |
| 1865 <dd> | |
| 1866 flag indicating an update of the model is requested (boolean) | |
| 1867 </dd> | |
| 1868 </dl><a NAME="Project.registerProjectType" ID="Project.registerProjectType"></a> | |
| 1869 <h4>Project.registerProjectType</h4> | |
| 1870 <b>registerProjectType</b>(<i>type_, description, fileTypeCallback = None, binaryTranslationsCallback = None, lexerAssociationCallback = None</i>) | |
| 1871 <p> | |
| 1872 Public method to register a project type. | |
| 1873 </p><dl> | |
| 1874 <dt><i>type_</i></dt> | |
| 1875 <dd> | |
| 1876 internal type designator to be registered (string) | |
| 1877 </dd><dt><i>description</i></dt> | |
| 1878 <dd> | |
| 1879 more verbose type name (display string) (string) | |
| 1880 </dd><dt><i>fileTypeCallback=</i></dt> | |
| 1881 <dd> | |
| 1882 reference to a method returning a dictionary | |
| 1883 of filetype associations. | |
| 1884 </dd><dt><i>binaryTranslationsCallback=</i></dt> | |
| 1885 <dd> | |
| 1886 reference to a method returning the | |
| 1887 name of the binary translation file given the name of the raw | |
| 1888 translation file | |
| 1889 </dd><dt><i>lexerAssociationCallback=</i></dt> | |
| 1890 <dd> | |
| 1891 reference to a method returning the | |
| 1892 lexer type to be used for syntax highlighting given the name of | |
| 1893 a file | |
| 1894 </dd> | |
| 1895 </dl><a NAME="Project.removeDirectory" ID="Project.removeDirectory"></a> | |
| 1896 <h4>Project.removeDirectory</h4> | |
| 1897 <b>removeDirectory</b>(<i>dn</i>) | |
| 1898 <p> | |
| 1899 Public slot to remove a directory from the project. | |
| 1900 </p><p> | |
| 1901 The directory is not deleted from the project directory. | |
| 1902 </p><dl> | |
| 1903 <dt><i>dn</i></dt> | |
| 1904 <dd> | |
| 1905 directory name to be removed from the project | |
| 1906 </dd> | |
| 1907 </dl><a NAME="Project.removeE4Actions" ID="Project.removeE4Actions"></a> | |
| 1908 <h4>Project.removeE4Actions</h4> | |
| 1909 <b>removeE4Actions</b>(<i>actions</i>) | |
| 1910 <p> | |
| 1911 Public method to remove actions from the list of actions. | |
| 1912 </p><dl> | |
| 1913 <dt><i>actions</i></dt> | |
| 1914 <dd> | |
| 1915 list of actions (list of E4Action) | |
| 1916 </dd> | |
| 1917 </dl><a NAME="Project.removeFile" ID="Project.removeFile"></a> | |
| 1918 <h4>Project.removeFile</h4> | |
| 1919 <b>removeFile</b>(<i>fn, updateModel = True</i>) | |
| 1920 <p> | |
| 1921 Public slot to remove a file from the project. | |
| 1922 </p><p> | |
| 1923 The file is not deleted from the project directory. | |
| 1924 </p><dl> | |
| 1925 <dt><i>fn</i></dt> | |
| 1926 <dd> | |
| 1927 filename to be removed from the project | |
| 1928 </dd><dt><i>updateModel</i></dt> | |
| 1929 <dd> | |
| 1930 flag indicating an update of the model is requested (boolean) | |
| 1931 </dd> | |
| 1932 </dl><a NAME="Project.removeLanguageFile" ID="Project.removeLanguageFile"></a> | |
| 1933 <h4>Project.removeLanguageFile</h4> | |
| 1934 <b>removeLanguageFile</b>(<i>langFile</i>) | |
| 1935 <p> | |
| 1936 Public slot to remove a translation from the project. | |
| 1937 </p><p> | |
| 1938 The translation file is not deleted from the project directory. | |
| 1939 </p><dl> | |
| 1940 <dt><i>langFile</i></dt> | |
| 1941 <dd> | |
| 1942 the translation file to be removed (string) | |
| 1943 </dd> | |
| 1944 </dl><a NAME="Project.renameFile" ID="Project.renameFile"></a> | |
| 1945 <h4>Project.renameFile</h4> | |
| 1946 <b>renameFile</b>(<i>oldfn, newfn = None</i>) | |
| 1947 <p> | |
| 1948 Public slot to rename a file of the project. | |
| 1949 </p><dl> | |
| 1950 <dt><i>oldfn</i></dt> | |
| 1951 <dd> | |
| 1952 old filename of the file (string) | |
| 1953 </dd><dt><i>newfn</i></dt> | |
| 1954 <dd> | |
| 1955 new filename of the file (string) | |
| 1956 </dd> | |
| 1957 </dl><dl> | |
| 1958 <dt>Returns:</dt> | |
| 1959 <dd> | |
| 1960 flag indicating success | |
| 1961 </dd> | |
| 1962 </dl><a NAME="Project.renameFileInPdata" ID="Project.renameFileInPdata"></a> | |
| 1963 <h4>Project.renameFileInPdata</h4> | |
| 1964 <b>renameFileInPdata</b>(<i>oldname, newname, isSourceFile = False</i>) | |
| 1965 <p> | |
| 1966 Public method to rename a file in the pdata structure. | |
| 1967 </p><dl> | |
| 1968 <dt><i>oldname</i></dt> | |
| 1969 <dd> | |
| 1970 old filename (string) | |
| 1971 </dd><dt><i>newname</i></dt> | |
| 1972 <dd> | |
| 1973 new filename (string) | |
| 1974 </dd><dt><i>isSourceFile</i></dt> | |
| 1975 <dd> | |
| 1976 flag indicating that this is a source file | |
| 1977 even if it doesn't have the source extension (boolean) | |
| 1978 </dd> | |
| 1979 </dl><a NAME="Project.renameMainScript" ID="Project.renameMainScript"></a> | |
| 1980 <h4>Project.renameMainScript</h4> | |
| 1981 <b>renameMainScript</b>(<i>oldfn, newfn</i>) | |
| 1982 <p> | |
| 1983 Public method to rename the main script. | |
| 1984 </p><dl> | |
| 1985 <dt><i>oldfn</i></dt> | |
| 1986 <dd> | |
| 1987 old filename (string) | |
| 1988 </dd><dt><i>newfn</i></dt> | |
| 1989 <dd> | |
| 1990 new filename of the main script (string) | |
| 1991 </dd> | |
| 1992 </dl><a NAME="Project.reopenProject" ID="Project.reopenProject"></a> | |
| 1993 <h4>Project.reopenProject</h4> | |
| 1994 <b>reopenProject</b>(<i></i>) | |
| 1995 <p> | |
| 1996 Public slot to reopen the current project. | |
| 1997 </p><a NAME="Project.repopulateItem" ID="Project.repopulateItem"></a> | |
| 1998 <h4>Project.repopulateItem</h4> | |
| 1999 <b>repopulateItem</b>(<i>fullname</i>) | |
| 2000 <p> | |
| 2001 Public slot to repopulate a named item. | |
| 2002 </p><dl> | |
| 2003 <dt><i>fullname</i></dt> | |
| 2004 <dd> | |
| 2005 full name of the item to repopulate (string) | |
| 2006 </dd> | |
| 2007 </dl><a NAME="Project.saveAllScripts" ID="Project.saveAllScripts"></a> | |
| 2008 <h4>Project.saveAllScripts</h4> | |
| 2009 <b>saveAllScripts</b>(<i>reportSyntaxErrors = False</i>) | |
| 2010 <p> | |
| 2011 Public method to save all scripts belonging to the project. | |
| 2012 </p><dl> | |
| 2013 <dt><i>reportSyntaxErrors=</i></dt> | |
| 2014 <dd> | |
| 2015 flag indicating special reporting | |
| 2016 for syntax errors (boolean) | |
| 2017 </dd> | |
| 2018 </dl><dl> | |
| 2019 <dt>Returns:</dt> | |
| 2020 <dd> | |
| 2021 flag indicating success (boolean) | |
| 2022 </dd> | |
| 2023 </dl><a NAME="Project.saveProject" ID="Project.saveProject"></a> | |
| 2024 <h4>Project.saveProject</h4> | |
| 2025 <b>saveProject</b>(<i></i>) | |
| 2026 <p> | |
| 2027 Public slot to save the current project. | |
| 2028 </p><dl> | |
| 2029 <dt>Returns:</dt> | |
| 2030 <dd> | |
| 2031 flag indicating success | |
| 2032 </dd> | |
| 2033 </dl><a NAME="Project.saveProjectAs" ID="Project.saveProjectAs"></a> | |
| 2034 <h4>Project.saveProjectAs</h4> | |
| 2035 <b>saveProjectAs</b>(<i></i>) | |
| 2036 <p> | |
| 2037 Public slot to save the current project to a different file. | |
| 2038 </p><dl> | |
| 2039 <dt>Returns:</dt> | |
| 2040 <dd> | |
| 2041 flag indicating success (boolean) | |
| 2042 </dd> | |
| 2043 </dl><a NAME="Project.setData" ID="Project.setData"></a> | |
| 2044 <h4>Project.setData</h4> | |
| 2045 <b>setData</b>(<i>category, key, data</i>) | |
| 2046 <p> | |
| 2047 Public method to store data in the project data store. | |
| 2048 </p><dl> | |
| 2049 <dt><i>category</i></dt> | |
| 2050 <dd> | |
| 2051 category of the data to get (string, one of | |
| 2052 PROJECTTYPESPECIFICDATA, CHECKERSPARMS, PACKAGERSPARMS, DOCUMENTATIONPARMS | |
| 2053 or OTHERTOOLSPARMS) | |
| 2054 </dd><dt><i>key</i></dt> | |
| 2055 <dd> | |
| 2056 key of the data entry to get (string). | |
| 2057 </dd><dt><i>data</i></dt> | |
| 2058 <dd> | |
| 2059 data to be stored | |
| 2060 </dd> | |
| 2061 </dl><dl> | |
| 2062 <dt>Returns:</dt> | |
| 2063 <dd> | |
| 2064 flag indicating success (boolean) | |
| 2065 </dd> | |
| 2066 </dl><a NAME="Project.setDbgInfo" ID="Project.setDbgInfo"></a> | |
| 2067 <h4>Project.setDbgInfo</h4> | |
| 2068 <b>setDbgInfo</b>(<i>argv, wd, env, excReporting, excList, excIgnoreList, autoClearShell, tracePython = None, autoContinue = None</i>) | |
| 2069 <p> | |
| 2070 Public method to set the debugging information. | |
| 2071 </p><dl> | |
| 2072 <dt><i>argv</i></dt> | |
| 2073 <dd> | |
| 2074 command line arguments to be used (string) | |
| 2075 </dd><dt><i>wd</i></dt> | |
| 2076 <dd> | |
| 2077 working directory (string) | |
| 2078 </dd><dt><i>env</i></dt> | |
| 2079 <dd> | |
| 2080 environment setting (string) | |
| 2081 </dd><dt><i>excReporting</i></dt> | |
| 2082 <dd> | |
| 2083 flag indicating the highlighting of exceptions | |
| 2084 </dd><dt><i>excList</i></dt> | |
| 2085 <dd> | |
| 2086 list of exceptions to be highlighted (list of strings) | |
| 2087 </dd><dt><i>excIgnoreList</i></dt> | |
| 2088 <dd> | |
| 2089 list of exceptions to be ignored (list of strings) | |
| 2090 </dd><dt><i>autoClearShell</i></dt> | |
| 2091 <dd> | |
| 2092 flag indicating, that the interpreter window | |
| 2093 should be cleared (boolean) | |
| 2094 </dd><dt><i>tracePython=</i></dt> | |
| 2095 <dd> | |
| 2096 flag to indicate if the Python library should be | |
| 2097 traced as well (boolean) | |
| 2098 </dd><dt><i>autoContinue=</i></dt> | |
| 2099 <dd> | |
| 2100 flag indicating, that the debugger should not stop | |
| 2101 at the first executable line (boolean) | |
| 2102 </dd> | |
| 2103 </dl><a NAME="Project.setDirty" ID="Project.setDirty"></a> | |
| 2104 <h4>Project.setDirty</h4> | |
| 2105 <b>setDirty</b>(<i>b</i>) | |
| 2106 <p> | |
| 2107 Public method to set the dirty state. | |
| 2108 </p><p> | |
| 2109 It emits the signal dirty(int). | |
| 2110 </p><dl> | |
| 2111 <dt><i>b</i></dt> | |
| 2112 <dd> | |
| 2113 dirty state (boolean) | |
| 2114 </dd> | |
| 2115 </dl><a NAME="Project.setStatusMonitorAutoUpdate" ID="Project.setStatusMonitorAutoUpdate"></a> | |
| 2116 <h4>Project.setStatusMonitorAutoUpdate</h4> | |
| 2117 <b>setStatusMonitorAutoUpdate</b>(<i>auto</i>) | |
| 2118 <p> | |
| 2119 Public method to enable the auto update function. | |
| 2120 </p><dl> | |
| 2121 <dt><i>auto</i></dt> | |
| 2122 <dd> | |
| 2123 status of the auto update function (boolean) | |
| 2124 </dd> | |
| 2125 </dl><a NAME="Project.setStatusMonitorInterval" ID="Project.setStatusMonitorInterval"></a> | |
| 2126 <h4>Project.setStatusMonitorInterval</h4> | |
| 2127 <b>setStatusMonitorInterval</b>(<i>interval</i>) | |
| 2128 <p> | |
| 2129 Public method to se the interval of the VCS status monitor thread. | |
| 2130 </p><dl> | |
| 2131 <dt><i>interval</i></dt> | |
| 2132 <dd> | |
| 2133 status monitor interval in seconds (integer) | |
| 2134 </dd> | |
| 2135 </dl><a NAME="Project.startStatusMonitor" ID="Project.startStatusMonitor"></a> | |
| 2136 <h4>Project.startStatusMonitor</h4> | |
| 2137 <b>startStatusMonitor</b>(<i></i>) | |
| 2138 <p> | |
| 2139 Public method to start the VCS status monitor thread. | |
| 2140 </p><a NAME="Project.stopStatusMonitor" ID="Project.stopStatusMonitor"></a> | |
| 2141 <h4>Project.stopStatusMonitor</h4> | |
| 2142 <b>stopStatusMonitor</b>(<i></i>) | |
| 2143 <p> | |
| 2144 Public method to stop the VCS status monitor thread. | |
| 2145 </p><a NAME="Project.unregisterProjectType" ID="Project.unregisterProjectType"></a> | |
| 2146 <h4>Project.unregisterProjectType</h4> | |
| 2147 <b>unregisterProjectType</b>(<i>type_</i>) | |
| 2148 <p> | |
| 2149 Public method to unregister a project type. | |
| 2150 </p><dl> | |
| 2151 <dt><i>type_</i></dt> | |
| 2152 <dd> | |
| 2153 internal type designator to be unregistered (string) | |
| 2154 </dd> | |
| 2155 </dl><a NAME="Project.updateFileTypes" ID="Project.updateFileTypes"></a> | |
| 2156 <h4>Project.updateFileTypes</h4> | |
| 2157 <b>updateFileTypes</b>(<i></i>) | |
| 2158 <p> | |
| 2159 Public method to update the filetype associations with new default values. | |
| 2160 </p> | |
| 2161 <div align="right"><a href="#top">Up</a></div> | |
| 2162 <hr /> | |
| 2163 </body></html> |
