5 <link rel="stylesheet" href="styles.css"> |
5 <link rel="stylesheet" href="styles.css"> |
6 </head> |
6 </head> |
7 <body> |
7 <body> |
8 <a NAME="top" ID="top"></a> |
8 <a NAME="top" ID="top"></a> |
9 <h1>eric7.MultiProject.MultiProjectBrowser</h1> |
9 <h1>eric7.MultiProject.MultiProjectBrowser</h1> |
10 |
|
11 <p> |
10 <p> |
12 Module implementing the multi project browser. |
11 Module implementing the multi project browser. |
13 </p> |
12 </p> |
|
13 |
14 <h3>Global Attributes</h3> |
14 <h3>Global Attributes</h3> |
15 |
|
16 <table> |
15 <table> |
17 <tr><td>None</td></tr> |
16 <tr><td>None</td></tr> |
18 </table> |
17 </table> |
|
18 |
19 <h3>Classes</h3> |
19 <h3>Classes</h3> |
20 |
20 <table> |
21 <table> |
|
22 |
|
23 <tr> |
21 <tr> |
24 <td><a href="#MultiProjectBrowser">MultiProjectBrowser</a></td> |
22 <td><a href="#MultiProjectBrowser">MultiProjectBrowser</a></td> |
25 <td>Class implementing the multi project browser.</td> |
23 <td>Class implementing the multi project browser.</td> |
26 </tr> |
24 </tr> |
27 </table> |
25 </table> |
|
26 |
28 <h3>Functions</h3> |
27 <h3>Functions</h3> |
29 |
|
30 <table> |
28 <table> |
31 <tr><td>None</td></tr> |
29 <tr><td>None</td></tr> |
32 </table> |
30 </table> |
|
31 |
33 <hr /> |
32 <hr /> |
34 <hr /> |
33 <hr /> |
35 <a NAME="MultiProjectBrowser" ID="MultiProjectBrowser"></a> |
34 <a NAME="MultiProjectBrowser" ID="MultiProjectBrowser"></a> |
36 <h2>MultiProjectBrowser</h2> |
35 <h2>MultiProjectBrowser</h2> |
37 |
|
38 <p> |
36 <p> |
39 Class implementing the multi project browser. |
37 Class implementing the multi project browser. |
40 </p> |
38 </p> |
|
39 |
41 <h3>Derived from</h3> |
40 <h3>Derived from</h3> |
42 QTreeWidget |
41 QTreeWidget |
43 <h3>Class Attributes</h3> |
42 <h3>Class Attributes</h3> |
44 |
43 <table> |
45 <table> |
44 <tr><td>ProjectFileNameRole</td></tr> |
46 <tr><td>ProjectFileNameRole</td></tr><tr><td>ProjectUidRole</td></tr> |
45 <tr><td>ProjectUidRole</td></tr> |
47 </table> |
46 </table> |
|
47 |
48 <h3>Class Methods</h3> |
48 <h3>Class Methods</h3> |
49 |
|
50 <table> |
49 <table> |
51 <tr><td>None</td></tr> |
50 <tr><td>None</td></tr> |
52 </table> |
51 </table> |
|
52 |
53 <h3>Methods</h3> |
53 <h3>Methods</h3> |
54 |
54 <table> |
55 <table> |
|
56 |
|
57 <tr> |
55 <tr> |
58 <td><a href="#MultiProjectBrowser.__init__">MultiProjectBrowser</a></td> |
56 <td><a href="#MultiProjectBrowser.__init__">MultiProjectBrowser</a></td> |
59 <td>Constructor</td> |
57 <td>Constructor</td> |
60 </tr> |
58 </tr> |
61 <tr> |
59 <tr> |
172 </dd> |
171 </dd> |
173 </dl> |
172 </dl> |
174 <a NAME="MultiProjectBrowser.__addNewProject" ID="MultiProjectBrowser.__addNewProject"></a> |
173 <a NAME="MultiProjectBrowser.__addNewProject" ID="MultiProjectBrowser.__addNewProject"></a> |
175 <h4>MultiProjectBrowser.__addNewProject</h4> |
174 <h4>MultiProjectBrowser.__addNewProject</h4> |
176 <b>__addNewProject</b>(<i></i>) |
175 <b>__addNewProject</b>(<i></i>) |
177 |
|
178 <p> |
176 <p> |
179 Private method to add a new project entry. |
177 Private method to add a new project entry. |
180 </p> |
178 </p> |
|
179 |
181 <a NAME="MultiProjectBrowser.__addProject" ID="MultiProjectBrowser.__addProject"></a> |
180 <a NAME="MultiProjectBrowser.__addProject" ID="MultiProjectBrowser.__addProject"></a> |
182 <h4>MultiProjectBrowser.__addProject</h4> |
181 <h4>MultiProjectBrowser.__addProject</h4> |
183 <b>__addProject</b>(<i>project</i>) |
182 <b>__addProject</b>(<i>project</i>) |
184 |
|
185 <p> |
183 <p> |
186 Private method to add a project to the list. |
184 Private method to add a project to the list. |
187 </p> |
185 </p> |
|
186 |
188 <dl> |
187 <dl> |
189 |
188 |
190 <dt><i>project</i> (MultiProjectProjectMeta)</dt> |
189 <dt><i>project</i> (MultiProjectProjectMeta)</dt> |
191 <dd> |
190 <dd> |
192 reference to the project metadata |
191 reference to the project metadata |
193 </dd> |
192 </dd> |
194 </dl> |
193 </dl> |
195 <a NAME="MultiProjectBrowser.__configure" ID="MultiProjectBrowser.__configure"></a> |
194 <a NAME="MultiProjectBrowser.__configure" ID="MultiProjectBrowser.__configure"></a> |
196 <h4>MultiProjectBrowser.__configure</h4> |
195 <h4>MultiProjectBrowser.__configure</h4> |
197 <b>__configure</b>(<i></i>) |
196 <b>__configure</b>(<i></i>) |
198 |
|
199 <p> |
197 <p> |
200 Private method to open the configuration dialog. |
198 Private method to open the configuration dialog. |
201 </p> |
199 </p> |
|
200 |
202 <a NAME="MultiProjectBrowser.__contextMenuRequested" ID="MultiProjectBrowser.__contextMenuRequested"></a> |
201 <a NAME="MultiProjectBrowser.__contextMenuRequested" ID="MultiProjectBrowser.__contextMenuRequested"></a> |
203 <h4>MultiProjectBrowser.__contextMenuRequested</h4> |
202 <h4>MultiProjectBrowser.__contextMenuRequested</h4> |
204 <b>__contextMenuRequested</b>(<i>coord</i>) |
203 <b>__contextMenuRequested</b>(<i>coord</i>) |
205 |
|
206 <p> |
204 <p> |
207 Private slot to show the context menu. |
205 Private slot to show the context menu. |
208 </p> |
206 </p> |
|
207 |
209 <dl> |
208 <dl> |
210 |
209 |
211 <dt><i>coord</i> (QPoint)</dt> |
210 <dt><i>coord</i> (QPoint)</dt> |
212 <dd> |
211 <dd> |
213 the position of the mouse pointer |
212 the position of the mouse pointer |
214 </dd> |
213 </dd> |
215 </dl> |
214 </dl> |
216 <a NAME="MultiProjectBrowser.__copyProject" ID="MultiProjectBrowser.__copyProject"></a> |
215 <a NAME="MultiProjectBrowser.__copyProject" ID="MultiProjectBrowser.__copyProject"></a> |
217 <h4>MultiProjectBrowser.__copyProject</h4> |
216 <h4>MultiProjectBrowser.__copyProject</h4> |
218 <b>__copyProject</b>(<i></i>) |
217 <b>__copyProject</b>(<i></i>) |
219 |
|
220 <p> |
218 <p> |
221 Private method to copy the selected project on disk. |
219 Private method to copy the selected project on disk. |
222 </p> |
220 </p> |
|
221 |
223 <a NAME="MultiProjectBrowser.__createPopupMenu" ID="MultiProjectBrowser.__createPopupMenu"></a> |
222 <a NAME="MultiProjectBrowser.__createPopupMenu" ID="MultiProjectBrowser.__createPopupMenu"></a> |
224 <h4>MultiProjectBrowser.__createPopupMenu</h4> |
223 <h4>MultiProjectBrowser.__createPopupMenu</h4> |
225 <b>__createPopupMenu</b>(<i></i>) |
224 <b>__createPopupMenu</b>(<i></i>) |
226 |
|
227 <p> |
225 <p> |
228 Private method to create the popup menu. |
226 Private method to create the popup menu. |
229 </p> |
227 </p> |
|
228 |
230 <a NAME="MultiProjectBrowser.__deleteProject" ID="MultiProjectBrowser.__deleteProject"></a> |
229 <a NAME="MultiProjectBrowser.__deleteProject" ID="MultiProjectBrowser.__deleteProject"></a> |
231 <h4>MultiProjectBrowser.__deleteProject</h4> |
230 <h4>MultiProjectBrowser.__deleteProject</h4> |
232 <b>__deleteProject</b>(<i></i>) |
231 <b>__deleteProject</b>(<i></i>) |
233 |
|
234 <p> |
232 <p> |
235 Private method to handle the Delete context menu entry. |
233 Private method to handle the Delete context menu entry. |
236 </p> |
234 </p> |
|
235 |
237 <a NAME="MultiProjectBrowser.__findCategoryItem" ID="MultiProjectBrowser.__findCategoryItem"></a> |
236 <a NAME="MultiProjectBrowser.__findCategoryItem" ID="MultiProjectBrowser.__findCategoryItem"></a> |
238 <h4>MultiProjectBrowser.__findCategoryItem</h4> |
237 <h4>MultiProjectBrowser.__findCategoryItem</h4> |
239 <b>__findCategoryItem</b>(<i>category</i>) |
238 <b>__findCategoryItem</b>(<i>category</i>) |
240 |
|
241 <p> |
239 <p> |
242 Private method to find the item for a category. |
240 Private method to find the item for a category. |
243 </p> |
241 </p> |
|
242 |
244 <dl> |
243 <dl> |
245 |
244 |
246 <dt><i>category</i> (str)</dt> |
245 <dt><i>category</i> (str)</dt> |
247 <dd> |
246 <dd> |
248 category to search for |
247 category to search for |
288 </dd> |
287 </dd> |
289 </dl> |
288 </dl> |
290 <a NAME="MultiProjectBrowser.__multiProjectClosed" ID="MultiProjectBrowser.__multiProjectClosed"></a> |
289 <a NAME="MultiProjectBrowser.__multiProjectClosed" ID="MultiProjectBrowser.__multiProjectClosed"></a> |
291 <h4>MultiProjectBrowser.__multiProjectClosed</h4> |
290 <h4>MultiProjectBrowser.__multiProjectClosed</h4> |
292 <b>__multiProjectClosed</b>(<i></i>) |
291 <b>__multiProjectClosed</b>(<i></i>) |
293 |
|
294 <p> |
292 <p> |
295 Private slot to handle the closing of a multi project. |
293 Private slot to handle the closing of a multi project. |
296 </p> |
294 </p> |
|
295 |
297 <a NAME="MultiProjectBrowser.__multiProjectOpened" ID="MultiProjectBrowser.__multiProjectOpened"></a> |
296 <a NAME="MultiProjectBrowser.__multiProjectOpened" ID="MultiProjectBrowser.__multiProjectOpened"></a> |
298 <h4>MultiProjectBrowser.__multiProjectOpened</h4> |
297 <h4>MultiProjectBrowser.__multiProjectOpened</h4> |
299 <b>__multiProjectOpened</b>(<i></i>) |
298 <b>__multiProjectOpened</b>(<i></i>) |
300 |
|
301 <p> |
299 <p> |
302 Private slot to handle the opening of a multi project. |
300 Private slot to handle the opening of a multi project. |
303 </p> |
301 </p> |
|
302 |
304 <a NAME="MultiProjectBrowser.__newMultiProject" ID="MultiProjectBrowser.__newMultiProject"></a> |
303 <a NAME="MultiProjectBrowser.__newMultiProject" ID="MultiProjectBrowser.__newMultiProject"></a> |
305 <h4>MultiProjectBrowser.__newMultiProject</h4> |
304 <h4>MultiProjectBrowser.__newMultiProject</h4> |
306 <b>__newMultiProject</b>(<i></i>) |
305 <b>__newMultiProject</b>(<i></i>) |
307 |
|
308 <p> |
306 <p> |
309 Private slot to handle the creation of a new multi project. |
307 Private slot to handle the creation of a new multi project. |
310 </p> |
308 </p> |
|
309 |
311 <a NAME="MultiProjectBrowser.__openItem" ID="MultiProjectBrowser.__openItem"></a> |
310 <a NAME="MultiProjectBrowser.__openItem" ID="MultiProjectBrowser.__openItem"></a> |
312 <h4>MultiProjectBrowser.__openItem</h4> |
311 <h4>MultiProjectBrowser.__openItem</h4> |
313 <b>__openItem</b>(<i>itm=None</i>) |
312 <b>__openItem</b>(<i>itm=None</i>) |
314 |
|
315 <p> |
313 <p> |
316 Private slot to open a project. |
314 Private slot to open a project. |
317 </p> |
315 </p> |
|
316 |
318 <dl> |
317 <dl> |
319 |
318 |
320 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
319 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
321 <dd> |
320 <dd> |
322 reference to the project item to be opened |
321 reference to the project item to be opened |
323 </dd> |
322 </dd> |
324 </dl> |
323 </dl> |
325 <a NAME="MultiProjectBrowser.__projectAdded" ID="MultiProjectBrowser.__projectAdded"></a> |
324 <a NAME="MultiProjectBrowser.__projectAdded" ID="MultiProjectBrowser.__projectAdded"></a> |
326 <h4>MultiProjectBrowser.__projectAdded</h4> |
325 <h4>MultiProjectBrowser.__projectAdded</h4> |
327 <b>__projectAdded</b>(<i>project</i>) |
326 <b>__projectAdded</b>(<i>project</i>) |
328 |
|
329 <p> |
327 <p> |
330 Private slot to handle the addition of a project to the multi project. |
328 Private slot to handle the addition of a project to the multi project. |
331 </p> |
329 </p> |
|
330 |
332 <dl> |
331 <dl> |
333 |
332 |
334 <dt><i>project</i> (MultiProjectProjectMeta)</dt> |
333 <dt><i>project</i> (MultiProjectProjectMeta)</dt> |
335 <dd> |
334 <dd> |
336 reference to the project metadata |
335 reference to the project metadata |
337 </dd> |
336 </dd> |
338 </dl> |
337 </dl> |
339 <a NAME="MultiProjectBrowser.__projectClosed" ID="MultiProjectBrowser.__projectClosed"></a> |
338 <a NAME="MultiProjectBrowser.__projectClosed" ID="MultiProjectBrowser.__projectClosed"></a> |
340 <h4>MultiProjectBrowser.__projectClosed</h4> |
339 <h4>MultiProjectBrowser.__projectClosed</h4> |
341 <b>__projectClosed</b>(<i></i>) |
340 <b>__projectClosed</b>(<i></i>) |
342 |
|
343 <p> |
341 <p> |
344 Private slot to handle the closing of a project. |
342 Private slot to handle the closing of a project. |
345 </p> |
343 </p> |
|
344 |
346 <a NAME="MultiProjectBrowser.__projectDataChanged" ID="MultiProjectBrowser.__projectDataChanged"></a> |
345 <a NAME="MultiProjectBrowser.__projectDataChanged" ID="MultiProjectBrowser.__projectDataChanged"></a> |
347 <h4>MultiProjectBrowser.__projectDataChanged</h4> |
346 <h4>MultiProjectBrowser.__projectDataChanged</h4> |
348 <b>__projectDataChanged</b>(<i>project</i>) |
347 <b>__projectDataChanged</b>(<i>project</i>) |
349 |
|
350 <p> |
348 <p> |
351 Private slot to handle the change of a project of the multi project. |
349 Private slot to handle the change of a project of the multi project. |
352 </p> |
350 </p> |
|
351 |
353 <dl> |
352 <dl> |
354 |
353 |
355 <dt><i>project</i> (MultiProjectProjectMeta)</dt> |
354 <dt><i>project</i> (MultiProjectProjectMeta)</dt> |
356 <dd> |
355 <dd> |
357 reference to the project metadata |
356 reference to the project metadata |
358 </dd> |
357 </dd> |
359 </dl> |
358 </dl> |
360 <a NAME="MultiProjectBrowser.__projectOpened" ID="MultiProjectBrowser.__projectOpened"></a> |
359 <a NAME="MultiProjectBrowser.__projectOpened" ID="MultiProjectBrowser.__projectOpened"></a> |
361 <h4>MultiProjectBrowser.__projectOpened</h4> |
360 <h4>MultiProjectBrowser.__projectOpened</h4> |
362 <b>__projectOpened</b>(<i></i>) |
361 <b>__projectOpened</b>(<i></i>) |
363 |
|
364 <p> |
362 <p> |
365 Private slot to handle the opening of a project. |
363 Private slot to handle the opening of a project. |
366 </p> |
364 </p> |
|
365 |
367 <a NAME="MultiProjectBrowser.__projectRemoved" ID="MultiProjectBrowser.__projectRemoved"></a> |
366 <a NAME="MultiProjectBrowser.__projectRemoved" ID="MultiProjectBrowser.__projectRemoved"></a> |
368 <h4>MultiProjectBrowser.__projectRemoved</h4> |
367 <h4>MultiProjectBrowser.__projectRemoved</h4> |
369 <b>__projectRemoved</b>(<i>project</i>) |
368 <b>__projectRemoved</b>(<i>project</i>) |
370 |
|
371 <p> |
369 <p> |
372 Private slot to handle the removal of a project from the multi project. |
370 Private slot to handle the removal of a project from the multi project. |
373 </p> |
371 </p> |
|
372 |
374 <dl> |
373 <dl> |
375 |
374 |
376 <dt><i>project</i> (MultiProjectProjectMeta)</dt> |
375 <dt><i>project</i> (MultiProjectProjectMeta)</dt> |
377 <dd> |
376 <dd> |
378 reference to the project metadata |
377 reference to the project metadata |
379 </dd> |
378 </dd> |
380 </dl> |
379 </dl> |
381 <a NAME="MultiProjectBrowser.__removeProject" ID="MultiProjectBrowser.__removeProject"></a> |
380 <a NAME="MultiProjectBrowser.__removeProject" ID="MultiProjectBrowser.__removeProject"></a> |
382 <h4>MultiProjectBrowser.__removeProject</h4> |
381 <h4>MultiProjectBrowser.__removeProject</h4> |
383 <b>__removeProject</b>(<i></i>) |
382 <b>__removeProject</b>(<i></i>) |
384 |
|
385 <p> |
383 <p> |
386 Private method to handle the Remove context menu entry. |
384 Private method to handle the Remove context menu entry. |
387 </p> |
385 </p> |
|
386 |
388 <a NAME="MultiProjectBrowser.__setItemData" ID="MultiProjectBrowser.__setItemData"></a> |
387 <a NAME="MultiProjectBrowser.__setItemData" ID="MultiProjectBrowser.__setItemData"></a> |
389 <h4>MultiProjectBrowser.__setItemData</h4> |
388 <h4>MultiProjectBrowser.__setItemData</h4> |
390 <b>__setItemData</b>(<i>itm, project</i>) |
389 <b>__setItemData</b>(<i>itm, project</i>) |
391 |
|
392 <p> |
390 <p> |
393 Private method to set the data of a project item. |
391 Private method to set the data of a project item. |
394 </p> |
392 </p> |
|
393 |
395 <dl> |
394 <dl> |
396 |
395 |
397 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
396 <dt><i>itm</i> (QTreeWidgetItem)</dt> |
398 <dd> |
397 <dd> |
399 reference to the item to be set |
398 reference to the item to be set |