|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.Project.ProjectSourcesBrowser</title> |
|
6 <style> |
|
7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' |
|
8 </style> |
|
9 </head> |
|
10 <body><a NAME="top" ID="top"></a> |
|
11 <h1>eric5.Project.ProjectSourcesBrowser</h1> |
|
12 <p> |
|
13 Module implementing a class used to display the Sources part of the project. |
|
14 </p> |
|
15 <h3>Global Attributes</h3> |
|
16 <table> |
|
17 <tr><td>None</td></tr> |
|
18 </table> |
|
19 <h3>Classes</h3> |
|
20 <table> |
|
21 <tr> |
|
22 <td><a href="#ProjectSourcesBrowser">ProjectSourcesBrowser</a></td> |
|
23 <td>A class used to display the Sources part of the project.</td> |
|
24 </tr> |
|
25 </table> |
|
26 <h3>Functions</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <hr /><hr /> |
|
31 <a NAME="ProjectSourcesBrowser" ID="ProjectSourcesBrowser"></a> |
|
32 <h2>ProjectSourcesBrowser</h2> |
|
33 <p> |
|
34 A class used to display the Sources part of the project. |
|
35 </p><h4>Signals</h4> |
|
36 <dl> |
|
37 <dt>closeSourceWindow(string)</dt> |
|
38 <dd> |
|
39 emitted after a file has been removed/deleted |
|
40 from the project |
|
41 </dd><dt>showMenu(string, QMenu)</dt> |
|
42 <dd> |
|
43 emitted when a menu is about to be shown. The name |
|
44 of the menu and a reference to the menu are given. |
|
45 </dd> |
|
46 </dl> |
|
47 <h3>Derived from</h3> |
|
48 ProjectBaseBrowser |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 <table> |
|
55 <tr> |
|
56 <td><a href="#ProjectSourcesBrowser.__init__">ProjectSourcesBrowser</a></td> |
|
57 <td>Constructor</td> |
|
58 </tr><tr> |
|
59 <td><a href="#ProjectSourcesBrowser.__addNewPackage">__addNewPackage</a></td> |
|
60 <td>Private method to add a new package to the project.</td> |
|
61 </tr><tr> |
|
62 <td><a href="#ProjectSourcesBrowser.__addSourceDirectory">__addSourceDirectory</a></td> |
|
63 <td>Private method to add source files of a directory to the project.</td> |
|
64 </tr><tr> |
|
65 <td><a href="#ProjectSourcesBrowser.__addSourceFiles">__addSourceFiles</a></td> |
|
66 <td>Private method to add a source file to the project.</td> |
|
67 </tr><tr> |
|
68 <td><a href="#ProjectSourcesBrowser.__closeAllWindows">__closeAllWindows</a></td> |
|
69 <td>Private method to close all project related windows.</td> |
|
70 </tr><tr> |
|
71 <td><a href="#ProjectSourcesBrowser.__createPythonPopupMenus">__createPythonPopupMenus</a></td> |
|
72 <td>Privat method to generate the popup menus for a Python project.</td> |
|
73 </tr><tr> |
|
74 <td><a href="#ProjectSourcesBrowser.__createRubyPopupMenus">__createRubyPopupMenus</a></td> |
|
75 <td>Privat method to generate the popup menus for a Ruby project.</td> |
|
76 </tr><tr> |
|
77 <td><a href="#ProjectSourcesBrowser.__deleteFile">__deleteFile</a></td> |
|
78 <td>Private method to delete files from the project.</td> |
|
79 </tr><tr> |
|
80 <td><a href="#ProjectSourcesBrowser.__showApplicationDiagram">__showApplicationDiagram</a></td> |
|
81 <td>Private method to handle the application diagram context menu action.</td> |
|
82 </tr><tr> |
|
83 <td><a href="#ProjectSourcesBrowser.__showClassDiagram">__showClassDiagram</a></td> |
|
84 <td>Private method to handle the class diagram context menu action.</td> |
|
85 </tr><tr> |
|
86 <td><a href="#ProjectSourcesBrowser.__showCodeCoverage">__showCodeCoverage</a></td> |
|
87 <td>Private method to handle the code coverage context menu action.</td> |
|
88 </tr><tr> |
|
89 <td><a href="#ProjectSourcesBrowser.__showCodeMetrics">__showCodeMetrics</a></td> |
|
90 <td>Private method to handle the code metrics context menu action.</td> |
|
91 </tr><tr> |
|
92 <td><a href="#ProjectSourcesBrowser.__showContextMenu">__showContextMenu</a></td> |
|
93 <td>Private slot called by the sourceMenu aboutToShow signal.</td> |
|
94 </tr><tr> |
|
95 <td><a href="#ProjectSourcesBrowser.__showContextMenuBack">__showContextMenuBack</a></td> |
|
96 <td>Private slot called by the backMenu aboutToShow signal.</td> |
|
97 </tr><tr> |
|
98 <td><a href="#ProjectSourcesBrowser.__showContextMenuCheck">__showContextMenuCheck</a></td> |
|
99 <td>Private slot called before the checks menu is shown.</td> |
|
100 </tr><tr> |
|
101 <td><a href="#ProjectSourcesBrowser.__showContextMenuDir">__showContextMenuDir</a></td> |
|
102 <td>Private slot called by the dirMenu aboutToShow signal.</td> |
|
103 </tr><tr> |
|
104 <td><a href="#ProjectSourcesBrowser.__showContextMenuDirMulti">__showContextMenuDirMulti</a></td> |
|
105 <td>Private slot called by the dirMultiMenu aboutToShow signal.</td> |
|
106 </tr><tr> |
|
107 <td><a href="#ProjectSourcesBrowser.__showContextMenuGraphics">__showContextMenuGraphics</a></td> |
|
108 <td>Private slot called before the checks menu is shown.</td> |
|
109 </tr><tr> |
|
110 <td><a href="#ProjectSourcesBrowser.__showContextMenuMulti">__showContextMenuMulti</a></td> |
|
111 <td>Private slot called by the multiMenu aboutToShow signal.</td> |
|
112 </tr><tr> |
|
113 <td><a href="#ProjectSourcesBrowser.__showContextMenuShow">__showContextMenuShow</a></td> |
|
114 <td>Private slot called before the show menu is shown.</td> |
|
115 </tr><tr> |
|
116 <td><a href="#ProjectSourcesBrowser.__showImportsDiagram">__showImportsDiagram</a></td> |
|
117 <td>Private method to handle the imports diagram context menu action.</td> |
|
118 </tr><tr> |
|
119 <td><a href="#ProjectSourcesBrowser.__showPackageDiagram">__showPackageDiagram</a></td> |
|
120 <td>Private method to handle the package diagram context menu action.</td> |
|
121 </tr><tr> |
|
122 <td><a href="#ProjectSourcesBrowser.__showProfileData">__showProfileData</a></td> |
|
123 <td>Private method to handle the show profile data context menu action.</td> |
|
124 </tr><tr> |
|
125 <td><a href="#ProjectSourcesBrowser._contextMenuRequested">_contextMenuRequested</a></td> |
|
126 <td>Protected slot to show the context menu.</td> |
|
127 </tr><tr> |
|
128 <td><a href="#ProjectSourcesBrowser._createPopupMenus">_createPopupMenus</a></td> |
|
129 <td>Protected overloaded method to generate the popup menu.</td> |
|
130 </tr><tr> |
|
131 <td><a href="#ProjectSourcesBrowser._openItem">_openItem</a></td> |
|
132 <td>Protected slot to handle the open popup menu entry.</td> |
|
133 </tr><tr> |
|
134 <td><a href="#ProjectSourcesBrowser._projectClosed">_projectClosed</a></td> |
|
135 <td>Protected slot to handle the projectClosed signal.</td> |
|
136 </tr> |
|
137 </table> |
|
138 <a NAME="ProjectSourcesBrowser.__init__" ID="ProjectSourcesBrowser.__init__"></a> |
|
139 <h4>ProjectSourcesBrowser (Constructor)</h4> |
|
140 <b>ProjectSourcesBrowser</b>(<i>project, parent = None</i>) |
|
141 <p> |
|
142 Constructor |
|
143 </p><dl> |
|
144 <dt><i>project</i></dt> |
|
145 <dd> |
|
146 reference to the project object |
|
147 </dd><dt><i>parent</i></dt> |
|
148 <dd> |
|
149 parent widget of this browser (QWidget) |
|
150 </dd> |
|
151 </dl><a NAME="ProjectSourcesBrowser.__addNewPackage" ID="ProjectSourcesBrowser.__addNewPackage"></a> |
|
152 <h4>ProjectSourcesBrowser.__addNewPackage</h4> |
|
153 <b>__addNewPackage</b>(<i></i>) |
|
154 <p> |
|
155 Private method to add a new package to the project. |
|
156 </p><a NAME="ProjectSourcesBrowser.__addSourceDirectory" ID="ProjectSourcesBrowser.__addSourceDirectory"></a> |
|
157 <h4>ProjectSourcesBrowser.__addSourceDirectory</h4> |
|
158 <b>__addSourceDirectory</b>(<i></i>) |
|
159 <p> |
|
160 Private method to add source files of a directory to the project. |
|
161 </p><a NAME="ProjectSourcesBrowser.__addSourceFiles" ID="ProjectSourcesBrowser.__addSourceFiles"></a> |
|
162 <h4>ProjectSourcesBrowser.__addSourceFiles</h4> |
|
163 <b>__addSourceFiles</b>(<i></i>) |
|
164 <p> |
|
165 Private method to add a source file to the project. |
|
166 </p><a NAME="ProjectSourcesBrowser.__closeAllWindows" ID="ProjectSourcesBrowser.__closeAllWindows"></a> |
|
167 <h4>ProjectSourcesBrowser.__closeAllWindows</h4> |
|
168 <b>__closeAllWindows</b>(<i></i>) |
|
169 <p> |
|
170 Private method to close all project related windows. |
|
171 </p><a NAME="ProjectSourcesBrowser.__createPythonPopupMenus" ID="ProjectSourcesBrowser.__createPythonPopupMenus"></a> |
|
172 <h4>ProjectSourcesBrowser.__createPythonPopupMenus</h4> |
|
173 <b>__createPythonPopupMenus</b>(<i></i>) |
|
174 <p> |
|
175 Privat method to generate the popup menus for a Python project. |
|
176 </p><a NAME="ProjectSourcesBrowser.__createRubyPopupMenus" ID="ProjectSourcesBrowser.__createRubyPopupMenus"></a> |
|
177 <h4>ProjectSourcesBrowser.__createRubyPopupMenus</h4> |
|
178 <b>__createRubyPopupMenus</b>(<i></i>) |
|
179 <p> |
|
180 Privat method to generate the popup menus for a Ruby project. |
|
181 </p><a NAME="ProjectSourcesBrowser.__deleteFile" ID="ProjectSourcesBrowser.__deleteFile"></a> |
|
182 <h4>ProjectSourcesBrowser.__deleteFile</h4> |
|
183 <b>__deleteFile</b>(<i></i>) |
|
184 <p> |
|
185 Private method to delete files from the project. |
|
186 </p><a NAME="ProjectSourcesBrowser.__showApplicationDiagram" ID="ProjectSourcesBrowser.__showApplicationDiagram"></a> |
|
187 <h4>ProjectSourcesBrowser.__showApplicationDiagram</h4> |
|
188 <b>__showApplicationDiagram</b>(<i></i>) |
|
189 <p> |
|
190 Private method to handle the application diagram context menu action. |
|
191 </p><a NAME="ProjectSourcesBrowser.__showClassDiagram" ID="ProjectSourcesBrowser.__showClassDiagram"></a> |
|
192 <h4>ProjectSourcesBrowser.__showClassDiagram</h4> |
|
193 <b>__showClassDiagram</b>(<i></i>) |
|
194 <p> |
|
195 Private method to handle the class diagram context menu action. |
|
196 </p><a NAME="ProjectSourcesBrowser.__showCodeCoverage" ID="ProjectSourcesBrowser.__showCodeCoverage"></a> |
|
197 <h4>ProjectSourcesBrowser.__showCodeCoverage</h4> |
|
198 <b>__showCodeCoverage</b>(<i></i>) |
|
199 <p> |
|
200 Private method to handle the code coverage context menu action. |
|
201 </p><a NAME="ProjectSourcesBrowser.__showCodeMetrics" ID="ProjectSourcesBrowser.__showCodeMetrics"></a> |
|
202 <h4>ProjectSourcesBrowser.__showCodeMetrics</h4> |
|
203 <b>__showCodeMetrics</b>(<i></i>) |
|
204 <p> |
|
205 Private method to handle the code metrics context menu action. |
|
206 </p><a NAME="ProjectSourcesBrowser.__showContextMenu" ID="ProjectSourcesBrowser.__showContextMenu"></a> |
|
207 <h4>ProjectSourcesBrowser.__showContextMenu</h4> |
|
208 <b>__showContextMenu</b>(<i></i>) |
|
209 <p> |
|
210 Private slot called by the sourceMenu aboutToShow signal. |
|
211 </p><a NAME="ProjectSourcesBrowser.__showContextMenuBack" ID="ProjectSourcesBrowser.__showContextMenuBack"></a> |
|
212 <h4>ProjectSourcesBrowser.__showContextMenuBack</h4> |
|
213 <b>__showContextMenuBack</b>(<i></i>) |
|
214 <p> |
|
215 Private slot called by the backMenu aboutToShow signal. |
|
216 </p><a NAME="ProjectSourcesBrowser.__showContextMenuCheck" ID="ProjectSourcesBrowser.__showContextMenuCheck"></a> |
|
217 <h4>ProjectSourcesBrowser.__showContextMenuCheck</h4> |
|
218 <b>__showContextMenuCheck</b>(<i></i>) |
|
219 <p> |
|
220 Private slot called before the checks menu is shown. |
|
221 </p><a NAME="ProjectSourcesBrowser.__showContextMenuDir" ID="ProjectSourcesBrowser.__showContextMenuDir"></a> |
|
222 <h4>ProjectSourcesBrowser.__showContextMenuDir</h4> |
|
223 <b>__showContextMenuDir</b>(<i></i>) |
|
224 <p> |
|
225 Private slot called by the dirMenu aboutToShow signal. |
|
226 </p><a NAME="ProjectSourcesBrowser.__showContextMenuDirMulti" ID="ProjectSourcesBrowser.__showContextMenuDirMulti"></a> |
|
227 <h4>ProjectSourcesBrowser.__showContextMenuDirMulti</h4> |
|
228 <b>__showContextMenuDirMulti</b>(<i></i>) |
|
229 <p> |
|
230 Private slot called by the dirMultiMenu aboutToShow signal. |
|
231 </p><a NAME="ProjectSourcesBrowser.__showContextMenuGraphics" ID="ProjectSourcesBrowser.__showContextMenuGraphics"></a> |
|
232 <h4>ProjectSourcesBrowser.__showContextMenuGraphics</h4> |
|
233 <b>__showContextMenuGraphics</b>(<i></i>) |
|
234 <p> |
|
235 Private slot called before the checks menu is shown. |
|
236 </p><a NAME="ProjectSourcesBrowser.__showContextMenuMulti" ID="ProjectSourcesBrowser.__showContextMenuMulti"></a> |
|
237 <h4>ProjectSourcesBrowser.__showContextMenuMulti</h4> |
|
238 <b>__showContextMenuMulti</b>(<i></i>) |
|
239 <p> |
|
240 Private slot called by the multiMenu aboutToShow signal. |
|
241 </p><a NAME="ProjectSourcesBrowser.__showContextMenuShow" ID="ProjectSourcesBrowser.__showContextMenuShow"></a> |
|
242 <h4>ProjectSourcesBrowser.__showContextMenuShow</h4> |
|
243 <b>__showContextMenuShow</b>(<i></i>) |
|
244 <p> |
|
245 Private slot called before the show menu is shown. |
|
246 </p><a NAME="ProjectSourcesBrowser.__showImportsDiagram" ID="ProjectSourcesBrowser.__showImportsDiagram"></a> |
|
247 <h4>ProjectSourcesBrowser.__showImportsDiagram</h4> |
|
248 <b>__showImportsDiagram</b>(<i></i>) |
|
249 <p> |
|
250 Private method to handle the imports diagram context menu action. |
|
251 </p><a NAME="ProjectSourcesBrowser.__showPackageDiagram" ID="ProjectSourcesBrowser.__showPackageDiagram"></a> |
|
252 <h4>ProjectSourcesBrowser.__showPackageDiagram</h4> |
|
253 <b>__showPackageDiagram</b>(<i></i>) |
|
254 <p> |
|
255 Private method to handle the package diagram context menu action. |
|
256 </p><a NAME="ProjectSourcesBrowser.__showProfileData" ID="ProjectSourcesBrowser.__showProfileData"></a> |
|
257 <h4>ProjectSourcesBrowser.__showProfileData</h4> |
|
258 <b>__showProfileData</b>(<i></i>) |
|
259 <p> |
|
260 Private method to handle the show profile data context menu action. |
|
261 </p><a NAME="ProjectSourcesBrowser._contextMenuRequested" ID="ProjectSourcesBrowser._contextMenuRequested"></a> |
|
262 <h4>ProjectSourcesBrowser._contextMenuRequested</h4> |
|
263 <b>_contextMenuRequested</b>(<i>coord</i>) |
|
264 <p> |
|
265 Protected slot to show the context menu. |
|
266 </p><dl> |
|
267 <dt><i>coord</i></dt> |
|
268 <dd> |
|
269 the position of the mouse pointer (QPoint) |
|
270 </dd> |
|
271 </dl><a NAME="ProjectSourcesBrowser._createPopupMenus" ID="ProjectSourcesBrowser._createPopupMenus"></a> |
|
272 <h4>ProjectSourcesBrowser._createPopupMenus</h4> |
|
273 <b>_createPopupMenus</b>(<i></i>) |
|
274 <p> |
|
275 Protected overloaded method to generate the popup menu. |
|
276 </p><a NAME="ProjectSourcesBrowser._openItem" ID="ProjectSourcesBrowser._openItem"></a> |
|
277 <h4>ProjectSourcesBrowser._openItem</h4> |
|
278 <b>_openItem</b>(<i></i>) |
|
279 <p> |
|
280 Protected slot to handle the open popup menu entry. |
|
281 </p><a NAME="ProjectSourcesBrowser._projectClosed" ID="ProjectSourcesBrowser._projectClosed"></a> |
|
282 <h4>ProjectSourcesBrowser._projectClosed</h4> |
|
283 <b>_projectClosed</b>(<i></i>) |
|
284 <p> |
|
285 Protected slot to handle the projectClosed signal. |
|
286 </p> |
|
287 <div align="right"><a href="#top">Up</a></div> |
|
288 <hr /> |
|
289 </body></html> |