Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Graphics.UMLClassDiagramBuilder.html
eric6/Documentation/Source/eric6.Graphics.UMLClassDiagramBuilder.html
- changeset 8289
- 871b40c5a77a
- parent 7989
- a21d673a8f99
- child 8294
- cb4e5bbf3a2c
equal
deleted
inserted
replaced
| 8288:809d5d5ac2ba | 8289:871b40c5a77a |
|---|---|
| 122 <p> | 122 <p> |
| 123 Constructor | 123 Constructor |
| 124 </p> | 124 </p> |
| 125 <dl> | 125 <dl> |
| 126 | 126 |
| 127 <dt><i>dialog</i></dt> | 127 <dt><i>dialog</i> (UMLDialog)</dt> |
| 128 <dd> | 128 <dd> |
| 129 reference to the UML dialog (UMLDialog) | 129 reference to the UML dialog |
| 130 </dd> | 130 </dd> |
| 131 <dt><i>view</i></dt> | 131 <dt><i>view</i> (UMLGraphicsView)</dt> |
| 132 <dd> | 132 <dd> |
| 133 reference to the view object (UMLGraphicsView) | 133 reference to the view object |
| 134 </dd> | 134 </dd> |
| 135 <dt><i>project</i></dt> | 135 <dt><i>project</i> (Project)</dt> |
| 136 <dd> | 136 <dd> |
| 137 reference to the project object (Project) | 137 reference to the project object |
| 138 </dd> | 138 </dd> |
| 139 <dt><i>file</i></dt> | 139 <dt><i>file</i> (str)</dt> |
| 140 <dd> | 140 <dd> |
| 141 file name of a python module to be shown (string) | 141 file name of a python module to be shown |
| 142 </dd> | 142 </dd> |
| 143 <dt><i>noAttrs</i></dt> | 143 <dt><i>noAttrs</i> (bool)</dt> |
| 144 <dd> | 144 <dd> |
| 145 flag indicating, that no attributes should be shown | 145 flag indicating, that no attributes should be shown |
| 146 (boolean) | |
| 147 </dd> | 146 </dd> |
| 148 </dl> | 147 </dl> |
| 149 <a NAME="UMLClassDiagramBuilder.__addExternalClass" ID="UMLClassDiagramBuilder.__addExternalClass"></a> | 148 <a NAME="UMLClassDiagramBuilder.__addExternalClass" ID="UMLClassDiagramBuilder.__addExternalClass"></a> |
| 150 <h4>UMLClassDiagramBuilder.__addExternalClass</h4> | 149 <h4>UMLClassDiagramBuilder.__addExternalClass</h4> |
| 151 <b>__addExternalClass</b>(<i>_class, x, y</i>) | 150 <b>__addExternalClass</b>(<i>_class, x, y</i>) |
| 157 If the canvas is too small to take the shape, it | 156 If the canvas is too small to take the shape, it |
| 158 is enlarged. | 157 is enlarged. |
| 159 </p> | 158 </p> |
| 160 <dl> | 159 <dl> |
| 161 | 160 |
| 162 <dt><i>_class</i></dt> | 161 <dt><i>_class</i> (ModuleParser.Class)</dt> |
| 163 <dd> | 162 <dd> |
| 164 class to be shown (string) | 163 class to be shown |
| 165 </dd> | 164 </dd> |
| 166 <dt><i>x</i></dt> | 165 <dt><i>x</i> (float)</dt> |
| 167 <dd> | 166 <dd> |
| 168 x-coordinate (float) | 167 x-coordinate |
| 169 </dd> | 168 </dd> |
| 170 <dt><i>y</i></dt> | 169 <dt><i>y</i> (float)</dt> |
| 171 <dd> | 170 <dd> |
| 172 y-coordinate (float) | 171 y-coordinate |
| 173 </dd> | 172 </dd> |
| 174 </dl> | 173 </dl> |
| 175 <a NAME="UMLClassDiagramBuilder.__addLocalClass" ID="UMLClassDiagramBuilder.__addLocalClass"></a> | 174 <a NAME="UMLClassDiagramBuilder.__addLocalClass" ID="UMLClassDiagramBuilder.__addLocalClass"></a> |
| 176 <h4>UMLClassDiagramBuilder.__addLocalClass</h4> | 175 <h4>UMLClassDiagramBuilder.__addLocalClass</h4> |
| 177 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>) | 176 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>) |
| 179 <p> | 178 <p> |
| 180 Private method to add a class defined in the module. | 179 Private method to add a class defined in the module. |
| 181 </p> | 180 </p> |
| 182 <dl> | 181 <dl> |
| 183 | 182 |
| 184 <dt><i>className</i></dt> | 183 <dt><i>className</i> (str)</dt> |
| 185 <dd> | 184 <dd> |
| 186 name of the class to be as a dictionary key (string) | 185 name of the class to be as a dictionary key |
| 187 </dd> | 186 </dd> |
| 188 <dt><i>_class</i></dt> | 187 <dt><i>_class</i> (ModuleParser.Class)</dt> |
| 189 <dd> | 188 <dd> |
| 190 class to be shown (ModuleParser.Class) | 189 class to be shown |
| 191 </dd> | 190 </dd> |
| 192 <dt><i>x</i></dt> | 191 <dt><i>x</i> (float)</dt> |
| 193 <dd> | 192 <dd> |
| 194 x-coordinate (float) | 193 x-coordinate |
| 195 </dd> | 194 </dd> |
| 196 <dt><i>y</i></dt> | 195 <dt><i>y</i> (float)</dt> |
| 197 <dd> | 196 <dd> |
| 198 y-coordinate (float) | 197 y-coordinate |
| 199 </dd> | 198 </dd> |
| 200 <dt><i>isRbModule</i></dt> | 199 <dt><i>isRbModule</i> (bool)</dt> |
| 201 <dd> | 200 <dd> |
| 202 flag indicating a Ruby module (boolean) | 201 flag indicating a Ruby module |
| 203 </dd> | 202 </dd> |
| 204 </dl> | 203 </dl> |
| 205 <a NAME="UMLClassDiagramBuilder.__arrangeClasses" ID="UMLClassDiagramBuilder.__arrangeClasses"></a> | 204 <a NAME="UMLClassDiagramBuilder.__arrangeClasses" ID="UMLClassDiagramBuilder.__arrangeClasses"></a> |
| 206 <h4>UMLClassDiagramBuilder.__arrangeClasses</h4> | 205 <h4>UMLClassDiagramBuilder.__arrangeClasses</h4> |
| 207 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>) | 206 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>) |
| 212 <p> | 211 <p> |
| 213 The algorithm is borrowed from Boa Constructor. | 212 The algorithm is borrowed from Boa Constructor. |
| 214 </p> | 213 </p> |
| 215 <dl> | 214 <dl> |
| 216 | 215 |
| 217 <dt><i>nodes</i></dt> | 216 <dt><i>nodes</i> (list of str)</dt> |
| 218 <dd> | 217 <dd> |
| 219 list of nodes to arrange | 218 list of nodes to arrange |
| 220 </dd> | 219 </dd> |
| 221 <dt><i>routes</i></dt> | 220 <dt><i>routes</i> (list of tuple of (str, str))</dt> |
| 222 <dd> | 221 <dd> |
| 223 list of routes | 222 list of routes |
| 224 </dd> | 223 </dd> |
| 225 <dt><i>whiteSpaceFactor</i></dt> | 224 <dt><i>whiteSpaceFactor</i> (float)</dt> |
| 226 <dd> | 225 <dd> |
| 227 factor to increase whitespace between | 226 factor to increase whitespace between |
| 228 items (float) | 227 items |
| 229 </dd> | 228 </dd> |
| 230 </dl> | 229 </dl> |
| 231 <a NAME="UMLClassDiagramBuilder.__createAssociations" ID="UMLClassDiagramBuilder.__createAssociations"></a> | 230 <a NAME="UMLClassDiagramBuilder.__createAssociations" ID="UMLClassDiagramBuilder.__createAssociations"></a> |
| 232 <h4>UMLClassDiagramBuilder.__createAssociations</h4> | 231 <h4>UMLClassDiagramBuilder.__createAssociations</h4> |
| 233 <b>__createAssociations</b>(<i>routes</i>) | 232 <b>__createAssociations</b>(<i>routes</i>) |
| 235 <p> | 234 <p> |
| 236 Private method to generate the associations between the class shapes. | 235 Private method to generate the associations between the class shapes. |
| 237 </p> | 236 </p> |
| 238 <dl> | 237 <dl> |
| 239 | 238 |
| 240 <dt><i>routes</i></dt> | 239 <dt><i>routes</i> (list of tuple of (str, str))</dt> |
| 241 <dd> | 240 <dd> |
| 242 list of relationsships | 241 list of relationsships |
| 243 </dd> | 242 </dd> |
| 244 </dl> | 243 </dl> |
| 245 <a NAME="UMLClassDiagramBuilder.__getCurrentShape" ID="UMLClassDiagramBuilder.__getCurrentShape"></a> | 244 <a NAME="UMLClassDiagramBuilder.__getCurrentShape" ID="UMLClassDiagramBuilder.__getCurrentShape"></a> |
| 249 <p> | 248 <p> |
| 250 Private method to get the named shape. | 249 Private method to get the named shape. |
| 251 </p> | 250 </p> |
| 252 <dl> | 251 <dl> |
| 253 | 252 |
| 254 <dt><i>name</i></dt> | 253 <dt><i>name</i> (str)</dt> |
| 255 <dd> | 254 <dd> |
| 256 name of the shape (string) | 255 name of the shape |
| 257 </dd> | 256 </dd> |
| 258 </dl> | 257 </dl> |
| 259 <dl> | 258 <dl> |
| 260 <dt>Return:</dt> | 259 <dt>Return:</dt> |
| 261 <dd> | 260 <dd> |
| 262 shape (QGraphicsItem) | 261 shape |
| 262 </dd> | |
| 263 </dl> | |
| 264 <dl> | |
| 265 <dt>Return Type:</dt> | |
| 266 <dd> | |
| 267 QGraphicsItem | |
| 263 </dd> | 268 </dd> |
| 264 </dl> | 269 </dl> |
| 265 <a NAME="UMLClassDiagramBuilder.buildDiagram" ID="UMLClassDiagramBuilder.buildDiagram"></a> | 270 <a NAME="UMLClassDiagramBuilder.buildDiagram" ID="UMLClassDiagramBuilder.buildDiagram"></a> |
| 266 <h4>UMLClassDiagramBuilder.buildDiagram</h4> | 271 <h4>UMLClassDiagramBuilder.buildDiagram</h4> |
| 267 <b>buildDiagram</b>(<i></i>) | 272 <b>buildDiagram</b>(<i></i>) |
| 280 Public method to get a string for data to be persisted. | 285 Public method to get a string for data to be persisted. |
| 281 </p> | 286 </p> |
| 282 <dl> | 287 <dl> |
| 283 <dt>Return:</dt> | 288 <dt>Return:</dt> |
| 284 <dd> | 289 <dd> |
| 285 persisted data string (string) | 290 persisted data string |
| 291 </dd> | |
| 292 </dl> | |
| 293 <dl> | |
| 294 <dt>Return Type:</dt> | |
| 295 <dd> | |
| 296 str | |
| 286 </dd> | 297 </dd> |
| 287 </dl> | 298 </dl> |
| 288 <a NAME="UMLClassDiagramBuilder.initialize" ID="UMLClassDiagramBuilder.initialize"></a> | 299 <a NAME="UMLClassDiagramBuilder.initialize" ID="UMLClassDiagramBuilder.initialize"></a> |
| 289 <h4>UMLClassDiagramBuilder.initialize</h4> | 300 <h4>UMLClassDiagramBuilder.initialize</h4> |
| 290 <b>initialize</b>(<i></i>) | 301 <b>initialize</b>(<i></i>) |
| 299 <p> | 310 <p> |
| 300 Public method to parse persisted data. | 311 Public method to parse persisted data. |
| 301 </p> | 312 </p> |
| 302 <dl> | 313 <dl> |
| 303 | 314 |
| 304 <dt><i>version</i></dt> | 315 <dt><i>version</i> (str)</dt> |
| 305 <dd> | 316 <dd> |
| 306 version of the data (string) | 317 version of the data |
| 307 </dd> | 318 </dd> |
| 308 <dt><i>data</i></dt> | 319 <dt><i>data</i> (str)</dt> |
| 309 <dd> | 320 <dd> |
| 310 persisted data to be parsed (string) | 321 persisted data to be parsed |
| 311 </dd> | 322 </dd> |
| 312 </dl> | 323 </dl> |
| 313 <dl> | 324 <dl> |
| 314 <dt>Return:</dt> | 325 <dt>Return:</dt> |
| 315 <dd> | 326 <dd> |
| 316 flag indicating success (boolean) | 327 flag indicating success |
| 328 </dd> | |
| 329 </dl> | |
| 330 <dl> | |
| 331 <dt>Return Type:</dt> | |
| 332 <dd> | |
| 333 bool | |
| 317 </dd> | 334 </dd> |
| 318 </dl> | 335 </dl> |
| 319 <div align="right"><a href="#top">Up</a></div> | 336 <div align="right"><a href="#top">Up</a></div> |
| 320 <hr /> | 337 <hr /> |
| 321 </body></html> | 338 </body></html> |
