Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Graphics.PackageDiagramBuilder.html

eric6/Documentation/Source/eric6.Graphics.PackageDiagramBuilder.html

changeset 8289
871b40c5a77a
parent 7989
a21d673a8f99
child 8294
cb4e5bbf3a2c
equal deleted inserted replaced
8288:809d5d5ac2ba 8289:871b40c5a77a
21 <body> 21 <body>
22 <a NAME="top" ID="top"></a> 22 <a NAME="top" ID="top"></a>
23 <h1>eric6.Graphics.PackageDiagramBuilder</h1> 23 <h1>eric6.Graphics.PackageDiagramBuilder</h1>
24 24
25 <p> 25 <p>
26 Module implementing a dialog showing a UML like class diagram of a package. 26 Module implementing a dialog showing an UML like class diagram of a package.
27 </p> 27 </p>
28 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29 29
30 <table> 30 <table>
31 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
134 <p> 134 <p>
135 Constructor 135 Constructor
136 </p> 136 </p>
137 <dl> 137 <dl>
138 138
139 <dt><i>dialog</i></dt> 139 <dt><i>dialog</i> (UMLDialog)</dt>
140 <dd> 140 <dd>
141 reference to the UML dialog (UMLDialog) 141 reference to the UML dialog
142 </dd> 142 </dd>
143 <dt><i>view</i></dt> 143 <dt><i>view</i> (UMLGraphicsView)</dt>
144 <dd> 144 <dd>
145 reference to the view object (UMLGraphicsView) 145 reference to the view object
146 </dd> 146 </dd>
147 <dt><i>project</i></dt> 147 <dt><i>project</i> (Project)</dt>
148 <dd> 148 <dd>
149 reference to the project object (Project) 149 reference to the project object
150 </dd> 150 </dd>
151 <dt><i>package</i></dt> 151 <dt><i>package</i> (str)</dt>
152 <dd> 152 <dd>
153 name of a python package to be shown (string) 153 name of a python package to be shown
154 </dd> 154 </dd>
155 <dt><i>noAttrs</i></dt> 155 <dt><i>noAttrs</i> (bool)</dt>
156 <dd> 156 <dd>
157 flag indicating, that no attributes should be shown 157 flag indicating, that no attributes should be shown
158 (boolean)
159 </dd> 158 </dd>
160 </dl> 159 </dl>
161 <a NAME="PackageDiagramBuilder.__addExternalClass" ID="PackageDiagramBuilder.__addExternalClass"></a> 160 <a NAME="PackageDiagramBuilder.__addExternalClass" ID="PackageDiagramBuilder.__addExternalClass"></a>
162 <h4>PackageDiagramBuilder.__addExternalClass</h4> 161 <h4>PackageDiagramBuilder.__addExternalClass</h4>
163 <b>__addExternalClass</b>(<i>_class, x, y</i>) 162 <b>__addExternalClass</b>(<i>_class, x, y</i>)
169 If the canvas is too small to take the shape, it 168 If the canvas is too small to take the shape, it
170 is enlarged. 169 is enlarged.
171 </p> 170 </p>
172 <dl> 171 <dl>
173 172
174 <dt><i>_class</i></dt> 173 <dt><i>_class</i> (ModuleParser.Class)</dt>
175 <dd> 174 <dd>
176 class to be shown (string) 175 class to be shown
177 </dd> 176 </dd>
178 <dt><i>x</i></dt> 177 <dt><i>x</i> (float)</dt>
179 <dd> 178 <dd>
180 x-coordinate (float) 179 x-coordinate
181 </dd> 180 </dd>
182 <dt><i>y</i></dt> 181 <dt><i>y</i> (float)</dt>
183 <dd> 182 <dd>
184 y-coordinate (float) 183 y-coordinate
185 </dd> 184 </dd>
186 </dl> 185 </dl>
187 <a NAME="PackageDiagramBuilder.__addLocalClass" ID="PackageDiagramBuilder.__addLocalClass"></a> 186 <a NAME="PackageDiagramBuilder.__addLocalClass" ID="PackageDiagramBuilder.__addLocalClass"></a>
188 <h4>PackageDiagramBuilder.__addLocalClass</h4> 187 <h4>PackageDiagramBuilder.__addLocalClass</h4>
189 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>) 188 <b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>)
191 <p> 190 <p>
192 Private method to add a class defined in the module. 191 Private method to add a class defined in the module.
193 </p> 192 </p>
194 <dl> 193 <dl>
195 194
196 <dt><i>className</i></dt> 195 <dt><i>className</i> (str)</dt>
197 <dd> 196 <dd>
198 name of the class to be as a dictionary key (string) 197 name of the class to be as a dictionary key
199 </dd> 198 </dd>
200 <dt><i>_class</i></dt> 199 <dt><i>_class</i> (ModuleParser.Class)</dt>
201 <dd> 200 <dd>
202 class to be shown (ModuleParser.Class) 201 class to be shown
203 </dd> 202 </dd>
204 <dt><i>x</i></dt> 203 <dt><i>x</i> (float)</dt>
205 <dd> 204 <dd>
206 x-coordinate (float) 205 x-coordinate
207 </dd> 206 </dd>
208 <dt><i>y</i></dt> 207 <dt><i>y</i> (float)</dt>
209 <dd> 208 <dd>
210 y-coordinate (float) 209 y-coordinate
211 </dd> 210 </dd>
212 <dt><i>isRbModule</i></dt> 211 <dt><i>isRbModule</i> (bool)</dt>
213 <dd> 212 <dd>
214 flag indicating a Ruby module (boolean) 213 flag indicating a Ruby module
215 </dd> 214 </dd>
216 </dl> 215 </dl>
217 <a NAME="PackageDiagramBuilder.__addPackage" ID="PackageDiagramBuilder.__addPackage"></a> 216 <a NAME="PackageDiagramBuilder.__addPackage" ID="PackageDiagramBuilder.__addPackage"></a>
218 <h4>PackageDiagramBuilder.__addPackage</h4> 217 <h4>PackageDiagramBuilder.__addPackage</h4>
219 <b>__addPackage</b>(<i>name, modules, x, y</i>) 218 <b>__addPackage</b>(<i>name, modules, x, y</i>)
221 <p> 220 <p>
222 Private method to add a package to the diagram. 221 Private method to add a package to the diagram.
223 </p> 222 </p>
224 <dl> 223 <dl>
225 224
226 <dt><i>name</i></dt> 225 <dt><i>name</i> (str)</dt>
227 <dd> 226 <dd>
228 package name to be shown (string) 227 package name to be shown
229 </dd> 228 </dd>
230 <dt><i>modules</i></dt> 229 <dt><i>modules</i> (list of str)</dt>
231 <dd> 230 <dd>
232 list of module names contained in the package 231 list of module names contained in the package
233 (list of strings) 232 </dd>
234 </dd> 233 <dt><i>x</i> (float)</dt>
235 <dt><i>x</i></dt> 234 <dd>
236 <dd> 235 x-coordinate
237 x-coordinate (float) 236 </dd>
238 </dd> 237 <dt><i>y</i> (float)</dt>
239 <dt><i>y</i></dt> 238 <dd>
240 <dd> 239 y-coordinate
241 y-coordinate (float)
242 </dd> 240 </dd>
243 </dl> 241 </dl>
244 <a NAME="PackageDiagramBuilder.__arrangeClasses" ID="PackageDiagramBuilder.__arrangeClasses"></a> 242 <a NAME="PackageDiagramBuilder.__arrangeClasses" ID="PackageDiagramBuilder.__arrangeClasses"></a>
245 <h4>PackageDiagramBuilder.__arrangeClasses</h4> 243 <h4>PackageDiagramBuilder.__arrangeClasses</h4>
246 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>) 244 <b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>)
251 <p> 249 <p>
252 The algorithm is borrowed from Boa Constructor. 250 The algorithm is borrowed from Boa Constructor.
253 </p> 251 </p>
254 <dl> 252 <dl>
255 253
256 <dt><i>nodes</i></dt> 254 <dt><i>nodes</i> (list of str)</dt>
257 <dd> 255 <dd>
258 list of nodes to arrange 256 list of nodes to arrange
259 </dd> 257 </dd>
260 <dt><i>routes</i></dt> 258 <dt><i>routes</i> (list of tuple of (str, str))</dt>
261 <dd> 259 <dd>
262 list of routes 260 list of routes
263 </dd> 261 </dd>
264 <dt><i>whiteSpaceFactor</i></dt> 262 <dt><i>whiteSpaceFactor</i> (float)</dt>
265 <dd> 263 <dd>
266 factor to increase whitespace between 264 factor to increase whitespace between
267 items (float) 265 items
268 </dd> 266 </dd>
269 </dl> 267 </dl>
270 <a NAME="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a> 268 <a NAME="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a>
271 <h4>PackageDiagramBuilder.__buildModulesDict</h4> 269 <h4>PackageDiagramBuilder.__buildModulesDict</h4>
272 <b>__buildModulesDict</b>(<i></i>) 270 <b>__buildModulesDict</b>(<i></i>)
276 package. 274 package.
277 </p> 275 </p>
278 <dl> 276 <dl>
279 <dt>Return:</dt> 277 <dt>Return:</dt>
280 <dd> 278 <dd>
281 dictionary of modules contained in the package. 279 dictionary of modules contained in the package
280 </dd>
281 </dl>
282 <dl>
283 <dt>Return Type:</dt>
284 <dd>
285 dict
282 </dd> 286 </dd>
283 </dl> 287 </dl>
284 <a NAME="PackageDiagramBuilder.__buildSubpackagesDict" ID="PackageDiagramBuilder.__buildSubpackagesDict"></a> 288 <a NAME="PackageDiagramBuilder.__buildSubpackagesDict" ID="PackageDiagramBuilder.__buildSubpackagesDict"></a>
285 <h4>PackageDiagramBuilder.__buildSubpackagesDict</h4> 289 <h4>PackageDiagramBuilder.__buildSubpackagesDict</h4>
286 <b>__buildSubpackagesDict</b>(<i></i>) 290 <b>__buildSubpackagesDict</b>(<i></i>)
293 <dt>Return:</dt> 297 <dt>Return:</dt>
294 <dd> 298 <dd>
295 dictionary of sub-packages contained in this package 299 dictionary of sub-packages contained in this package
296 </dd> 300 </dd>
297 </dl> 301 </dl>
302 <dl>
303 <dt>Return Type:</dt>
304 <dd>
305 dict
306 </dd>
307 </dl>
298 <a NAME="PackageDiagramBuilder.__createAssociations" ID="PackageDiagramBuilder.__createAssociations"></a> 308 <a NAME="PackageDiagramBuilder.__createAssociations" ID="PackageDiagramBuilder.__createAssociations"></a>
299 <h4>PackageDiagramBuilder.__createAssociations</h4> 309 <h4>PackageDiagramBuilder.__createAssociations</h4>
300 <b>__createAssociations</b>(<i>routes</i>) 310 <b>__createAssociations</b>(<i>routes</i>)
301 311
302 <p> 312 <p>
303 Private method to generate the associations between the class shapes. 313 Private method to generate the associations between the class shapes.
304 </p> 314 </p>
305 <dl> 315 <dl>
306 316
307 <dt><i>routes</i></dt> 317 <dt><i>routes</i> (list of tuple of (str, str))</dt>
308 <dd> 318 <dd>
309 list of relationsships 319 list of relationsships
310 </dd> 320 </dd>
311 </dl> 321 </dl>
312 <a NAME="PackageDiagramBuilder.__getCurrentShape" ID="PackageDiagramBuilder.__getCurrentShape"></a> 322 <a NAME="PackageDiagramBuilder.__getCurrentShape" ID="PackageDiagramBuilder.__getCurrentShape"></a>
316 <p> 326 <p>
317 Private method to get the named shape. 327 Private method to get the named shape.
318 </p> 328 </p>
319 <dl> 329 <dl>
320 330
321 <dt><i>name</i></dt> 331 <dt><i>name</i> (str)</dt>
322 <dd> 332 <dd>
323 name of the shape (string) 333 name of the shape
324 </dd> 334 </dd>
325 </dl> 335 </dl>
326 <dl> 336 <dl>
327 <dt>Return:</dt> 337 <dt>Return:</dt>
328 <dd> 338 <dd>
329 shape (QCanvasItem) 339 shape
340 </dd>
341 </dl>
342 <dl>
343 <dt>Return Type:</dt>
344 <dd>
345 QCanvasItem
330 </dd> 346 </dd>
331 </dl> 347 </dl>
332 <a NAME="PackageDiagramBuilder.buildDiagram" ID="PackageDiagramBuilder.buildDiagram"></a> 348 <a NAME="PackageDiagramBuilder.buildDiagram" ID="PackageDiagramBuilder.buildDiagram"></a>
333 <h4>PackageDiagramBuilder.buildDiagram</h4> 349 <h4>PackageDiagramBuilder.buildDiagram</h4>
334 <b>buildDiagram</b>(<i></i>) 350 <b>buildDiagram</b>(<i></i>)
347 Public method to get a string for data to be persisted. 363 Public method to get a string for data to be persisted.
348 </p> 364 </p>
349 <dl> 365 <dl>
350 <dt>Return:</dt> 366 <dt>Return:</dt>
351 <dd> 367 <dd>
352 persisted data string (string) 368 persisted data string
369 </dd>
370 </dl>
371 <dl>
372 <dt>Return Type:</dt>
373 <dd>
374 str
353 </dd> 375 </dd>
354 </dl> 376 </dl>
355 <a NAME="PackageDiagramBuilder.initialize" ID="PackageDiagramBuilder.initialize"></a> 377 <a NAME="PackageDiagramBuilder.initialize" ID="PackageDiagramBuilder.initialize"></a>
356 <h4>PackageDiagramBuilder.initialize</h4> 378 <h4>PackageDiagramBuilder.initialize</h4>
357 <b>initialize</b>(<i></i>) 379 <b>initialize</b>(<i></i>)
366 <p> 388 <p>
367 Public method to parse persisted data. 389 Public method to parse persisted data.
368 </p> 390 </p>
369 <dl> 391 <dl>
370 392
371 <dt><i>version</i></dt> 393 <dt><i>version</i> (str)</dt>
372 <dd> 394 <dd>
373 version of the data (string) 395 version of the data
374 </dd> 396 </dd>
375 <dt><i>data</i></dt> 397 <dt><i>data</i> (str)</dt>
376 <dd> 398 <dd>
377 persisted data to be parsed (string) 399 persisted data to be parsed
378 </dd> 400 </dd>
379 </dl> 401 </dl>
380 <dl> 402 <dl>
381 <dt>Return:</dt> 403 <dt>Return:</dt>
382 <dd> 404 <dd>
383 flag indicating success (boolean) 405 flag indicating success
406 </dd>
407 </dl>
408 <dl>
409 <dt>Return Type:</dt>
410 <dd>
411 bool
384 </dd> 412 </dd>
385 </dl> 413 </dl>
386 <div align="right"><a href="#top">Up</a></div> 414 <div align="right"><a href="#top">Up</a></div>
387 <hr /> 415 <hr />
388 </body></html> 416 </body></html>

Mercurial Repository: eric

eric ide

mercurial