Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Project.ProjectSourcesBrowser.html

Documentation/Source/eric4.Project.ProjectSourcesBrowser.html

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

Mercurial Repository: eric

eric ide

mercurial