Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 10259
b51dfacef37f
child 10684
58c7f23ae1cb
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Graphics.UMLDiagramBuilder</h1> 9 <h1>eric7.Graphics.UMLDiagramBuilder</h1>
10
11 <p> 10 <p>
12 Module implementing the UML diagram builder base class. 11 Module implementing the UML diagram builder base class.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#UMLDiagramBuilder">UMLDiagramBuilder</a></td> 22 <td><a href="#UMLDiagramBuilder">UMLDiagramBuilder</a></td>
25 <td>Class implementing the UML diagram builder base class.</td> 23 <td>Class implementing the UML diagram builder base class.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="UMLDiagramBuilder" ID="UMLDiagramBuilder"></a> 34 <a NAME="UMLDiagramBuilder" ID="UMLDiagramBuilder"></a>
36 <h2>UMLDiagramBuilder</h2> 35 <h2>UMLDiagramBuilder</h2>
37
38 <p> 36 <p>
39 Class implementing the UML diagram builder base class. 37 Class implementing the UML diagram builder base class.
40 </p> 38 </p>
39
41 <h3>Derived from</h3> 40 <h3>Derived from</h3>
42 QObject 41 QObject
43 <h3>Class Attributes</h3> 42 <h3>Class Attributes</h3>
44 43 <table>
45 <table> 44 <tr><td>None</td></tr>
46 <tr><td>None</td></tr> 45 </table>
47 </table> 46
48 <h3>Class Methods</h3> 47 <h3>Class Methods</h3>
49 48 <table>
50 <table> 49 <tr><td>None</td></tr>
51 <tr><td>None</td></tr> 50 </table>
52 </table> 51
53 <h3>Methods</h3> 52 <h3>Methods</h3>
54 53 <table>
55 <table>
56
57 <tr> 54 <tr>
58 <td><a href="#UMLDiagramBuilder.__init__">UMLDiagramBuilder</a></td> 55 <td><a href="#UMLDiagramBuilder.__init__">UMLDiagramBuilder</a></td>
59 <td>Constructor</td> 56 <td>Constructor</td>
60 </tr> 57 </tr>
61 <tr> 58 <tr>
81 <tr> 78 <tr>
82 <td><a href="#UMLDiagramBuilder.toDict">toDict</a></td> 79 <td><a href="#UMLDiagramBuilder.toDict">toDict</a></td>
83 <td>Public method to collect data to be persisted.</td> 80 <td>Public method to collect data to be persisted.</td>
84 </tr> 81 </tr>
85 </table> 82 </table>
83
86 <h3>Static Methods</h3> 84 <h3>Static Methods</h3>
87 85 <table>
88 <table> 86 <tr><td>None</td></tr>
89 <tr><td>None</td></tr> 87 </table>
90 </table> 88
91 89
92 <a NAME="UMLDiagramBuilder.__init__" ID="UMLDiagramBuilder.__init__"></a> 90 <a NAME="UMLDiagramBuilder.__init__" ID="UMLDiagramBuilder.__init__"></a>
93 <h4>UMLDiagramBuilder (Constructor)</h4> 91 <h4>UMLDiagramBuilder (Constructor)</h4>
94 <b>UMLDiagramBuilder</b>(<i>dialog, view, project</i>) 92 <b>UMLDiagramBuilder</b>(<i>dialog, view, project</i>)
95
96 <p> 93 <p>
97 Constructor 94 Constructor
98 </p> 95 </p>
96
99 <dl> 97 <dl>
100 98
101 <dt><i>dialog</i> (UMLDialog)</dt> 99 <dt><i>dialog</i> (UMLDialog)</dt>
102 <dd> 100 <dd>
103 reference to the UML dialog 101 reference to the UML dialog
112 </dd> 110 </dd>
113 </dl> 111 </dl>
114 <a NAME="UMLDiagramBuilder.buildDiagram" ID="UMLDiagramBuilder.buildDiagram"></a> 112 <a NAME="UMLDiagramBuilder.buildDiagram" ID="UMLDiagramBuilder.buildDiagram"></a>
115 <h4>UMLDiagramBuilder.buildDiagram</h4> 113 <h4>UMLDiagramBuilder.buildDiagram</h4>
116 <b>buildDiagram</b>(<i></i>) 114 <b>buildDiagram</b>(<i></i>)
117
118 <p> 115 <p>
119 Public method to build the diagram. 116 Public method to build the diagram.
120 </p> 117 </p>
121 <p> 118 <p>
122 This class must be implemented in subclasses. 119 This class must be implemented in subclasses.
123 </p> 120 </p>
121
124 <dl> 122 <dl>
125 123
126 <dt>Raises <b>NotImplementedError</b>:</dt> 124 <dt>Raises <b>NotImplementedError</b>:</dt>
127 <dd> 125 <dd>
128 raised to indicate that this class 126 raised to indicate that this class
130 </dd> 128 </dd>
131 </dl> 129 </dl>
132 <a NAME="UMLDiagramBuilder.buildErrorMessage" ID="UMLDiagramBuilder.buildErrorMessage"></a> 130 <a NAME="UMLDiagramBuilder.buildErrorMessage" ID="UMLDiagramBuilder.buildErrorMessage"></a>
133 <h4>UMLDiagramBuilder.buildErrorMessage</h4> 131 <h4>UMLDiagramBuilder.buildErrorMessage</h4>
134 <b>buildErrorMessage</b>(<i>msg</i>) 132 <b>buildErrorMessage</b>(<i>msg</i>)
135
136 <p> 133 <p>
137 Public method to build an error string to be included in the scene. 134 Public method to build an error string to be included in the scene.
138 </p> 135 </p>
136
139 <dl> 137 <dl>
140 138
141 <dt><i>msg</i> (str)</dt> 139 <dt><i>msg</i> (str)</dt>
142 <dd> 140 <dd>
143 error message 141 error message
156 </dd> 154 </dd>
157 </dl> 155 </dl>
158 <a NAME="UMLDiagramBuilder.fromDict" ID="UMLDiagramBuilder.fromDict"></a> 156 <a NAME="UMLDiagramBuilder.fromDict" ID="UMLDiagramBuilder.fromDict"></a>
159 <h4>UMLDiagramBuilder.fromDict</h4> 157 <h4>UMLDiagramBuilder.fromDict</h4>
160 <b>fromDict</b>(<i>version, data</i>) 158 <b>fromDict</b>(<i>version, data</i>)
161
162 <p> 159 <p>
163 Public method to populate the class with data persisted by 'toDict()'. 160 Public method to populate the class with data persisted by 'toDict()'.
164 </p> 161 </p>
162
165 <dl> 163 <dl>
166 164
167 <dt><i>version</i> (str)</dt> 165 <dt><i>version</i> (str)</dt>
168 <dd> 166 <dd>
169 version of the data 167 version of the data
187 </dd> 185 </dd>
188 </dl> 186 </dl>
189 <a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a> 187 <a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a>
190 <h4>UMLDiagramBuilder.initialize</h4> 188 <h4>UMLDiagramBuilder.initialize</h4>
191 <b>initialize</b>(<i></i>) 189 <b>initialize</b>(<i></i>)
192
193 <p> 190 <p>
194 Public method to initialize the object. 191 Public method to initialize the object.
195 </p> 192 </p>
193
196 <a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a> 194 <a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a>
197 <h4>UMLDiagramBuilder.parsePersistenceData</h4> 195 <h4>UMLDiagramBuilder.parsePersistenceData</h4>
198 <b>parsePersistenceData</b>(<i>version, data</i>) 196 <b>parsePersistenceData</b>(<i>version, data</i>)
199
200 <p> 197 <p>
201 Public method to parse persisted data. 198 Public method to parse persisted data.
202 </p> 199 </p>
200
203 <dl> 201 <dl>
204 202
205 <dt><i>version</i> (str)</dt> 203 <dt><i>version</i> (str)</dt>
206 <dd> 204 <dd>
207 version of the data 205 version of the data
224 </dd> 222 </dd>
225 </dl> 223 </dl>
226 <a NAME="UMLDiagramBuilder.toDict" ID="UMLDiagramBuilder.toDict"></a> 224 <a NAME="UMLDiagramBuilder.toDict" ID="UMLDiagramBuilder.toDict"></a>
227 <h4>UMLDiagramBuilder.toDict</h4> 225 <h4>UMLDiagramBuilder.toDict</h4>
228 <b>toDict</b>(<i></i>) 226 <b>toDict</b>(<i></i>)
229
230 <p> 227 <p>
231 Public method to collect data to be persisted. 228 Public method to collect data to be persisted.
232 </p> 229 </p>
230
233 <dl> 231 <dl>
234 <dt>Return:</dt> 232 <dt>Return:</dt>
235 <dd> 233 <dd>
236 dictionary containing data to be persisted 234 dictionary containing data to be persisted
237 </dd> 235 </dd>

Mercurial Repository: eric

eric ide

mercurial