← Back to branch summary

~ubuntu-branches/ubuntu/karmic/eric/karmic

« back to all changes in this revision

Viewing changes to eric/Documentation/Source/eric3doc-eric3.Graphics.UMLClassDiagram.html

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2008-01-28 18:02:25 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20080128180225-6nrox6yrworh2c4v
Tags: 4.0.4-1ubuntu1
* Add python-qt3 to build-depends becuase that's where Ubuntu puts 
  pyqtconfig
* Change maintainer to MOTU

Show diffs side-by-side

added added

removed removed

Lines of Context:
eric/Documentation/Source/eric3doc-eric3.Graphics.UMLClassDiagram.html
1
 
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
2
 
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
3
 
<html><head>
4
 
<title>eric3.Graphics.UMLClassDiagram</title>
5
 
</head>
6
 
<body bgcolor="#FFFFFF"><a NAME="top" ID="top"></a>
7
 
<h1><font color="#0000FF">eric3.Graphics.UMLClassDiagram</font></h1>
8
 
<p>
9
 
Module implementing a dialog showing a UML like class diagram.
10
 
</p>
11
 
<h3><font color="#FF0000">Classes</font></h3>
12
 
<table>
13
 
<tr>
14
 
<td><a href="#UMLClassDiagram">UMLClassDiagram</a></td>
15
 
<td>Class implementing a dialog showing a UML like class diagram.</td>
16
 
</tr>
17
 
</table>
18
 
<h3><font color="#FF0000">Functions</font></h3>
19
 
<table>
20
 
<tr>
21
 
<td><a href="#resetCachedWidgets">resetCachedWidgets</a></td>
22
 
<td>Module function to reset the list of cached widgets.</td>
23
 
</tr><tr>
24
 
<td><a href="#resetCachedWidgetsByFile">resetCachedWidgetsByFile</a></td>
25
 
<td>Module function to reset the list of cached widgets belonging to a file.</td>
26
 
</tr>
27
 
</table>
28
 
<hr /><hr />
29
 
<a NAME="UMLClassDiagram" ID="UMLClassDiagram"></a>
30
 
<h2><font color="#0000FF">UMLClassDiagram</font></h2>
31
 
<p>
32
 
    Class implementing a dialog showing a UML like class diagram.
33
 
</p>
34
 
<h3><font color="#FF0000">Derived from</font></h3>
35
 
QDialog
36
 
<h3><font color="#FF0000">Methods</font></h3>
37
 
<table>
38
 
<tr>
39
 
<td><a href="#UMLClassDiagram.__init__">UMLClassDiagram</a></td>
40
 
<td>Constructor</td>
41
 
</tr><tr>
42
 
<td><a href="#UMLClassDiagram.__tr">__tr</a></td>
43
 
<td>Private method to translate the display strings.</td>
44
 
</tr><tr>
45
 
<td><a href="#UMLClassDiagram.addExternalClass">addExternalClass</a></td>
46
 
<td>Private method to add a class defined outside the module.</td>
47
 
</tr><tr>
48
 
<td><a href="#UMLClassDiagram.addLocalClass">addLocalClass</a></td>
49
 
<td>Private method to add a class defined in the module.</td>
50
 
</tr><tr>
51
 
<td><a href="#UMLClassDiagram.arrangeClasses">arrangeClasses</a></td>
52
 
<td>Private method to arrange the shapes on the canvas.</td>
53
 
</tr><tr>
54
 
<td><a href="#UMLClassDiagram.buildClasses">buildClasses</a></td>
55
 
<td>Private method to build the class shapes of the class diagram.</td>
56
 
</tr><tr>
57
 
<td><a href="#UMLClassDiagram.createAssociations">createAssociations</a></td>
58
 
<td>Private method to generate the associations between the class shapes.</td>
59
 
</tr><tr>
60
 
<td><a href="#UMLClassDiagram.getCurrentShape">getCurrentShape</a></td>
61
 
<td>Private method to get the named shape.</td>
62
 
</tr><tr>
63
 
<td><a href="#UMLClassDiagram.getDiagramName">getDiagramName</a></td>
64
 
<td>Method to retrieve a name for the diagram.</td>
65
 
</tr><tr>
66
 
<td><a href="#UMLClassDiagram.languageChange">languageChange</a></td>
67
 
