eric6/Documentation/Source/eric6.Graphics.UMLDialog.html

changeset 8281
184ece570a2b
parent 8270
6ba3564b7161
child 8284
eeaed80810ff
equal deleted inserted replaced
8280:17d03699f151 8281:184ece570a2b
36 36
37 <tr> 37 <tr>
38 <td><a href="#UMLDialog">UMLDialog</a></td> 38 <td><a href="#UMLDialog">UMLDialog</a></td>
39 <td>Class implementing a dialog showing UML like diagrams.</td> 39 <td>Class implementing a dialog showing UML like diagrams.</td>
40 </tr> 40 </tr>
41 <tr>
42 <td><a href="#UMLDialogType">UMLDialogType</a></td>
43 <td>Class defining the UML dialog types.</td>
44 </tr>
41 </table> 45 </table>
42 <h3>Functions</h3> 46 <h3>Functions</h3>
43 47
44 <table> 48 <table>
45 <tr><td>None</td></tr> 49 <tr><td>None</td></tr>
55 <h3>Derived from</h3> 59 <h3>Derived from</h3>
56 E5MainWindow 60 E5MainWindow
57 <h3>Class Attributes</h3> 61 <h3>Class Attributes</h3>
58 62
59 <table> 63 <table>
60 <tr><td>ApplicationDiagram</td></tr><tr><td>ClassDiagram</td></tr><tr><td>FileVersions</td></tr><tr><td>ImportsDiagram</td></tr><tr><td>NoDiagram</td></tr><tr><td>PackageDiagram</td></tr> 64 <tr><td>FileVersions</td></tr>
61 </table> 65 </table>
62 <h3>Class Methods</h3> 66 <h3>Class Methods</h3>
63 67
64 <table> 68 <table>
65 <tr><td>None</td></tr> 69 <tr><td>None</td></tr>
122 <p> 126 <p>
123 Constructor 127 Constructor
124 </p> 128 </p>
125 <dl> 129 <dl>
126 130
127 <dt><i>diagramType</i></dt> 131 <dt><i>diagramType</i> (UMLDialogType)</dt>
128 <dd> 132 <dd>
129 type of the diagram (one of ApplicationDiagram, 133 type of the diagram
130 ClassDiagram, ImportsDiagram, NoDiagram, PackageDiagram) 134 </dd>
131 </dd> 135 <dt><i>project</i> (Project)</dt>
132 <dt><i>project</i></dt> 136 <dd>
133 <dd> 137 reference to the project object
134 reference to the project object (Project) 138 </dd>
135 </dd> 139 <dt><i>path</i> (str)</dt>
136 <dt><i>path</i></dt> 140 <dd>
137 <dd> 141 file or directory path to build the diagram from
138 file or directory path to build the diagram from (string) 142 </dd>
139 </dd> 143 <dt><i>parent</i> (QWidget)</dt>
140 <dt><i>parent</i></dt> 144 <dd>
141 <dd> 145 parent widget of the dialog
142 parent widget of the dialog (QWidget) 146 </dd>
143 </dd> 147 <dt><i>initBuilder</i> (bool)</dt>
144 <dt><i>initBuilder</i></dt>
145 <dd> 148 <dd>
146 flag indicating to initialize the diagram 149 flag indicating to initialize the diagram
147 builder (boolean) 150 builder
148 </dd> 151 </dd>
149 <dt><i>kwargs=</i></dt> 152 <dt><i>kwargs=</i> (dict)</dt>
150 <dd> 153 <dd>
151 diagram specific data 154 diagram specific data
152 </dd> 155 </dd>
153 </dl> 156 </dl>
154 <a NAME="UMLDialog.__diagramBuilder" ID="UMLDialog.__diagramBuilder"></a> 157 <a NAME="UMLDialog.__diagramBuilder" ID="UMLDialog.__diagramBuilder"></a>
158 <p> 161 <p>
159 Private method to instantiate a diagram builder object. 162 Private method to instantiate a diagram builder object.
160 </p> 163 </p>
161 <dl> 164 <dl>
162 165
163 <dt><i>diagramType</i></dt> 166 <dt><i>diagramType</i> (UMLDialogType)</dt>
164 <dd> 167 <dd>
165 type of the diagram 168 type of the diagram
166 (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, 169 </dd>
167 PackageDiagram) 170 <dt><i>path</i> (str)</dt>
168 </dd> 171 <dd>
169 <dt><i>path</i></dt> 172 file or directory path to build the diagram from
170 <dd> 173 </dd>
171 file or directory path to build the diagram from (string) 174 <dt><i>kwargs=</i> (dict)</dt>
172 </dd>
173 <dt><i>kwargs=</i></dt>
174 <dd> 175 <dd>
175 diagram specific data 176 diagram specific data
176 </dd> 177 </dd>
177 </dl> 178 </dl>
178 <dl> 179 <dl>
180 <dd> 181 <dd>
181 reference to the instantiated diagram builder 182 reference to the instantiated diagram builder
182 </dd> 183 </dd>
183 </dl> 184 </dl>
184 <dl> 185 <dl>
185 186 <dt>Return Type:</dt>
186 <dt>Raises <b>ValueError</b>:</dt> 187 <dd>
187 <dd> 188 UMLDiagramBuilder
188 raised to indicate an illegal diagram type
189 </dd> 189 </dd>
190 </dl> 190 </dl>
191 <a NAME="UMLDialog.__initActions" ID="UMLDialog.__initActions"></a> 191 <a NAME="UMLDialog.__initActions" ID="UMLDialog.__initActions"></a>
192 <h4>UMLDialog.__initActions</h4> 192 <h4>UMLDialog.__initActions</h4>
193 <b>__initActions</b>(<i></i>) 193 <b>__initActions</b>(<i></i>)
276 from file (boolean) 276 from file (boolean)
277 </dd> 277 </dd>
278 </dl> 278 </dl>
279 <div align="right"><a href="#top">Up</a></div> 279 <div align="right"><a href="#top">Up</a></div>
280 <hr /> 280 <hr />
281 <hr />
282 <a NAME="UMLDialogType" ID="UMLDialogType"></a>
283 <h2>UMLDialogType</h2>
284
285 <p>
286 Class defining the UML dialog types.
287 </p>
288 <h3>Derived from</h3>
289 enum.Enum
290 <h3>Class Attributes</h3>
291
292 <table>
293 <tr><td>APPLICATION_DIAGRAM</td></tr><tr><td>CLASS_DIAGRAM</td></tr><tr><td>IMPORTS_DIAGRAM</td></tr><tr><td>NO_DIAGRAM</td></tr><tr><td>PACKAGE_DIAGRAM</td></tr>
294 </table>
295 <h3>Class Methods</h3>
296
297 <table>
298 <tr><td>None</td></tr>
299 </table>
300 <h3>Methods</h3>
301
302 <table>
303 <tr><td>None</td></tr>
304 </table>
305 <h3>Static Methods</h3>
306
307 <table>
308 <tr><td>None</td></tr>
309 </table>
310
311 <div align="right"><a href="#top">Up</a></div>
312 <hr />
281 </body></html> 313 </body></html>

eric ide

mercurial