Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.MultiProject.MultiProject.html

Documentation/Source/eric4.MultiProject.MultiProject.html

changeset 3
0d9daebf5b8c
equal deleted inserted replaced
2:bc6196164237 3:0d9daebf5b8c
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
4 <html><head>
5 <title>eric4.MultiProject.MultiProject</title>
6 <style>
7 body {
8 background:white;
9 margin: 0em 1em 10em 1em;
10 color: black;
11 }
12
13 h1 { color: white; background: #4FA4FF; }
14 h2 { color: white; background: #4FA4FF; }
15 h3 { color: white; background: #00557F; }
16 h4 { color: white; background: #00557F; }
17
18 a { color: #AA5500; }
19
20 </style>
21 </head>
22 <body><a NAME="top" ID="top"></a>
23 <h1>eric4.MultiProject.MultiProject</h1>
24 <p>
25 Module implementing the multi project management functionality.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#MultiProject">MultiProject</a></td>
35 <td>Class implementing the project management functionality.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="MultiProject" ID="MultiProject"></a>
44 <h2>MultiProject</h2>
45 <p>
46 Class implementing the project management functionality.
47 </p><h4>Signals</h4>
48 <dl>
49 <dt>dirty(int)</dt>
50 <dd>
51 emitted when the dirty state changes
52 </dd><dt>multiProjectClosed()</dt>
53 <dd>
54 emitted after a multi project was closed
55 </dd><dt>multiProjectOpened()</dt>
56 <dd>
57 emitted after a multi project file was read
58 </dd><dt>multiProjectPropertiesChanged()</dt>
59 <dd>
60 emitted after the multi project
61 properties were changed
62 </dd><dt>newMultiProject()</dt>
63 <dd>
64 emitted after a new multi project was generated
65 </dd><dt>projectAdded(project data dict)</dt>
66 <dd>
67 emitted after a project entry
68 has been added
69 </dd><dt>projectDataChanged(project data dict)</dt>
70 <dd>
71 emitted after a project entry
72 has been changed
73 </dd><dt>projectOpened(filename)</dt>
74 <dd>
75 emitted after the project has been opened
76 </dd><dt>projectRemoved(project data dict)</dt>
77 <dd>
78 emitted after a project entry
79 has been removed
80 </dd><dt>showMenu(string, QMenu)</dt>
81 <dd>
82 emitted when a menu is about to be shown.
83 The name of the menu and a reference to the menu are given.
84 </dd>
85 </dl>
86 <h3>Derived from</h3>
87 QObject
88 <h3>Class Attributes</h3>
89 <table>
90 <tr><td>None</td></tr>
91 </table>
92 <h3>Methods</h3>
93 <table>
94 <tr>
95 <td><a href="#MultiProject.__init__">MultiProject</a></td>
96 <td>Constructor</td>
97 </tr><tr>
98 <td><a href="#MultiProject.__checkFilesExist">__checkFilesExist</a></td>
99 <td>Private method to check, if the files in a list exist.</td>
100 </tr><tr>
101 <td><a href="#MultiProject.__clearRecent">__clearRecent</a></td>
102 <td>Private method to clear the recent multi projects menu.</td>
103 </tr><tr>
104 <td><a href="#MultiProject.__initData">__initData</a></td>
105 <td>Private method to initialize the multi project data part.</td>
106 </tr><tr>
107 <td><a href="#MultiProject.__loadRecent">__loadRecent</a></td>
108 <td>Private method to load the recently opened multi project filenames.</td>
109 </tr><tr>
110 <td><a href="#MultiProject.__openMasterProject">__openMasterProject</a></td>
111 <td>Public slot to open the master project.</td>
112 </tr><tr>
113 <td><a href="#MultiProject.__openRecent">__openRecent</a></td>
114 <td>Private method to open a multi project from the list of rencently opened multi projects.</td>
115 </tr><tr>
116 <td><a href="#MultiProject.__readMultiProject">__readMultiProject</a></td>
117 <td>Private method to read in a multi project (.e4m, .e4mz) file.</td>
118 </tr><tr>
119 <td><a href="#MultiProject.__readXMLMultiProject">__readXMLMultiProject</a></td>
120 <td>Private method to read the multi project data from an XML file.</td>
121 </tr><tr>
122 <td><a href="#MultiProject.__saveRecent">__saveRecent</a></td>
123 <td>Private method to save the list of recently opened filenames.</td>
124 </tr><tr>
125 <td><a href="#MultiProject.__showContextMenuRecent">__showContextMenuRecent</a></td>
126 <td>Private method to set up the recent multi projects menu.</td>
127 </tr><tr>
128 <td><a href="#MultiProject.__showMenu">__showMenu</a></td>
129 <td>Private method to set up the multi project menu.</td>
130 </tr><tr>
131 <td><a href="#MultiProject.__showProperties">__showProperties</a></td>
132 <td>Private slot to display the properties dialog.</td>
133 </tr><tr>
134 <td><a href="#MultiProject.__syncRecent">__syncRecent</a></td>
135 <td>Private method to synchronize the list of recently opened multi projects with the central store.</td>
136 </tr><tr>
137 <td><a href="#MultiProject.__writeMultiProject">__writeMultiProject</a></td>
138 <td>Private method to save the multi project infos to a multi project file.</td>
139 </tr><tr>
140 <td><a href="#MultiProject.__writeXMLMultiProject">__writeXMLMultiProject</a></td>
141 <td>Private method to write the multi project data to an XML file.</td>
142 </tr><tr>
143 <td><a href="#MultiProject.addE4Actions">addE4Actions</a></td>
144 <td>Public method to add actions to the list of actions.</td>
145 </tr><tr>
146 <td><a href="#MultiProject.addProject">addProject</a></td>
147 <td>Public slot used to add files to the project.</td>
148 </tr><tr>
149 <td><a href="#MultiProject.changeProjectProperties">changeProjectProperties</a></td>
150 <td>Public method to change the data of a project entry.</td>
151 </tr><tr>
152 <td><a href="#MultiProject.checkDirty">checkDirty</a></td>
153 <td>Public method to check the dirty status and open a message window.</td>
154 </tr><tr>
155 <td><a href="#MultiProject.closeMultiProject">closeMultiProject</a></td>
156 <td>Public slot to close the current multi project.</td>
157 </tr><tr>
158 <td><a href="#MultiProject.getActions">getActions</a></td>
159 <td>Public method to get a list of all actions.</td>
160 </tr><tr>
161 <td><a href="#MultiProject.getDependantProjectFiles">getDependantProjectFiles</a></td>
162 <td>Public method to get the filenames of the dependant projects.</td>
163 </tr><tr>
164 <td><a href="#MultiProject.getMasterProjectFile">getMasterProjectFile</a></td>
165 <td>Public method to get the filename of the master project.</td>
166 </tr><tr>
167 <td><a href="#MultiProject.getMenu">getMenu</a></td>
168 <td>Public method to get a reference to the main menu or a submenu.</td>
169 </tr><tr>
170 <td><a href="#MultiProject.getMostRecent">getMostRecent</a></td>
171 <td>Public method to get the most recently opened multiproject.</td>
172 </tr><tr>
173 <td><a href="#MultiProject.getMultiProjectFile">getMultiProjectFile</a></td>
174 <td>Public method to get the path of the multi project file.</td>
175 </tr><tr>
176 <td><a href="#MultiProject.getMultiProjectPath">getMultiProjectPath</a></td>
177 <td>Public method to get the multi project path.</td>
178 </tr><tr>
179 <td><a href="#MultiProject.getProject">getProject</a></td>
180 <td>Public method to get a reference to a project entry.</td>
181 </tr><tr>
182 <td><a href="#MultiProject.getProjects">getProjects</a></td>
183 <td>Public method to get all project entries.</td>
184 </tr><tr>
185 <td><a href="#MultiProject.initActions">initActions</a></td>
186 <td>Public slot to initialize the multi project related actions.</td>
187 </tr><tr>
188 <td><a href="#MultiProject.initMenu">initMenu</a></td>
189 <td>Public slot to initialize the multi project menu.</td>
190 </tr><tr>
191 <td><a href="#MultiProject.initToolbar">initToolbar</a></td>
192 <td>Public slot to initialize the multi project toolbar.</td>
193 </tr><tr>
194 <td><a href="#MultiProject.isDirty">isDirty</a></td>
195 <td>Public method to return the dirty state.</td>
196 </tr><tr>
197 <td><a href="#MultiProject.isOpen">isOpen</a></td>
198 <td>Public method to return the opened state.</td>
199 </tr><tr>
200 <td><a href="#MultiProject.newMultiProject">newMultiProject</a></td>
201 <td>Public slot to build a new multi project.</td>
202 </tr><tr>
203 <td><a href="#MultiProject.openMultiProject">openMultiProject</a></td>
204 <td>Public slot to open a multi project.</td>
205 </tr><tr>
206 <td><a href="#MultiProject.openProject">openProject</a></td>
207 <td>Public slot to open a project.</td>
208 </tr><tr>
209 <td><a href="#MultiProject.removeE4Actions">removeE4Actions</a></td>
210 <td>Public method to remove actions from the list of actions.</td>
211 </tr><tr>
212 <td><a href="#MultiProject.removeProject">removeProject</a></td>
213 <td>Public slot to remove a project from the multi project.</td>
214 </tr><tr>
215 <td><a href="#MultiProject.saveMultiProject">saveMultiProject</a></td>
216 <td>Public slot to save the current multi project.</td>
217 </tr><tr>
218 <td><a href="#MultiProject.saveMultiProjectAs">saveMultiProjectAs</a></td>
219 <td>Public slot to save the current multi project to a different file.</td>
220 </tr><tr>
221 <td><a href="#MultiProject.setDirty">setDirty</a></td>
222 <td>Public method to set the dirty state.</td>
223 </tr>
224 </table>
225 <a NAME="MultiProject.__init__" ID="MultiProject.__init__"></a>
226 <h4>MultiProject (Constructor)</h4>
227 <b>MultiProject</b>(<i>project, parent = None, filename = None</i>)
228 <p>
229 Constructor
230 </p><dl>
231 <dt><i>project</i></dt>
232 <dd>
233 reference to the project object (Project.Project)
234 </dd><dt><i>parent</i></dt>
235 <dd>
236 parent widget (usually the ui object) (QWidget)
237 </dd><dt><i>filename</i></dt>
238 <dd>
239 optional filename of a multi project file to open (string)
240 </dd>
241 </dl><a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a>
242 <h4>MultiProject.__checkFilesExist</h4>
243 <b>__checkFilesExist</b>(<i></i>)
244 <p>
245 Private method to check, if the files in a list exist.
246 </p><p>
247 The project files are checked for existance in the
248 filesystem. Non existant projects are removed from the list and the
249 dirty state of the multi project is changed accordingly.
250 </p><a NAME="MultiProject.__clearRecent" ID="MultiProject.__clearRecent"></a>
251 <h4>MultiProject.__clearRecent</h4>
252 <b>__clearRecent</b>(<i></i>)
253 <p>
254 Private method to clear the recent multi projects menu.
255 </p><a NAME="MultiProject.__initData" ID="MultiProject.__initData"></a>
256 <h4>MultiProject.__initData</h4>
257 <b>__initData</b>(<i></i>)
258 <p>
259 Private method to initialize the multi project data part.
260 </p><a NAME="MultiProject.__loadRecent" ID="MultiProject.__loadRecent"></a>
261 <h4>MultiProject.__loadRecent</h4>
262 <b>__loadRecent</b>(<i></i>)
263 <p>
264 Private method to load the recently opened multi project filenames.
265 </p><a NAME="MultiProject.__openMasterProject" ID="MultiProject.__openMasterProject"></a>
266 <h4>MultiProject.__openMasterProject</h4>
267 <b>__openMasterProject</b>(<i>reopen = True</i>)
268 <p>
269 Public slot to open the master project.
270 </p><dl>
271 <dt><i>reopen</i></dt>
272 <dd>
273 flag indicating, that the master project should be
274 reopened, if it has been opened already (boolean)
275 </dd>
276 </dl><a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a>
277 <h4>MultiProject.__openRecent</h4>
278 <b>__openRecent</b>(<i>act</i>)
279 <p>
280 Private method to open a multi project from the list of rencently
281 opened multi projects.
282 </p><dl>
283 <dt><i>act</i></dt>
284 <dd>
285 reference to the action that triggered (QAction)
286 </dd>
287 </dl><a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a>
288 <h4>MultiProject.__readMultiProject</h4>
289 <b>__readMultiProject</b>(<i>fn</i>)
290 <p>
291 Private method to read in a multi project (.e4m, .e4mz) file.
292 </p><dl>
293 <dt><i>fn</i></dt>
294 <dd>
295 filename of the multi project file to be read (string)
296 </dd>
297 </dl><dl>
298 <dt>Returns:</dt>
299 <dd>
300 flag indicating success
301 </dd>
302 </dl><a NAME="MultiProject.__readXMLMultiProject" ID="MultiProject.__readXMLMultiProject"></a>
303 <h4>MultiProject.__readXMLMultiProject</h4>
304 <b>__readXMLMultiProject</b>(<i>fn, validating</i>)
305 <p>
306 Private method to read the multi project data from an XML file.
307 </p><dl>
308 <dt><i>fn</i></dt>
309 <dd>
310 filename of the multi project file to be read (string)
311 </dd><dt><i>validating</i></dt>
312 <dd>
313 flag indicating a validation of the XML file is
314 requested (boolean)
315 </dd>
316 </dl><dl>
317 <dt>Returns:</dt>
318 <dd>
319 flag indicating success
320 </dd>
321 </dl><a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a>
322 <h4>MultiProject.__saveRecent</h4>
323 <b>__saveRecent</b>(<i></i>)
324 <p>
325 Private method to save the list of recently opened filenames.
326 </p><a NAME="MultiProject.__showContextMenuRecent" ID="MultiProject.__showContextMenuRecent"></a>
327 <h4>MultiProject.__showContextMenuRecent</h4>
328 <b>__showContextMenuRecent</b>(<i></i>)
329 <p>
330 Private method to set up the recent multi projects menu.
331 </p><a NAME="MultiProject.__showMenu" ID="MultiProject.__showMenu"></a>
332 <h4>MultiProject.__showMenu</h4>
333 <b>__showMenu</b>(<i></i>)
334 <p>
335 Private method to set up the multi project menu.
336 </p><a NAME="MultiProject.__showProperties" ID="MultiProject.__showProperties"></a>
337 <h4>MultiProject.__showProperties</h4>
338 <b>__showProperties</b>(<i></i>)
339 <p>
340 Private slot to display the properties dialog.
341 </p><a NAME="MultiProject.__syncRecent" ID="MultiProject.__syncRecent"></a>
342 <h4>MultiProject.__syncRecent</h4>
343 <b>__syncRecent</b>(<i></i>)
344 <p>
345 Private method to synchronize the list of recently opened multi projects
346 with the central store.
347 </p><a NAME="MultiProject.__writeMultiProject" ID="MultiProject.__writeMultiProject"></a>
348 <h4>MultiProject.__writeMultiProject</h4>
349 <b>__writeMultiProject</b>(<i>fn = None</i>)
350 <p>
351 Private method to save the multi project infos to a multi project file.
352 </p><dl>
353 <dt><i>fn</i></dt>
354 <dd>
355 optional filename of the multi project file to be written.
356 If fn is None, the filename stored in the multi project object
357 is used. This is the 'save' action. If fn is given, this filename
358 is used instead of the one in the multi project object. This is the
359 'save as' action.
360 </dd>
361 </dl><dl>
362 <dt>Returns:</dt>
363 <dd>
364 flag indicating success
365 </dd>
366 </dl><a NAME="MultiProject.__writeXMLMultiProject" ID="MultiProject.__writeXMLMultiProject"></a>
367 <h4>MultiProject.__writeXMLMultiProject</h4>
368 <b>__writeXMLMultiProject</b>(<i>fn = None</i>)
369 <p>
370 Private method to write the multi project data to an XML file.
371 </p><dl>
372 <dt><i>fn</i></dt>
373 <dd>
374 the filename of the multi project file (string)
375 </dd>
376 </dl><a NAME="MultiProject.addE4Actions" ID="MultiProject.addE4Actions"></a>
377 <h4>MultiProject.addE4Actions</h4>
378 <b>addE4Actions</b>(<i>actions</i>)
379 <p>
380 Public method to add actions to the list of actions.
381 </p><dl>
382 <dt><i>actions</i></dt>
383 <dd>
384 list of actions (list of E4Action)
385 </dd>
386 </dl><a NAME="MultiProject.addProject" ID="MultiProject.addProject"></a>
387 <h4>MultiProject.addProject</h4>
388 <b>addProject</b>(<i>startdir = None</i>)
389 <p>
390 Public slot used to add files to the project.
391 </p><dl>
392 <dt><i>startdir</i></dt>
393 <dd>
394 start directory for the selection dialog (string)
395 </dd>
396 </dl><a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a>
397 <h4>MultiProject.changeProjectProperties</h4>
398 <b>changeProjectProperties</b>(<i>pro</i>)
399 <p>
400 Public method to change the data of a project entry.
401 </p><dl>
402 <dt><i>pro</i></dt>
403 <dd>
404 dictionary with the project data (string)
405 </dd>
406 </dl><a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a>
407 <h4>MultiProject.checkDirty</h4>
408 <b>checkDirty</b>(<i></i>)
409 <p>
410 Public method to check the dirty status and open a message window.
411 </p><dl>
412 <dt>Returns:</dt>
413 <dd>
414 flag indicating whether this operation was successful (boolean)
415 </dd>
416 </dl><a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a>
417 <h4>MultiProject.closeMultiProject</h4>
418 <b>closeMultiProject</b>(<i></i>)
419 <p>
420 Public slot to close the current multi project.
421 </p><dl>
422 <dt>Returns:</dt>
423 <dd>
424 flag indicating success (boolean)
425 </dd>
426 </dl><a NAME="MultiProject.getActions" ID="MultiProject.getActions"></a>
427 <h4>MultiProject.getActions</h4>
428 <b>getActions</b>(<i></i>)
429 <p>
430 Public method to get a list of all actions.
431 </p><dl>
432 <dt>Returns:</dt>
433 <dd>
434 list of all actions (list of E4Action)
435 </dd>
436 </dl><a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a>
437 <h4>MultiProject.getDependantProjectFiles</h4>
438 <b>getDependantProjectFiles</b>(<i></i>)
439 <p>
440 Public method to get the filenames of the dependant projects.
441 </p><dl>
442 <dt>Returns:</dt>
443 <dd>
444 names of the dependant project files (list of strings)
445 </dd>
446 </dl><a NAME="MultiProject.getMasterProjectFile" ID="MultiProject.getMasterProjectFile"></a>
447 <h4>MultiProject.getMasterProjectFile</h4>
448 <b>getMasterProjectFile</b>(<i></i>)
449 <p>
450 Public method to get the filename of the master project.
451 </p><dl>
452 <dt>Returns:</dt>
453 <dd>
454 name of the master project file (string)
455 </dd>
456 </dl><a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a>
457 <h4>MultiProject.getMenu</h4>
458 <b>getMenu</b>(<i>menuName</i>)
459 <p>
460 Public method to get a reference to the main menu or a submenu.
461 </p><dl>
462 <dt><i>menuName</i></dt>
463 <dd>
464 name of the menu (string)
465 </dd>
466 </dl><dl>
467 <dt>Returns:</dt>
468 <dd>
469 reference to the requested menu (QMenu) or None
470 </dd>
471 </dl><a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a>
472 <h4>MultiProject.getMostRecent</h4>
473 <b>getMostRecent</b>(<i></i>)
474 <p>
475 Public method to get the most recently opened multiproject.
476 </p><dl>
477 <dt>Returns:</dt>
478 <dd>
479 path of the most recently opened multiproject (string)
480 </dd>
481 </dl><a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a>
482 <h4>MultiProject.getMultiProjectFile</h4>
483 <b>getMultiProjectFile</b>(<i></i>)
484 <p>
485 Public method to get the path of the multi project file.
486 </p><dl>
487 <dt>Returns:</dt>
488 <dd>
489 path of the multi project file (string)
490 </dd>
491 </dl><a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a>
492 <h4>MultiProject.getMultiProjectPath</h4>
493 <b>getMultiProjectPath</b>(<i></i>)
494 <p>
495 Public method to get the multi project path.
496 </p><dl>
497 <dt>Returns:</dt>
498 <dd>
499 multi project path (string)
500 </dd>
501 </dl><a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a>
502 <h4>MultiProject.getProject</h4>
503 <b>getProject</b>(<i>fn</i>)
504 <p>
505 Public method to get a reference to a project entry.
506 </p><dl>
507 <dt><i>fn</i></dt>
508 <dd>
509 filename of the project (string)
510 </dd>
511 </dl><dl>
512 <dt>Returns:</dt>
513 <dd>
514 dictionary containing the project data
515 </dd>
516 </dl><a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a>
517 <h4>MultiProject.getProjects</h4>
518 <b>getProjects</b>(<i></i>)
519 <p>
520 Public method to get all project entries.
521 </p><dl>
522 <dt>Returns:</dt>
523 <dd>
524 list of all project entries (list of dictionaries)
525 </dd>
526 </dl><a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a>
527 <h4>MultiProject.initActions</h4>
528 <b>initActions</b>(<i></i>)
529 <p>
530 Public slot to initialize the multi project related actions.
531 </p><a NAME="MultiProject.initMenu" ID="MultiProject.initMenu"></a>
532 <h4>MultiProject.initMenu</h4>
533 <b>initMenu</b>(<i></i>)
534 <p>
535 Public slot to initialize the multi project menu.
536 </p><dl>
537 <dt>Returns:</dt>
538 <dd>
539 the menu generated (QMenu)
540 </dd>
541 </dl><a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a>
542 <h4>MultiProject.initToolbar</h4>
543 <b>initToolbar</b>(<i>toolbarManager</i>)
544 <p>
545 Public slot to initialize the multi project toolbar.
546 </p><dl>
547 <dt><i>toolbarManager</i></dt>
548 <dd>
549 reference to a toolbar manager object (E4ToolBarManager)
550 </dd>
551 </dl><dl>
552 <dt>Returns:</dt>
553 <dd>
554 the toolbar generated (QToolBar)
555 </dd>
556 </dl><a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a>
557 <h4>MultiProject.isDirty</h4>
558 <b>isDirty</b>(<i></i>)
559 <p>
560 Public method to return the dirty state.
561 </p><dl>
562 <dt>Returns:</dt>
563 <dd>
564 dirty state (boolean)
565 </dd>
566 </dl><a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a>
567 <h4>MultiProject.isOpen</h4>
568 <b>isOpen</b>(<i></i>)
569 <p>
570 Public method to return the opened state.
571 </p><dl>
572 <dt>Returns:</dt>
573 <dd>
574 open state (boolean)
575 </dd>
576 </dl><a NAME="MultiProject.newMultiProject" ID="MultiProject.newMultiProject"></a>
577 <h4>MultiProject.newMultiProject</h4>
578 <b>newMultiProject</b>(<i></i>)
579 <p>
580 Public slot to build a new multi project.
581 </p><p>
582 This method displays the new multi project dialog and initializes
583 the multi project object with the data entered.
584 </p><a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a>
585 <h4>MultiProject.openMultiProject</h4>
586 <b>openMultiProject</b>(<i>fn = None, openMaster = True</i>)
587 <p>
588 Public slot to open a multi project.
589 </p><dl>
590 <dt><i>fn</i></dt>
591 <dd>
592 optional filename of the multi project file to be read (string)
593 </dd><dt><i>openMaster</i></dt>
594 <dd>
595 flag indicating, that the master project
596 should be opened depending on the configuration (boolean)
597 </dd>
598 </dl><a NAME="MultiProject.openProject" ID="MultiProject.openProject"></a>
599 <h4>MultiProject.openProject</h4>
600 <b>openProject</b>(<i>filename</i>)
601 <p>
602 Public slot to open a project.
603 </p><dl>
604 <dt><i>filename</i></dt>
605 <dd>
606 filename of the project file (string)
607 </dd>
608 </dl><a NAME="MultiProject.removeE4Actions" ID="MultiProject.removeE4Actions"></a>
609 <h4>MultiProject.removeE4Actions</h4>
610 <b>removeE4Actions</b>(<i>actions</i>)
611 <p>
612 Public method to remove actions from the list of actions.
613 </p><dl>
614 <dt><i>actions</i></dt>
615 <dd>
616 list of actions (list of E4Action)
617 </dd>
618 </dl><a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a>
619 <h4>MultiProject.removeProject</h4>
620 <b>removeProject</b>(<i>fn</i>)
621 <p>
622 Public slot to remove a project from the multi project.
623 </p><dl>
624 <dt><i>fn</i></dt>
625 <dd>
626 filename of the project to be removed from the multi project (string)
627 </dd>
628 </dl><a NAME="MultiProject.saveMultiProject" ID="MultiProject.saveMultiProject"></a>
629 <h4>MultiProject.saveMultiProject</h4>
630 <b>saveMultiProject</b>(<i></i>)
631 <p>
632 Public slot to save the current multi project.
633 </p><dl>
634 <dt>Returns:</dt>
635 <dd>
636 flag indicating success (boolean)
637 </dd>
638 </dl><a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a>
639 <h4>MultiProject.saveMultiProjectAs</h4>
640 <b>saveMultiProjectAs</b>(<i></i>)
641 <p>
642 Public slot to save the current multi project to a different file.
643 </p><dl>
644 <dt>Returns:</dt>
645 <dd>
646 flag indicating success (boolean)
647 </dd>
648 </dl><a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a>
649 <h4>MultiProject.setDirty</h4>
650 <b>setDirty</b>(<i>b</i>)
651 <p>
652 Public method to set the dirty state.
653 </p><p>
654 It emits the signal dirty(int).
655 </p><dl>
656 <dt><i>b</i></dt>
657 <dd>
658 dirty state (boolean)
659 </dd>
660 </dl>
661 <div align="right"><a href="#top">Up</a></div>
662 <hr />
663 </body></html>

Mercurial Repository: eric

eric ide

mercurial