Documentation/Source/eric5.Graphics.ApplicationDiagram.html

<?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.ApplicationDiagram</title>
<style>
body {
    background: white;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: black; background: #C1BBA4; }
h4 { color: black; background: #C1BBA4; }
    
a { color: #C07037; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Graphics.ApplicationDiagram</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="#ApplicationDiagram">ApplicationDiagram</a></td>
<td>Class implementing a dialog showing an imports diagram of the application.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="ApplicationDiagram" ID="ApplicationDiagram"></a>
<h2>ApplicationDiagram</h2>
<p>
    Class implementing a dialog showing an imports diagram of the application.
</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="#ApplicationDiagram.__init__">ApplicationDiagram</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#ApplicationDiagram.__addPackage">__addPackage</a></td>
<td>Private method to add a package to the diagram.</td>
</tr><tr>
<td><a href="#ApplicationDiagram.__buildModulesDict">__buildModulesDict</a></td>
<td>Private method to build a dictionary of modules contained in the application.</td>
</tr><tr>
<td><a href="#ApplicationDiagram.__buildPackages">__buildPackages</a></td>
<td>Private method to build the packages shapes of the diagram.</td>
</tr><tr>
<td><a href="#ApplicationDiagram.__createAssociations">__createAssociations</a></td>
<td>Private method to generate the associations between the package shapes.</td>
</tr><tr>
<td><a href="#ApplicationDiagram.relayout">relayout</a></td>
<td>Method to relayout the diagram.</td>
</tr><tr>
<td><a href="#ApplicationDiagram.show">show</a></td>
<td>Overriden method to show the dialog.</td>
</tr>
</table>
<a NAME="ApplicationDiagram.__init__" ID="ApplicationDiagram.__init__"></a>
<h4>ApplicationDiagram (Constructor)</h4>
<b>ApplicationDiagram</b>(<i>project, parent = None, name = None, noModules = False</i>)
<p>
        Constructor
</p><dl>
<dt><i>project</i></dt>
<dd>
reference to the project object
</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>noModules=</i></dt>
<dd>
flag indicating, that no module names should be
            shown (boolean)
</dd>
</dl><a NAME="ApplicationDiagram.__addPackage" ID="ApplicationDiagram.__addPackage"></a>
<h4>ApplicationDiagram.__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="ApplicationDiagram.__buildModulesDict" ID="ApplicationDiagram.__buildModulesDict"></a>
<h4>ApplicationDiagram.__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="ApplicationDiagram.__buildPackages" ID="ApplicationDiagram.__buildPackages"></a>
<h4>ApplicationDiagram.__buildPackages</h4>
<b>__buildPackages</b>(<i></i>)
<p>
        Private method to build the packages shapes of the diagram.
</p><a NAME="ApplicationDiagram.__createAssociations" ID="ApplicationDiagram.__createAssociations"></a>
<h4>ApplicationDiagram.__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="ApplicationDiagram.relayout" ID="ApplicationDiagram.relayout"></a>
<h4>ApplicationDiagram.relayout</h4>
<b>relayout</b>(<i></i>)
<p>
        Method to relayout the diagram.
</p><a NAME="ApplicationDiagram.show" ID="ApplicationDiagram.show"></a>
<h4>ApplicationDiagram.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>