Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html
eric6/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html
- branch
- maintenance
- changeset 6989
- 8b8cadf8d7e9
- parent 6942
- 2602857055c5
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6938:7926553b7509 | 6989:8b8cadf8d7e9 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.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><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Graphics.UMLDiagramBuilder</h1> | |
| 23 <p> | |
| 24 Module implementing the UML diagram builder base class. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#UMLDiagramBuilder">UMLDiagramBuilder</a></td> | |
| 34 <td>Class implementing the UML diagram builder base class.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="UMLDiagramBuilder" ID="UMLDiagramBuilder"></a> | |
| 43 <h2>UMLDiagramBuilder</h2> | |
| 44 <p> | |
| 45 Class implementing the UML diagram builder base class. | |
| 46 </p> | |
| 47 <h3>Derived from</h3> | |
| 48 QObject | |
| 49 <h3>Class Attributes</h3> | |
| 50 <table> | |
| 51 <tr><td>None</td></tr> | |
| 52 </table> | |
| 53 <h3>Class Methods</h3> | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 <table> | |
| 59 <tr> | |
| 60 <td><a href="#UMLDiagramBuilder.__init__">UMLDiagramBuilder</a></td> | |
| 61 <td>Constructor</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#UMLDiagramBuilder.buildDiagram">buildDiagram</a></td> | |
| 64 <td>Public method to build the diagram.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#UMLDiagramBuilder.getPersistenceData">getPersistenceData</a></td> | |
| 67 <td>Public method to get a string for data to be persisted.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td> | |
| 70 <td>Public method to initialize the object.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> | |
| 73 <td>Public method to parse persisted data.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <h3>Static Methods</h3> | |
| 77 <table> | |
| 78 <tr><td>None</td></tr> | |
| 79 </table> | |
| 80 <a NAME="UMLDiagramBuilder.__init__" ID="UMLDiagramBuilder.__init__"></a> | |
| 81 <h4>UMLDiagramBuilder (Constructor)</h4> | |
| 82 <b>UMLDiagramBuilder</b>(<i>dialog, view, project</i>) | |
| 83 <p> | |
| 84 Constructor | |
| 85 </p><dl> | |
| 86 <dt><i>dialog</i></dt> | |
| 87 <dd> | |
| 88 reference to the UML dialog (UMLDialog) | |
| 89 </dd><dt><i>view</i></dt> | |
| 90 <dd> | |
| 91 reference to the view object (UMLGraphicsView) | |
| 92 </dd><dt><i>project</i></dt> | |
| 93 <dd> | |
| 94 reference to the project object (Project) | |
| 95 </dd> | |
| 96 </dl><a NAME="UMLDiagramBuilder.buildDiagram" ID="UMLDiagramBuilder.buildDiagram"></a> | |
| 97 <h4>UMLDiagramBuilder.buildDiagram</h4> | |
| 98 <b>buildDiagram</b>(<i></i>) | |
| 99 <p> | |
| 100 Public method to build the diagram. | |
| 101 </p><p> | |
| 102 This class must be implemented in subclasses. | |
| 103 </p><dl> | |
| 104 <dt>Raises <b>NotImplementedError</b>:</dt> | |
| 105 <dd> | |
| 106 raised to indicate that this class | |
| 107 must be subclassed | |
| 108 </dd> | |
| 109 </dl><a NAME="UMLDiagramBuilder.getPersistenceData" ID="UMLDiagramBuilder.getPersistenceData"></a> | |
| 110 <h4>UMLDiagramBuilder.getPersistenceData</h4> | |
| 111 <b>getPersistenceData</b>(<i></i>) | |
| 112 <p> | |
| 113 Public method to get a string for data to be persisted. | |
| 114 </p><dl> | |
| 115 <dt>Returns:</dt> | |
| 116 <dd> | |
| 117 persisted data string (string) | |
| 118 </dd> | |
| 119 </dl><a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a> | |
| 120 <h4>UMLDiagramBuilder.initialize</h4> | |
| 121 <b>initialize</b>(<i></i>) | |
| 122 <p> | |
| 123 Public method to initialize the object. | |
| 124 </p><a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a> | |
| 125 <h4>UMLDiagramBuilder.parsePersistenceData</h4> | |
| 126 <b>parsePersistenceData</b>(<i>version, data</i>) | |
| 127 <p> | |
| 128 Public method to parse persisted data. | |
| 129 </p><dl> | |
| 130 <dt><i>version</i></dt> | |
| 131 <dd> | |
| 132 version of the data (string) | |
| 133 </dd><dt><i>data</i></dt> | |
| 134 <dd> | |
| 135 persisted data to be parsed (string) | |
| 136 </dd> | |
| 137 </dl><dl> | |
| 138 <dt>Returns:</dt> | |
| 139 <dd> | |
| 140 flag indicating success (boolean) | |
| 141 </dd> | |
| 142 </dl> | |
| 143 <div align="right"><a href="#top">Up</a></div> | |
| 144 <hr /> | |
| 145 </body></html> |
