Mercurial Repositories > eric / file revision
Documentation/Source/eric5.Utilities.ClassBrowsers.ClbrBaseClasses.html@edde1fe80b3e
Documentation/Source/eric5.Utilities.ClassBrowsers.ClbrBaseClasses.html
Sat, 02 Jan 2010 18:19:35 +0000
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Sat, 02 Jan 2010 18:19:35 +0000
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
- permissions
- -rw-r--r--
Updated documentation.
<?xml version="1.0" encoding="utf-8"?> <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> <html><head> <title>eric5.Utilities.ClassBrowsers.ClbrBaseClasses</title> <style> 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' </style> </head> <body><a NAME="top" ID="top"></a> <h1>eric5.Utilities.ClassBrowsers.ClbrBaseClasses</h1> <p> Module implementing base classes used by the various class browsers. </p> <h3>Global Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> <table> <tr> <td><a href="#Attribute">Attribute</a></td> <td>Class to represent an attribute.</td> </tr><tr> <td><a href="#Class">Class</a></td> <td>Class to represent a class.</td> </tr><tr> <td><a href="#ClbrBase">ClbrBase</a></td> <td>Class implementing the base of all complex class browser objects.</td> </tr><tr> <td><a href="#ClbrVisibilityMixinBase">ClbrVisibilityMixinBase</a></td> <td>Class implementing the base class of all visibility mixins.</td> </tr><tr> <td><a href="#Coding">Coding</a></td> <td>Class to represent a source coding.</td> </tr><tr> <td><a href="#Function">Function</a></td> <td>Class to represent a function or method.</td> </tr><tr> <td><a href="#Module">Module</a></td> <td>Class to represent a module.</td> </tr><tr> <td><a href="#_ClbrBase">_ClbrBase</a></td> <td>Class implementing the base of all class browser objects.</td> </tr> </table> <h3>Functions</h3> <table> <tr><td>None</td></tr> </table> <hr /><hr /> <a NAME="Attribute" ID="Attribute"></a> <h2>Attribute</h2> <p> Class to represent an attribute. </p> <h3>Derived from</h3> _ClbrBase <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Attribute.__init__">Attribute</a></td> <td>Constructor</td> </tr> </table> <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> <h4>Attribute (Constructor)</h4> <b>Attribute</b>(<i>module, name, file, lineno</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this class </dd><dt><i>name</i></dt> <dd> name of this class </dd><dt><i>file</i></dt> <dd> filename containing this attribute </dd><dt><i>lineno</i></dt> <dd> linenumber of the class definition </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="Class" ID="Class"></a> <h2>Class</h2> <p> Class to represent a class. </p> <h3>Derived from</h3> ClbrBase <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Class.__init__">Class</a></td> <td>Constructor</td> </tr> </table> <a NAME="Class.__init__" ID="Class.__init__"></a> <h4>Class (Constructor)</h4> <b>Class</b>(<i>module, name, super, file, lineno</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this class </dd><dt><i>name</i></dt> <dd> name of this class </dd><dt><i>super</i></dt> <dd> list of class names this class is inherited from </dd><dt><i>file</i></dt> <dd> filename containing this class </dd><dt><i>lineno</i></dt> <dd> linenumber of the class definition </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="ClbrBase" ID="ClbrBase"></a> <h2>ClbrBase</h2> <p> Class implementing the base of all complex class browser objects. </p> <h3>Derived from</h3> _ClbrBase <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#ClbrBase.__init__">ClbrBase</a></td> <td>Constructor</td> </tr><tr> <td><a href="#ClbrBase._addattribute">_addattribute</a></td> <td>Protected method to add information about attributes.</td> </tr><tr> <td><a href="#ClbrBase._addclass">_addclass</a></td> <td>Protected method method to add a nested class to this class.</td> </tr><tr> <td><a href="#ClbrBase._addglobal">_addglobal</a></td> <td>Protected method to add information about global variables.</td> </tr><tr> <td><a href="#ClbrBase._addmethod">_addmethod</a></td> <td>Protected method to add information about a method.</td> </tr><tr> <td><a href="#ClbrBase._getattribute">_getattribute</a></td> <td>Protected method to retrieve an attribute by name.</td> </tr><tr> <td><a href="#ClbrBase._getglobal">_getglobal</a></td> <td>Protected method to retrieve a global variable by name.</td> </tr><tr> <td><a href="#ClbrBase._getmethod">_getmethod</a></td> <td>Protected method to retrieve a method by name.</td> </tr> </table> <a NAME="ClbrBase.__init__" ID="ClbrBase.__init__"></a> <h4>ClbrBase (Constructor)</h4> <b>ClbrBase</b>(<i>module, name, file, lineno</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this class </dd><dt><i>name</i></dt> <dd> name of this class </dd><dt><i>file</i></dt> <dd> filename containing this object </dd><dt><i>lineno</i></dt> <dd> linenumber of the class definition </dd> </dl><a NAME="ClbrBase._addattribute" ID="ClbrBase._addattribute"></a> <h4>ClbrBase._addattribute</h4> <b>_addattribute</b>(<i>attr</i>) <p> Protected method to add information about attributes. </p><dl> <dt><i>attr</i></dt> <dd> Attribute object to be added (Attribute) </dd> </dl><a NAME="ClbrBase._addclass" ID="ClbrBase._addclass"></a> <h4>ClbrBase._addclass</h4> <b>_addclass</b>(<i>name, _class</i>) <p> Protected method method to add a nested class to this class. </p><dl> <dt><i>name</i></dt> <dd> name of the class </dd><dt><i>_class</i></dt> <dd> Class object to be added (Class) </dd> </dl><a NAME="ClbrBase._addglobal" ID="ClbrBase._addglobal"></a> <h4>ClbrBase._addglobal</h4> <b>_addglobal</b>(<i>attr</i>) <p> Protected method to add information about global variables. </p><dl> <dt><i>attr</i></dt> <dd> Attribute object to be added (Attribute) </dd> </dl><a NAME="ClbrBase._addmethod" ID="ClbrBase._addmethod"></a> <h4>ClbrBase._addmethod</h4> <b>_addmethod</b>(<i>name, function</i>) <p> Protected method to add information about a method. </p><dl> <dt><i>name</i></dt> <dd> name of method to be added (string) </dd><dt><i>function</i></dt> <dd> Function object to be added </dd> </dl><a NAME="ClbrBase._getattribute" ID="ClbrBase._getattribute"></a> <h4>ClbrBase._getattribute</h4> <b>_getattribute</b>(<i>name</i>) <p> Protected method to retrieve an attribute by name. </p><dl> <dt><i>name</i></dt> <dd> name of the attribute (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> the named attribute or None </dd> </dl><a NAME="ClbrBase._getglobal" ID="ClbrBase._getglobal"></a> <h4>ClbrBase._getglobal</h4> <b>_getglobal</b>(<i>name</i>) <p> Protected method to retrieve a global variable by name. </p><dl> <dt><i>name</i></dt> <dd> name of the global variable (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> the named global variable or None </dd> </dl><a NAME="ClbrBase._getmethod" ID="ClbrBase._getmethod"></a> <h4>ClbrBase._getmethod</h4> <b>_getmethod</b>(<i>name</i>) <p> Protected method to retrieve a method by name. </p><dl> <dt><i>name</i></dt> <dd> name of the method (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> the named method or None </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="ClbrVisibilityMixinBase" ID="ClbrVisibilityMixinBase"></a> <h2>ClbrVisibilityMixinBase</h2> <p> Class implementing the base class of all visibility mixins. </p> <h3>Derived from</h3> object <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#ClbrVisibilityMixinBase.isPrivate">isPrivate</a></td> <td>Public method to check, if the visibility is Private.</td> </tr><tr> <td><a href="#ClbrVisibilityMixinBase.isProtected">isProtected</a></td> <td>Public method to check, if the visibility is Protected.</td> </tr><tr> <td><a href="#ClbrVisibilityMixinBase.isPublic">isPublic</a></td> <td>Public method to check, if the visibility is Public.</td> </tr><tr> <td><a href="#ClbrVisibilityMixinBase.setPrivate">setPrivate</a></td> <td>Public method to set the visibility to Private.</td> </tr><tr> <td><a href="#ClbrVisibilityMixinBase.setProtected">setProtected</a></td> <td>Public method to set the visibility to Protected.</td> </tr><tr> <td><a href="#ClbrVisibilityMixinBase.setPublic">setPublic</a></td> <td>Public method to set the visibility to Public.</td> </tr> </table> <a NAME="ClbrVisibilityMixinBase.isPrivate" ID="ClbrVisibilityMixinBase.isPrivate"></a> <h4>ClbrVisibilityMixinBase.isPrivate</h4> <b>isPrivate</b>(<i></i>) <p> Public method to check, if the visibility is Private. </p><dl> <dt>Returns:</dt> <dd> flag indicating Private visibility (boolean) </dd> </dl><a NAME="ClbrVisibilityMixinBase.isProtected" ID="ClbrVisibilityMixinBase.isProtected"></a> <h4>ClbrVisibilityMixinBase.isProtected</h4> <b>isProtected</b>(<i></i>) <p> Public method to check, if the visibility is Protected. </p><dl> <dt>Returns:</dt> <dd> flag indicating Protected visibility (boolean) </dd> </dl><a NAME="ClbrVisibilityMixinBase.isPublic" ID="ClbrVisibilityMixinBase.isPublic"></a> <h4>ClbrVisibilityMixinBase.isPublic</h4> <b>isPublic</b>(<i></i>) <p> Public method to check, if the visibility is Public. </p><dl> <dt>Returns:</dt> <dd> flag indicating Public visibility (boolean) </dd> </dl><a NAME="ClbrVisibilityMixinBase.setPrivate" ID="ClbrVisibilityMixinBase.setPrivate"></a> <h4>ClbrVisibilityMixinBase.setPrivate</h4> <b>setPrivate</b>(<i></i>) <p> Public method to set the visibility to Private. </p><a NAME="ClbrVisibilityMixinBase.setProtected" ID="ClbrVisibilityMixinBase.setProtected"></a> <h4>ClbrVisibilityMixinBase.setProtected</h4> <b>setProtected</b>(<i></i>) <p> Public method to set the visibility to Protected. </p><a NAME="ClbrVisibilityMixinBase.setPublic" ID="ClbrVisibilityMixinBase.setPublic"></a> <h4>ClbrVisibilityMixinBase.setPublic</h4> <b>setPublic</b>(<i></i>) <p> Public method to set the visibility to Public. </p> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="Coding" ID="Coding"></a> <h2>Coding</h2> <p> Class to represent a source coding. </p> <h3>Derived from</h3> ClbrBase <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Coding.__init__">Coding</a></td> <td>Constructor</td> </tr> </table> <a NAME="Coding.__init__" ID="Coding.__init__"></a> <h4>Coding (Constructor)</h4> <b>Coding</b>(<i>module, file, lineno, coding</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this module </dd><dt><i>file</i></dt> <dd> filename containing this module </dd><dt><i>lineno</i></dt> <dd> linenumber of the module definition </dd><dt><i>coding</i></dt> <dd> character coding of the source file </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="Function" ID="Function"></a> <h2>Function</h2> <p> Class to represent a function or method. </p> <h3>Derived from</h3> ClbrBase <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Function.__init__">Function</a></td> <td>Constructor</td> </tr> </table> <a NAME="Function.__init__" ID="Function.__init__"></a> <h4>Function (Constructor)</h4> <b>Function</b>(<i>module, name, file, lineno, signature = '', separator = ', '</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this function </dd><dt><i>name</i></dt> <dd> name of this function </dd><dt><i>file</i></dt> <dd> filename containing this class </dd><dt><i>lineno</i></dt> <dd> linenumber of the class definition </dd><dt><i>signature</i></dt> <dd> parameterlist of the method </dd><dt><i>separator</i></dt> <dd> string separating the parameters </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="Module" ID="Module"></a> <h2>Module</h2> <p> Class to represent a module. </p> <h3>Derived from</h3> ClbrBase <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#Module.__init__">Module</a></td> <td>Constructor</td> </tr> </table> <a NAME="Module.__init__" ID="Module.__init__"></a> <h4>Module (Constructor)</h4> <b>Module</b>(<i>module, name, file, lineno</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this module </dd><dt><i>name</i></dt> <dd> name of this module </dd><dt><i>file</i></dt> <dd> filename containing this module </dd><dt><i>lineno</i></dt> <dd> linenumber of the module definition </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /><hr /> <a NAME="_ClbrBase" ID="_ClbrBase"></a> <h2>_ClbrBase</h2> <p> Class implementing the base of all class browser objects. </p> <h3>Derived from</h3> object <h3>Class Attributes</h3> <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> <table> <tr> <td><a href="#_ClbrBase.__init__">_ClbrBase</a></td> <td>Constructor</td> </tr> </table> <a NAME="_ClbrBase.__init__" ID="_ClbrBase.__init__"></a> <h4>_ClbrBase (Constructor)</h4> <b>_ClbrBase</b>(<i>module, name, file, lineno</i>) <p> Constructor </p><dl> <dt><i>module</i></dt> <dd> name of the module containing this class </dd><dt><i>name</i></dt> <dd> name of this class </dd><dt><i>file</i></dt> <dd> filename containing this object </dd><dt><i>lineno</i></dt> <dd> linenumber of the class definition </dd> </dl> <div align="right"><a href="#top">Up</a></div> <hr /> </body></html>
