Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.MultiProject.MultiProject.html

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

Mercurial Repository: eric

eric ide

mercurial