--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Graphics.PackageDiagram.html Sat Jan 02 18:19:35 2010 +0000
@@ -0,0 +1,198 @@
+<?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.Graphics.PackageDiagram</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.Graphics.PackageDiagram</h1>
+<p>
+Module implementing a dialog showing a UML like class diagram of a package.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#PackageDiagram">PackageDiagram</a></td>
+<td>Class implementing a dialog showing a UML like class diagram of a package.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="PackageDiagram" ID="PackageDiagram"></a>
+<h2>PackageDiagram</h2>
+<p>
+ Class implementing a dialog showing a UML like class diagram of a package.
+</p>
+<h3>Derived from</h3>
+UMLDialog
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#PackageDiagram.__init__">PackageDiagram</a></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>
+</tr><tr>
+<td><a href="#PackageDiagram.__addLocalClass">__addLocalClass</a></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>
+</tr><tr>
+<td><a href="#PackageDiagram.__buildClasses">__buildClasses</a></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>
+</tr><tr>
+<td><a href="#PackageDiagram.__createAssociations">__createAssociations</a></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>
+</tr><tr>
+<td><a href="#PackageDiagram.relayout">relayout</a></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>
+</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
+</p><dl>
+<dt><i>package</i></dt>
+<dd>
+name of a python package to be shown (string)
+</dd><dt><i>parent</i></dt>
+<dd>
+parent widget of the view (QWidget)
+</dd><dt><i>name</i></dt>
+<dd>
+name of the view widget (string)
+</dd><dt><i>noAttrs=</i></dt>
+<dd>
+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.
+</p><p>
+ 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)
+</dd><dt><i>x</i></dt>
+<dd>
+x-coordinate (float)
+</dd><dt><i>y</i></dt>
+<dd>
+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.
+</p><dl>
+<dt><i>className</i></dt>
+<dd>
+name of the class to be as a dictionary key (string)
+</dd><dt><i>_class</i></dt>
+<dd>
+class to be shown (ModuleParser.Class)
+</dd><dt><i>x</i></dt>
+<dd>
+x-coordinate (float)
+</dd><dt><i>y</i></dt>
+<dd>
+y-coordinate (float)
+</dd><dt><i>isRbModule</i></dt>
+<dd>
+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.
+</p><p>
+ 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.
+</p><p>
+ 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.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+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.
+</p><dl>
+<dt><i>routes</i></dt>
+<dd>
+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.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+name of the shape (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+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.
+</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.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
