Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Graphics.ApplicationDiagram.html
Documentation/Source/eric4.Graphics.ApplicationDiagram.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric4.Graphics.ApplicationDiagram</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Graphics.ApplicationDiagram</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog showing an imports diagram of the application. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#ApplicationDiagram">ApplicationDiagram</a></td> | |
| 35 <td>Class implementing a dialog showing an imports diagram of the application.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="ApplicationDiagram" ID="ApplicationDiagram"></a> | |
| 44 <h2>ApplicationDiagram</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog showing an imports diagram of the application. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 UMLDialog | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#ApplicationDiagram.__init__">ApplicationDiagram</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#ApplicationDiagram.__addPackage">__addPackage</a></td> | |
| 61 <td>Private method to add a package to the diagram.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#ApplicationDiagram.__buildModulesDict">__buildModulesDict</a></td> | |
| 64 <td>Private method to build a dictionary of modules contained in the application.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#ApplicationDiagram.__buildPackages">__buildPackages</a></td> | |
| 67 <td>Private method to build the packages shapes of the diagram.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#ApplicationDiagram.__createAssociations">__createAssociations</a></td> | |
| 70 <td>Private method to generate the associations between the package shapes.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#ApplicationDiagram.relayout">relayout</a></td> | |
| 73 <td>Method to relayout the diagram.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#ApplicationDiagram.show">show</a></td> | |
| 76 <td>Overriden method to show the dialog.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <a NAME="ApplicationDiagram.__init__" ID="ApplicationDiagram.__init__"></a> | |
| 80 <h4>ApplicationDiagram (Constructor)</h4> | |
| 81 <b>ApplicationDiagram</b>(<i>project, parent = None, name = None, noModules = False</i>) | |
| 82 <p> | |
| 83 Constructor | |
| 84 </p><dl> | |
| 85 <dt><i>project</i></dt> | |
| 86 <dd> | |
| 87 reference to the project object | |
| 88 </dd><dt><i>parent</i></dt> | |
| 89 <dd> | |
| 90 parent widget of the view (QWidget) | |
| 91 </dd><dt><i>name</i></dt> | |
| 92 <dd> | |
| 93 name of the view widget (string) | |
| 94 </dd><dt><i>noModules=</i></dt> | |
| 95 <dd> | |
| 96 flag indicating, that no module names should be | |
| 97 shown (boolean) | |
| 98 </dd> | |
| 99 </dl><a NAME="ApplicationDiagram.__addPackage" ID="ApplicationDiagram.__addPackage"></a> | |
| 100 <h4>ApplicationDiagram.__addPackage</h4> | |
| 101 <b>__addPackage</b>(<i>name, modules, x, y</i>) | |
| 102 <p> | |
| 103 Private method to add a package to the diagram. | |
| 104 </p><dl> | |
| 105 <dt><i>name</i></dt> | |
| 106 <dd> | |
| 107 package name to be shown (string) | |
| 108 </dd><dt><i>modules</i></dt> | |
| 109 <dd> | |
| 110 list of module names contained in the package | |
| 111 (list of strings) | |
| 112 </dd><dt><i>x</i></dt> | |
| 113 <dd> | |
| 114 x-coordinate (float) | |
| 115 </dd><dt><i>y</i></dt> | |
| 116 <dd> | |
| 117 y-coordinate (float) | |
| 118 </dd> | |
| 119 </dl><a NAME="ApplicationDiagram.__buildModulesDict" ID="ApplicationDiagram.__buildModulesDict"></a> | |
| 120 <h4>ApplicationDiagram.__buildModulesDict</h4> | |
| 121 <b>__buildModulesDict</b>(<i></i>) | |
| 122 <p> | |
| 123 Private method to build a dictionary of modules contained in the application. | |
| 124 </p><dl> | |
| 125 <dt>Returns:</dt> | |
| 126 <dd> | |
| 127 dictionary of modules contained in the application. | |
| 128 </dd> | |
| 129 </dl><a NAME="ApplicationDiagram.__buildPackages" ID="ApplicationDiagram.__buildPackages"></a> | |
| 130 <h4>ApplicationDiagram.__buildPackages</h4> | |
| 131 <b>__buildPackages</b>(<i></i>) | |
| 132 <p> | |
| 133 Private method to build the packages shapes of the diagram. | |
| 134 </p><a NAME="ApplicationDiagram.__createAssociations" ID="ApplicationDiagram.__createAssociations"></a> | |
| 135 <h4>ApplicationDiagram.__createAssociations</h4> | |
| 136 <b>__createAssociations</b>(<i>shapes</i>) | |
| 137 <p> | |
| 138 Private method to generate the associations between the package shapes. | |
| 139 </p><dl> | |
| 140 <dt><i>shapes</i></dt> | |
| 141 <dd> | |
| 142 list of shapes | |
| 143 </dd> | |
| 144 </dl><a NAME="ApplicationDiagram.relayout" ID="ApplicationDiagram.relayout"></a> | |
| 145 <h4>ApplicationDiagram.relayout</h4> | |
| 146 <b>relayout</b>(<i></i>) | |
| 147 <p> | |
| 148 Method to relayout the diagram. | |
| 149 </p><a NAME="ApplicationDiagram.show" ID="ApplicationDiagram.show"></a> | |
| 150 <h4>ApplicationDiagram.show</h4> | |
| 151 <b>show</b>(<i></i>) | |
| 152 <p> | |
| 153 Overriden method to show the dialog. | |
| 154 </p> | |
| 155 <div align="right"><a href="#top">Up</a></div> | |
| 156 <hr /> | |
| 157 </body></html> |
