Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric5.Graphics.UMLDialog.html

changeset 2033
4b99609f6a87
parent 2031
c36c2eb62a75
child 2035
11bb61bc138d
equal deleted inserted replaced
2032:704593d042fe 2033:4b99609f6a87
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>ImportsDiagram</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><td>None</td></tr> 56 <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>
57 </table> 60 </table>
58 <h3>Methods</h3> 61 <h3>Methods</h3>
59 <table> 62 <table>
60 <tr> 63 <tr>
61 <td><a href="#UMLDialog.__init__">UMLDialog</a></td> 64 <td><a href="#UMLDialog.__init__">UMLDialog</a></td>
62 <td>Constructor</td> 65 <td>Constructor</td>
63 </tr><tr> 66 </tr><tr>
64 <td><a href="#UMLDialog.__diagramBuilder">__diagramBuilder</a></td> 67 <td><a href="#UMLDialog.__diagramBuilder">__diagramBuilder</a></td>
65 <td>Private method to instantiate a diagram builder object.</td> 68 <td>Private method to instantiate a diagram builder object.</td>
66 </tr><tr> 69 </tr><tr>
70 <td><a href="#UMLDialog.__diagramTypeString">__diagramTypeString</a></td>
71 <td>Private method to generate a readable string for the diagram type.</td>
72 </tr><tr>
73 <td><a href="#UMLDialog.__initActions">__initActions</a></td>
74 <td>Private slot to initialize the actions.</td>
75 </tr><tr>
76 <td><a href="#UMLDialog.__initToolBars">__initToolBars</a></td>
77 <td>Private slot to initialize the toolbars.</td>
78 </tr><tr>
67 <td><a href="#UMLDialog.__relayout">__relayout</a></td> 79 <td><a href="#UMLDialog.__relayout">__relayout</a></td>
68 <td>Private method to relayout the diagram.</td> 80 <td>Private method to relayout the diagram.</td>
69 </tr><tr> 81 </tr><tr>
70 <td><a href="#UMLDialog.diagramTypeToString">diagramTypeToString</a></td> 82 <td><a href="#UMLDialog.__save">__save</a></td>
71 <td>Public method to convert the diagram type to a readable string.</td> 83 <td>Private slot to save the diagram with the current name.</td>
84 </tr><tr>
85 <td><a href="#UMLDialog.__saveAs">__saveAs</a></td>
86 <td>Private slot to save the diagram.</td>
72 </tr><tr> 87 </tr><tr>
73 <td><a href="#UMLDialog.show">show</a></td> 88 <td><a href="#UMLDialog.show">show</a></td>
74 <td>Overriden method to show the dialog.</td> 89 <td>Overriden method to show the dialog.</td>
75 </tr> 90 </tr>
76 </table> 91 </table>
77 <h3>Static Methods</h3> 92 <h3>Static Methods</h3>
78 <table> 93 <table>
79 <tr><td>None</td></tr> 94 <tr><td>None</td></tr>
80 </table> 95 </table>
81 <a NAME="UMLDialog.__init__" ID="UMLDialog.__init__"></a> 96 <a NAME="UMLDialog.generateDialogFromFile" ID="UMLDialog.generateDialogFromFile"></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>
82 <h4>UMLDialog (Constructor)</h4> 115 <h4>UMLDialog (Constructor)</h4>
83 <b>UMLDialog</b>(<i>diagramType, project, path, parent=None, **kwargs</i>) 116 <b>UMLDialog</b>(<i>diagramType, project, path="", parent=None, initBuilder=True, **kwargs</i>)
84 <p> 117 <p>
85 Constructor 118 Constructor
86 </p><dl> 119 </p><dl>
87 <dt><i>diagramType</i></dt> 120 <dt><i>diagramType</i></dt>
88 <dd> 121 <dd>
94 </dd><dt><i>path</i></dt> 127 </dd><dt><i>path</i></dt>
95 <dd> 128 <dd>
96 file or directory path to build the diagram from (string) 129 file or directory path to build the diagram from (string)
97 </dd><dt><i>parent</i></dt> 130 </dd><dt><i>parent</i></dt>
98 <dd> 131 <dd>
99 parent widget of the view (QWidget) 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)
100 </dd><dt><i>kwargs</i></dt> 136 </dd><dt><i>kwargs</i></dt>
101 <dd> 137 <dd>
102 diagram specific data 138 diagram specific data
103 </dd> 139 </dd>
104 </dl><a NAME="UMLDialog.__diagramBuilder" ID="UMLDialog.__diagramBuilder"></a> 140 </dl><a NAME="UMLDialog.__diagramBuilder" ID="UMLDialog.__diagramBuilder"></a>
119 file or directory path to build the diagram from (string) 155 file or directory path to build the diagram from (string)
120 </dd><dt><i>kwargs</i></dt> 156 </dd><dt><i>kwargs</i></dt>
121 <dd> 157 <dd>
122 diagram specific data 158 diagram specific data
123 </dd> 159 </dd>
124 </dl><a NAME="UMLDialog.__relayout" ID="UMLDialog.__relayout"></a> 160 </dl><a NAME="UMLDialog.__diagramTypeString" ID="UMLDialog.__diagramTypeString"></a>
161 <h4>UMLDialog.__diagramTypeString</h4>
162 <b>__diagramTypeString</b>(<i></i>)
163 <p>
164 Private method to generate a readable string for the diagram type.
165 </p><dl>
166 <dt>Returns:</dt>
167 <dd>
168 readable type string (string)
169 </dd>
170 </dl><a NAME="UMLDialog.__initActions" ID="UMLDialog.__initActions"></a>
171 <h4>UMLDialog.__initActions</h4>
172 <b>__initActions</b>(<i></i>)
173 <p>
174 Private slot to initialize the actions.
175 </p><a NAME="UMLDialog.__initToolBars" ID="UMLDialog.__initToolBars"></a>
176 <h4>UMLDialog.__initToolBars</h4>
177 <b>__initToolBars</b>(<i></i>)
178 <p>
179 Private slot to initialize the toolbars.
180 </p><a NAME="UMLDialog.__relayout" ID="UMLDialog.__relayout"></a>
125 <h4>UMLDialog.__relayout</h4> 181 <h4>UMLDialog.__relayout</h4>
126 <b>__relayout</b>(<i></i>) 182 <b>__relayout</b>(<i></i>)
127 <p> 183 <p>
128 Private method to relayout the diagram. 184 Private method to relayout the diagram.
129 </p><a NAME="UMLDialog.diagramTypeToString" ID="UMLDialog.diagramTypeToString"></a> 185 </p><a NAME="UMLDialog.__save" ID="UMLDialog.__save"></a>
130 <h4>UMLDialog.diagramTypeToString</h4> 186 <h4>UMLDialog.__save</h4>
131 <b>diagramTypeToString</b>(<i>diagramType</i>) 187 <b>__save</b>(<i></i>)
132 <p> 188 <p>
133 Public method to convert the diagram type to a readable string. 189 Private slot to save the diagram with the current name.
134 </p><dl> 190 </p><a NAME="UMLDialog.__saveAs" ID="UMLDialog.__saveAs"></a>
135 <dt><i>diagramType</i></dt> 191 <h4>UMLDialog.__saveAs</h4>
136 <dd> 192 <b>__saveAs</b>(<i>filename=""</i>)
137 type of the diagram 193 <p>
138 (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram) 194 Private slot to save the diagram.
139 </dd> 195 </p><dl>
140 </dl><dl> 196 <dt><i>filename</i></dt>
141 <dt>Returns:</dt> 197 <dd>
142 <dd> 198 name of the file to write to (string)
143 readable type string (string)
144 </dd> 199 </dd>
145 </dl><a NAME="UMLDialog.show" ID="UMLDialog.show"></a> 200 </dl><a NAME="UMLDialog.show" ID="UMLDialog.show"></a>
146 <h4>UMLDialog.show</h4> 201 <h4>UMLDialog.show</h4>
147 <b>show</b>(<i></i>) 202 <b>show</b>(<i></i>)
148 <p> 203 <p>

Mercurial Repository: eric

eric ide

mercurial