Documentation/Source/eric5.Graphics.ApplicationDiagramBuilder.html

changeset 2031
c36c2eb62a75
child 2033
4b99609f6a87
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Graphics.ApplicationDiagramBuilder.html	Sun Sep 09 17:40:32 2012 +0200
@@ -0,0 +1,149 @@
+<?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.ApplicationDiagramBuilder</title>
+<style>
+body {
+    background: #EDECE6;
+    margin: 0em 1em 10em 1em;
+    color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+    
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Graphics.ApplicationDiagramBuilder</h1>
+<p>
+Module implementing a dialog showing an imports diagram of the application.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#ApplicationDiagramBuilder">ApplicationDiagramBuilder</a></td>
+<td>Class implementing a builder for imports diagrams of the application.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="ApplicationDiagramBuilder" ID="ApplicationDiagramBuilder"></a>
+<h2>ApplicationDiagramBuilder</h2>
+<p>
+    Class implementing a builder for imports diagrams of the application.
+</p>
+<h3>Derived from</h3>
+UMLDiagramBuilder
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Class Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#ApplicationDiagramBuilder.__init__">ApplicationDiagramBuilder</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#ApplicationDiagramBuilder.__addPackage">__addPackage</a></td>
+<td>Private method to add a package to the diagram.</td>
+</tr><tr>
+<td><a href="#ApplicationDiagramBuilder.__buildModulesDict">__buildModulesDict</a></td>
+<td>Private method to build a dictionary of modules contained in the application.</td>
+</tr><tr>
+<td><a href="#ApplicationDiagramBuilder.__createAssociations">__createAssociations</a></td>
+<td>Private method to generate the associations between the package shapes.</td>
+</tr><tr>
+<td><a href="#ApplicationDiagramBuilder.buildDiagram">buildDiagram</a></td>
+<td>Public method to build the packages shapes of the diagram.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<a NAME="ApplicationDiagramBuilder.__init__" ID="ApplicationDiagramBuilder.__init__"></a>
+<h4>ApplicationDiagramBuilder (Constructor)</h4>
+<b>ApplicationDiagramBuilder</b>(<i>dialog, view, project, noModules=False</i>)
+<p>
+        Constructor
+</p><dl>
+<dt><i>dialog</i></dt>
+<dd>
+reference to the UML dialog (UMLDialog)
+</dd><dt><i>view</i></dt>
+<dd>
+reference to the view object (UMLGraphicsView)
+</dd><dt><i>project</i></dt>
+<dd>
+reference to the project object (Project)
+</dd><dt><i>noModules=</i></dt>
+<dd>
+flag indicating, that no module names should be
+            shown (boolean)
+</dd>
+</dl><a NAME="ApplicationDiagramBuilder.__addPackage" ID="ApplicationDiagramBuilder.__addPackage"></a>
+<h4>ApplicationDiagramBuilder.__addPackage</h4>
+<b>__addPackage</b>(<i>name, modules, x, y</i>)
+<p>
+        Private method to add a package to the diagram.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+package name to be shown (string)
+</dd><dt><i>modules</i></dt>
+<dd>
+list of module names contained in the package
+            (list of strings)
+</dd><dt><i>x</i></dt>
+<dd>
+x-coordinate (float)
+</dd><dt><i>y</i></dt>
+<dd>
+y-coordinate (float)
+</dd>
+</dl><a NAME="ApplicationDiagramBuilder.__buildModulesDict" ID="ApplicationDiagramBuilder.__buildModulesDict"></a>
+<h4>ApplicationDiagramBuilder.__buildModulesDict</h4>
+<b>__buildModulesDict</b>(<i></i>)
+<p>
+        Private method to build a dictionary of modules contained in the application.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+dictionary of modules contained in the application.
+</dd>
+</dl><a NAME="ApplicationDiagramBuilder.__createAssociations" ID="ApplicationDiagramBuilder.__createAssociations"></a>
+<h4>ApplicationDiagramBuilder.__createAssociations</h4>
+<b>__createAssociations</b>(<i>shapes</i>)
+<p>
+        Private method to generate the associations between the package shapes.
+</p><dl>
+<dt><i>shapes</i></dt>
+<dd>
+list of shapes
+</dd>
+</dl><a NAME="ApplicationDiagramBuilder.buildDiagram" ID="ApplicationDiagramBuilder.buildDiagram"></a>
+<h4>ApplicationDiagramBuilder.buildDiagram</h4>
+<b>buildDiagram</b>(<i></i>)
+<p>
+        Public method to build the packages shapes of the diagram.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial