Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.idlclbr.html

eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.idlclbr.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Utilities.ClassBrowsers.idlclbr</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.Utilities.ClassBrowsers.idlclbr</h1>
23 <p>
24 Parse a CORBA IDL file and retrieve modules, interfaces, methods and
25 attributes.
26 </p><p>
27 Parse enough of a CORBA IDL file to recognize module, interface and method
28 definitions and to find out the superclasses of an interface as well as its
29 attributes.
30 </p><p>
31 It is based on the Python class browser found in this package.
32 </p>
33 <h3>Global Attributes</h3>
34 <table>
35 <tr><td>SUPPORTED_TYPES</td></tr><tr><td>_commentsub</td></tr><tr><td>_getnext</td></tr><tr><td>_modules</td></tr><tr><td>_normalize</td></tr>
36 </table>
37 <h3>Classes</h3>
38 <table>
39 <tr>
40 <td><a href="#Attribute">Attribute</a></td>
41 <td>Class to represent a CORBA IDL attribute.</td>
42 </tr><tr>
43 <td><a href="#Function">Function</a></td>
44 <td>Class to represent a CORBA IDL function.</td>
45 </tr><tr>
46 <td><a href="#Interface">Interface</a></td>
47 <td>Class to represent a CORBA IDL interface.</td>
48 </tr><tr>
49 <td><a href="#Module">Module</a></td>
50 <td>Class to represent a CORBA IDL module.</td>
51 </tr><tr>
52 <td><a href="#VisibilityMixin">VisibilityMixin</a></td>
53 <td>Mixin class implementing the notion of visibility.</td>
54 </tr>
55 </table>
56 <h3>Functions</h3>
57 <table>
58 <tr>
59 <td><a href="#readmodule_ex">readmodule_ex</a></td>
60 <td>Read a CORBA IDL file and return a dictionary of classes, functions and modules.</td>
61 </tr>
62 </table>
63 <hr /><hr />
64 <a NAME="Attribute" ID="Attribute"></a>
65 <h2>Attribute</h2>
66 <p>
67 Class to represent a CORBA IDL attribute.
68 </p>
69 <h3>Derived from</h3>
70 ClbrBaseClasses.Attribute, VisibilityMixin
71 <h3>Class Attributes</h3>
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Class Methods</h3>
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79 <h3>Methods</h3>
80 <table>
81 <tr>
82 <td><a href="#Attribute.__init__">Attribute</a></td>
83 <td>Constructor</td>
84 </tr>
85 </table>
86 <h3>Static Methods</h3>
87 <table>
88 <tr><td>None</td></tr>
89 </table>
90 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a>
91 <h4>Attribute (Constructor)</h4>
92 <b>Attribute</b>(<i>module, name, file, lineno</i>)
93 <p>
94 Constructor
95 </p><dl>
96 <dt><i>module</i> (str)</dt>
97 <dd>
98 name of the module containing this attribute
99 </dd><dt><i>name</i> (str)</dt>
100 <dd>
101 name of this attribute
102 </dd><dt><i>file</i> (str)</dt>
103 <dd>
104 filename containing this attribute
105 </dd><dt><i>lineno</i> (int)</dt>
106 <dd>
107 line number of the attribute definition
108 </dd>
109 </dl>
110 <div align="right"><a href="#top">Up</a></div>
111 <hr /><hr />
112 <a NAME="Function" ID="Function"></a>
113 <h2>Function</h2>
114 <p>
115 Class to represent a CORBA IDL function.
116 </p>
117 <h3>Derived from</h3>
118 ClbrBaseClasses.Function, VisibilityMixin
119 <h3>Class Attributes</h3>
120 <table>
121 <tr><td>None</td></tr>
122 </table>
123 <h3>Class Methods</h3>
124 <table>
125 <tr><td>None</td></tr>
126 </table>
127 <h3>Methods</h3>
128 <table>
129 <tr>
130 <td><a href="#Function.__init__">Function</a></td>
131 <td>Constructor</td>
132 </tr>
133 </table>
134 <h3>Static Methods</h3>
135 <table>
136 <tr><td>None</td></tr>
137 </table>
138 <a NAME="Function.__init__" ID="Function.__init__"></a>
139 <h4>Function (Constructor)</h4>
140 <b>Function</b>(<i>module, name, file, lineno, signature='', separator=', '</i>)
141 <p>
142 Constructor
143 </p><dl>
144 <dt><i>module</i> (str)</dt>
145 <dd>
146 name of the module containing this function
147 </dd><dt><i>name</i> (str)</dt>
148 <dd>
149 name of this function
150 </dd><dt><i>file</i> (str)</dt>
151 <dd>
152 filename containing this function
153 </dd><dt><i>lineno</i> (int)</dt>
154 <dd>
155 line number of the function definition
156 </dd><dt><i>signature</i> (str)</dt>
157 <dd>
158 parameter list of the function
159 </dd><dt><i>separator</i> (str)</dt>
160 <dd>
161 string separating the parameters
162 </dd>
163 </dl>
164 <div align="right"><a href="#top">Up</a></div>
165 <hr /><hr />
166 <a NAME="Interface" ID="Interface"></a>
167 <h2>Interface</h2>
168 <p>
169 Class to represent a CORBA IDL interface.
170 </p>
171 <h3>Derived from</h3>
172 ClbrBaseClasses.Class, VisibilityMixin
173 <h3>Class Attributes</h3>
174 <table>
175 <tr><td>None</td></tr>
176 </table>
177 <h3>Class Methods</h3>
178 <table>
179 <tr><td>None</td></tr>
180 </table>
181 <h3>Methods</h3>
182 <table>
183 <tr>
184 <td><a href="#Interface.__init__">Interface</a></td>
185 <td>Constructor</td>
186 </tr>
187 </table>
188 <h3>Static Methods</h3>
189 <table>
190 <tr><td>None</td></tr>
191 </table>
192 <a NAME="Interface.__init__" ID="Interface.__init__"></a>
193 <h4>Interface (Constructor)</h4>
194 <b>Interface</b>(<i>module, name, superClasses, file, lineno</i>)
195 <p>
196 Constructor
197 </p><dl>
198 <dt><i>module</i> (str)</dt>
199 <dd>
200 name of the module containing this interface
201 </dd><dt><i>name</i> (str)</dt>
202 <dd>
203 name of this interface
204 </dd><dt><i>superClasses</i> (list of str)</dt>
205 <dd>
206 list of interface names this interface is
207 inherited from
208 </dd><dt><i>file</i> (str)</dt>
209 <dd>
210 filename containing this interface
211 </dd><dt><i>lineno</i> (int)</dt>
212 <dd>
213 line number of the interface definition
214 </dd>
215 </dl>
216 <div align="right"><a href="#top">Up</a></div>
217 <hr /><hr />
218 <a NAME="Module" ID="Module"></a>
219 <h2>Module</h2>
220 <p>
221 Class to represent a CORBA IDL module.
222 </p>
223 <h3>Derived from</h3>
224 ClbrBaseClasses.Module, VisibilityMixin
225 <h3>Class Attributes</h3>
226 <table>
227 <tr><td>None</td></tr>
228 </table>
229 <h3>Class Methods</h3>
230 <table>
231 <tr><td>None</td></tr>
232 </table>
233 <h3>Methods</h3>
234 <table>
235 <tr>
236 <td><a href="#Module.__init__">Module</a></td>
237 <td>Constructor</td>
238 </tr>
239 </table>
240 <h3>Static Methods</h3>
241 <table>
242 <tr><td>None</td></tr>
243 </table>
244 <a NAME="Module.__init__" ID="Module.__init__"></a>
245 <h4>Module (Constructor)</h4>
246 <b>Module</b>(<i>module, name, file, lineno</i>)
247 <p>
248 Constructor
249 </p><dl>
250 <dt><i>module</i> (str)</dt>
251 <dd>
252 name of the module containing this module
253 </dd><dt><i>name</i> (str)</dt>
254 <dd>
255 name of this module
256 </dd><dt><i>file</i> (str)</dt>
257 <dd>
258 filename containing this module
259 </dd><dt><i>lineno</i> (int)</dt>
260 <dd>
261 line number of the module definition
262 </dd>
263 </dl>
264 <div align="right"><a href="#top">Up</a></div>
265 <hr /><hr />
266 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a>
267 <h2>VisibilityMixin</h2>
268 <p>
269 Mixin class implementing the notion of visibility.
270 </p>
271 <h3>Derived from</h3>
272 ClbrBaseClasses.ClbrVisibilityMixinBase
273 <h3>Class Attributes</h3>
274 <table>
275 <tr><td>None</td></tr>
276 </table>
277 <h3>Class Methods</h3>
278 <table>
279 <tr><td>None</td></tr>
280 </table>
281 <h3>Methods</h3>
282 <table>
283 <tr>
284 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td>
285 <td>Constructor</td>
286 </tr>
287 </table>
288 <h3>Static Methods</h3>
289 <table>
290 <tr><td>None</td></tr>
291 </table>
292 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a>
293 <h4>VisibilityMixin (Constructor)</h4>
294 <b>VisibilityMixin</b>(<i></i>)
295 <p>
296 Constructor
297 </p>
298 <div align="right"><a href="#top">Up</a></div>
299 <hr /><hr />
300 <a NAME="readmodule_ex" ID="readmodule_ex"></a>
301 <h2>readmodule_ex</h2>
302 <b>readmodule_ex</b>(<i>module, path=None</i>)
303 <p>
304 Read a CORBA IDL file and return a dictionary of classes, functions and
305 modules.
306 </p><dl>
307 <dt><i>module</i> (str)</dt>
308 <dd>
309 name of the CORBA IDL file
310 </dd><dt><i>path</i> (list of str)</dt>
311 <dd>
312 path the file should be searched in
313 </dd>
314 </dl><dl>
315 <dt>Returns:</dt>
316 <dd>
317 the resulting dictionary
318 </dd>
319 </dl><dl>
320 <dt>Return Type:</dt>
321 <dd>
322 dict
323 </dd>
324 </dl>
325 <div align="right"><a href="#top">Up</a></div>
326 <hr />
327 </body></html>

Mercurial Repository: eric

eric ide

mercurial