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

branch
eric7
changeset 10259
b51dfacef37f
parent 10070
9f5758c0fec1
child 10479
856476537696
equal deleted inserted replaced
10258:e7764f992a01 10259:b51dfacef37f
66 <td><a href="#UMLDiagramBuilder.buildErrorMessage">buildErrorMessage</a></td> 66 <td><a href="#UMLDiagramBuilder.buildErrorMessage">buildErrorMessage</a></td>
67 <td>Public method to build an error string to be included in the scene.</td> 67 <td>Public method to build an error string to be included in the scene.</td>
68 </tr> 68 </tr>
69 <tr> 69 <tr>
70 <td><a href="#UMLDiagramBuilder.fromDict">fromDict</a></td> 70 <td><a href="#UMLDiagramBuilder.fromDict">fromDict</a></td>
71 <td></td> 71 <td>Public method to populate the class with data persisted by 'toDict()'.</td>
72 </tr> 72 </tr>
73 <tr> 73 <tr>
74 <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td> 74 <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td>
75 <td>Public method to initialize the object.</td> 75 <td>Public method to initialize the object.</td>
76 </tr> 76 </tr>
77 <tr> 77 <tr>
78 <td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> 78 <td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td>
79 <td></td> 79 <td>Public method to parse persisted data.</td>
80 </tr> 80 </tr>
81 <tr> 81 <tr>
82 <td><a href="#UMLDiagramBuilder.toDict">toDict</a></td> 82 <td><a href="#UMLDiagramBuilder.toDict">toDict</a></td>
83 <td>Public method to collect data to be persisted.</td> 83 <td>Public method to collect data to be persisted.</td>
84 </tr> 84 </tr>
157 </dl> 157 </dl>
158 <a NAME="UMLDiagramBuilder.fromDict" ID="UMLDiagramBuilder.fromDict"></a> 158 <a NAME="UMLDiagramBuilder.fromDict" ID="UMLDiagramBuilder.fromDict"></a>
159 <h4>UMLDiagramBuilder.fromDict</h4> 159 <h4>UMLDiagramBuilder.fromDict</h4>
160 <b>fromDict</b>(<i>version, data</i>) 160 <b>fromDict</b>(<i>version, data</i>)
161 161
162 <p>
163 Public method to populate the class with data persisted by 'toDict()'.
164 </p>
165 <dl>
166
167 <dt><i>version</i> (str)</dt>
168 <dd>
169 version of the data
170 </dd>
171 <dt><i>data</i> (dict)</dt>
172 <dd>
173 dictionary containing the persisted data
174 </dd>
175 </dl>
176 <dl>
177 <dt>Return:</dt>
178 <dd>
179 tuple containing a flag indicating success and an info
180 message in case the diagram belongs to a different project
181 </dd>
182 </dl>
183 <dl>
184 <dt>Return Type:</dt>
185 <dd>
186 tuple of (bool, str)
187 </dd>
188 </dl>
162 <a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a> 189 <a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a>
163 <h4>UMLDiagramBuilder.initialize</h4> 190 <h4>UMLDiagramBuilder.initialize</h4>
164 <b>initialize</b>(<i></i>) 191 <b>initialize</b>(<i></i>)
165 192
166 <p> 193 <p>
168 </p> 195 </p>
169 <a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a> 196 <a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a>
170 <h4>UMLDiagramBuilder.parsePersistenceData</h4> 197 <h4>UMLDiagramBuilder.parsePersistenceData</h4>
171 <b>parsePersistenceData</b>(<i>version, data</i>) 198 <b>parsePersistenceData</b>(<i>version, data</i>)
172 199
200 <p>
201 Public method to parse persisted data.
202 </p>
203 <dl>
204
205 <dt><i>version</i> (str)</dt>
206 <dd>
207 version of the data
208 </dd>
209 <dt><i>data</i> (str)</dt>
210 <dd>
211 persisted data to be parsed
212 </dd>
213 </dl>
214 <dl>
215 <dt>Return:</dt>
216 <dd>
217 flag indicating success
218 </dd>
219 </dl>
220 <dl>
221 <dt>Return Type:</dt>
222 <dd>
223 bool
224 </dd>
225 </dl>
173 <a NAME="UMLDiagramBuilder.toDict" ID="UMLDiagramBuilder.toDict"></a> 226 <a NAME="UMLDiagramBuilder.toDict" ID="UMLDiagramBuilder.toDict"></a>
174 <h4>UMLDiagramBuilder.toDict</h4> 227 <h4>UMLDiagramBuilder.toDict</h4>
175 <b>toDict</b>(<i></i>) 228 <b>toDict</b>(<i></i>)
176 229
177 <p> 230 <p>

eric ide

mercurial