src/eric7/Documentation/Source/eric7.Project.ProjectInterfacesBrowser.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9530
c30f02ea1b27
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.ProjectInterfacesBrowser</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Project.ProjectInterfacesBrowser</h1>
10
11 <p>
12 Module implementing the a class used to display the interfaces (IDL) part
13 of the project.
14 </p>
15 <h3>Global Attributes</h3>
16
17 <table>
18 <tr><td>None</td></tr>
19 </table>
20 <h3>Classes</h3>
21
22 <table>
23
24 <tr>
25 <td><a href="#ProjectInterfacesBrowser">ProjectInterfacesBrowser</a></td>
26 <td>A class used to display the interfaces (IDL) part of the project.</td>
27 </tr>
28 </table>
29 <h3>Functions</h3>
30
31 <table>
32 <tr><td>None</td></tr>
33 </table>
34 <hr />
35 <hr />
36 <a NAME="ProjectInterfacesBrowser" ID="ProjectInterfacesBrowser"></a>
37 <h2>ProjectInterfacesBrowser</h2>
38
39 <p>
40 A class used to display the interfaces (IDL) part of the project.
41 </p>
42 <h3>Signals</h3>
43 <dl>
44
45 <dt>appendStderr(str)</dt>
46 <dd>
47 emitted after something was received from
48 a QProcess on stderr
49 </dd>
50 <dt>appendStdout(str)</dt>
51 <dd>
52 emitted after something was received from
53 a QProcess on stdout
54 </dd>
55 <dt>showMenu(str, QMenu)</dt>
56 <dd>
57 emitted when a menu is about to be shown.
58 The name of the menu and a reference to the menu are given.
59 </dd>
60 </dl>
61 <h3>Derived from</h3>
62 ProjectBaseBrowser
63 <h3>Class Attributes</h3>
64
65 <table>
66 <tr><td>None</td></tr>
67 </table>
68 <h3>Class Methods</h3>
69
70 <table>
71 <tr><td>None</td></tr>
72 </table>
73 <h3>Methods</h3>
74
75 <table>
76
77 <tr>
78 <td><a href="#ProjectInterfacesBrowser.__init__">ProjectInterfacesBrowser</a></td>
79 <td>Constructor</td>
80 </tr>
81 <tr>
82 <td><a href="#ProjectInterfacesBrowser.__addInterfaceFiles">__addInterfaceFiles</a></td>
83 <td>Private method to add interface files to the project.</td>
84 </tr>
85 <tr>
86 <td><a href="#ProjectInterfacesBrowser.__addInterfacesDirectory">__addInterfacesDirectory</a></td>
87 <td>Private method to add interface files of a directory to the project.</td>
88 </tr>
89 <tr>
90 <td><a href="#ProjectInterfacesBrowser.__compileAllInterfaces">__compileAllInterfaces</a></td>
91 <td>Private method to compile all interfaces to python.</td>
92 </tr>
93 <tr>
94 <td><a href="#ProjectInterfacesBrowser.__compileIDL">__compileIDL</a></td>
95 <td>Private method to compile a .idl file to python.</td>
96 </tr>
97 <tr>
98 <td><a href="#ProjectInterfacesBrowser.__compileIDLDone">__compileIDLDone</a></td>
99 <td>Private slot to handle the finished signal of the omniidl process.</td>
100 </tr>
101 <tr>
102 <td><a href="#ProjectInterfacesBrowser.__compileInterface">__compileInterface</a></td>
103 <td>Private method to compile an interface to python.</td>
104 </tr>
105 <tr>
106 <td><a href="#ProjectInterfacesBrowser.__compileSelectedInterfaces">__compileSelectedInterfaces</a></td>
107 <td>Private method to compile selected interfaces to python.</td>
108 </tr>
109 <tr>
110 <td><a href="#ProjectInterfacesBrowser.__configureCorba">__configureCorba</a></td>
111 <td>Private method to open the configuration dialog.</td>
112 </tr>
113 <tr>
114 <td><a href="#ProjectInterfacesBrowser.__configureIdlCompiler">__configureIdlCompiler</a></td>
115 <td>Private method to show a dialog to configure some options for the IDL compiler.</td>
116 </tr>
117 <tr>
118 <td><a href="#ProjectInterfacesBrowser.__deleteFile">__deleteFile</a></td>
119 <td>Private method to delete files from the project.</td>
120 </tr>
121 <tr>
122 <td><a href="#ProjectInterfacesBrowser.__readStderr">__readStderr</a></td>
123 <td>Private slot to handle the readyReadStandardError signal of the omniidl process.</td>
124 </tr>
125 <tr>
126 <td><a href="#ProjectInterfacesBrowser.__readStdout">__readStdout</a></td>
127 <td>Private slot to handle the readyReadStandardOutput signal of the omniidl process.</td>
128 </tr>
129 <tr>
130 <td><a href="#ProjectInterfacesBrowser.__showContextMenu">__showContextMenu</a></td>
131 <td>Private slot called by the menu aboutToShow signal.</td>
132 </tr>
133 <tr>
134 <td><a href="#ProjectInterfacesBrowser.__showContextMenuBack">__showContextMenuBack</a></td>
135 <td>Private slot called by the backMenu aboutToShow signal.</td>
136 </tr>
137 <tr>
138 <td><a href="#ProjectInterfacesBrowser.__showContextMenuDir">__showContextMenuDir</a></td>
139 <td>Private slot called by the dirMenu aboutToShow signal.</td>
140 </tr>
141 <tr>
142 <td><a href="#ProjectInterfacesBrowser.__showContextMenuDirMulti">__showContextMenuDirMulti</a></td>
143 <td>Private slot called by the dirMultiMenu aboutToShow signal.</td>
144 </tr>
145 <tr>
146 <td><a href="#ProjectInterfacesBrowser.__showContextMenuMulti">__showContextMenuMulti</a></td>
147 <td>Private slot called by the multiMenu aboutToShow signal.</td>
148 </tr>
149 <tr>
150 <td><a href="#ProjectInterfacesBrowser._contextMenuRequested">_contextMenuRequested</a></td>
151 <td>Protected slot to show the context menu.</td>
152 </tr>
153 <tr>
154 <td><a href="#ProjectInterfacesBrowser._createPopupMenus">_createPopupMenus</a></td>
155 <td>Protected overloaded method to generate the popup menu.</td>
156 </tr>
157 <tr>
158 <td><a href="#ProjectInterfacesBrowser._openItem">_openItem</a></td>
159 <td>Protected slot to handle the open popup menu entry.</td>
160 </tr>
161 </table>
162 <h3>Static Methods</h3>
163
164 <table>
165 <tr><td>None</td></tr>
166 </table>
167
168 <a NAME="ProjectInterfacesBrowser.__init__" ID="ProjectInterfacesBrowser.__init__"></a>
169 <h4>ProjectInterfacesBrowser (Constructor)</h4>
170 <b>ProjectInterfacesBrowser</b>(<i>project, parent=None</i>)
171
172 <p>
173 Constructor
174 </p>
175 <dl>
176
177 <dt><i>project</i></dt>
178 <dd>
179 reference to the project object
180 </dd>
181 <dt><i>parent</i></dt>
182 <dd>
183 parent widget of this browser (QWidget)
184 </dd>
185 </dl>
186 <a NAME="ProjectInterfacesBrowser.__addInterfaceFiles" ID="ProjectInterfacesBrowser.__addInterfaceFiles"></a>
187 <h4>ProjectInterfacesBrowser.__addInterfaceFiles</h4>
188 <b>__addInterfaceFiles</b>(<i></i>)
189
190 <p>
191 Private method to add interface files to the project.
192 </p>
193 <a NAME="ProjectInterfacesBrowser.__addInterfacesDirectory" ID="ProjectInterfacesBrowser.__addInterfacesDirectory"></a>
194 <h4>ProjectInterfacesBrowser.__addInterfacesDirectory</h4>
195 <b>__addInterfacesDirectory</b>(<i></i>)
196
197 <p>
198 Private method to add interface files of a directory to the project.
199 </p>
200 <a NAME="ProjectInterfacesBrowser.__compileAllInterfaces" ID="ProjectInterfacesBrowser.__compileAllInterfaces"></a>
201 <h4>ProjectInterfacesBrowser.__compileAllInterfaces</h4>
202 <b>__compileAllInterfaces</b>(<i></i>)
203
204 <p>
205 Private method to compile all interfaces to python.
206 </p>
207 <a NAME="ProjectInterfacesBrowser.__compileIDL" ID="ProjectInterfacesBrowser.__compileIDL"></a>
208 <h4>ProjectInterfacesBrowser.__compileIDL</h4>
209 <b>__compileIDL</b>(<i>fn, noDialog=False, progress=None</i>)
210
211 <p>
212 Private method to compile a .idl file to python.
213 </p>
214 <dl>
215
216 <dt><i>fn</i></dt>
217 <dd>
218 filename of the .idl file to be compiled (string)
219 </dd>
220 <dt><i>noDialog</i></dt>
221 <dd>
222 flag indicating silent operations (boolean)
223 </dd>
224 <dt><i>progress</i></dt>
225 <dd>
226 reference to the progress dialog (EricProgressDialog)
227 </dd>
228 </dl>
229 <dl>
230 <dt>Return:</dt>
231 <dd>
232 reference to the compile process (QProcess)
233 </dd>
234 </dl>
235 <a NAME="ProjectInterfacesBrowser.__compileIDLDone" ID="ProjectInterfacesBrowser.__compileIDLDone"></a>
236 <h4>ProjectInterfacesBrowser.__compileIDLDone</h4>
237 <b>__compileIDLDone</b>(<i>exitCode, exitStatus</i>)
238
239 <p>
240 Private slot to handle the finished signal of the omniidl process.
241 </p>
242 <dl>
243
244 <dt><i>exitCode</i></dt>
245 <dd>
246 exit code of the process (integer)
247 </dd>
248 <dt><i>exitStatus</i></dt>
249 <dd>
250 exit status of the process (QProcess.ExitStatus)
251 </dd>
252 </dl>
253 <a NAME="ProjectInterfacesBrowser.__compileInterface" ID="ProjectInterfacesBrowser.__compileInterface"></a>
254 <h4>ProjectInterfacesBrowser.__compileInterface</h4>
255 <b>__compileInterface</b>(<i></i>)
256
257 <p>
258 Private method to compile an interface to python.
259 </p>
260 <a NAME="ProjectInterfacesBrowser.__compileSelectedInterfaces" ID="ProjectInterfacesBrowser.__compileSelectedInterfaces"></a>
261 <h4>ProjectInterfacesBrowser.__compileSelectedInterfaces</h4>
262 <b>__compileSelectedInterfaces</b>(<i></i>)
263
264 <p>
265 Private method to compile selected interfaces to python.
266 </p>
267 <a NAME="ProjectInterfacesBrowser.__configureCorba" ID="ProjectInterfacesBrowser.__configureCorba"></a>
268 <h4>ProjectInterfacesBrowser.__configureCorba</h4>
269 <b>__configureCorba</b>(<i></i>)
270
271 <p>
272 Private method to open the configuration dialog.
273 </p>
274 <a NAME="ProjectInterfacesBrowser.__configureIdlCompiler" ID="ProjectInterfacesBrowser.__configureIdlCompiler"></a>
275 <h4>ProjectInterfacesBrowser.__configureIdlCompiler</h4>
276 <b>__configureIdlCompiler</b>(<i></i>)
277
278 <p>
279 Private method to show a dialog to configure some options for the
280 IDL compiler.
281 </p>
282 <a NAME="ProjectInterfacesBrowser.__deleteFile" ID="ProjectInterfacesBrowser.__deleteFile"></a>
283 <h4>ProjectInterfacesBrowser.__deleteFile</h4>
284 <b>__deleteFile</b>(<i></i>)
285
286 <p>
287 Private method to delete files from the project.
288 </p>
289 <a NAME="ProjectInterfacesBrowser.__readStderr" ID="ProjectInterfacesBrowser.__readStderr"></a>
290 <h4>ProjectInterfacesBrowser.__readStderr</h4>
291 <b>__readStderr</b>(<i></i>)
292
293 <p>
294 Private slot to handle the readyReadStandardError signal of the
295 omniidl process.
296 </p>
297 <a NAME="ProjectInterfacesBrowser.__readStdout" ID="ProjectInterfacesBrowser.__readStdout"></a>
298 <h4>ProjectInterfacesBrowser.__readStdout</h4>
299 <b>__readStdout</b>(<i></i>)
300
301 <p>
302 Private slot to handle the readyReadStandardOutput signal of the
303 omniidl process.
304 </p>
305 <a NAME="ProjectInterfacesBrowser.__showContextMenu" ID="ProjectInterfacesBrowser.__showContextMenu"></a>
306 <h4>ProjectInterfacesBrowser.__showContextMenu</h4>
307 <b>__showContextMenu</b>(<i></i>)
308
309 <p>
310 Private slot called by the menu aboutToShow signal.
311 </p>
312 <a NAME="ProjectInterfacesBrowser.__showContextMenuBack" ID="ProjectInterfacesBrowser.__showContextMenuBack"></a>
313 <h4>ProjectInterfacesBrowser.__showContextMenuBack</h4>
314 <b>__showContextMenuBack</b>(<i></i>)
315
316 <p>
317 Private slot called by the backMenu aboutToShow signal.
318 </p>
319 <a NAME="ProjectInterfacesBrowser.__showContextMenuDir" ID="ProjectInterfacesBrowser.__showContextMenuDir"></a>
320 <h4>ProjectInterfacesBrowser.__showContextMenuDir</h4>
321 <b>__showContextMenuDir</b>(<i></i>)
322
323 <p>
324 Private slot called by the dirMenu aboutToShow signal.
325 </p>
326 <a NAME="ProjectInterfacesBrowser.__showContextMenuDirMulti" ID="ProjectInterfacesBrowser.__showContextMenuDirMulti"></a>
327 <h4>ProjectInterfacesBrowser.__showContextMenuDirMulti</h4>
328 <b>__showContextMenuDirMulti</b>(<i></i>)
329
330 <p>
331 Private slot called by the dirMultiMenu aboutToShow signal.
332 </p>
333 <a NAME="ProjectInterfacesBrowser.__showContextMenuMulti" ID="ProjectInterfacesBrowser.__showContextMenuMulti"></a>
334 <h4>ProjectInterfacesBrowser.__showContextMenuMulti</h4>
335 <b>__showContextMenuMulti</b>(<i></i>)
336
337 <p>
338 Private slot called by the multiMenu aboutToShow signal.
339 </p>
340 <a NAME="ProjectInterfacesBrowser._contextMenuRequested" ID="ProjectInterfacesBrowser._contextMenuRequested"></a>
341 <h4>ProjectInterfacesBrowser._contextMenuRequested</h4>
342 <b>_contextMenuRequested</b>(<i>coord</i>)
343
344 <p>
345 Protected slot to show the context menu.
346 </p>
347 <dl>
348
349 <dt><i>coord</i></dt>
350 <dd>
351 the position of the mouse pointer (QPoint)
352 </dd>
353 </dl>
354 <a NAME="ProjectInterfacesBrowser._createPopupMenus" ID="ProjectInterfacesBrowser._createPopupMenus"></a>
355 <h4>ProjectInterfacesBrowser._createPopupMenus</h4>
356 <b>_createPopupMenus</b>(<i></i>)
357
358 <p>
359 Protected overloaded method to generate the popup menu.
360 </p>
361 <a NAME="ProjectInterfacesBrowser._openItem" ID="ProjectInterfacesBrowser._openItem"></a>
362 <h4>ProjectInterfacesBrowser._openItem</h4>
363 <b>_openItem</b>(<i></i>)
364
365 <p>
366 Protected slot to handle the open popup menu entry.
367 </p>
368 <div align="right"><a href="#top">Up</a></div>
369 <hr />
370 </body></html>

eric ide

mercurial