75 <tr> |
75 <tr> |
76 <td><a href="#UMLDiagramBuilder.buildDiagram">buildDiagram</a></td> |
76 <td><a href="#UMLDiagramBuilder.buildDiagram">buildDiagram</a></td> |
77 <td>Public method to build the diagram.</td> |
77 <td>Public method to build the diagram.</td> |
78 </tr> |
78 </tr> |
79 <tr> |
79 <tr> |
|
80 <td><a href="#UMLDiagramBuilder.buildErrorMessage">buildErrorMessage</a></td> |
|
81 <td>Public method to build an error string to be included in the scene.</td> |
|
82 </tr> |
|
83 <tr> |
|
84 <td><a href="#UMLDiagramBuilder.fromDict">fromDict</a></td> |
|
85 <td>Public method to populate the class with data persisted by 'toDict()'.</td> |
|
86 </tr> |
|
87 <tr> |
80 <td><a href="#UMLDiagramBuilder.getPersistenceData">getPersistenceData</a></td> |
88 <td><a href="#UMLDiagramBuilder.getPersistenceData">getPersistenceData</a></td> |
81 <td>Public method to get a string for data to be persisted.</td> |
89 <td>Public method to get a string for data to be persisted.</td> |
82 </tr> |
90 </tr> |
83 <tr> |
91 <tr> |
84 <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td> |
92 <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td> |
137 <dd> |
145 <dd> |
138 raised to indicate that this class |
146 raised to indicate that this class |
139 must be subclassed |
147 must be subclassed |
140 </dd> |
148 </dd> |
141 </dl> |
149 </dl> |
|
150 <a NAME="UMLDiagramBuilder.buildErrorMessage" ID="UMLDiagramBuilder.buildErrorMessage"></a> |
|
151 <h4>UMLDiagramBuilder.buildErrorMessage</h4> |
|
152 <b>buildErrorMessage</b>(<i>msg</i>) |
|
153 |
|
154 <p> |
|
155 Public method to build an error string to be included in the scene. |
|
156 </p> |
|
157 <dl> |
|
158 |
|
159 <dt><i>msg</i> (str)</dt> |
|
160 <dd> |
|
161 error message |
|
162 </dd> |
|
163 </dl> |
|
164 <dl> |
|
165 <dt>Return:</dt> |
|
166 <dd> |
|
167 prepared error string |
|
168 </dd> |
|
169 </dl> |
|
170 <dl> |
|
171 <dt>Return Type:</dt> |
|
172 <dd> |
|
173 str |
|
174 </dd> |
|
175 </dl> |
|
176 <a NAME="UMLDiagramBuilder.fromDict" ID="UMLDiagramBuilder.fromDict"></a> |
|
177 <h4>UMLDiagramBuilder.fromDict</h4> |
|
178 <b>fromDict</b>(<i>version, data</i>) |
|
179 |
|
180 <p> |
|
181 Public method to populate the class with data persisted by 'toDict()'. |
|
182 </p> |
|
183 <dl> |
|
184 |
|
185 <dt><i>version</i> (str)</dt> |
|
186 <dd> |
|
187 version of the data |
|
188 </dd> |
|
189 <dt><i>data</i> (dict)</dt> |
|
190 <dd> |
|
191 dictionary containing the persisted data |
|
192 </dd> |
|
193 </dl> |
|
194 <dl> |
|
195 <dt>Return:</dt> |
|
196 <dd> |
|
197 tuple containing a flag indicating success and an info |
|
198 message in case the diagram belongs to a different project |
|
199 </dd> |
|
200 </dl> |
|
201 <dl> |
|
202 <dt>Return Type:</dt> |
|
203 <dd> |
|
204 tuple of (bool, str) |
|
205 </dd> |
|
206 </dl> |
142 <a NAME="UMLDiagramBuilder.getPersistenceData" ID="UMLDiagramBuilder.getPersistenceData"></a> |
207 <a NAME="UMLDiagramBuilder.getPersistenceData" ID="UMLDiagramBuilder.getPersistenceData"></a> |
143 <h4>UMLDiagramBuilder.getPersistenceData</h4> |
208 <h4>UMLDiagramBuilder.getPersistenceData</h4> |
144 <b>getPersistenceData</b>(<i></i>) |
209 <b>getPersistenceData</b>(<i></i>) |
145 |
210 |
146 <p> |
211 <p> |