Documentation/Source/eric5.Graphics.PackageDiagram.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- 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>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#115;&#104;&#111;w&#105;&#110;&#103; &#97; &#85;&#77;&#76; &#108;&#105;&#107;&#101; &#99;&#108;&#97;&#115;&#115; &#100;&#105;&#97;&#103;&#114;&#97;&#109; &#111;&#102; &#97; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.
+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>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#115;&#104;&#111;w&#105;&#110;&#103; &#97; &#85;&#77;&#76; &#108;&#105;&#107;&#101; &#99;&#108;&#97;&#115;&#115; &#100;&#105;&#97;&#103;&#114;&#97;&#109; &#111;&#102; &#97; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.</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>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#97; &#100;&#105;&#97;&#108;&#111;&#103; &#115;&#104;&#111;w&#105;&#110;&#103; &#97; &#85;&#77;&#76; &#108;&#105;&#107;&#101; &#99;&#108;&#97;&#115;&#115; &#100;&#105;&#97;&#103;&#114;&#97;&#109; &#111;&#102; &#97; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.
+    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>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#PackageDiagram.__addExternalClass">__addExternalClass</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#99;&#108;&#97;&#115;&#115; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#111;&#117;&#116;&#115;&#105;&#100;&#101; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.</td>
+<td>Private method to add a class defined outside the module.</td>
 </tr><tr>
 <td><a href="#PackageDiagram.__addLocalClass">__addLocalClass</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#99;&#108;&#97;&#115;&#115; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#105;&#110; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.</td>
+<td>Private method to add a class defined in the module.</td>
 </tr><tr>
 <td><a href="#PackageDiagram.__arrangeClasses">__arrangeClasses</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#114;&#114;&#97;&#110;&#103;&#101; &#116;&#104;&#101; &#115;&#104;&#97;&#112;&#101;&#115; &#111;&#110; &#116;&#104;&#101; &#99;&#97;&#110;v&#97;&#115;.</td>
+<td>Private method to arrange the shapes on the canvas.</td>
 </tr><tr>
 <td><a href="#PackageDiagram.__buildClasses">__buildClasses</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#98;&#117;&#105;&#108;&#100; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#115;&#104;&#97;&#112;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101; &#100;&#105;&#97;&#103;&#114;&#97;&#109;.</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>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#98;&#117;&#105;&#108;&#100; &#97; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#111;&#102; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#101;&#100; &#105;&#110; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.</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>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#115;&#115;&#111;&#99;&#105;&#97;&#116;&#105;&#111;&#110;&#115; &#98;&#101;&#116;w&#101;&#101;&#110; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#115;&#104;&#97;&#112;&#101;&#115;.</td>
+<td>Private method to generate the associations between the class shapes.</td>
 </tr><tr>
 <td><a href="#PackageDiagram.__getCurrentShape">__getCurrentShape</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#110;&#97;&#109;&#101;&#100; &#115;&#104;&#97;&#112;&#101;.</td>
+<td>Private method to get the named shape.</td>
 </tr><tr>
 <td><a href="#PackageDiagram.relayout">relayout</a></td>
-<td>&#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#108;&#97;y&#111;&#117;&#116; &#116;&#104;&#101; &#100;&#105;&#97;&#103;&#114;&#97;&#109;.</td>
+<td>Method to relayout the diagram.</td>
 </tr><tr>
 <td><a href="#PackageDiagram.show">show</a></td>
-<td>&#79;v&#101;&#114;&#114;&#105;&#100;&#101;&#110; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.</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>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>package</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#97; &#112;y&#116;&#104;&#111;&#110; &#112;&#97;&#99;&#107;&#97;&#103;&#101; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of a python package to be shown (string)
 </dd><dt><i>parent</i></dt>
 <dd>
-&#112;&#97;&#114;&#101;&#110;&#116; w&#105;&#100;&#103;&#101;&#116; &#111;&#102; &#116;&#104;&#101; v&#105;&#101;w (&#81;&#87;&#105;&#100;&#103;&#101;&#116;)
+parent widget of the view (QWidget)
 </dd><dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; v&#105;&#101;w w&#105;&#100;&#103;&#101;&#116; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the view widget (string)
 </dd><dt><i>noAttrs=</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103;, &#116;&#104;&#97;&#116; &#110;&#111; &#97;&#116;&#116;&#114;&#105;&#98;&#117;&#116;&#101;&#115; &#115;&#104;&#111;&#117;&#108;&#100; &#98;&#101; &#115;&#104;&#111;w&#110; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#99;&#108;&#97;&#115;&#115; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#111;&#117;&#116;&#115;&#105;&#100;&#101; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.
+        Private method to add a class defined outside the module.
 </p><p>
-        &#73;&#102; &#116;&#104;&#101; &#99;&#97;&#110;v&#97;&#115; &#105;&#115; &#116;&#111;&#111; &#115;&#109;&#97;&#108;&#108; &#116;&#111; &#116;&#97;&#107;&#101; &#116;&#104;&#101; &#115;&#104;&#97;&#112;&#101;, &#105;&#116;
-        &#105;&#115; &#101;&#110;&#108;&#97;&#114;&#103;&#101;&#100;.
+        If the canvas is too small to take the shape, it
+        is enlarged.
 </p><dl>
 <dt><i>_class</i></dt>
 <dd>
-&#99;&#108;&#97;&#115;&#115; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+class to be shown (string)
 </dd><dt><i>x</i></dt>
 <dd>
