|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.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><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Project.ProjectSourcesBrowser</h1> |
|
23 <p> |
|
24 Module implementing a class used to display the Sources part of the project. |
|
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="#ProjectSourcesBrowser">ProjectSourcesBrowser</a></td> |
|
34 <td>A class used to display the Sources part of the project.</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="ProjectSourcesBrowser" ID="ProjectSourcesBrowser"></a> |
|
43 <h2>ProjectSourcesBrowser</h2> |
|
44 <p> |
|
45 A class used to display the Sources part of the project. |
|
46 </p><h3>Signals</h3> |
|
47 <dl> |
|
48 <dt>showMenu(str, QMenu)</dt> |
|
49 <dd> |
|
50 emitted when a menu is about to be shown. |
|
51 The name of the menu and a reference to the menu are given. |
|
52 </dd> |
|
53 </dl> |
|
54 <h3>Derived from</h3> |
|
55 ProjectBaseBrowser |
|
56 <h3>Class Attributes</h3> |
|
57 <table> |
|
58 <tr><td>None</td></tr> |
|
59 </table> |
|
60 <h3>Class Methods</h3> |
|
61 <table> |
|
62 <tr><td>None</td></tr> |
|
63 </table> |
|
64 <h3>Methods</h3> |
|
65 <table> |
|
66 <tr> |
|
67 <td><a href="#ProjectSourcesBrowser.__init__">ProjectSourcesBrowser</a></td> |
|
68 <td>Constructor</td> |
|
69 </tr><tr> |
|
70 <td><a href="#ProjectSourcesBrowser.__addNewPackage">__addNewPackage</a></td> |
|
71 <td>Private method to add a new package to the project.</td> |
|
72 </tr><tr> |
|
73 <td><a href="#ProjectSourcesBrowser.__addSourceDirectory">__addSourceDirectory</a></td> |
|
74 <td>Private method to add source files of a directory to the project.</td> |
|
75 </tr><tr> |
|
76 <td><a href="#ProjectSourcesBrowser.__addSourceFiles">__addSourceFiles</a></td> |
|
77 <td>Private method to add a source file to the project.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#ProjectSourcesBrowser.__closeAllWindows">__closeAllWindows</a></td> |
|
80 <td>Private method to close all project related windows.</td> |
|
81 </tr><tr> |
|
82 <td><a href="#ProjectSourcesBrowser.__createJavaScriptPopupMenus">__createJavaScriptPopupMenus</a></td> |
|
83 <td>Private method to generate the popup menus for a Python project.</td> |
|
84 </tr><tr> |
|
85 <td><a href="#ProjectSourcesBrowser.__createPythonPopupMenus">__createPythonPopupMenus</a></td> |
|
86 <td>Private method to generate the popup menus for a Python project.</td> |
|
87 </tr><tr> |
|
88 <td><a href="#ProjectSourcesBrowser.__createRubyPopupMenus">__createRubyPopupMenus</a></td> |
|
89 <td>Private method to generate the popup menus for a Ruby project.</td> |
|
90 </tr><tr> |
|
91 <td><a href="#ProjectSourcesBrowser.__deleteFile">__deleteFile</a></td> |
|
92 <td>Private method to delete files from the project.</td> |
|
93 </tr><tr> |
|
94 <td><a href="#ProjectSourcesBrowser.__loadDiagram">__loadDiagram</a></td> |
|
95 <td>Private slot to load a diagram from file.</td> |
|
96 </tr><tr> |
|
97 <td><a href="#ProjectSourcesBrowser.__showApplicationDiagram">__showApplicationDiagram</a></td> |
|
98 <td>Private method to handle the application diagram context menu action.</td> |
|
99 </tr><tr> |
|
100 <td><a href="#ProjectSourcesBrowser.__showClassDiagram">__showClassDiagram</a></td> |
|
101 <td>Private method to handle the class diagram context menu action.</td> |
|
102 </tr><tr> |
|
103 <td><a href="#ProjectSourcesBrowser.__showCodeCoverage">__showCodeCoverage</a></td> |
|
104 <td>Private method to handle the code coverage context menu action.</td> |
|
105 </tr><tr> |
|
106 <td><a href="#ProjectSourcesBrowser.__showCodeMetrics">__showCodeMetrics</a></td> |
|
107 <td>Private method to handle the code metrics context menu action.</td> |
|
108 </tr><tr> |
|
109 <td><a href="#ProjectSourcesBrowser.__showContextMenu">__showContextMenu</a></td> |
|
110 <td>Private slot called by the sourceMenu aboutToShow signal.</td> |
|
111 </tr><tr> |
|
112 <td><a href="#ProjectSourcesBrowser.__showContextMenuBack">__showContextMenuBack</a></td> |
|
113 <td>Private slot called by the backMenu aboutToShow signal.</td> |
|
114 </tr><tr> |
|
115 <td><a href="#ProjectSourcesBrowser.__showContextMenuCheck">__showContextMenuCheck</a></td> |
|
116 <td>Private slot called before the checks menu is shown.</td> |
|
117 </tr><tr> |
|
118 <td><a href="#ProjectSourcesBrowser.__showContextMenuDir">__showContextMenuDir</a></td> |
|
119 <td>Private slot called by the dirMenu aboutToShow signal.</td> |
|
120 </tr><tr> |
|
121 <td><a href="#ProjectSourcesBrowser.__showContextMenuDirMulti">__showContextMenuDirMulti</a></td> |
|
122 <td>Private slot called by the dirMultiMenu aboutToShow signal.</td> |
|
123 </tr><tr> |
|
124 <td><a href="#ProjectSourcesBrowser.__showContextMenuGraphics">__showContextMenuGraphics</a></td> |
|
125 <td>Private slot called before the checks menu is shown.</td> |
|
126 </tr><tr> |
|
127 <td><a href="#ProjectSourcesBrowser.__showContextMenuMulti">__showContextMenuMulti</a></td> |
|
128 <td>Private slot called by the multiMenu aboutToShow signal.</td> |
|
129 </tr><tr> |
|
130 <td><a href="#ProjectSourcesBrowser.__showContextMenuShow">__showContextMenuShow</a></td> |
|
131 <td>Private slot called before the show menu is shown.</td> |
|
132 </tr><tr> |
|
133 <td><a href="#ProjectSourcesBrowser.__showImportsDiagram">__showImportsDiagram</a></td> |
|
134 <td>Private method to handle the imports diagram context menu action.</td> |
|
135 </tr><tr> |
|
136 <td><a href="#ProjectSourcesBrowser.__showPackageDiagram">__showPackageDiagram</a></td> |
|
137 <td>Private method to handle the package diagram context menu action.</td> |
|
138 </tr><tr> |
|
139 <td><a href="#ProjectSourcesBrowser.__showProfileData">__showProfileData</a></td> |
|
140 <td>Private method to handle the show profile data context menu action.</td> |
|
141 </tr><tr> |
|
142 <td><a href="#ProjectSourcesBrowser._contextMenuRequested">_contextMenuRequested</a></td> |
|
143 <td>Protected slot to show the context menu.</td> |
|
144 </tr><tr> |
|
145 <td><a href="#ProjectSourcesBrowser._createPopupMenus">_createPopupMenus</a></td> |
|
146 <td>Protected overloaded method to generate the popup menu.</td> |
|
147 </tr><tr> |
|
148 <td><a href="#ProjectSourcesBrowser._openItem">_openItem</a></td> |
|
149 <td>Protected slot to handle the open popup menu entry.</td> |
|
150 </tr><tr> |
|
151 <td><a href="#ProjectSourcesBrowser._projectClosed">_projectClosed</a></td> |
|
152 <td>Protected slot to handle the projectClosed signal.</td> |
|
153 </tr> |
|
154 </table> |
|
155 <h3>Static Methods</h3> |
|
156 <table> |
|
157 <tr><td>None</td></tr> |
|
158 </table> |
|
159 <a NAME="ProjectSourcesBrowser.__init__" ID="ProjectSourcesBrowser.__init__"></a> |
|
160 <h4>ProjectSourcesBrowser (Constructor)</h4> |
|
161 <b>ProjectSourcesBrowser</b>(<i>project, parent=None</i>) |
|
162 <p> |
|
163 Constructor |
|
164 </p><dl> |
|
165 <dt><i>project</i></dt> |
|
166 <dd> |
|
167 reference to the project object |
|
168 </dd><dt><i>parent</i></dt> |
|
169 <dd> |
|
170 parent widget of this browser (QWidget) |
|
171 </dd> |
|
172 </dl><a NAME="ProjectSourcesBrowser.__addNewPackage" ID="ProjectSourcesBrowser.__addNewPackage"></a> |
|
173 <h4>ProjectSourcesBrowser.__addNewPackage</h4> |
|
174 <b>__addNewPackage</b>(<i></i>) |
|
175 <p> |
|
176 Private method to add a new package to the project. |
|
177 </p><a NAME="ProjectSourcesBrowser.__addSourceDirectory" ID="ProjectSourcesBrowser.__addSourceDirectory"></a> |
|
178 <h4>ProjectSourcesBrowser.__addSourceDirectory</h4> |
|
179 <b>__addSourceDirectory</b>(<i></i>) |
|
180 <p> |
|
181 Private method to add source files of a directory to the project. |
|
182 </p><a NAME="ProjectSourcesBrowser.__addSourceFiles" ID="ProjectSourcesBrowser.__addSourceFiles"></a> |
|
183 <h4>ProjectSourcesBrowser.__addSourceFiles</h4> |
|
184 <b>__addSourceFiles</b>(<i></i>) |
|
185 <p> |
|
186 Private method to add a source file to the project. |
|
187 </p><a NAME="ProjectSourcesBrowser.__closeAllWindows" ID="ProjectSourcesBrowser.__closeAllWindows"></a> |
|
188 <h4>ProjectSourcesBrowser.__closeAllWindows</h4> |
|
189 <b>__closeAllWindows</b>(<i></i>) |
|
190 <p> |
|
191 Private method to close all project related windows. |
|
192 </p><a NAME="ProjectSourcesBrowser.__createJavaScriptPopupMenus" ID="ProjectSourcesBrowser.__createJavaScriptPopupMenus"></a> |
|
193 <h4>ProjectSourcesBrowser.__createJavaScriptPopupMenus</h4> |
|
194 <b>__createJavaScriptPopupMenus</b>(<i></i>) |
|
195 <p> |
|
196 Private method to generate the popup menus for a Python project. |
|
197 </p><a NAME="ProjectSourcesBrowser.__createPythonPopupMenus" ID="ProjectSourcesBrowser.__createPythonPopupMenus"></a> |
|
198 <h4>ProjectSourcesBrowser.__createPythonPopupMenus</h4> |
|
199 <b>__createPythonPopupMenus</b>(<i></i>) |
|
200 <p> |
|
201 Private method to generate the popup menus for a Python project. |
|
202 </p><a NAME="ProjectSourcesBrowser.__createRubyPopupMenus" ID="ProjectSourcesBrowser.__createRubyPopupMenus"></a> |
|
203 <h4>ProjectSourcesBrowser.__createRubyPopupMenus</h4> |
|
204 <b>__createRubyPopupMenus</b>(<i></i>) |
|
205 <p> |
|
206 Private method to generate the popup menus for a Ruby project. |
|
207 </p><a NAME="ProjectSourcesBrowser.__deleteFile" ID="ProjectSourcesBrowser.__deleteFile"></a> |
|
208 <h4>ProjectSourcesBrowser.__deleteFile</h4> |
|
209 <b>__deleteFile</b>(<i></i>) |
|
210 <p> |
|
211 Private method to delete files from the project. |
|
212 </p><a NAME="ProjectSourcesBrowser.__loadDiagram" ID="ProjectSourcesBrowser.__loadDiagram"></a> |
|
213 <h4>ProjectSourcesBrowser.__loadDiagram</h4> |
|
214 <b>__loadDiagram</b>(<i></i>) |
|
215 <p> |
|
216 Private slot to load a diagram from file. |
|
217 </p><a NAME="ProjectSourcesBrowser.__showApplicationDiagram" ID="ProjectSourcesBrowser.__showApplicationDiagram"></a> |
|
218 <h4>ProjectSourcesBrowser.__showApplicationDiagram</h4> |
|
219 <b>__showApplicationDiagram</b>(<i></i>) |
|
220 <p> |
|
221 Private method to handle the application diagram context menu action. |
|
222 </p><a NAME="ProjectSourcesBrowser.__showClassDiagram" ID="ProjectSourcesBrowser.__showClassDiagram"></a> |
|
223 <h4>ProjectSourcesBrowser.__showClassDiagram</h4> |
|
224 <b>__showClassDiagram</b>(<i></i>) |
|
225 <p> |
|
226 Private method to handle the class diagram context menu action. |
|
227 </p><a NAME="ProjectSourcesBrowser.__showCodeCoverage" ID="ProjectSourcesBrowser.__showCodeCoverage"></a> |
|
228 <h4>ProjectSourcesBrowser.__showCodeCoverage</h4> |
|
229 <b>__showCodeCoverage</b>(<i></i>) |
|
230 <p> |
|
231 Private method to handle the code coverage context menu action. |
|
232 </p><a NAME="ProjectSourcesBrowser.__showCodeMetrics" ID="ProjectSourcesBrowser.__showCodeMetrics"></a> |
|
233 <h4>ProjectSourcesBrowser.__showCodeMetrics</h4> |
|
234 <b>__showCodeMetrics</b>(<i></i>) |
|
235 <p> |
|
236 Private method to handle the code metrics context menu action. |
|
237 </p><a NAME="ProjectSourcesBrowser.__showContextMenu" ID="ProjectSourcesBrowser.__showContextMenu"></a> |
|
238 <h4>ProjectSourcesBrowser.__showContextMenu</h4> |
|
239 <b>__showContextMenu</b>(<i></i>) |
|
240 <p> |
|
241 Private slot called by the sourceMenu aboutToShow signal. |
|
242 </p><a NAME="ProjectSourcesBrowser.__showContextMenuBack" ID="ProjectSourcesBrowser.__showContextMenuBack"></a> |
|
243 <h4>ProjectSourcesBrowser.__showContextMenuBack</h4> |
|
244 <b>__showContextMenuBack</b>(<i></i>) |
|
245 <p> |
|
246 Private slot called by the backMenu aboutToShow signal. |
|
247 </p><a NAME="ProjectSourcesBrowser.__showContextMenuCheck" ID="ProjectSourcesBrowser.__showContextMenuCheck"></a> |
|
248 <h4>ProjectSourcesBrowser.__showContextMenuCheck</h4> |
|
249 <b>__showContextMenuCheck</b>(<i></i>) |
|
250 <p> |
|
251 Private slot called before the checks menu is shown. |
|
252 </p><a NAME="ProjectSourcesBrowser.__showContextMenuDir" ID="ProjectSourcesBrowser.__showContextMenuDir"></a> |
|
253 <h4>ProjectSourcesBrowser.__showContextMenuDir</h4> |
|
254 <b>__showContextMenuDir</b>(<i></i>) |
|
255 <p> |
|
256 Private slot called by the dirMenu aboutToShow signal. |
|
257 </p><a NAME="ProjectSourcesBrowser.__showContextMenuDirMulti" ID="ProjectSourcesBrowser.__showContextMenuDirMulti"></a> |
|
258 <h4>ProjectSourcesBrowser.__showContextMenuDirMulti</h4> |
|
259 <b>__showContextMenuDirMulti</b>(<i></i>) |
|
260 <p> |
|
261 Private slot called by the dirMultiMenu aboutToShow signal. |
|
262 </p><a NAME="ProjectSourcesBrowser.__showContextMenuGraphics" ID="ProjectSourcesBrowser.__showContextMenuGraphics"></a> |
|
263 <h4>ProjectSourcesBrowser.__showContextMenuGraphics</h4> |
|
264 <b>__showContextMenuGraphics</b>(<i></i>) |
|
265 <p> |
|
266 Private slot called before the checks menu is shown. |
|
267 </p><a NAME="ProjectSourcesBrowser.__showContextMenuMulti" ID="ProjectSourcesBrowser.__showContextMenuMulti"></a> |
|
268 <h4>ProjectSourcesBrowser.__showContextMenuMulti</h4> |
|
269 <b>__showContextMenuMulti</b>(<i></i>) |
|
270 <p> |
|
271 Private slot called by the multiMenu aboutToShow signal. |
|
272 </p><a NAME="ProjectSourcesBrowser.__showContextMenuShow" ID="ProjectSourcesBrowser.__showContextMenuShow"></a> |
|
273 <h4>ProjectSourcesBrowser.__showContextMenuShow</h4> |
|
274 <b>__showContextMenuShow</b>(<i></i>) |
|
275 <p> |
|
276 Private slot called before the show menu is shown. |
|
277 </p><a NAME="ProjectSourcesBrowser.__showImportsDiagram" ID="ProjectSourcesBrowser.__showImportsDiagram"></a> |
|
278 <h4>ProjectSourcesBrowser.__showImportsDiagram</h4> |
|
279 <b>__showImportsDiagram</b>(<i></i>) |
|
280 <p> |
|
281 Private method to handle the imports diagram context menu action. |
|
282 </p><a NAME="ProjectSourcesBrowser.__showPackageDiagram" ID="ProjectSourcesBrowser.__showPackageDiagram"></a> |
|
283 <h4>ProjectSourcesBrowser.__showPackageDiagram</h4> |
|
284 <b>__showPackageDiagram</b>(<i></i>) |
|
285 <p> |
|
286 Private method to handle the package diagram context menu action. |
|
287 </p><a NAME="ProjectSourcesBrowser.__showProfileData" ID="ProjectSourcesBrowser.__showProfileData"></a> |
|
288 <h4>ProjectSourcesBrowser.__showProfileData</h4> |
|
289 <b>__showProfileData</b>(<i></i>) |
|
290 <p> |
|
291 Private method to handle the show profile data context menu action. |
|
292 </p><a NAME="ProjectSourcesBrowser._contextMenuRequested" ID="ProjectSourcesBrowser._contextMenuRequested"></a> |
|
293 <h4>ProjectSourcesBrowser._contextMenuRequested</h4> |
|
294 <b>_contextMenuRequested</b>(<i>coord</i>) |
|
295 <p> |
|
296 Protected slot to show the context menu. |
|
297 </p><dl> |
|
298 <dt><i>coord</i></dt> |
|
299 <dd> |
|
300 the position of the mouse pointer (QPoint) |
|
301 </dd> |
|
302 </dl><a NAME="ProjectSourcesBrowser._createPopupMenus" ID="ProjectSourcesBrowser._createPopupMenus"></a> |
|
303 <h4>ProjectSourcesBrowser._createPopupMenus</h4> |
|
304 <b>_createPopupMenus</b>(<i></i>) |
|
305 <p> |
|
306 Protected overloaded method to generate the popup menu. |
|
307 </p><a NAME="ProjectSourcesBrowser._openItem" ID="ProjectSourcesBrowser._openItem"></a> |
|
308 <h4>ProjectSourcesBrowser._openItem</h4> |
|
309 <b>_openItem</b>(<i></i>) |
|
310 <p> |
|
311 Protected slot to handle the open popup menu entry. |
|
312 </p><a NAME="ProjectSourcesBrowser._projectClosed" ID="ProjectSourcesBrowser._projectClosed"></a> |
|
313 <h4>ProjectSourcesBrowser._projectClosed</h4> |
|
314 <b>_projectClosed</b>(<i></i>) |
|
315 <p> |
|
316 Protected slot to handle the projectClosed signal. |
|
317 </p> |
|
318 <div align="right"><a href="#top">Up</a></div> |
|
319 <hr /> |
|
320 </body></html> |