Documentation/Source/eric5.Graphics.UMLDialog.html

changeset 2031
c36c2eb62a75
parent 2027
144463496a54
child 2033
4b99609f6a87
equal deleted inserted replaced
2030:db11a2fe9bbc 2031:c36c2eb62a75
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>None</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><td>None</td></tr>
57 </table> 57 </table>
59 <table> 59 <table>
60 <tr> 60 <tr>
61 <td><a href="#UMLDialog.__init__">UMLDialog</a></td> 61 <td><a href="#UMLDialog.__init__">UMLDialog</a></td>
62 <td>Constructor</td> 62 <td>Constructor</td>
63 </tr><tr> 63 </tr><tr>
64 <td><a href="#UMLDialog.setDiagramName">setDiagramName</a></td> 64 <td><a href="#UMLDialog.__diagramBuilder">__diagramBuilder</a></td>
65 <td>Public slot to set the diagram name.</td> 65 <td>Private method to instantiate a diagram builder object.</td>
66 </tr><tr>
67 <td><a href="#UMLDialog.__relayout">__relayout</a></td>
68 <td>Private method to relayout the diagram.</td>
69 </tr><tr>
70 <td><a href="#UMLDialog.diagramTypeToString">diagramTypeToString</a></td>
71 <td>Public method to convert the diagram type to a readable string.</td>
66 </tr><tr> 72 </tr><tr>
67 <td><a href="#UMLDialog.show">show</a></td> 73 <td><a href="#UMLDialog.show">show</a></td>
68 <td>Overriden method to show the dialog.</td> 74 <td>Overriden method to show the dialog.</td>
69 </tr> 75 </tr>
70 </table> 76 </table>
72 <table> 78 <table>
73 <tr><td>None</td></tr> 79 <tr><td>None</td></tr>
74 </table> 80 </table>
75 <a NAME="UMLDialog.__init__" ID="UMLDialog.__init__"></a> 81 <a NAME="UMLDialog.__init__" ID="UMLDialog.__init__"></a>
76 <h4>UMLDialog (Constructor)</h4> 82 <h4>UMLDialog (Constructor)</h4>
77 <b>UMLDialog</b>(<i>buildFunction=None, diagramName="Unnamed", parent=None, name=None</i>) 83 <b>UMLDialog</b>(<i>diagramType, project, path, parent=None, **kwargs</i>)
78 <p> 84 <p>
79 Constructor 85 Constructor
80 </p><dl> 86 </p><dl>
81 <dt><i>buildFunction</i></dt> 87 <dt><i>diagramType</i></dt>
82 <dd> 88 <dd>
83 function to build the diagram contents (function) 89 type of the diagram
84 </dd><dt><i>diagramName</i></dt> 90 (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram)
91 </dd><dt><i>project</i></dt>
85 <dd> 92 <dd>
86 name of the diagram (string) 93 reference to the project object (Project)
94 </dd><dt><i>path</i></dt>
95 <dd>
96 file or directory path to build the diagram from (string)
87 </dd><dt><i>parent</i></dt> 97 </dd><dt><i>parent</i></dt>
88 <dd> 98 <dd>
89 parent widget of the view (QWidget) 99 parent widget of the view (QWidget)
90 </dd><dt><i>name</i></dt> 100 </dd><dt><i>kwargs</i></dt>
91 <dd> 101 <dd>
92 name of the view widget (string) 102 diagram specific data
93 </dd> 103 </dd>
94 </dl><a NAME="UMLDialog.setDiagramName" ID="UMLDialog.setDiagramName"></a> 104 </dl><a NAME="UMLDialog.__diagramBuilder" ID="UMLDialog.__diagramBuilder"></a>
95 <h4>UMLDialog.setDiagramName</h4> 105 <h4>UMLDialog.__diagramBuilder</h4>
96 <b>setDiagramName</b>(<i>name</i>) 106 <b>__diagramBuilder</b>(<i>diagramType, project, path, **kwargs</i>)
97 <p> 107 <p>
98 Public slot to set the diagram name. 108 Private method to instantiate a diagram builder object.
99 </p><dl> 109 </p><dl>
100 <dt><i>name</i></dt> 110 <dt><i>diagramType</i></dt>
101 <dd> 111 <dd>
102 diagram name (string) 112 type of the diagram
113 (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram)
114 </dd><dt><i>project</i></dt>
115 <dd>
116 reference to the project object (Project)
117 </dd><dt><i>path</i></dt>
118 <dd>
119 file or directory path to build the diagram from (string)
120 </dd><dt><i>kwargs</i></dt>
121 <dd>
122 diagram specific data
123 </dd>
124 </dl><a NAME="UMLDialog.__relayout" ID="UMLDialog.__relayout"></a>
125 <h4>UMLDialog.__relayout</h4>
126 <b>__relayout</b>(<i></i>)
127 <p>
128 Private method to relayout the diagram.
129 </p><a NAME="UMLDialog.diagramTypeToString" ID="UMLDialog.diagramTypeToString"></a>
130 <h4>UMLDialog.diagramTypeToString</h4>
131 <b>diagramTypeToString</b>(<i>diagramType</i>)
132 <p>
133 Public method to convert the diagram type to a readable string.
134 </p><dl>
135 <dt><i>diagramType</i></dt>
136 <dd>
137 type of the diagram
138 (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram)
139 </dd>
140 </dl><dl>
141 <dt>Returns:</dt>
142 <dd>
143 readable type string (string)
103 </dd> 144 </dd>
104 </dl><a NAME="UMLDialog.show" ID="UMLDialog.show"></a> 145 </dl><a NAME="UMLDialog.show" ID="UMLDialog.show"></a>
105 <h4>UMLDialog.show</h4> 146 <h4>UMLDialog.show</h4>
106 <b>show</b>(<i></i>) 147 <b>show</b>(<i></i>)
107 <p> 148 <p>

eric ide

mercurial