<td>Private method used to show the localized strings for this dialog.</td>
68
 
</tr><tr>
69
 
<td><a href="#UMLClassDiagram.relayout">relayout</a></td>
70
 
<td>Method to relayout the diagram.</td>
71
 
</tr><tr>
72
 
<td><a href="#UMLClassDiagram.show">show</a></td>
73
 
<td>Overriden method to show the dialog.</td>
74
 
</tr>
75
 
</table>
76
 
<p><a NAME="UMLClassDiagram.__init__" ID="UMLClassDiagram__init__"></a>
77
 
<h3><font color="#0000FF">UMLClassDiagram (Constructor)</font></h3>
78
 
<b>UMLClassDiagram</b>(<i>file, parent = None, name = None, modal = 0, fl = 0, noAttrs=0</i>)
79
 
<p>
80
 
        Constructor
81
 
</p><dl>
82
 
<dt><i>file</i></dt>
83
 
<dd>
84
 
filename of a python module 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 (QString or string)
91
 
</dd><dt><i>flags</i></dt>
92
 
<dd>
93
 
the window flags to be passed to the view widget
94
 
</dd><dt><i>noAttrs=</i></dt>
95
 
<dd>
96
 
flag indicating, that no attributes should be shown (boolean)
97
 
</dd>
98
 
</dl><a NAME="UMLClassDiagram.__tr" ID="UMLClassDiagram__tr"></a>
99
 
<h3><font color="#0000FF">UMLClassDiagram.__tr</font></h3>
100
 
<b>__tr</b>(<i>s, c = None</i>)
101
 
<p>
102
 
        Private method to translate the display strings.
103
 
</p><a NAME="UMLClassDiagram.addExternalClass" ID="UMLClassDiagramaddExternalClass"></a>
104
 
<h3><font color="#0000FF">UMLClassDiagram.addExternalClass</font></h3>
105
 
<b>addExternalClass</b>(<i>_class, x, y</i>)
106
 
<p>
107
 
        Private method to add a class defined outside the module.
108
 
</p><p>
109
 
        If the canvas is too small to take the shape, it
110
 
        is enlarged.
111
 
</p><dl>
112
 
<dt><i>_class</i></dt>
113
 
<dd>
114
 
class to be shown (string)
115
 
</dd><dt><i>x</i></dt>
116
 
<dd>
117
 
x-coordinate (integer)
118
 
</dd><dt><i>y</i></dt>
119
 
<dd>
120
 
y-coordinate (integer)
121
 
</dd>
122
 
</dl><a NAME="UMLClassDiagram.addLocalClass" ID="UMLClassDiagramaddLocalClass"></a>
123
 
<h3><font color="#0000FF">UMLClassDiagram.addLocalClass</font></h3>
124
 
<b>addLocalClass</b>(<i>className, _class, x, y, isRbModule=0</i>)
125
 
<p>
126
 
        Private method to add a class defined in the module.
127
 
</p><p>
128
 
        If the canvas is too small to take the shape, it
129
 
        is enlarged.
130
 
</p><dl>
131
 
<dt><i>className</i></dt>
132
 
<dd>
133
 
name of the class to be as a dictionary key (string)
134
 
</dd><dt><i>_class</i></dt>
135
 
<dd>
136
 
class to be shown (ModuleParser.Class)
137
 
</dd><dt><i>x</i></dt>
138
 
<dd>
139
 
x-coordinate (integer)
140
 
</dd><dt><i>y</i></dt>
141
 
<dd>
142
 
y-coordinate (integer)
143
 
</dd><dt><i>isRbModule</i></dt>
144
 
<dd>
145
 
flag indicating a Ruby module (boolean)
146
 
</dd>
147
 
</dl><a NAME="UMLClassDiagram.arrangeClasses" ID="UMLClassDiagramarrangeClasses"></a>
148
 
<h3><font color="#0000FF">UMLClassDiagram.arrangeClasses</font></h3>
149
 
<b>arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor = 1.2</i>)
150
 
<p>
151
 
        Private method to arrange the shapes on the canvas.
152
 
</p><p>
153
 
        The algorithm is borrowed from Boa Constructor.
154
 
</p><a NAME="UMLClassDiagram.buildClasses" ID="UMLClassDiagrambuildClasses"></a>
155
 
