Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html
eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Graphics.UMLDiagramBuilder</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Graphics.UMLDiagramBuilder</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing the UML diagram builder base class. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#UMLDiagramBuilder">UMLDiagramBuilder</a></td> | |
| 39 <td>Class implementing the UML diagram builder base class.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="UMLDiagramBuilder" ID="UMLDiagramBuilder"></a> | |
| 50 <h2>UMLDiagramBuilder</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing the UML diagram builder base class. | |
| 54 </p> | |
| 55 <h3>Derived from</h3> | |
| 56 QObject | |
| 57 <h3>Class Attributes</h3> | |
| 58 | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 | |
| 64 <table> | |
| 65 <tr><td>None</td></tr> | |
| 66 </table> | |
| 67 <h3>Methods</h3> | |
| 68 | |
| 69 <table> | |
| 70 | |
| 71 <tr> | |
| 72 <td><a href="#UMLDiagramBuilder.__init__">UMLDiagramBuilder</a></td> | |
| 73 <td>Constructor</td> | |
| 74 </tr> | |
| 75 <tr> | |
| 76 <td><a href="#UMLDiagramBuilder.buildDiagram">buildDiagram</a></td> | |
| 77 <td>Public method to build the diagram.</td> | |
| 78 </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> | |
| 88 <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td> | |
| 89 <td>Public method to initialize the object.</td> | |
| 90 </tr> | |
| 91 <tr> | |
| 92 <td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> | |
| 93 <td>Public method to parse persisted data.</td> | |
| 94 </tr> | |
| 95 <tr> | |
| 96 <td><a href="#UMLDiagramBuilder.toDict">toDict</a></td> | |
| 97 <td>Public method to collect data to be persisted.</td> | |
| 98 </tr> | |
| 99 </table> | |
| 100 <h3>Static Methods</h3> | |
| 101 | |
| 102 <table> | |
| 103 <tr><td>None</td></tr> | |
| 104 </table> | |
| 105 | |
| 106 <a NAME="UMLDiagramBuilder.__init__" ID="UMLDiagramBuilder.__init__"></a> | |
| 107 <h4>UMLDiagramBuilder (Constructor)</h4> | |
| 108 <b>UMLDiagramBuilder</b>(<i>dialog, view, project</i>) | |
| 109 | |
| 110 <p> | |
| 111 Constructor | |
| 112 </p> | |
| 113 <dl> | |
| 114 | |
| 115 <dt><i>dialog</i> (UMLDialog)</dt> | |
| 116 <dd> | |
| 117 reference to the UML dialog | |
| 118 </dd> | |
| 119 <dt><i>view</i> (UMLGraphicsView)</dt> | |
| 120 <dd> | |
| 121 reference to the view object | |
| 122 </dd> | |
| 123 <dt><i>project</i> (Project)</dt> | |
| 124 <dd> | |
| 125 reference to the project object | |
| 126 </dd> | |
| 127 </dl> | |
| 128 <a NAME="UMLDiagramBuilder.buildDiagram" ID="UMLDiagramBuilder.buildDiagram"></a> | |
| 129 <h4>UMLDiagramBuilder.buildDiagram</h4> | |
| 130 <b>buildDiagram</b>(<i></i>) | |
| 131 | |
| 132 <p> | |
| 133 Public method to build the diagram. | |
| 134 </p> | |
| 135 <p> | |
| 136 This class must be implemented in subclasses. | |
| 137 </p> | |
| 138 <dl> | |
| 139 | |
| 140 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 141 <dd> | |
| 142 raised to indicate that this class | |
| 143 must be subclassed | |
| 144 </dd> | |
| 145 </dl> | |
| 146 <a NAME="UMLDiagramBuilder.buildErrorMessage" ID="UMLDiagramBuilder.buildErrorMessage"></a> | |
| 147 <h4>UMLDiagramBuilder.buildErrorMessage</h4> | |
| 148 <b>buildErrorMessage</b>(<i>msg</i>) | |
| 149 | |
| 150 <p> | |
| 151 Public method to build an error string to be included in the scene. | |
| 152 </p> | |
| 153 <dl> | |
| 154 | |
| 155 <dt><i>msg</i> (str)</dt> | |
| 156 <dd> | |
| 157 error message | |
| 158 </dd> | |
| 159 </dl> | |
| 160 <dl> | |
| 161 <dt>Return:</dt> | |
| 162 <dd> | |
| 163 prepared error string | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <dl> | |
| 167 <dt>Return Type:</dt> | |
| 168 <dd> | |
| 169 str | |
| 170 </dd> | |
| 171 </dl> | |
| 172 <a NAME="UMLDiagramBuilder.fromDict" ID="UMLDiagramBuilder.fromDict"></a> | |
| 173 <h4>UMLDiagramBuilder.fromDict</h4> | |
| 174 <b>fromDict</b>(<i>version, data</i>) | |
| 175 | |
| 176 <p> | |
| 177 Public method to populate the class with data persisted by 'toDict()'. | |
| 178 </p> | |
| 179 <dl> | |
| 180 | |
| 181 <dt><i>version</i> (str)</dt> | |
| 182 <dd> | |
| 183 version of the data | |
| 184 </dd> | |
| 185 <dt><i>data</i> (dict)</dt> | |
| 186 <dd> | |
| 187 dictionary containing the persisted data | |
| 188 </dd> | |
| 189 </dl> | |
| 190 <dl> | |
| 191 <dt>Return:</dt> | |
| 192 <dd> | |
| 193 tuple containing a flag indicating success and an info | |
| 194 message in case the diagram belongs to a different project | |
| 195 </dd> | |
| 196 </dl> | |
| 197 <dl> | |
| 198 <dt>Return Type:</dt> | |
| 199 <dd> | |
| 200 tuple of (bool, str) | |
| 201 </dd> | |
| 202 </dl> | |
| 203 <a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a> | |
| 204 <h4>UMLDiagramBuilder.initialize</h4> | |
| 205 <b>initialize</b>(<i></i>) | |
| 206 | |
| 207 <p> | |
| 208 Public method to initialize the object. | |
| 209 </p> | |
| 210 <a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a> | |
| 211 <h4>UMLDiagramBuilder.parsePersistenceData</h4> | |
| 212 <b>parsePersistenceData</b>(<i>version, data</i>) | |
| 213 | |
| 214 <p> | |
| 215 Public method to parse persisted data. | |
| 216 </p> | |
| 217 <dl> | |
| 218 | |
| 219 <dt><i>version</i> (str)</dt> | |
| 220 <dd> | |
| 221 version of the data | |
| 222 </dd> | |
| 223 <dt><i>data</i> (str)</dt> | |
| 224 <dd> | |
| 225 persisted data to be parsed | |
| 226 </dd> | |
| 227 </dl> | |
| 228 <dl> | |
| 229 <dt>Return:</dt> | |
| 230 <dd> | |
| 231 flag indicating success | |
| 232 </dd> | |
| 233 </dl> | |
| 234 <dl> | |
| 235 <dt>Return Type:</dt> | |
| 236 <dd> | |
| 237 bool | |
| 238 </dd> | |
| 239 </dl> | |
| 240 <a NAME="UMLDiagramBuilder.toDict" ID="UMLDiagramBuilder.toDict"></a> | |
| 241 <h4>UMLDiagramBuilder.toDict</h4> | |
| 242 <b>toDict</b>(<i></i>) | |
| 243 | |
| 244 <p> | |
| 245 Public method to collect data to be persisted. | |
| 246 </p> | |
| 247 <dl> | |
| 248 <dt>Return:</dt> | |
| 249 <dd> | |
| 250 dictionary containing data to be persisted | |
| 251 </dd> | |
| 252 </dl> | |
| 253 <dl> | |
| 254 <dt>Return Type:</dt> | |
| 255 <dd> | |
| 256 dict | |
| 257 </dd> | |
| 258 </dl> | |
| 259 <div align="right"><a href="#top">Up</a></div> | |
| 260 <hr /> | |
| 261 </body></html> |
