eric7/Documentation/Source/eric7.Project.CreateDialogCodeDialog.html

branch
eric7
changeset 8372
e0227a7c850e
child 8596
d64760b2da50
equal deleted inserted replaced
8371:d6062691d424 8372:e0227a7c850e
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Project.CreateDialogCodeDialog</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body>
22 <a NAME="top" ID="top"></a>
23 <h1>eric7.Project.CreateDialogCodeDialog</h1>
24
25 <p>
26 Module implementing a dialog to generate code for a Qt5 dialog.
27 </p>
28 <h3>Global Attributes</h3>
29
30 <table>
31 <tr><td>parameterNamesListRole</td></tr><tr><td>parameterTypesListRole</td></tr><tr><td>pyqtSignatureRole</td></tr><tr><td>pythonSignatureRole</td></tr><tr><td>returnTypeRole</td></tr><tr><td>rubySignatureRole</td></tr>
32 </table>
33 <h3>Classes</h3>
34
35 <table>
36
37 <tr>
38 <td><a href="#CreateDialogCodeDialog">CreateDialogCodeDialog</a></td>
39 <td>Class implementing a dialog to generate code for a Qt5 dialog.</td>
40 </tr>
41 </table>
42 <h3>Functions</h3>
43
44 <table>
45 <tr><td>None</td></tr>
46 </table>
47 <hr />
48 <hr />
49 <a NAME="CreateDialogCodeDialog" ID="CreateDialogCodeDialog"></a>
50 <h2>CreateDialogCodeDialog</h2>
51
52 <p>
53 Class implementing a dialog to generate code for a Qt5 dialog.
54 </p>
55 <h3>Derived from</h3>
56 QDialog, Ui_CreateDialogCodeDialog
57 <h3>Class Attributes</h3>
58
59 <table>
60 <tr><td>DialogClasses</td></tr><tr><td>Separator</td></tr>
61 </table>
62 <h3>Class Methods</h3>
63
64 <table>
65 <tr><td>None</td></tr>
66 </table>
67 <h3>Methods</h3>
68
69 <table>
70
71 <tr>
72 <td><a href="#CreateDialogCodeDialog.__init__">CreateDialogCodeDialog</a></td>
73 <td>Constructor</td>
74 </tr>
75 <tr>
76 <td><a href="#CreateDialogCodeDialog.__className">__className</a></td>
77 <td>Private method to get the class name of a form.</td>
78 </tr>
79 <tr>
80 <td><a href="#CreateDialogCodeDialog.__generateCode">__generateCode</a></td>
81 <td>Private slot to generate the code as requested by the user.</td>
82 </tr>
83 <tr>
84 <td><a href="#CreateDialogCodeDialog.__generatePythonCode">__generatePythonCode</a></td>
85 <td>Private slot to generate Python code as requested by the user.</td>
86 </tr>
87 <tr>
88 <td><a href="#CreateDialogCodeDialog.__mapType">__mapType</a></td>
89 <td>Private method to map a type as reported by Qt's meta object to the correct Python type.</td>
90 </tr>
91 <tr>
92 <td><a href="#CreateDialogCodeDialog.__objectName">__objectName</a></td>
93 <td>Private method to get the object name of a form.</td>
94 </tr>
95 <tr>
96 <td><a href="#CreateDialogCodeDialog.__runUicLoadUi">__runUicLoadUi</a></td>
97 <td>Private method to run the UicLoadUi.py script with the given command and return the output.</td>
98 </tr>
99 <tr>
100 <td><a href="#CreateDialogCodeDialog.__signatures">__signatures</a></td>
101 <td>Private slot to get the signatures.</td>
102 </tr>
103 <tr>
104 <td><a href="#CreateDialogCodeDialog.__updateSlotsModel">__updateSlotsModel</a></td>
105 <td>Private slot to update the slots tree display.</td>
106 </tr>
107 <tr>
108 <td><a href="#CreateDialogCodeDialog.initError">initError</a></td>
109 <td>Public method to determine, if there was an initialzation error.</td>
110 </tr>
111 <tr>
112 <td><a href="#CreateDialogCodeDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
113 <td>Private slot to handle the buttonBox clicked signal.</td>
114 </tr>
115 <tr>
116 <td><a href="#CreateDialogCodeDialog.on_classNameCombo_activated">on_classNameCombo_activated</a></td>
117 <td>Private slot to handle the activated signal of the classname combo.</td>
118 </tr>
119 <tr>
120 <td><a href="#CreateDialogCodeDialog.on_filterEdit_textChanged">on_filterEdit_textChanged</a></td>
121 <td>Private slot called, when thext of the filter edit has changed.</td>
122 </tr>
123 <tr>
124 <td><a href="#CreateDialogCodeDialog.on_newButton_clicked">on_newButton_clicked</a></td>
125 <td>Private slot called to enter the data for a new dialog class.</td>
126 </tr>
127 </table>
128 <h3>Static Methods</h3>
129
130 <table>
131 <tr><td>None</td></tr>
132 </table>
133
134 <a NAME="CreateDialogCodeDialog.__init__" ID="CreateDialogCodeDialog.__init__"></a>
135 <h4>CreateDialogCodeDialog (Constructor)</h4>
136 <b>CreateDialogCodeDialog</b>(<i>formName, project, parent=None</i>)
137
138 <p>
139 Constructor
140 </p>
141 <dl>
142
143 <dt><i>formName</i></dt>
144 <dd>
145 name of the file containing the form (string)
146 </dd>
147 <dt><i>project</i></dt>
148 <dd>
149 reference to the project object
150 </dd>
151 <dt><i>parent</i></dt>
152 <dd>
153 parent widget if the dialog (QWidget)
154 </dd>
155 </dl>
156 <a NAME="CreateDialogCodeDialog.__className" ID="CreateDialogCodeDialog.__className"></a>
157 <h4>CreateDialogCodeDialog.__className</h4>
158 <b>__className</b>(<i></i>)
159
160 <p>
161 Private method to get the class name of a form.
162 </p>
163 <dl>
164 <dt>Return:</dt>
165 <dd>
166 class name
167 </dd>
168 </dl>
169 <dl>
170 <dt>Return Type:</dt>
171 <dd>
172 str
173 </dd>
174 </dl>
175 <a NAME="CreateDialogCodeDialog.__generateCode" ID="CreateDialogCodeDialog.__generateCode"></a>
176 <h4>CreateDialogCodeDialog.__generateCode</h4>
177 <b>__generateCode</b>(<i></i>)
178
179 <p>
180 Private slot to generate the code as requested by the user.
181 </p>
182 <a NAME="CreateDialogCodeDialog.__generatePythonCode" ID="CreateDialogCodeDialog.__generatePythonCode"></a>
183 <h4>CreateDialogCodeDialog.__generatePythonCode</h4>
184 <b>__generatePythonCode</b>(<i></i>)
185
186 <p>
187 Private slot to generate Python code as requested by the user.
188 </p>
189 <a NAME="CreateDialogCodeDialog.__mapType" ID="CreateDialogCodeDialog.__mapType"></a>
190 <h4>CreateDialogCodeDialog.__mapType</h4>
191 <b>__mapType</b>(<i>type_</i>)
192
193 <p>
194 Private method to map a type as reported by Qt's meta object to the
195 correct Python type.
196 </p>
197 <dl>
198
199 <dt><i>type_</i></dt>
200 <dd>
201 type as reported by Qt (QByteArray)
202 </dd>
203 </dl>
204 <dl>
205 <dt>Return:</dt>
206 <dd>
207 mapped Python type (string)
208 </dd>
209 </dl>
210 <a NAME="CreateDialogCodeDialog.__objectName" ID="CreateDialogCodeDialog.__objectName"></a>
211 <h4>CreateDialogCodeDialog.__objectName</h4>
212 <b>__objectName</b>(<i></i>)
213
214 <p>
215 Private method to get the object name of a form.
216 </p>
217 <dl>
218 <dt>Return:</dt>
219 <dd>
220 object name
221 </dd>
222 </dl>
223 <dl>
224 <dt>Return Type:</dt>
225 <dd>
226 str
227 </dd>
228 </dl>
229 <a NAME="CreateDialogCodeDialog.__runUicLoadUi" ID="CreateDialogCodeDialog.__runUicLoadUi"></a>
230 <h4>CreateDialogCodeDialog.__runUicLoadUi</h4>
231 <b>__runUicLoadUi</b>(<i>command</i>)
232
233 <p>
234 Private method to run the UicLoadUi.py script with the given command
235 and return the output.
236 </p>
237 <dl>
238
239 <dt><i>command</i> (str)</dt>
240 <dd>
241 uic command to be run
242 </dd>
243 </dl>
244 <dl>
245 <dt>Return:</dt>
246 <dd>
247 tuple of process output and error flag
248 </dd>
249 </dl>
250 <dl>
251 <dt>Return Type:</dt>
252 <dd>
253 tuple of (str, bool)
254 </dd>
255 </dl>
256 <a NAME="CreateDialogCodeDialog.__signatures" ID="CreateDialogCodeDialog.__signatures"></a>
257 <h4>CreateDialogCodeDialog.__signatures</h4>
258 <b>__signatures</b>(<i></i>)
259
260 <p>
261 Private slot to get the signatures.
262 </p>
263 <dl>
264 <dt>Return:</dt>
265 <dd>
266 list of signatures (list of strings)
267 </dd>
268 </dl>
269 <a NAME="CreateDialogCodeDialog.__updateSlotsModel" ID="CreateDialogCodeDialog.__updateSlotsModel"></a>
270 <h4>CreateDialogCodeDialog.__updateSlotsModel</h4>
271 <b>__updateSlotsModel</b>(<i></i>)
272
273 <p>
274 Private slot to update the slots tree display.
275 </p>
276 <a NAME="CreateDialogCodeDialog.initError" ID="CreateDialogCodeDialog.initError"></a>
277 <h4>CreateDialogCodeDialog.initError</h4>
278 <b>initError</b>(<i></i>)
279
280 <p>
281 Public method to determine, if there was an initialzation error.
282 </p>
283 <dl>
284 <dt>Return:</dt>
285 <dd>
286 flag indicating an initialzation error (boolean)
287 </dd>
288 </dl>
289 <a NAME="CreateDialogCodeDialog.on_buttonBox_clicked" ID="CreateDialogCodeDialog.on_buttonBox_clicked"></a>
290 <h4>CreateDialogCodeDialog.on_buttonBox_clicked</h4>
291 <b>on_buttonBox_clicked</b>(<i>button</i>)
292
293 <p>
294 Private slot to handle the buttonBox clicked signal.
295 </p>
296 <dl>
297
298 <dt><i>button</i></dt>
299 <dd>
300 reference to the button that was clicked
301 (QAbstractButton)
302 </dd>
303 </dl>
304 <a NAME="CreateDialogCodeDialog.on_classNameCombo_activated" ID="CreateDialogCodeDialog.on_classNameCombo_activated"></a>
305 <h4>CreateDialogCodeDialog.on_classNameCombo_activated</h4>
306 <b>on_classNameCombo_activated</b>(<i>index</i>)
307
308 <p>
309 Private slot to handle the activated signal of the classname combo.
310 </p>
311 <dl>
312
313 <dt><i>index</i></dt>
314 <dd>
315 index of the activated item (integer)
316 </dd>
317 </dl>
318 <a NAME="CreateDialogCodeDialog.on_filterEdit_textChanged" ID="CreateDialogCodeDialog.on_filterEdit_textChanged"></a>
319 <h4>CreateDialogCodeDialog.on_filterEdit_textChanged</h4>
320 <b>on_filterEdit_textChanged</b>(<i>text</i>)
321
322 <p>
323 Private slot called, when thext of the filter edit has changed.
324 </p>
325 <dl>
326
327 <dt><i>text</i></dt>
328 <dd>
329 changed text (string)
330 </dd>
331 </dl>
332 <a NAME="CreateDialogCodeDialog.on_newButton_clicked" ID="CreateDialogCodeDialog.on_newButton_clicked"></a>
333 <h4>CreateDialogCodeDialog.on_newButton_clicked</h4>
334 <b>on_newButton_clicked</b>(<i></i>)
335
336 <p>
337 Private slot called to enter the data for a new dialog class.
338 </p>
339 <div align="right"><a href="#top">Up</a></div>
340 <hr />
341 </body></html>

eric ide

mercurial