eric7/Documentation/Source/eric7.Project.ProjectSourcesBrowser.html

branch
eric7
changeset 8372
e0227a7c850e
child 8541
927d57b6aae0
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.ProjectSourcesBrowser</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>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Project.ProjectSourcesBrowser</h1>
24
25 <p>
26 Module implementing a class used to display the Sources part of the project.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#ProjectSourcesBrowser">ProjectSourcesBrowser</a></td>
39 <td>A class used to display the Sources part of the project.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="ProjectSourcesBrowser" ID="ProjectSourcesBrowser"></a>
50 <h2>ProjectSourcesBrowser</h2>
51
52 <p>
53 A class used to display the Sources part of the project.
54 </p>
55 <h3>Signals</h3>
56 <dl>
57
58 <dt>showMenu(str, QMenu)</dt>
59 <dd>
60 emitted when a menu is about to be shown.
61 The name of the menu and a reference to the menu are given.
62 </dd>
63 </dl>
64 <h3>Derived from</h3>
65 ProjectBaseBrowser
66 <h3>Class Attributes</h3>
67
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Class Methods</h3>
72
73 <table>
74 <tr><td>None</td></tr>
75 </table>
76 <h3>Methods</h3>
77
78 <table>
79
80 <tr>
81 <td><a href="#ProjectSourcesBrowser.__init__">ProjectSourcesBrowser</a></td>
82 <td>Constructor</td>
83 </tr>
84 <tr>
85 <td><a href="#ProjectSourcesBrowser.__addNewPackage">__addNewPackage</a></td>
86 <td>Private method to add a new package to the project.</td>
87 </tr>
88 <tr>
89 <td><a href="#ProjectSourcesBrowser.__addSourceDirectory">__addSourceDirectory</a></td>
90 <td>Private method to add source files of a directory to the project.</td>
91 </tr>
92 <tr>
93 <td><a href="#ProjectSourcesBrowser.__addSourceFiles">__addSourceFiles</a></td>
94 <td>Private method to add a source file to the project.</td>
95 </tr>
96 <tr>
97 <td><a href="#ProjectSourcesBrowser.__closeAllWindows">__closeAllWindows</a></td>
98 <td>Private method to close all project related windows.</td>
99 </tr>
100 <tr>
101 <td><a href="#ProjectSourcesBrowser.__createJavaScriptPopupMenus">__createJavaScriptPopupMenus</a></td>
102 <td>Private method to generate the popup menus for a Python project.</td>
103 </tr>
104 <tr>
105 <td><a href="#ProjectSourcesBrowser.__createPythonPopupMenus">__createPythonPopupMenus</a></td>
106 <td>Private method to generate the popup menus for a Python project.</td>
107 </tr>
108 <tr>
109 <td><a href="#ProjectSourcesBrowser.__createRubyPopupMenus">__createRubyPopupMenus</a></td>
110 <td>Private method to generate the popup menus for a Ruby project.</td>
111 </tr>
112 <tr>
113 <td><a href="#ProjectSourcesBrowser.__deleteFile">__deleteFile</a></td>
114 <td>Private method to delete files from the project.</td>
115 </tr>
116 <tr>
117 <td><a href="#ProjectSourcesBrowser.__loadDiagram">__loadDiagram</a></td>
118 <td>Private slot to load a diagram from file.</td>
119 </tr>
120 <tr>
121 <td><a href="#ProjectSourcesBrowser.__showApplicationDiagram">__showApplicationDiagram</a></td>
122 <td>Private method to handle the application diagram context menu action.</td>
123 </tr>
124 <tr>
125 <td><a href="#ProjectSourcesBrowser.__showClassDiagram">__showClassDiagram</a></td>
126 <td>Private method to handle the class diagram context menu action.</td>
127 </tr>
128 <tr>
129 <td><a href="#ProjectSourcesBrowser.__showCodeCoverage">__showCodeCoverage</a></td>
130 <td>Private method to handle the code coverage context menu action.</td>
131 </tr>
132 <tr>
133 <td><a href="#ProjectSourcesBrowser.__showCodeMetrics">__showCodeMetrics</a></td>
134 <td>Private method to handle the code metrics context menu action.</td>
135 </tr>
136 <tr>
137 <td><a href="#ProjectSourcesBrowser.__showContextMenu">__showContextMenu</a></td>
138 <td>Private slot called by the sourceMenu aboutToShow signal.</td>
139 </tr>
140 <tr>
141 <td><a href="#ProjectSourcesBrowser.__showContextMenuBack">__showContextMenuBack</a></td>
142 <td>Private slot called by the backMenu aboutToShow signal.</td>
143 </tr>
144 <tr>
145 <td><a href="#ProjectSourcesBrowser.__showContextMenuCheck">__showContextMenuCheck</a></td>
146 <td>Private slot called before the checks menu is shown.</td>
147 </tr>
148 <tr>
149 <td><a href="#ProjectSourcesBrowser.__showContextMenuDir">__showContextMenuDir</a></td>
150 <td>Private slot called by the dirMenu aboutToShow signal.</td>
151 </tr>
152 <tr>
153 <td><a href="#ProjectSourcesBrowser.__showContextMenuDirMulti">__showContextMenuDirMulti</a></td>
154 <td>Private slot called by the dirMultiMenu aboutToShow signal.</td>
155 </tr>
156 <tr>
157 <td><a href="#ProjectSourcesBrowser.__showContextMenuGraphics">__showContextMenuGraphics</a></td>
158 <td>Private slot called before the checks menu is shown.</td>
159 </tr>
160 <tr>
161 <td><a href="#ProjectSourcesBrowser.__showContextMenuMulti">__showContextMenuMulti</a></td>
162 <td>Private slot called by the multiMenu aboutToShow signal.</td>
163 </tr>
164 <tr>
165 <td><a href="#ProjectSourcesBrowser.__showContextMenuShow">__showContextMenuShow</a></td>
166 <td>Private slot called before the show menu is shown.</td>
167 </tr>
168 <tr>
169 <td><a href="#ProjectSourcesBrowser.__showImportsDiagram">__showImportsDiagram</a></td>
170 <td>Private method to handle the imports diagram context menu action.</td>
171 </tr>
172 <tr>
173 <td><a href="#ProjectSourcesBrowser.__showPackageDiagram">__showPackageDiagram</a></td>
174 <td>Private method to handle the package diagram context menu action.</td>
175 </tr>
176 <tr>
177 <td><a href="#ProjectSourcesBrowser.__showProfileData">__showProfileData</a></td>
178 <td>Private method to handle the show profile data context menu action.</td>
179 </tr>
180 <tr>
181 <td><a href="#ProjectSourcesBrowser._contextMenuRequested">_contextMenuRequested</a></td>
182 <td>Protected slot to show the context menu.</td>
183 </tr>
184 <tr>
185 <td><a href="#ProjectSourcesBrowser._createPopupMenus">_createPopupMenus</a></td>
186 <td>Protected overloaded method to generate the popup menu.</td>
187 </tr>
188 <tr>
189 <td><a href="#ProjectSourcesBrowser._openItem">_openItem</a></td>
190 <td>Protected slot to handle the open popup menu entry.</td>
191 </tr>
192 <tr>
193 <td><a href="#ProjectSourcesBrowser._projectClosed">_projectClosed</a></td>
194 <td>Protected slot to handle the projectClosed signal.</td>
195 </tr>
196 </table>
197 <h3>Static Methods</h3>
198
199 <table>
200 <tr><td>None</td></tr>
201 </table>
202
203 <a NAME="ProjectSourcesBrowser.__init__" ID="ProjectSourcesBrowser.__init__"></a>
204 <h4>ProjectSourcesBrowser (Constructor)</h4>
205 <b>ProjectSourcesBrowser</b>(<i>project, parent=None</i>)
206
207 <p>
208 Constructor
209 </p>
210 <dl>
211
212 <dt><i>project</i></dt>
213 <dd>
214 reference to the project object
215 </dd>
216 <dt><i>parent</i></dt>
217 <dd>
218 parent widget of this browser (QWidget)
219 </dd>
220 </dl>
221 <a NAME="ProjectSourcesBrowser.__addNewPackage" ID="ProjectSourcesBrowser.__addNewPackage"></a>
222 <h4>ProjectSourcesBrowser.__addNewPackage</h4>
223 <b>__addNewPackage</b>(<i></i>)
224
225 <p>
226 Private method to add a new package to the project.
227 </p>
228 <a NAME="ProjectSourcesBrowser.__addSourceDirectory" ID="ProjectSourcesBrowser.__addSourceDirectory"></a>
229 <h4>ProjectSourcesBrowser.__addSourceDirectory</h4>
230 <b>__addSourceDirectory</b>(<i></i>)
231
232 <p>
233 Private method to add source files of a directory to the project.
234 </p>
235 <a NAME="ProjectSourcesBrowser.__addSourceFiles" ID="ProjectSourcesBrowser.__addSourceFiles"></a>
236 <h4>ProjectSourcesBrowser.__addSourceFiles</h4>
237 <b>__addSourceFiles</b>(<i></i>)
238
239 <p>
240 Private method to add a source file to the project.
241 </p>
242 <a NAME="ProjectSourcesBrowser.__closeAllWindows" ID="ProjectSourcesBrowser.__closeAllWindows"></a>
243 <h4>ProjectSourcesBrowser.__closeAllWindows</h4>
244 <b>__closeAllWindows</b>(<i></i>)
245
246 <p>
247 Private method to close all project related windows.
248 </p>
249 <a NAME="ProjectSourcesBrowser.__createJavaScriptPopupMenus" ID="ProjectSourcesBrowser.__createJavaScriptPopupMenus"></a>
250 <h4>ProjectSourcesBrowser.__createJavaScriptPopupMenus</h4>
251 <b>__createJavaScriptPopupMenus</b>(<i></i>)
252
253 <p>
254 Private method to generate the popup menus for a Python project.
255 </p>
256 <a NAME="ProjectSourcesBrowser.__createPythonPopupMenus" ID="ProjectSourcesBrowser.__createPythonPopupMenus"></a>
257 <h4>ProjectSourcesBrowser.__createPythonPopupMenus</h4>
258 <b>__createPythonPopupMenus</b>(<i></i>)
259
260 <p>
261 Private method to generate the popup menus for a Python project.
262 </p>
263 <a NAME="ProjectSourcesBrowser.__createRubyPopupMenus" ID="ProjectSourcesBrowser.__createRubyPopupMenus"></a>
264 <h4>ProjectSourcesBrowser.__createRubyPopupMenus</h4>
265 <b>__createRubyPopupMenus</b>(<i></i>)
266
267 <p>
268 Private method to generate the popup menus for a Ruby project.
269 </p>
270 <a NAME="ProjectSourcesBrowser.__deleteFile" ID="ProjectSourcesBrowser.__deleteFile"></a>
271 <h4>ProjectSourcesBrowser.__deleteFile</h4>
272 <b>__deleteFile</b>(<i></i>)
273
274 <p>
275 Private method to delete files from the project.
276 </p>
277 <a NAME="ProjectSourcesBrowser.__loadDiagram" ID="ProjectSourcesBrowser.__loadDiagram"></a>
278 <h4>ProjectSourcesBrowser.__loadDiagram</h4>
279 <b>__loadDiagram</b>(<i></i>)
280
281 <p>
282 Private slot to load a diagram from file.
283 </p>
284 <a NAME="ProjectSourcesBrowser.__showApplicationDiagram" ID="ProjectSourcesBrowser.__showApplicationDiagram"></a>
285 <h4>ProjectSourcesBrowser.__showApplicationDiagram</h4>
286 <b>__showApplicationDiagram</b>(<i></i>)
287
288 <p>
289 Private method to handle the application diagram context menu action.
290 </p>
291 <a NAME="ProjectSourcesBrowser.__showClassDiagram" ID="ProjectSourcesBrowser.__showClassDiagram"></a>
292 <h4>ProjectSourcesBrowser.__showClassDiagram</h4>
293 <b>__showClassDiagram</b>(<i></i>)
294
295 <p>
296 Private method to handle the class diagram context menu action.
297 </p>
298 <a NAME="ProjectSourcesBrowser.__showCodeCoverage" ID="ProjectSourcesBrowser.__showCodeCoverage"></a>
299 <h4>ProjectSourcesBrowser.__showCodeCoverage</h4>
300 <b>__showCodeCoverage</b>(<i></i>)
301
302 <p>
303 Private method to handle the code coverage context menu action.
304 </p>
305 <a NAME="ProjectSourcesBrowser.__showCodeMetrics" ID="ProjectSourcesBrowser.__showCodeMetrics"></a>
306 <h4>ProjectSourcesBrowser.__showCodeMetrics</h4>
307 <b>__showCodeMetrics</b>(<i></i>)
308
309 <p>
310 Private method to handle the code metrics context menu action.
311 </p>
312 <a NAME="ProjectSourcesBrowser.__showContextMenu" ID="ProjectSourcesBrowser.__showContextMenu"></a>
313 <h4>ProjectSourcesBrowser.__showContextMenu</h4>
314 <b>__showContextMenu</b>(<i></i>)
315
316 <p>
317 Private slot called by the sourceMenu aboutToShow signal.
318 </p>
319 <a NAME="ProjectSourcesBrowser.__showContextMenuBack" ID="ProjectSourcesBrowser.__showContextMenuBack"></a>
320 <h4>ProjectSourcesBrowser.__showContextMenuBack</h4>
321 <b>__showContextMenuBack</b>(<i></i>)
322
323 <p>
324 Private slot called by the backMenu aboutToShow signal.
325 </p>
326 <a NAME="ProjectSourcesBrowser.__showContextMenuCheck" ID="ProjectSourcesBrowser.__showContextMenuCheck"></a>
327 <h4>ProjectSourcesBrowser.__showContextMenuCheck</h4>
328 <b>__showContextMenuCheck</b>(<i></i>)
329
330 <p>
331 Private slot called before the checks menu is shown.
332 </p>
333 <a NAME="ProjectSourcesBrowser.__showContextMenuDir" ID="ProjectSourcesBrowser.__showContextMenuDir"></a>
334 <h4>ProjectSourcesBrowser.__showContextMenuDir</h4>
335 <b>__showContextMenuDir</b>(<i></i>)
336
337 <p>
338 Private slot called by the dirMenu aboutToShow signal.
339 </p>
340 <a NAME="ProjectSourcesBrowser.__showContextMenuDirMulti" ID="ProjectSourcesBrowser.__showContextMenuDirMulti"></a>
341 <h4>ProjectSourcesBrowser.__showContextMenuDirMulti</h4>
342 <b>__showContextMenuDirMulti</b>(<i></i>)
343
344 <p>
345 Private slot called by the dirMultiMenu aboutToShow signal.
346 </p>
347 <a NAME="ProjectSourcesBrowser.__showContextMenuGraphics" ID="ProjectSourcesBrowser.__showContextMenuGraphics"></a>
348 <h4>ProjectSourcesBrowser.__showContextMenuGraphics</h4>
349 <b>__showContextMenuGraphics</b>(<i></i>)
350
351 <p>
352 Private slot called before the checks menu is shown.
353 </p>
354 <a NAME="ProjectSourcesBrowser.__showContextMenuMulti" ID="ProjectSourcesBrowser.__showContextMenuMulti"></a>
355 <h4>ProjectSourcesBrowser.__showContextMenuMulti</h4>
356 <b>__showContextMenuMulti</b>(<i></i>)
357
358 <p>
359 Private slot called by the multiMenu aboutToShow signal.
360 </p>
361 <a NAME="ProjectSourcesBrowser.__showContextMenuShow" ID="ProjectSourcesBrowser.__showContextMenuShow"></a>
362 <h4>ProjectSourcesBrowser.__showContextMenuShow</h4>
363 <b>__showContextMenuShow</b>(<i></i>)
364
365 <p>
366 Private slot called before the show menu is shown.
367 </p>
368 <a NAME="ProjectSourcesBrowser.__showImportsDiagram" ID="ProjectSourcesBrowser.__showImportsDiagram"></a>
369 <h4>ProjectSourcesBrowser.__showImportsDiagram</h4>
370 <b>__showImportsDiagram</b>(<i></i>)
371
372 <p>
373 Private method to handle the imports diagram context menu action.
374 </p>
375 <a NAME="ProjectSourcesBrowser.__showPackageDiagram" ID="ProjectSourcesBrowser.__showPackageDiagram"></a>
376 <h4>ProjectSourcesBrowser.__showPackageDiagram</h4>
377 <b>__showPackageDiagram</b>(<i></i>)
378
379 <p>
380 Private method to handle the package diagram context menu action.
381 </p>
382 <a NAME="ProjectSourcesBrowser.__showProfileData" ID="ProjectSourcesBrowser.__showProfileData"></a>
383 <h4>ProjectSourcesBrowser.__showProfileData</h4>
384 <b>__showProfileData</b>(<i></i>)
385
386 <p>
387 Private method to handle the show profile data context menu action.
388 </p>
389 <a NAME="ProjectSourcesBrowser._contextMenuRequested" ID="ProjectSourcesBrowser._contextMenuRequested"></a>
390 <h4>ProjectSourcesBrowser._contextMenuRequested</h4>
391 <b>_contextMenuRequested</b>(<i>coord</i>)
392
393 <p>
394 Protected slot to show the context menu.
395 </p>
396 <dl>
397
398 <dt><i>coord</i></dt>
399 <dd>
400 the position of the mouse pointer (QPoint)
401 </dd>
402 </dl>
403 <a NAME="ProjectSourcesBrowser._createPopupMenus" ID="ProjectSourcesBrowser._createPopupMenus"></a>
404 <h4>ProjectSourcesBrowser._createPopupMenus</h4>
405 <b>_createPopupMenus</b>(<i></i>)
406
407 <p>
408 Protected overloaded method to generate the popup menu.
409 </p>
410 <a NAME="ProjectSourcesBrowser._openItem" ID="ProjectSourcesBrowser._openItem"></a>
411 <h4>ProjectSourcesBrowser._openItem</h4>
412 <b>_openItem</b>(<i></i>)
413
414 <p>
415 Protected slot to handle the open popup menu entry.
416 </p>
417 <a NAME="ProjectSourcesBrowser._projectClosed" ID="ProjectSourcesBrowser._projectClosed"></a>
418 <h4>ProjectSourcesBrowser._projectClosed</h4>
419 <b>_projectClosed</b>(<i></i>)
420
421 <p>
422 Protected slot to handle the projectClosed signal.
423 </p>
424 <div align="right"><a href="#top">Up</a></div>
425 <hr />
426 </body></html>

eric ide

mercurial