Mercurial Repositories > eric / file comparison

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

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

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.MultiProject.MultiProject</h1> 23 <h1>eric6.MultiProject.MultiProject</h1>
24
23 <p> 25 <p>
24 Module implementing the multi project management functionality. 26 Module implementing the multi project management functionality.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#MultiProject">MultiProject</a></td> 38 <td><a href="#MultiProject">MultiProject</a></td>
34 <td>Class implementing the project management functionality.</td> 39 <td>Class implementing the project management functionality.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="MultiProject" ID="MultiProject"></a> 49 <a NAME="MultiProject" ID="MultiProject"></a>
43 <h2>MultiProject</h2> 50 <h2>MultiProject</h2>
51
44 <p> 52 <p>
45 Class implementing the project management functionality. 53 Class implementing the project management functionality.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>dirty(bool)</dt> 58 <dt>dirty(bool)</dt>
49 <dd> 59 <dd>
50 emitted when the dirty state changes 60 emitted when the dirty state changes
51 </dd><dt>multiProjectClosed()</dt> 61 </dd>
62 <dt>multiProjectClosed()</dt>
52 <dd> 63 <dd>
53 emitted after a multi project was closed 64 emitted after a multi project was closed
54 </dd><dt>multiProjectOpened()</dt> 65 </dd>
66 <dt>multiProjectOpened()</dt>
55 <dd> 67 <dd>
56 emitted after a multi project file was read 68 emitted after a multi project file was read
57 </dd><dt>multiProjectPropertiesChanged()</dt> 69 </dd>
70 <dt>multiProjectPropertiesChanged()</dt>
58 <dd> 71 <dd>
59 emitted after the multi project 72 emitted after the multi project
60 properties were changed 73 properties were changed
61 </dd><dt>newMultiProject()</dt> 74 </dd>
75 <dt>newMultiProject()</dt>
62 <dd> 76 <dd>
63 emitted after a new multi project was generated 77 emitted after a new multi project was generated
64 </dd><dt>projectAdded(project data dict)</dt> 78 </dd>
79 <dt>projectAdded(project data dict)</dt>
65 <dd> 80 <dd>
66 emitted after a project entry 81 emitted after a project entry
67 has been added 82 has been added
68 </dd><dt>projectDataChanged(project data dict)</dt> 83 </dd>
84 <dt>projectDataChanged(project data dict)</dt>
69 <dd> 85 <dd>
70 emitted after a project entry 86 emitted after a project entry
71 has been changed 87 has been changed
72 </dd><dt>projectOpened(filename)</dt> 88 </dd>
89 <dt>projectOpened(filename)</dt>
73 <dd> 90 <dd>
74 emitted after the project has been opened 91 emitted after the project has been opened
75 </dd><dt>projectRemoved(project data dict)</dt> 92 </dd>
93 <dt>projectRemoved(project data dict)</dt>
76 <dd> 94 <dd>
77 emitted after a project entry 95 emitted after a project entry
78 has been removed 96 has been removed
79 </dd><dt>showMenu(string, QMenu)</dt> 97 </dd>
98 <dt>showMenu(string, QMenu)</dt>
80 <dd> 99 <dd>
81 emitted when a menu is about to be shown. 100 emitted when a menu is about to be shown.
82 The name of the menu and a reference to the menu are given. 101 The name of the menu and a reference to the menu are given.
83 </dd> 102 </dd>
84 </dl> 103 </dl>
85 <h3>Derived from</h3> 104 <h3>Derived from</h3>
86 QObject 105 QObject
87 <h3>Class Attributes</h3> 106 <h3>Class Attributes</h3>
107
88 <table> 108 <table>
89 <tr><td>None</td></tr> 109 <tr><td>None</td></tr>
90 </table> 110 </table>
91 <h3>Class Methods</h3> 111 <h3>Class Methods</h3>
112
92 <table> 113 <table>
93 <tr><td>None</td></tr> 114 <tr><td>None</td></tr>
94 </table> 115 </table>
95 <h3>Methods</h3> 116 <h3>Methods</h3>
117
96 <table> 118 <table>
119
97 <tr> 120 <tr>
98 <td><a href="#MultiProject.__init__">MultiProject</a></td> 121 <td><a href="#MultiProject.__init__">MultiProject</a></td>
99 <td>Constructor</td> 122 <td>Constructor</td>
100 </tr><tr> 123 </tr>
124 <tr>
101 <td><a href="#MultiProject.__checkFilesExist">__checkFilesExist</a></td> 125 <td><a href="#MultiProject.__checkFilesExist">__checkFilesExist</a></td>
102 <td>Private method to check, if the files in a list exist.</td> 126 <td>Private method to check, if the files in a list exist.</td>
103 </tr><tr> 127 </tr>
128 <tr>
104 <td><a href="#MultiProject.__extractCategories">__extractCategories</a></td> 129 <td><a href="#MultiProject.__extractCategories">__extractCategories</a></td>
105 <td>Private slot to extract the categories used in the project definitions.</td> 130 <td>Private slot to extract the categories used in the project definitions.</td>
106 </tr><tr> 131 </tr>
132 <tr>
107 <td><a href="#MultiProject.__initData">__initData</a></td> 133 <td><a href="#MultiProject.__initData">__initData</a></td>
108 <td>Private method to initialize the multi project data part.</td> 134 <td>Private method to initialize the multi project data part.</td>
109 </tr><tr> 135 </tr>
136 <tr>
110 <td><a href="#MultiProject.__loadRecent">__loadRecent</a></td> 137 <td><a href="#MultiProject.__loadRecent">__loadRecent</a></td>
111 <td>Private method to load the recently opened multi project filenames.</td> 138 <td>Private method to load the recently opened multi project filenames.</td>
112 </tr><tr> 139 </tr>
140 <tr>
113 <td><a href="#MultiProject.__newMultiProject">__newMultiProject</a></td> 141 <td><a href="#MultiProject.__newMultiProject">__newMultiProject</a></td>
114 <td>Private slot to build a new multi project.</td> 142 <td>Private slot to build a new multi project.</td>
115 </tr><tr> 143 </tr>
144 <tr>
116 <td><a href="#MultiProject.__openMasterProject">__openMasterProject</a></td> 145 <td><a href="#MultiProject.__openMasterProject">__openMasterProject</a></td>
117 <td>Private slot to open the master project.</td> 146 <td>Private slot to open the master project.</td>
118 </tr><tr> 147 </tr>
148 <tr>
119 <td><a href="#MultiProject.__openRecent">__openRecent</a></td> 149 <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> 150 <td>Private method to open a multi project from the list of rencently opened multi projects.</td>
121 </tr><tr> 151 </tr>
152 <tr>
122 <td><a href="#MultiProject.__readMultiProject">__readMultiProject</a></td> 153 <td><a href="#MultiProject.__readMultiProject">__readMultiProject</a></td>
123 <td>Private method to read in a multi project (.e4m, .e5m) file.</td> 154 <td>Private method to read in a multi project (.e4m, .e5m) file.</td>
124 </tr><tr> 155 </tr>
156 <tr>
125 <td><a href="#MultiProject.__saveRecent">__saveRecent</a></td> 157 <td><a href="#MultiProject.__saveRecent">__saveRecent</a></td>
126 <td>Private method to save the list of recently opened filenames.</td> 158 <td>Private method to save the list of recently opened filenames.</td>
127 </tr><tr> 159 </tr>
160 <tr>
128 <td><a href="#MultiProject.__showContextMenuRecent">__showContextMenuRecent</a></td> 161 <td><a href="#MultiProject.__showContextMenuRecent">__showContextMenuRecent</a></td>
129 <td>Private method to set up the recent multi projects menu.</td> 162 <td>Private method to set up the recent multi projects menu.</td>
130 </tr><tr> 163 </tr>
164 <tr>
131 <td><a href="#MultiProject.__showMenu">__showMenu</a></td> 165 <td><a href="#MultiProject.__showMenu">__showMenu</a></td>
132 <td>Private method to set up the multi project menu.</td> 166 <td>Private method to set up the multi project menu.</td>
133 </tr><tr> 167 </tr>
168 <tr>
134 <td><a href="#MultiProject.__showProperties">__showProperties</a></td> 169 <td><a href="#MultiProject.__showProperties">__showProperties</a></td>
135 <td>Private slot to display the properties dialog.</td> 170 <td>Private slot to display the properties dialog.</td>
136 </tr><tr> 171 </tr>
172 <tr>
137 <td><a href="#MultiProject.__syncRecent">__syncRecent</a></td> 173 <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> 174 <td>Private method to synchronize the list of recently opened multi projects with the central store.</td>
139 </tr><tr> 175 </tr>
176 <tr>
140 <td><a href="#MultiProject.__writeMultiProject">__writeMultiProject</a></td> 177 <td><a href="#MultiProject.__writeMultiProject">__writeMultiProject</a></td>
141 <td>Private method to save the multi project infos to a multi project file.</td> 178 <td>Private method to save the multi project infos to a multi project file.</td>
142 </tr><tr> 179 </tr>
180 <tr>
143 <td><a href="#MultiProject.addE5Actions">addE5Actions</a></td> 181 <td><a href="#MultiProject.addE5Actions">addE5Actions</a></td>
144 <td>Public method to add actions to the list of actions.</td> 182 <td>Public method to add actions to the list of actions.</td>
145 </tr><tr> 183 </tr>
184 <tr>
146 <td><a href="#MultiProject.addNewProject">addNewProject</a></td> 185 <td><a href="#MultiProject.addNewProject">addNewProject</a></td>
147 <td>Public slot used to add a new project to the multi-project.</td> 186 <td>Public slot used to add a new project to the multi-project.</td>
148 </tr><tr> 187 </tr>
188 <tr>
149 <td><a href="#MultiProject.addProject">addProject</a></td> 189 <td><a href="#MultiProject.addProject">addProject</a></td>
150 <td>Public method to add a project to the multi-project.</td> 190 <td>Public method to add a project to the multi-project.</td>
151 </tr><tr> 191 </tr>
192 <tr>
152 <td><a href="#MultiProject.changeProjectProperties">changeProjectProperties</a></td> 193 <td><a href="#MultiProject.changeProjectProperties">changeProjectProperties</a></td>
153 <td>Public method to change the data of a project entry.</td> 194 <td>Public method to change the data of a project entry.</td>
154 </tr><tr> 195 </tr>
196 <tr>
155 <td><a href="#MultiProject.checkDirty">checkDirty</a></td> 197 <td><a href="#MultiProject.checkDirty">checkDirty</a></td>
156 <td>Public method to check the dirty status and open a message window.</td> 198 <td>Public method to check the dirty status and open a message window.</td>
157 </tr><tr> 199 </tr>
200 <tr>
158 <td><a href="#MultiProject.clearRecent">clearRecent</a></td> 201 <td><a href="#MultiProject.clearRecent">clearRecent</a></td>
159 <td>Public method to clear the recent multi projects menu.</td> 202 <td>Public method to clear the recent multi projects menu.</td>
160 </tr><tr> 203 </tr>
204 <tr>
161 <td><a href="#MultiProject.closeMultiProject">closeMultiProject</a></td> 205 <td><a href="#MultiProject.closeMultiProject">closeMultiProject</a></td>
162 <td>Public slot to close the current multi project.</td> 206 <td>Public slot to close the current multi project.</td>
163 </tr><tr> 207 </tr>
208 <tr>
164 <td><a href="#MultiProject.copyProject">copyProject</a></td> 209 <td><a href="#MultiProject.copyProject">copyProject</a></td>
165 <td>Public method to copy the project with given UID on disk.</td> 210 <td>Public method to copy the project with given UID on disk.</td>
166 </tr><tr> 211 </tr>
212 <tr>
167 <td><a href="#MultiProject.deleteProject">deleteProject</a></td> 213 <td><a href="#MultiProject.deleteProject">deleteProject</a></td>
168 <td>Public slot to delete project(s) from the multi project and disk.</td> 214 <td>Public slot to delete project(s) from the multi project and disk.</td>
169 </tr><tr> 215 </tr>
216 <tr>
170 <td><a href="#MultiProject.getActions">getActions</a></td> 217 <td><a href="#MultiProject.getActions">getActions</a></td>
171 <td>Public method to get a list of all actions.</td> 218 <td>Public method to get a list of all actions.</td>
172 </tr><tr> 219 </tr>
220 <tr>
173 <td><a href="#MultiProject.getCategories">getCategories</a></td> 221 <td><a href="#MultiProject.getCategories">getCategories</a></td>
174 <td>Public method to get the list of defined categories.</td> 222 <td>Public method to get the list of defined categories.</td>
175 </tr><tr> 223 </tr>
224 <tr>
176 <td><a href="#MultiProject.getDependantProjectFiles">getDependantProjectFiles</a></td> 225 <td><a href="#MultiProject.getDependantProjectFiles">getDependantProjectFiles</a></td>
177 <td>Public method to get the filenames of the dependent projects.</td> 226 <td>Public method to get the filenames of the dependent projects.</td>
178 </tr><tr> 227 </tr>
228 <tr>
179 <td><a href="#MultiProject.getMasterProjectFile">getMasterProjectFile</a></td> 229 <td><a href="#MultiProject.getMasterProjectFile">getMasterProjectFile</a></td>
180 <td>Public method to get the filename of the master project.</td> 230 <td>Public method to get the filename of the master project.</td>
181 </tr><tr> 231 </tr>
232 <tr>
182 <td><a href="#MultiProject.getMenu">getMenu</a></td> 233 <td><a href="#MultiProject.getMenu">getMenu</a></td>
183 <td>Public method to get a reference to the main menu or a submenu.</td> 234 <td>Public method to get a reference to the main menu or a submenu.</td>
184 </tr><tr> 235 </tr>
236 <tr>
185 <td><a href="#MultiProject.getMostRecent">getMostRecent</a></td> 237 <td><a href="#MultiProject.getMostRecent">getMostRecent</a></td>
186 <td>Public method to get the most recently opened multiproject.</td> 238 <td>Public method to get the most recently opened multiproject.</td>
187 </tr><tr> 239 </tr>
240 <tr>
188 <td><a href="#MultiProject.getMultiProjectFile">getMultiProjectFile</a></td> 241 <td><a href="#MultiProject.getMultiProjectFile">getMultiProjectFile</a></td>
189 <td>Public method to get the path of the multi project file.</td> 242 <td>Public method to get the path of the multi project file.</td>
190 </tr><tr> 243 </tr>
244 <tr>
191 <td><a href="#MultiProject.getMultiProjectPath">getMultiProjectPath</a></td> 245 <td><a href="#MultiProject.getMultiProjectPath">getMultiProjectPath</a></td>
192 <td>Public method to get the multi project path.</td> 246 <td>Public method to get the multi project path.</td>
193 </tr><tr> 247 </tr>
248 <tr>
194 <td><a href="#MultiProject.getProject">getProject</a></td> 249 <td><a href="#MultiProject.getProject">getProject</a></td>
195 <td>Public method to get a reference to a project entry.</td> 250 <td>Public method to get a reference to a project entry.</td>
196 </tr><tr> 251 </tr>
252 <tr>
197 <td><a href="#MultiProject.getProjects">getProjects</a></td> 253 <td><a href="#MultiProject.getProjects">getProjects</a></td>
198 <td>Public method to get all project entries.</td> 254 <td>Public method to get all project entries.</td>
199 </tr><tr> 255 </tr>
256 <tr>
200 <td><a href="#MultiProject.initActions">initActions</a></td> 257 <td><a href="#MultiProject.initActions">initActions</a></td>
201 <td>Public slot to initialize the multi project related actions.</td> 258 <td>Public slot to initialize the multi project related actions.</td>
202 </tr><tr> 259 </tr>
260 <tr>
203 <td><a href="#MultiProject.initMenu">initMenu</a></td> 261 <td><a href="#MultiProject.initMenu">initMenu</a></td>
204 <td>Public slot to initialize the multi project menu.</td> 262 <td>Public slot to initialize the multi project menu.</td>
205 </tr><tr> 263 </tr>
264 <tr>
206 <td><a href="#MultiProject.initToolbar">initToolbar</a></td> 265 <td><a href="#MultiProject.initToolbar">initToolbar</a></td>
207 <td>Public slot to initialize the multi project toolbar.</td> 266 <td>Public slot to initialize the multi project toolbar.</td>
208 </tr><tr> 267 </tr>
268 <tr>
209 <td><a href="#MultiProject.isDirty">isDirty</a></td> 269 <td><a href="#MultiProject.isDirty">isDirty</a></td>
210 <td>Public method to return the dirty state.</td> 270 <td>Public method to return the dirty state.</td>
211 </tr><tr> 271 </tr>
272 <tr>
212 <td><a href="#MultiProject.isOpen">isOpen</a></td> 273 <td><a href="#MultiProject.isOpen">isOpen</a></td>
213 <td>Public method to return the opened state.</td> 274 <td>Public method to return the opened state.</td>
214 </tr><tr> 275 </tr>
276 <tr>
215 <td><a href="#MultiProject.openMultiProject">openMultiProject</a></td> 277 <td><a href="#MultiProject.openMultiProject">openMultiProject</a></td>
216 <td>Public slot to open a multi project.</td> 278 <td>Public slot to open a multi project.</td>
217 </tr><tr> 279 </tr>
280 <tr>
218 <td><a href="#MultiProject.openProject">openProject</a></td> 281 <td><a href="#MultiProject.openProject">openProject</a></td>
219 <td>Public slot to open a project.</td> 282 <td>Public slot to open a project.</td>
220 </tr><tr> 283 </tr>
284 <tr>
221 <td><a href="#MultiProject.removeE5Actions">removeE5Actions</a></td> 285 <td><a href="#MultiProject.removeE5Actions">removeE5Actions</a></td>
222 <td>Public method to remove actions from the list of actions.</td> 286 <td>Public method to remove actions from the list of actions.</td>
223 </tr><tr> 287 </tr>
288 <tr>
224 <td><a href="#MultiProject.removeProject">removeProject</a></td> 289 <td><a href="#MultiProject.removeProject">removeProject</a></td>
225 <td>Public slot to remove a project from the multi project.</td> 290 <td>Public slot to remove a project from the multi project.</td>
226 </tr><tr> 291 </tr>
292 <tr>
227 <td><a href="#MultiProject.saveMultiProject">saveMultiProject</a></td> 293 <td><a href="#MultiProject.saveMultiProject">saveMultiProject</a></td>
228 <td>Public slot to save the current multi project.</td> 294 <td>Public slot to save the current multi project.</td>
229 </tr><tr> 295 </tr>
296 <tr>
230 <td><a href="#MultiProject.saveMultiProjectAs">saveMultiProjectAs</a></td> 297 <td><a href="#MultiProject.saveMultiProjectAs">saveMultiProjectAs</a></td>
231 <td>Public slot to save the current multi project to a different file.</td> 298 <td>Public slot to save the current multi project to a different file.</td>
232 </tr><tr> 299 </tr>
300 <tr>
233 <td><a href="#MultiProject.setDirty">setDirty</a></td> 301 <td><a href="#MultiProject.setDirty">setDirty</a></td>
234 <td>Public method to set the dirty state.</td> 302 <td>Public method to set the dirty state.</td>
235 </tr> 303 </tr>
236 </table> 304 </table>
237 <h3>Static Methods</h3> 305 <h3>Static Methods</h3>
306
238 <table> 307 <table>
239 <tr><td>None</td></tr> 308 <tr><td>None</td></tr>
240 </table> 309 </table>
310
241 <a NAME="MultiProject.__init__" ID="MultiProject.__init__"></a> 311 <a NAME="MultiProject.__init__" ID="MultiProject.__init__"></a>
242 <h4>MultiProject (Constructor)</h4> 312 <h4>MultiProject (Constructor)</h4>
243 <b>MultiProject</b>(<i>project, parent=None, filename=None</i>) 313 <b>MultiProject</b>(<i>project, parent=None, filename=None</i>)
314
244 <p> 315 <p>
245 Constructor 316 Constructor
246 </p><dl> 317 </p>
318 <dl>
319
247 <dt><i>project</i></dt> 320 <dt><i>project</i></dt>
248 <dd> 321 <dd>
249 reference to the project object (Project.Project) 322 reference to the project object (Project.Project)
250 </dd><dt><i>parent</i></dt> 323 </dd>
324 <dt><i>parent</i></dt>
251 <dd> 325 <dd>
252 parent widget (usually the ui object) (QWidget) 326 parent widget (usually the ui object) (QWidget)
253 </dd><dt><i>filename</i></dt> 327 </dd>
328 <dt><i>filename</i></dt>
254 <dd> 329 <dd>
255 optional filename of a multi project file to open 330 optional filename of a multi project file to open
256 (string) 331 (string)
257 </dd> 332 </dd>
258 </dl><a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a> 333 </dl>
334 <a NAME="MultiProject.__checkFilesExist" ID="MultiProject.__checkFilesExist"></a>
259 <h4>MultiProject.__checkFilesExist</h4> 335 <h4>MultiProject.__checkFilesExist</h4>
260 <b>__checkFilesExist</b>(<i></i>) 336 <b>__checkFilesExist</b>(<i></i>)
337
261 <p> 338 <p>
262 Private method to check, if the files in a list exist. 339 Private method to check, if the files in a list exist.
263 </p><p> 340 </p>
341 <p>
264 The project files are checked for existance in the 342 The project files are checked for existance in the
265 filesystem. Non existant projects are removed from the list and the 343 filesystem. Non existant projects are removed from the list and the
266 dirty state of the multi project is changed accordingly. 344 dirty state of the multi project is changed accordingly.
267 </p><a NAME="MultiProject.__extractCategories" ID="MultiProject.__extractCategories"></a> 345 </p>
346 <a NAME="MultiProject.__extractCategories" ID="MultiProject.__extractCategories"></a>
268 <h4>MultiProject.__extractCategories</h4> 347 <h4>MultiProject.__extractCategories</h4>
269 <b>__extractCategories</b>(<i></i>) 348 <b>__extractCategories</b>(<i></i>)
349
270 <p> 350 <p>
271 Private slot to extract the categories used in the project definitions. 351 Private slot to extract the categories used in the project definitions.
272 </p><a NAME="MultiProject.__initData" ID="MultiProject.__initData"></a> 352 </p>
353 <a NAME="MultiProject.__initData" ID="MultiProject.__initData"></a>
273 <h4>MultiProject.__initData</h4> 354 <h4>MultiProject.__initData</h4>
274 <b>__initData</b>(<i></i>) 355 <b>__initData</b>(<i></i>)
356
275 <p> 357 <p>
276 Private method to initialize the multi project data part. 358 Private method to initialize the multi project data part.
277 </p><a NAME="MultiProject.__loadRecent" ID="MultiProject.__loadRecent"></a> 359 </p>
360 <a NAME="MultiProject.__loadRecent" ID="MultiProject.__loadRecent"></a>
278 <h4>MultiProject.__loadRecent</h4> 361 <h4>MultiProject.__loadRecent</h4>
279 <b>__loadRecent</b>(<i></i>) 362 <b>__loadRecent</b>(<i></i>)
363
280 <p> 364 <p>
281 Private method to load the recently opened multi project filenames. 365 Private method to load the recently opened multi project filenames.
282 </p><a NAME="MultiProject.__newMultiProject" ID="MultiProject.__newMultiProject"></a> 366 </p>
367 <a NAME="MultiProject.__newMultiProject" ID="MultiProject.__newMultiProject"></a>
283 <h4>MultiProject.__newMultiProject</h4> 368 <h4>MultiProject.__newMultiProject</h4>
284 <b>__newMultiProject</b>(<i></i>) 369 <b>__newMultiProject</b>(<i></i>)
370
285 <p> 371 <p>
286 Private slot to build a new multi project. 372 Private slot to build a new multi project.
287 </p><p> 373 </p>
374 <p>
288 This method displays the new multi project dialog and initializes 375 This method displays the new multi project dialog and initializes
289 the multi project object with the data entered. 376 the multi project object with the data entered.
290 </p><a NAME="MultiProject.__openMasterProject" ID="MultiProject.__openMasterProject"></a> 377 </p>
378 <a NAME="MultiProject.__openMasterProject" ID="MultiProject.__openMasterProject"></a>
291 <h4>MultiProject.__openMasterProject</h4> 379 <h4>MultiProject.__openMasterProject</h4>
292 <b>__openMasterProject</b>(<i>reopen=True</i>) 380 <b>__openMasterProject</b>(<i>reopen=True</i>)
381
293 <p> 382 <p>
294 Private slot to open the master project. 383 Private slot to open the master project.
295 </p><dl> 384 </p>
385 <dl>
386
296 <dt><i>reopen</i></dt> 387 <dt><i>reopen</i></dt>
297 <dd> 388 <dd>
298 flag indicating, that the master project should be 389 flag indicating, that the master project should be
299 reopened, if it has been opened already (boolean) 390 reopened, if it has been opened already (boolean)
300 </dd> 391 </dd>
301 </dl><a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a> 392 </dl>
393 <a NAME="MultiProject.__openRecent" ID="MultiProject.__openRecent"></a>
302 <h4>MultiProject.__openRecent</h4> 394 <h4>MultiProject.__openRecent</h4>
303 <b>__openRecent</b>(<i>act</i>) 395 <b>__openRecent</b>(<i>act</i>)
396
304 <p> 397 <p>
305 Private method to open a multi project from the list of rencently 398 Private method to open a multi project from the list of rencently
306 opened multi projects. 399 opened multi projects.
307 </p><dl> 400 </p>
401 <dl>
402
308 <dt><i>act</i></dt> 403 <dt><i>act</i></dt>
309 <dd> 404 <dd>
310 reference to the action that triggered (QAction) 405 reference to the action that triggered (QAction)
311 </dd> 406 </dd>
312 </dl><a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a> 407 </dl>
408 <a NAME="MultiProject.__readMultiProject" ID="MultiProject.__readMultiProject"></a>
313 <h4>MultiProject.__readMultiProject</h4> 409 <h4>MultiProject.__readMultiProject</h4>
314 <b>__readMultiProject</b>(<i>fn</i>) 410 <b>__readMultiProject</b>(<i>fn</i>)
411
315 <p> 412 <p>
316 Private method to read in a multi project (.e4m, .e5m) file. 413 Private method to read in a multi project (.e4m, .e5m) file.
317 </p><dl> 414 </p>
415 <dl>
416
318 <dt><i>fn</i></dt> 417 <dt><i>fn</i></dt>
319 <dd> 418 <dd>
320 filename of the multi project file to be read (string) 419 filename of the multi project file to be read (string)
321 </dd> 420 </dd>
322 </dl><dl> 421 </dl>
422 <dl>
323 <dt>Returns:</dt> 423 <dt>Returns:</dt>
324 <dd> 424 <dd>
325 flag indicating success 425 flag indicating success
326 </dd> 426 </dd>
327 </dl><a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a> 427 </dl>
428 <a NAME="MultiProject.__saveRecent" ID="MultiProject.__saveRecent"></a>
328 <h4>MultiProject.__saveRecent</h4> 429 <h4>MultiProject.__saveRecent</h4>
329 <b>__saveRecent</b>(<i></i>) 430 <b>__saveRecent</b>(<i></i>)
431
330 <p> 432 <p>
331 Private method to save the list of recently opened filenames. 433 Private method to save the list of recently opened filenames.
332 </p><a NAME="MultiProject.__showContextMenuRecent" ID="MultiProject.__showContextMenuRecent"></a> 434 </p>
435 <a NAME="MultiProject.__showContextMenuRecent" ID="MultiProject.__showContextMenuRecent"></a>
333 <h4>MultiProject.__showContextMenuRecent</h4> 436 <h4>MultiProject.__showContextMenuRecent</h4>
334 <b>__showContextMenuRecent</b>(<i></i>) 437 <b>__showContextMenuRecent</b>(<i></i>)
438
335 <p> 439 <p>
336 Private method to set up the recent multi projects menu. 440 Private method to set up the recent multi projects menu.
337 </p><a NAME="MultiProject.__showMenu" ID="MultiProject.__showMenu"></a> 441 </p>
442 <a NAME="MultiProject.__showMenu" ID="MultiProject.__showMenu"></a>
338 <h4>MultiProject.__showMenu</h4> 443 <h4>MultiProject.__showMenu</h4>
339 <b>__showMenu</b>(<i></i>) 444 <b>__showMenu</b>(<i></i>)
445
340 <p> 446 <p>
341 Private method to set up the multi project menu. 447 Private method to set up the multi project menu.
342 </p><a NAME="MultiProject.__showProperties" ID="MultiProject.__showProperties"></a> 448 </p>
449 <a NAME="MultiProject.__showProperties" ID="MultiProject.__showProperties"></a>
343 <h4>MultiProject.__showProperties</h4> 450 <h4>MultiProject.__showProperties</h4>
344 <b>__showProperties</b>(<i></i>) 451 <b>__showProperties</b>(<i></i>)
452
345 <p> 453 <p>
346 Private slot to display the properties dialog. 454 Private slot to display the properties dialog.
347 </p><a NAME="MultiProject.__syncRecent" ID="MultiProject.__syncRecent"></a> 455 </p>
456 <a NAME="MultiProject.__syncRecent" ID="MultiProject.__syncRecent"></a>
348 <h4>MultiProject.__syncRecent</h4> 457 <h4>MultiProject.__syncRecent</h4>
349 <b>__syncRecent</b>(<i></i>) 458 <b>__syncRecent</b>(<i></i>)
459
350 <p> 460 <p>
351 Private method to synchronize the list of recently opened multi 461 Private method to synchronize the list of recently opened multi
352 projects with the central store. 462 projects with the central store.
353 </p><a NAME="MultiProject.__writeMultiProject" ID="MultiProject.__writeMultiProject"></a> 463 </p>
464 <a NAME="MultiProject.__writeMultiProject" ID="MultiProject.__writeMultiProject"></a>
354 <h4>MultiProject.__writeMultiProject</h4> 465 <h4>MultiProject.__writeMultiProject</h4>
355 <b>__writeMultiProject</b>(<i>fn=None</i>) 466 <b>__writeMultiProject</b>(<i>fn=None</i>)
467
356 <p> 468 <p>
357 Private method to save the multi project infos to a multi project file. 469 Private method to save the multi project infos to a multi project file.
358 </p><dl> 470 </p>
471 <dl>
472
359 <dt><i>fn</i></dt> 473 <dt><i>fn</i></dt>
360 <dd> 474 <dd>
361 optional filename of the multi project file to be written. 475 optional filename of the multi project file to be written.
362 If fn is None, the filename stored in the multi project object 476 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 477 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 478 is used instead of the one in the multi project object. This is the
365 'save as' action. 479 'save as' action.
366 </dd> 480 </dd>
367 </dl><dl> 481 </dl>
482 <dl>
368 <dt>Returns:</dt> 483 <dt>Returns:</dt>
369 <dd> 484 <dd>
370 flag indicating success 485 flag indicating success
371 </dd> 486 </dd>
372 </dl><a NAME="MultiProject.addE5Actions" ID="MultiProject.addE5Actions"></a> 487 </dl>
488 <a NAME="MultiProject.addE5Actions" ID="MultiProject.addE5Actions"></a>
373 <h4>MultiProject.addE5Actions</h4> 489 <h4>MultiProject.addE5Actions</h4>
374 <b>addE5Actions</b>(<i>actions</i>) 490 <b>addE5Actions</b>(<i>actions</i>)
491
375 <p> 492 <p>
376 Public method to add actions to the list of actions. 493 Public method to add actions to the list of actions.
377 </p><dl> 494 </p>
495 <dl>
496
378 <dt><i>actions</i></dt> 497 <dt><i>actions</i></dt>
379 <dd> 498 <dd>
380 list of actions (list of E5Action) 499 list of actions (list of E5Action)
381 </dd> 500 </dd>
382 </dl><a NAME="MultiProject.addNewProject" ID="MultiProject.addNewProject"></a> 501 </dl>
502 <a NAME="MultiProject.addNewProject" ID="MultiProject.addNewProject"></a>
383 <h4>MultiProject.addNewProject</h4> 503 <h4>MultiProject.addNewProject</h4>
384 <b>addNewProject</b>(<i>startdir="", category=""</i>) 504 <b>addNewProject</b>(<i>startdir="", category=""</i>)
505
385 <p> 506 <p>
386 Public slot used to add a new project to the multi-project. 507 Public slot used to add a new project to the multi-project.
387 </p><dl> 508 </p>
509 <dl>
510
388 <dt><i>startdir</i> (str)</dt> 511 <dt><i>startdir</i> (str)</dt>
389 <dd> 512 <dd>
390 start directory for the selection dialog 513 start directory for the selection dialog
391 </dd><dt><i>category</i> (str)</dt> 514 </dd>
515 <dt><i>category</i> (str)</dt>
392 <dd> 516 <dd>
393 category to be preset 517 category to be preset
394 </dd> 518 </dd>
395 </dl><a NAME="MultiProject.addProject" ID="MultiProject.addProject"></a> 519 </dl>
520 <a NAME="MultiProject.addProject" ID="MultiProject.addProject"></a>
396 <h4>MultiProject.addProject</h4> 521 <h4>MultiProject.addProject</h4>
397 <b>addProject</b>(<i>project</i>) 522 <b>addProject</b>(<i>project</i>)
523
398 <p> 524 <p>
399 Public method to add a project to the multi-project. 525 Public method to add a project to the multi-project.
400 </p><dl> 526 </p>
527 <dl>
528
401 <dt><i>project</i> (dict)</dt> 529 <dt><i>project</i> (dict)</dt>
402 <dd> 530 <dd>
403 dictionary containing the project data to be added 531 dictionary containing the project data to be added
404 </dd> 532 </dd>
405 </dl><a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a> 533 </dl>
534 <a NAME="MultiProject.changeProjectProperties" ID="MultiProject.changeProjectProperties"></a>
406 <h4>MultiProject.changeProjectProperties</h4> 535 <h4>MultiProject.changeProjectProperties</h4>
407 <b>changeProjectProperties</b>(<i>pro</i>) 536 <b>changeProjectProperties</b>(<i>pro</i>)
537
408 <p> 538 <p>
409 Public method to change the data of a project entry. 539 Public method to change the data of a project entry.
410 </p><dl> 540 </p>
541 <dl>
542
411 <dt><i>pro</i></dt> 543 <dt><i>pro</i></dt>
412 <dd> 544 <dd>
413 dictionary with the project data (string) 545 dictionary with the project data (string)
414 </dd> 546 </dd>
415 </dl><a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a> 547 </dl>
548 <a NAME="MultiProject.checkDirty" ID="MultiProject.checkDirty"></a>
416 <h4>MultiProject.checkDirty</h4> 549 <h4>MultiProject.checkDirty</h4>
417 <b>checkDirty</b>(<i></i>) 550 <b>checkDirty</b>(<i></i>)
551
418 <p> 552 <p>
419 Public method to check the dirty status and open a message window. 553 Public method to check the dirty status and open a message window.
420 </p><dl> 554 </p>
555 <dl>
421 <dt>Returns:</dt> 556 <dt>Returns:</dt>
422 <dd> 557 <dd>
423 flag indicating whether this operation was successful (boolean) 558 flag indicating whether this operation was successful (boolean)
424 </dd> 559 </dd>
425 </dl><a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a> 560 </dl>
561 <a NAME="MultiProject.clearRecent" ID="MultiProject.clearRecent"></a>
426 <h4>MultiProject.clearRecent</h4> 562 <h4>MultiProject.clearRecent</h4>
427 <b>clearRecent</b>(<i></i>) 563 <b>clearRecent</b>(<i></i>)
564
428 <p> 565 <p>
429 Public method to clear the recent multi projects menu. 566 Public method to clear the recent multi projects menu.
430 </p><a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a> 567 </p>
568 <a NAME="MultiProject.closeMultiProject" ID="MultiProject.closeMultiProject"></a>
431 <h4>MultiProject.closeMultiProject</h4> 569 <h4>MultiProject.closeMultiProject</h4>
432 <b>closeMultiProject</b>(<i></i>) 570 <b>closeMultiProject</b>(<i></i>)
571
433 <p> 572 <p>
434 Public slot to close the current multi project. 573 Public slot to close the current multi project.
435 </p><dl> 574 </p>
575 <dl>
436 <dt>Returns:</dt> 576 <dt>Returns:</dt>
437 <dd> 577 <dd>
438 flag indicating success (boolean) 578 flag indicating success (boolean)
439 </dd> 579 </dd>
440 </dl><a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a> 580 </dl>
581 <a NAME="MultiProject.copyProject" ID="MultiProject.copyProject"></a>
441 <h4>MultiProject.copyProject</h4> 582 <h4>MultiProject.copyProject</h4>
442 <b>copyProject</b>(<i>uid</i>) 583 <b>copyProject</b>(<i>uid</i>)
584
443 <p> 585 <p>
444 Public method to copy the project with given UID on disk. 586 Public method to copy the project with given UID on disk.
445 </p><dl> 587 </p>
588 <dl>
589
446 <dt><i>uid</i> (str)</dt> 590 <dt><i>uid</i> (str)</dt>
447 <dd> 591 <dd>
448 UID of the project to copy 592 UID of the project to copy
449 </dd> 593 </dd>
450 </dl><a NAME="MultiProject.deleteProject" ID="MultiProject.deleteProject"></a> 594 </dl>
595 <a NAME="MultiProject.deleteProject" ID="MultiProject.deleteProject"></a>
451 <h4>MultiProject.deleteProject</h4> 596 <h4>MultiProject.deleteProject</h4>
452 <b>deleteProject</b>(<i>uid</i>) 597 <b>deleteProject</b>(<i>uid</i>)
598
453 <p> 599 <p>
454 Public slot to delete project(s) from the multi project and disk. 600 Public slot to delete project(s) from the multi project and disk.
455 </p><dl> 601 </p>
602 <dl>
603
456 <dt><i>uid</i> (str)</dt> 604 <dt><i>uid</i> (str)</dt>
457 <dd> 605 <dd>
458 UID of the project to be removed from the multi 606 UID of the project to be removed from the multi
459 project 607 project
460 </dd> 608 </dd>
461 </dl><a NAME="MultiProject.getActions" ID="MultiProject.getActions"></a> 609 </dl>
610 <a NAME="MultiProject.getActions" ID="MultiProject.getActions"></a>
462 <h4>MultiProject.getActions</h4> 611 <h4>MultiProject.getActions</h4>
463 <b>getActions</b>(<i></i>) 612 <b>getActions</b>(<i></i>)
613
464 <p> 614 <p>
465 Public method to get a list of all actions. 615 Public method to get a list of all actions.
466 </p><dl> 616 </p>
617 <dl>
467 <dt>Returns:</dt> 618 <dt>Returns:</dt>
468 <dd> 619 <dd>
469 list of all actions (list of E5Action) 620 list of all actions (list of E5Action)
470 </dd> 621 </dd>
471 </dl><a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a> 622 </dl>
623 <a NAME="MultiProject.getCategories" ID="MultiProject.getCategories"></a>
472 <h4>MultiProject.getCategories</h4> 624 <h4>MultiProject.getCategories</h4>
473 <b>getCategories</b>(<i></i>) 625 <b>getCategories</b>(<i></i>)
626
474 <p> 627 <p>
475 Public method to get the list of defined categories. 628 Public method to get the list of defined categories.
476 </p><dl> 629 </p>
630 <dl>
477 <dt>Returns:</dt> 631 <dt>Returns:</dt>
478 <dd> 632 <dd>
479 list of categories (list of string) 633 list of categories (list of string)
480 </dd> 634 </dd>
481 </dl><a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a> 635 </dl>
636 <a NAME="MultiProject.getDependantProjectFiles" ID="MultiProject.getDependantProjectFiles"></a>
482 <h4>MultiProject.getDependantProjectFiles</h4> 637 <h4>MultiProject.getDependantProjectFiles</h4>
483 <b>getDependantProjectFiles</b>(<i></i>) 638 <b>getDependantProjectFiles</b>(<i></i>)
639
484 <p> 640 <p>
485 Public method to get the filenames of the dependent projects. 641 Public method to get the filenames of the dependent projects.
486 </p><dl> 642 </p>
643 <dl>
487 <dt>Returns:</dt> 644 <dt>Returns:</dt>
488 <dd> 645 <dd>
489 names of the dependent project files (list of strings) 646 names of the dependent project files (list of strings)
490 </dd> 647 </dd>
491 </dl><a NAME="MultiProject.getMasterProjectFile" ID="MultiProject.getMasterProjectFile"></a> 648 </dl>
649 <a NAME="MultiProject.getMasterProjectFile" ID="MultiProject.getMasterProjectFile"></a>
492 <h4>MultiProject.getMasterProjectFile</h4> 650 <h4>MultiProject.getMasterProjectFile</h4>
493 <b>getMasterProjectFile</b>(<i></i>) 651 <b>getMasterProjectFile</b>(<i></i>)
652
494 <p> 653 <p>
495 Public method to get the filename of the master project. 654 Public method to get the filename of the master project.
496 </p><dl> 655 </p>
656 <dl>
497 <dt>Returns:</dt> 657 <dt>Returns:</dt>
498 <dd> 658 <dd>
499 name of the master project file (string) 659 name of the master project file (string)
500 </dd> 660 </dd>
501 </dl><a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a> 661 </dl>
662 <a NAME="MultiProject.getMenu" ID="MultiProject.getMenu"></a>
502 <h4>MultiProject.getMenu</h4> 663 <h4>MultiProject.getMenu</h4>
503 <b>getMenu</b>(<i>menuName</i>) 664 <b>getMenu</b>(<i>menuName</i>)
665
504 <p> 666 <p>
505 Public method to get a reference to the main menu or a submenu. 667 Public method to get a reference to the main menu or a submenu.
506 </p><dl> 668 </p>
669 <dl>
670
507 <dt><i>menuName</i></dt> 671 <dt><i>menuName</i></dt>
508 <dd> 672 <dd>
509 name of the menu (string) 673 name of the menu (string)
510 </dd> 674 </dd>
511 </dl><dl> 675 </dl>
676 <dl>
512 <dt>Returns:</dt> 677 <dt>Returns:</dt>
513 <dd> 678 <dd>
514 reference to the requested menu (QMenu) or None 679 reference to the requested menu (QMenu) or None
515 </dd> 680 </dd>
516 </dl><a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a> 681 </dl>
682 <a NAME="MultiProject.getMostRecent" ID="MultiProject.getMostRecent"></a>
517 <h4>MultiProject.getMostRecent</h4> 683 <h4>MultiProject.getMostRecent</h4>
518 <b>getMostRecent</b>(<i></i>) 684 <b>getMostRecent</b>(<i></i>)
685
519 <p> 686 <p>
520 Public method to get the most recently opened multiproject. 687 Public method to get the most recently opened multiproject.
521 </p><dl> 688 </p>
689 <dl>
522 <dt>Returns:</dt> 690 <dt>Returns:</dt>
523 <dd> 691 <dd>
524 path of the most recently opened multiproject (string) 692 path of the most recently opened multiproject (string)
525 </dd> 693 </dd>
526 </dl><a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a> 694 </dl>
695 <a NAME="MultiProject.getMultiProjectFile" ID="MultiProject.getMultiProjectFile"></a>
527 <h4>MultiProject.getMultiProjectFile</h4> 696 <h4>MultiProject.getMultiProjectFile</h4>
528 <b>getMultiProjectFile</b>(<i></i>) 697 <b>getMultiProjectFile</b>(<i></i>)
698
529 <p> 699 <p>
530 Public method to get the path of the multi project file. 700 Public method to get the path of the multi project file.
531 </p><dl> 701 </p>
702 <dl>
532 <dt>Returns:</dt> 703 <dt>Returns:</dt>
533 <dd> 704 <dd>
534 path of the multi project file (string) 705 path of the multi project file (string)
535 </dd> 706 </dd>
536 </dl><a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a> 707 </dl>
708 <a NAME="MultiProject.getMultiProjectPath" ID="MultiProject.getMultiProjectPath"></a>
537 <h4>MultiProject.getMultiProjectPath</h4> 709 <h4>MultiProject.getMultiProjectPath</h4>
538 <b>getMultiProjectPath</b>(<i></i>) 710 <b>getMultiProjectPath</b>(<i></i>)
711
539 <p> 712 <p>
540 Public method to get the multi project path. 713 Public method to get the multi project path.
541 </p><dl> 714 </p>
715 <dl>
542 <dt>Returns:</dt> 716 <dt>Returns:</dt>
543 <dd> 717 <dd>
544 multi project path (string) 718 multi project path (string)
545 </dd> 719 </dd>
546 </dl><a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a> 720 </dl>
721 <a NAME="MultiProject.getProject" ID="MultiProject.getProject"></a>
547 <h4>MultiProject.getProject</h4> 722 <h4>MultiProject.getProject</h4>
548 <b>getProject</b>(<i>uid</i>) 723 <b>getProject</b>(<i>uid</i>)
724
549 <p> 725 <p>
550 Public method to get a reference to a project entry. 726 Public method to get a reference to a project entry.
551 </p><dl> 727 </p>
728 <dl>
729
552 <dt><i>uid</i> (str)</dt> 730 <dt><i>uid</i> (str)</dt>
553 <dd> 731 <dd>
554 UID of the project to get 732 UID of the project to get
555 </dd> 733 </dd>
556 </dl><dl> 734 </dl>
735 <dl>
557 <dt>Returns:</dt> 736 <dt>Returns:</dt>
558 <dd> 737 <dd>
559 dictionary containing the project data 738 dictionary containing the project data
560 </dd> 739 </dd>
561 </dl><dl> 740 </dl>
741 <dl>
562 <dt>Return Type:</dt> 742 <dt>Return Type:</dt>
563 <dd> 743 <dd>
564 dict 744 dict
565 </dd> 745 </dd>
566 </dl><a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a> 746 </dl>
747 <a NAME="MultiProject.getProjects" ID="MultiProject.getProjects"></a>
567 <h4>MultiProject.getProjects</h4> 748 <h4>MultiProject.getProjects</h4>
568 <b>getProjects</b>(<i></i>) 749 <b>getProjects</b>(<i></i>)
750
569 <p> 751 <p>
570 Public method to get all project entries. 752 Public method to get all project entries.
571 </p><dl> 753 </p>
754 <dl>
572 <dt>Returns:</dt> 755 <dt>Returns:</dt>
573 <dd> 756 <dd>
574 list of all project entries (list of dictionaries) 757 list of all project entries (list of dictionaries)
575 </dd> 758 </dd>
576 </dl><a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a> 759 </dl>
760 <a NAME="MultiProject.initActions" ID="MultiProject.initActions"></a>
577 <h4>MultiProject.initActions</h4> 761 <h4>MultiProject.initActions</h4>
578 <b>initActions</b>(<i></i>) 762 <b>initActions</b>(<i></i>)
763
579 <p> 764 <p>
580 Public slot to initialize the multi project related actions. 765 Public slot to initialize the multi project related actions.
581 </p><a NAME="MultiProject.initMenu" ID="MultiProject.initMenu"></a> 766 </p>
767 <a NAME="MultiProject.initMenu" ID="MultiProject.initMenu"></a>
582 <h4>MultiProject.initMenu</h4> 768 <h4>MultiProject.initMenu</h4>
583 <b>initMenu</b>(<i></i>) 769 <b>initMenu</b>(<i></i>)
770
584 <p> 771 <p>
585 Public slot to initialize the multi project menu. 772 Public slot to initialize the multi project menu.
586 </p><dl> 773 </p>
774 <dl>
587 <dt>Returns:</dt> 775 <dt>Returns:</dt>
588 <dd> 776 <dd>
589 the menu generated (QMenu) 777 the menu generated (QMenu)
590 </dd> 778 </dd>
591 </dl><a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a> 779 </dl>
780 <a NAME="MultiProject.initToolbar" ID="MultiProject.initToolbar"></a>
592 <h4>MultiProject.initToolbar</h4> 781 <h4>MultiProject.initToolbar</h4>
593 <b>initToolbar</b>(<i>toolbarManager</i>) 782 <b>initToolbar</b>(<i>toolbarManager</i>)
783
594 <p> 784 <p>
595 Public slot to initialize the multi project toolbar. 785 Public slot to initialize the multi project toolbar.
596 </p><dl> 786 </p>
787 <dl>
788
597 <dt><i>toolbarManager</i></dt> 789 <dt><i>toolbarManager</i></dt>
598 <dd> 790 <dd>
599 reference to a toolbar manager object 791 reference to a toolbar manager object
600 (E5ToolBarManager) 792 (E5ToolBarManager)
601 </dd> 793 </dd>
602 </dl><dl> 794 </dl>
795 <dl>
603 <dt>Returns:</dt> 796 <dt>Returns:</dt>
604 <dd> 797 <dd>
605 the toolbar generated (QToolBar) 798 the toolbar generated (QToolBar)
606 </dd> 799 </dd>
607 </dl><a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a> 800 </dl>
801 <a NAME="MultiProject.isDirty" ID="MultiProject.isDirty"></a>
608 <h4>MultiProject.isDirty</h4> 802 <h4>MultiProject.isDirty</h4>
609 <b>isDirty</b>(<i></i>) 803 <b>isDirty</b>(<i></i>)
804
610 <p> 805 <p>
611 Public method to return the dirty state. 806 Public method to return the dirty state.
612 </p><dl> 807 </p>
808 <dl>
613 <dt>Returns:</dt> 809 <dt>Returns:</dt>
614 <dd> 810 <dd>
615 dirty state (boolean) 811 dirty state (boolean)
616 </dd> 812 </dd>
617 </dl><a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a> 813 </dl>
814 <a NAME="MultiProject.isOpen" ID="MultiProject.isOpen"></a>
618 <h4>MultiProject.isOpen</h4> 815 <h4>MultiProject.isOpen</h4>
619 <b>isOpen</b>(<i></i>) 816 <b>isOpen</b>(<i></i>)
817
620 <p> 818 <p>
621 Public method to return the opened state. 819 Public method to return the opened state.
622 </p><dl> 820 </p>
821 <dl>
623 <dt>Returns:</dt> 822 <dt>Returns:</dt>
624 <dd> 823 <dd>
625 open state (boolean) 824 open state (boolean)
626 </dd> 825 </dd>
627 </dl><a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a> 826 </dl>
827 <a NAME="MultiProject.openMultiProject" ID="MultiProject.openMultiProject"></a>
628 <h4>MultiProject.openMultiProject</h4> 828 <h4>MultiProject.openMultiProject</h4>
629 <b>openMultiProject</b>(<i>fn=None, openMaster=True</i>) 829 <b>openMultiProject</b>(<i>fn=None, openMaster=True</i>)
830
630 <p> 831 <p>
631 Public slot to open a multi project. 832 Public slot to open a multi project.
632 </p><dl> 833 </p>
834 <dl>
835
633 <dt><i>fn</i></dt> 836 <dt><i>fn</i></dt>
634 <dd> 837 <dd>
635 optional filename of the multi project file to be 838 optional filename of the multi project file to be
636 read (string) 839 read (string)
637 </dd><dt><i>openMaster</i></dt> 840 </dd>
841 <dt><i>openMaster</i></dt>
638 <dd> 842 <dd>
639 flag indicating, that the master project 843 flag indicating, that the master project
640 should be opened depending on the configuration (boolean) 844 should be opened depending on the configuration (boolean)
641 </dd> 845 </dd>
642 </dl><a NAME="MultiProject.openProject" ID="MultiProject.openProject"></a> 846 </dl>
847 <a NAME="MultiProject.openProject" ID="MultiProject.openProject"></a>
643 <h4>MultiProject.openProject</h4> 848 <h4>MultiProject.openProject</h4>
644 <b>openProject</b>(<i>filename</i>) 849 <b>openProject</b>(<i>filename</i>)
850
645 <p> 851 <p>
646 Public slot to open a project. 852 Public slot to open a project.
647 </p><dl> 853 </p>
854 <dl>
855
648 <dt><i>filename</i></dt> 856 <dt><i>filename</i></dt>
649 <dd> 857 <dd>
650 filename of the project file (string) 858 filename of the project file (string)
651 </dd> 859 </dd>
652 </dl><a NAME="MultiProject.removeE5Actions" ID="MultiProject.removeE5Actions"></a> 860 </dl>
861 <a NAME="MultiProject.removeE5Actions" ID="MultiProject.removeE5Actions"></a>
653 <h4>MultiProject.removeE5Actions</h4> 862 <h4>MultiProject.removeE5Actions</h4>
654 <b>removeE5Actions</b>(<i>actions</i>) 863 <b>removeE5Actions</b>(<i>actions</i>)
864
655 <p> 865 <p>
656 Public method to remove actions from the list of actions. 866 Public method to remove actions from the list of actions.
657 </p><dl> 867 </p>
868 <dl>
869
658 <dt><i>actions</i></dt> 870 <dt><i>actions</i></dt>
659 <dd> 871 <dd>
660 list of actions (list of E5Action) 872 list of actions (list of E5Action)
661 </dd> 873 </dd>
662 </dl><a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a> 874 </dl>
875 <a NAME="MultiProject.removeProject" ID="MultiProject.removeProject"></a>
663 <h4>MultiProject.removeProject</h4> 876 <h4>MultiProject.removeProject</h4>
664 <b>removeProject</b>(<i>uid</i>) 877 <b>removeProject</b>(<i>uid</i>)
878
665 <p> 879 <p>
666 Public slot to remove a project from the multi project. 880 Public slot to remove a project from the multi project.
667 </p><dl> 881 </p>
882 <dl>
883
668 <dt><i>uid</i> (str)</dt> 884 <dt><i>uid</i> (str)</dt>
669 <dd> 885 <dd>
670 UID of the project to be removed from the multi 886 UID of the project to be removed from the multi
671 project 887 project
672 </dd> 888 </dd>
673 </dl><a NAME="MultiProject.saveMultiProject" ID="MultiProject.saveMultiProject"></a> 889 </dl>
890 <a NAME="MultiProject.saveMultiProject" ID="MultiProject.saveMultiProject"></a>
674 <h4>MultiProject.saveMultiProject</h4> 891 <h4>MultiProject.saveMultiProject</h4>
675 <b>saveMultiProject</b>(<i></i>) 892 <b>saveMultiProject</b>(<i></i>)
893
676 <p> 894 <p>
677 Public slot to save the current multi project. 895 Public slot to save the current multi project.
678 </p><dl> 896 </p>
897 <dl>
679 <dt>Returns:</dt> 898 <dt>Returns:</dt>
680 <dd> 899 <dd>
681 flag indicating success (boolean) 900 flag indicating success (boolean)
682 </dd> 901 </dd>
683 </dl><a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a> 902 </dl>
903 <a NAME="MultiProject.saveMultiProjectAs" ID="MultiProject.saveMultiProjectAs"></a>
684 <h4>MultiProject.saveMultiProjectAs</h4> 904 <h4>MultiProject.saveMultiProjectAs</h4>
685 <b>saveMultiProjectAs</b>(<i></i>) 905 <b>saveMultiProjectAs</b>(<i></i>)
906
686 <p> 907 <p>
687 Public slot to save the current multi project to a different file. 908 Public slot to save the current multi project to a different file.
688 </p><dl> 909 </p>
910 <dl>
689 <dt>Returns:</dt> 911 <dt>Returns:</dt>
690 <dd> 912 <dd>
691 flag indicating success (boolean) 913 flag indicating success (boolean)
692 </dd> 914 </dd>
693 </dl><a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a> 915 </dl>
916 <a NAME="MultiProject.setDirty" ID="MultiProject.setDirty"></a>
694 <h4>MultiProject.setDirty</h4> 917 <h4>MultiProject.setDirty</h4>
695 <b>setDirty</b>(<i>b</i>) 918 <b>setDirty</b>(<i>b</i>)
919
696 <p> 920 <p>
697 Public method to set the dirty state. 921 Public method to set the dirty state.
698 </p><p> 922 </p>
923 <p>
699 It emits the signal dirty(int). 924 It emits the signal dirty(int).
700 </p><dl> 925 </p>
926 <dl>
927
701 <dt><i>b</i></dt> 928 <dt><i>b</i></dt>
702 <dd> 929 <dd>
703 dirty state (boolean) 930 dirty state (boolean)
704 </dd> 931 </dd>
705 </dl> 932 </dl>

Mercurial Repository: eric

eric ide

mercurial