Mercurial Repositories > eric / file comparison

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

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

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

Mercurial Repository: eric

eric ide

mercurial