Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Graphics.UMLDialog.html

src/eric7/Documentation/Source/eric7.Graphics.UMLDialog.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10479
856476537696
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Graphics.UMLDialog</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Graphics.UMLDialog</h1>
10
11 <p>
12 Module implementing a dialog showing UML like diagrams.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#UMLDialog">UMLDialog</a></td>
25 <td>Class implementing a dialog showing UML like diagrams.</td>
26 </tr>
27 <tr>
28 <td><a href="#UMLDialogType">UMLDialogType</a></td>
29 <td>Class defining the UML dialog types.</td>
30 </tr>
31 </table>
32 <h3>Functions</h3>
33
34 <table>
35 <tr><td>None</td></tr>
36 </table>
37 <hr />
38 <hr />
39 <a NAME="UMLDialog" ID="UMLDialog"></a>
40 <h2>UMLDialog</h2>
41
42 <p>
43 Class implementing a dialog showing UML like diagrams.
44 </p>
45 <h3>Derived from</h3>
46 EricMainWindow
47 <h3>Class Attributes</h3>
48
49 <table>
50 <tr><td>FileVersions</td></tr><tr><td>JsonFileVersions</td></tr><tr><td>UMLDialogType2String</td></tr>
51 </table>
52 <h3>Class Methods</h3>
53
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58
59 <table>
60
61 <tr>
62 <td><a href="#UMLDialog.__init__">UMLDialog</a></td>
63 <td>Constructor</td>
64 </tr>
65 <tr>
66 <td><a href="#UMLDialog.__diagramBuilder">__diagramBuilder</a></td>
67 <td>Private method to instantiate a diagram builder object.</td>
68 </tr>
69 <tr>
70 <td><a href="#UMLDialog.__getDiagramTitel">__getDiagramTitel</a></td>
71 <td>Private method to get a textual description for the diagram type.</td>
72 </tr>
73 <tr>
74 <td><a href="#UMLDialog.__initActions">__initActions</a></td>
75 <td>Private slot to initialize the actions.</td>
76 </tr>
77 <tr>
78 <td><a href="#UMLDialog.__initToolBars">__initToolBars</a></td>
79 <td>Private slot to initialize the toolbars.</td>
80 </tr>
81 <tr>
82 <td><a href="#UMLDialog.__readJsonGraphicsFile">__readJsonGraphicsFile</a></td>
83 <td>Private method to read an eric graphics file using the JSON based file format.</td>
84 </tr>
85 <tr>
86 <td><a href="#UMLDialog.__readLineBasedGraphicsFile">__readLineBasedGraphicsFile</a></td>
87 <td>Private method to read an eric graphics file using the old line based file format.</td>
88 </tr>
89 <tr>
90 <td><a href="#UMLDialog.__relayout">__relayout</a></td>
91 <td>Private method to re-layout the diagram.</td>
92 </tr>
93 <tr>
94 <td><a href="#UMLDialog.__save">__save</a></td>
95 <td>Private slot to save the diagram with the current name.</td>
96 </tr>
97 <tr>
98 <td><a href="#UMLDialog.__saveAs">__saveAs</a></td>
99 <td>Private slot to save the diagram.</td>
100 </tr>
101 <tr>
102 <td><a href="#UMLDialog.__showInvalidDataMessage">__showInvalidDataMessage</a></td>
103 <td>Private slot to show a message dialog indicating an invalid data file.</td>
104 </tr>
105 <tr>
106 <td><a href="#UMLDialog.__writeJsonGraphicsFile">__writeJsonGraphicsFile</a></td>
107 <td>Private method to write an eric graphics file using the JSON based file format.</td>
108 </tr>
109 <tr>
110 <td><a href="#UMLDialog.load">load</a></td>
111 <td>Public method to load a diagram from a file.</td>
112 </tr>
113 <tr>
114 <td><a href="#UMLDialog.show">show</a></td>
115 <td>Public method to show the dialog.</td>
116 </tr>
117 </table>
118 <h3>Static Methods</h3>
119
120 <table>
121 <tr><td>None</td></tr>
122 </table>
123
124 <a NAME="UMLDialog.__init__" ID="UMLDialog.__init__"></a>
125 <h4>UMLDialog (Constructor)</h4>
126 <b>UMLDialog</b>(<i>diagramType, project, path="", parent=None, initBuilder=True, **kwargs</i>)
127
128 <p>
129 Constructor
130 </p>
131 <dl>
132
133 <dt><i>diagramType</i> (UMLDialogType)</dt>
134 <dd>
135 type of the diagram
136 </dd>
137 <dt><i>project</i> (Project)</dt>
138 <dd>
139 reference to the project object
140 </dd>
141 <dt><i>path</i> (str)</dt>
142 <dd>
143 file or directory path to build the diagram from
144 </dd>
145 <dt><i>parent</i> (QWidget)</dt>
146 <dd>
147 parent widget of the dialog
148 </dd>
149 <dt><i>initBuilder</i> (bool)</dt>
150 <dd>
151 flag indicating to initialize the diagram
152 builder
153 </dd>
154 <dt><i>kwargs=</i> (dict)</dt>
155 <dd>
156 diagram specific data
157 </dd>
158 </dl>
159 <a NAME="UMLDialog.__diagramBuilder" ID="UMLDialog.__diagramBuilder"></a>
160 <h4>UMLDialog.__diagramBuilder</h4>
161 <b>__diagramBuilder</b>(<i>diagramType, path, **kwargs</i>)
162
163 <p>
164 Private method to instantiate a diagram builder object.
165 </p>
166 <dl>
167
168 <dt><i>diagramType</i> (UMLDialogType)</dt>
169 <dd>
170 type of the diagram
171 </dd>
172 <dt><i>path</i> (str)</dt>
173 <dd>
174 file or directory path to build the diagram from
175 </dd>
176 <dt><i>kwargs=</i> (dict)</dt>
177 <dd>
178 diagram specific data
179 </dd>
180 </dl>
181 <dl>
182 <dt>Return:</dt>
183 <dd>
184 reference to the instantiated diagram builder
185 </dd>
186 </dl>
187 <dl>
188 <dt>Return Type:</dt>
189 <dd>
190 UMLDiagramBuilder
191 </dd>
192 </dl>
193 <a NAME="UMLDialog.__getDiagramTitel" ID="UMLDialog.__getDiagramTitel"></a>
194 <h4>UMLDialog.__getDiagramTitel</h4>
195 <b>__getDiagramTitel</b>(<i>diagramType</i>)
196
197 <p>
198 Private method to get a textual description for the diagram type.
199 </p>
200 <dl>
201
202 <dt><i>diagramType</i> (str)</dt>
203 <dd>
204 diagram type string
205 </dd>
206 </dl>
207 <dl>
208 <dt>Return:</dt>
209 <dd>
210 titel of the diagram
211 </dd>
212 </dl>
213 <dl>
214 <dt>Return Type:</dt>
215 <dd>
216 str
217 </dd>
218 </dl>
219 <a NAME="UMLDialog.__initActions" ID="UMLDialog.__initActions"></a>
220 <h4>UMLDialog.__initActions</h4>
221 <b>__initActions</b>(<i></i>)
222
223 <p>
224 Private slot to initialize the actions.
225 </p>
226 <a NAME="UMLDialog.__initToolBars" ID="UMLDialog.__initToolBars"></a>
227 <h4>UMLDialog.__initToolBars</h4>
228 <b>__initToolBars</b>(<i></i>)
229
230 <p>
231 Private slot to initialize the toolbars.
232 </p>
233 <a NAME="UMLDialog.__readJsonGraphicsFile" ID="UMLDialog.__readJsonGraphicsFile"></a>
234 <h4>UMLDialog.__readJsonGraphicsFile</h4>
235 <b>__readJsonGraphicsFile</b>(<i>filename</i>)
236
237 <p>
238 Private method to read an eric graphics file using the JSON based
239 file format.
240 </p>
241 <dl>
242
243 <dt><i>filename</i> (str)</dt>
244 <dd>
245 name of the file to be read
246 </dd>
247 </dl>
248 <dl>
249 <dt>Return:</dt>
250 <dd>
251 flag indicating a successful read
252 </dd>
253 </dl>
254 <dl>
255 <dt>Return Type:</dt>
256 <dd>
257 bool
258 </dd>
259 </dl>
260 <a NAME="UMLDialog.__readLineBasedGraphicsFile" ID="UMLDialog.__readLineBasedGraphicsFile"></a>
261 <h4>UMLDialog.__readLineBasedGraphicsFile</h4>
262 <b>__readLineBasedGraphicsFile</b>(<i>filename</i>)
263
264 <p>
265 Private method to read an eric graphics file using the old line
266 based file format.
267 </p>
268 <dl>
269
270 <dt><i>filename</i> (str)</dt>
271 <dd>
272 name of the file to be read
273 </dd>
274 </dl>
275 <dl>
276 <dt>Return:</dt>
277 <dd>
278 flag indicating success
279 </dd>
280 </dl>
281 <dl>
282 <dt>Return Type:</dt>
283 <dd>
284 bool
285 </dd>
286 </dl>
287 <a NAME="UMLDialog.__relayout" ID="UMLDialog.__relayout"></a>
288 <h4>UMLDialog.__relayout</h4>
289 <b>__relayout</b>(<i></i>)
290
291 <p>
292 Private method to re-layout the diagram.
293 </p>
294 <a NAME="UMLDialog.__save" ID="UMLDialog.__save"></a>
295 <h4>UMLDialog.__save</h4>
296 <b>__save</b>(<i></i>)
297
298 <p>
299 Private slot to save the diagram with the current name.
300 </p>
301 <a NAME="UMLDialog.__saveAs" ID="UMLDialog.__saveAs"></a>
302 <h4>UMLDialog.__saveAs</h4>
303 <b>__saveAs</b>(<i>filename=""</i>)
304
305 <p>
306 Private slot to save the diagram.
307 </p>
308 <dl>
309
310 <dt><i>filename</i> (str)</dt>
311 <dd>
312 name of the file to write to
313 </dd>
314 </dl>
315 <a NAME="UMLDialog.__showInvalidDataMessage" ID="UMLDialog.__showInvalidDataMessage"></a>
316 <h4>UMLDialog.__showInvalidDataMessage</h4>
317 <b>__showInvalidDataMessage</b>(<i>filename, linenum=-1</i>)
318
319 <p>
320 Private slot to show a message dialog indicating an invalid data file.
321 </p>
322 <dl>
323
324 <dt><i>filename</i> (str)</dt>
325 <dd>
326 name of the file containing the invalid data
327 </dd>
328 <dt><i>linenum</i> (int)</dt>
329 <dd>
330 number of the invalid line
331 </dd>
332 </dl>
333 <a NAME="UMLDialog.__writeJsonGraphicsFile" ID="UMLDialog.__writeJsonGraphicsFile"></a>
334 <h4>UMLDialog.__writeJsonGraphicsFile</h4>
335 <b>__writeJsonGraphicsFile</b>(<i>filename</i>)
336
337 <p>
338 Private method to write an eric graphics file using the JSON based
339 file format.
340 </p>
341 <dl>
342
343 <dt><i>filename</i> (str)</dt>
344 <dd>
345 name of the file to write to
346 </dd>
347 </dl>
348 <dl>
349 <dt>Return:</dt>
350 <dd>
351 flag indicating a successful write
352 </dd>
353 </dl>
354 <dl>
355 <dt>Return Type:</dt>
356 <dd>
357 bool
358 </dd>
359 </dl>
360 <a NAME="UMLDialog.load" ID="UMLDialog.load"></a>
361 <h4>UMLDialog.load</h4>
362 <b>load</b>(<i>filename=""</i>)
363
364 <p>
365 Public method to load a diagram from a file.
366 </p>
367 <dl>
368
369 <dt><i>filename</i> (str)</dt>
370 <dd>
371 name of the file to be loaded
372 </dd>
373 </dl>
374 <dl>
375 <dt>Return:</dt>
376 <dd>
377 flag indicating success
378 </dd>
379 </dl>
380 <dl>
381 <dt>Return Type:</dt>
382 <dd>
383 bool
384 </dd>
385 </dl>
386 <a NAME="UMLDialog.show" ID="UMLDialog.show"></a>
387 <h4>UMLDialog.show</h4>
388 <b>show</b>(<i>fromFile=False</i>)
389
390 <p>
391 Public method to show the dialog.
392 </p>
393 <dl>
394
395 <dt><i>fromFile</i> (bool)</dt>
396 <dd>
397 flag indicating, that the diagram was loaded
398 from file
399 </dd>
400 </dl>
401 <div align="right"><a href="#top">Up</a></div>
402 <hr />
403 <hr />
404 <a NAME="UMLDialogType" ID="UMLDialogType"></a>
405 <h2>UMLDialogType</h2>
406
407 <p>
408 Class defining the UML dialog types.
409 </p>
410 <h3>Derived from</h3>
411 enum.Enum
412 <h3>Class Attributes</h3>
413
414 <table>
415 <tr><td>APPLICATION_DIAGRAM</td></tr><tr><td>CLASS_DIAGRAM</td></tr><tr><td>IMPORTS_DIAGRAM</td></tr><tr><td>NO_DIAGRAM</td></tr><tr><td>PACKAGE_DIAGRAM</td></tr>
416 </table>
417 <h3>Class Methods</h3>
418
419 <table>
420 <tr><td>None</td></tr>
421 </table>
422 <h3>Methods</h3>
423
424 <table>
425 <tr><td>None</td></tr>
426 </table>
427 <h3>Static Methods</h3>
428
429 <table>
430 <tr><td>None</td></tr>
431 </table>
432
433 <div align="right"><a href="#top">Up</a></div>
434 <hr />
435 </body></html>

Mercurial Repository: eric

eric ide

mercurial