Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.Project.Project.html

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

Mercurial Repository: eric

eric ide

mercurial