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