|
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.Utilities.ClassBrowsers.ClbrBaseClasses</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.Utilities.ClassBrowsers.ClbrBaseClasses</h1> |
|
12 <p> |
|
13 Module implementing base classes used by the various class browsers. |
|
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="#Attribute">Attribute</a></td> |
|
23 <td>Class to represent an attribute.</td> |
|
24 </tr><tr> |
|
25 <td><a href="#Class">Class</a></td> |
|
26 <td>Class to represent a class.</td> |
|
27 </tr><tr> |
|
28 <td><a href="#ClbrBase">ClbrBase</a></td> |
|
29 <td>Class implementing the base of all complex class browser objects.</td> |
|
30 </tr><tr> |
|
31 <td><a href="#ClbrVisibilityMixinBase">ClbrVisibilityMixinBase</a></td> |
|
32 <td>Class implementing the base class of all visibility mixins.</td> |
|
33 </tr><tr> |
|
34 <td><a href="#Coding">Coding</a></td> |
|
35 <td>Class to represent a source coding.</td> |
|
36 </tr><tr> |
|
37 <td><a href="#Function">Function</a></td> |
|
38 <td>Class to represent a function or method.</td> |
|
39 </tr><tr> |
|
40 <td><a href="#Module">Module</a></td> |
|
41 <td>Class to represent a module.</td> |
|
42 </tr><tr> |
|
43 <td><a href="#_ClbrBase">_ClbrBase</a></td> |
|
44 <td>Class implementing the base of all class browser objects.</td> |
|
45 </tr> |
|
46 </table> |
|
47 <h3>Functions</h3> |
|
48 <table> |
|
49 <tr><td>None</td></tr> |
|
50 </table> |
|
51 <hr /><hr /> |
|
52 <a NAME="Attribute" ID="Attribute"></a> |
|
53 <h2>Attribute</h2> |
|
54 <p> |
|
55 Class to represent an attribute. |
|
56 </p> |
|
57 <h3>Derived from</h3> |
|
58 _ClbrBase |
|
59 <h3>Class Attributes</h3> |
|
60 <table> |
|
61 <tr><td>None</td></tr> |
|
62 </table> |
|
63 <h3>Methods</h3> |
|
64 <table> |
|
65 <tr> |
|
66 <td><a href="#Attribute.__init__">Attribute</a></td> |
|
67 <td>Constructor</td> |
|
68 </tr> |
|
69 </table> |
|
70 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> |
|
71 <h4>Attribute (Constructor)</h4> |
|
72 <b>Attribute</b>(<i>module, name, file, lineno</i>) |
|
73 <p> |
|
74 Constructor |
|
75 </p><dl> |
|
76 <dt><i>module</i></dt> |
|
77 <dd> |
|
78 name of the module containing this class |
|
79 </dd><dt><i>name</i></dt> |
|
80 <dd> |
|
81 name of this class |
|
82 </dd><dt><i>file</i></dt> |
|
83 <dd> |
|
84 filename containing this attribute |
|
85 </dd><dt><i>lineno</i></dt> |
|
86 <dd> |
|
87 linenumber of the class definition |
|
88 </dd> |
|
89 </dl> |
|
90 <div align="right"><a href="#top">Up</a></div> |
|
91 <hr /><hr /> |
|
92 <a NAME="Class" ID="Class"></a> |
|
93 <h2>Class</h2> |
|
94 <p> |
|
95 Class to represent a class. |
|
96 </p> |
|
97 <h3>Derived from</h3> |
|
98 ClbrBase |
|
99 <h3>Class Attributes</h3> |
|
100 <table> |
|
101 <tr><td>None</td></tr> |
|
102 </table> |
|
103 <h3>Methods</h3> |
|
104 <table> |
|
105 <tr> |
|
106 <td><a href="#Class.__init__">Class</a></td> |
|
107 <td>Constructor</td> |
|
108 </tr> |
|
109 </table> |
|
110 <a NAME="Class.__init__" ID="Class.__init__"></a> |
|
111 <h4>Class (Constructor)</h4> |
|
112 <b>Class</b>(<i>module, name, super, file, lineno</i>) |
|
113 <p> |
|
114 Constructor |
|
115 </p><dl> |
|
116 <dt><i>module</i></dt> |
|
117 <dd> |
|
118 name of the module containing this class |
|
119 </dd><dt><i>name</i></dt> |
|
120 <dd> |
|
121 name of this class |
|
122 </dd><dt><i>super</i></dt> |
|
123 <dd> |
|
124 list of class names this class is inherited from |
|
125 </dd><dt><i>file</i></dt> |
|
126 <dd> |
|
127 filename containing this class |
|
128 </dd><dt><i>lineno</i></dt> |
|
129 <dd> |
|
130 linenumber of the class definition |
|
131 </dd> |
|
132 </dl> |
|
133 <div align="right"><a href="#top">Up</a></div> |
|
134 <hr /><hr /> |
|
135 <a NAME="ClbrBase" ID="ClbrBase"></a> |
|
136 <h2>ClbrBase</h2> |
|
137 <p> |
|
138 Class implementing the base of all complex class browser objects. |
|
139 </p> |
|
140 <h3>Derived from</h3> |
|
141 _ClbrBase |
|
142 <h3>Class Attributes</h3> |
|
143 <table> |
|
144 <tr><td>None</td></tr> |
|
145 </table> |
|
146 <h3>Methods</h3> |
|
147 <table> |
|
148 <tr> |
|
149 <td><a href="#ClbrBase.__init__">ClbrBase</a></td> |
|
150 <td>Constructor</td> |
|
151 </tr><tr> |
|
152 <td><a href="#ClbrBase._addattribute">_addattribute</a></td> |
|
153 <td>Protected method to add information about attributes.</td> |
|
154 </tr><tr> |
|
155 <td><a href="#ClbrBase._addclass">_addclass</a></td> |
|
156 <td>Protected method method to add a nested class to this class.</td> |
|
157 </tr><tr> |
|
158 <td><a href="#ClbrBase._addglobal">_addglobal</a></td> |
|
159 <td>Protected method to add information about global variables.</td> |
|
160 </tr><tr> |
|
161 <td><a href="#ClbrBase._addmethod">_addmethod</a></td> |
|
162 <td>Protected method to add information about a method.</td> |
|
163 </tr><tr> |
|
164 <td><a href="#ClbrBase._getattribute">_getattribute</a></td> |
|
165 <td>Protected method to retrieve an attribute by name.</td> |
|
166 </tr><tr> |
|
167 <td><a href="#ClbrBase._getglobal">_getglobal</a></td> |
|
168 <td>Protected method to retrieve a global variable by name.</td> |
|
169 </tr><tr> |
|
170 <td><a href="#ClbrBase._getmethod">_getmethod</a></td> |
|
171 <td>Protected method to retrieve a method by name.</td> |
|
172 </tr> |
|
173 </table> |
|
174 <a NAME="ClbrBase.__init__" ID="ClbrBase.__init__"></a> |
|
175 <h4>ClbrBase (Constructor)</h4> |
|
176 <b>ClbrBase</b>(<i>module, name, file, lineno</i>) |
|
177 <p> |
|
178 Constructor |
|
179 </p><dl> |
|
180 <dt><i>module</i></dt> |
|
181 <dd> |
|
182 name of the module containing this class |
|
183 </dd><dt><i>name</i></dt> |
|
184 <dd> |
|
185 name of this class |
|
186 </dd><dt><i>file</i></dt> |
|
187 <dd> |
|
188 filename containing this object |
|
189 </dd><dt><i>lineno</i></dt> |
|
190 <dd> |
|
191 linenumber of the class definition |
|
192 </dd> |
|
193 </dl><a NAME="ClbrBase._addattribute" ID="ClbrBase._addattribute"></a> |
|
194 <h4>ClbrBase._addattribute</h4> |
|
195 <b>_addattribute</b>(<i>attr</i>) |
|
196 <p> |
|
197 Protected method to add information about attributes. |
|
198 </p><dl> |
|
199 <dt><i>attr</i></dt> |
|
200 <dd> |
|
201 Attribute object to be added (Attribute) |
|
202 </dd> |
|
203 </dl><a NAME="ClbrBase._addclass" ID="ClbrBase._addclass"></a> |
|
204 <h4>ClbrBase._addclass</h4> |
|
205 <b>_addclass</b>(<i>name, _class</i>) |
|
206 <p> |
|
207 Protected method method to add a nested class to this class. |
|
208 </p><dl> |
|
209 <dt><i>name</i></dt> |
|
210 <dd> |
|
211 name of the class |
|
212 </dd><dt><i>_class</i></dt> |
|
213 <dd> |
|
214 Class object to be added (Class) |
|
215 </dd> |
|
216 </dl><a NAME="ClbrBase._addglobal" ID="ClbrBase._addglobal"></a> |
|
217 <h4>ClbrBase._addglobal</h4> |
|
218 <b>_addglobal</b>(<i>attr</i>) |
|
219 <p> |
|
220 Protected method to add information about global variables. |
|
221 </p><dl> |
|
222 <dt><i>attr</i></dt> |
|
223 <dd> |
|
224 Attribute object to be added (Attribute) |
|
225 </dd> |
|
226 </dl><a NAME="ClbrBase._addmethod" ID="ClbrBase._addmethod"></a> |
|
227 <h4>ClbrBase._addmethod</h4> |
|
228 <b>_addmethod</b>(<i>name, function</i>) |
|
229 <p> |
|
230 Protected method to add information about a method. |
|
231 </p><dl> |
|
232 <dt><i>name</i></dt> |
|
233 <dd> |
|
234 name of method to be added (string) |
|
235 </dd><dt><i>function</i></dt> |
|
236 <dd> |
|
237 Function object to be added |
|
238 </dd> |
|
239 </dl><a NAME="ClbrBase._getattribute" ID="ClbrBase._getattribute"></a> |
|
240 <h4>ClbrBase._getattribute</h4> |
|
241 <b>_getattribute</b>(<i>name</i>) |
|
242 <p> |
|
243 Protected method to retrieve an attribute by name. |
|
244 </p><dl> |
|
245 <dt><i>name</i></dt> |
|
246 <dd> |
|
247 name of the attribute (string) |
|
248 </dd> |
|
249 </dl><dl> |
|
250 <dt>Returns:</dt> |
|
251 <dd> |
|
252 the named attribute or None |
|
253 </dd> |
|
254 </dl><a NAME="ClbrBase._getglobal" ID="ClbrBase._getglobal"></a> |
|
255 <h4>ClbrBase._getglobal</h4> |
|
256 <b>_getglobal</b>(<i>name</i>) |
|
257 <p> |
|
258 Protected method to retrieve a global variable by name. |
|
259 </p><dl> |
|
260 <dt><i>name</i></dt> |
|
261 <dd> |
|
262 name of the global variable (string) |
|
263 </dd> |
|
264 </dl><dl> |
|
265 <dt>Returns:</dt> |
|
266 <dd> |
|
267 the named global variable or None |
|
268 </dd> |
|
269 </dl><a NAME="ClbrBase._getmethod" ID="ClbrBase._getmethod"></a> |
|
270 <h4>ClbrBase._getmethod</h4> |
|
271 <b>_getmethod</b>(<i>name</i>) |
|
272 <p> |
|
273 Protected method to retrieve a method by name. |
|
274 </p><dl> |
|
275 <dt><i>name</i></dt> |
|
276 <dd> |
|
277 name of the method (string) |
|
278 </dd> |
|
279 </dl><dl> |
|
280 <dt>Returns:</dt> |
|
281 <dd> |
|
282 the named method or None |
|
283 </dd> |
|
284 </dl> |
|
285 <div align="right"><a href="#top">Up</a></div> |
|
286 <hr /><hr /> |
|
287 <a NAME="ClbrVisibilityMixinBase" ID="ClbrVisibilityMixinBase"></a> |
|
288 <h2>ClbrVisibilityMixinBase</h2> |
|
289 <p> |
|
290 Class implementing the base class of all visibility mixins. |
|
291 </p> |
|
292 <h3>Derived from</h3> |
|
293 object |
|
294 <h3>Class Attributes</h3> |
|
295 <table> |
|
296 <tr><td>None</td></tr> |
|
297 </table> |
|
298 <h3>Methods</h3> |
|
299 <table> |
|
300 <tr> |
|
301 <td><a href="#ClbrVisibilityMixinBase.isPrivate">isPrivate</a></td> |
|
302 <td>Public method to check, if the visibility is Private.</td> |
|
303 </tr><tr> |
|
304 <td><a href="#ClbrVisibilityMixinBase.isProtected">isProtected</a></td> |
|
305 <td>Public method to check, if the visibility is Protected.</td> |
|
306 </tr><tr> |
|
307 <td><a href="#ClbrVisibilityMixinBase.isPublic">isPublic</a></td> |
|
308 <td>Public method to check, if the visibility is Public.</td> |
|
309 </tr><tr> |
|
310 <td><a href="#ClbrVisibilityMixinBase.setPrivate">setPrivate</a></td> |
|
311 <td>Public method to set the visibility to Private.</td> |
|
312 </tr><tr> |
|
313 <td><a href="#ClbrVisibilityMixinBase.setProtected">setProtected</a></td> |
|
314 <td>Public method to set the visibility to Protected.</td> |
|
315 </tr><tr> |
|
316 <td><a href="#ClbrVisibilityMixinBase.setPublic">setPublic</a></td> |
|
317 <td>Public method to set the visibility to Public.</td> |
|
318 </tr> |
|
319 </table> |
|
320 <a NAME="ClbrVisibilityMixinBase.isPrivate" ID="ClbrVisibilityMixinBase.isPrivate"></a> |
|
321 <h4>ClbrVisibilityMixinBase.isPrivate</h4> |
|
322 <b>isPrivate</b>(<i></i>) |
|
323 <p> |
|
324 Public method to check, if the visibility is Private. |
|
325 </p><dl> |
|
326 <dt>Returns:</dt> |
|
327 <dd> |
|
328 flag indicating Private visibility (boolean) |
|
329 </dd> |
|
330 </dl><a NAME="ClbrVisibilityMixinBase.isProtected" ID="ClbrVisibilityMixinBase.isProtected"></a> |
|
331 <h4>ClbrVisibilityMixinBase.isProtected</h4> |
|
332 <b>isProtected</b>(<i></i>) |
|
333 <p> |
|
334 Public method to check, if the visibility is Protected. |
|
335 </p><dl> |
|
336 <dt>Returns:</dt> |
|
337 <dd> |
|
338 flag indicating Protected visibility (boolean) |
|
339 </dd> |
|
340 </dl><a NAME="ClbrVisibilityMixinBase.isPublic" ID="ClbrVisibilityMixinBase.isPublic"></a> |
|
341 <h4>ClbrVisibilityMixinBase.isPublic</h4> |
|
342 <b>isPublic</b>(<i></i>) |
|
343 <p> |
|
344 Public method to check, if the visibility is Public. |
|
345 </p><dl> |
|
346 <dt>Returns:</dt> |
|
347 <dd> |
|
348 flag indicating Public visibility (boolean) |
|
349 </dd> |
|
350 </dl><a NAME="ClbrVisibilityMixinBase.setPrivate" ID="ClbrVisibilityMixinBase.setPrivate"></a> |
|
351 <h4>ClbrVisibilityMixinBase.setPrivate</h4> |
|
352 <b>setPrivate</b>(<i></i>) |
|
353 <p> |
|
354 Public method to set the visibility to Private. |
|
355 </p><a NAME="ClbrVisibilityMixinBase.setProtected" ID="ClbrVisibilityMixinBase.setProtected"></a> |
|
356 <h4>ClbrVisibilityMixinBase.setProtected</h4> |
|
357 <b>setProtected</b>(<i></i>) |
|
358 <p> |
|
359 Public method to set the visibility to Protected. |
|
360 </p><a NAME="ClbrVisibilityMixinBase.setPublic" ID="ClbrVisibilityMixinBase.setPublic"></a> |
|
361 <h4>ClbrVisibilityMixinBase.setPublic</h4> |
|
362 <b>setPublic</b>(<i></i>) |
|
363 <p> |
|
364 Public method to set the visibility to Public. |
|
365 </p> |
|
366 <div align="right"><a href="#top">Up</a></div> |
|
367 <hr /><hr /> |
|
368 <a NAME="Coding" ID="Coding"></a> |
|
369 <h2>Coding</h2> |
|
370 <p> |
|
371 Class to represent a source coding. |
|
372 </p> |
|
373 <h3>Derived from</h3> |
|
374 ClbrBase |
|
375 <h3>Class Attributes</h3> |
|
376 <table> |
|
377 <tr><td>None</td></tr> |
|
378 </table> |
|
379 <h3>Methods</h3> |
|
380 <table> |
|
381 <tr> |
|
382 <td><a href="#Coding.__init__">Coding</a></td> |
|
383 <td>Constructor</td> |
|
384 </tr> |
|
385 </table> |
|
386 <a NAME="Coding.__init__" ID="Coding.__init__"></a> |
|
387 <h4>Coding (Constructor)</h4> |
|
388 <b>Coding</b>(<i>module, file, lineno, coding</i>) |
|
389 <p> |
|
390 Constructor |
|
391 </p><dl> |
|
392 <dt><i>module</i></dt> |
|
393 <dd> |
|
394 name of the module containing this module |
|
395 </dd><dt><i>file</i></dt> |
|
396 <dd> |
|
397 filename containing this module |
|
398 </dd><dt><i>lineno</i></dt> |
|
399 <dd> |
|
400 linenumber of the module definition |
|
401 </dd><dt><i>coding</i></dt> |
|
402 <dd> |
|
403 character coding of the source file |
|
404 </dd> |
|
405 </dl> |
|
406 <div align="right"><a href="#top">Up</a></div> |
|
407 <hr /><hr /> |
|
408 <a NAME="Function" ID="Function"></a> |
|
409 <h2>Function</h2> |
|
410 <p> |
|
411 Class to represent a function or method. |
|
412 </p> |
|
413 <h3>Derived from</h3> |
|
414 ClbrBase |
|
415 <h3>Class Attributes</h3> |
|
416 <table> |
|
417 <tr><td>None</td></tr> |
|
418 </table> |
|
419 <h3>Methods</h3> |
|
420 <table> |
|
421 <tr> |
|
422 <td><a href="#Function.__init__">Function</a></td> |
|
423 <td>Constructor</td> |
|
424 </tr> |
|
425 </table> |
|
426 <a NAME="Function.__init__" ID="Function.__init__"></a> |
|
427 <h4>Function (Constructor)</h4> |
|
428 <b>Function</b>(<i>module, name, file, lineno, signature = '', separator = ', '</i>) |
|
429 <p> |
|
430 Constructor |
|
431 </p><dl> |
|
432 <dt><i>module</i></dt> |
|
433 <dd> |
|
434 name of the module containing this function |
|
435 </dd><dt><i>name</i></dt> |
|
436 <dd> |
|
437 name of this function |
|
438 </dd><dt><i>file</i></dt> |
|
439 <dd> |
|
440 filename containing this class |
|
441 </dd><dt><i>lineno</i></dt> |
|
442 <dd> |
|
443 linenumber of the class definition |
|
444 </dd><dt><i>signature</i></dt> |
|
445 <dd> |
|
446 parameterlist of the method |
|
447 </dd><dt><i>separator</i></dt> |
|
448 <dd> |
|
449 string separating the parameters |
|
450 </dd> |
|
451 </dl> |
|
452 <div align="right"><a href="#top">Up</a></div> |
|
453 <hr /><hr /> |
|
454 <a NAME="Module" ID="Module"></a> |
|
455 <h2>Module</h2> |
|
456 <p> |
|
457 Class to represent a module. |
|
458 </p> |
|
459 <h3>Derived from</h3> |
|
460 ClbrBase |
|
461 <h3>Class Attributes</h3> |
|
462 <table> |
|
463 <tr><td>None</td></tr> |
|
464 </table> |
|
465 <h3>Methods</h3> |
|
466 <table> |
|
467 <tr> |
|
468 <td><a href="#Module.__init__">Module</a></td> |
|
469 <td>Constructor</td> |
|
470 </tr> |
|
471 </table> |
|
472 <a NAME="Module.__init__" ID="Module.__init__"></a> |
|
473 <h4>Module (Constructor)</h4> |
|
474 <b>Module</b>(<i>module, name, file, lineno</i>) |
|
475 <p> |
|
476 Constructor |
|
477 </p><dl> |
|
478 <dt><i>module</i></dt> |
|
479 <dd> |
|
480 name of the module containing this module |
|
481 </dd><dt><i>name</i></dt> |
|
482 <dd> |
|
483 name of this module |
|
484 </dd><dt><i>file</i></dt> |
|
485 <dd> |
|
486 filename containing this module |
|
487 </dd><dt><i>lineno</i></dt> |
|
488 <dd> |
|
489 linenumber of the module definition |
|
490 </dd> |
|
491 </dl> |
|
492 <div align="right"><a href="#top">Up</a></div> |
|
493 <hr /><hr /> |
|
494 <a NAME="_ClbrBase" ID="_ClbrBase"></a> |
|
495 <h2>_ClbrBase</h2> |
|
496 <p> |
|
497 Class implementing the base of all class browser objects. |
|
498 </p> |
|
499 <h3>Derived from</h3> |
|
500 object |
|
501 <h3>Class Attributes</h3> |
|
502 <table> |
|
503 <tr><td>None</td></tr> |
|
504 </table> |
|
505 <h3>Methods</h3> |
|
506 <table> |
|
507 <tr> |
|
508 <td><a href="#_ClbrBase.__init__">_ClbrBase</a></td> |
|
509 <td>Constructor</td> |
|
510 </tr> |
|
511 </table> |
|
512 <a NAME="_ClbrBase.__init__" ID="_ClbrBase.__init__"></a> |
|
513 <h4>_ClbrBase (Constructor)</h4> |
|
514 <b>_ClbrBase</b>(<i>module, name, file, lineno</i>) |
|
515 <p> |
|
516 Constructor |
|
517 </p><dl> |
|
518 <dt><i>module</i></dt> |
|
519 <dd> |
|
520 name of the module containing this class |
|
521 </dd><dt><i>name</i></dt> |
|
522 <dd> |
|
523 name of this class |
|
524 </dd><dt><i>file</i></dt> |
|
525 <dd> |
|
526 filename containing this object |
|
527 </dd><dt><i>lineno</i></dt> |
|
528 <dd> |
|
529 linenumber of the class definition |
|
530 </dd> |
|
531 </dl> |
|
532 <div align="right"><a href="#top">Up</a></div> |
|
533 <hr /> |
|
534 </body></html> |