Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.MultiProject.MultiProject.html

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

Mercurial Repository: eric

eric ide

mercurial