Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.MultiProject.MultiProjectBrowser.html

changeset 3673
e26d7d0c1088
child 5314
76013775e623
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
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>None</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.__createPopupMenu">__createPopupMenu</a></td>
76 <td>Private method to create the popup menu.</td>
77 </tr><tr>
78 <td><a href="#MultiProjectBrowser.__findCategoryItem">__findCategoryItem</a></td>
79 <td>Private method to find the item for a category.</td>
80 </tr><tr>
81 <td><a href="#MultiProjectBrowser.__findProjectItem">__findProjectItem</a></td>
82 <td>Private method to search a specific project item.</td>
83 </tr><tr>
84 <td><a href="#MultiProjectBrowser.__multiProjectClosed">__multiProjectClosed</a></td>
85 <td>Private slot to handle the closing of a multi project.</td>
86 </tr><tr>
87 <td><a href="#MultiProjectBrowser.__multiProjectOpened">__multiProjectOpened</a></td>
88 <td>Private slot to handle the opening of a multi project.</td>
89 </tr><tr>
90 <td><a href="#MultiProjectBrowser.__newMultiProject">__newMultiProject</a></td>
91 <td>Private slot to handle the creation of a new multi project.</td>
92 </tr><tr>
93 <td><a href="#MultiProjectBrowser.__openItem">__openItem</a></td>
94 <td>Private slot to open a project.</td>
95 </tr><tr>
96 <td><a href="#MultiProjectBrowser.__projectAdded">__projectAdded</a></td>
97 <td>Private slot to handle the addition of a project to the multi project.</td>
98 </tr><tr>
99 <td><a href="#MultiProjectBrowser.__projectDataChanged">__projectDataChanged</a></td>
100 <td>Private slot to handle the change of a project of the multi project.</td>
101 </tr><tr>
102 <td><a href="#MultiProjectBrowser.__projectOpened">__projectOpened</a></td>
103 <td>Private slot to handle the opening of a project.</td>
104 </tr><tr>
105 <td><a href="#MultiProjectBrowser.__projectRemoved">__projectRemoved</a></td>
106 <td>Private slot to handle the removal of a project from the multi project.</td>
107 </tr><tr>
108 <td><a href="#MultiProjectBrowser.__removeProject">__removeProject</a></td>
109 <td>Private method to handle the Remove context menu entry.</td>
110 </tr><tr>
111 <td><a href="#MultiProjectBrowser.__setItemData">__setItemData</a></td>
112 <td>Private method to set the data of a project item.</td>
113 </tr><tr>
114 <td><a href="#MultiProjectBrowser.__showProjectProperties">__showProjectProperties</a></td>
115 <td>Private method to show the data of a project entry.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119 <table>
120 <tr><td>None</td></tr>
121 </table>
122 <a NAME="MultiProjectBrowser.__init__" ID="MultiProjectBrowser.__init__"></a>
123 <h4>MultiProjectBrowser (Constructor)</h4>
124 <b>MultiProjectBrowser</b>(<i>multiProject, parent=None</i>)
125 <p>
126 Constructor
127 </p><dl>
128 <dt><i>multiProject</i></dt>
129 <dd>
130 reference to the multi project object
131 </dd><dt><i>parent</i></dt>
132 <dd>
133 parent widget (QWidget)
134 </dd>
135 </dl><a NAME="MultiProjectBrowser.__addNewProject" ID="MultiProjectBrowser.__addNewProject"></a>
136 <h4>MultiProjectBrowser.__addNewProject</h4>
137 <b>__addNewProject</b>(<i></i>)
138 <p>
139 Private method to add a new project entry.
140 </p><a NAME="MultiProjectBrowser.__addProject" ID="MultiProjectBrowser.__addProject"></a>
141 <h4>MultiProjectBrowser.__addProject</h4>
142 <b>__addProject</b>(<i>project</i>)
143 <p>
144 Private method to add a project to the list.
145 </p><dl>
146 <dt><i>project</i></dt>
147 <dd>
148 reference to the project data dictionary
149 </dd>
150 </dl><a NAME="MultiProjectBrowser.__configure" ID="MultiProjectBrowser.__configure"></a>
151 <h4>MultiProjectBrowser.__configure</h4>
152 <b>__configure</b>(<i></i>)
153 <p>
154 Private method to open the configuration dialog.
155 </p><a NAME="MultiProjectBrowser.__contextMenuRequested" ID="MultiProjectBrowser.__contextMenuRequested"></a>
156 <h4>MultiProjectBrowser.__contextMenuRequested</h4>
157 <b>__contextMenuRequested</b>(<i>coord</i>)
158 <p>
159 Private slot to show the context menu.
160 </p><dl>
161 <dt><i>coord</i></dt>
162 <dd>
163 the position of the mouse pointer (QPoint)
164 </dd>
165 </dl><a NAME="MultiProjectBrowser.__createPopupMenu" ID="MultiProjectBrowser.__createPopupMenu"></a>
166 <h4>MultiProjectBrowser.__createPopupMenu</h4>
167 <b>__createPopupMenu</b>(<i></i>)
168 <p>
169 Private method to create the popup menu.
170 </p><a NAME="MultiProjectBrowser.__findCategoryItem" ID="MultiProjectBrowser.__findCategoryItem"></a>
171 <h4>MultiProjectBrowser.__findCategoryItem</h4>
172 <b>__findCategoryItem</b>(<i>category</i>)
173 <p>
174 Private method to find the item for a category.
175 </p><dl>
176 <dt><i>category</i></dt>
177 <dd>
178 category to search for (string)
179 </dd>
180 </dl><dl>
181 <dt>Returns:</dt>
182 <dd>
183 reference to the category item or None, if there is
184 no such item (QTreeWidgetItem or None)
185 </dd>
186 </dl><a NAME="MultiProjectBrowser.__findProjectItem" ID="MultiProjectBrowser.__findProjectItem"></a>
187 <h4>MultiProjectBrowser.__findProjectItem</h4>
188 <b>__findProjectItem</b>(<i>project</i>)
189 <p>
190 Private method to search a specific project item.
191 </p><dl>
192 <dt><i>project</i></dt>
193 <dd>
194 reference to the project data dictionary
195 </dd>
196 </dl><dl>
197 <dt>Returns:</dt>
198 <dd>
199 reference to the item (QTreeWidgetItem) or None
200 </dd>
201 </dl><a NAME="MultiProjectBrowser.__multiProjectClosed" ID="MultiProjectBrowser.__multiProjectClosed"></a>
202 <h4>MultiProjectBrowser.__multiProjectClosed</h4>
203 <b>__multiProjectClosed</b>(<i></i>)
204 <p>
205 Private slot to handle the closing of a multi project.
206 </p><a NAME="MultiProjectBrowser.__multiProjectOpened" ID="MultiProjectBrowser.__multiProjectOpened"></a>
207 <h4>MultiProjectBrowser.__multiProjectOpened</h4>
208 <b>__multiProjectOpened</b>(<i></i>)
209 <p>
210 Private slot to handle the opening of a multi project.
211 </p><a NAME="MultiProjectBrowser.__newMultiProject" ID="MultiProjectBrowser.__newMultiProject"></a>
212 <h4>MultiProjectBrowser.__newMultiProject</h4>
213 <b>__newMultiProject</b>(<i></i>)
214 <p>
215 Private slot to handle the creation of a new multi project.
216 </p><a NAME="MultiProjectBrowser.__openItem" ID="MultiProjectBrowser.__openItem"></a>
217 <h4>MultiProjectBrowser.__openItem</h4>
218 <b>__openItem</b>(<i>itm=None</i>)
219 <p>
220 Private slot to open a project.
221 </p><dl>
222 <dt><i>itm</i></dt>
223 <dd>
224 reference to the project item to be opened (QTreeWidgetItem)
225 </dd>
226 </dl><a NAME="MultiProjectBrowser.__projectAdded" ID="MultiProjectBrowser.__projectAdded"></a>
227 <h4>MultiProjectBrowser.__projectAdded</h4>
228 <b>__projectAdded</b>(<i>project</i>)
229 <p>
230 Private slot to handle the addition of a project to the multi project.
231 </p><dl>
232 <dt><i>project</i></dt>
233 <dd>
234 reference to the project data dictionary
235 </dd>
236 </dl><a NAME="MultiProjectBrowser.__projectDataChanged" ID="MultiProjectBrowser.__projectDataChanged"></a>
237 <h4>MultiProjectBrowser.__projectDataChanged</h4>
238 <b>__projectDataChanged</b>(<i>project</i>)
239 <p>
240 Private slot to handle the change of a project of the multi project.
241 </p><dl>
242 <dt><i>project</i></dt>
243 <dd>
244 reference to the project data dictionary
245 </dd>
246 </dl><a NAME="MultiProjectBrowser.__projectOpened" ID="MultiProjectBrowser.__projectOpened"></a>
247 <h4>MultiProjectBrowser.__projectOpened</h4>
248 <b>__projectOpened</b>(<i>projectfile</i>)
249 <p>
250 Private slot to handle the opening of a project.
251 </p><dl>
252 <dt><i>projectfile</i></dt>
253 <dd>
254 file name of the opened project file (string)
255 </dd>
256 </dl><a NAME="MultiProjectBrowser.__projectRemoved" ID="MultiProjectBrowser.__projectRemoved"></a>
257 <h4>MultiProjectBrowser.__projectRemoved</h4>
258 <b>__projectRemoved</b>(<i>project</i>)
259 <p>
260 Private slot to handle the removal of a project from the multi project.
261 </p><dl>
262 <dt><i>project</i></dt>
263 <dd>
264 reference to the project data dictionary
265 </dd>
266 </dl><a NAME="MultiProjectBrowser.__removeProject" ID="MultiProjectBrowser.__removeProject"></a>
267 <h4>MultiProjectBrowser.__removeProject</h4>
268 <b>__removeProject</b>(<i></i>)
269 <p>
270 Private method to handle the Remove context menu entry.
271 </p><a NAME="MultiProjectBrowser.__setItemData" ID="MultiProjectBrowser.__setItemData"></a>
272 <h4>MultiProjectBrowser.__setItemData</h4>
273 <b>__setItemData</b>(<i>itm, project</i>)
274 <p>
275 Private method to set the data of a project item.
276 </p><dl>
277 <dt><i>itm</i></dt>
278 <dd>
279 reference to the item to be set (QTreeWidgetItem)
280 </dd><dt><i>project</i></dt>
281 <dd>
282 reference to the project data dictionary
283 </dd>
284 </dl><a NAME="MultiProjectBrowser.__showProjectProperties" ID="MultiProjectBrowser.__showProjectProperties"></a>
285 <h4>MultiProjectBrowser.__showProjectProperties</h4>
286 <b>__showProjectProperties</b>(<i></i>)
287 <p>
288 Private method to show the data of a project entry.
289 </p>
290 <div align="right"><a href="#top">Up</a></div>
291 <hr />
292 </body></html>

Mercurial Repository: eric

eric ide

mercurial