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