eric6/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html

changeset 8296
14f33eededf7
parent 8294
cb4e5bbf3a2c
--- a/eric6/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html	Sat May 08 18:34:08 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html	Sat May 08 18:35:00 2021 +0200
@@ -77,6 +77,14 @@
 <td>Public method to build the diagram.</td>
 </tr>
 <tr>
+<td><a href="#UMLDiagramBuilder.buildErrorMessage">buildErrorMessage</a></td>
+<td>Public method to build an error string to be included in the scene.</td>
+</tr>
+<tr>
+<td><a href="#UMLDiagramBuilder.fromDict">fromDict</a></td>
+<td>Public method to populate the class with data persisted by 'toDict()'.</td>
+</tr>
+<tr>
 <td><a href="#UMLDiagramBuilder.getPersistenceData">getPersistenceData</a></td>
 <td>Public method to get a string for data to be persisted.</td>
 </tr>
@@ -139,6 +147,63 @@
             must be subclassed
 </dd>
 </dl>
+<a NAME="UMLDiagramBuilder.buildErrorMessage" ID="UMLDiagramBuilder.buildErrorMessage"></a>
+<h4>UMLDiagramBuilder.buildErrorMessage</h4>
+<b>buildErrorMessage</b>(<i>msg</i>)
+
+<p>
+        Public method to build an error string to be included in the scene.
+</p>
+<dl>
+
+<dt><i>msg</i> (str)</dt>
+<dd>
+error message
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+prepared error string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="UMLDiagramBuilder.fromDict" ID="UMLDiagramBuilder.fromDict"></a>
+<h4>UMLDiagramBuilder.fromDict</h4>
+<b>fromDict</b>(<i>version, data</i>)
+
+<p>
+        Public method to populate the class with data persisted by 'toDict()'.
+</p>
+<dl>
+
+<dt><i>version</i> (str)</dt>
+<dd>
+version of the data
+</dd>
+<dt><i>data</i> (dict)</dt>
+<dd>
+dictionary containing the persisted data
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an info
+            message in case the diagram belongs to a different project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
 <a NAME="UMLDiagramBuilder.getPersistenceData" ID="UMLDiagramBuilder.getPersistenceData"></a>
 <h4>UMLDiagramBuilder.getPersistenceData</h4>
 <b>getPersistenceData</b>(<i></i>)

eric ide

mercurial