Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html
eric6/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7989
- a21d673a8f99
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Graphics.UMLDiagramBuilder</h1> | 23 <h1>eric6.Graphics.UMLDiagramBuilder</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing the UML diagram builder base class. | 26 Module implementing the UML diagram builder base class. |
| 25 </p> | 27 </p> |
| 26 <h3>Global Attributes</h3> | 28 <h3>Global Attributes</h3> |
| 29 | |
| 27 <table> | 30 <table> |
| 28 <tr><td>None</td></tr> | 31 <tr><td>None</td></tr> |
| 29 </table> | 32 </table> |
| 30 <h3>Classes</h3> | 33 <h3>Classes</h3> |
| 34 | |
| 31 <table> | 35 <table> |
| 36 | |
| 32 <tr> | 37 <tr> |
| 33 <td><a href="#UMLDiagramBuilder">UMLDiagramBuilder</a></td> | 38 <td><a href="#UMLDiagramBuilder">UMLDiagramBuilder</a></td> |
| 34 <td>Class implementing the UML diagram builder base class.</td> | 39 <td>Class implementing the UML diagram builder base class.</td> |
| 35 </tr> | 40 </tr> |
| 36 </table> | 41 </table> |
| 37 <h3>Functions</h3> | 42 <h3>Functions</h3> |
| 43 | |
| 38 <table> | 44 <table> |
| 39 <tr><td>None</td></tr> | 45 <tr><td>None</td></tr> |
| 40 </table> | 46 </table> |
| 41 <hr /><hr /> | 47 <hr /> |
| 48 <hr /> | |
| 42 <a NAME="UMLDiagramBuilder" ID="UMLDiagramBuilder"></a> | 49 <a NAME="UMLDiagramBuilder" ID="UMLDiagramBuilder"></a> |
| 43 <h2>UMLDiagramBuilder</h2> | 50 <h2>UMLDiagramBuilder</h2> |
| 51 | |
| 44 <p> | 52 <p> |
| 45 Class implementing the UML diagram builder base class. | 53 Class implementing the UML diagram builder base class. |
| 46 </p> | 54 </p> |
| 47 <h3>Derived from</h3> | 55 <h3>Derived from</h3> |
| 48 QObject | 56 QObject |
| 49 <h3>Class Attributes</h3> | 57 <h3>Class Attributes</h3> |
| 58 | |
| 50 <table> | 59 <table> |
| 51 <tr><td>None</td></tr> | 60 <tr><td>None</td></tr> |
| 52 </table> | 61 </table> |
| 53 <h3>Class Methods</h3> | 62 <h3>Class Methods</h3> |
| 63 | |
| 54 <table> | 64 <table> |
| 55 <tr><td>None</td></tr> | 65 <tr><td>None</td></tr> |
| 56 </table> | 66 </table> |
| 57 <h3>Methods</h3> | 67 <h3>Methods</h3> |
| 68 | |
| 58 <table> | 69 <table> |
| 70 | |
| 59 <tr> | 71 <tr> |
| 60 <td><a href="#UMLDiagramBuilder.__init__">UMLDiagramBuilder</a></td> | 72 <td><a href="#UMLDiagramBuilder.__init__">UMLDiagramBuilder</a></td> |
| 61 <td>Constructor</td> | 73 <td>Constructor</td> |
| 62 </tr><tr> | 74 </tr> |
| 75 <tr> | |
| 63 <td><a href="#UMLDiagramBuilder.buildDiagram">buildDiagram</a></td> | 76 <td><a href="#UMLDiagramBuilder.buildDiagram">buildDiagram</a></td> |
| 64 <td>Public method to build the diagram.</td> | 77 <td>Public method to build the diagram.</td> |
| 65 </tr><tr> | 78 </tr> |
| 79 <tr> | |
| 66 <td><a href="#UMLDiagramBuilder.getPersistenceData">getPersistenceData</a></td> | 80 <td><a href="#UMLDiagramBuilder.getPersistenceData">getPersistenceData</a></td> |
| 67 <td>Public method to get a string for data to be persisted.</td> | 81 <td>Public method to get a string for data to be persisted.</td> |
| 68 </tr><tr> | 82 </tr> |
| 83 <tr> | |
| 69 <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td> | 84 <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td> |
| 70 <td>Public method to initialize the object.</td> | 85 <td>Public method to initialize the object.</td> |
| 71 </tr><tr> | 86 </tr> |
| 87 <tr> | |
| 72 <td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> | 88 <td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td> |
| 73 <td>Public method to parse persisted data.</td> | 89 <td>Public method to parse persisted data.</td> |
| 74 </tr> | 90 </tr> |
| 75 </table> | 91 </table> |
| 76 <h3>Static Methods</h3> | 92 <h3>Static Methods</h3> |
| 93 | |
| 77 <table> | 94 <table> |
| 78 <tr><td>None</td></tr> | 95 <tr><td>None</td></tr> |
| 79 </table> | 96 </table> |
| 97 | |
| 80 <a NAME="UMLDiagramBuilder.__init__" ID="UMLDiagramBuilder.__init__"></a> | 98 <a NAME="UMLDiagramBuilder.__init__" ID="UMLDiagramBuilder.__init__"></a> |
| 81 <h4>UMLDiagramBuilder (Constructor)</h4> | 99 <h4>UMLDiagramBuilder (Constructor)</h4> |
| 82 <b>UMLDiagramBuilder</b>(<i>dialog, view, project</i>) | 100 <b>UMLDiagramBuilder</b>(<i>dialog, view, project</i>) |
| 101 | |
| 83 <p> | 102 <p> |
| 84 Constructor | 103 Constructor |
| 85 </p><dl> | 104 </p> |
| 105 <dl> | |
| 106 | |
| 86 <dt><i>dialog</i></dt> | 107 <dt><i>dialog</i></dt> |
| 87 <dd> | 108 <dd> |
| 88 reference to the UML dialog (UMLDialog) | 109 reference to the UML dialog (UMLDialog) |
| 89 </dd><dt><i>view</i></dt> | 110 </dd> |
| 111 <dt><i>view</i></dt> | |
| 90 <dd> | 112 <dd> |
| 91 reference to the view object (UMLGraphicsView) | 113 reference to the view object (UMLGraphicsView) |
| 92 </dd><dt><i>project</i></dt> | 114 </dd> |
| 115 <dt><i>project</i></dt> | |
| 93 <dd> | 116 <dd> |
| 94 reference to the project object (Project) | 117 reference to the project object (Project) |
| 95 </dd> | 118 </dd> |
| 96 </dl><a NAME="UMLDiagramBuilder.buildDiagram" ID="UMLDiagramBuilder.buildDiagram"></a> | 119 </dl> |
| 120 <a NAME="UMLDiagramBuilder.buildDiagram" ID="UMLDiagramBuilder.buildDiagram"></a> | |
| 97 <h4>UMLDiagramBuilder.buildDiagram</h4> | 121 <h4>UMLDiagramBuilder.buildDiagram</h4> |
| 98 <b>buildDiagram</b>(<i></i>) | 122 <b>buildDiagram</b>(<i></i>) |
| 123 | |
| 99 <p> | 124 <p> |
| 100 Public method to build the diagram. | 125 Public method to build the diagram. |
| 101 </p><p> | 126 </p> |
| 127 <p> | |
| 102 This class must be implemented in subclasses. | 128 This class must be implemented in subclasses. |
| 103 </p><dl> | 129 </p> |
| 130 <dl> | |
| 131 | |
| 104 <dt>Raises <b>NotImplementedError</b>:</dt> | 132 <dt>Raises <b>NotImplementedError</b>:</dt> |
| 105 <dd> | 133 <dd> |
| 106 raised to indicate that this class | 134 raised to indicate that this class |
| 107 must be subclassed | 135 must be subclassed |
| 108 </dd> | 136 </dd> |
| 109 </dl><a NAME="UMLDiagramBuilder.getPersistenceData" ID="UMLDiagramBuilder.getPersistenceData"></a> | 137 </dl> |
| 138 <a NAME="UMLDiagramBuilder.getPersistenceData" ID="UMLDiagramBuilder.getPersistenceData"></a> | |
| 110 <h4>UMLDiagramBuilder.getPersistenceData</h4> | 139 <h4>UMLDiagramBuilder.getPersistenceData</h4> |
| 111 <b>getPersistenceData</b>(<i></i>) | 140 <b>getPersistenceData</b>(<i></i>) |
| 141 | |
| 112 <p> | 142 <p> |
| 113 Public method to get a string for data to be persisted. | 143 Public method to get a string for data to be persisted. |
| 114 </p><dl> | 144 </p> |
| 145 <dl> | |
| 115 <dt>Returns:</dt> | 146 <dt>Returns:</dt> |
| 116 <dd> | 147 <dd> |
| 117 persisted data string (string) | 148 persisted data string (string) |
| 118 </dd> | 149 </dd> |
| 119 </dl><a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a> | 150 </dl> |
| 151 <a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a> | |
| 120 <h4>UMLDiagramBuilder.initialize</h4> | 152 <h4>UMLDiagramBuilder.initialize</h4> |
| 121 <b>initialize</b>(<i></i>) | 153 <b>initialize</b>(<i></i>) |
| 154 | |
| 122 <p> | 155 <p> |
| 123 Public method to initialize the object. | 156 Public method to initialize the object. |
| 124 </p><a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a> | 157 </p> |
| 158 <a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a> | |
| 125 <h4>UMLDiagramBuilder.parsePersistenceData</h4> | 159 <h4>UMLDiagramBuilder.parsePersistenceData</h4> |
| 126 <b>parsePersistenceData</b>(<i>version, data</i>) | 160 <b>parsePersistenceData</b>(<i>version, data</i>) |
| 161 | |
| 127 <p> | 162 <p> |
| 128 Public method to parse persisted data. | 163 Public method to parse persisted data. |
| 129 </p><dl> | 164 </p> |
| 165 <dl> | |
| 166 | |
| 130 <dt><i>version</i></dt> | 167 <dt><i>version</i></dt> |
| 131 <dd> | 168 <dd> |
| 132 version of the data (string) | 169 version of the data (string) |
| 133 </dd><dt><i>data</i></dt> | 170 </dd> |
| 171 <dt><i>data</i></dt> | |
| 134 <dd> | 172 <dd> |
| 135 persisted data to be parsed (string) | 173 persisted data to be parsed (string) |
| 136 </dd> | 174 </dd> |
| 137 </dl><dl> | 175 </dl> |
| 176 <dl> | |
| 138 <dt>Returns:</dt> | 177 <dt>Returns:</dt> |
| 139 <dd> | 178 <dd> |
| 140 flag indicating success (boolean) | 179 flag indicating success (boolean) |
| 141 </dd> | 180 </dd> |
| 142 </dl> | 181 </dl> |
