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