<h3><font color="#0000FF">UMLClassDiagram.buildClasses</font></h3>
156
 
<b>buildClasses</b>(<i></i>)
157
 
<p>
158
 
        Private method to build the class shapes of the class diagram.
159
 
</p><p>
160
 
        The algorithm is borrowed from Boa Constructor.
161
 
</p><a NAME="UMLClassDiagram.createAssociations" ID="UMLClassDiagramcreateAssociations"></a>
162
 
<h3><font color="#0000FF">UMLClassDiagram.createAssociations</font></h3>
163
 
<b>createAssociations</b>(<i>routes</i>)
164
 
<p>
165
 
        Private method to generate the associations between the class shapes.
166
 
</p><dl>
167
 
<dt><i>routes</i></dt>
168
 
<dd>
169
 
list of relationsships
170
 
</dd>
171
 
</dl><a NAME="UMLClassDiagram.getCurrentShape" ID="UMLClassDiagramgetCurrentShape"></a>
172
 
<h3><font color="#0000FF">UMLClassDiagram.getCurrentShape</font></h3>
173
 
<b>getCurrentShape</b>(<i>name</i>)
174
 
<p>
175
 
        Private method to get the named shape.
176
 
</p><dl>
177
 
<dt><i>name</i></dt>
178
 
<dd>
179
 
name of the shape (string)
180
 
</dd>
181
 
</dl><dl>
182
 
<dt>Returns:</dt>
183
 
<dd>
184
 
shape (QCanvasItem)
185
 
</dd>
186
 
</dl><a NAME="UMLClassDiagram.getDiagramName" ID="UMLClassDiagramgetDiagramName"></a>
187
 
<h3><font color="#0000FF">UMLClassDiagram.getDiagramName</font></h3>
188
 
<b>getDiagramName</b>(<i></i>)
189
 
<p>
190
 
        Method to retrieve a name for the diagram.
191
 
</p><dl>
192
 
<dt>Returns:</dt>
193
 
<dd>
194
 
name for the diagram
195
 
</dd>
196
 
</dl><a NAME="UMLClassDiagram.languageChange" ID="UMLClassDiagramlanguageChange"></a>
197
 
<h3><font color="#0000FF">UMLClassDiagram.languageChange</font></h3>
198
 
<b>languageChange</b>(<i></i>)
199
 
<p>
200
 
        Private method used to show the localized strings for this dialog.
201
 
</p><a NAME="UMLClassDiagram.relayout" ID="UMLClassDiagramrelayout"></a>
202
 
<h3><font color="#0000FF">UMLClassDiagram.relayout</font></h3>
203
 
<b>relayout</b>(<i></i>)
204
 
<p>
205
 
        Method to relayout the diagram.
206
 
</p><a NAME="UMLClassDiagram.show" ID="UMLClassDiagramshow"></a>
207
 
<h3><font color="#0000FF">UMLClassDiagram.show</font></h3>
208
 
<b>show</b>(<i></i>)
209
 
<p>
210
 
        Overriden method to show the dialog.
211
 
</p></p>
212
 
<div align="right"><a href="#top">Up</a></div>
213
 
<hr /><hr />
214
 
<a NAME="resetCachedWidgets" ID="resetCachedWidgets"></a>
215
 
<h2><font color="#0000FF">resetCachedWidgets</font></h2>
216
 
<b>resetCachedWidgets</b>(<i></i>)
217
 
<p>
218
 
    Module function to reset the list of cached widgets.
219
 
</p>
220
 
<div align="right"><a href="#top">Up</a></div>
221
 
<hr /><hr />
222
 
<a NAME="resetCachedWidgetsByFile" ID="resetCachedWidgetsByFile"></a>
223
 
<h2><font color="#0000FF">resetCachedWidgetsByFile</font></h2>
224
 
<b>resetCachedWidgetsByFile</b>(<i>filename</i>)
225
 
<p>
226
 
    Module function to reset the list of cached widgets belonging to a file.
227
 
</p><dl>
228
 
<dt><i>file</i></dt>
229
 
<dd>
230
 
filename of the widgets to be removed from cache (string)
231
 
</dd>
232
 
</dl>
233
 
<div align="right"><a href="#top">Up</a></div>
234
 
<hr />
235
 
</body></html>
 
 
b'\\ No newline at end of file'