-x-&#99;&#111;&#111;&#114;&#100;&#105;&#110;&#97;&#116;&#101; (&#102;&#108;&#111;&#97;&#116;)
+x-coordinate (float)
 </dd><dt><i>y</i></dt>
 <dd>
-y-&#99;&#111;&#111;&#114;&#100;&#105;&#110;&#97;&#116;&#101; (&#102;&#108;&#111;&#97;&#116;)
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#99;&#108;&#97;&#115;&#115; &#100;&#101;&#102;&#105;&#110;&#101;&#100; &#105;&#110; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;.
+        Private method to add a class defined in the module.
 </p><dl>
 <dt><i>className</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#116;&#111; &#98;&#101; &#97;&#115; &#97; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#107;&#101;y (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the class to be as a dictionary key (string)
 </dd><dt><i>_class</i></dt>
 <dd>
-&#99;&#108;&#97;&#115;&#115; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#77;&#111;&#100;&#117;&#108;&#101;&#80;&#97;&#114;&#115;&#101;&#114;.&#67;&#108;&#97;&#115;&#115;)
+class to be shown (ModuleParser.Class)
 </dd><dt><i>x</i></dt>
 <dd>
-x-&#99;&#111;&#111;&#114;&#100;&#105;&#110;&#97;&#116;&#101; (&#102;&#108;&#111;&#97;&#116;)
+x-coordinate (float)
 </dd><dt><i>y</i></dt>
 <dd>
-y-&#99;&#111;&#111;&#114;&#100;&#105;&#110;&#97;&#116;&#101; (&#102;&#108;&#111;&#97;&#116;)
+y-coordinate (float)
 </dd><dt><i>isRbModule</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#97; &#82;&#117;&#98;y &#109;&#111;&#100;&#117;&#108;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#114;&#114;&#97;&#110;&#103;&#101; &#116;&#104;&#101; &#115;&#104;&#97;&#112;&#101;&#115; &#111;&#110; &#116;&#104;&#101; &#99;&#97;&#110;v&#97;&#115;.
+        Private method to arrange the shapes on the canvas.
 </p><p>
-        &#84;&#104;&#101; &#97;&#108;&#103;&#111;&#114;&#105;&#116;&#104;&#109; &#105;&#115; &#98;&#111;&#114;&#114;&#111;w&#101;&#100; &#102;&#114;&#111;&#109; &#66;&#111;&#97; &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;.
+        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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#98;&#117;&#105;&#108;&#100; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#115;&#104;&#97;&#112;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101; &#100;&#105;&#97;&#103;&#114;&#97;&#109;.
+        Private method to build the class shapes of the package diagram.
 </p><p>
-        &#84;&#104;&#101; &#97;&#108;&#103;&#111;&#114;&#105;&#116;&#104;&#109; &#105;&#115; &#98;&#111;&#114;&#114;&#111;w&#101;&#100; &#102;&#114;&#111;&#109; &#66;&#111;&#97; &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;.
+        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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#98;&#117;&#105;&#108;&#100; &#97; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#111;&#102; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#101;&#100; &#105;&#110; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.
+        Private method to build a dictionary of modules contained in the package.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#111;&#102; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#101;&#100; &#105;&#110; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.
+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>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#116;&#104;&#101; &#97;&#115;&#115;&#111;&#99;&#105;&#97;&#116;&#105;&#111;&#110;&#115; &#98;&#101;&#116;w&#101;&#101;&#110; &#116;&#104;&#101; &#99;&#108;&#97;&#115;&#115; &#115;&#104;&#97;&#112;&#101;&#115;.
+        Private method to generate the associations between the class shapes.
 </p><dl>
 <dt><i>routes</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#114;&#101;&#108;&#97;&#116;&#105;&#111;&#110;&#115;&#115;&#104;&#105;&#112;&#115;
+list of relationsships
 </dd>
 </dl><a NAME="PackageDiagram.__getCurrentShape" ID="PackageDiagram.__getCurrentShape"></a>
 <h4>PackageDiagram.__getCurrentShape</h4>
 <b>__getCurrentShape</b>(<i>name</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#110;&#97;&#109;&#101;&#100; &#115;&#104;&#97;&#112;&#101;.
+        Private method to get the named shape.
 </p><dl>
 <dt><i>name</i></dt>
 <dd>
-&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#104;&#97;&#112;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of the shape (string)
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#115;&#104;&#97;&#112;&#101; (&#81;&#67;&#97;&#110;v&#97;&#115;&#73;&#116;&#101;&#109;)
+shape (QCanvasItem)
 </dd>
 </dl><a NAME="PackageDiagram.relayout" ID="PackageDiagram.relayout"></a>
 <h4>PackageDiagram.relayout</h4>
 <b>relayout</b>(<i></i>)
 <p>
-        &#77;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#108;&#97;y&#111;&#117;&#116; &#116;&#104;&#101; &#100;&#105;&#97;&#103;&#114;&#97;&#109;.
+        Method to relayout the diagram.
 </p><a NAME="PackageDiagram.show" ID="PackageDiagram.show"></a>
 <h4>PackageDiagram.show</h4>
 <b>show</b>(<i></i>)
 <p>
-        &#79;v&#101;&#114;&#114;&#105;&#100;&#101;&#110; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#104;&#111;w &#116;&#104;&#101; &#100;&#105;&#97;&#108;&#111;&#103;.
+        Overriden method to show the dialog.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial