Documentation/Source/eric5.Graphics.UMLDialog.html

changeset 2033
4b99609f6a87
parent 2031
c36c2eb62a75
child 2035
11bb61bc138d
--- a/Documentation/Source/eric5.Graphics.UMLDialog.html	Sun Sep 09 17:46:32 2012 +0200
+++ b/Documentation/Source/eric5.Graphics.UMLDialog.html	Sun Sep 09 19:38:07 2012 +0200
@@ -53,7 +53,10 @@
 </table>
 <h3>Class Methods</h3>
 <table>
-<tr><td>None</td></tr>
+<tr>
+<td><a href="#UMLDialog.generateDialogFromFile">generateDialogFromFile</a></td>
+<td>Class method to generate a dialog reading data from a file.</td>
+</tr>
 </table>
 <h3>Methods</h3>
 <table>
@@ -64,11 +67,23 @@
 <td><a href="#UMLDialog.__diagramBuilder">__diagramBuilder</a></td>
 <td>Private method to instantiate a diagram builder object.</td>
 </tr><tr>
+<td><a href="#UMLDialog.__diagramTypeString">__diagramTypeString</a></td>
+<td>Private method to generate a readable string for the diagram type.</td>
+</tr><tr>
+<td><a href="#UMLDialog.__initActions">__initActions</a></td>
+<td>Private slot to initialize the actions.</td>
+</tr><tr>
+<td><a href="#UMLDialog.__initToolBars">__initToolBars</a></td>
+<td>Private slot to initialize the toolbars.</td>
+</tr><tr>
 <td><a href="#UMLDialog.__relayout">__relayout</a></td>
 <td>Private method to relayout the diagram.</td>
 </tr><tr>
-<td><a href="#UMLDialog.diagramTypeToString">diagramTypeToString</a></td>
-<td>Public method to convert the diagram type to a readable string.</td>
+<td><a href="#UMLDialog.__save">__save</a></td>
+<td>Private slot to save the diagram with the current name.</td>
+</tr><tr>
+<td><a href="#UMLDialog.__saveAs">__saveAs</a></td>
+<td>Private slot to save the diagram.</td>
 </tr><tr>
 <td><a href="#UMLDialog.show">show</a></td>
 <td>Overriden method to show the dialog.</td>
@@ -78,9 +93,27 @@
 <table>
 <tr><td>None</td></tr>
 </table>
-<a NAME="UMLDialog.__init__" ID="UMLDialog.__init__"></a>
+<a NAME="UMLDialog.generateDialogFromFile" ID="UMLDialog.generateDialogFromFile"></a>
+<h4>UMLDialog.generateDialogFromFile (class method)</h4>
+<b>generateDialogFromFile</b>(<i>project, parent=None</i>)
+<p>
+        Class method to generate a dialog reading data from a file.
+</p><dl>
+<dt><i>project</i></dt>
+<dd>
+reference to the project object (Project)
+</dd><dt><i>parent</i></dt>
+<dd>
+parent widget of the dialog (QWidget)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+generated dialog (UMLDialog)
+</dd>
+</dl><a NAME="UMLDialog.__init__" ID="UMLDialog.__init__"></a>
 <h4>UMLDialog (Constructor)</h4>
-<b>UMLDialog</b>(<i>diagramType, project, path, parent=None, **kwargs</i>)
+<b>UMLDialog</b>(<i>diagramType, project, path="", parent=None, initBuilder=True, **kwargs</i>)
 <p>
         Constructor
 </p><dl>
@@ -96,7 +129,10 @@
 file or directory path to build the diagram from (string)
 </dd><dt><i>parent</i></dt>
 <dd>
-parent widget of the view (QWidget)
+parent widget of the dialog (QWidget)
+</dd><dt><i>initBuilder=</i></dt>
+<dd>
+flag indicating to initialize the diagram builder (boolean)
 </dd><dt><i>kwargs</i></dt>
 <dd>
 diagram specific data
@@ -121,26 +157,45 @@
 <dd>
 diagram specific data
 </dd>
-</dl><a NAME="UMLDialog.__relayout" ID="UMLDialog.__relayout"></a>
+</dl><a NAME="UMLDialog.__diagramTypeString" ID="UMLDialog.__diagramTypeString"></a>
+<h4>UMLDialog.__diagramTypeString</h4>
+<b>__diagramTypeString</b>(<i></i>)
+<p>
+        Private method to generate a readable string for the diagram type.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+readable type string (string)
+</dd>
+</dl><a NAME="UMLDialog.__initActions" ID="UMLDialog.__initActions"></a>
+<h4>UMLDialog.__initActions</h4>
+<b>__initActions</b>(<i></i>)
+<p>
+        Private slot to initialize the actions.
+</p><a NAME="UMLDialog.__initToolBars" ID="UMLDialog.__initToolBars"></a>
+<h4>UMLDialog.__initToolBars</h4>
+<b>__initToolBars</b>(<i></i>)
+<p>
+        Private slot to initialize the toolbars.
+</p><a NAME="UMLDialog.__relayout" ID="UMLDialog.__relayout"></a>
 <h4>UMLDialog.__relayout</h4>
 <b>__relayout</b>(<i></i>)
 <p>
         Private method to relayout the diagram.
-</p><a NAME="UMLDialog.diagramTypeToString" ID="UMLDialog.diagramTypeToString"></a>
-<h4>UMLDialog.diagramTypeToString</h4>
-<b>diagramTypeToString</b>(<i>diagramType</i>)
+</p><a NAME="UMLDialog.__save" ID="UMLDialog.__save"></a>
+<h4>UMLDialog.__save</h4>
+<b>__save</b>(<i></i>)
 <p>
-        Public method to convert the diagram type to a readable string.
+        Private slot to save the diagram with the current name.
+</p><a NAME="UMLDialog.__saveAs" ID="UMLDialog.__saveAs"></a>
+<h4>UMLDialog.__saveAs</h4>
+<b>__saveAs</b>(<i>filename=""</i>)
+<p>
+        Private slot to save the diagram.
 </p><dl>
-<dt><i>diagramType</i></dt>
+<dt><i>filename</i></dt>
 <dd>
-type of the diagram
-            (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram)
-</dd>
-</dl><dl>
-<dt>Returns:</dt>
-<dd>
-readable type string (string)
+name of the file to write to (string)
 </dd>
 </dl><a NAME="UMLDialog.show" ID="UMLDialog.show"></a>
 <h4>UMLDialog.show</h4>

eric ide

mercurial