Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric5.Graphics.UMLDialog.html

Documentation/Source/eric5.Graphics.UMLDialog.html

changeset 2035
11bb61bc138d
parent 2033
4b99609f6a87
child 2101
5bac7dee9e1a
equal deleted inserted replaced
2034:8de0fc1f7fef 2035:11bb61bc138d
47 </p> 47 </p>
48 <h3>Derived from</h3> 48 <h3>Derived from</h3>
49 QMainWindow 49 QMainWindow
50 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
51 <table> 51 <table>
52 <tr><td>ApplicationDiagram</td></tr><tr><td>ClassDiagram</td></tr><tr><td>ImportsDiagram</td></tr><tr><td>PackageDiagram</td></tr> 52 <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>
53 </table> 53 </table>
54 <h3>Class Methods</h3> 54 <h3>Class Methods</h3>
55 <table> 55 <table>
56 <tr> 56 <tr><td>None</td></tr>
57 <td><a href="#UMLDialog.generateDialogFromFile">generateDialogFromFile</a></td>
58 <td>Class method to generate a dialog reading data from a file.</td>
59 </tr>
60 </table> 57 </table>
61 <h3>Methods</h3> 58 <h3>Methods</h3>
62 <table> 59 <table>
63 <tr> 60 <tr>
64 <td><a href="#UMLDialog.__init__">UMLDialog</a></td> 61 <td><a href="#UMLDialog.__init__">UMLDialog</a></td>
83 <td>Private slot to save the diagram with the current name.</td> 80 <td>Private slot to save the diagram with the current name.</td>
84 </tr><tr> 81 </tr><tr>
85 <td><a href="#UMLDialog.__saveAs">__saveAs</a></td> 82 <td><a href="#UMLDialog.__saveAs">__saveAs</a></td>
86 <td>Private slot to save the diagram.</td> 83 <td>Private slot to save the diagram.</td>
87 </tr><tr> 84 </tr><tr>
85 <td><a href="#UMLDialog.__showInvalidDataMessage">__showInvalidDataMessage</a></td>
86 <td>Private slot to show a message dialog indicating an invalid data file.</td>
87 </tr><tr>
88 <td><a href="#UMLDialog.load">load</a></td>
89 <td>Public method to load a diagram from a file.</td>
90 </tr><tr>
88 <td><a href="#UMLDialog.show">show</a></td> 91 <td><a href="#UMLDialog.show">show</a></td>
89 <td>Overriden method to show the dialog.</td> 92 <td>Public method to show the dialog.</td>
90 </tr> 93 </tr>
91 </table> 94 </table>
92 <h3>Static Methods</h3> 95 <h3>Static Methods</h3>
93 <table> 96 <table>
94 <tr><td>None</td></tr> 97 <tr><td>None</td></tr>
95 </table> 98 </table>
96 <a NAME="UMLDialog.generateDialogFromFile" ID="UMLDialog.generateDialogFromFile"></a> 99 <a NAME="UMLDialog.__init__" ID="UMLDialog.__init__"></a>
97 <h4>UMLDialog.generateDialogFromFile (class method)</h4>
98 <b>generateDialogFromFile</b>(<i>project, parent=None</i>)
99 <p>
100 Class method to generate a dialog reading data from a file.
101 </p><dl>
102 <dt><i>project</i></dt>
103 <dd>
104 reference to the project object (Project)
105 </dd><dt><i>parent</i></dt>
106 <dd>
107 parent widget of the dialog (QWidget)
108 </dd>
109 </dl><dl>
110 <dt>Returns:</dt>
111 <dd>
112 generated dialog (UMLDialog)
113 </dd>
114 </dl><a NAME="UMLDialog.__init__" ID="UMLDialog.__init__"></a>
115 <h4>UMLDialog (Constructor)</h4> 100 <h4>UMLDialog (Constructor)</h4>
116 <b>UMLDialog</b>(<i>diagramType, project, path="", parent=None, initBuilder=True, **kwargs</i>) 101 <b>UMLDialog</b>(<i>diagramType, project, path="", parent=None, initBuilder=True, **kwargs</i>)
117 <p> 102 <p>
118 Constructor 103 Constructor
119 </p><dl> 104 </p><dl>
120 <dt><i>diagramType</i></dt> 105 <dt><i>diagramType</i></dt>
121 <dd> 106 <dd>
107 type of the diagram (one of ApplicationDiagram, ClassDiagram,
108 ImportsDiagram, NoDiagram, PackageDiagram)
109 </dd><dt><i>project</i></dt>
110 <dd>
111 reference to the project object (Project)
112 </dd><dt><i>path</i></dt>
113 <dd>
114 file or directory path to build the diagram from (string)
115 </dd><dt><i>parent</i></dt>
116 <dd>
117 parent widget of the dialog (QWidget)
118 </dd><dt><i>initBuilder=</i></dt>
119 <dd>
120 flag indicating to initialize the diagram builder (boolean)
121 </dd><dt><i>kwargs</i></dt>
122 <dd>
123 diagram specific data
124 </dd>
125 </dl><a NAME="UMLDialog.__diagramBuilder" ID="UMLDialog.__diagramBuilder"></a>
126 <h4>UMLDialog.__diagramBuilder</h4>
127 <b>__diagramBuilder</b>(<i>diagramType, path, **kwargs</i>)
128 <p>
129 Private method to instantiate a diagram builder object.
130 </p><dl>
131 <dt><i>diagramType</i></dt>
132 <dd>
122 type of the diagram 133 type of the diagram
123 (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram) 134 (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram)
124 </dd><dt><i>project</i></dt>
125 <dd>
126 reference to the project object (Project)
127 </dd><dt><i>path</i></dt>
128 <dd>
129 file or directory path to build the diagram from (string)
130 </dd><dt><i>parent</i></dt>
131 <dd>
132 parent widget of the dialog (QWidget)
133 </dd><dt><i>initBuilder=</i></dt>
134 <dd>
135 flag indicating to initialize the diagram builder (boolean)
136 </dd><dt><i>kwargs</i></dt>
137 <dd>
138 diagram specific data
139 </dd>
140 </dl><a NAME="UMLDialog.__diagramBuilder" ID="UMLDialog.__diagramBuilder"></a>
141 <h4>UMLDialog.__diagramBuilder</h4>
142 <b>__diagramBuilder</b>(<i>diagramType, project, path, **kwargs</i>)
143 <p>
144 Private method to instantiate a diagram builder object.
145 </p><dl>
146 <dt><i>diagramType</i></dt>
147 <dd>
148 type of the diagram
149 (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram)
150 </dd><dt><i>project</i></dt>
151 <dd>
152 reference to the project object (Project)
153 </dd><dt><i>path</i></dt> 135 </dd><dt><i>path</i></dt>
154 <dd> 136 <dd>
155 file or directory path to build the diagram from (string) 137 file or directory path to build the diagram from (string)
156 </dd><dt><i>kwargs</i></dt> 138 </dd><dt><i>kwargs</i></dt>
157 <dd> 139 <dd>
195 </p><dl> 177 </p><dl>
196 <dt><i>filename</i></dt> 178 <dt><i>filename</i></dt>
197 <dd> 179 <dd>
198 name of the file to write to (string) 180 name of the file to write to (string)
199 </dd> 181 </dd>
182 </dl><a NAME="UMLDialog.__showInvalidDataMessage" ID="UMLDialog.__showInvalidDataMessage"></a>
183 <h4>UMLDialog.__showInvalidDataMessage</h4>
184 <b>__showInvalidDataMessage</b>(<i>filename, linenum=-1</i>)
185 <p>
186 Private slot to show a message dialog indicating an invalid data file.
187 </p><dl>
188 <dt><i>filename</i></dt>
189 <dd>
190 name of the file containing the invalid data (string)
191 </dd><dt><i>linenum</i></dt>
192 <dd>
193 number of the invalid line (integer)
194 </dd>
195 </dl><a NAME="UMLDialog.load" ID="UMLDialog.load"></a>
196 <h4>UMLDialog.load</h4>
197 <b>load</b>(<i></i>)
198 <p>
199 Public method to load a diagram from a file.
200 </p><dl>
201 <dt>Returns:</dt>
202 <dd>
203 flag indicating success (boolean)
204 </dd>
200 </dl><a NAME="UMLDialog.show" ID="UMLDialog.show"></a> 205 </dl><a NAME="UMLDialog.show" ID="UMLDialog.show"></a>
201 <h4>UMLDialog.show</h4> 206 <h4>UMLDialog.show</h4>
202 <b>show</b>(<i></i>) 207 <b>show</b>(<i>fromFile=False</i>)
203 <p> 208 <p>
204 Overriden method to show the dialog. 209 Public method to show the dialog.
205 </p> 210 </p><dl>
211 <dt><i>fromFile=</i></dt>
212 <dd>
213 flag indicating, that the diagram was loaded
214 from file (boolean)
215 </dd>
216 </dl>
206 <div align="right"><a href="#top">Up</a></div> 217 <div align="right"><a href="#top">Up</a></div>
207 <hr /> 218 <hr />
208 </body></html> 219 </body></html>

Mercurial Repository: eric

eric ide

mercurial