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