--- a/Documentation/Source/eric5.Graphics.PackageDiagram.html Thu Jan 14 17:27:31 2010 +0000 +++ b/Documentation/Source/eric5.Graphics.PackageDiagram.html Thu Jan 14 18:35:52 2010 +0000 @@ -22,7 +22,7 @@ <body><a NAME="top" ID="top"></a> <h1>eric5.Graphics.PackageDiagram</h1> <p> -Module implementing a dialog showing a UML like class diagram of a package. +Module implementing a dialog showing a UML like class diagram of a package. </p> <h3>Global Attributes</h3> <table> @@ -32,7 +32,7 @@ <table> <tr> <td><a href="#PackageDiagram">PackageDiagram</a></td> -<td>Class implementing a dialog showing a UML like class diagram of a package.</td> +<td>Class implementing a dialog showing a UML like class diagram of a package.</td> </tr> </table> <h3>Functions</h3> @@ -43,7 +43,7 @@ <a NAME="PackageDiagram" ID="PackageDiagram"></a> <h2>PackageDiagram</h2> <p> - Class implementing a dialog showing a UML like class diagram of a package. + Class implementing a dialog showing a UML like class diagram of a package. </p> <h3>Derived from</h3> UMLDialog @@ -55,155 +55,155 @@ <table> <tr> <td><a href="#PackageDiagram.__init__">PackageDiagram</a></td> -<td>Constructor</td> +<td>Constructor</td> </tr><tr> <td><a href="#PackageDiagram.__addExternalClass">__addExternalClass</a></td> -<td>Private method to add a class defined outside the module.</td> +<td>Private method to add a class defined outside the module.</td> </tr><tr> <td><a href="#PackageDiagram.__addLocalClass">__addLocalClass</a></td> -<td>Private method to add a class defined in the module.</td> +<td>Private method to add a class defined in the module.</td> </tr><tr> <td><a href="#PackageDiagram.__arrangeClasses">__arrangeClasses</a></td> -<td>Private method to arrange the shapes on the canvas.</td> +<td>Private method to arrange the shapes on the canvas.</td> </tr><tr> <td><a href="#PackageDiagram.__buildClasses">__buildClasses</a></td> -<td>Private method to build the class shapes of the package diagram.</td> +<td>Private method to build the class shapes of the package diagram.</td> </tr><tr> <td><a href="#PackageDiagram.__buildModulesDict">__buildModulesDict</a></td> -<td>Private method to build a dictionary of modules contained in the package.</td> +<td>Private method to build a dictionary of modules contained in the package.</td> </tr><tr> <td><a href="#PackageDiagram.__createAssociations">__createAssociations</a></td> -<td>Private method to generate the associations between the class shapes.</td> +<td>Private method to generate the associations between the class shapes.</td> </tr><tr> <td><a href="#PackageDiagram.__getCurrentShape">__getCurrentShape</a></td> -<td>Private method to get the named shape.</td> +<td>Private method to get the named shape.</td> </tr><tr> <td><a href="#PackageDiagram.relayout">relayout</a></td> -<td>Method to relayout the diagram.</td> +<td>Method to relayout the diagram.</td> </tr><tr> <td><a href="#PackageDiagram.show">show</a></td> -<td>Overriden method to show the dialog.</td> +<td>Overriden method to show the dialog.</td> </tr> </table> <a NAME="PackageDiagram.__init__" ID="PackageDiagram.__init__"></a> <h4>PackageDiagram (Constructor)</h4> <b>PackageDiagram</b>(<i>package, parent = None, name = None, noAttrs = False</i>) <p> - Constructor + Constructor </p><dl> <dt><i>package</i></dt> <dd> -name of a python package to be shown (string) +name of a python package to be shown (string) </dd><dt><i>parent</i></dt> <dd> -parent widget of the view (QWidget) +parent widget of the view (QWidget) </dd><dt><i>name</i></dt> <dd> -name of the view widget (string) +name of the view widget (string) </dd><dt><i>noAttrs=</i></dt> <dd> -flag indicating, that no attributes should be shown (boolean) +flag indicating, that no attributes should be shown (boolean) </dd> </dl><a NAME="PackageDiagram.__addExternalClass" ID="PackageDiagram.__addExternalClass"></a> <h4>PackageDiagram.__addExternalClass</h4> <b>__addExternalClass</b>(<i>_class, x, y</i>) <p> - Private method to add a class defined outside the module. + Private method to add a class defined outside the module. </p><p> - If the canvas is too small to take the shape, it - is enlarged. + If the canvas is too small to take the shape, it + is enlarged. </p><dl> <dt><i>_class</i></dt> <dd> -class to be shown (string) +class to be shown (string) </dd><dt><i>x</i></dt> <dd> -x-coordinate (float) +x-coordinate (float) </dd><dt><i>y</i></dt> <dd> -y-coordinate (float) +y-coordinate (float) </dd> </dl><a NAME="PackageDiagram.__addLocalClass" ID="PackageDiagram.__addLocalClass"></a> <h4>PackageDiagram.__addLocalClass</h4> <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule = False</i>) <p> - Private method to add a class defined in the module. + Private method to add a class defined in the module. </p><dl> <dt><i>className</i></dt> <dd> -name of the class to be as a dictionary key (string) +name of the class to be as a dictionary key (string) </dd><dt><i>_class</i></dt> <dd> -class to be shown (ModuleParser.Class) +class to be shown (ModuleParser.Class) </dd><dt><i>x</i></dt> <dd> -x-coordinate (float) +x-coordinate (float) </dd><dt><i>y</i></dt> <dd> -y-coordinate (float) +y-coordinate (float) </dd><dt><i>isRbModule</i></dt> <dd> -flag indicating a Ruby module (boolean) +flag indicating a Ruby module (boolean) </dd> </dl><a NAME="PackageDiagram.__arrangeClasses" ID="PackageDiagram.__arrangeClasses"></a> <h4>PackageDiagram.__arrangeClasses</h4> <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor = 1.2</i>) <p> - Private method to arrange the shapes on the canvas. + Private method to arrange the shapes on the canvas. </p><p> - The algorithm is borrowed from Boa Constructor. + The algorithm is borrowed from Boa Constructor. </p><a NAME="PackageDiagram.__buildClasses" ID="PackageDiagram.__buildClasses"></a> <h4>PackageDiagram.__buildClasses</h4> <b>__buildClasses</b>(<i></i>) <p> - Private method to build the class shapes of the package diagram. + Private method to build the class shapes of the package diagram. </p><p> - The algorithm is borrowed from Boa Constructor. + The algorithm is borrowed from Boa Constructor. </p><a NAME="PackageDiagram.__buildModulesDict" ID="PackageDiagram.__buildModulesDict"></a> <h4>PackageDiagram.__buildModulesDict</h4> <b>__buildModulesDict</b>(<i></i>) <p> - Private method to build a dictionary of modules contained in the package. + Private method to build a dictionary of modules contained in the package. </p><dl> <dt>Returns:</dt> <dd> -dictionary of modules contained in the package. +dictionary of modules contained in the package. </dd> </dl><a NAME="PackageDiagram.__createAssociations" ID="PackageDiagram.__createAssociations"></a> <h4>PackageDiagram.__createAssociations</h4> <b>__createAssociations</b>(<i>routes</i>) <p> - Private method to generate the associations between the class shapes. + Private method to generate the associations between the class shapes. </p><dl> <dt><i>routes</i></dt> <dd> -list of relationsships +list of relationsships </dd> </dl><a NAME="PackageDiagram.__getCurrentShape" ID="PackageDiagram.__getCurrentShape"></a> <h4>PackageDiagram.__getCurrentShape</h4> <b>__getCurrentShape</b>(<i>name</i>) <p> - Private method to get the named shape. + Private method to get the named shape. </p><dl> <dt><i>name</i></dt> <dd> -name of the shape (string) +name of the shape (string) </dd> </dl><dl> <dt>Returns:</dt> <dd> -shape (QCanvasItem) +shape (QCanvasItem) </dd> </dl><a NAME="PackageDiagram.relayout" ID="PackageDiagram.relayout"></a> <h4>PackageDiagram.relayout</h4> <b>relayout</b>(<i></i>) <p> - Method to relayout the diagram. + Method to relayout the diagram. </p><a NAME="PackageDiagram.show" ID="PackageDiagram.show"></a> <h4>PackageDiagram.show</h4> <b>show</b>(<i></i>) <p> - Overriden method to show the dialog. + Overriden method to show the dialog. </p> <div align="right"><a href="#top">Up</a></div> <hr />