Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Graphics.PackageDiagram.html
Documentation/Source/eric5.Graphics.PackageDiagram.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 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>eric5.Graphics.PackageDiagram</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Graphics.PackageDiagram</h1> | |
| 12 <p> | |
| 13 Module implementing a dialog showing a UML like class diagram of a package. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#PackageDiagram">PackageDiagram</a></td> | |
| 23 <td>Class implementing a dialog showing a UML like class diagram of a package.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="PackageDiagram" ID="PackageDiagram"></a> | |
| 32 <h2>PackageDiagram</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog showing a UML like class diagram of a package. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 UMLDialog | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#PackageDiagram.__init__">PackageDiagram</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#PackageDiagram.__addExternalClass">__addExternalClass</a></td> | |
| 49 <td>Private method to add a class defined outside the module.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#PackageDiagram.__addLocalClass">__addLocalClass</a></td> | |
| 52 <td>Private method to add a class defined in the module.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#PackageDiagram.__arrangeClasses">__arrangeClasses</a></td> | |
| 55 <td>Private method to arrange the shapes on the canvas.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#PackageDiagram.__buildClasses">__buildClasses</a></td> | |
| 58 <td>Private method to build the class shapes of the package diagram.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#PackageDiagram.__buildModulesDict">__buildModulesDict</a></td> | |
| 61 <td>Private method to build a dictionary of modules contained in the package.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#PackageDiagram.__createAssociations">__createAssociations</a></td> | |
| 64 <td>Private method to generate the associations between the class shapes.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#PackageDiagram.__getCurrentShape">__getCurrentShape</a></td> | |
| 67 <td>Private method to get the named shape.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#PackageDiagram.relayout">relayout</a></td> | |
| 70 <td>Method to relayout the diagram.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#PackageDiagram.show">show</a></td> | |
| 73 <td>Overriden method to show the dialog.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <a NAME="PackageDiagram.__init__" ID="PackageDiagram.__init__"></a> | |
| 77 <h4>PackageDiagram (Constructor)</h4> | |
| 78 <b>PackageDiagram</b>(<i>package, parent = None, name = None, noAttrs = False</i>) | |
| 79 <p> | |
| 80 Constructor | |
| 81 </p><dl> | |
| 82 <dt><i>package</i></dt> | |
| 83 <dd> | |
| 84 name of a python package to be shown (string) | |
| 85 </dd><dt><i>parent</i></dt> | |
| 86 <dd> | |
| 87 parent widget of the view (QWidget) | |
| 88 </dd><dt><i>name</i></dt> | |
| 89 <dd> | |
| 90 name of the view widget (string) | |
| 91 </dd><dt><i>noAttrs=</i></dt> | |
| 92 <dd> | |
| 93 flag indicating, that no attributes should be shown (boolean) | |
| 94 </dd> | |
| 95 </dl><a NAME="PackageDiagram.__addExternalClass" ID="PackageDiagram.__addExternalClass"></a> | |
| 96 <h4>PackageDiagram.__addExternalClass</h4> | |
| 97 <b>__addExternalClass</b>(<i>_class, x, y</i>) | |
| 98 <p> | |
| 99 Private method to add a class defined outside the module. | |
| 100 </p><p> | |
| 101 If the canvas is too small to take the shape, it | |
| 102 is enlarged. | |
| 103 </p><dl> | |
| 104 <dt><i>_class</i></dt> | |
| 105 <dd> | |
| 106 class to be shown (string) | |
| 107 </dd><dt><i>x</i></dt> | |
| 108 <dd> | |
| 109 x-coordinate (float) | |
| 110 </dd><dt><i>y</i></dt> | |
| 111 <dd> | |
| 112 y-coordinate (float) | |
| 113 </dd> | |
| 114 </dl><a NAME="PackageDiagram.__addLocalClass" ID="PackageDiagram.__addLocalClass"></a> | |
| 115 <h4>PackageDiagram.__addLocalClass</h4> | |
| 116 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule = False</i>) | |
| 117 <p> | |
| 118 Private method to add a class defined in the module. | |
| 119 </p><dl> | |
| 120 <dt><i>className</i></dt> | |
| 121 <dd> | |
| 122 name of the class to be as a dictionary key (string) | |
| 123 </dd><dt><i>_class</i></dt> | |
| 124 <dd> | |
| 125 class to be shown (ModuleParser.Class) | |
| 126 </dd><dt><i>x</i></dt> | |
| 127 <dd> | |
| 128 x-coordinate (float) | |
| 129 </dd><dt><i>y</i></dt> | |
| 130 <dd> | |
| 131 y-coordinate (float) | |
| 132 </dd><dt><i>isRbModule</i></dt> | |
| 133 <dd> | |
| 134 flag indicating a Ruby module (boolean) | |
| 135 </dd> | |
| 136 </dl><a NAME="PackageDiagram.__arrangeClasses" ID="PackageDiagram.__arrangeClasses"></a> | |
| 137 <h4>PackageDiagram.__arrangeClasses</h4> | |
| 138 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor = 1.2</i>) | |
| 139 <p> | |
| 140 Private method to arrange the shapes on the canvas. | |
| 141 </p><p> | |
| 142 The algorithm is borrowed from Boa Constructor. | |
| 143 </p><a NAME="PackageDiagram.__buildClasses" ID="PackageDiagram.__buildClasses"></a> | |
| 144 <h4>PackageDiagram.__buildClasses</h4> | |
| 145 <b>__buildClasses</b>(<i></i>) | |
| 146 <p> | |
| 147 Private method to build the class shapes of the package diagram. | |
| 148 </p><p> | |
| 149 The algorithm is borrowed from Boa Constructor. | |
| 150 </p><a NAME="PackageDiagram.__buildModulesDict" ID="PackageDiagram.__buildModulesDict"></a> | |
| 151 <h4>PackageDiagram.__buildModulesDict</h4> | |
| 152 <b>__buildModulesDict</b>(<i></i>) | |
| 153 <p> | |
| 154 Private method to build a dictionary of modules contained in the package. | |
| 155 </p><dl> | |
| 156 <dt>Returns:</dt> | |
| 157 <dd> | |
| 158 dictionary of modules contained in the package. | |
| 159 </dd> | |
| 160 </dl><a NAME="PackageDiagram.__createAssociations" ID="PackageDiagram.__createAssociations"></a> | |
| 161 <h4>PackageDiagram.__createAssociations</h4> | |
| 162 <b>__createAssociations</b>(<i>routes</i>) | |
| 163 <p> | |
| 164 Private method to generate the associations between the class shapes. | |
| 165 </p><dl> | |
| 166 <dt><i>routes</i></dt> | |
| 167 <dd> | |
| 168 list of relationsships | |
| 169 </dd> | |
| 170 </dl><a NAME="PackageDiagram.__getCurrentShape" ID="PackageDiagram.__getCurrentShape"></a> | |
| 171 <h4>PackageDiagram.__getCurrentShape</h4> | |
| 172 <b>__getCurrentShape</b>(<i>name</i>) | |
| 173 <p> | |
| 174 Private method to get the named shape. | |
| 175 </p><dl> | |
| 176 <dt><i>name</i></dt> | |
| 177 <dd> | |
| 178 name of the shape (string) | |
| 179 </dd> | |
| 180 </dl><dl> | |
| 181 <dt>Returns:</dt> | |
| 182 <dd> | |
| 183 shape (QCanvasItem) | |
| 184 </dd> | |
| 185 </dl><a NAME="PackageDiagram.relayout" ID="PackageDiagram.relayout"></a> | |
| 186 <h4>PackageDiagram.relayout</h4> | |
| 187 <b>relayout</b>(<i></i>) | |
| 188 <p> | |
| 189 Method to relayout the diagram. | |
| 190 </p><a NAME="PackageDiagram.show" ID="PackageDiagram.show"></a> | |
| 191 <h4>PackageDiagram.show</h4> | |
| 192 <b>show</b>(<i></i>) | |
| 193 <p> | |
| 194 Overriden method to show the dialog. | |
| 195 </p> | |
| 196 <div align="right"><a href="#top">Up</a></div> | |
| 197 <hr /> | |
| 198 </body></html> |
