eric6/Documentation/Source/eric6.Graphics.UMLDialog.html

changeset 8281
184ece570a2b
parent 8270
6ba3564b7161
child 8284
eeaed80810ff
diff -r 17d03699f151 -r 184ece570a2b eric6/Documentation/Source/eric6.Graphics.UMLDialog.html
--- a/eric6/Documentation/Source/eric6.Graphics.UMLDialog.html	Sun May 02 15:09:14 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Graphics.UMLDialog.html	Sun May 02 15:09:29 2021 +0200
@@ -38,6 +38,10 @@
 <td><a href="#UMLDialog">UMLDialog</a></td>
 <td>Class implementing a dialog showing UML like diagrams.</td>
 </tr>
+<tr>
+<td><a href="#UMLDialogType">UMLDialogType</a></td>
+<td>Class defining the UML dialog types.</td>
+</tr>
 </table>
 <h3>Functions</h3>
 
@@ -57,7 +61,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>ApplicationDiagram</td></tr><tr><td>ClassDiagram</td></tr><tr><td>FileVersions</td></tr><tr><td>ImportsDiagram</td></tr><tr><td>NoDiagram</td></tr><tr><td>PackageDiagram</td></tr>
+<tr><td>FileVersions</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -124,29 +128,28 @@
 </p>
 <dl>
 
-<dt><i>diagramType</i></dt>
+<dt><i>diagramType</i> (UMLDialogType)</dt>
 <dd>
-type of the diagram (one of ApplicationDiagram,
-            ClassDiagram, ImportsDiagram, NoDiagram, PackageDiagram)
+type of the diagram
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
-reference to the project object (Project)
+reference to the project object
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-file or directory path to build the diagram from (string)
+file or directory path to build the diagram from
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget of the dialog (QWidget)
+parent widget of the dialog
 </dd>
-<dt><i>initBuilder</i></dt>
+<dt><i>initBuilder</i> (bool)</dt>
 <dd>
 flag indicating to initialize the diagram
-            builder (boolean)
+            builder
 </dd>
-<dt><i>kwargs=</i></dt>
+<dt><i>kwargs=</i> (dict)</dt>
 <dd>
 diagram specific data
 </dd>
@@ -160,17 +163,15 @@
 </p>
 <dl>
 
-<dt><i>diagramType</i></dt>
+<dt><i>diagramType</i> (UMLDialogType)</dt>
 <dd>
 type of the diagram
-            (one of ApplicationDiagram, ClassDiagram, ImportsDiagram,
-            PackageDiagram)
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-file or directory path to build the diagram from (string)
+file or directory path to build the diagram from
 </dd>
-<dt><i>kwargs=</i></dt>
+<dt><i>kwargs=</i> (dict)</dt>
 <dd>
 diagram specific data
 </dd>
@@ -182,10 +183,9 @@
 </dd>
 </dl>
 <dl>
-
-<dt>Raises <b>ValueError</b>:</dt>
+<dt>Return Type:</dt>
 <dd>
-raised to indicate an illegal diagram type
+UMLDiagramBuilder
 </dd>
 </dl>
 <a NAME="UMLDialog.__initActions" ID="UMLDialog.__initActions"></a>
@@ -278,4 +278,36 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
+<hr />
+<a NAME="UMLDialogType" ID="UMLDialogType"></a>
+<h2>UMLDialogType</h2>
+
+<p>
+    Class defining the UML dialog types.
+</p>
+<h3>Derived from</h3>
+enum.Enum
+<h3>Class Attributes</h3>
+
+<table>
+<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>
+</table>
+<h3>Class Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<div align="right"><a href="#top">Up</a></div>
+<hr />
 </body></html>
\ No newline at end of file

eric ide

mercurial