Mercurial Repositories > eric / file comparison

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

eric6/Documentation/Source/eric6.MultiProject.MultiProjectBrowser.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.MultiProjectBrowser</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.MultiProjectBrowser</h1>
23 <p>
24 Module implementing the multi project browser.
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="#MultiProjectBrowser">MultiProjectBrowser</a></td>
34 <td>Class implementing the multi project browser.</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="MultiProjectBrowser" ID="MultiProjectBrowser"></a>
43 <h2>MultiProjectBrowser</h2>
44 <p>
45 Class implementing the multi project browser.
46 </p>
47 <h3>Derived from</h3>
48 QTreeWidget
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>ProjectFileNameRole</td></tr><tr><td>ProjectUidRole</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#MultiProjectBrowser.__init__">MultiProjectBrowser</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#MultiProjectBrowser.__addNewProject">__addNewProject</a></td>
64 <td>Private method to add a new project entry.</td>
65 </tr><tr>
66 <td><a href="#MultiProjectBrowser.__addProject">__addProject</a></td>
67 <td>Private method to add a project to the list.</td>
68 </tr><tr>
69 <td><a href="#MultiProjectBrowser.__configure">__configure</a></td>
70 <td>Private method to open the configuration dialog.</td>
71 </tr><tr>
72 <td><a href="#MultiProjectBrowser.__contextMenuRequested">__contextMenuRequested</a></td>
73 <td>Private slot to show the context menu.</td>
74 </tr><tr>
75 <td><a href="#MultiProjectBrowser.__copyProject">__copyProject</a></td>
76 <td>Private method to copy the selected project on disk.</td>
77 </tr><tr>
78 <td><a href="#MultiProjectBrowser.__createPopupMenu">__createPopupMenu</a></td>
79 <td>Private method to create the popup menu.</td>
80 </tr><tr>
81 <td><a href="#MultiProjectBrowser.__deleteProject">__deleteProject</a></td>
82 <td>Private method to handle the Delete context menu entry.</td>
83 </tr><tr>
84 <td><a href="#MultiProjectBrowser.__findCategoryItem">__findCategoryItem</a></td>
85 <td>Private method to find the item for a category.</td>
86 </tr><tr>
87 <td><a href="#MultiProjectBrowser.__findProjectItem">__findProjectItem</a></td>
88 <td>Private method to search a specific project item.</td>
89 </tr><tr>
90 <td><a href="#MultiProjectBrowser.__multiProjectClosed">__multiProjectClosed</a></td>
91 <td>Private slot to handle the closing of a multi project.</td>
92 </tr><tr>
93 <td><a href="#MultiProjectBrowser.__multiProjectOpened">__multiProjectOpened</a></td>
94 <td>Private slot to handle the opening of a multi project.</td>
95 </tr><tr>
96 <td><a href="#MultiProjectBrowser.__newMultiProject">__newMultiProject</a></td>
97 <td>Private slot to handle the creation of a new multi project.</td>
98 </tr><tr>
99 <td><a href="#MultiProjectBrowser.__openItem">__openItem</a></td>
100 <td>Private slot to open a project.</td>
101 </tr><tr>
102 <td><a href="#MultiProjectBrowser.__projectAdded">__projectAdded</a></td>
103 <td>Private slot to handle the addition of a project to the multi project.</td>
104 </tr><tr>
105 <td><a href="#MultiProjectBrowser.__projectClosed">__projectClosed</a></td>
106 <td>Private slot to handle the closing of a project.</td>
107 </tr><tr>
108 <td><a href="#MultiProjectBrowser.__projectDataChanged">__projectDataChanged</a></td>
109 <td>Private slot to handle the change of a project of the multi project.</td>
110 </tr><tr>
111 <td><a href="#MultiProjectBrowser.__projectOpened">__projectOpened</a></td>
112 <td>Private slot to handle the opening of a project.</td>
113 </tr><tr>
114 <td><a href="#MultiProjectBrowser.__projectRemoved">__projectRemoved</a></td>
115 <td>Private slot to handle the removal of a project from the multi project.</td>
116 </tr><tr>
117 <td><a href="#MultiProjectBrowser.__removeProject">__removeProject</a></td>
118 <td>Private method to handle the Remove context menu entry.</td>
119 </tr><tr>
120 <td><a href="#MultiProjectBrowser.__setItemData">__setItemData</a></td>
121 <td>Private method to set the data of a project item.</td>
122 </tr><tr>
123 <td><a href="#MultiProjectBrowser.__showProjectProperties">__showProjectProperties</a></td>
124 <td>Private method to show the data of a project entry.</td>
125 </tr>
126 </table>
127 <h3>Static Methods</h3>
128 <table>
129 <tr><td>None</td></tr>
130 </table>
131 <a NAME="MultiProjectBrowser.__init__" ID="MultiProjectBrowser.__init__"></a>
132 <h4>MultiProjectBrowser (Constructor)</h4>
133 <b>MultiProjectBrowser</b>(<i>multiProject, project, parent=None</i>)
134 <p>
135 Constructor
136 </p><dl>
137 <dt><i>multiProject</i> (MultiProject)</dt>
138 <dd>
139 reference to the multi project object
140 </dd><dt><i>project</i> (Project)</dt>
141 <dd>
142 reference to the project object
143 </dd><dt><i>parent</i> (QWidget)</dt>
144 <dd>
145 parent widget
146 </dd>
147 </dl><a NAME="MultiProjectBrowser.__addNewProject" ID="MultiProjectBrowser.__addNewProject"></a>
148 <h4>MultiProjectBrowser.__addNewProject</h4>
149 <b>__addNewProject</b>(<i></i>)
150 <p>
151 Private method to add a new project entry.
152 </p><a NAME="MultiProjectBrowser.__addProject" ID="MultiProjectBrowser.__addProject"></a>
153 <h4>MultiProjectBrowser.__addProject</h4>
154 <b>__addProject</b>(<i>project</i>)
155 <p>
156 Private method to add a project to the list.
157 </p><dl>
158 <dt><i>project</i></dt>
159 <dd>
160 reference to the project data dictionary
161 </dd>
162 </dl><a NAME="MultiProjectBrowser.__configure" ID="MultiProjectBrowser.__configure"></a>
163 <h4>MultiProjectBrowser.__configure</h4>
164 <b>__configure</b>(<i></i>)
165 <p>
166 Private method to open the configuration dialog.
167 </p><a NAME="MultiProjectBrowser.__contextMenuRequested" ID="MultiProjectBrowser.__contextMenuRequested"></a>
168 <h4>MultiProjectBrowser.__contextMenuRequested</h4>
169 <b>__contextMenuRequested</b>(<i>coord</i>)
170 <p>
171 Private slot to show the context menu.
172 </p><dl>
173 <dt><i>coord</i></dt>
174 <dd>
175 the position of the mouse pointer (QPoint)
176 </dd>
177 </dl><a NAME="MultiProjectBrowser.__copyProject" ID="MultiProjectBrowser.__copyProject"></a>
178 <h4>MultiProjectBrowser.__copyProject</h4>
179 <b>__copyProject</b>(<i></i>)
180 <p>
181 Private method to copy the selected project on disk.
182 </p><a NAME="MultiProjectBrowser.__createPopupMenu" ID="MultiProjectBrowser.__createPopupMenu"></a>
183 <h4>MultiProjectBrowser.__createPopupMenu</h4>
184 <b>__createPopupMenu</b>(<i></i>)
185 <p>
186 Private method to create the popup menu.
187 </p><a NAME="MultiProjectBrowser.__deleteProject" ID="MultiProjectBrowser.__deleteProject"></a>
188 <h4>MultiProjectBrowser.__deleteProject</h4>
189 <b>__deleteProject</b>(<i></i>)
190 <p>
191 Private method to handle the Delete context menu entry.
192 </p><a NAME="MultiProjectBrowser.__findCategoryItem" ID="MultiProjectBrowser.__findCategoryItem"></a>
193 <h4>MultiProjectBrowser.__findCategoryItem</h4>
194 <b>__findCategoryItem</b>(<i>category</i>)
195 <p>
196 Private method to find the item for a category.
197 </p><dl>
198 <dt><i>category</i></dt>
199 <dd>
200 category to search for (string)
201 </dd>
202 </dl><dl>
203 <dt>Returns:</dt>
204 <dd>
205 reference to the category item or None, if there is
206 no such item (QTreeWidgetItem or None)
207 </dd>
208 </dl><a NAME="MultiProjectBrowser.__findProjectItem" ID="MultiProjectBrowser.__findProjectItem"></a>
209 <h4>MultiProjectBrowser.__findProjectItem</h4>
210 <b>__findProjectItem</b>(<i>project</i>)
211 <p>
212 Private method to search a specific project item.
213 </p><dl>
214 <dt><i>project</i></dt>
215 <dd>
216 reference to the project data dictionary
217 </dd>
218 </dl><dl>
219 <dt>Returns:</dt>
220 <dd>
221 reference to the item (QTreeWidgetItem) or None
222 </dd>
223 </dl><a NAME="MultiProjectBrowser.__multiProjectClosed" ID="MultiProjectBrowser.__multiProjectClosed"></a>
224 <h4>MultiProjectBrowser.__multiProjectClosed</h4>
225 <b>__multiProjectClosed</b>(<i></i>)
226 <p>
227 Private slot to handle the closing of a multi project.
228 </p><a NAME="MultiProjectBrowser.__multiProjectOpened" ID="MultiProjectBrowser.__multiProjectOpened"></a>
229 <h4>MultiProjectBrowser.__multiProjectOpened</h4>
230 <b>__multiProjectOpened</b>(<i></i>)
231 <p>
232 Private slot to handle the opening of a multi project.
233 </p><a NAME="MultiProjectBrowser.__newMultiProject" ID="MultiProjectBrowser.__newMultiProject"></a>
234 <h4>MultiProjectBrowser.__newMultiProject</h4>
235 <b>__newMultiProject</b>(<i></i>)
236 <p>
237 Private slot to handle the creation of a new multi project.
238 </p><a NAME="MultiProjectBrowser.__openItem" ID="MultiProjectBrowser.__openItem"></a>
239 <h4>MultiProjectBrowser.__openItem</h4>
240 <b>__openItem</b>(<i>itm=None</i>)
241 <p>
242 Private slot to open a project.
243 </p><dl>
244 <dt><i>itm</i></dt>
245 <dd>
246 reference to the project item to be opened (QTreeWidgetItem)
247 </dd>
248 </dl><a NAME="MultiProjectBrowser.__projectAdded" ID="MultiProjectBrowser.__projectAdded"></a>
249 <h4>MultiProjectBrowser.__projectAdded</h4>
250 <b>__projectAdded</b>(<i>project</i>)
251 <p>
252 Private slot to handle the addition of a project to the multi project.
253 </p><dl>
254 <dt><i>project</i></dt>
255 <dd>
256 reference to the project data dictionary
257 </dd>
258 </dl><a NAME="MultiProjectBrowser.__projectClosed" ID="MultiProjectBrowser.__projectClosed"></a>
259 <h4>MultiProjectBrowser.__projectClosed</h4>
260 <b>__projectClosed</b>(<i></i>)
261 <p>
262 Private slot to handle the closing of a project.
263 </p><a NAME="MultiProjectBrowser.__projectDataChanged" ID="MultiProjectBrowser.__projectDataChanged"></a>
264 <h4>MultiProjectBrowser.__projectDataChanged</h4>
265 <b>__projectDataChanged</b>(<i>project</i>)
266 <p>
267 Private slot to handle the change of a project of the multi project.
268 </p><dl>
269 <dt><i>project</i></dt>
270 <dd>
271 reference to the project data dictionary
272 </dd>
273 </dl><a NAME="MultiProjectBrowser.__projectOpened" ID="MultiProjectBrowser.__projectOpened"></a>
274 <h4>MultiProjectBrowser.__projectOpened</h4>
275 <b>__projectOpened</b>(<i></i>)
276 <p>
277 Private slot to handle the opening of a project.
278 </p><a NAME="MultiProjectBrowser.__projectRemoved" ID="MultiProjectBrowser.__projectRemoved"></a>
279 <h4>MultiProjectBrowser.__projectRemoved</h4>
280 <b>__projectRemoved</b>(<i>project</i>)
281 <p>
282 Private slot to handle the removal of a project from the multi project.
283 </p><dl>
284 <dt><i>project</i></dt>
285 <dd>
286 reference to the project data dictionary
287 </dd>
288 </dl><a NAME="MultiProjectBrowser.__removeProject" ID="MultiProjectBrowser.__removeProject"></a>
289 <h4>MultiProjectBrowser.__removeProject</h4>
290 <b>__removeProject</b>(<i></i>)
291 <p>
292 Private method to handle the Remove context menu entry.
293 </p><a NAME="MultiProjectBrowser.__setItemData" ID="MultiProjectBrowser.__setItemData"></a>
294 <h4>MultiProjectBrowser.__setItemData</h4>
295 <b>__setItemData</b>(<i>itm, project</i>)
296 <p>
297 Private method to set the data of a project item.
298 </p><dl>
299 <dt><i>itm</i></dt>
300 <dd>
301 reference to the item to be set (QTreeWidgetItem)
302 </dd><dt><i>project</i></dt>
303 <dd>
304 reference to the project data dictionary
305 </dd>
306 </dl><a NAME="MultiProjectBrowser.__showProjectProperties" ID="MultiProjectBrowser.__showProjectProperties"></a>
307 <h4>MultiProjectBrowser.__showProjectProperties</h4>
308 <b>__showProjectProperties</b>(<i></i>)
309 <p>
310 Private method to show the data of a project entry.
311 </p>
312 <div align="right"><a href="#top">Up</a></div>
313 <hr />
314 </body></html>

Mercurial Repository: eric

eric ide

mercurial