--- a/eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,166 +18,218 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.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 /> +<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> +</tr> +<tr> <td><a href="#ApplicationDiagramBuilder.__addPackage">__addPackage</a></td> <td>Private method to add a package to the diagram.</td> -</tr><tr> +</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> +</tr> +<tr> <td><a href="#ApplicationDiagramBuilder.__createAssociations">__createAssociations</a></td> <td>Private method to generate the associations between the package shapes.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ApplicationDiagramBuilder.buildDiagram">buildDiagram</a></td> <td>Public method to build the packages shapes of the diagram.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ApplicationDiagramBuilder.getPersistenceData">getPersistenceData</a></td> <td>Public method to get a string for data to be persisted.</td> -</tr><tr> +</tr> +<tr> <td><a href="#ApplicationDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> <td>Public method to parse persisted data.</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> +</p> +<dl> + <dt><i>dialog</i></dt> <dd> reference to the UML dialog (UMLDialog) -</dd><dt><i>view</i></dt> +</dd> +<dt><i>view</i></dt> <dd> reference to the view object (UMLGraphicsView) -</dd><dt><i>project</i></dt> +</dd> +<dt><i>project</i></dt> <dd> reference to the project object (Project) -</dd><dt><i>noModules=</i></dt> +</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> +</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> +</p> +<dl> + <dt><i>name</i></dt> <dd> package name to be shown (string) -</dd><dt><i>modules</i></dt> +</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> +<dt><i>x</i></dt> <dd> x-coordinate (float) -</dd><dt><i>y</i></dt> +</dd> +<dt><i>y</i></dt> <dd> y-coordinate (float) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the package item (PackageItem) </dd> -</dl><a NAME="ApplicationDiagramBuilder.__buildModulesDict" ID="ApplicationDiagramBuilder.__buildModulesDict"></a> +</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> +</p> +<dl> <dt>Returns:</dt> <dd> dictionary of modules contained in the application. </dd> -</dl><a NAME="ApplicationDiagramBuilder.__createAssociations" ID="ApplicationDiagramBuilder.__createAssociations"></a> +</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> +</p> +<dl> + <dt><i>shapes</i></dt> <dd> list of shapes </dd> -</dl><a NAME="ApplicationDiagramBuilder.buildDiagram" ID="ApplicationDiagramBuilder.buildDiagram"></a> +</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><a NAME="ApplicationDiagramBuilder.getPersistenceData" ID="ApplicationDiagramBuilder.getPersistenceData"></a> +</p> +<a NAME="ApplicationDiagramBuilder.getPersistenceData" ID="ApplicationDiagramBuilder.getPersistenceData"></a> <h4>ApplicationDiagramBuilder.getPersistenceData</h4> <b>getPersistenceData</b>(<i></i>) + <p> Public method to get a string for data to be persisted. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> persisted data string (string) </dd> -</dl><a NAME="ApplicationDiagramBuilder.parsePersistenceData" ID="ApplicationDiagramBuilder.parsePersistenceData"></a> +</dl> +<a NAME="ApplicationDiagramBuilder.parsePersistenceData" ID="ApplicationDiagramBuilder.parsePersistenceData"></a> <h4>ApplicationDiagramBuilder.parsePersistenceData</h4> <b>parsePersistenceData</b>(<i>version, data</i>) + <p> Public method to parse persisted data. -</p><dl> +</p> +<dl> + <dt><i>version</i></dt> <dd> version of the data (string) -</dd><dt><i>data</i></dt> +</dd> +<dt><i>data</i></dt> <dd> persisted data to be parsed (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating success (boolean)