Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.ClbrBaseClasses.html

src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.ClbrBaseClasses.html

branch
eric7
changeset 10479
856476537696
parent 9236
db53a9efe7ef
child 10677
6ee2e475490c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Utilities.ClassBrowsers.ClbrBaseClasses</h1> 9 <h1>eric7.Utilities.ClassBrowsers.ClbrBaseClasses</h1>
10
11 <p> 10 <p>
12 Module implementing base classes used by the various class browsers. 11 Module implementing base classes used by the various class browsers.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#Attribute">Attribute</a></td> 22 <td><a href="#Attribute">Attribute</a></td>
25 <td>Class to represent an attribute.</td> 23 <td>Class to represent an attribute.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
55 <tr> 53 <tr>
56 <td><a href="#_ClbrBase">_ClbrBase</a></td> 54 <td><a href="#_ClbrBase">_ClbrBase</a></td>
57 <td>Class implementing the base of all class browser objects.</td> 55 <td>Class implementing the base of all class browser objects.</td>
58 </tr> 56 </tr>
59 </table> 57 </table>
58
60 <h3>Functions</h3> 59 <h3>Functions</h3>
61 60 <table>
62 <table> 61 <tr><td>None</td></tr>
63 <tr><td>None</td></tr> 62 </table>
64 </table> 63
65 <hr /> 64 <hr />
66 <hr /> 65 <hr />
67 <a NAME="Attribute" ID="Attribute"></a> 66 <a NAME="Attribute" ID="Attribute"></a>
68 <h2>Attribute</h2> 67 <h2>Attribute</h2>
69
70 <p> 68 <p>
71 Class to represent an attribute. 69 Class to represent an attribute.
72 </p> 70 </p>
71
73 <h3>Derived from</h3> 72 <h3>Derived from</h3>
74 _ClbrBase 73 _ClbrBase
75 <h3>Class Attributes</h3> 74 <h3>Class Attributes</h3>
76 75 <table>
77 <table> 76 <tr><td>None</td></tr>
78 <tr><td>None</td></tr> 77 </table>
79 </table> 78
80 <h3>Class Methods</h3> 79 <h3>Class Methods</h3>
81 80 <table>
82 <table> 81 <tr><td>None</td></tr>
83 <tr><td>None</td></tr> 82 </table>
84 </table> 83
85 <h3>Methods</h3> 84 <h3>Methods</h3>
86 85 <table>
87 <table>
88
89 <tr> 86 <tr>
90 <td><a href="#Attribute.__init__">Attribute</a></td> 87 <td><a href="#Attribute.__init__">Attribute</a></td>
91 <td>Constructor</td> 88 <td>Constructor</td>
92 </tr> 89 </tr>
93 <tr> 90 <tr>
94 <td><a href="#Attribute.addAssignment">addAssignment</a></td> 91 <td><a href="#Attribute.addAssignment">addAssignment</a></td>
95 <td>Public method to add another assignment line number.</td> 92 <td>Public method to add another assignment line number.</td>
96 </tr> 93 </tr>
97 </table> 94 </table>
95
98 <h3>Static Methods</h3> 96 <h3>Static Methods</h3>
99 97 <table>
100 <table> 98 <tr><td>None</td></tr>
101 <tr><td>None</td></tr> 99 </table>
102 </table> 100
103 101
104 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> 102 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a>
105 <h4>Attribute (Constructor)</h4> 103 <h4>Attribute (Constructor)</h4>
106 <b>Attribute</b>(<i>module, name, file, lineno</i>) 104 <b>Attribute</b>(<i>module, name, file, lineno</i>)
107
108 <p> 105 <p>
109 Constructor 106 Constructor
110 </p> 107 </p>
108
111 <dl> 109 <dl>
112 110
113 <dt><i>module</i> (str)</dt> 111 <dt><i>module</i> (str)</dt>
114 <dd> 112 <dd>
115 name of the module containing this attribute 113 name of the module containing this attribute
128 </dd> 126 </dd>
129 </dl> 127 </dl>
130 <a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a> 128 <a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a>
131 <h4>Attribute.addAssignment</h4> 129 <h4>Attribute.addAssignment</h4>
132 <b>addAssignment</b>(<i>lineno</i>) 130 <b>addAssignment</b>(<i>lineno</i>)
133
134 <p> 131 <p>
135 Public method to add another assignment line number. 132 Public method to add another assignment line number.
136 </p> 133 </p>
134
137 <dl> 135 <dl>
138 136
139 <dt><i>lineno</i> (int)</dt> 137 <dt><i>lineno</i> (int)</dt>
140 <dd> 138 <dd>
141 line number of the additional attribute assignment 139 line number of the additional attribute assignment
144 <div align="right"><a href="#top">Up</a></div> 142 <div align="right"><a href="#top">Up</a></div>
145 <hr /> 143 <hr />
146 <hr /> 144 <hr />
147 <a NAME="Class" ID="Class"></a> 145 <a NAME="Class" ID="Class"></a>
148 <h2>Class</h2> 146 <h2>Class</h2>
149
150 <p> 147 <p>
151 Class to represent a class. 148 Class to represent a class.
152 </p> 149 </p>
150
153 <h3>Derived from</h3> 151 <h3>Derived from</h3>
154 ClbrBase 152 ClbrBase
155 <h3>Class Attributes</h3> 153 <h3>Class Attributes</h3>
156 154 <table>
157 <table> 155 <tr><td>None</td></tr>
158 <tr><td>None</td></tr> 156 </table>
159 </table> 157
160 <h3>Class Methods</h3> 158 <h3>Class Methods</h3>
161 159 <table>
162 <table> 160 <tr><td>None</td></tr>
163 <tr><td>None</td></tr> 161 </table>
164 </table> 162
165 <h3>Methods</h3> 163 <h3>Methods</h3>
166 164 <table>
167 <table>
168
169 <tr> 165 <tr>
170 <td><a href="#Class.__init__">Class</a></td> 166 <td><a href="#Class.__init__">Class</a></td>
171 <td>Constructor</td> 167 <td>Constructor</td>
172 </tr> 168 </tr>
173 </table> 169 </table>
170
174 <h3>Static Methods</h3> 171 <h3>Static Methods</h3>
175 172 <table>
176 <table> 173 <tr><td>None</td></tr>
177 <tr><td>None</td></tr> 174 </table>
178 </table> 175
179 176
180 <a NAME="Class.__init__" ID="Class.__init__"></a> 177 <a NAME="Class.__init__" ID="Class.__init__"></a>
181 <h4>Class (Constructor)</h4> 178 <h4>Class (Constructor)</h4>
182 <b>Class</b>(<i>module, name, superClasses, file, lineno</i>) 179 <b>Class</b>(<i>module, name, superClasses, file, lineno</i>)
183
184 <p> 180 <p>
185 Constructor 181 Constructor
186 </p> 182 </p>
183
187 <dl> 184 <dl>
188 185
189 <dt><i>module</i> (str)</dt> 186 <dt><i>module</i> (str)</dt>
190 <dd> 187 <dd>
191 name of the module containing this class 188 name of the module containing this class
210 <div align="right"><a href="#top">Up</a></div> 207 <div align="right"><a href="#top">Up</a></div>
211 <hr /> 208 <hr />
212 <hr /> 209 <hr />
213 <a NAME="ClbrBase" ID="ClbrBase"></a> 210 <a NAME="ClbrBase" ID="ClbrBase"></a>
214 <h2>ClbrBase</h2> 211 <h2>ClbrBase</h2>
215
216 <p> 212 <p>
217 Class implementing the base of all complex class browser objects. 213 Class implementing the base of all complex class browser objects.
218 </p> 214 </p>
215
219 <h3>Derived from</h3> 216 <h3>Derived from</h3>
220 _ClbrBase 217 _ClbrBase
221 <h3>Class Attributes</h3> 218 <h3>Class Attributes</h3>
222 219 <table>
223 <table> 220 <tr><td>None</td></tr>
224 <tr><td>None</td></tr> 221 </table>
225 </table> 222
226 <h3>Class Methods</h3> 223 <h3>Class Methods</h3>
227 224 <table>
228 <table> 225 <tr><td>None</td></tr>
229 <tr><td>None</td></tr> 226 </table>
230 </table> 227
231 <h3>Methods</h3> 228 <h3>Methods</h3>
232 229 <table>
233 <table>
234
235 <tr> 230 <tr>
236 <td><a href="#ClbrBase.__init__">ClbrBase</a></td> 231 <td><a href="#ClbrBase.__init__">ClbrBase</a></td>
237 <td>Constructor</td> 232 <td>Constructor</td>
238 </tr> 233 </tr>
239 <tr> 234 <tr>
263 <tr> 258 <tr>
264 <td><a href="#ClbrBase._getmethod">_getmethod</a></td> 259 <td><a href="#ClbrBase._getmethod">_getmethod</a></td>
265 <td>Protected method to retrieve a method by name.</td> 260 <td>Protected method to retrieve a method by name.</td>
266 </tr> 261 </tr>
267 </table> 262 </table>
263
268 <h3>Static Methods</h3> 264 <h3>Static Methods</h3>
269 265 <table>
270 <table> 266 <tr><td>None</td></tr>
271 <tr><td>None</td></tr> 267 </table>
272 </table> 268
273 269
274 <a NAME="ClbrBase.__init__" ID="ClbrBase.__init__"></a> 270 <a NAME="ClbrBase.__init__" ID="ClbrBase.__init__"></a>
275 <h4>ClbrBase (Constructor)</h4> 271 <h4>ClbrBase (Constructor)</h4>
276 <b>ClbrBase</b>(<i>module, name, file, lineno</i>) 272 <b>ClbrBase</b>(<i>module, name, file, lineno</i>)
277
278 <p> 273 <p>
279 Constructor 274 Constructor
280 </p> 275 </p>
276
281 <dl> 277 <dl>
282 278
283 <dt><i>module</i> (str)</dt> 279 <dt><i>module</i> (str)</dt>
284 <dd> 280 <dd>
285 name of the module containing this object 281 name of the module containing this object
298 </dd> 294 </dd>
299 </dl> 295 </dl>
300 <a NAME="ClbrBase._addattribute" ID="ClbrBase._addattribute"></a> 296 <a NAME="ClbrBase._addattribute" ID="ClbrBase._addattribute"></a>
301 <h4>ClbrBase._addattribute</h4> 297 <h4>ClbrBase._addattribute</h4>
302 <b>_addattribute</b>(<i>attr</i>) 298 <b>_addattribute</b>(<i>attr</i>)
303
304 <p> 299 <p>
305 Protected method to add information about attributes. 300 Protected method to add information about attributes.
306 </p> 301 </p>
302
307 <dl> 303 <dl>
308 304
309 <dt><i>attr</i> (Attribute)</dt> 305 <dt><i>attr</i> (Attribute)</dt>
310 <dd> 306 <dd>
311 Attribute object to be added 307 Attribute object to be added
312 </dd> 308 </dd>
313 </dl> 309 </dl>
314 <a NAME="ClbrBase._addclass" ID="ClbrBase._addclass"></a> 310 <a NAME="ClbrBase._addclass" ID="ClbrBase._addclass"></a>
315 <h4>ClbrBase._addclass</h4> 311 <h4>ClbrBase._addclass</h4>
316 <b>_addclass</b>(<i>name, _class</i>) 312 <b>_addclass</b>(<i>name, _class</i>)
317
318 <p> 313 <p>
319 Protected method method to add a nested class to this class. 314 Protected method method to add a nested class to this class.
320 </p> 315 </p>
316
321 <dl> 317 <dl>
322 318
323 <dt><i>name</i> (str)</dt> 319 <dt><i>name</i> (str)</dt>
324 <dd> 320 <dd>
325 name of the class 321 name of the class
330 </dd> 326 </dd>
331 </dl> 327 </dl>
332 <a NAME="ClbrBase._addglobal" ID="ClbrBase._addglobal"></a> 328 <a NAME="ClbrBase._addglobal" ID="ClbrBase._addglobal"></a>
333 <h4>ClbrBase._addglobal</h4> 329 <h4>ClbrBase._addglobal</h4>
334 <b>_addglobal</b>(<i>attr</i>) 330 <b>_addglobal</b>(<i>attr</i>)
335
336 <p> 331 <p>
337 Protected method to add information about global variables. 332 Protected method to add information about global variables.
338 </p> 333 </p>
334
339 <dl> 335 <dl>
340 336
341 <dt><i>attr</i> (Attribute)</dt> 337 <dt><i>attr</i> (Attribute)</dt>
342 <dd> 338 <dd>
343 Attribute object to be added 339 Attribute object to be added
344 </dd> 340 </dd>
345 </dl> 341 </dl>
346 <a NAME="ClbrBase._addmethod" ID="ClbrBase._addmethod"></a> 342 <a NAME="ClbrBase._addmethod" ID="ClbrBase._addmethod"></a>
347 <h4>ClbrBase._addmethod</h4> 343 <h4>ClbrBase._addmethod</h4>
348 <b>_addmethod</b>(<i>name, function</i>) 344 <b>_addmethod</b>(<i>name, function</i>)
349
350 <p> 345 <p>
351 Protected method to add information about a method. 346 Protected method to add information about a method.
352 </p> 347 </p>
348
353 <dl> 349 <dl>
354 350
355 <dt><i>name</i> (str)</dt> 351 <dt><i>name</i> (str)</dt>
356 <dd> 352 <dd>
357 name of method to be added 353 name of method to be added
362 </dd> 358 </dd>
363 </dl> 359 </dl>
364 <a NAME="ClbrBase._getattribute" ID="ClbrBase._getattribute"></a> 360 <a NAME="ClbrBase._getattribute" ID="ClbrBase._getattribute"></a>
365 <h4>ClbrBase._getattribute</h4> 361 <h4>ClbrBase._getattribute</h4>
366 <b>_getattribute</b>(<i>name</i>) 362 <b>_getattribute</b>(<i>name</i>)
367
368 <p> 363 <p>
369 Protected method to retrieve an attribute by name. 364 Protected method to retrieve an attribute by name.
370 </p> 365 </p>
366
371 <dl> 367 <dl>
372 368
373 <dt><i>name</i> (str)</dt> 369 <dt><i>name</i> (str)</dt>
374 <dd> 370 <dd>
375 name of the attribute 371 name of the attribute
388 </dd> 384 </dd>
389 </dl> 385 </dl>
390 <a NAME="ClbrBase._getglobal" ID="ClbrBase._getglobal"></a> 386 <a NAME="ClbrBase._getglobal" ID="ClbrBase._getglobal"></a>
391 <h4>ClbrBase._getglobal</h4> 387 <h4>ClbrBase._getglobal</h4>
392 <b>_getglobal</b>(<i>name</i>) 388 <b>_getglobal</b>(<i>name</i>)
393
394 <p> 389 <p>
395 Protected method to retrieve a global variable by name. 390 Protected method to retrieve a global variable by name.
396 </p> 391 </p>
392
397 <dl> 393 <dl>
398 394
399 <dt><i>name</i> (str)</dt> 395 <dt><i>name</i> (str)</dt>
400 <dd> 396 <dd>
401 name of the global variable 397 name of the global variable
414 </dd> 410 </dd>
415 </dl> 411 </dl>
416 <a NAME="ClbrBase._getmethod" ID="ClbrBase._getmethod"></a> 412 <a NAME="ClbrBase._getmethod" ID="ClbrBase._getmethod"></a>
417 <h4>ClbrBase._getmethod</h4> 413 <h4>ClbrBase._getmethod</h4>
418 <b>_getmethod</b>(<i>name</i>) 414 <b>_getmethod</b>(<i>name</i>)
419
420 <p> 415 <p>
421 Protected method to retrieve a method by name. 416 Protected method to retrieve a method by name.
422 </p> 417 </p>
418
423 <dl> 419 <dl>
424 420
425 <dt><i>name</i> (str)</dt> 421 <dt><i>name</i> (str)</dt>
426 <dd> 422 <dd>
427 name of the method (string) 423 name of the method (string)
442 <div align="right"><a href="#top">Up</a></div> 438 <div align="right"><a href="#top">Up</a></div>
443 <hr /> 439 <hr />
444 <hr /> 440 <hr />
445 <a NAME="ClbrVisibilityMixinBase" ID="ClbrVisibilityMixinBase"></a> 441 <a NAME="ClbrVisibilityMixinBase" ID="ClbrVisibilityMixinBase"></a>
446 <h2>ClbrVisibilityMixinBase</h2> 442 <h2>ClbrVisibilityMixinBase</h2>
447
448 <p> 443 <p>
449 Class implementing the base class of all visibility mixins. 444 Class implementing the base class of all visibility mixins.
450 </p> 445 </p>
446
451 <h3>Derived from</h3> 447 <h3>Derived from</h3>
452 None 448 None
453 <h3>Class Attributes</h3> 449 <h3>Class Attributes</h3>
454 450 <table>
455 <table> 451 <tr><td>None</td></tr>
456 <tr><td>None</td></tr> 452 </table>
457 </table> 453
458 <h3>Class Methods</h3> 454 <h3>Class Methods</h3>
459 455 <table>
460 <table> 456 <tr><td>None</td></tr>
461 <tr><td>None</td></tr> 457 </table>
462 </table> 458
463 <h3>Methods</h3> 459 <h3>Methods</h3>
464 460 <table>
465 <table>
466
467 <tr> 461 <tr>
468 <td><a href="#ClbrVisibilityMixinBase.isPrivate">isPrivate</a></td> 462 <td><a href="#ClbrVisibilityMixinBase.isPrivate">isPrivate</a></td>
469 <td>Public method to check, if the visibility is Private.</td> 463 <td>Public method to check, if the visibility is Private.</td>
470 </tr> 464 </tr>
471 <tr> 465 <tr>
487 <tr> 481 <tr>
488 <td><a href="#ClbrVisibilityMixinBase.setPublic">setPublic</a></td> 482 <td><a href="#ClbrVisibilityMixinBase.setPublic">setPublic</a></td>
489 <td>Public method to set the visibility to Public.</td> 483 <td>Public method to set the visibility to Public.</td>
490 </tr> 484 </tr>
491 </table> 485 </table>
486
492 <h3>Static Methods</h3> 487 <h3>Static Methods</h3>
493 488 <table>
494 <table> 489 <tr><td>None</td></tr>
495 <tr><td>None</td></tr> 490 </table>
496 </table> 491
497 492
498 <a NAME="ClbrVisibilityMixinBase.isPrivate" ID="ClbrVisibilityMixinBase.isPrivate"></a> 493 <a NAME="ClbrVisibilityMixinBase.isPrivate" ID="ClbrVisibilityMixinBase.isPrivate"></a>
499 <h4>ClbrVisibilityMixinBase.isPrivate</h4> 494 <h4>ClbrVisibilityMixinBase.isPrivate</h4>
500 <b>isPrivate</b>(<i></i>) 495 <b>isPrivate</b>(<i></i>)
501
502 <p> 496 <p>
503 Public method to check, if the visibility is Private. 497 Public method to check, if the visibility is Private.
504 </p> 498 </p>
499
505 <dl> 500 <dl>
506 <dt>Return:</dt> 501 <dt>Return:</dt>
507 <dd> 502 <dd>
508 flag indicating Private visibility 503 flag indicating Private visibility
509 </dd> 504 </dd>
515 </dd> 510 </dd>
516 </dl> 511 </dl>
517 <a NAME="ClbrVisibilityMixinBase.isProtected" ID="ClbrVisibilityMixinBase.isProtected"></a> 512 <a NAME="ClbrVisibilityMixinBase.isProtected" ID="ClbrVisibilityMixinBase.isProtected"></a>
518 <h4>ClbrVisibilityMixinBase.isProtected</h4> 513 <h4>ClbrVisibilityMixinBase.isProtected</h4>
519 <b>isProtected</b>(<i></i>) 514 <b>isProtected</b>(<i></i>)
520
521 <p> 515 <p>
522 Public method to check, if the visibility is Protected. 516 Public method to check, if the visibility is Protected.
523 </p> 517 </p>
518
524 <dl> 519 <dl>
525 <dt>Return:</dt> 520 <dt>Return:</dt>
526 <dd> 521 <dd>
527 flag indicating Protected visibility 522 flag indicating Protected visibility
528 </dd> 523 </dd>
534 </dd> 529 </dd>
535 </dl> 530 </dl>
536 <a NAME="ClbrVisibilityMixinBase.isPublic" ID="ClbrVisibilityMixinBase.isPublic"></a> 531 <a NAME="ClbrVisibilityMixinBase.isPublic" ID="ClbrVisibilityMixinBase.isPublic"></a>
537 <h4>ClbrVisibilityMixinBase.isPublic</h4> 532 <h4>ClbrVisibilityMixinBase.isPublic</h4>
538 <b>isPublic</b>(<i></i>) 533 <b>isPublic</b>(<i></i>)
539
540 <p> 534 <p>
541 Public method to check, if the visibility is Public. 535 Public method to check, if the visibility is Public.
542 </p> 536 </p>
537
543 <dl> 538 <dl>
544 <dt>Return:</dt> 539 <dt>Return:</dt>
545 <dd> 540 <dd>
546 flag indicating Public visibility 541 flag indicating Public visibility
547 </dd> 542 </dd>
553 </dd> 548 </dd>
554 </dl> 549 </dl>
555 <a NAME="ClbrVisibilityMixinBase.setPrivate" ID="ClbrVisibilityMixinBase.setPrivate"></a> 550 <a NAME="ClbrVisibilityMixinBase.setPrivate" ID="ClbrVisibilityMixinBase.setPrivate"></a>
556 <h4>ClbrVisibilityMixinBase.setPrivate</h4> 551 <h4>ClbrVisibilityMixinBase.setPrivate</h4>
557 <b>setPrivate</b>(<i></i>) 552 <b>setPrivate</b>(<i></i>)
558
559 <p> 553 <p>
560 Public method to set the visibility to Private. 554 Public method to set the visibility to Private.
561 </p> 555 </p>
556
562 <a NAME="ClbrVisibilityMixinBase.setProtected" ID="ClbrVisibilityMixinBase.setProtected"></a> 557 <a NAME="ClbrVisibilityMixinBase.setProtected" ID="ClbrVisibilityMixinBase.setProtected"></a>
563 <h4>ClbrVisibilityMixinBase.setProtected</h4> 558 <h4>ClbrVisibilityMixinBase.setProtected</h4>
564 <b>setProtected</b>(<i></i>) 559 <b>setProtected</b>(<i></i>)
565
566 <p> 560 <p>
567 Public method to set the visibility to Protected. 561 Public method to set the visibility to Protected.
568 </p> 562 </p>
563
569 <a NAME="ClbrVisibilityMixinBase.setPublic" ID="ClbrVisibilityMixinBase.setPublic"></a> 564 <a NAME="ClbrVisibilityMixinBase.setPublic" ID="ClbrVisibilityMixinBase.setPublic"></a>
570 <h4>ClbrVisibilityMixinBase.setPublic</h4> 565 <h4>ClbrVisibilityMixinBase.setPublic</h4>
571 <b>setPublic</b>(<i></i>) 566 <b>setPublic</b>(<i></i>)
572
573 <p> 567 <p>
574 Public method to set the visibility to Public. 568 Public method to set the visibility to Public.
575 </p> 569 </p>
570
576 <div align="right"><a href="#top">Up</a></div> 571 <div align="right"><a href="#top">Up</a></div>
577 <hr /> 572 <hr />
578 <hr /> 573 <hr />
579 <a NAME="Coding" ID="Coding"></a> 574 <a NAME="Coding" ID="Coding"></a>
580 <h2>Coding</h2> 575 <h2>Coding</h2>
581
582 <p> 576 <p>
583 Class to represent a source coding. 577 Class to represent a source coding.
584 </p> 578 </p>
579
585 <h3>Derived from</h3> 580 <h3>Derived from</h3>
586 ClbrBase 581 ClbrBase
587 <h3>Class Attributes</h3> 582 <h3>Class Attributes</h3>
588 583 <table>
589 <table> 584 <tr><td>None</td></tr>
590 <tr><td>None</td></tr> 585 </table>
591 </table> 586
592 <h3>Class Methods</h3> 587 <h3>Class Methods</h3>
593 588 <table>
594 <table> 589 <tr><td>None</td></tr>
595 <tr><td>None</td></tr> 590 </table>
596 </table> 591
597 <h3>Methods</h3> 592 <h3>Methods</h3>
598 593 <table>
599 <table>
600
601 <tr> 594 <tr>
602 <td><a href="#Coding.__init__">Coding</a></td> 595 <td><a href="#Coding.__init__">Coding</a></td>
603 <td>Constructor</td> 596 <td>Constructor</td>
604 </tr> 597 </tr>
605 </table> 598 </table>
599
606 <h3>Static Methods</h3> 600 <h3>Static Methods</h3>
607 601 <table>
608 <table> 602 <tr><td>None</td></tr>
609 <tr><td>None</td></tr> 603 </table>
610 </table> 604
611 605
612 <a NAME="Coding.__init__" ID="Coding.__init__"></a> 606 <a NAME="Coding.__init__" ID="Coding.__init__"></a>
613 <h4>Coding (Constructor)</h4> 607 <h4>Coding (Constructor)</h4>
614 <b>Coding</b>(<i>module, file, lineno, coding</i>) 608 <b>Coding</b>(<i>module, file, lineno, coding</i>)
615
616 <p> 609 <p>
617 Constructor 610 Constructor
618 </p> 611 </p>
612
619 <dl> 613 <dl>
620 614
621 <dt><i>module</i> (str)</dt> 615 <dt><i>module</i> (str)</dt>
622 <dd> 616 <dd>
623 name of the module containing this coding statement 617 name of the module containing this coding statement
638 <div align="right"><a href="#top">Up</a></div> 632 <div align="right"><a href="#top">Up</a></div>
639 <hr /> 633 <hr />
640 <hr /> 634 <hr />
641 <a NAME="Enum" ID="Enum"></a> 635 <a NAME="Enum" ID="Enum"></a>
642 <h2>Enum</h2> 636 <h2>Enum</h2>
643
644 <p> 637 <p>
645 Class to represent an enum definition. 638 Class to represent an enum definition.
646 </p> 639 </p>
640
647 <h3>Derived from</h3> 641 <h3>Derived from</h3>
648 ClbrBase 642 ClbrBase
649 <h3>Class Attributes</h3> 643 <h3>Class Attributes</h3>
650 644 <table>
651 <table> 645 <tr><td>None</td></tr>
652 <tr><td>None</td></tr> 646 </table>
653 </table> 647
654 <h3>Class Methods</h3> 648 <h3>Class Methods</h3>
655 649 <table>
656 <table> 650 <tr><td>None</td></tr>
657 <tr><td>None</td></tr> 651 </table>
658 </table> 652
659 <h3>Methods</h3> 653 <h3>Methods</h3>
660 654 <table>
661 <table>
662
663 <tr> 655 <tr>
664 <td><a href="#Enum.__init__">Enum</a></td> 656 <td><a href="#Enum.__init__">Enum</a></td>
665 <td>Constructor</td> 657 <td>Constructor</td>
666 </tr> 658 </tr>
667 </table> 659 </table>
660
668 <h3>Static Methods</h3> 661 <h3>Static Methods</h3>
669 662 <table>
670 <table> 663 <tr><td>None</td></tr>
671 <tr><td>None</td></tr> 664 </table>
672 </table> 665
673 666
674 <a NAME="Enum.__init__" ID="Enum.__init__"></a> 667 <a NAME="Enum.__init__" ID="Enum.__init__"></a>
675 <h4>Enum (Constructor)</h4> 668 <h4>Enum (Constructor)</h4>
676 <b>Enum</b>(<i>module, name, file, lineno</i>) 669 <b>Enum</b>(<i>module, name, file, lineno</i>)
677
678 <p> 670 <p>
679 Constructor 671 Constructor
680 </p> 672 </p>
673
681 <dl> 674 <dl>
682 675
683 <dt><i>module</i> (str)</dt> 676 <dt><i>module</i> (str)</dt>
684 <dd> 677 <dd>
685 name of the module containing this enum 678 name of the module containing this enum
700 <div align="right"><a href="#top">Up</a></div> 693 <div align="right"><a href="#top">Up</a></div>
701 <hr /> 694 <hr />
702 <hr /> 695 <hr />
703 <a NAME="Function" ID="Function"></a> 696 <a NAME="Function" ID="Function"></a>
704 <h2>Function</h2> 697 <h2>Function</h2>
705
706 <p> 698 <p>
707 Class to represent a function or method. 699 Class to represent a function or method.
708 </p> 700 </p>
701
709 <h3>Derived from</h3> 702 <h3>Derived from</h3>
710 ClbrBase 703 ClbrBase
711 <h3>Class Attributes</h3> 704 <h3>Class Attributes</h3>
712 705 <table>
713 <table> 706 <tr><td>Class</td></tr>
714 <tr><td>Class</td></tr><tr><td>General</td></tr><tr><td>Static</td></tr> 707 <tr><td>General</td></tr>
715 </table> 708 <tr><td>Static</td></tr>
709 </table>
710
716 <h3>Class Methods</h3> 711 <h3>Class Methods</h3>
717 712 <table>
718 <table> 713 <tr><td>None</td></tr>
719 <tr><td>None</td></tr> 714 </table>
720 </table> 715
721 <h3>Methods</h3> 716 <h3>Methods</h3>
722 717 <table>
723 <table>
724
725 <tr> 718 <tr>
726 <td><a href="#Function.__init__">Function</a></td> 719 <td><a href="#Function.__init__">Function</a></td>
727 <td>Constructor</td> 720 <td>Constructor</td>
728 </tr> 721 </tr>
729 </table> 722 </table>
723
730 <h3>Static Methods</h3> 724 <h3>Static Methods</h3>
731 725 <table>
732 <table> 726 <tr><td>None</td></tr>
733 <tr><td>None</td></tr> 727 </table>
734 </table> 728
735 729
736 <a NAME="Function.__init__" ID="Function.__init__"></a> 730 <a NAME="Function.__init__" ID="Function.__init__"></a>
737 <h4>Function (Constructor)</h4> 731 <h4>Function (Constructor)</h4>
738 <b>Function</b>(<i>module, name, file, lineno, signature="", separator=", ", modifierType=General, annotation="", </i>) 732 <b>Function</b>(<i>module, name, file, lineno, signature="", separator=", ", modifierType=General, annotation="", </i>)
739
740 <p> 733 <p>
741 Constructor 734 Constructor
742 </p> 735 </p>
736
743 <dl> 737 <dl>
744 738
745 <dt><i>module</i> (str)</dt> 739 <dt><i>module</i> (str)</dt>
746 <dd> 740 <dd>
747 name of the module containing this function 741 name of the module containing this function
778 <div align="right"><a href="#top">Up</a></div> 772 <div align="right"><a href="#top">Up</a></div>
779 <hr /> 773 <hr />
780 <hr /> 774 <hr />
781 <a NAME="Module" ID="Module"></a> 775 <a NAME="Module" ID="Module"></a>
782 <h2>Module</h2> 776 <h2>Module</h2>
783
784 <p> 777 <p>
785 Class to represent a module. 778 Class to represent a module.
786 </p> 779 </p>
780
787 <h3>Derived from</h3> 781 <h3>Derived from</h3>
788 ClbrBase 782 ClbrBase
789 <h3>Class Attributes</h3> 783 <h3>Class Attributes</h3>
790 784 <table>
791 <table> 785 <tr><td>None</td></tr>
792 <tr><td>None</td></tr> 786 </table>
793 </table> 787
794 <h3>Class Methods</h3> 788 <h3>Class Methods</h3>
795 789 <table>
796 <table> 790 <tr><td>None</td></tr>
797 <tr><td>None</td></tr> 791 </table>
798 </table> 792
799 <h3>Methods</h3> 793 <h3>Methods</h3>
800 794 <table>
801 <table>
802
803 <tr> 795 <tr>
804 <td><a href="#Module.__init__">Module</a></td> 796 <td><a href="#Module.__init__">Module</a></td>
805 <td>Constructor</td> 797 <td>Constructor</td>
806 </tr> 798 </tr>
807 </table> 799 </table>
800
808 <h3>Static Methods</h3> 801 <h3>Static Methods</h3>
809 802 <table>
810 <table> 803 <tr><td>None</td></tr>
811 <tr><td>None</td></tr> 804 </table>
812 </table> 805
813 806
814 <a NAME="Module.__init__" ID="Module.__init__"></a> 807 <a NAME="Module.__init__" ID="Module.__init__"></a>
815 <h4>Module (Constructor)</h4> 808 <h4>Module (Constructor)</h4>
816 <b>Module</b>(<i>module, name, file, lineno</i>) 809 <b>Module</b>(<i>module, name, file, lineno</i>)
817
818 <p> 810 <p>
819 Constructor 811 Constructor
820 </p> 812 </p>
813
821 <dl> 814 <dl>
822 815
823 <dt><i>module</i> (str)</dt> 816 <dt><i>module</i> (str)</dt>
824 <dd> 817 <dd>
825 name of the module containing this module 818 name of the module containing this module
840 <div align="right"><a href="#top">Up</a></div> 833 <div align="right"><a href="#top">Up</a></div>
841 <hr /> 834 <hr />
842 <hr /> 835 <hr />
843 <a NAME="_ClbrBase" ID="_ClbrBase"></a> 836 <a NAME="_ClbrBase" ID="_ClbrBase"></a>
844 <h2>_ClbrBase</h2> 837 <h2>_ClbrBase</h2>
845
846 <p> 838 <p>
847 Class implementing the base of all class browser objects. 839 Class implementing the base of all class browser objects.
848 </p> 840 </p>
841
849 <h3>Derived from</h3> 842 <h3>Derived from</h3>
850 None 843 None
851 <h3>Class Attributes</h3> 844 <h3>Class Attributes</h3>
852 845 <table>
853 <table> 846 <tr><td>None</td></tr>
854 <tr><td>None</td></tr> 847 </table>
855 </table> 848
856 <h3>Class Methods</h3> 849 <h3>Class Methods</h3>
857 850 <table>
858 <table> 851 <tr><td>None</td></tr>
859 <tr><td>None</td></tr> 852 </table>
860 </table> 853
861 <h3>Methods</h3> 854 <h3>Methods</h3>
862 855 <table>
863 <table>
864
865 <tr> 856 <tr>
866 <td><a href="#_ClbrBase.__init__">_ClbrBase</a></td> 857 <td><a href="#_ClbrBase.__init__">_ClbrBase</a></td>
867 <td>Constructor</td> 858 <td>Constructor</td>
868 </tr> 859 </tr>
869 <tr> 860 <tr>
870 <td><a href="#_ClbrBase.setEndLine">setEndLine</a></td> 861 <td><a href="#_ClbrBase.setEndLine">setEndLine</a></td>
871 <td>Public method to set the ending line number.</td> 862 <td>Public method to set the ending line number.</td>
872 </tr> 863 </tr>
873 </table> 864 </table>
865
874 <h3>Static Methods</h3> 866 <h3>Static Methods</h3>
875 867 <table>
876 <table> 868 <tr><td>None</td></tr>
877 <tr><td>None</td></tr> 869 </table>
878 </table> 870
879 871
880 <a NAME="_ClbrBase.__init__" ID="_ClbrBase.__init__"></a> 872 <a NAME="_ClbrBase.__init__" ID="_ClbrBase.__init__"></a>
881 <h4>_ClbrBase (Constructor)</h4> 873 <h4>_ClbrBase (Constructor)</h4>
882 <b>_ClbrBase</b>(<i>module, name, file, lineno</i>) 874 <b>_ClbrBase</b>(<i>module, name, file, lineno</i>)
883
884 <p> 875 <p>
885 Constructor 876 Constructor
886 </p> 877 </p>
878
887 <dl> 879 <dl>
888 880
889 <dt><i>module</i> (str)</dt> 881 <dt><i>module</i> (str)</dt>
890 <dd> 882 <dd>
891 name of the module containing this object 883 name of the module containing this object
904 </dd> 896 </dd>
905 </dl> 897 </dl>
906 <a NAME="_ClbrBase.setEndLine" ID="_ClbrBase.setEndLine"></a> 898 <a NAME="_ClbrBase.setEndLine" ID="_ClbrBase.setEndLine"></a>
907 <h4>_ClbrBase.setEndLine</h4> 899 <h4>_ClbrBase.setEndLine</h4>
908 <b>setEndLine</b>(<i>endLineNo</i>) 900 <b>setEndLine</b>(<i>endLineNo</i>)
909
910 <p> 901 <p>
911 Public method to set the ending line number. 902 Public method to set the ending line number.
912 </p> 903 </p>
904
913 <dl> 905 <dl>
914 906
915 <dt><i>endLineNo</i> (int)</dt> 907 <dt><i>endLineNo</i> (int)</dt>
916 <dd> 908 <dd>
917 number of the last line 909 number of the last line

Mercurial Repository: eric

eric ide

mercurial