Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Project.Project.html

Documentation/Source/eric6.Project.Project.html

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

Mercurial Repository: eric

eric ide

mercurial