Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric4.Utilities.ClassBrowsers.ClbrBaseClasses.html

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

Mercurial Repository: eric

eric ide

mercurial