|
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.ApplicationDiagram</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.ApplicationDiagram</h1> |
|
12 <p> |
|
13 Module implementing a dialog showing an imports diagram of the application. |
|
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="#ApplicationDiagram">ApplicationDiagram</a></td> |
|
23 <td>Class implementing a dialog showing an imports diagram of the application.</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="ApplicationDiagram" ID="ApplicationDiagram"></a> |
|
32 <h2>ApplicationDiagram</h2> |
|
33 <p> |
|
34 Class implementing a dialog showing an imports diagram of the application. |
|
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="#ApplicationDiagram.__init__">ApplicationDiagram</a></td> |
|
46 <td>Constructor</td> |
|
47 </tr><tr> |
|
48 <td><a href="#ApplicationDiagram.__addPackage">__addPackage</a></td> |
|
49 <td>Private method to add a package to the diagram.</td> |
|
50 </tr><tr> |
|
51 <td><a href="#ApplicationDiagram.__buildModulesDict">__buildModulesDict</a></td> |
|
52 <td>Private method to build a dictionary of modules contained in the application.</td> |
|
53 </tr><tr> |
|
54 <td><a href="#ApplicationDiagram.__buildPackages">__buildPackages</a></td> |
|
55 <td>Private method to build the packages shapes of the diagram.</td> |
|
56 </tr><tr> |
|
57 <td><a href="#ApplicationDiagram.__createAssociations">__createAssociations</a></td> |
|
58 <td>Private method to generate the associations between the package shapes.</td> |
|
59 </tr><tr> |
|
60 <td><a href="#ApplicationDiagram.relayout">relayout</a></td> |
|
61 <td>Method to relayout the diagram.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#ApplicationDiagram.show">show</a></td> |
|
64 <td>Overriden method to show the dialog.</td> |
|
65 </tr> |
|
66 </table> |
|
67 <a NAME="ApplicationDiagram.__init__" ID="ApplicationDiagram.__init__"></a> |
|
68 <h4>ApplicationDiagram (Constructor)</h4> |
|
69 <b>ApplicationDiagram</b>(<i>project, parent = None, name = None, noModules = False</i>) |
|
70 <p> |
|
71 Constructor |
|
72 </p><dl> |
|
73 <dt><i>project</i></dt> |
|
74 <dd> |
|
75 reference to the project object |
|
76 </dd><dt><i>parent</i></dt> |
|
77 <dd> |
|
78 parent widget of the view (QWidget) |
|
79 </dd><dt><i>name</i></dt> |
|
80 <dd> |
|
81 name of the view widget (string) |
|
82 </dd><dt><i>noModules=</i></dt> |
|
83 <dd> |
|
84 flag indicating, that no module names should be |
|
85 shown (boolean) |
|
86 </dd> |
|
87 </dl><a NAME="ApplicationDiagram.__addPackage" ID="ApplicationDiagram.__addPackage"></a> |
|
88 <h4>ApplicationDiagram.__addPackage</h4> |
|
89 <b>__addPackage</b>(<i>name, modules, x, y</i>) |
|
90 <p> |
|
91 Private method to add a package to the diagram. |
|
92 </p><dl> |
|
93 <dt><i>name</i></dt> |
|
94 <dd> |
|
95 package name to be shown (string) |
|
96 </dd><dt><i>modules</i></dt> |
|
97 <dd> |
|
98 list of module names contained in the package |
|
99 (list of strings) |
|
100 </dd><dt><i>x</i></dt> |
|
101 <dd> |
|
102 x-coordinate (float) |
|
103 </dd><dt><i>y</i></dt> |
|
104 <dd> |
|
105 y-coordinate (float) |
|
106 </dd> |
|
107 </dl><a NAME="ApplicationDiagram.__buildModulesDict" ID="ApplicationDiagram.__buildModulesDict"></a> |
|
108 <h4>ApplicationDiagram.__buildModulesDict</h4> |
|
109 <b>__buildModulesDict</b>(<i></i>) |
|
110 <p> |
|
111 Private method to build a dictionary of modules contained in the application. |
|
112 </p><dl> |
|
113 <dt>Returns:</dt> |
|
114 <dd> |
|
115 dictionary of modules contained in the application. |
|
116 </dd> |
|
117 </dl><a NAME="ApplicationDiagram.__buildPackages" ID="ApplicationDiagram.__buildPackages"></a> |
|
118 <h4>ApplicationDiagram.__buildPackages</h4> |
|
119 <b>__buildPackages</b>(<i></i>) |
|
120 <p> |
|
121 Private method to build the packages shapes of the diagram. |
|
122 </p><a NAME="ApplicationDiagram.__createAssociations" ID="ApplicationDiagram.__createAssociations"></a> |
|
123 <h4>ApplicationDiagram.__createAssociations</h4> |
|
124 <b>__createAssociations</b>(<i>shapes</i>) |
|
125 <p> |
|
126 Private method to generate the associations between the package shapes. |
|
127 </p><dl> |
|
128 <dt><i>shapes</i></dt> |
|
129 <dd> |
|
130 list of shapes |
|
131 </dd> |
|
132 </dl><a NAME="ApplicationDiagram.relayout" ID="ApplicationDiagram.relayout"></a> |
|
133 <h4>ApplicationDiagram.relayout</h4> |
|
134 <b>relayout</b>(<i></i>) |
|
135 <p> |
|
136 Method to relayout the diagram. |
|
137 </p><a NAME="ApplicationDiagram.show" ID="ApplicationDiagram.show"></a> |
|
138 <h4>ApplicationDiagram.show</h4> |
|
139 <b>show</b>(<i></i>) |
|
140 <p> |
|
141 Overriden method to show the dialog. |
|
142 </p> |
|
143 <div align="right"><a href="#top">Up</a></div> |
|
144 <hr /> |
|
145 </body></html> |