Documentation/Source/eric5.Graphics.ImportsDiagram.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 409
0ea528e80202
--- a/Documentation/Source/eric5.Graphics.ImportsDiagram.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Graphics.ImportsDiagram.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Graphics.ImportsDiagram</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;&#110; &#105;&#109;&#112;&#111;&#114;&#116;&#115; &#100;&#105;&#97;&#103;&#114;&#97;&#109; &#111;&#102; &#97; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.
+Module implementing a dialog showing an imports diagram of a package.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,7 +32,7 @@
 <table>
 <tr>
 <td><a href="#ImportsDiagram">ImportsDiagram</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;&#110; &#105;&#109;&#112;&#111;&#114;&#116;&#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 an imports diagram of a package.</td>
 </tr>
 </table>
 <h3>Functions</h3>
@@ -43,10 +43,10 @@
 <a NAME="ImportsDiagram" ID="ImportsDiagram"></a>
 <h2>ImportsDiagram</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;&#110; &#105;&#109;&#112;&#111;&#114;&#116;&#115; &#100;&#105;&#97;&#103;&#114;&#97;&#109; &#111;&#102; &#97; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.
+    Class implementing a dialog showing an imports diagram of a package.
 </p><p>
-    &#78;&#111;&#116;&#101;&#58; &#79;&#110;&#108;y &#112;&#97;&#99;&#107;&#97;&#103;&#101; &#105;&#110;&#116;&#101;&#114;&#110;&#97;&#108; &#105;&#109;&#112;&#111;&#114;&#116;&#115; &#97;&#114;&#101; &#115;&#104;&#111;w &#105;&#110; &#111;&#114;&#100;&#101;&#114; &#116;&#111; &#109;&#97;&#105;&#110;&#116;&#97;&#105;&#110;
-    &#115;&#111;&#109;&#101; &#114;&#101;&#97;&#100;&#97;&#98;&#105;&#108;&#105;&#116;y.
+    Note: Only package internal imports are show in order to maintain
+    some readability.
 </p>
 <h3>Derived from</h3>
 UMLDialog
@@ -58,103 +58,103 @@
 <table>
 <tr>
 <td><a href="#ImportsDiagram.__init__">ImportsDiagram</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#ImportsDiagram.__addModule">__addModule</a></td>
-<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#109;&#111;&#100;&#117;&#108;&#101; &#116;&#111; &#116;&#104;&#101; &#100;&#105;&#97;&#103;&#114;&#97;&#109;.</td>
+<td>Private method to add a module to the diagram.</td>
 </tr><tr>
 <td><a href="#ImportsDiagram.__buildImports">__buildImports</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; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#115;&#104;&#97;&#112;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#97;&#103;&#114;&#97;&#109;.</td>
+<td>Private method to build the modules shapes of the diagram.</td>
 </tr><tr>
 <td><a href="#ImportsDiagram.__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="#ImportsDiagram.__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; &#109;&#111;&#100;&#117;&#108;&#101; &#115;&#104;&#97;&#112;&#101;&#115;.</td>
+<td>Private method to generate the associations between the module shapes.</td>
 </tr><tr>
 <td><a href="#ImportsDiagram.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="#ImportsDiagram.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="ImportsDiagram.__init__" ID="ImportsDiagram.__init__"></a>
 <h4>ImportsDiagram (Constructor)</h4>
 <b>ImportsDiagram</b>(<i>package, parent = None, name = None, showExternalImports = 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; &#115;&#104;&#111;w &#116;&#104;&#101; &#105;&#109;&#112;&#111;&#114;&#116;
-            &#114;&#101;&#108;&#97;&#116;&#105;&#111;&#110;&#115;&#104;&#105;&#112;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
+name of a python package to show the import
+            relationships (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>showExternalImports=</i></dt>
 <dd>
-&#102;&#108;&#97;&#103; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#105;&#110;&#103; &#116;&#111; &#115;&#104;&#111;w &#101;x&#112;&#111;&#114;&#116;&#115; &#102;&#114;&#111;&#109; &#111;&#117;&#116;&#115;&#105;&#100;&#101;
-            &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+flag indicating to show exports from outside
+            the package (boolean)
 </dd>
 </dl><a NAME="ImportsDiagram.__addModule" ID="ImportsDiagram.__addModule"></a>
 <h4>ImportsDiagram.__addModule</h4>
 <b>__addModule</b>(<i>name, classes, x, y</i>)
 <p>
-        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#100;&#100; &#97; &#109;&#111;&#100;&#117;&#108;&#101; &#116;&#111; &#116;&#104;&#101; &#100;&#105;&#97;&#103;&#114;&#97;&#109;.
+        Private method to add a module to the diagram.
 </p><dl>
 <dt><i>name</i></dt>
 <dd>
-&#109;&#111;&#100;&#117;&#108;&#101; &#110;&#97;&#109;&#101; &#116;&#111; &#98;&#101; &#115;&#104;&#111;w&#110; (&#115;&#116;&#114;&#105;&#110;&#103;)
+module name to be shown (string)
 </dd><dt><i>classes</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#99;&#108;&#97;&#115;&#115; &#110;&#97;&#109;&#101;&#115; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#101;&#100; &#105;&#110; &#116;&#104;&#101; &#109;&#111;&#100;&#117;&#108;&#101;
-            (&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
+list of class names contained in the module
+            (list of strings)
 </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="ImportsDiagram.__buildImports" ID="ImportsDiagram.__buildImports"></a>
 <h4>ImportsDiagram.__buildImports</h4>
 <b>__buildImports</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; &#109;&#111;&#100;&#117;&#108;&#101;&#115; &#115;&#104;&#97;&#112;&#101;&#115; &#111;&#102; &#116;&#104;&#101; &#100;&#105;&#97;&#103;&#114;&#97;&#109;.
+        Private method to build the modules shapes of the diagram.
 </p><a NAME="ImportsDiagram.__buildModulesDict" ID="ImportsDiagram.__buildModulesDict"></a>
 <h4>ImportsDiagram.__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="ImportsDiagram.__createAssociations" ID="ImportsDiagram.__createAssociations"></a>
 <h4>ImportsDiagram.__createAssociations</h4>
 <b>__createAssociations</b>(<i>shapes</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; &#109;&#111;&#100;&#117;&#108;&#101; &#115;&#104;&#97;&#112;&#101;&#115;.
+        Private method to generate the associations between the module shapes.
 </p><dl>
 <dt><i>shapes</i></dt>
 <dd>
-&#108;&#105;&#115;&#116; &#111;&#102; &#115;&#104;&#97;&#112;&#101;&#115;
+list of shapes
 </dd>
 </dl><a NAME="ImportsDiagram.relayout" ID="ImportsDiagram.relayout"></a>
 <h4>ImportsDiagram.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="ImportsDiagram.show" ID="ImportsDiagram.show"></a>
 <h4>ImportsDiagram.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