Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Graphics.PackageDiagram.html
Documentation/Source/eric4.Graphics.PackageDiagram.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.PackageDiagram</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.PackageDiagram</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog showing a UML like class diagram of a package. | |
| 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="#PackageDiagram">PackageDiagram</a></td> | |
| 35 <td>Class implementing a dialog showing a UML like class diagram of a package.</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="PackageDiagram" ID="PackageDiagram"></a> | |
| 44 <h2>PackageDiagram</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog showing a UML like class diagram of a package. | |
| 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="#PackageDiagram.__init__">PackageDiagram</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#PackageDiagram.__addExternalClass">__addExternalClass</a></td> | |
| 61 <td>Private method to add a class defined outside the module.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#PackageDiagram.__addLocalClass">__addLocalClass</a></td> | |
| 64 <td>Private method to add a class defined in the module.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#PackageDiagram.__arrangeClasses">__arrangeClasses</a></td> | |
| 67 <td>Private method to arrange the shapes on the canvas.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#PackageDiagram.__buildClasses">__buildClasses</a></td> | |
| 70 <td>Private method to build the class shapes of the package diagram.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#PackageDiagram.__buildModulesDict">__buildModulesDict</a></td> | |
| 73 <td>Private method to build a dictionary of modules contained in the package.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#PackageDiagram.__createAssociations">__createAssociations</a></td> | |
| 76 <td>Private method to generate the associations between the class shapes.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#PackageDiagram.__getCurrentShape">__getCurrentShape</a></td> | |
| 79 <td>Private method to get the named shape.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#PackageDiagram.relayout">relayout</a></td> | |
| 82 <td>Method to relayout the diagram.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#PackageDiagram.show">show</a></td> | |
| 85 <td>Overriden method to show the dialog.</td> | |
| 86 </tr> | |
| 87 </table> | |
| 88 <a NAME="PackageDiagram.__init__" ID="PackageDiagram.__init__"></a> | |
| 89 <h4>PackageDiagram (Constructor)</h4> | |
| 90 <b>PackageDiagram</b>(<i>package, parent = None, name = None, noAttrs = False</i>) | |
| 91 <p> | |
| 92 Constructor | |
| 93 </p><dl> | |
| 94 <dt><i>package</i></dt> | |
| 95 <dd> | |
| 96 name of a python package to be shown (string) | |
| 97 </dd><dt><i>parent</i></dt> | |
| 98 <dd> | |
| 99 parent widget of the view (QWidget) | |
| 100 </dd><dt><i>name</i></dt> | |
| 101 <dd> | |
| 102 name of the view widget (string) | |
| 103 </dd><dt><i>noAttrs=</i></dt> | |
| 104 <dd> | |
| 105 flag indicating, that no attributes should be shown (boolean) | |
| 106 </dd> | |
| 107 </dl><a NAME="PackageDiagram.__addExternalClass" ID="PackageDiagram.__addExternalClass"></a> | |
| 108 <h4>PackageDiagram.__addExternalClass</h4> | |
| 109 <b>__addExternalClass</b>(<i>_class, x, y</i>) | |
| 110 <p> | |
| 111 Private method to add a class defined outside the module. | |
| 112 </p><p> | |
| 113 If the canvas is too small to take the shape, it | |
| 114 is enlarged. | |
| 115 </p><dl> | |
| 116 <dt><i>_class</i></dt> | |
| 117 <dd> | |
| 118 class to be shown (string) | |
| 119 </dd><dt><i>x</i></dt> | |
| 120 <dd> | |
| 121 x-coordinate (float) | |
| 122 </dd><dt><i>y</i></dt> | |
| 123 <dd> | |
| 124 y-coordinate (float) | |
| 125 </dd> | |
| 126 </dl><a NAME="PackageDiagram.__addLocalClass" ID="PackageDiagram.__addLocalClass"></a> | |
| 127 <h4>PackageDiagram.__addLocalClass</h4> | |
| 128 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule = False</i>) | |
| 129 <p> | |
| 130 Private method to add a class defined in the module. | |
| 131 </p><dl> | |
| 132 <dt><i>className</i></dt> | |
| 133 <dd> | |
| 134 name of the class to be as a dictionary key (string) | |
| 135 </dd><dt><i>_class</i></dt> | |
| 136 <dd> | |
| 137 class to be shown (ModuleParser.Class) | |
| 138 </dd><dt><i>x</i></dt> | |
| 139 <dd> | |
| 140 x-coordinate (float) | |
| 141 </dd><dt><i>y</i></dt> | |
| 142 <dd> | |
| 143 y-coordinate (float) | |
| 144 </dd><dt><i>isRbModule</i></dt> | |
| 145 <dd> | |
| 146 flag indicating a Ruby module (boolean) | |
| 147 </dd> | |
| 148 </dl><a NAME="PackageDiagram.__arrangeClasses" ID="PackageDiagram.__arrangeClasses"></a> | |
| 149 <h4>PackageDiagram.__arrangeClasses</h4> | |
| 150 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor = 1.2</i>) | |
| 151 <p> | |
| 152 Private method to arrange the shapes on the canvas. | |
| 153 </p><p> | |
| 154 The algorithm is borrowed from Boa Constructor. | |
| 155 </p><a NAME="PackageDiagram.__buildClasses" ID="PackageDiagram.__buildClasses"></a> | |
| 156 <h4>PackageDiagram.__buildClasses</h4> | |
| 157 <b>__buildClasses</b>(<i></i>) | |
| 158 <p> | |
| 159 Private method to build the class shapes of the package diagram. | |
| 160 </p><p> | |
| 161 The algorithm is borrowed from Boa Constructor. | |
| 162 </p><a NAME="PackageDiagram.__buildModulesDict" ID="PackageDiagram.__buildModulesDict"></a> | |
| 163 <h4>PackageDiagram.__buildModulesDict</h4> | |
| 164 <b>__buildModulesDict</b>(<i></i>) | |
| 165 <p> | |
| 166 Private method to build a dictionary of modules contained in the package. | |
| 167 </p><dl> | |
| 168 <dt>Returns:</dt> | |
| 169 <dd> | |
| 170 dictionary of modules contained in the package. | |
| 171 </dd> | |
| 172 </dl><a NAME="PackageDiagram.__createAssociations" ID="PackageDiagram.__createAssociations"></a> | |
| 173 <h4>PackageDiagram.__createAssociations</h4> | |
| 174 <b>__createAssociations</b>(<i>routes</i>) | |
| 175 <p> | |
| 176 Private method to generate the associations between the class shapes. | |
| 177 </p><dl> | |
| 178 <dt><i>routes</i></dt> | |
| 179 <dd> | |
| 180 list of relationsships | |
| 181 </dd> | |
| 182 </dl><a NAME="PackageDiagram.__getCurrentShape" ID="PackageDiagram.__getCurrentShape"></a> | |
| 183 <h4>PackageDiagram.__getCurrentShape</h4> | |
| 184 <b>__getCurrentShape</b>(<i>name</i>) | |
| 185 <p> | |
| 186 Private method to get the named shape. | |
| 187 </p><dl> | |
| 188 <dt><i>name</i></dt> | |
| 189 <dd> | |
| 190 name of the shape (string) | |
| 191 </dd> | |
| 192 </dl><dl> | |
| 193 <dt>Returns:</dt> | |
| 194 <dd> | |
| 195 shape (QCanvasItem) | |
| 196 </dd> | |
| 197 </dl><a NAME="PackageDiagram.relayout" ID="PackageDiagram.relayout"></a> | |
| 198 <h4>PackageDiagram.relayout</h4> | |
| 199 <b>relayout</b>(<i></i>) | |
| 200 <p> | |
| 201 Method to relayout the diagram. | |
| 202 </p><a NAME="PackageDiagram.show" ID="PackageDiagram.show"></a> | |
| 203 <h4>PackageDiagram.show</h4> | |
| 204 <b>show</b>(<i></i>) | |
| 205 <p> | |
| 206 Overriden method to show the dialog. | |
| 207 </p> | |
| 208 <div align="right"><a href="#top">Up</a></div> | |
| 209 <hr /> | |
| 210 </body></html> |
